Skip to main content

Client

Struct Client 

Source
pub struct Client {
    pub model: GoogleModel,
    /* private fields */
}
Expand description

Wrapper struct which stores the HTTP Reqwest client and the request history. The send methods are used to send text and images without having to manage the history manually.

Fields§

§model: GoogleModel

Implementations§

Source§

impl Client

Source

pub async fn new(model: &GoogleModel, key: &str) -> Result<Self, Error>

Creates a new instance of a Reqwest client. The client is setup to utilize the given Google Gemini model.

Source

pub fn with_defaults(&mut self) -> Self

Mutates the client by setting sane default configurations based on the model.

Source

pub async fn with_tools_client( &mut self, mcps: Vec<Arc<ClientRuntime>>, ) -> Result<Self, Error>

Source

pub fn with_safety(&mut self, safety_settings: &[SafetySettings]) -> Self

Mutate the client by setting the specified safety settings.

Source

pub fn update_options(&mut self, updates: &[UpdateGenConfig]) -> Self

Source

pub fn with_instructions(&mut self, system_instruction: &str) -> &mut Self

Mutate the client by setting the specified system instructions. Some models do not support system instructions, so in these cases we front-load the system instructions as user text content.

Source

pub fn with_options(&mut self, options: &GenerationConfig) -> &mut Self

Source

pub async fn send_text(&mut self, text: &str) -> Result<Responses, Error>

Send the given text to the model. Returns the responses or an error message if an error was returned.

Source

pub async fn send_image(&mut self, blob: &Blob) -> Result<Responses, Error>

Source

pub async fn send_file_data( &mut self, data: &FileData, ) -> Result<Responses, Error>

Source

pub async fn send_image_file( &mut self, message: Option<String>, img: &Path, ) -> Result<Responses, Error>

Source

pub async fn send_parts(&mut self, parts: &[Part]) -> Result<Responses, Error>

Source

pub async fn send_image_bytes( &mut self, message: Option<String>, mime_type: &str, data: &str, ) -> Result<Responses, Error>

Send the given image to the model. This must be a UTF-8 Base64 encoded string which is required by the Google API. Optional text may be sent with the image to create a single consolidated message. Returns the responses or an error message if an error was returned.

Source

pub fn history(&self) -> &[Content]

Returns the entire session content.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<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