Share via


VectorStoresOperations interface

Interface representing a VectorStores operations.

Properties

create

Creates a vector store.

delete

Deletes the vector store object matching the specified ID.

get

Returns the vector store object matching the specified ID.

list

Returns a list of vector stores.

update

Modifies an existing vector store.

Methods

createAndPoll(VectorStoresCreateVectorStoreOptionalParams)

Creates a vector store and poll.

Property Details

create

Creates a vector store.

create: (options?: VectorStoresCreateVectorStoreOptionalParams) => Promise<VectorStore>

Property Value

(options?: VectorStoresCreateVectorStoreOptionalParams) => Promise<VectorStore>

delete

Deletes the vector store object matching the specified ID.

delete: (vectorStoreId: string, options?: VectorStoresDeleteVectorStoreOptionalParams) => Promise<VectorStoreDeletionStatus>

Property Value

(vectorStoreId: string, options?: VectorStoresDeleteVectorStoreOptionalParams) => Promise<VectorStoreDeletionStatus>

get

Returns the vector store object matching the specified ID.

get: (vectorStoreId: string, options?: VectorStoresGetVectorStoreOptionalParams) => Promise<VectorStore>

Property Value

(vectorStoreId: string, options?: VectorStoresGetVectorStoreOptionalParams) => Promise<VectorStore>

list

Returns a list of vector stores.

list: (options?: VectorStoresListVectorStoresOptionalParams) => PagedAsyncIterableIterator<VectorStore, VectorStore[], PageSettings>

Property Value

(options?: VectorStoresListVectorStoresOptionalParams) => PagedAsyncIterableIterator<VectorStore, VectorStore[], PageSettings>

update

Modifies an existing vector store.

update: (vectorStoreId: string, options?: VectorStoresModifyVectorStoreOptionalParams) => Promise<VectorStore>

Property Value

(vectorStoreId: string, options?: VectorStoresModifyVectorStoreOptionalParams) => Promise<VectorStore>

Method Details

createAndPoll(VectorStoresCreateVectorStoreOptionalParams)

Creates a vector store and poll.

function createAndPoll(options?: VectorStoresCreateVectorStoreOptionalParams): PollerLike<OperationState<VectorStore>, VectorStore>

Parameters

Returns