1use crate::{
2 OneOrMany,
3 completion::{self, CompletionError, GetTokenUsage},
4 http_client::{self, HttpClientExt},
5 json_utils,
6 message::{self, Reasoning, ToolChoice},
7 telemetry::SpanCombinator,
8};
9use std::collections::HashMap;
10
11use super::client::Client;
12use crate::completion::CompletionRequest;
13use crate::providers::cohere::streaming::StreamingCompletionResponse;
14use serde::{Deserialize, Serialize};
15use tracing::{Instrument, Level, enabled, info_span};
16
17#[derive(Debug, Deserialize, Serialize)]
18pub struct CompletionResponse {
19 pub id: String,
20 pub finish_reason: FinishReason,
21 message: Message,
22 #[serde(default)]
23 pub usage: Option<Usage>,
24}
25
26impl CompletionResponse {
27 pub fn message(&self) -> (Vec<AssistantContent>, Vec<Citation>, Vec<ToolCall>) {
29 let Message::Assistant {
30 content,
31 citations,
32 tool_calls,
33 ..
34 } = self.message.clone()
35 else {
36 unreachable!("Completion responses will only return an assistant message")
37 };
38
39 (content, citations, tool_calls)
40 }
41}
42
43impl crate::telemetry::ProviderResponseExt for CompletionResponse {
44 type OutputMessage = Message;
45 type Usage = Usage;
46
47 fn get_response_id(&self) -> Option<String> {
48 Some(self.id.clone())
49 }
50
51 fn get_response_model_name(&self) -> Option<String> {
52 None
53 }
54
55 fn get_output_messages(&self) -> Vec<Self::OutputMessage> {
56 vec![self.message.clone()]
57 }
58
59 fn get_text_response(&self) -> Option<String> {
60 let Message::Assistant { ref content, .. } = self.message else {
61 return None;
62 };
63
64 let res = content
65 .iter()
66 .filter_map(|x| {
67 if let AssistantContent::Text { text } = x {
68 Some(text.to_string())
69 } else {
70 None
71 }
72 })
73 .collect::<Vec<String>>()
74 .join("\n");
75
76 if res.is_empty() { None } else { Some(res) }
77 }
78
79 fn get_usage(&self) -> Option<Self::Usage> {
80 self.usage.clone()
81 }
82}
83
84#[derive(Debug, Deserialize, PartialEq, Eq, Clone, Serialize)]
85#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
86pub enum FinishReason {
87 MaxTokens,
88 StopSequence,
89 Complete,
90 Error,
91 ToolCall,
92}
93
94#[derive(Debug, Deserialize, Clone, Serialize)]
95pub struct Usage {
96 #[serde(default)]
97 pub billed_units: Option<BilledUnits>,
98 #[serde(default)]
99 pub tokens: Option<Tokens>,
100}
101
102impl GetTokenUsage for Usage {
103 fn token_usage(&self) -> Option<crate::completion::Usage> {
104 let mut usage = crate::completion::Usage::new();
105
106 if let Some(ref billed_units) = self.billed_units {
107 usage.input_tokens = billed_units.input_tokens.unwrap_or_default() as u64;
108 usage.output_tokens = billed_units.output_tokens.unwrap_or_default() as u64;
109 usage.total_tokens = usage.input_tokens + usage.output_tokens;
110 }
111
112 Some(usage)
113 }
114}
115
116#[derive(Debug, Deserialize, Clone, Serialize)]
117pub struct BilledUnits {
118 #[serde(default)]
119 pub output_tokens: Option<f64>,
120 #[serde(default)]
121 pub classifications: Option<f64>,
122 #[serde(default)]
123 pub search_units: Option<f64>,
124 #[serde(default)]
125 pub input_tokens: Option<f64>,
126}
127
128#[derive(Debug, Deserialize, Clone, Serialize)]
129pub struct Tokens {
130 #[serde(default)]
131 pub input_tokens: Option<f64>,
132 #[serde(default)]
133 pub output_tokens: Option<f64>,
134}
135
136impl TryFrom<CompletionResponse> for completion::CompletionResponse<CompletionResponse> {
137 type Error = CompletionError;
138
139 fn try_from(response: CompletionResponse) -> Result<Self, Self::Error> {
140 let (content, _, tool_calls) = response.message();
141
142 let model_response = if !tool_calls.is_empty() {
143 OneOrMany::many(
144 tool_calls
145 .into_iter()
146 .filter_map(|tool_call| {
147 let ToolCallFunction { name, arguments } = tool_call.function?;
148 let id = tool_call.id.unwrap_or_else(|| name.clone());
149
150 Some(completion::AssistantContent::tool_call(id, name, arguments))
151 })
152 .collect::<Vec<_>>(),
153 )
154 .expect("We have atleast 1 tool call in this if block")
155 } else {
156 OneOrMany::many(content.into_iter().map(|content| match content {
157 AssistantContent::Text { text } => completion::AssistantContent::text(text),
158 AssistantContent::Thinking { thinking } => {
159 completion::AssistantContent::Reasoning(Reasoning {
160 id: None,
161 reasoning: vec![thinking],
162 signature: None,
163 })
164 }
165 }))
166 .map_err(|_| {
167 CompletionError::ResponseError(
168 "Response contained no message or tool call (empty)".to_owned(),
169 )
170 })?
171 };
172
173 let usage = response
174 .usage
175 .as_ref()
176 .and_then(|usage| usage.tokens.as_ref())
177 .map(|tokens| {
178 let input_tokens = tokens.input_tokens.unwrap_or(0.0);
179 let output_tokens = tokens.output_tokens.unwrap_or(0.0);
180
181 completion::Usage {
182 input_tokens: input_tokens as u64,
183 output_tokens: output_tokens as u64,
184 total_tokens: (input_tokens + output_tokens) as u64,
185 cached_input_tokens: 0,
186 }
187 })
188 .unwrap_or_default();
189
190 Ok(completion::CompletionResponse {
191 choice: OneOrMany::many(model_response).expect("There is atleast one content"),
192 usage,
193 raw_response: response,
194 })
195 }
196}
197
198#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
199pub struct Document {
200 pub id: String,
201 pub data: HashMap<String, serde_json::Value>,
202}
203
204impl From<completion::Document> for Document {
205 fn from(document: completion::Document) -> Self {
206 let mut data: HashMap<String, serde_json::Value> = HashMap::new();
207
208 document
211 .additional_props
212 .into_iter()
213 .for_each(|(key, value)| {
214 data.insert(key, value.into());
215 });
216
217 data.insert("text".to_string(), document.text.into());
218
219 Self {
220 id: document.id,
221 data,
222 }
223 }
224}
225
226#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
227pub struct ToolCall {
228 #[serde(default)]
229 pub id: Option<String>,
230 #[serde(default)]
231 pub r#type: Option<ToolType>,
232 #[serde(default)]
233 pub function: Option<ToolCallFunction>,
234}
235
236#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
237pub struct ToolCallFunction {
238 pub name: String,
239 #[serde(with = "json_utils::stringified_json")]
240 pub arguments: serde_json::Value,
241}
242
243#[derive(Clone, Default, Debug, Deserialize, Serialize, PartialEq, Eq)]
244#[serde(rename_all = "lowercase")]
245pub enum ToolType {
246 #[default]
247 Function,
248}
249
250#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
251pub struct Tool {
252 pub r#type: ToolType,
253 pub function: Function,
254}
255
256#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
257pub struct Function {
258 pub name: String,
259 #[serde(default)]
260 pub description: Option<String>,
261 pub parameters: serde_json::Value,
262}
263
264impl From<completion::ToolDefinition> for Tool {
265 fn from(tool: completion::ToolDefinition) -> Self {
266 Self {
267 r#type: ToolType::default(),
268 function: Function {
269 name: tool.name,
270 description: Some(tool.description),
271 parameters: tool.parameters,
272 },
273 }
274 }
275}
276
277#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
278#[serde(tag = "role", rename_all = "lowercase")]
279pub enum Message {
280 User {
281 content: OneOrMany<UserContent>,
282 },
283
284 Assistant {
285 #[serde(default)]
286 content: Vec<AssistantContent>,
287 #[serde(default)]
288 citations: Vec<Citation>,
289 #[serde(default)]
290 tool_calls: Vec<ToolCall>,
291 #[serde(default)]
292 tool_plan: Option<String>,
293 },
294
295 Tool {
296 content: OneOrMany<ToolResultContent>,
297 tool_call_id: String,
298 },
299
300 System {
301 content: String,
302 },
303}
304
305#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
306#[serde(tag = "type", rename_all = "lowercase")]
307pub enum UserContent {
308 Text { text: String },
309 ImageUrl { image_url: ImageUrl },
310}
311
312#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
313#[serde(tag = "type", rename_all = "lowercase")]
314pub enum AssistantContent {
315 Text { text: String },
316 Thinking { thinking: String },
317}
318
319#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
320pub struct ImageUrl {
321 pub url: String,
322}
323
324#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
325pub enum ToolResultContent {
326 Text { text: String },
327 Document { document: Document },
328}
329
330#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
331pub struct Citation {
332 #[serde(default)]
333 pub start: Option<u32>,
334 #[serde(default)]
335 pub end: Option<u32>,
336 #[serde(default)]
337 pub text: Option<String>,
338 #[serde(rename = "type")]
339 pub citation_type: Option<CitationType>,
340 #[serde(default)]
341 pub sources: Vec<Source>,
342}
343
344#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
345#[serde(tag = "type", rename_all = "lowercase")]
346pub enum Source {
347 Document {
348 id: Option<String>,
349 document: Option<serde_json::Map<String, serde_json::Value>>,
350 },
351 Tool {
352 id: Option<String>,
353 tool_output: Option<serde_json::Map<String, serde_json::Value>>,
354 },
355}
356
357#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
358#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
359pub enum CitationType {
360 TextContent,
361 Plan,
362}
363
364impl TryFrom<message::Message> for Vec<Message> {
365 type Error = message::MessageError;
366
367 fn try_from(message: message::Message) -> Result<Self, Self::Error> {
368 Ok(match message {
369 message::Message::User { content } => content
370 .into_iter()
371 .map(|content| match content {
372 message::UserContent::Text(message::Text { text }) => Ok(Message::User {
373 content: OneOrMany::one(UserContent::Text { text }),
374 }),
375 message::UserContent::ToolResult(message::ToolResult {
376 id, content, ..
377 }) => Ok(Message::Tool {
378 tool_call_id: id,
379 content: content.try_map(|content| match content {
380 message::ToolResultContent::Text(text) => {
381 Ok(ToolResultContent::Text { text: text.text })
382 }
383 _ => Err(message::MessageError::ConversionError(
384 "Only text tool result content is supported by Cohere".to_owned(),
385 )),
386 })?,
387 }),
388 _ => Err(message::MessageError::ConversionError(
389 "Only text content is supported by Cohere".to_owned(),
390 )),
391 })
392 .collect::<Result<Vec<_>, _>>()?,
393 message::Message::Assistant { content, .. } => {
394 let mut text_content = vec![];
395 let mut tool_calls = vec![];
396
397 for content in content.into_iter() {
398 match content {
399 message::AssistantContent::Text(message::Text { text }) => {
400 text_content.push(AssistantContent::Text { text });
401 }
402 message::AssistantContent::ToolCall(message::ToolCall {
403 id,
404 function:
405 message::ToolFunction {
406 name, arguments, ..
407 },
408 ..
409 }) => {
410 tool_calls.push(ToolCall {
411 id: Some(id),
412 r#type: Some(ToolType::Function),
413 function: Some(ToolCallFunction {
414 name,
415 arguments: serde_json::to_value(arguments).unwrap_or_default(),
416 }),
417 });
418 }
419 message::AssistantContent::Reasoning(Reasoning { reasoning, .. }) => {
420 let thinking = reasoning.join("\n");
421 text_content.push(AssistantContent::Thinking { thinking });
422 }
423 message::AssistantContent::Image(_) => {
424 return Err(message::MessageError::ConversionError(
425 "Cohere currently doesn't support images.".to_owned(),
426 ));
427 }
428 }
429 }
430
431 vec![Message::Assistant {
432 content: text_content,
433 citations: vec![],
434 tool_calls,
435 tool_plan: None,
436 }]
437 }
438 })
439 }
440}
441
442impl TryFrom<Message> for message::Message {
443 type Error = message::MessageError;
444
445 fn try_from(message: Message) -> Result<Self, Self::Error> {
446 match message {
447 Message::User { content } => Ok(message::Message::User {
448 content: content.map(|content| match content {
449 UserContent::Text { text } => {
450 message::UserContent::Text(message::Text { text })
451 }
452 UserContent::ImageUrl { image_url } => {
453 message::UserContent::image_url(image_url.url, None, None)
454 }
455 }),
456 }),
457 Message::Assistant {
458 content,
459 tool_calls,
460 ..
461 } => {
462 let mut content = content
463 .into_iter()
464 .map(|content| match content {
465 AssistantContent::Text { text } => message::AssistantContent::text(text),
466 AssistantContent::Thinking { thinking } => {
467 message::AssistantContent::Reasoning(Reasoning {
468 id: None,
469 reasoning: vec![thinking],
470 signature: None,
471 })
472 }
473 })
474 .collect::<Vec<_>>();
475
476 content.extend(tool_calls.into_iter().filter_map(|tool_call| {
477 let ToolCallFunction { name, arguments } = tool_call.function?;
478
479 Some(message::AssistantContent::tool_call(
480 tool_call.id.unwrap_or_else(|| name.clone()),
481 name,
482 arguments,
483 ))
484 }));
485
486 let content = OneOrMany::many(content).map_err(|_| {
487 message::MessageError::ConversionError(
488 "Expected either text content or tool calls".to_string(),
489 )
490 })?;
491
492 Ok(message::Message::Assistant { id: None, content })
493 }
494 Message::Tool {
495 content,
496 tool_call_id,
497 } => {
498 let content = content.try_map(|content| {
499 Ok(match content {
500 ToolResultContent::Text { text } => message::ToolResultContent::text(text),
501 ToolResultContent::Document { document } => {
502 message::ToolResultContent::text(
503 serde_json::to_string(&document.data).map_err(|e| {
504 message::MessageError::ConversionError(
505 format!("Failed to convert tool result document content into text: {e}"),
506 )
507 })?,
508 )
509 }
510 })
511 })?;
512
513 Ok(message::Message::User {
514 content: OneOrMany::one(message::UserContent::tool_result(
515 tool_call_id,
516 content,
517 )),
518 })
519 }
520 Message::System { content } => Ok(message::Message::user(content)),
521 }
522 }
523}
524
525#[derive(Clone)]
526pub struct CompletionModel<T = reqwest::Client> {
527 pub(crate) client: Client<T>,
528 pub model: String,
529}
530
531#[derive(Debug, Serialize, Deserialize)]
532pub(super) struct CohereCompletionRequest {
533 model: String,
534 pub messages: Vec<Message>,
535 documents: Vec<crate::completion::Document>,
536 #[serde(skip_serializing_if = "Option::is_none")]
537 temperature: Option<f64>,
538 #[serde(skip_serializing_if = "Vec::is_empty")]
539 tools: Vec<Tool>,
540 #[serde(skip_serializing_if = "Option::is_none")]
541 tool_choice: Option<ToolChoice>,
542 #[serde(flatten, skip_serializing_if = "Option::is_none")]
543 pub additional_params: Option<serde_json::Value>,
544}
545
546impl TryFrom<(&str, CompletionRequest)> for CohereCompletionRequest {
547 type Error = CompletionError;
548
549 fn try_from((model, req): (&str, CompletionRequest)) -> Result<Self, Self::Error> {
550 let mut partial_history = vec![];
551 if let Some(docs) = req.normalized_documents() {
552 partial_history.push(docs);
553 }
554 partial_history.extend(req.chat_history);
555
556 let mut full_history: Vec<Message> = req.preamble.map_or_else(Vec::new, |preamble| {
557 vec![Message::System { content: preamble }]
558 });
559
560 full_history.extend(
561 partial_history
562 .into_iter()
563 .map(message::Message::try_into)
564 .collect::<Result<Vec<Vec<Message>>, _>>()?
565 .into_iter()
566 .flatten()
567 .collect::<Vec<_>>(),
568 );
569
570 let tool_choice = if let Some(tool_choice) = req.tool_choice {
571 if !matches!(tool_choice, ToolChoice::Auto) {
572 Some(tool_choice)
573 } else {
574 return Err(CompletionError::RequestError(
575 "\"auto\" is not an allowed tool_choice value in the Cohere API".into(),
576 ));
577 }
578 } else {
579 None
580 };
581
582 Ok(Self {
583 model: model.to_string(),
584 messages: full_history,
585 documents: req.documents,
586 temperature: req.temperature,
587 tools: req.tools.into_iter().map(Tool::from).collect::<Vec<_>>(),
588 tool_choice,
589 additional_params: req.additional_params,
590 })
591 }
592}
593
594impl<T> CompletionModel<T>
595where
596 T: HttpClientExt,
597{
598 pub fn new(client: Client<T>, model: impl Into<String>) -> Self {
599 Self {
600 client,
601 model: model.into(),
602 }
603 }
604}
605
606impl<T> completion::CompletionModel for CompletionModel<T>
607where
608 T: HttpClientExt + Clone + 'static,
609{
610 type Response = CompletionResponse;
611 type StreamingResponse = StreamingCompletionResponse;
612 type Client = Client<T>;
613
614 fn make(client: &Self::Client, model: impl Into<String>) -> Self {
615 Self::new(client.clone(), model.into())
616 }
617
618 async fn completion(
619 &self,
620 completion_request: completion::CompletionRequest,
621 ) -> Result<completion::CompletionResponse<CompletionResponse>, CompletionError> {
622 let request = CohereCompletionRequest::try_from((self.model.as_ref(), completion_request))?;
623
624 let llm_span = if tracing::Span::current().is_disabled() {
625 info_span!(
626 target: "rig::completions",
627 "chat",
628 gen_ai.operation.name = "chat",
629 gen_ai.provider.name = "cohere",
630 gen_ai.request.model = self.model,
631 gen_ai.response.id = tracing::field::Empty,
632 gen_ai.response.model = self.model,
633 gen_ai.usage.output_tokens = tracing::field::Empty,
634 gen_ai.usage.input_tokens = tracing::field::Empty,
635 )
636 } else {
637 tracing::Span::current()
638 };
639
640 if enabled!(Level::TRACE) {
641 tracing::trace!(
642 "Cohere completion request: {}",
643 serde_json::to_string_pretty(&request)?
644 );
645 }
646
647 let req_body = serde_json::to_vec(&request)?;
648
649 let req = self.client.post("/v2/chat")?.body(req_body).unwrap();
650
651 async {
652 let response = self
653 .client
654 .send::<_, bytes::Bytes>(req)
655 .await
656 .map_err(|e| http_client::Error::Instance(e.into()))?;
657
658 let status = response.status();
659 let body = response.into_body().into_future().await?.to_owned();
660
661 if status.is_success() {
662 let json_response: CompletionResponse = serde_json::from_slice(&body)?;
663 let span = tracing::Span::current();
664 span.record_token_usage(&json_response.usage);
665 span.record_response_metadata(&json_response);
666
667 if enabled!(Level::TRACE) {
668 tracing::trace!(
669 target: "rig::completions",
670 "Cohere completion response: {}",
671 serde_json::to_string_pretty(&json_response)?
672 );
673 }
674
675 let completion: completion::CompletionResponse<CompletionResponse> =
676 json_response.try_into()?;
677 Ok(completion)
678 } else {
679 Err(CompletionError::ProviderError(
680 String::from_utf8_lossy(&body).to_string(),
681 ))
682 }
683 }
684 .instrument(llm_span)
685 .await
686 }
687
688 async fn stream(
689 &self,
690 request: CompletionRequest,
691 ) -> Result<
692 crate::streaming::StreamingCompletionResponse<Self::StreamingResponse>,
693 CompletionError,
694 > {
695 CompletionModel::stream(self, request).await
696 }
697}
698#[cfg(test)]
699mod tests {
700 use super::*;
701 use serde_path_to_error::deserialize;
702
703 #[test]
704 fn test_deserialize_completion_response() {
705 let json_data = r#"
706 {
707 "id": "abc123",
708 "message": {
709 "role": "assistant",
710 "tool_plan": "I will use the subtract tool to find the difference between 2 and 5.",
711 "tool_calls": [
712 {
713 "id": "subtract_sm6ps6fb6y9f",
714 "type": "function",
715 "function": {
716 "name": "subtract",
717 "arguments": "{\"x\":5,\"y\":2}"
718 }
719 }
720 ]
721 },
722 "finish_reason": "TOOL_CALL",
723 "usage": {
724 "billed_units": {
725 "input_tokens": 78,
726 "output_tokens": 27
727 },
728 "tokens": {
729 "input_tokens": 1028,
730 "output_tokens": 63
731 }
732 }
733 }
734 "#;
735
736 let mut deserializer = serde_json::Deserializer::from_str(json_data);
737 let result: Result<CompletionResponse, _> = deserialize(&mut deserializer);
738
739 let response = result.unwrap();
740 let (_, citations, tool_calls) = response.message();
741 let CompletionResponse {
742 id,
743 finish_reason,
744 usage,
745 ..
746 } = response;
747
748 assert_eq!(id, "abc123");
749 assert_eq!(finish_reason, FinishReason::ToolCall);
750
751 let Usage {
752 billed_units,
753 tokens,
754 } = usage.unwrap();
755 let BilledUnits {
756 input_tokens: billed_input_tokens,
757 output_tokens: billed_output_tokens,
758 ..
759 } = billed_units.unwrap();
760 let Tokens {
761 input_tokens,
762 output_tokens,
763 } = tokens.unwrap();
764
765 assert_eq!(billed_input_tokens.unwrap(), 78.0);
766 assert_eq!(billed_output_tokens.unwrap(), 27.0);
767 assert_eq!(input_tokens.unwrap(), 1028.0);
768 assert_eq!(output_tokens.unwrap(), 63.0);
769
770 assert!(citations.is_empty());
771 assert_eq!(tool_calls.len(), 1);
772
773 let ToolCallFunction { name, arguments } = tool_calls[0].function.clone().unwrap();
774
775 assert_eq!(name, "subtract");
776 assert_eq!(arguments, serde_json::json!({"x": 5, "y": 2}));
777 }
778
779 #[test]
780 fn test_convert_completion_message_to_message_and_back() {
781 let completion_message = completion::Message::User {
782 content: OneOrMany::one(completion::message::UserContent::Text(
783 completion::message::Text {
784 text: "Hello, world!".to_string(),
785 },
786 )),
787 };
788
789 let messages: Vec<Message> = completion_message.clone().try_into().unwrap();
790 let _converted_back: Vec<completion::Message> = messages
791 .into_iter()
792 .map(|msg| msg.try_into().unwrap())
793 .collect::<Vec<_>>();
794 }
795
796 #[test]
797 fn test_convert_message_to_completion_message_and_back() {
798 let message = Message::User {
799 content: OneOrMany::one(UserContent::Text {
800 text: "Hello, world!".to_string(),
801 }),
802 };
803
804 let completion_message: completion::Message = message.clone().try_into().unwrap();
805 let _converted_back: Vec<Message> = completion_message.try_into().unwrap();
806 }
807}