List vector store files in a batch

vector_stores.file_batches.list_files(batch_id, **kwargs) -> CursorPage<VectorStoreFile { id, created_at, last_error, 6 more } >

GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Returns a list of vector store files in a batch.

ParametersExpand Collapse

vector_store_id: String

batch_id: String

after: String

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before: String

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

filter: :in_progress | :completed | :failed | :cancelled

Filter by file status. One of in_progress, completed, failed, cancelled.

Accepts one of the following:

:in_progress

:completed

:failed

:cancelled

limit: Integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order: :asc | :desc

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Accepts one of the following:

:asc

:desc

ReturnsExpand Collapse

class VectorStoreFile { id, created_at, last_error, 6 more }

A list of files attached to a vector store.

id: String

The identifier, which can be referenced in API endpoints.

created_at: Integer

The Unix timestamp (in seconds) for when the vector store file was created.

last_error: { code, message}

The last error associated with this vector store file. Will be null if there are no errors.

code: :server_error | :unsupported_file | :invalid_file

One of server_error, unsupported_file, or invalid_file.

Accepts one of the following:

:server_error

:unsupported_file

:invalid_file

message: String

A human-readable description of the error.

object: :"vector_store.file"

The object type, which is always vector_store.file.

status: :in_progress | :completed | :cancelled | :failed

The status of the vector store file, which can be either in_progress, completed, cancelled, or failed. The status completed indicates that the vector store file is ready for use.

Accepts one of the following:

:in_progress

:completed

:cancelled

:failed

usage_bytes: Integer

The total vector store usage in bytes. Note that this may be different from the original file size.

vector_store_id: String

The ID of the vector store that the File is attached to.

attributes: Hash[Symbol, String | Float | bool]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Accepts one of the following:

String

Float

bool

chunking_strategy: FileChunkingStrategy

The strategy used to chunk the file.

Accepts one of the following:

class StaticFileChunkingStrategyObject { static, type }

static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }

chunk_overlap_tokens: Integer

The number of tokens that overlap between chunks. The default value is 400.

Note that the overlap must not exceed half of max_chunk_size_tokens.

max_chunk_size_tokens: Integer

The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.

minimum100

maximum4096

type: :static

Always static.

class OtherFileChunkingStrategyObject { type }

This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.

type: :other

Always other.

List vector store files in a batch

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

page = openai.vector_stores.file_batches.list_files("batch_id", vector_store_id: "vector_store_id")

puts(page)

{
  "object": "list",
  "data": [
    {
      "id": "file-abc123",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    },
    {
      "id": "file-abc456",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc456",
  "has_more": false
}

Returns Examples

{
  "object": "list",
  "data": [
    {
      "id": "file-abc123",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    },
    {
      "id": "file-abc456",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc456",
  "has_more": false
}