DocumentChunksRetrievalResponse

Document chunks pulled from embeddings retrieval queries.

JSON Example

{
    "origin_name": "string",
    "origin_ref": "string",
    "retrieval_id": "ref01",
    "document_id": "string",
    "score": "number",
    "media_type": "string",
    "text": "string"
}

string

origin_name

Optional

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

string

origin_ref

Optional

Constraints: maxLength: 2048

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

string

retrieval_id

Required

Constraints: minLength: 1

Identifier of this response.

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.

Property Of

DocumentChunksRetrievalResponseList