Struct Client

pub struct Client { /* private fields */ }

Implementations

impl Client

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

Create a new Hyperbolic client with the given API key.

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

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

pub fn from_env() -> Self

Create a new Hyperbolic client from the HYPERBOLIC_API_KEY environment variable. Panics if the environment variable is not set.

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

Create a completion model with the given name.

Example

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

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

let llama_3_1_8b = hyperbolic.completion_model(hyperbolic::LLAMA_3_1_8B);

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

Create an agent builder with the given completion model.

Example

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

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

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

pub fn extractor<T: JsonSchema + for<'a> Deserialize<'a> + Serialize + Send + Sync>( &self, model: &str, ) -> ExtractorBuilder<T, CompletionModel>

Create an extractor builder with the given completion model.

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.