API Reference

Beta

Retrieval

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve

client.Beta.Retrieval.Get(ctx, params) (*BetaRetrievalGetResponse, error)

POST/api/v1/retrieval/retrieve

Retrieve relevant chunks via hybrid search (vector + full-text), with filtering on built-in or user-defined metadata.

ParametersExpand Collapse

params BetaRetrievalGetParams

IndexID param.Field[string]

Body param: ID of the index to retrieve against.

Query param.Field[string]

Body param: Natural-language query to retrieve relevant chunks.

OrganizationID param.Field[string]optional

Query param

formatuuid

ProjectID param.Field[string]optional

Query param

formatuuid

CustomFilters param.Field[map[string, BetaRetrievalGetParamsCustomFilterUnion]]optional

Body param: Filters on user-defined metadata fields.

type BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloat struct{…}

Operator string

One of the following:

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorEq BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "eq"

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorNe BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "ne"

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorGt BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "gt"

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorLt BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "lt"

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorGte BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "gte"

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorLte BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "lte"

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorIn BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "in"

const BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperatorNin BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatOperator = "nin"

Value BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatValueUnion

One of the following:

string

bool

float64

type BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatValueArray []BetaRetrievalGetParamsCustomFilterFilterTypeUnionStrIntBoolFloatValueArrayItemUnion

One of the following:

string

bool

float64

type BetaRetrievalGetParamsCustomFilterArray []BetaRetrievalGetParamsCustomFilterArrayItem

Operator string

One of the following:

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorEq BetaRetrievalGetParamsCustomFilterArrayItemOperator = "eq"

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorNe BetaRetrievalGetParamsCustomFilterArrayItemOperator = "ne"

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorGt BetaRetrievalGetParamsCustomFilterArrayItemOperator = "gt"

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorLt BetaRetrievalGetParamsCustomFilterArrayItemOperator = "lt"

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorGte BetaRetrievalGetParamsCustomFilterArrayItemOperator = "gte"

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorLte BetaRetrievalGetParamsCustomFilterArrayItemOperator = "lte"

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorIn BetaRetrievalGetParamsCustomFilterArrayItemOperator = "in"

const BetaRetrievalGetParamsCustomFilterArrayItemOperatorNin BetaRetrievalGetParamsCustomFilterArrayItemOperator = "nin"

Value BetaRetrievalGetParamsCustomFilterArrayItemValueUnion

One of the following:

float64

type BetaRetrievalGetParamsCustomFilterArrayItemValueArray []float64

FullTextPipelineWeight param.Field[float64]optional

Body param: Weight of the full-text search pipeline (0-1).

NumCandidates param.Field[int64]optional

Body param: Number of candidates for approximate nearest neighbor search.

Rerank param.Field[BetaRetrievalGetParamsRerank]optional

Body param: Reranking configuration applied after hybrid search. Enabled by default.

Enabled booloptional

Set to false to disable reranking.

TopN int64optional

Number of results to return after reranking.

ScoreThreshold param.Field[float64]optional

Body param: Minimum score threshold for returned results.

StaticFilters param.Field[BetaRetrievalGetParamsStaticFilters]optional

Body param: Filters on built-in document fields (page range, chunk index, etc.).

ParsedDirectoryFileID BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDoptional

Operator string

One of the following:

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorEq BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "eq"

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorNe BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "ne"

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorGt BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "gt"

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorLt BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "lt"

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorGte BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "gte"

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorLte BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "lte"

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorIn BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "in"

const BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorNin BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "nin"

Value BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDValueUnion

One of the following:

string

type BetaRetrievalGetParamsStaticFiltersParsedDirectoryFileIDValueArray []string

TopK param.Field[int64]optional

Body param: Maximum number of results to return.

VectorPipelineWeight param.Field[float64]optional

Body param: Weight of the vector search pipeline (0-1).

ReturnsExpand Collapse

type BetaRetrievalGetResponse struct{…}

Response containing retrieval results.

Results []BetaRetrievalGetResponseResult

Ordered list of retrieved chunks.

Content string

Text content of the retrieved chunk.

Metadata map[string, BetaRetrievalGetResponseResultMetadataUnion]optional

User-defined metadata associated with the chunk.

One of the following:

string

float64

bool

type BetaRetrievalGetResponseResultMetadataArray []string

RerankScore float64optional

Relevance score from the reranker, if reranking was applied.

Score float64optional

Hybrid search relevance score.

StaticFields BetaRetrievalGetResponseResultStaticFieldsoptional

Built-in fields stored for every exported chunk.

Attachments []BetaRetrievalGetResponseResultStaticFieldsAttachmentoptional

Attachments associated with the chunk

AttachmentName string

Attachment-relative path, e.g. ‘screenshots/page_7.jpg’.

SourceID string

File ID to pass as source_id when fetching the attachment.

Type string

Attachment kind, e.g. ‘screenshot’, ‘items’.

ChunkEndChar int64optional

End character offset of the chunk.

ChunkIndex int64optional

Index of the chunk within the file.

ChunkStartChar int64optional

Start character offset of the chunk.

ChunkTokenCount int64optional

Token count of the chunk.

PageRangeEnd int64optional

Last page number covered by this chunk.

PageRangeStart int64optional

First page number covered by this chunk.

ParsedDirectoryFileID stringoptional

ID of the parsed file.

Retrieve

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"),
  )
  retrieval, err := client.Beta.Retrieval.Get(context.TODO(), llamacloudprod.BetaRetrievalGetParams{
    IndexID: "idx-abc123",
    Query: "What are the key findings?",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", retrieval.Results)
}

200 example

{
  "results": [
    {
      "content": "content",
      "metadata": {
        "foo": "string"
      },
      "rerank_score": 0,
      "score": 0,
      "static_fields": {
        "attachments": [
          {
            "attachment_name": "attachment_name",
            "source_id": "source_id",
            "type": "type"
          }
        ],
        "chunk_end_char": 0,
        "chunk_index": 0,
        "chunk_start_char": 0,
        "chunk_token_count": 0,
        "page_range_end": 0,
        "page_range_start": 0,
        "parsed_directory_file_id": "parsed_directory_file_id"
      }
    }
  ]
}

Returns Examples

200 example

{
  "results": [
    {
      "content": "content",
      "metadata": {
        "foo": "string"
      },
      "rerank_score": 0,
      "score": 0,
      "static_fields": {
        "attachments": [
          {
            "attachment_name": "attachment_name",
            "source_id": "source_id",
            "type": "type"
          }
        ],
        "chunk_end_char": 0,
        "chunk_index": 0,
        "chunk_start_char": 0,
        "chunk_token_count": 0,
        "page_range_end": 0,
        "page_range_start": 0,
        "parsed_directory_file_id": "parsed_directory_file_id"
      }
    }
  ]
}