Struct VectorStoresClient

Source

pub struct VectorStoresClient<'a, T = ()> { /* private fields */ }

Expand description

Client for vector stores API.

Implementations§

Source §

impl<T: Default + Send + Sync> VectorStoresClient<'_, T>

Source

pub async fn create( &self, builder: VectorStoreBuilder, ) -> Result<VectorStoreObject>

Create a new vector store.

§Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::vector_stores::VectorStoreBuilder;

let client = Client::from_env()?;
let builder = VectorStoreBuilder::new()
    .name("My Knowledge Base")
    .add_file("file-123");
let vector_store = client.vector_stores().create(builder).await?;
println!("Created vector store: {}", vector_store.id);

Source

pub async fn list( &self, limit: Option<i32>, order: Option<&str>, after: Option<&str>, before: Option<&str>, ) -> Result<ListVectorStoresResponse>

List vector stores.

§Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.vector_stores().list(Some(20), None, None, None).await?;
println!("Found {} vector stores", response.data.len());

Source

pub async fn get( &self, vector_store_id: impl Into<String>, ) -> Result<VectorStoreObject>

Get a specific vector store by ID.

§Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let vector_store = client.vector_stores().get("vs_123").await?;
println!("Vector store: {}", vector_store.name);

Source

pub async fn update( &self, vector_store_id: impl Into<String>, builder: VectorStoreBuilder, ) -> Result<VectorStoreObject>

Update a vector store.

§Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::vector_stores::VectorStoreBuilder;

let client = Client::from_env()?;
let builder = VectorStoreBuilder::new()
    .name("Updated Name")
    .metadata("updated", "true");
let vector_store = client.vector_stores().update("vs_123", builder).await?;
println!("Updated: {}", vector_store.name);

Source

pub async fn delete( &self, vector_store_id: impl Into<String>, ) -> Result<DeleteVectorStoreResponse>

Delete a vector store.

§Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.vector_stores().delete("vs_123").await?;
println!("Deleted: {}", response.deleted);

Source

pub async fn add_file( &self, vector_store_id: impl Into<String>, file_id: impl Into<String>, ) -> Result<VectorStoreFileObject>

Add a file to a vector store.

§Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let file = client.vector_stores().add_file("vs_123", "file-456").await?;
println!("Added file: {}", file.id);

Source

pub async fn list_files( &self, vector_store_id: impl Into<String>, limit: Option<i32>, order: Option<&str>, after: Option<&str>, before: Option<&str>, filter: Option<&str>, ) -> Result<ListVectorStoreFilesResponse>

List files in a vector store.

§Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.vector_stores().list_files("vs_123", None, None, None, None, None).await?;
println!("Found {} files", response.data.len());

Source

pub async fn get_file( &self, vector_store_id: impl Into<String>, file_id: impl Into<String>, ) -> Result<VectorStoreFileObject>

Get a file from a vector store.

§Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let file = client.vector_stores().get_file("vs_123", "file-456").await?;
println!("File: {}", file.id);

Source

pub async fn delete_file( &self, vector_store_id: impl Into<String>, file_id: impl Into<String>, ) -> Result<DeleteVectorStoreFileResponse>

Delete a file from a vector store.

§Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.vector_stores().delete_file("vs_123", "file-456").await?;
println!("Deleted: {}", response.deleted);

Source

pub async fn search( &self, builder: VectorStoreSearchBuilder, ) -> Result<VectorStoreSearchResultsPage>

Search a vector store.

§Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::vector_stores::VectorStoreSearchBuilder;

let client = Client::from_env()?;
let builder = VectorStoreSearchBuilder::new("vs_123", "machine learning concepts");
let results = client.vector_stores().search(builder).await?;
println!("Found {} results", results.data.len());