Struct Client 

pub struct Client<Ext = Nothing, H = Client> { /* private fields */ }

Implementations

impl<Ext, ExtBuilder, Key, H> Client<Ext, H>

where ExtBuilder: Clone + Default + ProviderBuilder<Output = Ext, ApiKey = Key>, Ext: Provider<Builder = ExtBuilder>, H: Default + HttpClientExt, Key: ApiKey,

pub fn new(api_key: impl Into<Key>) -> Result<Client<Ext, H>, Error>

impl<Ext, H> Client<Ext, H>

pub fn base_url(&self) -> &str

pub fn headers(&self) -> &HeaderMap

pub fn ext(&self) -> &Ext

pub fn with_ext<NewExt>(self, new_ext: NewExt) -> Client<NewExt, H>

impl<Ext, Builder, H> Client<Ext, H>

where H: Default + HttpClientExt, Ext: Provider<Builder = Builder>, Builder: Default + ProviderBuilder,

pub fn builder() -> ClientBuilder<Builder, NeedsApiKey, H>

impl<Ext, H> Client<Ext, H>

where Ext: Provider,

pub fn post<S>(&self, path: S) -> Result<Builder, Error>

where S: AsRef<str>,

pub fn post_sse<S>(&self, path: S) -> Result<Builder, Error>

where S: AsRef<str>,

pub fn get<S>(&self, path: S) -> Result<Builder, Error>

where S: AsRef<str>,

impl<T> Client<CohereExt, T>

where T: HttpClientExt + Clone + WasmCompatSend + WasmCompatSync + 'static,

pub fn embeddings<D>( &self, model: impl Into<String>, input_type: &str, ) -> EmbeddingsBuilder<EmbeddingModel<T>, D>

where D: Embed,

pub fn embedding_model( &self, model: impl Into<String>, input_type: &str, ) -> EmbeddingModel<T>

Note: default embedding dimension of 0 will be used if model is not known. If this is the case, it’s better to use function embedding_model_with_ndims

pub fn embedding_model_with_ndims( &self, model: impl Into<String>, input_type: &str, ndims: usize, ) -> EmbeddingModel<T>

Create an embedding model with the given name and the number of dimensions in the embedding generated by the model.

impl<T> Client<MiraExt, T>

where T: HttpClientExt + 'static,

pub async fn list_models(&self) -> Result<Vec<String>, MiraError>

List available models

impl<H> Client<OpenAIResponsesExt, H>

where H: HttpClientExt + Clone + Debug + Default + WasmCompatSend + WasmCompatSync + 'static,

pub fn extractor<U>( &self, model: impl Into<String>, ) -> ExtractorBuilder<ResponsesCompletionModel<H>, U>

where U: JsonSchema + for<'a> Deserialize<'a> + Serialize + WasmCompatSend + WasmCompatSync,

Create an extractor builder with the given completion model. Uses the OpenAI Responses API (default behavior).

pub fn completions_api(self) -> Client<OpenAICompletionsExt, H>

Create a Completions API client from this Responses API client. Useful for switching to the traditional Chat Completions API.

impl<H> Client<OpenAICompletionsExt, H>

where H: HttpClientExt + Clone + Debug + Default + WasmCompatSend + WasmCompatSync + 'static,

pub fn extractor<U>( &self, model: impl Into<String>, ) -> ExtractorBuilder<CompletionModel<H>, U>

where U: JsonSchema + for<'a> Deserialize<'a> + Serialize + WasmCompatSend + WasmCompatSync,

Create an extractor builder with the given completion model. Uses the OpenAI Chat Completions API.

pub fn responses_api(self) -> Client<OpenAIResponsesExt, H>

Create a Responses API client from this Completions API client. Useful for switching to the newer Responses API.

Trait Implementations

impl<Ext, H> Clone for Client<Ext, H>

where Ext: Clone, H: Clone,

fn clone(&self) -> Client<Ext, H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M, Ext, H> CompletionClient for Client<Ext, H>

where Ext: Capabilities<H, Completion = Capable<M>>, M: CompletionModel<Client = Client<Ext, H>>,

type CompletionModel = M

The type of CompletionModel used by the client.

fn completion_model( &self, model: impl Into<String>, ) -> <Client<Ext, H> as CompletionClient>::CompletionModel

Create a completion model with the given model.

fn agent(&self, model: impl Into<String>) -> AgentBuilder<Self::CompletionModel>

Create an agent builder with the given completion model.

fn extractor<T>( &self, model: impl Into<String>, ) -> ExtractorBuilder<Self::CompletionModel, T>

where T: JsonSchema + for<'a> Deserialize<'a> + Serialize + Send + Sync,

Create an extractor builder with the given completion model.

impl<Ext, H> Debug for Client<Ext, H>

where Ext: DebugExt, H: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<M, Ext, H> EmbeddingsClient for Client<Ext, H>

