gemini_client_api/gemini/
ask.rs

1use super::error::GeminiResponseError;
2use super::types::request::*;
3use super::types::response::*;
4use super::types::sessions::Session;
5use reqwest::Client;
6use serde_json::{Value, json};
7use std::time::Duration;
8
9const BASE_URL: &str = "https://generativelanguage.googleapis.com/v1beta/models";
10
11#[derive(Clone, Default, Debug)]
12pub struct Gemini {
13    client: Client,
14    api_key: String,
15    model: String,
16    sys_prompt: Option<SystemInstruction>,
17    generation_config: Option<Value>,
18    tools: Option<Vec<Tool>>,
19}
20impl Gemini {
21    /// # Arguments
22    /// `api_key` get one from [Google AI studio](https://aistudio.google.com/app/apikey)
23    /// `model` should be of those mentioned [here](https://ai.google.dev/gemini-api/docs/models#model-variations) in bold black color
24    /// `sys_prompt` should follow [gemini doc](https://ai.google.dev/gemini-api/docs/text-generation#image-input)
25    pub fn new(
26        api_key: impl Into<String>,
27        model: impl Into<String>,
28        sys_prompt: Option<SystemInstruction>,
29    ) -> Self {
30        Self {
31            client: Client::builder()
32                .timeout(Duration::from_secs(60))
33                .build()
34                .unwrap(),
35            api_key: api_key.into(),
36            model: model.into(),
37            sys_prompt,
38            generation_config: None,
39            tools: None,
40        }
41    }
42    /// `sys_prompt` should follow [gemini doc](https://ai.google.dev/gemini-api/docs/text-generation#image-input)
43    pub fn new_with_timeout(
44        api_key: impl Into<String>,
45        model: impl Into<String>,
46        sys_prompt: Option<SystemInstruction>,
47        api_timeout: Duration,
48    ) -> Self {
49        Self {
50            client: Client::builder().timeout(api_timeout).build().unwrap(),
51            api_key: api_key.into(),
52            model: model.into(),
53            sys_prompt,
54            generation_config: None,
55            tools: None,
56        }
57    }
58    /// The generation config Schema should follow [Gemini docs](https://ai.google.dev/api/generate-content#generationconfig)
59    pub fn set_generation_config(mut self, generation_config: Value) -> Self {
60        self.generation_config = Some(generation_config);
61        self
62    }
63    pub fn set_model(mut self, model: impl Into<String>) -> Self {
64        self.model = model.into();
65        self
66    }
67    pub fn set_api_key(mut self, api_key: impl Into<String>) -> Self {
68        self.api_key = api_key.into();
69        self
70    }
71    /// `schema` should follow [Schema of gemini](https://ai.google.dev/api/caching#Schema)
72    /// To verify your schema visit [here](https://aistudio.google.com/prompts/new_chat):
73    /// - Under tools, toggle on Structured output
74    /// - Click Edit
75    /// - Here you can create schema with `Visual Editor` or `Code Editor` with error detection
76    pub fn set_json_mode(mut self, schema: Value) -> Self {
77        if let None = self.generation_config {
78            self.generation_config = Some(json!({
79                "response_mime_type": "application/json",
80                "response_schema":schema
81            }))
82        } else if let Some(config) = self.generation_config.as_mut() {
83            config["response_mime_type"] = "application/json".into();
84            config["response_schema"] = schema.into();
85        }
86        self
87    }
88    pub fn unset_json_mode(mut self) -> Self {
89        if let Some(ref mut generation_config) = self.generation_config {
90            generation_config["response_schema"] = None::<Value>.into();
91            generation_config["response_mime_type"] = None::<Value>.into();
92        }
93        self
94    }
95    pub fn set_tools(mut self, tools: Vec<Tool>) -> Self {
96        self.tools = Some(tools);
97        self
98    }
99    pub fn unset_tools(mut self) -> Self {
100        self.tools = None;
101        self
102    }
103
104    pub async fn ask(&self, session: &mut Session) -> Result<GeminiResponse, GeminiResponseError> {
105        let req_url = format!(
106            "{BASE_URL}/{}:generateContent?key={}",
107            self.model, self.api_key
108        );
109
110        let response = self
111            .client
112            .post(req_url)
113            .json(&GeminiRequestBody::new(
114                self.sys_prompt.as_ref(),
115                self.tools.as_deref(),
116                &session.get_history().as_slice(),
117                self.generation_config.as_ref(),
118            ))
119            .send()
120            .await
121            .map_err(|e| GeminiResponseError::ReqwestError(e))?;
122
123        if !response.status().is_success() {
124            let text = response
125                .text()
126                .await
127                .map_err(|e| GeminiResponseError::ReqwestError(e))?;
128            return Err(GeminiResponseError::StatusNotOk(text));
129        }
130
131        let reply = GeminiResponse::new(response)
132            .await
133            .map_err(|e| GeminiResponseError::ReqwestError(e))?;
134        session.update(&reply);
135        Ok(reply)
136    }
137    /// # Warning
138    /// You must read the response stream to get reply stored context in `session`.
139    /// `data_extractor` is used to extract data that you get as a stream of futures.
140    /// # Example
141    ///```ignore
142    ///use futures::StreamExt
143    ///let mut response_stream = gemini.ask_as_stream_with_extractor(session,
144    ///|session, _gemini_response| session.get_last_message_text("").unwrap())
145    ///.await.unwrap(); // Use _gemini_response.get_text("") to just get the text received in every chunk
146    ///
147    ///while let Some(response) = response_stream.next().await {
148    ///    if let Ok(response) = response {
149    ///        println!("{}", response);
150    ///    }
151    ///}
152    ///```
153    pub async fn ask_as_stream_with_extractor<F, StreamType>(
154        &self,
155        session: Session,
156        data_extractor: F,
157    ) -> Result<ResponseStream<F, StreamType>, GeminiResponseError>
158    where
159        F: FnMut(&Session, GeminiResponse) -> StreamType,
160    {
161        let req_url = format!(
162            "{BASE_URL}/{}:streamGenerateContent?key={}",
163            self.model, self.api_key
164        );
165
166        let response = self
167            .client
168            .post(req_url)
169            .json(&GeminiRequestBody::new(
170                self.sys_prompt.as_ref(),
171                self.tools.as_deref(),
172                session.get_history().as_slice(),
173                self.generation_config.as_ref(),
174            ))
175            .send()
176            .await
177            .map_err(|e| GeminiResponseError::ReqwestError(e))?;
178
179        if !response.status().is_success() {
180            let text = response
181                .text()
182                .await
183                .map_err(|e| GeminiResponseError::ReqwestError(e))?;
184            return Err(GeminiResponseError::StatusNotOk(text.into()));
185        }
186
187        Ok(ResponseStream::new(
188            Box::new(response.bytes_stream()),
189            session,
190            data_extractor,
191        ))
192    }
193    /// # Warning
194    /// You must read the response stream to get reply stored context in `session`.
195    /// # Example
196    ///```ignore
197    ///use futures::StreamExt
198    ///let mut response_stream = gemini.ask_as_stream(session).await.unwrap();
199    ///
200    ///while let Some(response) = response_stream.next().await {
201    ///    if let Ok(response) = response {
202    ///        println!("{}", response.get_text(""));
203    ///    }
204    ///}
205    ///```
206    pub async fn ask_as_stream(
207        &self,
208        session: Session,
209    ) -> Result<GeminiResponseStream, GeminiResponseError> {
210        self.ask_as_stream_with_extractor(
211            session,
212            (|_, gemini_response| gemini_response)
213                as fn(&Session, GeminiResponse) -> GeminiResponse,
214        )
215        .await
216    }
217}
gemini_client_api/gemini/ask.rs

gemini_client_api/gemini/
ask.rs
