API Reference

Retrievers

Retriever

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve

client.retrievers.retriever.search(stringretrieverID, RetrieverSearchParams { query, organization_id, project_id, 3 more } params, RequestOptionsoptions?): CompositeRetrievalResult { image_nodes, nodes, page_figure_nodes }

POST/api/v1/retrievers/{retriever_id}/retrieve

Retrieve data using a Retriever.

ParametersExpand Collapse

retrieverID: string

params: RetrieverSearchParams { query, organization_id, project_id, 3 more }

query: string

Body param: The query to retrieve against.

minLength1

organization_id?: string | null

Query param

formatuuid

project_id?: string | null

Query param

formatuuid

mode?: CompositeRetrievalMode

Body param: The mode of composite retrieval.

One of the following:

"routing"

"full"

rerank_config?: ReRankConfig { top_n, type }

Body param: The rerank configuration for composite retrieval.

top_n?: number

The number of nodes to retrieve after reranking over retrieved nodes from all retrieval tools.

minimum1

type?: "system_default" | "llm" | "cohere" | 3 more

The type of reranker to use.

One of the following:

"system_default"

"llm"

"cohere"

"bedrock"

"score"

"disabled"

Deprecatedrerank_top_n?: number | null

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

ReturnsExpand Collapse

CompositeRetrievalResult { image_nodes, nodes, page_figure_nodes }

Deprecatedimage_nodes?: Array<PageScreenshotNodeWithScore { node, score, class_name } >

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

node: Node { file_id, image_size, page_index, metadata }

file_id: string

The ID of the file that the page screenshot was taken from

formatuuid

image_size: number

The size of the image in bytes

minimum0

page_index: number

The index of the page for which the screenshot is taken (0-indexed)

minimum0

metadata?: Record<string, unknown> | null

Metadata for the screenshot

score: number

The score of the screenshot node

class_name?: string

nodes?: Array<Node>

The retrieved nodes from the composite retrieval.

node: Node { id, end_char_idx, pipeline_id, 5 more }

id: string

The ID of the retrieved node.

formatuuid

end_char_idx: number | null

The end character index of the retrieved node in the document

pipeline_id: string

The ID of the pipeline this node was retrieved from.

formatuuid

retriever_id: string

The ID of the retriever this node was retrieved from.

formatuuid

retriever_pipeline_name: string

The name of the retrieval pipeline this node was retrieved from.

start_char_idx: number | null

The start character index of the retrieved node in the document

text: string

The text of the retrieved node.

metadata?: Record<string, unknown>

Metadata associated with the retrieved node.

class_name?: string

score?: number | null

page_figure_nodes?: Array<PageFigureNodeWithScore { node, score, class_name } >

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

node: Node { confidence, figure_name, figure_size, 4 more }

confidence: number

The confidence of the figure

maximum1

minimum0

figure_name: string

The name of the figure

figure_size: number

The size of the figure in bytes

minimum0

file_id: string

The ID of the file that the figure was taken from

formatuuid

page_index: number

The index of the page for which the figure is taken (0-indexed)

minimum0

is_likely_noise?: boolean

Whether the figure is likely to be noise

metadata?: Record<string, unknown> | null

Metadata for the figure

score: number

The score of the figure node

class_name?: string

Retrieve

TypeScript

HTTP

TypeScript

Python

Java

Go

CLI Tool

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const compositeRetrievalResult = await client.retrievers.retriever.search(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { query: 'x' },
);

console.log(compositeRetrievalResult.image_nodes);

200 example

{
  "image_nodes": [
    {
      "node": {
        "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "image_size": 0,
        "page_index": 0,
        "metadata": {
          "foo": "bar"
        }
      },
      "score": 0,
      "class_name": "class_name"
    }
  ],
  "nodes": [
    {
      "node": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "end_char_idx": 0,
        "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "retriever_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "retriever_pipeline_name": "retriever_pipeline_name",
        "start_char_idx": 0,
        "text": "text",
        "metadata": {
          "foo": "bar"
        }
      },
      "class_name": "class_name",
      "score": 0
    }
  ],
  "page_figure_nodes": [
    {
      "node": {
        "confidence": 0,
        "figure_name": "figure_name",
        "figure_size": 0,
        "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "page_index": 0,
        "is_likely_noise": true,
        "metadata": {
          "foo": "bar"
        }
      },
      "score": 0,
      "class_name": "class_name"
    }
  ]
}

Returns Examples

200 example

{
  "image_nodes": [
    {
      "node": {
        "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "image_size": 0,
        "page_index": 0,
        "metadata": {
          "foo": "bar"
        }
      },
      "score": 0,
      "class_name": "class_name"
    }
  ],
  "nodes": [
    {
      "node": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "end_char_idx": 0,
        "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "retriever_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "retriever_pipeline_name": "retriever_pipeline_name",
        "start_char_idx": 0,
        "text": "text",
        "metadata": {
          "foo": "bar"
        }
      },
      "class_name": "class_name",
      "score": 0
    }
  ],
  "page_figure_nodes": [
    {
      "node": {
        "confidence": 0,
        "figure_name": "figure_name",
        "figure_size": 0,
        "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "page_index": 0,
        "is_likely_noise": true,
        "metadata": {
          "foo": "bar"
        }
      },
      "score": 0,
      "class_name": "class_name"
    }
  ]
}