Interface: RetrievedVectorDocument
Defined in: packages/agentos/src/rag/IVectorStore.ts:145
Represents a single document retrieved from a query, including its similarity score.
RetrievedVectorDocument
Extends
Properties
embedding
embedding:
number[]
Defined in: packages/agentos/src/rag/IVectorStore.ts:106
The vector embedding of the document's content.
Inherited from
id
id:
string
Defined in: packages/agentos/src/rag/IVectorStore.ts:105
A unique identifier for the document.
Inherited from
metadata?
optionalmetadata:Record<string,MetadataValue>
Defined in: packages/agentos/src/rag/IVectorStore.ts:107
A flexible key-value store for document metadata. Values can be scalars or arrays of scalars. Used for filtering and providing context.
Inherited from
similarityScore
similarityScore:
number
Defined in: packages/agentos/src/rag/IVectorStore.ts:146
The similarity score of this document with respect to the query vector. The meaning of this score depends on the similarity metric used by the vector store (e.g., cosine similarity, Euclidean distance).
textContent?
optionaltextContent:string
Defined in: packages/agentos/src/rag/IVectorStore.ts:108
Optional: The raw text content of the document. Some use cases might store this alongside the embedding, while others might fetch it from a primary store using the ID.