Struct Client 

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

Implementations

impl<T> Client<T>

where T: Default,

pub fn builder(api_key: &str) -> ClientBuilder<T>

Create a new Huggingface client builder.

Example

use rig::providers::huggingface::{ClientBuilder, self};

// Initialize the Huggingface client
let client = Client::builder("your-huggingface-api-key")
   .build()

pub fn new(api_key: &str) -> Self

Create a new Huggingface client. For more control, use the builder method.

Panics

• If the reqwest client cannot be built (if the TLS backend cannot be initialized).

Trait Implementations

impl<T> AsAudioGeneration for Client<T>

fn as_audio_generation(&self) -> Option<Box<dyn AudioGenerationClientDyn>>

Available on crate feature audio only.

impl<T> AsEmbeddings for Client<T>

fn as_embeddings(&self) -> Option<Box<dyn EmbeddingsClientDyn>>

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompletionClient for Client<Client>

fn completion_model(&self, model: &str) -> CompletionModel<Client>

Create a new completion model with the given name

Example

use rig::providers::huggingface::{Client, self}

// Initialize the Huggingface client
let client = Client::new("your-huggingface-api-key");

let completion_model = client.completion_model(huggingface::GEMMA_2);

type CompletionModel = CompletionModel

The type of CompletionModel used by the client.

fn agent(&self, model: &str) -> AgentBuilder<Self::CompletionModel>

Create an agent builder with the given completion model.

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

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

Create an extractor builder with the given completion model.

impl<T> Debug for Client<T>

where T: Debug,

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

Formats the value using the given formatter.

impl ImageGenerationClient for Client<Client>

Available on crate feature image only.

fn image_generation_model(&self, model: &str) -> ImageGenerationModel<Client>

Create a new image generation model with the given name

Example

use rig::providers::huggingface::{Client, self}

// Initialize the Huggingface client
let client = Client::new("your-huggingface-api-key");

let completion_model = client.image_generation_model(huggingface::WHISPER_LARGE_V3);

type ImageGenerationModel = ImageGenerationModel

The ImageGenerationModel used by the Client

impl ProviderClient for Client<Client>

fn from_env() -> Self

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

fn from_val(input: ProviderValue) -> Self

fn boxed(self) -> Box<dyn ProviderClient>

where Self: Sized + 'static,

A helper method to box the client.

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.

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.

impl TranscriptionClient for Client<Client>

fn transcription_model(&self, model: &str) -> TranscriptionModel<Client>

Create a new transcription model with the given name

Example

use rig::providers::huggingface::{Client, self}

// Initialize the Huggingface client
let client = Client::new("your-huggingface-api-key");

let completion_model = client.transcription_model(huggingface::WHISPER_LARGE_V3);

type TranscriptionModel = TranscriptionModel

The type of TranscriptionModel used by the Client

impl VerifyClient for Client<Client>

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

Verify the configuration.