Skip to main content

List Retrievers

GET 
/api/v1/retrievers

List Retrievers for a project.

Request​

Query Parameters

    project_id any
    organization_id any

Cookie Parameters

    session any

Responses​

Successful Response

Schema

  • Array [

    • name Name (string)required

    A name for the retriever tool. Will default to the pipeline name if not provided.

    Possible values: non-empty and <= 3000 characters

    pipelines

    object[]

    The pipelines this retriever uses.

  • Array [

    • name

    object

    required

    A name for the retriever tool. Will default to the pipeline name if not provided.

    anyOf

    string

    Possible values: non-empty and <= 3000 characters

    description

    object

    required

    A description of the retriever tool.

    anyOf

    string

    Possible values: <= 15000 characters

    pipeline_id uuidrequired

    The ID of the pipeline this tool uses.

    preset_retrieval_parameters

    object

    Schema for the search params for an retrieval execution that can be preset for a pipeline.

    dense_similarity_top_k

    object

    Number of nodes for dense retrieval.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    dense_similarity_cutoff

    object

    Minimum similarity score wrt query for retrieval

    anyOf

    number

    Possible values: <= 1

    sparse_similarity_top_k

    object

    Number of nodes for sparse retrieval.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    enable_reranking

    object

    Enable reranking for retrieval

    anyOf

    boolean

    rerank_top_n

    object

    Number of reranked nodes for returning.

    anyOf

    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

    number

    Possible values: <= 1

    search_filters

    object

    Search filters for retrieval.

    anyOf

    Metadata filters for vector stores.

    filters

    object[]

    required

  • Array [

    • anyOf

    Comprehensive metadata filter for vector stores to support more operators.

    Value uses Strict* types, as int, float and str are compatible types and were all converted to string before.

    See: https://docs.pydantic.dev/latest/usage/types/#strict-types

    key Key (string)required

    value

    object

    required

    anyOf

    integer

    operator FilterOperator (string)

    Vector store filter operator.

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

    Default value: ==

  • ]

    • condition

    object

    anyOf

    Vector store filter conditions to combine different filters.

    string

    Possible values: [and, or, not]

    files_top_k

    object

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

    anyOf

    integer

    Possible values: >= 1 and <= 5

    retrieval_mode RetrievalMode (string)

    The retrieval mode for the query.

    Possible values: [chunks, files_via_metadata, files_via_content, auto_routed]

    Default value: chunks
    retrieve_image_nodes Retrieve Image Nodes (boolean)

    Whether to retrieve image nodes.

    Default value: false
    class_name Class Name (string)
    Default value: base_component

  • ]

    • id uuidrequired

    Unique identifier

    created_at

    object

    Creation datetime

    anyOf

    string

    updated_at

    object

    Update datetime

    anyOf

    string

    project_id uuidrequired

    The ID of the project this retriever resides in.

  • ]