Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename index to corpus #90

Merged
merged 3 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions www/docs/console-ui/corpus_create.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
---
id: creating-a-corpus
title: Creating a corpus
title: Create a corpus
---

To 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
is like 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. Click **Corpora** on the left sidebar. 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, click **Corpora**. This
will open an overview of the corpora you have created. It will be empty
if this is your first time accessing the console.

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

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
below.
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 below.

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

Expand Down
6 changes: 3 additions & 3 deletions www/docs/console-ui/reset_or_delete_corpus.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: reset-or-delete-corpus
title: Resetting and deleting a corpus
title: Reset or delete a corpus
---

If you've decided to stop using a corpus you have three options.
Expand All @@ -21,7 +21,7 @@ descriptions.

![Create operations](/img/corpus_operations.png)

## Resetting a corpus
## Reset a corpus

To reset a corpus:
1. Click on the _Reset_ button. A warning modal will appear.
Expand All @@ -30,7 +30,7 @@ To reset a corpus:

That's it, all the data within the corpus has been purged.

## Deleting a corpus
## Delete a corpus

To permanently delete a corpus:
1. Click on the _Delete_ button. A warning modal will appear.
Expand Down
27 changes: 14 additions & 13 deletions www/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Welcome to <Config v="names.product"/>'s Quick Start tutorial. In just a couple
you'll upload this [employee handbook](/img/vectara_employee_handbook.pdf) and begin exploring our
company's unique pet policy. Have you ever wondered if you can bring a velociraptor
to work? Why certain birds are allowed for the most random reason? We have part of a
unique employee handbook ready for you to upload into a <Config v="names.product"/> index,
unique employee handbook ready for you to upload into a <Config v="names.product"/> corpus,
and we'll guide you through the ingestion and question answering process step by step.

## Create a Vectara Account
## Create a Vectara account

To get started with <Config v="names.product"/>, register an account with us.
1. Go to https://console.vectara.com/signup or click **Get Started Free**
Expand All @@ -37,27 +37,28 @@ the Customer ID.
you a welcome email with this ID after you created the account.
:::

Now that you have an account, you can create your first index and upload
Now that you have an account, you can create your first corpus and upload
your first document!

## Create your first index
## Create your first corpus

Before you can ask the data about bringing your velociraptor to the
office, you first need to create an index. Think of an index as a container
office, you first need to create a corpus. Think of a corpus as a container
that includes your uploaded data, and you really want to extract meaningful
information from this data through queries. In this case, we upload a [PDF file](/img/vectara_employee_handbook.pdf) file
that contains the pet policy information. After you upload this
file, <Config v="names.product"/> ingests your data and lets you ask the burning
question on everyone's mind!

1. Click **Create index**.
1. Click **Create corpus**.
2. Enter a **Name** and **Description** such as _Employee Handbook_ and _Pet Policy_.

Don't worry about the Filter Attributes for now. You can read
about [filter expressions](/docs/common-use-cases/filtering-by-metadata/filter-overview) later.
about [filter expressions](/docs/common-use-cases/filtering-by-metadata/filter-overview) and
edit them later.
3. Click **Create**.

The **Index ID** displays next to the index title **Employee Handbook** in the
The **Corpus ID** displays next to the corpus title **Employee Handbook** in the
console. If you use the API later, you need to configure `corpus_id` fields
with this value.

Expand All @@ -68,9 +69,9 @@ Think about the kind of queries that you or other users could ask about
the company's pet policies. The main question on everyone's mind is still
_"Can I bring a velociraptor to the office?"_

Now that you created the index, you can upload the PDF document
that contains the pet policy. When you create additional indices in the
future, the left menu lets you come back to any index for data
Now that you created the corpus, you can upload the PDF document
that contains the pet policy. When you create additional corpora in the
future, the left menu lets you come back to any corpus for data
ingestion and search.

1. Click **Employee Handbook** from the left menu, if you decided to explore the UI
Expand All @@ -81,7 +82,7 @@ ingestion and search.
`.html`, `.rtf`, and `.epub` files. Review [supported file types](/docs/api-reference/indexing-apis/file-upload/file-upload-filetypes) for
a full list.

3. Select or drag and drop the pet policy document `PDF` into the index.
3. Select or drag and drop the pet policy document `PDF` into the corpus.

That's it! <Config v="names.product"/> has just ingested this important document!

Expand Down Expand Up @@ -119,7 +120,7 @@ more about the pet policies:
- How does the company handle potential conflicts between different species,
such as birds and alligators?

Now you have an understanding of how to upload data into an index, ask
Now you have an understanding of how to upload data into an corpus, ask
questions, and get meaningful answers from <Config v="names.product"/>. Continue
gaining more answers and insights from your data, and ingest more data.
Imagine the amount of time saved because you get quick answers with precise
Expand Down