NAME

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

DESCRIPTION

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

PATHS

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

Retrieve vector store file batch

Retrieves a vector store file batch.

Operation ID

getVectorStoreFileBatch

$client->getVectorStoreFileBatch( ... );

Parameters

• vector_store_id (in path) (Required) - The ID of the vector store that the file batch belongs to.

  Type: string

• batch_id (in path) (Required) - The ID of the file batch being retrieved.

  Type: string

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
    "id": "vsfb_123",
    "object": "vector_store.files_batch",
    "created_at": 1698107661,
    "vector_store_id": "vs_abc123",
    "status": "completed",
    "file_counts": {
      "in_progress": 0,
      "completed": 100,
      "failed": 0,
      "cancelled": 0,
      "total": 100
    }
  }

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.