VectorStore | /resources/beta/vector-stores/mod.ts | openai@v4.38.5

namespace VectorStore

import { VectorStore } from "https://deno.land/x/openai@v4.38.5/resources/beta/vector-stores/mod.ts";

Interfaces

I VectorStore.ExpiresAfter	The expiration policy for a vector store.
I VectorStore.FileCounts

interface VectorStore

import { type VectorStore } from "https://deno.land/x/openai@v4.38.5/resources/beta/vector-stores/mod.ts";

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

Properties

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

file_counts: VectorStore.FileCounts

last_active_at: number | null

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

metadata: unknown | null

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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

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.

usage_bytes: number

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

optional

expires_after: VectorStore.ExpiresAfter

The expiration policy for a vector store.

optional

expires_at: number | null

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