Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Client for sending AI requests to supported providers.

Construct with:

Implementations§

Source§

impl Client

High-level client APIs.

Source

pub async fn all_model_names( &self, adapter_kind: AdapterKind, provider_config: impl Into<ProviderConfig>, ) -> Result<Vec<String>>

Lists model names for the given adapter.

Notes:

  • Non-Ollama adapters use a static list.

  • Ollama queries the default host (http://localhost:11434/v1/).

  • May evolve to accept a custom endpoint.

  • Accepts ProviderConfig or compatible values to override endpoint and auth.

  • For most adapters, names also drive AdapterKind detection (see AdapterKind).

  • Adapters should filter non-chat models until more skills are supported. Future: model_names(adapter_kind, Option<&[Skill]>).

Source

pub fn adapter_kind(&self) -> Option<AdapterKind>

Returns the bound AdapterKind for this Client, if any.

Set via ClientBuilder::with_adapter_kind at construction time — None for Clients that did not opt into the bound shape and still use per-call model-name inference. Useful for callers that want to introspect a Client without tracking the provider in parallel state.

Source

pub fn default_model(&self, model_name: &str) -> Result<ModelIden>

Builds a ModelIden by inferring AdapterKind from the model name.

Source

pub async fn resolve_model_iden(&self, model_name: &str) -> Result<ModelIden>

👎Deprecated:

use client.resolve_service_target(model_name)

Deprecated: use Client::resolve_service_target.

Source

pub async fn resolve_service_target( &self, model: impl Into<ModelSpec>, ) -> Result<ServiceTarget>

Resolves the service target (endpoint, auth, and model) for the given model.

Accepts any type that implements Into<ModelSpec>:

  • &str or String: Model name with full inference
  • ModelIden: Explicit adapter, resolves auth/endpoint
  • ServiceTarget: Uses directly, bypasses model mapping and auth resolution
Source

pub async fn exec_chat( &self, model: impl Into<ModelSpec>, chat_req: ChatRequest, options: Option<&ChatOptions>, ) -> Result<ChatResponse>

Sends a chat request and returns the full response.

Accepts any type that implements Into<ModelSpec>:

  • &str or String: Model name with full inference
  • ModelIden: Explicit adapter, resolves auth/endpoint
  • ServiceTarget: Uses directly, bypasses model mapping and auth resolution
Source

pub async fn exec_chat_stream( &self, model: impl Into<ModelSpec>, chat_req: ChatRequest, options: Option<&ChatOptions>, ) -> Result<ChatStreamResponse>

Streams a chat response.

Accepts any type that implements Into<ModelSpec>:

  • &str or String: Model name with full inference
  • ModelIden: Explicit adapter, resolves auth/endpoint
  • ServiceTarget: Uses directly, bypasses model mapping and auth resolution
Source

pub async fn embed( &self, model: impl Into<ModelSpec>, input: impl Into<String>, options: Option<&EmbedOptions>, ) -> Result<EmbedResponse>

Creates embeddings for a single input string.

Accepts any type that implements Into<ModelSpec> for the model parameter.

Source

pub async fn embed_batch( &self, model: impl Into<ModelSpec>, inputs: Vec<String>, options: Option<&EmbedOptions>, ) -> Result<EmbedResponse>

Creates embeddings for multiple input strings.

Accepts any type that implements Into<ModelSpec> for the model parameter.

Source

pub async fn exec_embed( &self, model: impl Into<ModelSpec>, embed_req: EmbedRequest, options: Option<&EmbedOptions>, ) -> Result<EmbedResponse>

Sends an embedding request and returns the response.

Accepts any type that implements Into<ModelSpec>:

  • &str or String: Model name with full inference
  • ModelIden: Explicit adapter, resolves auth/endpoint
  • ServiceTarget: Uses directly, bypasses model mapping and auth resolution
Source§

impl Client

Source

pub fn builder() -> ClientBuilder

Returns a builder for configuring and constructing a Client.

Equivalent to calling ClientBuilder::default().

Source

pub fn new() -> Result<Client>

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more