Class VectorStores

constructor

• new VectorStores(client): VectorStores

• Parameters

  • client: OpenAI

  Returns VectorStores

fileBatches

files

create

• create(body, options?): APIPromise<OpenAIClient.VectorStores.VectorStore>

• Create a vector store.

  Parameters

  • body: VectorStoreCreateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.VectorStores.VectorStore>

del

• del(vectorStoreId, options?): APIPromise<VectorStoreDeleted>

• Delete a vector store.

  Parameters

  • vectorStoreId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<VectorStoreDeleted>

list

• list(query?, options?): PagePromise<VectorStoresPage, OpenAIClient.VectorStores.VectorStore>

• Returns a list of vector stores.

  Parameters

  • Optionalquery: VectorStoreListParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<VectorStoresPage, OpenAIClient.VectorStores.VectorStore>
• list(options?): PagePromise<VectorStoresPage, OpenAIClient.VectorStores.VectorStore>

• Parameters

  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<VectorStoresPage, OpenAIClient.VectorStores.VectorStore>

retrieve

• retrieve(vectorStoreId, options?): APIPromise<OpenAIClient.VectorStores.VectorStore>

• Retrieves a vector store.

  Parameters

  • vectorStoreId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.VectorStores.VectorStore>

search

• search(vectorStoreId, body, options?): PagePromise<VectorStoreSearchResponsesPage, VectorStoreSearchResponse>

• Search a vector store for relevant chunks based on a query and file attributes filter.

  Parameters

  • vectorStoreId: string
  • body: VectorStoreSearchParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<VectorStoreSearchResponsesPage, VectorStoreSearchResponse>

update

• update(vectorStoreId, body, options?): APIPromise<OpenAIClient.VectorStores.VectorStore>

• Modifies a vector store.

  Parameters

  • vectorStoreId: string
  • body: VectorStoreUpdateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.VectorStores.VectorStore>