API Reference

Retrieval

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve

client.Retrieval.Get(ctx, params) (*RetrievalGetResponse, 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 RetrievalGetParams

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, *RetrievalGetParamsCustomFilterUnion]]Optional

Body param: Filters on user-defined metadata fields.

type RetrievalGetParamsCustomFilterValueFilter struct{…}

Filter on a single metadata field value.

Operator string

One of the following:

const RetrievalGetParamsCustomFilterValueFilterOperatorEq RetrievalGetParamsCustomFilterValueFilterOperator = "eq"

const RetrievalGetParamsCustomFilterValueFilterOperatorGt RetrievalGetParamsCustomFilterValueFilterOperator = "gt"

const RetrievalGetParamsCustomFilterValueFilterOperatorGte RetrievalGetParamsCustomFilterValueFilterOperator = "gte"

const RetrievalGetParamsCustomFilterValueFilterOperatorIn RetrievalGetParamsCustomFilterValueFilterOperator = "in"

const RetrievalGetParamsCustomFilterValueFilterOperatorLt RetrievalGetParamsCustomFilterValueFilterOperator = "lt"

const RetrievalGetParamsCustomFilterValueFilterOperatorLte RetrievalGetParamsCustomFilterValueFilterOperator = "lte"

const RetrievalGetParamsCustomFilterValueFilterOperatorNe RetrievalGetParamsCustomFilterValueFilterOperator = "ne"

const RetrievalGetParamsCustomFilterValueFilterOperatorNin RetrievalGetParamsCustomFilterValueFilterOperator = "nin"

Value RetrievalGetParamsCustomFilterValueFilterValueUnion

One of the following:

string

bool

float64

type RetrievalGetParamsCustomFilterValueFilterValueArray []RetrievalGetParamsCustomFilterValueFilterValueArrayItemUnion

One of the following:

string

bool

float64

type RetrievalGetParamsCustomFilterArray []RetrievalGetParamsCustomFilterArrayItem

Operator string

One of the following:

const RetrievalGetParamsCustomFilterArrayItemOperatorEq RetrievalGetParamsCustomFilterArrayItemOperator = "eq"

const RetrievalGetParamsCustomFilterArrayItemOperatorGt RetrievalGetParamsCustomFilterArrayItemOperator = "gt"

const RetrievalGetParamsCustomFilterArrayItemOperatorGte RetrievalGetParamsCustomFilterArrayItemOperator = "gte"

const RetrievalGetParamsCustomFilterArrayItemOperatorIn RetrievalGetParamsCustomFilterArrayItemOperator = "in"

const RetrievalGetParamsCustomFilterArrayItemOperatorLt RetrievalGetParamsCustomFilterArrayItemOperator = "lt"

const RetrievalGetParamsCustomFilterArrayItemOperatorLte RetrievalGetParamsCustomFilterArrayItemOperator = "lte"

const RetrievalGetParamsCustomFilterArrayItemOperatorNe RetrievalGetParamsCustomFilterArrayItemOperator = "ne"

const RetrievalGetParamsCustomFilterArrayItemOperatorNin RetrievalGetParamsCustomFilterArrayItemOperator = "nin"

Value RetrievalGetParamsCustomFilterArrayItemValueUnion

One of the following:

float64

type RetrievalGetParamsCustomFilterArrayItemValueArray []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.

minimum1

Rerank param.Field[RetrievalGetParamsRerank]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.

minimum1

ScoreThreshold param.Field[float64]Optional

Body param: Minimum score threshold for returned results.

StaticFilters param.Field[RetrievalGetParamsStaticFilters]Optional

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

ParsedDirectoryFileID RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOptional

Filter on a string field.

Operator string

One of the following:

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorEq RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "eq"

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorGt RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "gt"

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorGte RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "gte"

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorIn RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "in"

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorLt RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "lt"

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorLte RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "lte"

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorNe RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "ne"

const RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperatorNin RetrievalGetParamsStaticFiltersParsedDirectoryFileIDOperator = "nin"

Value RetrievalGetParamsStaticFiltersParsedDirectoryFileIDValueUnion

One of the following:

string

type RetrievalGetParamsStaticFiltersParsedDirectoryFileIDValueArray []string

TopK param.Field[int64]Optional

Body param: Maximum number of results to return. Values above 500 are capped at 500.

minimum1

VectorPipelineWeight param.Field[float64]Optional

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

ReturnsExpand Collapse

type RetrievalGetResponse struct{…}

Response containing retrieval results.

Results []RetrievalGetResponseResult

Ordered list of retrieved chunks.

Content string

Text content of the retrieved chunk.

Metadata map[string, RetrievalGetResponseResultMetadataUnion]Optional

User-defined metadata associated with the chunk.

One of the following:

string

int64

float64

bool

type RetrievalGetResponseResultMetadataMetadataListValue []string

RerankScore float64Optional

Relevance score from the reranker, if reranking was applied.

Score float64Optional

Hybrid search relevance score.

StaticFields RetrievalGetResponseResultStaticFieldsOptional

Built-in fields stored for every exported chunk.

Attachments []RetrievalGetResponseResultStaticFieldsAttachmentOptional

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

Java

C#

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  retrieval, err := client.Retrieval.Get(context.TODO(), llamacloud.RetrievalGetParams{
    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"
      }
    }
  ]
}