Run Search

POST 
/api/v1/pipelines/:pipeline_id/retrieve

Get retrieval results for a managed pipeline and a query

Request

Path Parameters

pipeline_id uuidrequired

Cookie Parameters

session any

application/json

Body

required

dense_similarity_top_k

object

Number of nodes for dense retrieval.

anyOf

MOD1

integer

Possible values: >= 1 and <= 100

sparse_similarity_top_k

object

Number of nodes for sparse retrieval.

anyOf

MOD1

integer

Possible values: >= 1 and <= 100

enable_reranking

object

Enable reranking for retrieval

anyOf

MOD1

boolean

rerank_top_n

object

Number of reranked nodes for returning.

anyOf

MOD1

integer

Possible values: >= 1 and <= 100

alpha

object

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

anyOf

MOD1

number

Possible values: <= 1

search_filters

object

Search filters for retrieval.

anyOf

MetadataFilters

filters

object[]

required

Array [

anyOf

MetadataFilter

key Key (string)required

value

object

required

anyOf

MOD1

integer

MOD2

number

MOD3

string

MOD4

Array [

string

]

MOD5

Array [

number

]

MOD6

Array [

integer

]

operator FilterOperator (string)

Possible values: [==, >, <, !=, >=, <=, in, nin, any, all, text_match, contains, is_empty]

Default value: ==

Vector store filter operator.

]

condition

object

anyOf

FilterCondition

string

Possible values: [and, or]

files_top_k

object

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

anyOf

MOD1

integer

Possible values: >= 1 and <= 5

retrieval_mode RetrievalMode (string)

Possible values: [chunks, files_via_metadata, files_via_content]

Default value: chunks

The retrieval mode for the query.

retrieve_image_nodes Retrieve Image Nodes (boolean)

Whether to retrieve image nodes.

query Query (string)required

The query to retrieve against.

class_name Class Name (string)

Default value: base_component

Responses

200

Successful Response

application/json

Schema

Schema

pipeline_id uuidrequired

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

retrieval_nodes

object[]

required

The nodes retrieved by the pipeline for the given query.

Array [

node

object

required

id_ Id (string)

Unique ID of the node.

embedding

object

Embedding of the node.

anyOf

MOD1

Array [

number

]

extra_info object

A flat dictionary of metadata fields

excluded_embed_metadata_keys string[]

Metadata keys that are excluded from text for the embed model.

excluded_llm_metadata_keys string[]

Metadata keys that are excluded from text for the LLM.

relationships

object

A mapping of relationships to other node information.

anyOf

text Text (string)

Text content of the node.

mimetype Mimetype (string)

Default value: text/plain

MIME type of the node content.

start_char_idx

object

Start char index of the node.

anyOf

MOD1

integer

end_char_idx

object

End char index of the node.

anyOf

MOD1

integer

text_template Text Template (string)

Default value: `{metadata_str}

{content}`

Template for how text is formatted, with {content} and {metadata_str} placeholders.

metadata_template Metadata Template (string)

Default value: {key}: {value}

Template for how metadata is formatted, with {key} and {value} placeholders.

metadata_seperator Metadata Seperator (string)

Default value:

Separator between metadata fields when converting to string.

class_name Class Name (string)

Default value: TextNode

score

object

anyOf

MOD1

number

class_name Class Name (string)

Default value: NodeWithScore

]

image_nodes

object[]

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

Array [

node

object

required

page_index Page Index (integer)required

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

file_id uuidrequired

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

image_size Image Size (integer)required

The size of the image in bytes

score Score (number)required

The score of the screenshot node

class_name Class Name (string)

Default value: NodeWithScore

]

retrieval_latency

object

required

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

property name* number
class_name Class Name (string)

Default value: RetrieveResults

Example (from schema)

{
  "pipeline_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retrieval_nodes": [
    {
      "node": {
        "id_": "string",
        "embedding": [
          null
        ],
        "extra_info": {},
        "excluded_embed_metadata_keys": [
          "string"
        ],
        "excluded_llm_metadata_keys": [
          "string"
        ],
        "relationships": {},
        "text": "string",
        "mimetype": "text/plain",
        "start_char_idx": 0,
        "end_char_idx": 0,
        "text_template": "{metadata_str}\n\n{content}",
        "metadata_template": "{key}: {value}",
        "metadata_seperator": "\n",
        "class_name": "TextNode"
      },
      "score": 0,
      "class_name": "NodeWithScore"
    }
  ],
  "image_nodes": [
    {
      "node": {
        "page_index": 0,
        "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "image_size": 0
      },
      "score": 0,
      "class_name": "NodeWithScore"
    }
  ],
  "retrieval_latency": {},
  "class_name": "RetrieveResults"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...