Struct OpenAIEmbeddingClient 

pub struct OpenAIEmbeddingClient { /* private fields */ }

An OpenAI (or OpenAI-compatible) embeddings client.

let client = OpenAIEmbeddingClient::from_env("text-embedding-3-small")?;
let batch = client
    .get_embeddings(vec!["Hello, world!".into()], None)
    .await?;
println!("{} dims", batch[0].dimensions());

Implementations

impl OpenAIEmbeddingClient

pub fn new( api_key: impl Into<String>, model: impl Into<String>, ) -> OpenAIEmbeddingClient

Create a client for the given API key and default embedding model.

pub fn from_env( model: impl Into<String>, ) -> Result<OpenAIEmbeddingClient, Error>

Build a client from the environment: OPENAI_API_KEY (required) and optional OPENAI_BASE_URL. The model falls back through OPENAI_EMBEDDING_MODEL when the argument is empty — mirroring upstream’s model or OPENAI_EMBEDDING_MODEL resolution.

pub fn with_base_url(self, base_url: impl Into<String>) -> OpenAIEmbeddingClient

Override the base URL (for OpenAI-compatible servers).

pub fn with_organization(self, org: impl Into<String>) -> OpenAIEmbeddingClient

Set the organization header.

Trait Implementations

impl Clone for OpenAIEmbeddingClient

fn clone(&self) -> OpenAIEmbeddingClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl EmbeddingClient for OpenAIEmbeddingClient

fn get_embeddings<'life0, 'async_trait>( &'life0 self, values: Vec<String>, options: Option<EmbeddingGenerationOptions>, ) -> Pin<Box<dyn Future<Output = Result<GeneratedEmbeddings, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OpenAIEmbeddingClient: 'async_trait,

Generate embeddings for the given values (one per value, in order).

fn model(&self) -> Option<&str>

The default embedding model id for this client, if any.