RetrievalParams

RetrievalParams = object

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

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:7503

Number of nodes for dense retrieval.

---

dense_similarity_cutoff?

optional dense_similarity_cutoff: number | null

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

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:7511

Number of nodes for sparse retrieval.

---

enable_reranking?

optional enable_reranking: boolean | null

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

Enable reranking for retrieval

---

rerank_top_n?

optional rerank_top_n: number | null

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

Number of reranked nodes for returning.

---

alpha?

optional alpha: number | null

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

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:7527

Search filters for retrieval.

---

search_filters_inference_schema?

optional search_filters_inference_schema: {[key: string]: null | string | number | boolean | unknown[] | {[key: string]: unknown; }; } | null

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

JSON Schema that will be used to infer search_filters. Omit or leave as null to skip inference.

---

files_top_k?

optional files_top_k: number | null

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

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:7550

The retrieval mode for the query.

---

retrieve_image_nodes?

optional retrieve_image_nodes: boolean

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

Whether to retrieve image nodes.

Deprecated

---

retrieve_page_screenshot_nodes?

optional retrieve_page_screenshot_nodes: boolean

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

Whether to retrieve page screenshot nodes.

---

retrieve_page_figure_nodes?

optional retrieve_page_figure_nodes: boolean

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

Whether to retrieve page figure nodes.

---

query

query: string

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

The query to retrieve against.

---

class_name?

optional class_name: string

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