google_ai.rs

  1use std::mem;
  2
  3use anyhow::{Result, anyhow, bail};
  4use futures::{AsyncBufReadExt, AsyncReadExt, StreamExt, io::BufReader, stream::BoxStream};
  5use http_client::{AsyncBody, HttpClient, Method, Request as HttpRequest};
  6use serde::{Deserialize, Deserializer, Serialize, Serializer};
  7
  8pub const API_URL: &str = "https://generativelanguage.googleapis.com";
  9
 10pub async fn stream_generate_content(
 11    client: &dyn HttpClient,
 12    api_url: &str,
 13    api_key: &str,
 14    mut request: GenerateContentRequest,
 15) -> Result<BoxStream<'static, Result<GenerateContentResponse>>> {
 16    validate_generate_content_request(&request)?;
 17
 18    // The `model` field is emptied as it is provided as a path parameter.
 19    let model_id = mem::take(&mut request.model.model_id);
 20
 21    let uri =
 22        format!("{api_url}/v1beta/models/{model_id}:streamGenerateContent?alt=sse&key={api_key}",);
 23
 24    let request_builder = HttpRequest::builder()
 25        .method(Method::POST)
 26        .uri(uri)
 27        .header("Content-Type", "application/json");
 28
 29    let request = request_builder.body(AsyncBody::from(serde_json::to_string(&request)?))?;
 30    let mut response = client.send(request).await?;
 31    if response.status().is_success() {
 32        let reader = BufReader::new(response.into_body());
 33        Ok(reader
 34            .lines()
 35            .filter_map(|line| async move {
 36                match line {
 37                    Ok(line) => {
 38                        if let Some(line) = line.strip_prefix("data: ") {
 39                            match serde_json::from_str(line) {
 40                                Ok(response) => Some(Ok(response)),
 41                                Err(error) => Some(Err(anyhow!(format!(
 42                                    "Error parsing JSON: {:?}\n{:?}",
 43                                    error, line
 44                                )))),
 45                            }
 46                        } else {
 47                            None
 48                        }
 49                    }
 50                    Err(error) => Some(Err(anyhow!(error))),
 51                }
 52            })
 53            .boxed())
 54    } else {
 55        let mut text = String::new();
 56        response.body_mut().read_to_string(&mut text).await?;
 57        Err(anyhow!(
 58            "error during streamGenerateContent, status code: {:?}, body: {}",
 59            response.status(),
 60            text
 61        ))
 62    }
 63}
 64
 65pub async fn count_tokens(
 66    client: &dyn HttpClient,
 67    api_url: &str,
 68    api_key: &str,
 69    request: CountTokensRequest,
 70) -> Result<CountTokensResponse> {
 71    validate_generate_content_request(&request.generate_content_request)?;
 72
 73    let uri = format!(
 74        "{api_url}/v1beta/models/{model_id}:countTokens?key={api_key}",
 75        model_id = &request.generate_content_request.model.model_id,
 76    );
 77
 78    let request = serde_json::to_string(&request)?;
 79    let request_builder = HttpRequest::builder()
 80        .method(Method::POST)
 81        .uri(&uri)
 82        .header("Content-Type", "application/json");
 83    let http_request = request_builder.body(AsyncBody::from(request))?;
 84
 85    let mut response = client.send(http_request).await?;
 86    let mut text = String::new();
 87    response.body_mut().read_to_string(&mut text).await?;
 88    if response.status().is_success() {
 89        Ok(serde_json::from_str::<CountTokensResponse>(&text)?)
 90    } else {
 91        Err(anyhow!(
 92            "error during countTokens, status code: {:?}, body: {}",
 93            response.status(),
 94            text
 95        ))
 96    }
 97}
 98
 99pub fn validate_generate_content_request(request: &GenerateContentRequest) -> Result<()> {
100    if request.model.is_empty() {
101        bail!("Model must be specified");
102    }
103
104    if request.contents.is_empty() {
105        bail!("Request must contain at least one content item");
106    }
107
108    if let Some(user_content) = request
109        .contents
110        .iter()
111        .find(|content| content.role == Role::User)
112    {
113        if user_content.parts.is_empty() {
114            bail!("User content must contain at least one part");
115        }
116    }
117
118    Ok(())
119}
120
121#[derive(Debug, Serialize, Deserialize)]
122pub enum Task {
123    #[serde(rename = "generateContent")]
124    GenerateContent,
125    #[serde(rename = "streamGenerateContent")]
126    StreamGenerateContent,
127    #[serde(rename = "countTokens")]
128    CountTokens,
129    #[serde(rename = "embedContent")]
130    EmbedContent,
131    #[serde(rename = "batchEmbedContents")]
132    BatchEmbedContents,
133}
134
135#[derive(Debug, Serialize, Deserialize)]
136#[serde(rename_all = "camelCase")]
137pub struct GenerateContentRequest {
138    #[serde(default, skip_serializing_if = "ModelName::is_empty")]
139    pub model: ModelName,
140    pub contents: Vec<Content>,
141    #[serde(skip_serializing_if = "Option::is_none")]
142    pub system_instruction: Option<SystemInstruction>,
143    #[serde(skip_serializing_if = "Option::is_none")]
144    pub generation_config: Option<GenerationConfig>,
145    #[serde(skip_serializing_if = "Option::is_none")]
146    pub safety_settings: Option<Vec<SafetySetting>>,
147    #[serde(skip_serializing_if = "Option::is_none")]
148    pub tools: Option<Vec<Tool>>,
149    #[serde(skip_serializing_if = "Option::is_none")]
150    pub tool_config: Option<ToolConfig>,
151}
152
153#[derive(Debug, Serialize, Deserialize)]
154#[serde(rename_all = "camelCase")]
155pub struct GenerateContentResponse {
156    #[serde(skip_serializing_if = "Option::is_none")]
157    pub candidates: Option<Vec<GenerateContentCandidate>>,
158    #[serde(skip_serializing_if = "Option::is_none")]
159    pub prompt_feedback: Option<PromptFeedback>,
160    #[serde(skip_serializing_if = "Option::is_none")]
161    pub usage_metadata: Option<UsageMetadata>,
162}
163
164#[derive(Debug, Serialize, Deserialize)]
165#[serde(rename_all = "camelCase")]
166pub struct GenerateContentCandidate {
167    #[serde(skip_serializing_if = "Option::is_none")]
168    pub index: Option<usize>,
169    pub content: Content,
170    #[serde(skip_serializing_if = "Option::is_none")]
171    pub finish_reason: Option<String>,
172    #[serde(skip_serializing_if = "Option::is_none")]
173    pub finish_message: Option<String>,
174    #[serde(skip_serializing_if = "Option::is_none")]
175    pub safety_ratings: Option<Vec<SafetyRating>>,
176    #[serde(skip_serializing_if = "Option::is_none")]
177    pub citation_metadata: Option<CitationMetadata>,
178}
179
180#[derive(Debug, Serialize, Deserialize)]
181#[serde(rename_all = "camelCase")]
182pub struct Content {
183    #[serde(default)]
184    pub parts: Vec<Part>,
185    pub role: Role,
186}
187
188#[derive(Debug, Serialize, Deserialize)]
189#[serde(rename_all = "camelCase")]
190pub struct SystemInstruction {
191    pub parts: Vec<Part>,
192}
193
194#[derive(Debug, PartialEq, Deserialize, Serialize)]
195#[serde(rename_all = "camelCase")]
196pub enum Role {
197    User,
198    Model,
199}
200
201#[derive(Debug, Serialize, Deserialize)]
202#[serde(untagged)]
203pub enum Part {
204    TextPart(TextPart),
205    InlineDataPart(InlineDataPart),
206    FunctionCallPart(FunctionCallPart),
207    FunctionResponsePart(FunctionResponsePart),
208}
209
210#[derive(Debug, Serialize, Deserialize)]
211#[serde(rename_all = "camelCase")]
212pub struct TextPart {
213    pub text: String,
214}
215
216#[derive(Debug, Serialize, Deserialize)]
217#[serde(rename_all = "camelCase")]
218pub struct InlineDataPart {
219    pub inline_data: GenerativeContentBlob,
220}
221
222#[derive(Debug, Serialize, Deserialize)]
223#[serde(rename_all = "camelCase")]
224pub struct GenerativeContentBlob {
225    pub mime_type: String,
226    pub data: String,
227}
228
229#[derive(Debug, Serialize, Deserialize)]
230#[serde(rename_all = "camelCase")]
231pub struct FunctionCallPart {
232    pub function_call: FunctionCall,
233}
234
235#[derive(Debug, Serialize, Deserialize)]
236#[serde(rename_all = "camelCase")]
237pub struct FunctionResponsePart {
238    pub function_response: FunctionResponse,
239}
240
241#[derive(Debug, Serialize, Deserialize)]
242#[serde(rename_all = "camelCase")]
243pub struct CitationSource {
244    #[serde(skip_serializing_if = "Option::is_none")]
245    pub start_index: Option<usize>,
246    #[serde(skip_serializing_if = "Option::is_none")]
247    pub end_index: Option<usize>,
248    #[serde(skip_serializing_if = "Option::is_none")]
249    pub uri: Option<String>,
250    #[serde(skip_serializing_if = "Option::is_none")]
251    pub license: Option<String>,
252}
253
254#[derive(Debug, Serialize, Deserialize)]
255#[serde(rename_all = "camelCase")]
256pub struct CitationMetadata {
257    pub citation_sources: Vec<CitationSource>,
258}
259
260#[derive(Debug, Serialize, Deserialize)]
261#[serde(rename_all = "camelCase")]
262pub struct PromptFeedback {
263    #[serde(skip_serializing_if = "Option::is_none")]
264    pub block_reason: Option<String>,
265    pub safety_ratings: Vec<SafetyRating>,
266    #[serde(skip_serializing_if = "Option::is_none")]
267    pub block_reason_message: Option<String>,
268}
269
270#[derive(Debug, Serialize, Deserialize, Default)]
271#[serde(rename_all = "camelCase")]
272pub struct UsageMetadata {
273    #[serde(skip_serializing_if = "Option::is_none")]
274    pub prompt_token_count: Option<usize>,
275    #[serde(skip_serializing_if = "Option::is_none")]
276    pub cached_content_token_count: Option<usize>,
277    #[serde(skip_serializing_if = "Option::is_none")]
278    pub candidates_token_count: Option<usize>,
279    #[serde(skip_serializing_if = "Option::is_none")]
280    pub tool_use_prompt_token_count: Option<usize>,
281    #[serde(skip_serializing_if = "Option::is_none")]
282    pub thoughts_token_count: Option<usize>,
283    #[serde(skip_serializing_if = "Option::is_none")]
284    pub total_token_count: Option<usize>,
285}
286
287#[derive(Debug, Deserialize, Serialize)]
288#[serde(rename_all = "camelCase")]
289pub struct GenerationConfig {
290    #[serde(skip_serializing_if = "Option::is_none")]
291    pub candidate_count: Option<usize>,
292    #[serde(skip_serializing_if = "Option::is_none")]
293    pub stop_sequences: Option<Vec<String>>,
294    #[serde(skip_serializing_if = "Option::is_none")]
295    pub max_output_tokens: Option<usize>,
296    #[serde(skip_serializing_if = "Option::is_none")]
297    pub temperature: Option<f64>,
298    #[serde(skip_serializing_if = "Option::is_none")]
299    pub top_p: Option<f64>,
300    #[serde(skip_serializing_if = "Option::is_none")]
301    pub top_k: Option<usize>,
302}
303
304#[derive(Debug, Serialize, Deserialize)]
305#[serde(rename_all = "camelCase")]
306pub struct SafetySetting {
307    pub category: HarmCategory,
308    pub threshold: HarmBlockThreshold,
309}
310
311#[derive(Debug, Serialize, Deserialize)]
312pub enum HarmCategory {
313    #[serde(rename = "HARM_CATEGORY_UNSPECIFIED")]
314    Unspecified,
315    #[serde(rename = "HARM_CATEGORY_DEROGATORY")]
316    Derogatory,
317    #[serde(rename = "HARM_CATEGORY_TOXICITY")]
318    Toxicity,
319    #[serde(rename = "HARM_CATEGORY_VIOLENCE")]
320    Violence,
321    #[serde(rename = "HARM_CATEGORY_SEXUAL")]
322    Sexual,
323    #[serde(rename = "HARM_CATEGORY_MEDICAL")]
324    Medical,
325    #[serde(rename = "HARM_CATEGORY_DANGEROUS")]
326    Dangerous,
327    #[serde(rename = "HARM_CATEGORY_HARASSMENT")]
328    Harassment,
329    #[serde(rename = "HARM_CATEGORY_HATE_SPEECH")]
330    HateSpeech,
331    #[serde(rename = "HARM_CATEGORY_SEXUALLY_EXPLICIT")]
332    SexuallyExplicit,
333    #[serde(rename = "HARM_CATEGORY_DANGEROUS_CONTENT")]
334    DangerousContent,
335}
336
337#[derive(Debug, Serialize, Deserialize)]
338#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
339pub enum HarmBlockThreshold {
340    #[serde(rename = "HARM_BLOCK_THRESHOLD_UNSPECIFIED")]
341    Unspecified,
342    BlockLowAndAbove,
343    BlockMediumAndAbove,
344    BlockOnlyHigh,
345    BlockNone,
346}
347
348#[derive(Debug, Serialize, Deserialize)]
349#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
350pub enum HarmProbability {
351    #[serde(rename = "HARM_PROBABILITY_UNSPECIFIED")]
352    Unspecified,
353    Negligible,
354    Low,
355    Medium,
356    High,
357}
358
359#[derive(Debug, Serialize, Deserialize)]
360#[serde(rename_all = "camelCase")]
361pub struct SafetyRating {
362    pub category: HarmCategory,
363    pub probability: HarmProbability,
364}
365
366#[derive(Debug, Serialize, Deserialize)]
367#[serde(rename_all = "camelCase")]
368pub struct CountTokensRequest {
369    pub generate_content_request: GenerateContentRequest,
370}
371
372#[derive(Debug, Serialize, Deserialize)]
373#[serde(rename_all = "camelCase")]
374pub struct CountTokensResponse {
375    pub total_tokens: usize,
376}
377
378#[derive(Debug, Serialize, Deserialize)]
379pub struct FunctionCall {
380    pub name: String,
381    pub args: serde_json::Value,
382}
383
384#[derive(Debug, Serialize, Deserialize)]
385pub struct FunctionResponse {
386    pub name: String,
387    pub response: serde_json::Value,
388}
389
390#[derive(Debug, Serialize, Deserialize)]
391#[serde(rename_all = "camelCase")]
392pub struct Tool {
393    pub function_declarations: Vec<FunctionDeclaration>,
394}
395
396#[derive(Debug, Serialize, Deserialize)]
397#[serde(rename_all = "camelCase")]
398pub struct ToolConfig {
399    pub function_calling_config: FunctionCallingConfig,
400}
401
402#[derive(Debug, Serialize, Deserialize)]
403#[serde(rename_all = "camelCase")]
404pub struct FunctionCallingConfig {
405    pub mode: FunctionCallingMode,
406    #[serde(skip_serializing_if = "Option::is_none")]
407    pub allowed_function_names: Option<Vec<String>>,
408}
409
410#[derive(Debug, Serialize, Deserialize)]
411#[serde(rename_all = "lowercase")]
412pub enum FunctionCallingMode {
413    Auto,
414    Any,
415    None,
416}
417
418#[derive(Debug, Serialize, Deserialize)]
419pub struct FunctionDeclaration {
420    pub name: String,
421    pub description: String,
422    pub parameters: serde_json::Value,
423}
424
425#[derive(Debug, Default)]
426pub struct ModelName {
427    pub model_id: String,
428}
429
430impl ModelName {
431    pub fn is_empty(&self) -> bool {
432        self.model_id.is_empty()
433    }
434}
435
436const MODEL_NAME_PREFIX: &str = "models/";
437
438impl Serialize for ModelName {
439    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
440    where
441        S: Serializer,
442    {
443        serializer.serialize_str(&format!("{MODEL_NAME_PREFIX}{}", &self.model_id))
444    }
445}
446
447impl<'de> Deserialize<'de> for ModelName {
448    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
449    where
450        D: Deserializer<'de>,
451    {
452        let string = String::deserialize(deserializer)?;
453        if let Some(id) = string.strip_prefix(MODEL_NAME_PREFIX) {
454            Ok(Self {
455                model_id: id.to_string(),
456            })
457        } else {
458            return Err(serde::de::Error::custom(format!(
459                "Expected model name to begin with {}, got: {}",
460                MODEL_NAME_PREFIX, string
461            )));
462        }
463    }
464}
465
466#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
467#[derive(Clone, Default, Debug, Deserialize, Serialize, PartialEq, Eq, strum::EnumIter)]
468pub enum Model {
469    #[serde(rename = "gemini-1.5-pro")]
470    Gemini15Pro,
471    #[serde(rename = "gemini-1.5-flash")]
472    Gemini15Flash,
473    #[serde(rename = "gemini-2.0-pro-exp")]
474    Gemini20Pro,
475    #[serde(rename = "gemini-2.0-flash")]
476    #[default]
477    Gemini20Flash,
478    #[serde(rename = "gemini-2.0-flash-thinking-exp")]
479    Gemini20FlashThinking,
480    #[serde(rename = "gemini-2.0-flash-lite-preview")]
481    Gemini20FlashLite,
482    #[serde(rename = "gemini-2.5-pro-exp-03-25")]
483    Gemini25ProExp0325,
484    #[serde(rename = "gemini-2.5-pro-preview-03-25")]
485    Gemini25ProPreview0325,
486    #[serde(rename = "gemini-2.5-flash-preview-04-17")]
487    Gemini25FlashPreview0417,
488    #[serde(rename = "custom")]
489    Custom {
490        name: String,
491        /// The name displayed in the UI, such as in the assistant panel model dropdown menu.
492        display_name: Option<String>,
493        max_tokens: usize,
494    },
495}
496
497impl Model {
498    pub fn default_fast() -> Model {
499        Model::Gemini15Flash
500    }
501
502    pub fn id(&self) -> &str {
503        match self {
504            Model::Gemini15Pro => "gemini-1.5-pro",
505            Model::Gemini15Flash => "gemini-1.5-flash",
506            Model::Gemini20Pro => "gemini-2.0-pro-exp",
507            Model::Gemini20Flash => "gemini-2.0-flash",
508            Model::Gemini20FlashThinking => "gemini-2.0-flash-thinking-exp",
509            Model::Gemini20FlashLite => "gemini-2.0-flash-lite-preview",
510            Model::Gemini25ProExp0325 => "gemini-2.5-pro-exp-03-25",
511            Model::Gemini25ProPreview0325 => "gemini-2.5-pro-preview-03-25",
512            Model::Gemini25FlashPreview0417 => "gemini-2.5-flash-preview-04-17",
513            Model::Custom { name, .. } => name,
514        }
515    }
516
517    pub fn display_name(&self) -> &str {
518        match self {
519            Model::Gemini15Pro => "Gemini 1.5 Pro",
520            Model::Gemini15Flash => "Gemini 1.5 Flash",
521            Model::Gemini20Pro => "Gemini 2.0 Pro",
522            Model::Gemini20Flash => "Gemini 2.0 Flash",
523            Model::Gemini20FlashThinking => "Gemini 2.0 Flash Thinking",
524            Model::Gemini20FlashLite => "Gemini 2.0 Flash Lite",
525            Model::Gemini25ProExp0325 => "Gemini 2.5 Pro Exp",
526            Model::Gemini25ProPreview0325 => "Gemini 2.5 Pro Preview",
527            Model::Gemini25FlashPreview0417 => "Gemini 2.5 Flash Preview",
528            Self::Custom {
529                name, display_name, ..
530            } => display_name.as_ref().unwrap_or(name),
531        }
532    }
533
534    pub fn max_token_count(&self) -> usize {
535        const ONE_MILLION: usize = 1_048_576;
536        const TWO_MILLION: usize = 2_097_152;
537        match self {
538            Model::Gemini15Pro => TWO_MILLION,
539            Model::Gemini15Flash => ONE_MILLION,
540            Model::Gemini20Pro => TWO_MILLION,
541            Model::Gemini20Flash => ONE_MILLION,
542            Model::Gemini20FlashThinking => ONE_MILLION,
543            Model::Gemini20FlashLite => ONE_MILLION,
544            Model::Gemini25ProExp0325 => ONE_MILLION,
545            Model::Gemini25ProPreview0325 => ONE_MILLION,
546            Model::Gemini25FlashPreview0417 => ONE_MILLION,
547            Model::Custom { max_tokens, .. } => *max_tokens,
548        }
549    }
550}
551
552impl std::fmt::Display for Model {
553    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
554        write!(f, "{}", self.id())
555    }
556}