Document

Document
Document

Document.

JSON Example
{
    "origin_name": "string",
    "origin_ref": "string",
    "id": "string",
    "object": "string",
    "knowledge_base_id": "string",
    "index_id": "string",
    "data_source_id": "string",
    "created_at": 0,
    "last_embedded_at": 0,
    "last_indexed_by_id": "string",
    "size_bytes": 0,
    "hash_sha256": "string",
    "reindexing_needed": false
}
string
origin_name
Optional
Constraints: maxLength: 256

Name of the original document, if one was provided during indexing.

string
origin_ref
Optional
Constraints: maxLength: 256

Link to the original document, if one was available during indexing.

string As uuid As uuid
id
Required

ID of the document.

string
object
Optional
Constraints: default: document

Object type, which is always document.

state
Optional

Indexing state of the document.

media_type
Optional

Media type detected for the document.

string As uuid As uuid
knowledge_base_id
Required

ID of the Knowledge Dase of the document.

string As uuid As uuid
index_id
Required

ID of the index.

string As uuid As uuid
data_source_id
Optional

ID of the data source from which the document originates (if backed by a data source).

integer
created_at
Required

Unix timestamp (in seconds) when the document was added to the index.

integer
last_embedded_at
Required

Unix timestamp (in seconds) when the document was last embedded in the index.

string As uuid As uuid
last_indexed_by_id
Optional

Most recent indexing job affecting this document. Updated once the state of this indexing becomes INDEXED.

integer
size_bytes
Optional
Constraints: minimum: 0 default: 0

Size in bytes of the document.

string
hash_sha256
Optional

SHA256 hash of the document.

boolean
reindexing_needed
Required

If set, the document embeddings require an indexing to guarantee they are in sync with any updates from the data source.

Property Of
Returned By