Struct Client 

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

Generic provider client shared by Rig provider integrations.

Ext stores provider-specific behavior such as URL construction, request customization, and capabilities. H is the HTTP backend and defaults to reqwest::Client.

Implementations

impl<Ext> Client<Ext>

where Ext: Provider, <Ext as Provider>::Builder: ProviderBuilder<Extension<Client> = Ext> + Default,

new is pinned to H = reqwest::Client so the call site infers without an explicit H annotation. Callers who want a different backend should go through Client::builder and chain ClientBuilder::http_client before ClientBuilder::build.

pub fn new( api_key: impl Into<<<Ext as Provider>::Builder as ProviderBuilder>::ApiKey>, ) -> Result<Client<Ext>, Error>

Construct a provider client using the default reqwest::Client backend.

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

pub fn base_url(&self) -> &str

Returns the configured provider base URL.

pub fn headers(&self) -> &HeaderMap

Returns default headers applied to outgoing provider requests.

pub fn ext(&self) -> &Ext

Returns the provider extension.

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

Reuse this client’s base URL, headers, and HTTP backend with a different extension.

impl<Ext> Client<Ext>

where Ext: Provider, <Ext as Provider>::Builder: ProviderBuilder + Default,

builder() is anchored on Client<Ext, reqwest::Client> purely as an inference hook so that provider::Client::builder() resolves without a H annotation. The returned builder itself has H = Missing, accurately reflecting that no backend has been chosen yet; the eventual Client produced by build() may end up with any HTTP backend depending on whether ClientBuilder::http_client was called.

pub fn builder() -> ClientBuilder<<Ext as Provider>::Builder>

Start constructing a provider client.

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

where Ext: Provider,

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

where S: AsRef<str>,

Build a provider-customized POST request for a regular HTTP endpoint.

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

where S: AsRef<str>,

Build a provider-customized POST request for an SSE endpoint.

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

where S: AsRef<str>,

Build a provider-customized GET request for an SSE endpoint.

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

where S: AsRef<str>,

Build a provider-customized GET request for a regular HTTP endpoint.

impl<H> Client<ChatGPTExt, H>

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

pub async fn authorize(&self) -> Result<(), AuthError>

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<H> Client<CopilotExt, H>

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

pub async fn authorize(&self) -> Result<(), AuthError>

impl<H> Client<GeminiExt, H>

pub fn interactions_api(self) -> Client<GeminiInteractionsExt, H>

Create an Interactions API client from this GenerateContent client.

impl<H> Client<GeminiInteractionsExt, H>

pub fn generate_content_api(self) -> Client<GeminiExt, H>

Create a GenerateContent API client from this Interactions client.

impl<T> Client<GeminiInteractionsExt, T>

where T: HttpClientExt + Clone + Debug + Default + 'static,

pub async fn create_interaction( &self, request: CreateInteractionRequest, ) -> Result<Interaction, CompletionError>

Create a new interaction and return the raw response payload.

pub async fn get_interaction( &self, interaction_id: impl AsRef<str>, ) -> Result<Interaction, CompletionError>

Fetch an interaction by ID (useful for polling background tasks).

pub async fn stream_interaction_events( &self, request: CreateInteractionRequest, ) -> Result<Pin<Box<dyn Stream<Item = Result<InteractionSseEvent, CompletionError>> + Send>>, CompletionError>

Start an interaction and stream raw SSE events.

pub async fn stream_interaction_events_by_id( &self, interaction_id: impl AsRef<str>, last_event_id: Option<&str>, ) -> Result<Pin<Box<dyn Stream<Item = Result<InteractionSseEvent, CompletionError>> + Send>>, CompletionError>

Resume an interaction stream by ID and optional last event ID.

impl Client<LlamafileExt>

pub fn from_url( base_url: &str, ) -> Result<Client<LlamafileExt>, ProviderClientError>

Create a client pointing at the given llamafile base URL (e.g. http://localhost:8080).

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<GenericResponsesCompletionModel<OpenAIResponsesExt, 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 Client<OpenAIResponsesExt>

pub fn responses_websocket_builder( &self, model: impl Into<String>, ) -> ResponsesWebSocketSessionBuilder

Available on non-target_family=wasm and crate feature websocket only.

WebSocket mode currently uses a native tokio-tungstenite transport and does not reuse custom HttpClientExt backends, so this API is only exposed for the default reqwest::Client transport.

pub async fn responses_websocket( &self, model: impl Into<String>, ) -> Result<ResponsesWebSocketSession, CompletionError>

Available on non-target_family=wasm and crate feature websocket only.

This API is OpenAI-specific and only available on non-wasm targets in rig-core.

impl<H> Client<OpenAICompletionsExt, H>

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

pub fn extractor<U>( &self, model: impl Into<String>, ) -> ExtractorBuilder<GenericCompletionModel<OpenAICompletionsExt, 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<M, Ext, H> AudioGenerationClient for Client<Ext, H>

where Ext: Capabilities<H, AudioGeneration = Capable<M>>, M: AudioGenerationModel<Client = Client<Ext, H>>,

Available on crate feature audio only.

type AudioGenerationModel = M

The AudioGenerationModel used by the Client

fn audio_generation_model( &self, model: impl Into<String>, ) -> <Client<Ext, H> as AudioGenerationClient>::AudioGenerationModel

Create an audio generation model with the given name.

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. Use this when the provider supports a model whose dimensionality is not known by Rig.

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<MultipartForm>, ) -> 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<Item = Result<Bytes, Error>, InnerItem = Result<Bytes, Error>>>>>, Error>> + WasmCompatSend

