SharedClient

Struct SharedClient 

Source
pub struct SharedClient { /* private fields */ }
Expand description

A thread-safe, cheaply clonable client for interacting with the Generative Language API.

This client wraps a standard Client in an Arc, making it easy to share across threads without lifetime issues. Unlike the regular Client, which provides a borrowed reference (&'c self), methods on SharedClient return models with a static lifetime ('static), allowing them to be moved and stored independently of the client.

Use SharedClient when you need to pass the client to different threads, store it in a global state, or when the client is intended to live for the duration of the application.

§Example

use google_ai_rs::{Client, SharedClient};

let client = Client::new("your-api-key").await?;
let shared_client: SharedClient = client.into_shared();

let model = shared_client.generative_model("models/gemini-pro");
// The model can now be used in a different thread or stored.

drop(shared_client);

// You can still use model
model.generate_content("Hello, AI").await?;

Implementations§

Source§

impl SharedClient

Source

pub fn generative_model(&self, name: &str) -> GenerativeModel<'static>

Creates a new generative model interface

Source

pub fn typed_model<T: AsSchema>(&self, name: &str) -> TypedModel<'static, T>

Creates a new typed generative model interface

Methods from Deref<Target = Client>§

Source

pub async fn update_auth(&self, new_auth: impl Into<Auth> + Send)

Updates authentication credentials atomically

Subsequent requests will use the new credentials immediately. This operation is thread-safe.

§Panics

May panic if auth cannot parsed

Source

pub async fn update_auth_fallibly( &self, new_auth: impl Into<Auth> + Send, ) -> Result<(), Error>

Source

pub async fn create_cached_content( &self, content: CachedContent, ) -> Result<CachedContent, Error>

Creates a new cached content entry

§Arguments
  • content - Content to cache without name (server-generated)
§Errors

Returns Error::InvalidArgument if content contains a name

Source

pub async fn get_cached_content( &self, name: &str, ) -> Result<CachedContent, Error>

Retrieves the CachedContent with the given name.

Source

pub async fn delete_cached_content(&self, name: &str) -> Result<(), Error>

Deletes the CachedContent with the given name.

Source

pub async fn update_cached_content( &self, cc: &CachedContent, ) -> Result<CachedContent, Error>

Modifies the CachedContent.

It returns the modified CachedContent.

The argument CachedContent must have its name field and fields to update populated.

Source

pub fn list_cached_contents(&self) -> CachedContentIterator<'_>

Returns an async iterator over cached content entries

Automatically handles pagination through server-side results.

Source

pub async fn get_model(&self, name: &str) -> Result<Model, Error>

Gets information about a specific Model such as its version number, token limits, etc

Source

pub async fn get_tuned_model( &self, resource_name: &str, ) -> Result<TunedModel, Error>

Gets information about a specific TunedModel.

Source

pub async fn list_models(&self) -> ModelsListIterator<'_>

Returns an async iterator over models list results

Automatically handles pagination through server-side results.

Source

pub async fn list_tuned_models(&self) -> TunedModelsListIterator<'_>

Returns an async iterator over tuned models list results

Automatically handles pagination through server-side results.

Source

pub async fn update_tuned_model( &self, m: &TunedModel, ) -> Result<TunedModel, Error>

Updates a tuned model.

Source

pub async fn delete_tuned_model(&self, name: &str) -> Result<(), Error>

Deletes the TunedModel with the given name.

Source

pub fn embedding_model<'c>(&'c self, name: &str) -> Model<'c>

Creates a new embedding model interface

Shorthand for EmbeddingModel::new()

Source

pub fn generative_model<'c>(&'c self, name: &str) -> GenerativeModel<'c>

Creates a new generative model interface

Shorthand for GenerativeModel::new()

Source

pub fn typed_model<'c, T: AsSchema>(&'c self, name: &str) -> TypedModel<'c, T>

Creates a new typed generative model interface

Shorthand for TypedModel::new()

Trait Implementations§

Source§

impl Clone for SharedClient

Source§

fn clone(&self) -> SharedClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SharedClient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for SharedClient

Source§

type Target = Client

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl From<Client> for SharedClient

Source§

fn from(value: Client) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic_veecore::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more