Interface: QueryOptions

Defined in: packages/agentos/src/rag/IVectorStore.ts:126

Options for a vector store query operation.

QueryOptions

Properties

customParams?

optional customParams: Record<string, any>

Defined in: packages/agentos/src/rag/IVectorStore.ts:134

Provider-specific parameters for the query.

---

filter?

optional filter: MetadataFilter

Defined in: packages/agentos/src/rag/IVectorStore.ts:128

Metadata filter to apply to the search. Only documents matching the filter will be considered.

---

includeEmbedding?

optional includeEmbedding: boolean

Defined in: packages/agentos/src/rag/IVectorStore.ts:129

Whether to include the embedding vector in the retrieved documents.

---

includeMetadata?

optional includeMetadata: boolean

Defined in: packages/agentos/src/rag/IVectorStore.ts:130

Whether to include metadata in the retrieved documents.

---

includeTextContent?

optional includeTextContent: boolean

Defined in: packages/agentos/src/rag/IVectorStore.ts:131

Whether to include the textContent in the retrieved documents.

---

minSimilarityScore?

optional minSimilarityScore: number

Defined in: packages/agentos/src/rag/IVectorStore.ts:132

Optional minimum similarity score (0-1, or specific to metric) for a document to be included in the results. Interpretation depends on the store's similarity metric.

---

topK?

optional topK: number

Defined in: packages/agentos/src/rag/IVectorStore.ts:127

The number of most similar documents to retrieve.

---

userId?

optional userId: string

Defined in: packages/agentos/src/rag/IVectorStore.ts:133

Optional user ID, which might be used for multi-tenancy filters if the store supports it.