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

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

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

PATHS

  "DELETE /vector_stores/{vector_store_id}"
Delete a vector store.

Operation ID

"deleteVectorStore"

    $client->deleteVectorStore( ... );

Parameters

•   "vector_store_id" (in path) (Required) - The ID of the vector store 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}"
Retrieves a vector store.

Operation ID

"getVectorStore"

    $client->getVectorStore( ... );

Parameters

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

    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": "vs_123",
          "object": "vector_store",
          "created_at": 1698107661,
          "usage_bytes": 123456,
          "last_active_at": 1698107661,
          "name": "my_vector_store",
          "status": "completed",
          "file_counts": {
            "in_progress": 0,
            "completed": 100,
            "cancelled": 0,
            "failed": 0,
            "total": 100
          },
          "last_used_at": 1698107661
        }

  "POST /vector_stores/{vector_store_id}"
Modifies a vector store.

Operation ID

"modifyVectorStore"

    $client->modifyVectorStore( ... );

Parameters

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

    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": "vs_123",
          "object": "vector_store",
          "created_at": 1698107661,
          "usage_bytes": 123456,
          "last_active_at": 1698107661,
          "name": "my_vector_store",
          "status": "completed",
          "file_counts": {
            "in_progress": 0,
            "completed": 100,
            "cancelled": 0,
            "failed": 0,
            "total": 100
          },
          "last_used_at": 1698107661
        }

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.