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 Together AI client builder.

Example

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

// Initialize the Together AI client
let together_ai = Client::builder("your-together-ai-api-key")
   .build()

pub fn new(api_key: &str) -> Client<T>

Create a new Together AI 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> AsTranscription for Client<T>

fn as_transcription(&self) -> Option<Box<dyn TranscriptionClientDyn>>

impl<T> Clone for Client<T>

where T: Clone,

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

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

Create a completion model with the given name.

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<(), Error>

Formats the value using the given formatter.

impl EmbeddingsClient for Client

fn embedding_model(&self, model: &str) -> 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

Example

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

// Initialize the Together AI client
let together_ai = Client::new("your-together-ai-api-key");

let embedding_model = together_ai.embedding_model(together_ai::embedding::EMBEDDING_V1);

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

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

Example

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

// Initialize the Together AI client
let together_ai = Client::new("your-together-ai-api-key");

let embedding_model = together_ai.embedding_model_with_ndims("model-unknown-to-rig", 1024);

type EmbeddingModel = EmbeddingModel

The type of EmbeddingModel used by the Client

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

where D: Embed,

Create an embedding builder with the given embedding model.

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.

impl ProviderClient for Client

fn from_env() -> Client

Create a new Together AI client from the TOGETHER_API_KEY environment variable. Panics if the environment variable is not set.

fn from_val(input: ProviderValue) -> Client

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 VerifyClient for Client

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

Verify the configuration.