Struct Client 

pub struct Client { /* private fields */ }

Implementations

impl Client

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

Create a new Cohere client builder.

Example

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

// Initialize the Cohere client
let cohere_client = Client::builder("your-cohere-api-key")
   .build()

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

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

Panics

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

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

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

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

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

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

Trait Implementations

impl AsAudioGeneration for Client

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

Available on crate feature audio only.

impl AsImageGeneration for Client

fn as_image_generation(&self) -> Option<Box<dyn ImageGenerationClientDyn>>

Available on crate feature image only.

impl AsTranscription for Client

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

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompletionClient for Client

type CompletionModel = CompletionModel

The type of CompletionModel used by the client.

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

Create a completion model with the given name.

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

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

Formats the value using the given formatter.

impl EmbeddingsClient for Client

type EmbeddingModel = EmbeddingModel

The type of EmbeddingModel used by the Client

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

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.

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

Create an embedding builder with the given embedding model.

fn embeddings_with_ndims<D: Embed>( &self, model: &str, ndims: usize, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>

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() -> Self

Create a new Cohere client from the COHERE_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 VerifyClient for Client

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

Verify the configuration.