File: /var/www/ai-notam/node_modules/openai/resources/beta/vector-stores/vector-stores.d.ts
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as VectorStoresAPI from "./vector-stores.js";
import * as FileBatchesAPI from "./file-batches.js";
import * as FilesAPI from "./files.js";
import { CursorPage, type CursorPageParams } from "../../../pagination.js";
export declare class VectorStores extends APIResource {
files: FilesAPI.Files;
fileBatches: FileBatchesAPI.FileBatches;
/**
* Create a vector store.
*/
create(body: VectorStoreCreateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
/**
* Retrieves a vector store.
*/
retrieve(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
/**
* Modifies a vector store.
*/
update(vectorStoreId: string, body: VectorStoreUpdateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
/**
* Returns a list of vector stores.
*/
list(query?: VectorStoreListParams, options?: Core.RequestOptions): Core.PagePromise<VectorStoresPage, VectorStore>;
list(options?: Core.RequestOptions): Core.PagePromise<VectorStoresPage, VectorStore>;
/**
* Delete a vector store.
*/
del(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStoreDeleted>;
}
export declare class VectorStoresPage extends CursorPage<VectorStore> {
}
/**
* A vector store is a collection of processed files can be used by the
* `file_search` tool.
*/
export interface VectorStore {
/**
* The identifier, which can be referenced in API endpoints.
*/
id: string;
/**
* The Unix timestamp (in seconds) for when the vector store was created.
*/
created_at: number;
file_counts: VectorStore.FileCounts;
/**
* The Unix timestamp (in seconds) for when the vector store was last active.
*/
last_active_at: number | 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.
*/
metadata: unknown | null;
/**
* The name of the vector store.
*/
name: string;
/**
* The object type, which is always `vector_store`.
*/
object: 'vector_store';
/**
* 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.
*/
status: 'expired' | 'in_progress' | 'completed';
/**
* The total number of bytes used by the files in the vector store.
*/
usage_bytes: number;
/**
* The expiration policy for a vector store.
*/
expires_after?: VectorStore.ExpiresAfter;
/**
* The Unix timestamp (in seconds) for when the vector store will expire.
*/
expires_at?: number | null;
}
export declare namespace VectorStore {
interface FileCounts {
/**
* The number of files that were cancelled.
*/
cancelled: number;
/**
* The number of files that have been successfully processed.
*/
completed: number;
/**
* The number of files that have failed to process.
*/
failed: number;
/**
* The number of files that are currently being processed.
*/
in_progress: number;
/**
* The total number of files.
*/
total: number;
}
/**
* The expiration policy for a vector store.
*/
interface ExpiresAfter {
/**
* Anchor timestamp after which the expiration policy applies. Supported anchors:
* `last_active_at`.
*/
anchor: 'last_active_at';
/**
* The number of days after the anchor time that the vector store will expire.
*/
days: number;
}
}
export interface VectorStoreDeleted {
id: string;
deleted: boolean;
object: 'vector_store.deleted';
}
export interface VectorStoreCreateParams {
/**
* 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.
*/
chunking_strategy?: VectorStoreCreateParams.Auto | VectorStoreCreateParams.Static;
/**
* The expiration policy for a vector store.
*/
expires_after?: VectorStoreCreateParams.ExpiresAfter;
/**
* A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
* the vector store should use. Useful for tools like `file_search` that can access
* files.
*/
file_ids?: Array<string>;
/**
* 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.
*/
metadata?: unknown | null;
/**
* The name of the vector store.
*/
name?: string;
}
export declare namespace VectorStoreCreateParams {
/**
* The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
* `800` and `chunk_overlap_tokens` of `400`.
*/
interface Auto {
/**
* Always `auto`.
*/
type: 'auto';
}
interface Static {
static: Static.Static;
/**
* Always `static`.
*/
type: 'static';
}
namespace Static {
interface Static {
/**
* 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`.
*/
chunk_overlap_tokens: number;
/**
* The maximum number of tokens in each chunk. The default value is `800`. The
* minimum value is `100` and the maximum value is `4096`.
*/
max_chunk_size_tokens: number;
}
}
/**
* The expiration policy for a vector store.
*/
interface ExpiresAfter {
/**
* Anchor timestamp after which the expiration policy applies. Supported anchors:
* `last_active_at`.
*/
anchor: 'last_active_at';
/**
* The number of days after the anchor time that the vector store will expire.
*/
days: number;
}
}
export interface VectorStoreUpdateParams {
/**
* The expiration policy for a vector store.
*/
expires_after?: VectorStoreUpdateParams.ExpiresAfter | 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.
*/
metadata?: unknown | null;
/**
* The name of the vector store.
*/
name?: string | null;
}
export declare namespace VectorStoreUpdateParams {
/**
* The expiration policy for a vector store.
*/
interface ExpiresAfter {
/**
* Anchor timestamp after which the expiration policy applies. Supported anchors:
* `last_active_at`.
*/
anchor: 'last_active_at';
/**
* The number of days after the anchor time that the vector store will expire.
*/
days: number;
}
}
export interface VectorStoreListParams extends CursorPageParams {
/**
* A cursor for use in pagination. `before` is an object ID that defines your place
* in the list. For instance, if you make a list request and receive 100 objects,
* ending with obj_foo, your subsequent call can include before=obj_foo in order to
* fetch the previous page of the list.
*/
before?: string;
/**
* Sort order by the `created_at` timestamp of the objects. `asc` for ascending
* order and `desc` for descending order.
*/
order?: 'asc' | 'desc';
}
export declare namespace VectorStores {
export import VectorStore = VectorStoresAPI.VectorStore;
export import VectorStoreDeleted = VectorStoresAPI.VectorStoreDeleted;
export import VectorStoresPage = VectorStoresAPI.VectorStoresPage;
export import VectorStoreCreateParams = VectorStoresAPI.VectorStoreCreateParams;
export import VectorStoreUpdateParams = VectorStoresAPI.VectorStoreUpdateParams;
export import VectorStoreListParams = VectorStoresAPI.VectorStoreListParams;
export import Files = FilesAPI.Files;
export import VectorStoreFile = FilesAPI.VectorStoreFile;
export import VectorStoreFileDeleted = FilesAPI.VectorStoreFileDeleted;
export import VectorStoreFilesPage = FilesAPI.VectorStoreFilesPage;
export import FileCreateParams = FilesAPI.FileCreateParams;
export import FileListParams = FilesAPI.FileListParams;
export import FileBatches = FileBatchesAPI.FileBatches;
export import VectorStoreFileBatch = FileBatchesAPI.VectorStoreFileBatch;
export import FileBatchCreateParams = FileBatchesAPI.FileBatchCreateParams;
export import FileBatchListFilesParams = FileBatchesAPI.FileBatchListFilesParams;
}
//# sourceMappingURL=vector-stores.d.ts.map