API Reference

Vector Stores

Copy Markdown

Open in ChatGPT

---

Copy Markdown

View as Markdown

Modify vector store

VectorStore vectorStores().update(VectorStoreUpdateParamsparams = VectorStoreUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/vector_stores/{vector_store_id}

Modifies a vector store.

ParametersExpand Collapse

VectorStoreUpdateParams params

Optional<String> vectorStoreId

Optional<ExpiresAfter> expiresAfter

The expiration policy for a vector store.

JsonValue; anchor "last_active_at"constant"last_active_at"constant

Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.

long days

The number of days after the anchor time that the vector store will expire.

minimum1

maximum365

Optional<Metadata> metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Optional<String> name

The name of the vector store.

ReturnsExpand Collapse

class VectorStore:

A vector store is a collection of processed files can be used by the file_search tool.

String id

The identifier, which can be referenced in API endpoints.

long createdAt

The Unix timestamp (in seconds) for when the vector store was created.

FileCounts fileCounts

long cancelled

The number of files that were cancelled.

long completed

The number of files that have been successfully processed.

long failed

The number of files that have failed to process.

long inProgress

The number of files that are currently being processed.

long total

The total number of files.

Optional<Long> lastActiveAt

The Unix timestamp (in seconds) for when the vector store was last active.

Optional<Metadata> metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

String name

The name of the vector store.

JsonValue; object_ "vector_store"constant"vector_store"constant

The object type, which is always vector_store.

Status status

The status of the vector store, which can be either expired, in_progress, or completed. A status of completed indicates that the vector store is ready for use.

Accepts one of the following:

EXPIRED("expired")

IN_PROGRESS("in_progress")

COMPLETED("completed")

long usageBytes

The total number of bytes used by the files in the vector store.

Optional<ExpiresAfter> expiresAfter

The expiration policy for a vector store.

JsonValue; anchor "last_active_at"constant"last_active_at"constant

Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.

long days

The number of days after the anchor time that the vector store will expire.

minimum1

maximum365

Optional<Long> expiresAt

The Unix timestamp (in seconds) for when the vector store will expire.

Modify vector store

Java

HTTP

TypeScript

Python

Java

Go

Ruby

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.vectorstores.VectorStore;
import com.openai.models.vectorstores.VectorStoreUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        VectorStore vectorStore = client.vectorStores().update("vector_store_id");
    }
}

{
  "id": "vs_abc123",
  "object": "vector_store",
  "created_at": 1699061776,
  "name": "Support FAQ",
  "description": "Contains commonly asked questions and answers, organized by topic.",
  "bytes": 139920,
  "file_counts": {
    "in_progress": 0,
    "completed": 3,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  }
}

Returns Examples

{
  "id": "vs_abc123",
  "object": "vector_store",
  "created_at": 1699061776,
  "name": "Support FAQ",
  "description": "Contains commonly asked questions and answers, organized by topic.",
  "bytes": 139920,
  "file_counts": {
    "in_progress": 0,
    "completed": 3,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  }
}