Search Files

client.Beta.Retrieval.Search(ctx, params) (*BetaRetrievalSearchResponse, error)

POST/api/v1/retrieval/files/search

Search for files by name.

ParametersExpand Collapse

params BetaRetrievalSearchParams

IndexID param.Field[string]

Body param: ID of the index to search within.

OrganizationID param.Field[string]optional

Query param

formatuuid

ProjectID param.Field[string]optional

Query param

formatuuid

FileName param.Field[string]optional

Body param: Exact file name to match.

FileNameContains param.Field[string]optional

Body param: Substring match on file name (case-insensitive).

Limit param.Field[int64]optional

Body param: Maximum number of files to return.

ReturnsExpand Collapse

type BetaRetrievalSearchResponse struct{…}

File search results.

Files []BetaRetrievalSearchResponseFile

Matching files with names.

FileID string

ID of the file.

FileName string

Display name of the file.

Search Files

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"),
  )
  response, err := client.Beta.Retrieval.Search(context.TODO(), llamacloudprod.BetaRetrievalSearchParams{
    IndexID: "idx-abc123",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Files)
}

{
  "files": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ]
}

Returns Examples

{
  "files": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ]
}