Skip to content
API Reference
Vector Stores
File Batches

Cancel vector store file batch

vector_stores.file_batches.cancel(batch_id, **kwargs) -> VectorStoreFileBatch { id, created_at, file_counts, 3 more }
POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

ParametersExpand Collapse
vector_store_id: String
batch_id: String
ReturnsExpand Collapse
class VectorStoreFileBatch { id, created_at, file_counts, 3 more }

A batch 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 files batch was created.

file_counts: { cancelled, completed, failed, 2 more}
cancelled: Integer

The number of files that where cancelled.

completed: Integer

The number of files that have been processed.

failed: Integer

The number of files that have failed to process.

in_progress: Integer

The number of files that are currently being processed.

total: Integer

The total number of files.

object: :"vector_store.files_batch"

The object type, which is always vector_store.file_batch.

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

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

Accepts one of the following:
:in_progress
:completed
:cancelled
:failed
vector_store_id: String

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

Cancel vector store file batch

require "openai"

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

vector_store_file_batch = openai.vector_stores.file_batches.cancel("batch_id", vector_store_id: "vector_store_id")

puts(vector_store_file_batch)
{
  "id": "id",
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "object": "vector_store.files_batch",
  "status": "in_progress",
  "vector_store_id": "vector_store_id"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "object": "vector_store.files_batch",
  "status": "in_progress",
  "vector_store_id": "vector_store_id"
}