OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id-files(3)

NAME
OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id-files - Documentation for the /vector_stores/{vector_store_id}/file_batches/{batch_id}/files path.

DESCRIPTION
This document describes the API endpoint at "/vector_stores/{vector_store_id}/file_batches/{batch_id}/files".

PATHS

  "GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files"
Returns a list of vector store files in a batch.

Operation ID

"listFilesInVectorStoreBatch"

    $client->listFilesInVectorStoreBatch( ... );

Parameters

•   "vector_store_id" (in path) (Required) - The ID of the vector store that the files belong to.

    Type: "string"

•   "batch_id" (in path) (Required) - The ID of the file batch that the files belong to.

    Type: "string"

•   "limit" (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Type: "integer"

    Default: 20

•   "order" (in query) (Optional) - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

    Type: "string"

    Allowed values: "asc, desc"

    Default: "desc"

•   "after" (in query) (Optional) - 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.

    Type: "string"

•   "before" (in query) (Optional) - 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.

    Type: "string"

•   "filter" (in query) (Optional) - Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.

    Type: "string"

    Allowed values: "in_progress, completed, failed, cancelled"

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "data" : [
              "{\n  \"id\": \"file-abc123\",\n  \"object\": \"vector_store.file\",\n  \"usage_bytes\": 1234,\n  \"created_at\": 1698107661,\n  \"vector_store_id\": \"vs_abc123\",\n  \"status\": \"completed\",\n  \"last_error\": null,\n  \"chunking_strategy\": {\n    \"type\": \"static\",\n    \"static\": {\n      \"max_chunk_size_tokens\": 800,\n      \"chunk_overlap_tokens\": 400\n    }\n  }\n}\n"
           ],
           "first_id" : "file-abc123",
           "has_more" : false,
           "last_id" : "file-abc456",
           "object" : "list"
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.