Find Files

RetrievalFindPage beta().retrieval().find(, )

POST/api/v1/retrieval/files/find

Search for files by name.

ParametersExpand Collapse

RetrievalFindParams params

Optional<String> organizationId

Optional<String> projectId

String indexId

ID of the index to search within.

Optional<String> fileName

Exact file name to match.

Optional<String> fileNameContains

Substring match on file name (case-insensitive).

Optional<Long> pageSize

The maximum number of items to return. The service may return fewer than this value. If unspecified, a default page size will be used. The maximum value is typically 1000; values above this will be coerced to the maximum.

Optional<String> pageToken

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

ReturnsExpand Collapse

class RetrievalFindResponse:

A file returned by find.

String fileId

ID of the file.

String fileName

Display name of the file.

Find Files

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.beta.retrieval.RetrievalFindPage;
import com.llamacloud_prod.api.models.beta.retrieval.RetrievalFindParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        RetrievalFindParams params = RetrievalFindParams.builder()
            .indexId("idx-abc123")
            .build();
        RetrievalFindPage page = client.beta().retrieval().find(params);
    }
}

{
  "items": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}