where Ext: Capabilities<H, Embeddings = Capable<M>>, M: EmbeddingModel<Client = Client<Ext, H>>,

type EmbeddingModel = M

The type of EmbeddingModel used by the Client

fn embedding_model( &self, model: impl Into<String>, ) -> <Client<Ext, H> as EmbeddingsClient>::EmbeddingModel

Create an embedding model with the given model.

fn embedding_model_with_ndims( &self, model: impl Into<String>, ndims: usize, ) -> <Client<Ext, H> as EmbeddingsClient>::EmbeddingModel

Create an embedding model with the given model identifier string and the number of dimensions in the embedding generated by the model. This is the suggested method if you need to use a model not included in Self::EmbeddingModel::Models

fn embeddings<D>( &self, model: impl Into<String>, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>

where D: Embed,

Create an embedding builder with the given embedding model.

fn embeddings_with_ndims<D>( &self, model: &str, ndims: usize, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>

where D: Embed,

Create an embedding builder with the given name and the number of dimensions in the embedding generated by the model.

impl<Ext, H> HttpClientExt for Client<Ext, H>

where H: HttpClientExt + 'static, Ext: WasmCompatSend + WasmCompatSync + 'static,

fn send<T, U>( &self, req: Request<T>, ) -> impl Future<Output = Result<Response<Pin<Box<dyn Future<Output = Result<U, Error>> + Send>>>, Error>> + WasmCompatSend + 'static

where T: Into<Bytes> + WasmCompatSend, U: From<Bytes> + WasmCompatSend + 'static,

Send a HTTP request, get a response back (as bytes). Response must be able to be turned back into Bytes.

fn send_multipart<U>( &self, req: Request<Form>, ) -> impl Future<Output = Result<Response<Pin<Box<dyn Future<Output = Result<U, Error>> + Send>>>, Error>> + WasmCompatSend + 'static

where U: From<Bytes> + WasmCompatSend + 'static,

Send a HTTP request with a multipart body, get a response back (as bytes). Response must be able to be turned back into Bytes (although usually for the response, you will probably want to specify Bytes anyway).

fn send_streaming<T>( &self, req: Request<T>, ) -> impl Future<Output = Result<Response<Pin<Box<dyn WasmCompatSendStream<InnerItem = Result<Bytes, Error>, Item = Result<Bytes, Error>>>>>, Error>> + WasmCompatSend

where T: Into<Bytes>,

Send a HTTP request, get a streamed response back (as a stream of bytes::Bytes.)

impl ProviderClient for Client<AnthropicExt>

type Input = String

fn from_env() -> Client<AnthropicExt>

where Client<AnthropicExt>: Sized,

Create a client from the process’s environment. Panics if an environment is improperly configured.

fn from_val( input: <Client<AnthropicExt> as ProviderClient>::Input, ) -> Client<AnthropicExt>

where Client<AnthropicExt>: Sized,

impl ProviderClient for Client<AzureExt>

fn from_env() -> Client<AzureExt>

Create a new Azure OpenAI client from the AZURE_API_KEY or AZURE_TOKEN, AZURE_API_VERSION, and AZURE_ENDPOINT environment variables.

type Input = AzureOpenAIClientParams

fn from_val(_: <Client<AzureExt> as ProviderClient>::Input) -> Client<AzureExt>

impl ProviderClient for Client<CohereExt>

type Input = BearerAuth

fn from_env() -> Client<CohereExt>

where Client<CohereExt>: Sized,

Create a client from the process’s environment. Panics if an environment is improperly configured.

fn from_val( input: <Client<CohereExt> as ProviderClient>::Input, ) -> Client<CohereExt>

where Client<CohereExt>: Sized,

impl ProviderClient for Client<DeepSeekExt>

type Input = BearerAuth

fn from_env() -> Client<DeepSeekExt>

Create a client from the process’s environment. Panics if an environment is improperly configured.

fn from_val( input: <Client<DeepSeekExt> as ProviderClient>::Input, ) -> Client<DeepSeekExt>

impl ProviderClient for Client<GaladrielExt>

fn from_env() -> Client<GaladrielExt>

Create a new Galadriel client from the GALADRIEL_API_KEY environment variable, and optionally from the GALADRIEL_FINE_TUNE_API_KEY environment variable. Panics if the GALADRIEL_API_KEY environment variable is not set.

type Input = (String, Option<String>)

fn from_val( _: <Client<GaladrielExt> as ProviderClient>::Input, ) -> Client<GaladrielExt>

impl ProviderClient for Client<GeminiExt>

fn from_env() -> Client<GeminiExt>

Create a new Google Gemini client from the GEMINI_API_KEY environment variable. Panics if the environment variable is not set.

type Input = GeminiApiKey

fn from_val( input: <Client<GeminiExt> as ProviderClient>::Input, ) -> Client<GeminiExt>

impl ProviderClient for Client<GroqExt>

fn from_env() -> Client<GroqExt>

Create a new Groq client from the GROQ_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<GroqExt> as ProviderClient>::Input, ) -> Client<GroqExt>

impl ProviderClient for Client<HuggingFaceExt>

fn from_env() -> Client<HuggingFaceExt>

Create a new Huggingface client from the HUGGINGFACE_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<HuggingFaceExt> as ProviderClient>::Input, ) -> Client<HuggingFaceExt>

