Logo
Type aliases

RetrievalParams

RetrievalParams = object

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

Schema for the search params for an retrieval execution.

Properties

dense_similarity_top_k?

optional dense_similarity_top_k: number | null

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

Number of nodes for dense retrieval.


dense_similarity_cutoff?

optional dense_similarity_cutoff: number | null

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

Minimum similarity score wrt query for retrieval


sparse_similarity_top_k?

optional sparse_similarity_top_k: number | null

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

Number of nodes for sparse retrieval.


enable_reranking?

optional enable_reranking: boolean | null

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

Enable reranking for retrieval


rerank_top_n?

optional rerank_top_n: number | null

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

Number of reranked nodes for returning.


alpha?

optional alpha: number | null

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

Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.


search_filters?

optional search_filters: MetadataFilters | null

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

Search filters for retrieval.


files_top_k?

optional files_top_k: number | null

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

Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).


retrieval_mode?

optional retrieval_mode: RetrievalMode

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

The retrieval mode for the query.


retrieve_image_nodes?

optional retrieve_image_nodes: boolean

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

Whether to retrieve image nodes.


query

query: string

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

The query to retrieve against.


class_name?

optional class_name: string

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

On this page