Represents a retrieved document or multimedia chunk.
Signature:
export declare interface RetrievalResult
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| id | string | The unique identifier of the retrieved record. | |
| content | readonly ContentPart[] | The list of multi-modal parts in the retrieved record. | |
| metadata | Record |
The metadata associated with the retrieved record. | |
| score | number | The similarity/relevance score of this retrieved result. |
RetrievalResult.id
The unique identifier of the retrieved record.
Signature:
readonly id: string;
RetrievalResult.content
The list of multi-modal parts in the retrieved record.
Signature:
readonly content: readonly ContentPart[];
RetrievalResult.metadata
The metadata associated with the retrieved record.
Signature:
readonly metadata: Record<string, string>;
RetrievalResult.score
The similarity/relevance score of this retrieved result.
Signature:
readonly score: number;