rig/providers/
moonshot.rs

1//! Moonshot API client and Rig integration
2//!
3//! # Example
4//! ```
5//! use rig::providers::moonshot;
6//!
7//! let client = moonshot::Client::new("YOUR_API_KEY");
8//!
9//! let moonshot_model = client.completion_model(moonshot::MOONSHOT_CHAT);
10//! ```
11
12use crate::client::{CompletionClient, ProviderClient};
13use crate::json_utils::merge;
14use crate::providers::openai::send_compatible_streaming_request;
15use crate::streaming::StreamingCompletionResponse;
16use crate::{
17    completion::{self, CompletionError, CompletionRequest},
18    json_utils,
19    providers::openai,
20};
21use crate::{impl_conversion_traits, message};
22use serde::Deserialize;
23use serde_json::{json, Value};
24
25// ================================================================
26// Main Moonshot Client
27// ================================================================
28const MOONSHOT_API_BASE_URL: &str = "https://api.moonshot.cn/v1";
29
30#[derive(Clone, Debug)]
31pub struct Client {
32    base_url: String,
33    http_client: reqwest::Client,
34}
35
36impl Client {
37    /// Create a new Moonshot client with the given API key.
38    pub fn new(api_key: &str) -> Self {
39        Self::from_url(api_key, MOONSHOT_API_BASE_URL)
40    }
41
42    /// Create a new Moonshot client with the given API key and base API URL.
43    pub fn from_url(api_key: &str, base_url: &str) -> Self {
44        Self {
45            base_url: base_url.to_string(),
46            http_client: reqwest::Client::builder()
47                .default_headers({
48                    let mut headers = reqwest::header::HeaderMap::new();
49                    headers.insert(
50                        "Authorization",
51                        format!("Bearer {api_key}")
52                            .parse()
53                            .expect("Bearer token should parse"),
54                    );
55                    headers
56                })
57                .build()
58                .expect("Moonshot reqwest client should build"),
59        }
60    }
61
62    fn post(&self, path: &str) -> reqwest::RequestBuilder {
63        let url = format!("{}/{}", self.base_url, path).replace("//", "/");
64        self.http_client.post(url)
65    }
66}
67
68impl ProviderClient for Client {
69    /// Create a new Moonshot client from the `MOONSHOT_API_KEY` environment variable.
70    /// Panics if the environment variable is not set.
71    fn from_env() -> Self {
72        let api_key = std::env::var("MOONSHOT_API_KEY").expect("MOONSHOT_API_KEY not set");
73        Self::new(&api_key)
74    }
75}
76
77impl CompletionClient for Client {
78    type CompletionModel = CompletionModel;
79
80    /// Create a completion model with the given name.
81    ///
82    /// # Example
83    /// ```
84    /// use rig::providers::moonshot::{Client, self};
85    ///
86    /// // Initialize the Moonshot client
87    /// let moonshot = Client::new("your-moonshot-api-key");
88    ///
89    /// let completion_model = moonshot.completion_model(moonshot::MOONSHOT_CHAT);
90    /// ```
91    fn completion_model(&self, model: &str) -> CompletionModel {
92        CompletionModel::new(self.clone(), model)
93    }
94}
95
96impl_conversion_traits!(
97    AsEmbeddings,
98    AsTranscription,
99    AsImageGeneration,
100    AsAudioGeneration for Client
101);
102
103#[derive(Debug, Deserialize)]
104struct ApiErrorResponse {
105    error: MoonshotError,
106}
107
108#[derive(Debug, Deserialize)]
109struct MoonshotError {
110    message: String,
111}
112
113#[derive(Debug, Deserialize)]
114#[serde(untagged)]
115enum ApiResponse<T> {
116    Ok(T),
117    Err(ApiErrorResponse),
118}
119
120// ================================================================
121// Moonshot Completion API
122// ================================================================
123pub const MOONSHOT_CHAT: &str = "moonshot-v1-128k";
124
125#[derive(Clone)]
126pub struct CompletionModel {
127    client: Client,
128    pub model: String,
129}
130
131impl CompletionModel {
132    pub fn new(client: Client, model: &str) -> Self {
133        Self {
134            client,
135            model: model.to_string(),
136        }
137    }
138
139    fn create_completion_request(
140        &self,
141        completion_request: CompletionRequest,
142    ) -> Result<Value, CompletionError> {
143        // Build up the order of messages (context, chat_history)
144        let mut partial_history = vec![];
145        if let Some(docs) = completion_request.normalized_documents() {
146            partial_history.push(docs);
147        }
148        partial_history.extend(completion_request.chat_history);
149
150        // Initialize full history with preamble (or empty if non-existent)
151        let mut full_history: Vec<openai::Message> = completion_request
152            .preamble
153            .map_or_else(Vec::new, |preamble| {
154                vec![openai::Message::system(&preamble)]
155            });
156
157        // Convert and extend the rest of the history
158        full_history.extend(
159            partial_history
160                .into_iter()
161                .map(message::Message::try_into)
162                .collect::<Result<Vec<Vec<openai::Message>>, _>>()?
163                .into_iter()
164                .flatten()
165                .collect::<Vec<_>>(),
166        );
167
168        let request = if completion_request.tools.is_empty() {
169            json!({
170                "model": self.model,
171                "messages": full_history,
172                "temperature": completion_request.temperature,
173            })
174        } else {
175            json!({
176                "model": self.model,
177                "messages": full_history,
178                "temperature": completion_request.temperature,
179                "tools": completion_request.tools.into_iter().map(openai::ToolDefinition::from).collect::<Vec<_>>(),
180                "tool_choice": "auto",
181            })
182        };
183
184        let request = if let Some(params) = completion_request.additional_params {
185            json_utils::merge(request, params)
186        } else {
187            request
188        };
189
190        Ok(request)
191    }
192}
193
194impl completion::CompletionModel for CompletionModel {
195    type Response = openai::CompletionResponse;
196    type StreamingResponse = openai::StreamingCompletionResponse;
197
198    #[cfg_attr(feature = "worker", worker::send)]
199    async fn completion(
200        &self,
201        completion_request: CompletionRequest,
202    ) -> Result<completion::CompletionResponse<openai::CompletionResponse>, CompletionError> {
203        let request = self.create_completion_request(completion_request)?;
204
205        let response = self
206            .client
207            .post("/chat/completions")
208            .json(&request)
209            .send()
210            .await?;
211
212        if response.status().is_success() {
213            let t = response.text().await?;
214            tracing::debug!(target: "rig", "MoonShot completion error: {}", t);
215
216            match serde_json::from_str::<ApiResponse<openai::CompletionResponse>>(&t)? {
217                ApiResponse::Ok(response) => {
218                    tracing::info!(target: "rig",
219                        "MoonShot completion token usage: {:?}",
220                        response.usage.clone().map(|usage| format!("{usage}")).unwrap_or("N/A".to_string())
221                    );
222                    response.try_into()
223                }
224                ApiResponse::Err(err) => Err(CompletionError::ProviderError(err.error.message)),
225            }
226        } else {
227            Err(CompletionError::ProviderError(response.text().await?))
228        }
229    }
230
231    #[cfg_attr(feature = "worker", worker::send)]
232    async fn stream(
233        &self,
234        request: CompletionRequest,
235    ) -> Result<StreamingCompletionResponse<Self::StreamingResponse>, CompletionError> {
236        let mut request = self.create_completion_request(request)?;
237
238        request = merge(
239            request,
240            json!({"stream": true, "stream_options": {"include_usage": true}}),
241        );
242
243        let builder = self.client.post("/chat/completions").json(&request);
244
245        send_compatible_streaming_request(builder).await
246    }
247}