Search Files

client.beta.retrieval.search(, ?): RetrievalSearchResponse { files }

POST/api/v1/retrieval/files/search

Search for files by name.

ParametersExpand Collapse

params: RetrievalSearchParams { index_id, organization_id, project_id, 3 more }

index_id: string

Body param: ID of the index to search within.

organization_id?: string | null

Query param

formatuuid

project_id?: string | null

Query param

formatuuid

file_name?: string | null

Body param: Exact file name to match.

file_name_contains?: string | null

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

limit?: number | null

Body param: Maximum number of files to return.

ReturnsExpand Collapse

RetrievalSearchResponse { files }

File search results.

files: Array<File>

Matching files with names.

file_id: string

ID of the file.

file_name: string

Display name of the file.

Search Files

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.beta.retrieval.search({ index_id: 'idx-abc123' });

console.log(response.files);

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

Returns Examples

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