Skip to content
API Reference
Vector Stores

Create vector store

vector_stores.create(**kwargs) -> VectorStore { id, created_at, file_counts, 8 more }
POST/vector_stores

Create a vector store.

ParametersExpand Collapse
chunking_strategy: FileChunkingStrategyParam

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.

Accepts one of the following:
class AutoFileChunkingStrategyParam { type }

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

type: :auto

Always auto.

class StaticFileChunkingStrategyObjectParam { static, type }

Customize your own chunking strategy by setting chunk size and chunk overlap.

static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }
chunk_overlap_tokens: Integer

The number of tokens that overlap between chunks. The default value is 400.

Note that the overlap must not exceed half of max_chunk_size_tokens.

max_chunk_size_tokens: Integer

The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.

minimum100
maximum4096
type: :static

Always static.

description: String

A description for the vector store. Can be used to describe the vector store's purpose.

expires_after: { anchor, days}

The expiration policy for a vector store.

anchor: :last_active_at

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

days: Integer

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

minimum1
maximum365
file_ids: Array[String]

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

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.

name: String

The name of the vector store.

ReturnsExpand Collapse
class VectorStore { id, created_at, file_counts, 8 more }

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

id: String

The identifier, which can be referenced in API endpoints.

created_at: Integer

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

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

The number of files that were cancelled.

completed: Integer

The number of files that have been successfully 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.

last_active_at: Integer

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

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.

name: String

The name of the vector store.

object: :vector_store

The object type, which is always vector_store.

status: :expired | :in_progress | :completed

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
:in_progress
:completed
usage_bytes: Integer

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

expires_after: { anchor, days}

The expiration policy for a vector store.

anchor: :last_active_at

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

days: Integer

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

minimum1
maximum365
expires_at: Integer

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

Create vector store

require "openai"

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

vector_store = openai.vector_stores.create

puts(vector_store)
{
  "id": "id",
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "last_active_at": 0,
  "metadata": {
    "foo": "string"
  },
  "name": "name",
  "object": "vector_store",
  "status": "expired",
  "usage_bytes": 0,
  "expires_after": {
    "anchor": "last_active_at",
    "days": 1
  },
  "expires_at": 0
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "last_active_at": 0,
  "metadata": {
    "foo": "string"
  },
  "name": "name",
  "object": "vector_store",
  "status": "expired",
  "usage_bytes": 0,
  "expires_after": {
    "anchor": "last_active_at",
    "days": 1
  },
  "expires_at": 0
}