List the documents in the corpus
GET/v2/corpora/:corpus_key/documents
List the documents in the corpus
Request
Path Parameters
Possible values: <= 50 characters
, Value must match regular expression [a-zA-Z0-9_\=\-]+$
The unique key identifying the queried corpus.
Query Parameters
Possible values: >= 1
and <= 100
Default value: 10
The maximum number of documents to return at one time.
Filter documents by metadata. Uses the same expression as a query metadata filter, but only allows filtering on document metadata.
Used to the retrieve the next page of documents after the limit has been reached.
Responses
- 200
- 403
- 404
List of documents.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
documents object[]
List of documents.
The Document ID.
metadata object
The document metadata.
The document metadata.
parts object[]
Parts of the document that make up the document. However, parts are not available when retrieving a list of documents or when creating a document. This property is only available when retrieving a document by id.
The text of the document part.
metadata object
The metadata for a document part. Attributes matching corpus document part filter attributes are used as document part filter attributes.
The metadata for a document part. Attributes matching corpus document part filter attributes are used as document part filter attributes.
The context text for the document part.
custom_dimensions object
The custom dimensions as additional weights.
storage_usage object
How much storage the document used. This information is currently not returned when retrieving the document, and only returned when indexing document.
Number of bytes used by document counting towards maximum corpus size, and towards any billing plans.
Number of metadata bytes used by document metadata.
metadata object
The standard metadata in the response of a list operation.
When requesting the next page of this list, this is needed as a query parameter.
{
"documents": [
{
"id": "my-doc-id",
"metadata": {},
"parts": [
{
"text": "I'm a nice document part.",
"metadata": {
"nice_rank": 9000
},
"context": "string",
"custom_dimensions": {}
}
],
"storage_usage": {
"bytes_used": 0,
"metadata_bytes_used": 0
}
}
],
"metadata": {
"page_key": "string"
}
}
Permissions do not allow listing documents in 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"
}