Struct Client 

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

Implementations

impl<T> Client<T>

where T: HttpClientExt + Default,

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

Create a new Google Gemini client builder.

Example

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

// Initialize the Google Gemini client
let gemini_client = Client::builder("your-google-gemini-api-key")
   .build()

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

Create a new Google Gemini 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> AsImageGeneration for Client<T>

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

Available on crate feature image only.

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) -> Self::CompletionModel

Create a completion model with the given name. Gemini-specific parameters can be set using the GenerationConfig struct. Gemini API Reference

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<T> EmbeddingsClient for Client<T>

where T: HttpClientExt + Clone + Debug + Default + 'static, Client<T>: CompletionClient,

fn embedding_model(&self, model: &str) -> EmbeddingModel<T>

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::gemini::{Client, self};

// Initialize the Google Gemini client
let gemini = Client::new("your-google-gemini-api-key");

let embedding_model = gemini.embedding_model(gemini::embedding::EMBEDDING_GECKO_001);

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

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

Example

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

// Initialize the Google Gemini client
let gemini = Client::new("your-google-gemini-api-key");

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

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

Create an embedding builder with the given embedding model.

Example

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

// Initialize the Google Gemini client
let gemini = Client::new("your-google-gemini-api-key");

let embeddings = gemini.embeddings(gemini::embedding::EMBEDDING_GECKO_001)
    .simple_document("doc0", "Hello, world!")
    .simple_document("doc1", "Goodbye, world!")
    .build()
    .await
    .expect("Failed to embed documents");

type EmbeddingModel = EmbeddingModel<T>

The type of EmbeddingModel used by the Client

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

fn from_env() -> Self

Create a new Google Gemini client from the GEMINI_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<T> TranscriptionClient for Client<T>

where T: HttpClientExt + Clone + Debug + Default + 'static, Client<T>: CompletionClient,

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

Create a transcription model with the given name. Gemini-specific parameters can be set using the GenerationConfig struct. Gemini API Reference

type TranscriptionModel = TranscriptionModel<T>

The type of TranscriptionModel used by the Client

impl<T> VerifyClient for Client<T>

where T: HttpClientExt + Clone + Debug + Default + WasmCompatSend + WasmCompatSync + 'static, Client<T>: CompletionClient,

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

Verify the configuration.