OpenaiEx.VectorStores (openai_ex v0.9.22)

Copy Markdown View Source

This module provides an implementation of the OpenAI vector_stores API. The API reference can be found at https://platform.openai.com/docs/api-reference/vector-stores.

Summary

Functions

create(openai, params \\ %{})

create!(openai, params \\ %{})

delete(openai, vector_store_id)

delete!(openai, vector_store_id)

list(openai)

list!(openai)

new(args)

Creates a new vector store request

Example usage:

iex> _request = OpenaiEx.VectorStores.new(name: "My Vector Store", file_ids: ["file-abc123"])
%{name: "My Vector Store", file_ids: ["file-abc123"]}

iex> _request = OpenaiEx.VectorStores.new(%{name: "My Vector Store", metadata: %{"version" => "1.0"}})
%{name: "My Vector Store", metadata: %{"version" => "1.0"}}

retrieve(openai, vector_store_id)

retrieve!(openai, vector_store_id)

search(openai, vector_store_id, params \\ %{})

search!(openai, vector_store_id, params \\ %{})

Searches a vector store for relevant chunks.

See https://platform.openai.com/docs/api-reference/vector-stores/search

update(openai, vector_store_id, params \\ %{})

update!(openai, vector_store_id, params \\ %{})