DocumentChunksRetrievalResponse

DocumentChunksRetrievalResponse
DocumentChunksRetrievalResponse

Document chunks pulled from embeddings retrieval queries.

JSON Example
{
    "origin_name": "string",
    "origin_ref": "string",
    "document_id": "string",
    "score": "number",
    "text": "string"
}
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
document_id
Required

ID of the document from which the text originates.

number
score
Required

Similarity score between text and query.

media_type
Optional

Media type detected for the document from which the text originates.

string
text
Required

Text chunk of the document retrieved for the query.