RetrieveResults

RetrieveResults = object

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

Schema for the result of an retrieval execution.

Properties

pipeline_id

pipeline_id: string

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

The ID of the pipeline that the query was retrieved against.

---

retrieval_nodes

retrieval_nodes: TextNodeWithScore[]

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

The nodes retrieved by the pipeline for the given query.

---

image_nodes?

optional image_nodes: PageScreenshotNodeWithScore[]

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

The image nodes retrieved by the pipeline for the given query. Deprecated - will soon be replaced with 'page_screenshot_nodes'.

Deprecated

---

page_figure_nodes?

optional page_figure_nodes: PageFigureNodeWithScore[]

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

The page figure nodes retrieved by the pipeline for the given query.

---

retrieval_latency?

optional retrieval_latency: object

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

The end-to-end latency for retrieval and reranking.

Index Signature

[key: string]: number

---

metadata?

optional metadata: object

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

Metadata associated with the retrieval execution

Index Signature

[key: string]: string

---

inferred_search_filters?

optional inferred_search_filters: MetadataFilters | null

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

The inferred search filters for the query.

---

class_name?

optional class_name: string

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