where T: Into<Bytes> + WasmCompatSend,

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

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

where Ext: Capabilities<H, ImageGeneration = Capable<M>>, M: ImageGenerationModel<Client = Client<Ext, H>>,

Available on crate feature image only.

type ImageGenerationModel = M

The ImageGenerationModel used by the Client

fn image_generation_model( &self, model: impl Into<String>, ) -> <Client<Ext, H> as ImageGenerationClient>::ImageGenerationModel

Create an image generation model with the given name.

fn custom_image_generation_model( &self, model: impl Into<String>, ) -> Self::ImageGenerationModel

Create an image generation model with the given name.

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

where Ext: Capabilities<H, ModelListing = Capable<M>> + Clone, M: ModelLister<H, Client = Client<Ext, H>> + WasmCompatSend + WasmCompatSync + Clone + 'static, H: WasmCompatSend + WasmCompatSync + Clone,

fn list_models( &self, ) -> impl Future<Output = Result<ModelList, ModelListingError>> + WasmCompatSend

List all available models from the provider.

impl ProviderClient for Client<AnthropicExt>

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<AnthropicExt>, <Client<AnthropicExt> as ProviderClient>::Error>

where Client<AnthropicExt>: Sized,

Create a client from the process’s environment.

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

where Client<AnthropicExt>: Sized,

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<AzureExt>

fn from_env() -> Result<Client<AzureExt>, <Client<AzureExt> as ProviderClient>::Error>

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

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<ChatGPTExt>

type Input = ChatGPTAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<ChatGPTExt>, <Client<ChatGPTExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<ChatGPTExt> as ProviderClient>::Input, ) -> Result<Client<ChatGPTExt>, <Client<ChatGPTExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<CohereExt>

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<CohereExt>, <Client<CohereExt> as ProviderClient>::Error>

where Client<CohereExt>: Sized,

Create a client from the process’s environment.

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

where Client<CohereExt>: Sized,

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<CopilotExt>

type Input = CopilotAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<CopilotExt>, <Client<CopilotExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<CopilotExt> as ProviderClient>::Input, ) -> Result<Client<CopilotExt>, <Client<CopilotExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<DeepSeekExt>

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<DeepSeekExt>, <Client<DeepSeekExt> as ProviderClient>::Error>

Create a client from the process’s environment.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<GaladrielExt>

fn from_env() -> Result<Client<GaladrielExt>, <Client<GaladrielExt> as ProviderClient>::Error>

Create a new Galadriel client from the GALADRIEL_API_KEY environment variable, and optionally from the GALADRIEL_FINE_TUNE_API_KEY environment variable.

type Input = (String, Option<String>)

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<GeminiExt>

fn from_env() -> Result<Client<GeminiExt>, <Client<GeminiExt> as ProviderClient>::Error>

Create a new Google Gemini client from the GEMINI_API_KEY environment variable.

type Input = GeminiApiKey

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<GeminiInteractionsExt>

fn from_env() -> Result<Client<GeminiInteractionsExt>, <Client<GeminiInteractionsExt> as ProviderClient>::Error>

Create a new Google Gemini interactions client from the GEMINI_API_KEY environment variable.

type Input = GeminiApiKey

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_val( input: <Client<GeminiInteractionsExt> as ProviderClient>::Input, ) -> Result<Client<GeminiInteractionsExt>, <Client<GeminiInteractionsExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<GroqExt>

fn from_env() -> Result<Client<GroqExt>, <Client<GroqExt> as ProviderClient>::Error>

Create a new Groq client from the GROQ_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<HuggingFaceExt>

fn from_env() -> Result<Client<HuggingFaceExt>, <Client<HuggingFaceExt> as ProviderClient>::Error>

Create a new Huggingface client from the HUGGINGFACE_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<HyperbolicExt>

fn from_env() -> Result<Client<HyperbolicExt>, <Client<HyperbolicExt> as ProviderClient>::Error>

Create a new Hyperbolic client from the HYPERBOLIC_API_KEY environment variable.

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<LlamafileExt>

