RetrieveResults

RetrieveResults = object

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

Schema for the result of an retrieval execution.

Properties

pipeline_id

pipeline_id: string

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

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

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

The image nodes retrieved by the pipeline for the given query.

---

retrieval_latency?

optional retrieval_latency: object

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

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

Metadata associated with the retrieval execution

Index Signature

[key: string]: string

---

class_name?

optional class_name: string

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