Struct Client

pub struct Client { /* private fields */ }

Implementations

impl Client

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

Create a new Huggingface client with the given API key.

pub fn from_url( api_key: &str, base_url: &str, sub_provider: SubProvider, ) -> Self

Create a new Client with the given API key and base API URL.

pub fn from_env() -> Self

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

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

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);

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

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);

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

Create an agent builder with the given completion model.

Example

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

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

let agent = client.agent(huggingface::GEMMA_2)
   .preamble("You are comedian AI with a mission to make people laugh.")
   .temperature(0.0)
   .build();

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.