type Input = Nothing

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<LlamafileExt>, <Client<LlamafileExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( _: <Client<LlamafileExt> as ProviderClient>::Input, ) -> Result<Client<LlamafileExt>, <Client<LlamafileExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<MiniMaxAnthropicExt>

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<MiniMaxAnthropicExt>, <Client<MiniMaxAnthropicExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<MiniMaxAnthropicExt> as ProviderClient>::Input, ) -> Result<Client<MiniMaxAnthropicExt>, <Client<MiniMaxAnthropicExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<MiniMaxExt>

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<MiniMaxExt>, <Client<MiniMaxExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<MiniMaxExt> as ProviderClient>::Input, ) -> Result<Client<MiniMaxExt>, <Client<MiniMaxExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<MiraExt>

fn from_env() -> Result<Client<MiraExt>, <Client<MiraExt> as ProviderClient>::Error>

Create a new Mira client from the MIRA_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<MistralExt>

fn from_env() -> Result<Client<MistralExt>, <Client<MistralExt> as ProviderClient>::Error>

where Client<MistralExt>: Sized,

Create a new Mistral client from the MISTRAL_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<MoonshotAnthropicExt>

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<MoonshotAnthropicExt>, <Client<MoonshotAnthropicExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<MoonshotAnthropicExt> as ProviderClient>::Input, ) -> Result<Client<MoonshotAnthropicExt>, <Client<MoonshotAnthropicExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<MoonshotExt>

fn from_env() -> Result<Client<MoonshotExt>, <Client<MoonshotExt> as ProviderClient>::Error>

Create a new Moonshot client from the MOONSHOT_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<OllamaExt>

type Input = OllamaApiKey

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<OllamaExt>, <Client<OllamaExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( api_key: <Client<OllamaExt> as ProviderClient>::Input, ) -> Result<Client<OllamaExt>, <Client<OllamaExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<OpenAICompletionsExt>

fn from_env() -> Result<Client<OpenAICompletionsExt>, <Client<OpenAICompletionsExt> as ProviderClient>::Error>

Create a new OpenAI Completions API client from the OPENAI_API_KEY environment variable.

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<OpenAIResponsesExt>

fn from_env() -> Result<Client<OpenAIResponsesExt>, <Client<OpenAIResponsesExt> as ProviderClient>::Error>

Create a new OpenAI Responses API client from the OPENAI_API_KEY environment variable.

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<OpenRouterExt>

fn from_env() -> Result<Client<OpenRouterExt>, <Client<OpenRouterExt> as ProviderClient>::Error>

Create a new openrouter client from the OPENROUTER_API_KEY environment variable.

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<PerplexityExt>

fn from_env() -> Result<Client<PerplexityExt>, <Client<PerplexityExt> as ProviderClient>::Error>

Create a new Perplexity client from the PERPLEXITY_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<TogetherExt>

fn from_env() -> Result<Client<TogetherExt>, <Client<TogetherExt> as ProviderClient>::Error>

Create a new Together AI client from the TOGETHER_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<VoyageExt>

fn from_env() -> Result<Client<VoyageExt>, <Client<VoyageExt> as ProviderClient>::Error>

Create a new OpenAI client from the OPENAI_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<XAiExt>

fn from_env() -> Result<Client<XAiExt>, <Client<XAiExt> as ProviderClient>::Error>

Create a new xAI client from the XAI_API_KEY environment variable.

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

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

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<XiaomiMimoAnthropicExt>

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<XiaomiMimoAnthropicExt>, <Client<XiaomiMimoAnthropicExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<XiaomiMimoAnthropicExt> as ProviderClient>::Input, ) -> Result<Client<XiaomiMimoAnthropicExt>, <Client<XiaomiMimoAnthropicExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<XiaomiMimoExt>

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<XiaomiMimoExt>, <Client<XiaomiMimoExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<XiaomiMimoExt> as ProviderClient>::Input, ) -> Result<Client<XiaomiMimoExt>, <Client<XiaomiMimoExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<ZAiAnthropicExt>

type Input = String

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<ZAiAnthropicExt>, <Client<ZAiAnthropicExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<ZAiAnthropicExt> as ProviderClient>::Input, ) -> Result<Client<ZAiAnthropicExt>, <Client<ZAiAnthropicExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

impl ProviderClient for Client<ZAiExt>

type Input = BearerAuth

Input accepted by ProviderClient::from_val.

type Error = ProviderClientError

Error returned when client construction fails.

fn from_env() -> Result<Client<ZAiExt>, <Client<ZAiExt> as ProviderClient>::Error>

Create a client from the process’s environment.

fn from_val( input: <Client<ZAiExt> as ProviderClient>::Input, ) -> Result<Client<ZAiExt>, <Client<ZAiExt> as ProviderClient>::Error>

Create a client from an explicit provider-specific input value.

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.