Skip to content

Commit

Permalink
Rename corpus to index (#77)
Browse files Browse the repository at this point in the history
* Rename corpus to index

Renamed corpus to index in 4 topics

* Fix spelling

Fixed ingest spelling

* Update corpus_create.md

Renamed corpus to index throughout the body

* Update terms and comments

Updated the terms and comments for more clarifications
  • Loading branch information
pwoznic committed Aug 21, 2023
1 parent 31538e4 commit 6755d05
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 41 deletions.
Binary file added .DS_Store
Binary file not shown.
13 changes: 6 additions & 7 deletions www/docs/api-reference/admin-apis/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,21 @@ import {vars} from '@site/static/variables.json';

The admin console is a good way to get started with <Config v="names.product"/>. Once
you're ready to integrate the platform more deeply into your application, the
Admin APIs allow you to programatically manipulate corpora and perform many
other operations within the system.
Admin APIs allow you to programatically manipulate indices, also known as
corpora, and perform many other operations within the system.

## Full Definition

### Service

The full definitions of the Create, Reset, and Delete gRPC APIs are covered
below. The Create API allows corpora to be programatically created, up to the
limit defined for the account. Reset deletes all data from a corpus, without
deleting its definition, while Delete expunges both the data in the corpus and
below. The Create API allows indices to be programatically created, up to the
limit defined for the account. Reset deletes all data from an index, without
deleting its definition, while Delete expunges both the data in the index and
its definition.

The REST APIs are programatically derived from these definitions: see
[REST APIs](/docs/api-reference/rest) for more information on endpoints or expand the
specific API in the navigation sidebar to find REST examples in various
[REST APIs](/docs/api-reference/rest) for more information on endpoints or expand the specific API in the navigation sidebar to find REST examples in various
programming languages. For more information on the programmatic conversion,
see [gRPC with REST and Open APIs](https://grpc.io/blog/coreos/).

Expand Down
18 changes: 9 additions & 9 deletions www/docs/api-reference/admin-apis/create-corpus.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ import {vars} from '@site/static/variables.json';
## Endpoint Address

<Config v="names.product"/> exposes a REST endpoint at the following URL
to index content into a corpus:
to ingest content into an index:
<code>https://<Config v="domains.rest.admin"/>/v1/create-corpus</code>
This page describes the details of interacting with this endpoint.

Only the `name` and `description` fields are mandatory when creating a corpus.
The response message returns a unique id, `corpus_id`, by which the corpus can
Only the `name` and `description` fields are mandatory when creating an index.
The response message returns a unique id, `corpus_id`, by which the index can
be subsequently referenced. Note that the name needn't be unique within an
account.

Expand All @@ -33,21 +33,21 @@ message CreateCorpusRequest {
}
message CreateCorpusResponse {
// The Corpus ID that was created.
// The corpus_id uniquely identifies the index that was created.
uint32 corpus_id = 1;
Status status = 2;
}
message Corpus {
// The Corpus ID.
// The index ID, also referred to as the corpus ID.
uint32 id = 1;
// The name of the corpus.
// The name of the index.
string name = 2;
// A description for the corpus.
// A description for the index.
string description = 3;
// The time at which the corpus was provisioned.
// The time at which the index was provisioned.
int64 dt_provision = 4;
// Whether the corpus is enabled for use or not.
// Whether the index is enabled for use or not.
bool enabled = 5;
Expand Down
12 changes: 6 additions & 6 deletions www/docs/api-reference/admin-apis/delete-corpus.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ import {Config} from '@site/docs/definitions.md';
import {vars} from '@site/static/variables.json';

<Config v="names.product"/> exposes a REST endpoint at the following URL
to index content into a corpus:
to ingest content into an index:
<code>https://<Config v="domains.rest.admin"/>/v1/delete-corpus</code>
This page describes the details of interacting with this endpoint.

To delete a corpus, specify the **customer id** and **corpus id**. Upon
successful completion, space quota consumed by the corpus will be freed,
and the corpus will no longer be usable for future indexing or querying.
Note that the corpus id assigned to the corpus will not be reused.
To delete an index, specify the `customer_id` and `corpus_id`. Upon
successful completion, space quota consumed by the index will be freed,
and the index will no longer be useable for data ingestion or querying.
Note that the corpus_id assigned to the index will not be reused.

```protobuf
message DeleteCorpusRequest {
// The Customer ID that contains the corpus to be deleted.
uint32 customer_id = 1;
// The Corpus ID to be deleted.
// The corpus ID uniquely identifies the index to delete.
uint32 corpus_id = 2;
}
Expand Down
8 changes: 4 additions & 4 deletions www/docs/api-reference/admin-apis/reset-corpus.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ import {Config} from '@site/docs/definitions.md';
import {vars} from '@site/static/variables.json';

<Config v="names.product"/> exposes a REST endpoint at the following URL
to index content into a corpus:
to reset an index:
<code>https://<Config v="domains.rest.admin"/>/v1/reset-corpus</code>
This page describes the details of interacting with this endpoint.

To reset a corpus, specify the **customer id** and **corpus id**. Upon
successful completion, space quota consumed by the corpus will be freed.
To reset an index, specify the `customer_id` and `corpus_id`. Upon
successful completion, space quota consumed by the index will be freed.

```protobuf
message ResetCorpusRequest {
uint32 customer_id = 1;
// The Corpus ID to be reset.
// The corpus ID uniquely identifies the index to reset.
uint32 corpus_id = 2;
}
Expand Down
26 changes: 11 additions & 15 deletions www/docs/console-ui/corpus_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,24 @@ id: creating-a-corpus
title: Creating a corpus
---

To get begin searching your data, you first have to create a corpus. A corpus is
a container where you upload all your data to be indexed and grouped together in
a single location for querying.
To get begin searching your data, you first have to create an index. An index,
also referenced as a corpus, is a container where you upload all your data to
be ingested and grouped together in a single location for querying.

1. To get started, navigate to the [Console Overview](https://console.vectara.com/overview).

2. On the left sidebar, you'll see a **Copora** section. Click on it. This will
open an overview of the corpora you have created. It will be empty if this
is your first time accessing the console.
2. On the left sidebar, you'll see an **Indices** section. Click on it. This
will open an overview of the incides you have created. It will be empty
if this is your first time accessing the console.

![Create corpus](/img/create_corpus.png)

3. Now click on the **Create Corpus** button, a dialog box will open. Enter the
name and description of the corpus.

![Create corpus dialog](/img/create_corpus_dialog.png)
3. Now click on the **Create Index** button, a dialog box will open. Enter the
name and description of the index.

4. Leave all settings on their default values and click create. Once created,
you will see a confirmation message and the newly created corpus listed
you will see a confirmation message and the newly created index listed
below.

![Create corpus success](/img/create_corpus_success.png)

The corpus is now created and ready to receive your data. You might want to head
towards how to index data and corpus overview.
The index is now created and ready to receive your data. You might want to head
towards how to index data and the index overview.

0 comments on commit 6755d05

Please sign in to comment.