DirectRetrievalParams

DirectRetrievalParams = object

Defined in: packages/cloud/src/client/types.gen.ts:2558

Properties

mode?

optional mode: CompositeRetrievalMode

Defined in: packages/cloud/src/client/types.gen.ts:2562

The mode of composite retrieval.

---

rerank_top_n?

optional rerank_top_n: number | null

Defined in: packages/cloud/src/client/types.gen.ts:2567

(use rerank_config.top_n instead) The number of nodes to retrieve after reranking over retrieved nodes from all retrieval tools.

Deprecated

---

rerank_config?

optional rerank_config: ReRankConfig

Defined in: packages/cloud/src/client/types.gen.ts:2571

The rerank configuration for composite retrieval.

---

query

query: string

Defined in: packages/cloud/src/client/types.gen.ts:2575

The query to retrieve against.

---

pipelines?

optional pipelines: RetrieverPipeline[]

Defined in: packages/cloud/src/client/types.gen.ts:2579

The pipelines to use for retrieval.