Retrieve metadata about a corpus
GET/v2/corpora/:corpus_key
Get metadata about a corpus. This operation is not a method of searching a corpus.
Request
Path Parameters
Possible values: <= 50 characters
, Value must match regular expression [a-zA-Z0-9_\=\-]+$
The unique key identifying the corpus to retrieve.
Responses
- 200
- 403
- 404
A corpus.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
Possible values: Value must match regular expression crp_[0-9]+$
Vectara ID of the corpus.
Possible values: <= 50 characters
, Value must match regular expression [a-zA-Z0-9_\=\-]+$
A user-provided key for a corpus.
Name for the corpus. This value defaults to the key.
Corpus description.
Specifies whether the corpus is enabled or not.
Indicates that this corpus does not store documents amd stores chats instead.
Default value: false
Queries made to this corpus are considered answers, and not questions. This swaps the semantics of the encoder used at query time.
Default value: false
Documents inside this corpus are considered questions, and not answers. This swaps the semantics of the encoder used at indexing.
Possible values: Value must match regular expression enc_[0-9]+$
The encoder used by the corpus.
Deprecated: use encoder_name
instead
The encoder used by the corpus.
filter_attributes object[]
The new filter attributes of the corpus.
The JSON path of the filter attribute in a document or document part metadata.
Possible values: [document
, part
]
Indicates whether this a document or document part metadata filter.
Description of the filter. May be omitted.
Default value: true
Indicates whether an index should be created for the filter. Creating an index will improve query latency when using the filter.
Possible values: [integer
, real_number
, text
, boolean
, list[integer]
, list[real_number]
, list[text]
]
The value type of the filter.
custom_dimensions object[]
The custom dimensions of all document parts inside the corpus.
The name of the custom dimension.
Default value of a custom dimension on a document part if the custom dimension value is not specified when the document part is indexed.
A value of 0 means that custom dimension is not considered.
Default value of a custom dimension for a query if the value of the custom dimension is not specified when querying the corpus.
A value of 0 means that custom dimension is not considered.
limits object
The number of bytes contained in the corpus. This includes the document metadata, document part metadata, and document contents.
The number of characters contained in the corpus. This includes the document metadata, document part metadata, and document contents.
The maximum number of bytes the corpus can be.
The maximum size that metadata can be on documents.
The maximum per-second addition of new documents to corpus.
Indicates when the corpus was created.
{
"id": "string",
"key": "my-corpus",
"name": "string",
"description": "string",
"enabled": true,
"chat_history_corpus": true,
"queries_are_answers": false,
"documents_are_questions": false,
"encoder_name": "boomerang",
"filter_attributes": [
{
"name": "Title",
"level": "document",
"description": "The title of the document.",
"indexed": true,
"type": "text"
}
],
"custom_dimensions": [
{
"name": "importance",
"indexing_default": 0,
"querying_default": 0
}
],
"limits": {
"used_bytes": 0,
"used_characters": 0,
"max_bytes": 0,
"max_metadata_bytes": 0,
"index_rate": 0
},
"created_at": "2024-09-05T02:15:29.461Z"
}
Permissions do not allow retrieving the corpus.
- application/json
- Schema
- Example (from schema)
Schema
The messages describing why the error occurred.
The ID of the request that can be used to help Vectara support debug what went wrong .
{
"messages": [
"Internal server error."
],
"request_id": "string"
}
Corpus not found.
- application/json
- Schema
- Example (from schema)
Schema
The ID cannot found.
ID of the request that can be used to help Vectara support debug what went wrong.
{
"id": "string",
"messages": [
"string"
],
"request_id": "string"
}