Update Retriever

PUT 
/api/v1/retrievers/:retriever_id

Update an existing Retriever.

Request

Path Parameters

retriever_id uuidrequired

Cookie Parameters

session any

application/json

Body

required

name

object

required

A name for the retriever.

anyOf

MOD1

string

Possible values: non-empty and <= 3000 characters

pipelines

object

required

The pipelines this retriever uses.

anyOf

MOD1

Array [

name

object

required

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

anyOf

MOD1

string

Possible values: non-empty and <= 3000 characters

description

object

required

A description of the retriever tool.

anyOf

MOD1

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

MOD1

integer

Possible values: >= 1 and <= 100

dense_similarity_cutoff

object

Minimum similarity score wrt query for retrieval

anyOf

MOD1

number

Possible values: <= 1

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

Metadata filters for vector stores.

filters

object[]

required

Array [

anyOf

MetadataFilter

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

MOD1

integer

MOD2

number

MOD3

string

MOD4

Array [

string

]

MOD5

Array [

number

]

MOD6

Array [

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

FilterCondition

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

MOD1

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

]

Responses

200

Successful Response

application/json

Schema

Schema

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

MOD1

string

Possible values: non-empty and <= 3000 characters

description

object

required

A description of the retriever tool.

anyOf

MOD1

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

MOD1

integer

Possible values: >= 1 and <= 100

dense_similarity_cutoff

object

Minimum similarity score wrt query for retrieval

anyOf

MOD1

number

Possible values: <= 1

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

Metadata filters for vector stores.

filters

object[]

required

Array [

anyOf

MetadataFilter

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

MOD1

integer

MOD2

number

MOD3

string

MOD4

Array [

string

]

MOD5

Array [

number

]

MOD6

Array [

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

FilterCondition

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

MOD1

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

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

project_id uuidrequired

The ID of the project this retriever resides in.

Example (from schema)

{
  "name": "string",
  "pipelines": [
    {
      "name": "string",
      "description": "string",
      "pipeline_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "preset_retrieval_parameters": {
        "dense_similarity_top_k": 0,
        "dense_similarity_cutoff": 0,
        "sparse_similarity_top_k": 0,
        "enable_reranking": true,
        "rerank_top_n": 0,
        "alpha": 0,
        "search_filters": {},
        "files_top_k": 0,
        "retrieval_mode": "chunks",
        "retrieve_image_nodes": false,
        "class_name": "base_component"
      }
    }
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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"
    }
  ]
}