impl ProviderClient for Client<HyperbolicExt>

fn from_env() -> Client<HyperbolicExt>

Create a new Hyperbolic client from the HYPERBOLIC_API_KEY environment variable. Panics if the environment variable is not set.

type Input = BearerAuth

fn from_val( input: <Client<HyperbolicExt> as ProviderClient>::Input, ) -> Client<HyperbolicExt>

impl ProviderClient for Client<MiraExt>

fn from_env() -> Client<MiraExt>

Create a new Mira client from the MIRA_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<MiraExt> as ProviderClient>::Input, ) -> Client<MiraExt>

impl ProviderClient for Client<MistralExt>

fn from_env() -> Client<MistralExt>

where Client<MistralExt>: Sized,

Create a new Mistral client from the MISTRAL_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<MistralExt> as ProviderClient>::Input, ) -> Client<MistralExt>

impl ProviderClient for Client<MoonshotExt>

fn from_env() -> Client<MoonshotExt>

Create a new Moonshot client from the MOONSHOT_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<MoonshotExt> as ProviderClient>::Input, ) -> Client<MoonshotExt>

impl ProviderClient for Client<OllamaExt>

type Input = Nothing

fn from_env() -> Client<OllamaExt>

Create a client from the process’s environment. Panics if an environment is improperly configured.

fn from_val( _: <Client<OllamaExt> as ProviderClient>::Input, ) -> Client<OllamaExt>

impl ProviderClient for Client<OpenAICompletionsExt>

fn from_env() -> Client<OpenAICompletionsExt>

Create a new OpenAI Completions API client from the OPENAI_API_KEY environment variable. Panics if the environment variable is not set.

type Input = BearerAuth

fn from_val( input: <Client<OpenAICompletionsExt> as ProviderClient>::Input, ) -> Client<OpenAICompletionsExt>

impl ProviderClient for Client<OpenAIResponsesExt>

fn from_env() -> Client<OpenAIResponsesExt>

Create a new OpenAI Responses API client from the OPENAI_API_KEY environment variable. Panics if the environment variable is not set.

type Input = BearerAuth

fn from_val( input: <Client<OpenAIResponsesExt> as ProviderClient>::Input, ) -> Client<OpenAIResponsesExt>

impl ProviderClient for Client<OpenRouterExt>

fn from_env() -> Client<OpenRouterExt>

Create a new openrouter client from the OPENROUTER_API_KEY environment variable. Panics if the environment variable is not set.

type Input = BearerAuth

fn from_val( input: <Client<OpenRouterExt> as ProviderClient>::Input, ) -> Client<OpenRouterExt>

impl ProviderClient for Client<PerplexityExt>

fn from_env() -> Client<PerplexityExt>

Create a new Perplexity client from the PERPLEXITY_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<PerplexityExt> as ProviderClient>::Input, ) -> Client<PerplexityExt>

impl ProviderClient for Client<TogetherExt>

fn from_env() -> Client<TogetherExt>

Create a new Together AI client from the TOGETHER_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<TogetherExt> as ProviderClient>::Input, ) -> Client<TogetherExt>

impl ProviderClient for Client<VoyageExt>

fn from_env() -> Client<VoyageExt>

Create a new OpenAI client from the OPENAI_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val( input: <Client<VoyageExt> as ProviderClient>::Input, ) -> Client<VoyageExt>

impl ProviderClient for Client<XAiExt>

fn from_env() -> Client<XAiExt>

Create a new xAI client from the XAI_API_KEY environment variable. Panics if the environment variable is not set.

type Input = String

fn from_val(input: <Client<XAiExt> as ProviderClient>::Input) -> Client<XAiExt>

impl<M, Ext, H> TranscriptionClient for Client<Ext, H>

where Ext: Capabilities<H, Transcription = Capable<M>>, M: TranscriptionModel<Client = Client<Ext, H>> + WasmCompatSend,

type TranscriptionModel = M

The type of TranscriptionModel used by the Client

fn transcription_model( &self, model: impl Into<String>, ) -> <Client<Ext, H> as TranscriptionClient>::TranscriptionModel

Create a transcription model with the given name.

impl<Ext, H> VerifyClient for Client<Ext, H>

where H: HttpClientExt, Ext: DebugExt + Provider + WasmCompatSync,

async fn verify(&self) -> Result<(), VerifyError>

Verify the configuration.