Retrievers

Direct Retrieve

Changed on

Retrieve data using specified pipelines without creating a persistent retriever.

post/api/v1/retrievers/retrieve

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

mode'routing' | 'full'

Enum for the mode of composite retrieval.

rerank_top_ninteger nullable

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

querystring required

The query to retrieve against.

Response

Successful Response

Changes

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status