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

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

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

PATHS

  "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.

Operation ID

"cancelVectorStoreFileBatch"

    $client->cancelVectorStoreFileBatch( ... );

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 to cancel.

    Type: "string"

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>):

        {
          "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.