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

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

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

PATHS

  "DELETE /vector_stores/{vector_store_id}/files/{file_id}"
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file <https://platform.openai.com/docs/api-reference/files/delete> endpoint.

Operation ID

"deleteVectorStoreFile"

    $client->deleteVectorStoreFile( ... );

Parameters

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

    Type: "string"

•   "file_id" (in path) (Required) - The ID of the file to delete.

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

  "GET /vector_stores/{vector_store_id}/files/{file_id}"
Retrieves a vector store file.

Operation ID

"getVectorStoreFile"

    $client->getVectorStoreFile( ... );

Parameters

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

    Type: "string"

•   "file_id" (in path) (Required) - The ID of the file being retrieved.

    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": "file-abc123",
          "object": "vector_store.file",
          "usage_bytes": 1234,
          "created_at": 1698107661,
          "vector_store_id": "vs_abc123",
          "status": "completed",
          "last_error": null,
          "chunking_strategy": {
            "type": "static",
            "static": {
              "max_chunk_size_tokens": 800,
              "chunk_overlap_tokens": 400
            }
          }
        }

  "POST /vector_stores/{vector_store_id}/files/{file_id}"
Update attributes on a vector store file.

Operation ID

"updateVectorStoreFileAttributes"

    $client->updateVectorStoreFileAttributes( ... );

Parameters

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

    Type: "string"

•   "file_id" (in path) (Required) - The ID of the file to update attributes.

    Type: "string"

Request Body

Content Type: "application/json"

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": "file-abc123",
          "object": "vector_store.file",
          "usage_bytes": 1234,
          "created_at": 1698107661,
          "vector_store_id": "vs_abc123",
          "status": "completed",
          "last_error": null,
          "chunking_strategy": {
            "type": "static",
            "static": {
              "max_chunk_size_tokens": 800,
              "chunk_overlap_tokens": 400
            }
          }
        }

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.