API Reference

Retrievers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Upsert Retriever

client.Retrievers.Upsert(ctx, params) (*Retriever, error)

PUT/api/v1/retrievers

Upsert a new Retriever.

ParametersExpand Collapse

params RetrieverUpsertParams

RetrieverCreate param.Field[RetrieverCreate]

Body param

OrganizationID param.Field[string]optional

Query param

formatuuid

ProjectID param.Field[string]optional

Query param

formatuuid

ReturnsExpand Collapse

type Retriever struct{…}

An entity that retrieves context nodes from several sub RetrieverTools.

ID string

Unique identifier

formatuuid

Name string

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

maxLength3000

minLength1

ProjectID string

The ID of the project this retriever resides in.

formatuuid

CreatedAt Timeoptional

Creation datetime

formatdate-time

Pipelines []RetrieverPipelineoptional

The pipelines this retriever uses.

Description string

A description of the retriever tool.

maxLength15000

Name string

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

maxLength3000

minLength1

PipelineID string

The ID of the pipeline this tool uses.

formatuuid

PresetRetrievalParameters PresetRetrievalParamsRespoptional

Parameters for retrieval configuration.

Alpha float64optional

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

maximum1

minimum0

ClassName stringoptional

DenseSimilarityCutoff float64optional

Minimum similarity score wrt query for retrieval

maximum1

minimum0

DenseSimilarityTopK int64optional

Number of nodes for dense retrieval.

maximum100

minimum1

EnableReranking booloptional

Enable reranking for retrieval

FilesTopK int64optional

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

maximum5

minimum1

RerankTopN int64optional

Number of reranked nodes for returning.

maximum100

minimum1

RetrievalMode RetrievalModeoptional

The retrieval mode for the query.

One of the following:

const RetrievalModeChunks RetrievalMode = "chunks"

const RetrievalModeFilesViaMetadata RetrievalMode = "files_via_metadata"

const RetrievalModeFilesViaContent RetrievalMode = "files_via_content"

const RetrievalModeAutoRouted RetrievalMode = "auto_routed"

DeprecatedRetrieveImageNodes booloptional

Whether to retrieve image nodes.

RetrievePageFigureNodes booloptional

Whether to retrieve page figure nodes.

RetrievePageScreenshotNodes booloptional

Whether to retrieve page screenshot nodes.

SearchFilters MetadataFiltersoptional

Metadata filters for vector stores.

Filters []MetadataFiltersFilterUnion

One of the following:

type MetadataFiltersFilterMetadataFilter struct{…}

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 string

Value MetadataFiltersFilterMetadataFilterValueUnion

One of the following:

float64

string

type MetadataFiltersFilterMetadataFilterValueArray []string

type MetadataFiltersFilterMetadataFilterValueArray []float64

type MetadataFiltersFilterMetadataFilterValueArray []int64

Operator stringoptional

Vector store filter operator.

One of the following:

const MetadataFiltersFilterMetadataFilterOperatorEquals MetadataFiltersFilterMetadataFilterOperator = "=="

const MetadataFiltersFilterMetadataFilterOperatorGreater MetadataFiltersFilterMetadataFilterOperator = ">"

const MetadataFiltersFilterMetadataFilterOperatorLess MetadataFiltersFilterMetadataFilterOperator = "<"

const MetadataFiltersFilterMetadataFilterOperatorNotEquals MetadataFiltersFilterMetadataFilterOperator = "!="

const MetadataFiltersFilterMetadataFilterOperatorGreaterOrEquals MetadataFiltersFilterMetadataFilterOperator = ">="

const MetadataFiltersFilterMetadataFilterOperatorLessOrEquals MetadataFiltersFilterMetadataFilterOperator = "<="

const MetadataFiltersFilterMetadataFilterOperatorIn MetadataFiltersFilterMetadataFilterOperator = "in"

const MetadataFiltersFilterMetadataFilterOperatorNin MetadataFiltersFilterMetadataFilterOperator = "nin"

