1use std::io::{Cursor, Write};
2use std::sync::Arc;
3
4use anyhow::Result;
5use base64::write::EncoderWriter;
6use cloud_llm_client::{CompletionIntent, CompletionMode};
7use gpui::{
8 App, AppContext as _, DevicePixels, Image, ImageFormat, ObjectFit, SharedString, Size, Task,
9 point, px, size,
10};
11use image::codecs::png::PngEncoder;
12use serde::{Deserialize, Serialize};
13use util::ResultExt;
14
15use crate::role::Role;
16use crate::{LanguageModelToolUse, LanguageModelToolUseId};
17
18#[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
19pub struct LanguageModelImage {
20 /// A base64-encoded PNG image.
21 pub source: SharedString,
22 pub size: Size<DevicePixels>,
23}
24
25impl LanguageModelImage {
26 pub fn len(&self) -> usize {
27 self.source.len()
28 }
29
30 pub fn is_empty(&self) -> bool {
31 self.source.is_empty()
32 }
33
34 // Parse Self from a JSON object with case-insensitive field names
35 pub fn from_json(obj: &serde_json::Map<String, serde_json::Value>) -> Option<Self> {
36 let mut source = None;
37 let mut size_obj = None;
38
39 // Find source and size fields (case-insensitive)
40 for (k, v) in obj.iter() {
41 match k.to_lowercase().as_str() {
42 "source" => source = v.as_str(),
43 "size" => size_obj = v.as_object(),
44 _ => {}
45 }
46 }
47
48 let source = source?;
49 let size_obj = size_obj?;
50
51 let mut width = None;
52 let mut height = None;
53
54 // Find width and height in size object (case-insensitive)
55 for (k, v) in size_obj.iter() {
56 match k.to_lowercase().as_str() {
57 "width" => width = v.as_i64().map(|w| w as i32),
58 "height" => height = v.as_i64().map(|h| h as i32),
59 _ => {}
60 }
61 }
62
63 Some(Self {
64 size: size(DevicePixels(width?), DevicePixels(height?)),
65 source: SharedString::from(source.to_string()),
66 })
67 }
68}
69
70impl std::fmt::Debug for LanguageModelImage {
71 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
72 f.debug_struct("LanguageModelImage")
73 .field("source", &format!("<{} bytes>", self.source.len()))
74 .field("size", &self.size)
75 .finish()
76 }
77}
78
79/// Anthropic wants uploaded images to be smaller than this in both dimensions.
80const ANTHROPIC_SIZE_LIMT: f32 = 1568.;
81
82impl LanguageModelImage {
83 pub fn empty() -> Self {
84 Self {
85 source: "".into(),
86 size: size(DevicePixels(0), DevicePixels(0)),
87 }
88 }
89
90 pub fn from_image(data: Arc<Image>, cx: &mut App) -> Task<Option<Self>> {
91 cx.background_spawn(async move {
92 let image_bytes = Cursor::new(data.bytes());
93 let dynamic_image = match data.format() {
94 ImageFormat::Png => image::codecs::png::PngDecoder::new(image_bytes)
95 .and_then(image::DynamicImage::from_decoder),
96 ImageFormat::Jpeg => image::codecs::jpeg::JpegDecoder::new(image_bytes)
97 .and_then(image::DynamicImage::from_decoder),
98 ImageFormat::Webp => image::codecs::webp::WebPDecoder::new(image_bytes)
99 .and_then(image::DynamicImage::from_decoder),
100 ImageFormat::Gif => image::codecs::gif::GifDecoder::new(image_bytes)
101 .and_then(image::DynamicImage::from_decoder),
102 _ => return None,
103 }
104 .log_err()?;
105
106 let width = dynamic_image.width();
107 let height = dynamic_image.height();
108 let image_size = size(DevicePixels(width as i32), DevicePixels(height as i32));
109
110 let base64_image = {
111 if image_size.width.0 > ANTHROPIC_SIZE_LIMT as i32
112 || image_size.height.0 > ANTHROPIC_SIZE_LIMT as i32
113 {
114 let new_bounds = ObjectFit::ScaleDown.get_bounds(
115 gpui::Bounds {
116 origin: point(px(0.0), px(0.0)),
117 size: size(px(ANTHROPIC_SIZE_LIMT), px(ANTHROPIC_SIZE_LIMT)),
118 },
119 image_size,
120 );
121 let resized_image = dynamic_image.resize(
122 new_bounds.size.width.0 as u32,
123 new_bounds.size.height.0 as u32,
124 image::imageops::FilterType::Triangle,
125 );
126
127 encode_as_base64(data, resized_image)
128 } else {
129 encode_as_base64(data, dynamic_image)
130 }
131 }
132 .log_err()?;
133
134 // SAFETY: The base64 encoder should not produce non-UTF8.
135 let source = unsafe { String::from_utf8_unchecked(base64_image) };
136
137 Some(LanguageModelImage {
138 size: image_size,
139 source: source.into(),
140 })
141 })
142 }
143
144 pub fn estimate_tokens(&self) -> usize {
145 let width = self.size.width.0.unsigned_abs() as usize;
146 let height = self.size.height.0.unsigned_abs() as usize;
147
148 // From: https://docs.anthropic.com/en/docs/build-with-claude/vision#calculate-image-costs
149 // Note that are a lot of conditions on Anthropic's API, and OpenAI doesn't use this,
150 // so this method is more of a rough guess.
151 (width * height) / 750
152 }
153
154 pub fn to_base64_url(&self) -> String {
155 format!("data:image/png;base64,{}", self.source)
156 }
157}
158
159fn encode_as_base64(data: Arc<Image>, image: image::DynamicImage) -> Result<Vec<u8>> {
160 let mut base64_image = Vec::new();
161 {
162 let mut base64_encoder = EncoderWriter::new(
163 Cursor::new(&mut base64_image),
164 &base64::engine::general_purpose::STANDARD,
165 );
166 if data.format() == ImageFormat::Png {
167 base64_encoder.write_all(data.bytes())?;
168 } else {
169 let mut png = Vec::new();
170 image.write_with_encoder(PngEncoder::new(&mut png))?;
171
172 base64_encoder.write_all(png.as_slice())?;
173 }
174 }
175 Ok(base64_image)
176}
177
178#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq, Hash)]
179pub struct LanguageModelToolResult {
180 pub tool_use_id: LanguageModelToolUseId,
181 pub tool_name: Arc<str>,
182 pub is_error: bool,
183 pub content: LanguageModelToolResultContent,
184 pub output: Option<serde_json::Value>,
185}
186
187#[derive(Debug, Clone, Serialize, Eq, PartialEq, Hash)]
188pub enum LanguageModelToolResultContent {
189 Text(Arc<str>),
190 Image(LanguageModelImage),
191}
192
193impl<'de> Deserialize<'de> for LanguageModelToolResultContent {
194 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
195 where
196 D: serde::Deserializer<'de>,
197 {
198 use serde::de::Error;
199
200 let value = serde_json::Value::deserialize(deserializer)?;
201
202 // Models can provide these responses in several styles. Try each in order.
203
204 // 1. Try as plain string
205 if let Ok(text) = serde_json::from_value::<String>(value.clone()) {
206 return Ok(Self::Text(Arc::from(text)));
207 }
208
209 // 2. Try as object
210 if let Some(obj) = value.as_object() {
211 // get a JSON field case-insensitively
212 fn get_field<'a>(
213 obj: &'a serde_json::Map<String, serde_json::Value>,
214 field: &str,
215 ) -> Option<&'a serde_json::Value> {
216 obj.iter()
217 .find(|(k, _)| k.to_lowercase() == field.to_lowercase())
218 .map(|(_, v)| v)
219 }
220
221 // Accept wrapped text format: { "type": "text", "text": "..." }
222 if let (Some(type_value), Some(text_value)) =
223 (get_field(obj, "type"), get_field(obj, "text"))
224 && let Some(type_str) = type_value.as_str()
225 && type_str.to_lowercase() == "text"
226 && let Some(text) = text_value.as_str() {
227 return Ok(Self::Text(Arc::from(text)));
228 }
229
230 // Check for wrapped Text variant: { "text": "..." }
231 if let Some((_key, value)) = obj.iter().find(|(k, _)| k.to_lowercase() == "text")
232 && obj.len() == 1 {
233 // Only one field, and it's "text" (case-insensitive)
234 if let Some(text) = value.as_str() {
235 return Ok(Self::Text(Arc::from(text)));
236 }
237 }
238
239 // Check for wrapped Image variant: { "image": { "source": "...", "size": ... } }
240 if let Some((_key, value)) = obj.iter().find(|(k, _)| k.to_lowercase() == "image")
241 && obj.len() == 1 {
242 // Only one field, and it's "image" (case-insensitive)
243 // Try to parse the nested image object
244 if let Some(image_obj) = value.as_object()
245 && let Some(image) = LanguageModelImage::from_json(image_obj) {
246 return Ok(Self::Image(image));
247 }
248 }
249
250 // Try as direct Image (object with "source" and "size" fields)
251 if let Some(image) = LanguageModelImage::from_json(obj) {
252 return Ok(Self::Image(image));
253 }
254 }
255
256 // If none of the variants match, return an error with the problematic JSON
257 Err(D::Error::custom(format!(
258 "data did not match any variant of LanguageModelToolResultContent. Expected either a string, \
259 an object with 'type': 'text', a wrapped variant like {{\"Text\": \"...\"}}, or an image object. Got: {}",
260 serde_json::to_string_pretty(&value).unwrap_or_else(|_| value.to_string())
261 )))
262 }
263}
264
265impl LanguageModelToolResultContent {
266 pub fn to_str(&self) -> Option<&str> {
267 match self {
268 Self::Text(text) => Some(text),
269 Self::Image(_) => None,
270 }
271 }
272
273 pub fn is_empty(&self) -> bool {
274 match self {
275 Self::Text(text) => text.chars().all(|c| c.is_whitespace()),
276 Self::Image(_) => false,
277 }
278 }
279}
280
281impl From<&str> for LanguageModelToolResultContent {
282 fn from(value: &str) -> Self {
283 Self::Text(Arc::from(value))
284 }
285}
286
287impl From<String> for LanguageModelToolResultContent {
288 fn from(value: String) -> Self {
289 Self::Text(Arc::from(value))
290 }
291}
292
293impl From<LanguageModelImage> for LanguageModelToolResultContent {
294 fn from(image: LanguageModelImage) -> Self {
295 Self::Image(image)
296 }
297}
298
299#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq, Hash)]
300pub enum MessageContent {
301 Text(String),
302 Thinking {
303 text: String,
304 signature: Option<String>,
305 },
306 RedactedThinking(String),
307 Image(LanguageModelImage),
308 ToolUse(LanguageModelToolUse),
309 ToolResult(LanguageModelToolResult),
310}
311
312impl MessageContent {
313 pub fn to_str(&self) -> Option<&str> {
314 match self {
315 MessageContent::Text(text) => Some(text.as_str()),
316 MessageContent::Thinking { text, .. } => Some(text.as_str()),
317 MessageContent::RedactedThinking(_) => None,
318 MessageContent::ToolResult(tool_result) => tool_result.content.to_str(),
319 MessageContent::ToolUse(_) | MessageContent::Image(_) => None,
320 }
321 }
322
323 pub fn is_empty(&self) -> bool {
324 match self {
325 MessageContent::Text(text) => text.chars().all(|c| c.is_whitespace()),
326 MessageContent::Thinking { text, .. } => text.chars().all(|c| c.is_whitespace()),
327 MessageContent::ToolResult(tool_result) => tool_result.content.is_empty(),
328 MessageContent::RedactedThinking(_)
329 | MessageContent::ToolUse(_)
330 | MessageContent::Image(_) => false,
331 }
332 }
333}
334
335impl From<String> for MessageContent {
336 fn from(value: String) -> Self {
337 MessageContent::Text(value)
338 }
339}
340
341impl From<&str> for MessageContent {
342 fn from(value: &str) -> Self {
343 MessageContent::Text(value.to_string())
344 }
345}
346
347#[derive(Clone, Serialize, Deserialize, Debug, PartialEq, Hash)]
348pub struct LanguageModelRequestMessage {
349 pub role: Role,
350 pub content: Vec<MessageContent>,
351 pub cache: bool,
352}
353
354impl LanguageModelRequestMessage {
355 pub fn string_contents(&self) -> String {
356 let mut buffer = String::new();
357 for string in self.content.iter().filter_map(|content| content.to_str()) {
358 buffer.push_str(string);
359 }
360
361 buffer
362 }
363
364 pub fn contents_empty(&self) -> bool {
365 self.content.iter().all(|content| content.is_empty())
366 }
367}
368
369#[derive(Debug, PartialEq, Hash, Clone, Serialize, Deserialize)]
370pub struct LanguageModelRequestTool {
371 pub name: String,
372 pub description: String,
373 pub input_schema: serde_json::Value,
374}
375
376#[derive(Debug, PartialEq, Hash, Clone, Serialize, Deserialize)]
377pub enum LanguageModelToolChoice {
378 Auto,
379 Any,
380 None,
381}
382
383#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
384pub struct LanguageModelRequest {
385 pub thread_id: Option<String>,
386 pub prompt_id: Option<String>,
387 pub intent: Option<CompletionIntent>,
388 pub mode: Option<CompletionMode>,
389 pub messages: Vec<LanguageModelRequestMessage>,
390 pub tools: Vec<LanguageModelRequestTool>,
391 pub tool_choice: Option<LanguageModelToolChoice>,
392 pub stop: Vec<String>,
393 pub temperature: Option<f32>,
394 pub thinking_allowed: bool,
395}
396
397#[derive(Serialize, Deserialize, Debug, Eq, PartialEq)]
398pub struct LanguageModelResponseMessage {
399 pub role: Option<Role>,
400 pub content: Option<String>,
401}
402
403#[cfg(test)]
404mod tests {
405 use super::*;
406
407 #[test]
408 fn test_language_model_tool_result_content_deserialization() {
409 let json = r#""This is plain text""#;
410 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
411 assert_eq!(
412 result,
413 LanguageModelToolResultContent::Text("This is plain text".into())
414 );
415
416 let json = r#"{"type": "text", "text": "This is wrapped text"}"#;
417 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
418 assert_eq!(
419 result,
420 LanguageModelToolResultContent::Text("This is wrapped text".into())
421 );
422
423 let json = r#"{"Type": "TEXT", "TEXT": "Case insensitive"}"#;
424 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
425 assert_eq!(
426 result,
427 LanguageModelToolResultContent::Text("Case insensitive".into())
428 );
429
430 let json = r#"{"Text": "Wrapped variant"}"#;
431 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
432 assert_eq!(
433 result,
434 LanguageModelToolResultContent::Text("Wrapped variant".into())
435 );
436
437 let json = r#"{"text": "Lowercase wrapped"}"#;
438 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
439 assert_eq!(
440 result,
441 LanguageModelToolResultContent::Text("Lowercase wrapped".into())
442 );
443
444 // Test image deserialization
445 let json = r#"{
446 "source": "base64encodedimagedata",
447 "size": {
448 "width": 100,
449 "height": 200
450 }
451 }"#;
452 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
453 match result {
454 LanguageModelToolResultContent::Image(image) => {
455 assert_eq!(image.source.as_ref(), "base64encodedimagedata");
456 assert_eq!(image.size.width.0, 100);
457 assert_eq!(image.size.height.0, 200);
458 }
459 _ => panic!("Expected Image variant"),
460 }
461
462 // Test wrapped Image variant
463 let json = r#"{
464 "Image": {
465 "source": "wrappedimagedata",
466 "size": {
467 "width": 50,
468 "height": 75
469 }
470 }
471 }"#;
472 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
473 match result {
474 LanguageModelToolResultContent::Image(image) => {
475 assert_eq!(image.source.as_ref(), "wrappedimagedata");
476 assert_eq!(image.size.width.0, 50);
477 assert_eq!(image.size.height.0, 75);
478 }
479 _ => panic!("Expected Image variant"),
480 }
481
482 // Test wrapped Image variant with case insensitive
483 let json = r#"{
484 "image": {
485 "Source": "caseinsensitive",
486 "SIZE": {
487 "width": 30,
488 "height": 40
489 }
490 }
491 }"#;
492 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
493 match result {
494 LanguageModelToolResultContent::Image(image) => {
495 assert_eq!(image.source.as_ref(), "caseinsensitive");
496 assert_eq!(image.size.width.0, 30);
497 assert_eq!(image.size.height.0, 40);
498 }
499 _ => panic!("Expected Image variant"),
500 }
501
502 // Test that wrapped text with wrong type fails
503 let json = r#"{"type": "blahblah", "text": "This should fail"}"#;
504 let result: Result<LanguageModelToolResultContent, _> = serde_json::from_str(json);
505 assert!(result.is_err());
506
507 // Test that malformed JSON fails
508 let json = r#"{"invalid": "structure"}"#;
509 let result: Result<LanguageModelToolResultContent, _> = serde_json::from_str(json);
510 assert!(result.is_err());
511
512 // Test edge cases
513 let json = r#""""#; // Empty string
514 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
515 assert_eq!(result, LanguageModelToolResultContent::Text("".into()));
516
517 // Test with extra fields in wrapped text (should be ignored)
518 let json = r#"{"type": "text", "text": "Hello", "extra": "field"}"#;
519 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
520 assert_eq!(result, LanguageModelToolResultContent::Text("Hello".into()));
521
522 // Test direct image with case-insensitive fields
523 let json = r#"{
524 "SOURCE": "directimage",
525 "Size": {
526 "width": 200,
527 "height": 300
528 }
529 }"#;
530 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
531 match result {
532 LanguageModelToolResultContent::Image(image) => {
533 assert_eq!(image.source.as_ref(), "directimage");
534 assert_eq!(image.size.width.0, 200);
535 assert_eq!(image.size.height.0, 300);
536 }
537 _ => panic!("Expected Image variant"),
538 }
539
540 // Test that multiple fields prevent wrapped variant interpretation
541 let json = r#"{"Text": "not wrapped", "extra": "field"}"#;
542 let result: Result<LanguageModelToolResultContent, _> = serde_json::from_str(json);
543 assert!(result.is_err());
544
545 // Test wrapped text with uppercase TEXT variant
546 let json = r#"{"TEXT": "Uppercase variant"}"#;
547 let result: LanguageModelToolResultContent = serde_json::from_str(json).unwrap();
548 assert_eq!(
549 result,
550 LanguageModelToolResultContent::Text("Uppercase variant".into())
551 );
552
553 // Test that numbers and other JSON values fail gracefully
554 let json = r#"123"#;
555 let result: Result<LanguageModelToolResultContent, _> = serde_json::from_str(json);
556 assert!(result.is_err());
557
558 let json = r#"null"#;
559 let result: Result<LanguageModelToolResultContent, _> = serde_json::from_str(json);
560 assert!(result.is_err());
561
562 let json = r#"[1, 2, 3]"#;
563 let result: Result<LanguageModelToolResultContent, _> = serde_json::from_str(json);
564 assert!(result.is_err());
565 }
566}