COcontextualai
/datastores/{id}/documents

Get Document Metadata

Changed on

Get details of a given document, including its name and ingestion job status.

get/datastores/{datastore_id}/documents/{document_id}/metadata

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/datastores/{datastore_id}/documents/{document_id}/metadata
  • Auth
    HTTP bearer

Path parameters

datastore_idstring uuid required

Datastore ID of the datastore from which to retrieve the document

document_idstring uuid required

Document ID of the document to retrieve details for

Response

Successful Response

custom_metadataobject

Custom metadata for the document, provided by the user at ingestion time.Must be a JSON-serializable dictionary with string keys and simple primitive values (str, int, float, bool). The total size must not exceed 2 KB.The strings with date format must stay in date format or be avodied if not in date format.The 'custom_metadata.url' field is automatically included in returned attributions during query time, if provided.The default maximum metadata fields that can be used is 15, contact support if more is needed.

custom_metadata_configobject

A dictionary mapping metadata field names to the configuration to use for each field. If a metadata field is not present in the dictionary, the default configuration will be used. If the dictionary is not provided, metadata will be added in context for rerank and generation but will not be returned back to the user in retrievals in query API. Limits:

  • Maximum characters per metadata field (for prompt or rerank): 400
  • Maximum number of metadata fields (for prompt or retrieval): 10 Contact support@contextual.ai to request quota increases.
idstring uuid required

ID of the document that was ingested

namestring required

User specified name of the document

status'pending' | 'processing' | 'retrying' | 'completed' | 'failed' | 'cancelled' required
created_atstring required

Timestamp of when the document was created in ISO format.

updated_atstring

Timestamp of when the document was modified in ISO format.

ingestion_configunknown
has_accessboolean

Whether the user has access to this document.

Changes

  • 4abdda722de9Revision changes
    • breaking

      the response's property type changed from object to no type for status

  • c8152db45500Revision changes
    • breaking

      response property custom_metadata/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 200