const MetadataFiltersFilterMetadataFilterOperatorAny MetadataFiltersFilterMetadataFilterOperator = "any"

const MetadataFiltersFilterMetadataFilterOperatorAll MetadataFiltersFilterMetadataFilterOperator = "all"

const MetadataFiltersFilterMetadataFilterOperatorTextMatch MetadataFiltersFilterMetadataFilterOperator = "text_match"

const MetadataFiltersFilterMetadataFilterOperatorTextMatchInsensitive MetadataFiltersFilterMetadataFilterOperator = "text_match_insensitive"

const MetadataFiltersFilterMetadataFilterOperatorContains MetadataFiltersFilterMetadataFilterOperator = "contains"

const MetadataFiltersFilterMetadataFilterOperatorIsEmpty MetadataFiltersFilterMetadataFilterOperator = "is_empty"

type MetadataFilters MetadataFilters

Metadata filters for vector stores.

Condition MetadataFiltersConditionoptional

Vector store filter conditions to combine different filters.

One of the following:

const MetadataFiltersConditionAnd MetadataFiltersCondition = "and"

const MetadataFiltersConditionOr MetadataFiltersCondition = "or"

const MetadataFiltersConditionNot MetadataFiltersCondition = "not"

SearchFiltersInferenceSchema map[string, PresetRetrievalParamsSearchFiltersInferenceSchemaUnionResp]optional

JSON Schema that will be used to infer search_filters. Omit or leave as null to skip inference.

One of the following:

type PresetRetrievalParamsSearchFiltersInferenceSchemaMap map[string, any]

type PresetRetrievalParamsSearchFiltersInferenceSchemaArray []any

string

float64

bool

SparseSimilarityTopK int64optional

Number of nodes for sparse retrieval.

maximum100

minimum1

UpdatedAt Timeoptional

Update datetime

formatdate-time

Upsert Retriever

Go

HTTP

TypeScript

Python

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/llamacloud-prod-go"
  "github.com/stainless-sdks/llamacloud-prod-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  retriever, err := client.Retrievers.Upsert(context.TODO(), llamacloudprod.RetrieverUpsertParams{
    RetrieverCreate: llamacloudprod.RetrieverCreateParam{
      Name: "x",
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", retriever.ID)
}

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "name": "x",
  "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "pipelines": [
    {
      "description": "description",
      "name": "x",
      "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "preset_retrieval_parameters": {
        "alpha": 0,
        "class_name": "class_name",
        "dense_similarity_cutoff": 0,
        "dense_similarity_top_k": 1,
        "enable_reranking": true,
        "files_top_k": 1,
        "rerank_top_n": 1,
        "retrieval_mode": "chunks",
        "retrieve_image_nodes": true,
        "retrieve_page_figure_nodes": true,
        "retrieve_page_screenshot_nodes": true,
        "search_filters": {
          "filters": [
            {
              "key": "key",
              "value": 0,
              "operator": "=="
            }
          ],
          "condition": "and"
        },
        "search_filters_inference_schema": {
          "foo": {
            "foo": "bar"
          }
        },
        "sparse_similarity_top_k": 1
      }
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "name": "x",
  "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "pipelines": [
    {
      "description": "description",
      "name": "x",
      "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "preset_retrieval_parameters": {
        "alpha": 0,
        "class_name": "class_name",
        "dense_similarity_cutoff": 0,
        "dense_similarity_top_k": 1,
        "enable_reranking": true,
        "files_top_k": 1,
        "rerank_top_n": 1,
        "retrieval_mode": "chunks",
        "retrieve_image_nodes": true,
        "retrieve_page_figure_nodes": true,
        "retrieve_page_screenshot_nodes": true,
        "search_filters": {
          "filters": [
            {
              "key": "key",
              "value": 0,
              "operator": "=="
            }
          ],
          "condition": "and"
        },
        "search_filters_inference_schema": {
          "foo": {
            "foo": "bar"
          }
        },
        "sparse_similarity_top_k": 1
      }
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}