Client

Struct Client 

Source
pub struct Client<T = Client> { /* private fields */ }
Expand description

Provider client: Client Note: base_url is resolved into concrete endpoints during build, so we don’t store base_url.

Implementations§

Source§

impl<T> Client<T>
where T: Default,

Source

pub fn builder<'a>() -> ClientBuilder<'a, T>

Source

pub fn new() -> Self

Source§

impl Client<Client>

Source

pub async fn predict( &self, inputs: impl IntoIterator<Item = String>, ) -> Result<PredictResponse, PredictError>

Predict/classify inputs using TEI router endpoint (customizable via ClientBuilder)

Source§

impl Client<Client>

Source

pub async fn rerank( &self, query: &str, texts: impl IntoIterator<Item = String>, top_n: Option<usize>, ) -> Result<Vec<RerankResult>, RerankError>

Rerank endpoint (customizable via ClientBuilder): POST {endpoints.rerank}

Trait Implementations§

Source§

impl<T> AsCompletion for Client<T>

Source§

impl<T> AsTranscription for Client<T>

Source§

impl<T: Clone> Clone for Client<T>

Source§

fn clone(&self) -> Client<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Client<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for Client<T>
where T: Default,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl EmbeddingsClient for Client<Client>

Source§

type EmbeddingModel = EmbeddingModel

The type of EmbeddingModel used by the Client
Source§

fn embedding_model(&self, model: &str) -> Self::EmbeddingModel

Create an embedding model with the given name. 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 Read more
Source§

fn embedding_model_with_ndims( &self, model: &str, ndims: usize, ) -> Self::EmbeddingModel

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

fn embeddings<D>( &self, model: &str, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>
where D: Embed,

Create an embedding builder with the given embedding model. Read more
Source§

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. Read more
Source§

impl ProviderClient for Client<Client>

Source§

fn from_env() -> Self

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

fn from_val(input: ProviderValue) -> Self

Source§

fn boxed(self) -> Box<dyn ProviderClient>
where Self: Sized + 'static,

A helper method to box the client.
Source§

fn from_env_boxed<'a>() -> Box<dyn ProviderClient + 'a>
where Self: Sized + 'a,

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

fn from_val_boxed<'a>(input: ProviderValue) -> Box<dyn ProviderClient + 'a>
where Self: Sized + 'a,

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

impl VerifyClient for Client<Client>

Source§

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

Verify the configuration.

Auto Trait Implementations§

§

impl<T> Freeze for Client<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Client<T>
where T: RefUnwindSafe,

§

impl<T> Send for Client<T>
where T: Send,

§

impl<T> Sync for Client<T>
where T: Sync,

§

impl<T> Unpin for Client<T>
where T: Unpin,

§

impl<T> UnwindSafe for Client<T>
where T: UnwindSafe,

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> AsEmbeddings for T
where T: EmbeddingsClientDyn + Clone + 'static,

Source§

impl<T> AsVerify for T
where T: VerifyClientDyn + Clone + 'static,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<M, T> EmbeddingsClientDyn for T
where T: EmbeddingsClient<EmbeddingModel = M>, M: EmbeddingModel + 'static,

Source§

fn embedding_model<'a>(&self, model: &str) -> Box<dyn EmbeddingModelDyn + 'a>

Create an embedding model with the given name. 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
Source§

fn embedding_model_with_ndims<'a>( &self, model: &str, ndims: usize, ) -> Box<dyn EmbeddingModelDyn + 'a>

Create an embedding model with the given name and the number of dimensions in the embedding generated by the model.
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> 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: 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: 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> VerifyClientDyn for T
where T: VerifyClient,

Source§

fn verify( &self, ) -> Pin<Box<dyn Future<Output = Result<(), VerifyError>> + Send + '_>>

Verify the configuration.
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
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
Source§

impl<T> AsAudioGeneration for T
where T: ProviderClient,

Source§

impl<T> AsImageGeneration for T
where T: ProviderClient,

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,