rust-genai 0.3.1

Rust SDK for the Google Gemini API and Vertex AI
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
//! Live Music API surface.

use std::sync::Arc;

use futures_util::{SinkExt, StreamExt};
use reqwest::Url;
use tokio::sync::{mpsc, oneshot};
use tokio_tungstenite::connect_async;
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::http::{HeaderMap, HeaderValue};
use tokio_tungstenite::tungstenite::Message;

use rust_genai_types::live_music_types::{
    LiveMusicClientContent, LiveMusicClientMessage, LiveMusicClientSetup,
    LiveMusicGenerationConfig, LiveMusicPlaybackControl, LiveMusicServerMessage, WeightedPrompt,
};

use crate::client::{Backend, ClientInner};
use crate::error::{Error, Result};

#[derive(Clone)]
pub struct LiveMusic {
    pub(crate) inner: Arc<ClientInner>,
}

impl LiveMusic {
    pub(crate) const fn new(inner: Arc<ClientInner>) -> Self {
        Self { inner }
    }

    /// 连接到 Live Music API。
    ///
    /// # Errors
    /// 当连接失败或配置无效时返回错误。
    pub async fn connect(&self, model: impl Into<String>) -> Result<LiveMusicSession> {
        connect_live_music_session(self.inner.clone(), model.into()).await
    }
}

pub struct LiveMusicSession {
    outgoing_tx: mpsc::UnboundedSender<LiveMusicClientMessage>,
    incoming_rx: mpsc::UnboundedReceiver<Result<LiveMusicServerMessage>>,
    shutdown_tx: Option<oneshot::Sender<()>>,
}

impl LiveMusicSession {
    /// 设置加权提示词。
    ///
    /// # Errors
    /// 当配置无效或发送失败时返回错误。
    pub async fn set_weighted_prompts(&self, prompts: Vec<WeightedPrompt>) -> Result<()> {
        if prompts.is_empty() {
            return Err(Error::InvalidConfig {
                message: "weighted_prompts must contain at least one entry".into(),
            });
        }
        let message = LiveMusicClientMessage {
            setup: None,
            client_content: Some(LiveMusicClientContent {
                weighted_prompts: Some(prompts),
            }),
            music_generation_config: None,
            playback_control: None,
        };
        self.send_async(message).await
    }

    /// 设置音乐生成配置。
    ///
    /// # Errors
    /// 当发送失败时返回错误。
    pub async fn set_music_generation_config(
        &self,
        config: Option<LiveMusicGenerationConfig>,
    ) -> Result<()> {
        let message = LiveMusicClientMessage {
            setup: None,
            client_content: None,
            music_generation_config: Some(config.unwrap_or_default()),
            playback_control: None,
        };
        self.send_async(message).await
    }

    /// 播放。
    ///
    /// # Errors
    /// 当发送失败时返回错误。
    pub async fn play(&self) -> Result<()> {
        self.send_playback(LiveMusicPlaybackControl::Play).await
    }

    /// 暂停。
    ///
    /// # Errors
    /// 当发送失败时返回错误。
    pub async fn pause(&self) -> Result<()> {
        self.send_playback(LiveMusicPlaybackControl::Pause).await
    }

    /// 停止。
    ///
    /// # Errors
    /// 当发送失败时返回错误。
    pub async fn stop(&self) -> Result<()> {
        self.send_playback(LiveMusicPlaybackControl::Stop).await
    }

    /// 重置上下文。
    ///
    /// # Errors
    /// 当发送失败时返回错误。
    pub async fn reset_context(&self) -> Result<()> {
        self.send_playback(LiveMusicPlaybackControl::ResetContext)
            .await
    }

    /// 接收服务器消息。
    pub async fn receive(&mut self) -> Option<Result<LiveMusicServerMessage>> {
        self.incoming_rx.recv().await
    }

    /// 关闭会话。
    ///
    /// # Errors
    /// 当发送关闭信号失败时返回错误。
    pub async fn close(mut self) -> Result<()> {
        if let Some(tx) = self.shutdown_tx.take() {
            let _ = tx.send(());
        }
        tokio::task::yield_now().await;
        Ok(())
    }

    async fn send_playback(&self, control: LiveMusicPlaybackControl) -> Result<()> {
        let message = LiveMusicClientMessage {
            setup: None,
            client_content: None,
            music_generation_config: None,
            playback_control: Some(control),
        };
        self.send_async(message).await
    }

    fn send(&self, message: LiveMusicClientMessage) -> Result<()> {
        self.outgoing_tx
            .send(message)
            .map_err(|_| Error::ChannelClosed)?;
        Ok(())
    }

    async fn send_async(&self, message: LiveMusicClientMessage) -> Result<()> {
        self.send(message)?;
        tokio::task::yield_now().await;
        Ok(())
    }
}

async fn connect_live_music_session(
    inner: Arc<ClientInner>,
    model: String,
) -> Result<LiveMusicSession> {
    if inner.config.backend == Backend::VertexAi {
        return Err(Error::InvalidConfig {
            message: "Live music is not supported for Vertex AI".into(),
        });
    }

    let api_key = inner
        .config
        .api_key
        .as_ref()
        .ok_or_else(|| Error::InvalidConfig {
            message: "API key required for Live Music API".into(),
        })?;

    if api_key.starts_with("auth_tokens/") {
        return Err(Error::InvalidConfig {
            message: "Live music does not support ephemeral tokens".into(),
        });
    }

    let (url, headers) = build_live_music_ws_url(
        &inner.api_client.base_url,
        &inner.api_client.api_version,
        api_key,
    )?;

    let request = build_ws_request(&url, &headers)?;
    let (ws_stream, _) = connect_async(request).await?;
    let (mut write, mut read) = ws_stream.split();

    let setup = LiveMusicClientMessage {
        setup: Some(LiveMusicClientSetup {
            model: Some(normalize_model_name(&model)),
        }),
        client_content: None,
        music_generation_config: None,
        playback_control: None,
    };
    let payload = serde_json::to_string(&setup)?;
    write.send(Message::Text(payload.into())).await?;

    loop {
        match read.next().await {
            Some(Ok(message)) => match message {
                Message::Close(frame) => {
                    return Err(Error::Parse {
                        message: format!("WebSocket closed before setup_complete: {frame:?}"),
                    })
                }
                _ => {
                    if let Some(parsed) = parse_server_message(message)? {
                        if parsed.setup_complete.is_some() {
                            break;
                        }
                    }
                }
            },
            Some(Err(err)) => return Err(Error::WebSocket { source: err }),
            None => {
                return Err(Error::Parse {
                    message: "WebSocket closed before setup_complete".into(),
                })
            }
        }
    }

    let (incoming_tx, incoming_rx) = mpsc::unbounded_channel();
    let (outgoing_tx, outgoing_rx) = mpsc::unbounded_channel();
    let (shutdown_tx, shutdown_rx) = oneshot::channel();

    tokio::spawn(message_loop(
        write,
        read,
        outgoing_rx,
        incoming_tx,
        shutdown_rx,
    ));

    Ok(LiveMusicSession {
        outgoing_tx,
        incoming_rx,
        shutdown_tx: Some(shutdown_tx),
    })
}

fn normalize_model_name(model: &str) -> String {
    if model.starts_with("models/") {
        model.to_string()
    } else {
        format!("models/{model}")
    }
}

fn build_ws_request(
    url: &Url,
    headers: &HeaderMap,
) -> Result<tokio_tungstenite::tungstenite::http::Request<()>> {
    let mut request = url
        .as_str()
        .into_client_request()
        .map_err(|err| Error::Parse {
            message: err.to_string(),
        })?;
    {
        let request_headers = request.headers_mut();
        for (key, value) in headers {
            request_headers.insert(key, value.clone());
        }
    }
    Ok(request)
}

fn build_live_music_ws_url(
    base_url: &str,
    api_version: &str,
    api_key: &str,
) -> Result<(Url, HeaderMap)> {
    let mut url = Url::parse(base_url).map_err(|err| Error::InvalidConfig {
        message: err.to_string(),
    })?;

    let scheme = match url.scheme() {
        "http" | "ws" => "ws",
        _ => "wss",
    };
    url.set_scheme(scheme).map_err(|()| Error::InvalidConfig {
        message: "Invalid base_url scheme".into(),
    })?;

    let base_path = url.path().trim_end_matches('/');
    let path = format!(
        "{base_path}/ws/google.ai.generativelanguage.{api_version}.GenerativeService.BidiGenerateMusic"
    );
    url.set_path(&path);
    url.set_query(Some(&format!("key={api_key}")));

    let mut headers = HeaderMap::new();
    headers.insert(
        "x-goog-api-key",
        HeaderValue::from_str(api_key).map_err(|_| Error::InvalidConfig {
            message: "Invalid API key".into(),
        })?,
    );

    Ok((url, headers))
}

fn parse_server_message(message: Message) -> Result<Option<LiveMusicServerMessage>> {
    match message {
        Message::Text(text) => {
            let msg = serde_json::from_str::<LiveMusicServerMessage>(&text)?;
            Ok(Some(msg))
        }
        Message::Binary(data) => {
            let msg = serde_json::from_slice::<LiveMusicServerMessage>(&data)?;
            Ok(Some(msg))
        }
        Message::Ping(_) | Message::Pong(_) | Message::Close(_) | Message::Frame(_) => Ok(None),
    }
}

async fn message_loop(
    mut write: futures_util::stream::SplitSink<
        tokio_tungstenite::WebSocketStream<
            tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>,
        >,
        Message,
    >,
    mut read: futures_util::stream::SplitStream<
        tokio_tungstenite::WebSocketStream<
            tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>,
        >,
    >,
    mut outgoing_rx: mpsc::UnboundedReceiver<LiveMusicClientMessage>,
    incoming_tx: mpsc::UnboundedSender<Result<LiveMusicServerMessage>>,
    mut shutdown_rx: oneshot::Receiver<()>,
) {
    loop {
        tokio::select! {
            Some(message) = outgoing_rx.recv() => {
                match serde_json::to_string(&message) {
                    Ok(payload) => {
                        if write.send(Message::Text(payload.into())).await.is_err() {
                            let _ = incoming_tx.send(Err(Error::ChannelClosed));
                            break;
                        }
                    }
                    Err(err) => {
                        let _ = incoming_tx.send(Err(Error::Serialization { source: err }));
                    }
                }
            }
            message = read.next() => {
                match message {
                    Some(Ok(message)) => {
                        match message {
                            Message::Ping(payload) => {
                                let _ = write.send(Message::Pong(payload)).await;
                            }
                            Message::Close(_) => break,
                            other => match parse_server_message(other) {
                                Ok(Some(parsed)) => {
                                    let _ = incoming_tx.send(Ok(parsed));
                                }
                                Ok(None) => {}
                                Err(err) => {
                                    let _ = incoming_tx.send(Err(err));
                                }
                            },
                        }
                    }
                    Some(Err(err)) => {
                        let _ = incoming_tx.send(Err(Error::WebSocket { source: err }));
                        break;
                    }
                    None => break,
                }
            }
            _ = &mut shutdown_rx => {
                let _ = write.send(Message::Close(None)).await;
                break;
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_support::test_client_inner_with_api_key;
    use rust_genai_types::live_music_types::LiveMusicServerSetupComplete;
    use tokio::sync::{mpsc, oneshot};

    #[test]
    fn test_build_live_music_ws_url() {
        let (url, headers) = build_live_music_ws_url(
            "https://generativelanguage.googleapis.com/",
            "v1beta",
            "test-key",
        )
        .unwrap();
        assert!(url.as_str().starts_with("wss://"));
        assert!(
            url.as_str().contains("BidiGenerateMusic"),
            "missing music endpoint"
        );
        assert!(url.as_str().contains("key=test-key"));
        assert!(headers.contains_key("x-goog-api-key"));
    }

    #[tokio::test]
    async fn test_live_music_session_send_and_close() {
        let (outgoing_tx, mut outgoing_rx) = mpsc::unbounded_channel();
        let (_incoming_tx, incoming_rx) = mpsc::unbounded_channel();
        let (shutdown_tx, shutdown_rx) = oneshot::channel();
        let session = LiveMusicSession {
            outgoing_tx,
            incoming_rx,
            shutdown_tx: Some(shutdown_tx),
        };

        let err = session.set_weighted_prompts(vec![]).await.unwrap_err();
        assert!(matches!(err, Error::InvalidConfig { .. }));

        session
            .set_weighted_prompts(vec![WeightedPrompt {
                text: Some("hi".to_string()),
                weight: Some(1.0),
            }])
            .await
            .unwrap();
        let msg = outgoing_rx.recv().await.unwrap();
        assert!(msg.client_content.is_some());

        session
            .set_music_generation_config(Some(LiveMusicGenerationConfig {
                temperature: Some(0.2),
                ..Default::default()
            }))
            .await
            .unwrap();
        let msg = outgoing_rx.recv().await.unwrap();
        assert!(msg.music_generation_config.is_some());

        session.play().await.unwrap();
        let msg = outgoing_rx.recv().await.unwrap();
        assert!(matches!(
            msg.playback_control,
            Some(LiveMusicPlaybackControl::Play)
        ));

        session.pause().await.unwrap();
        let msg = outgoing_rx.recv().await.unwrap();
        assert!(matches!(
            msg.playback_control,
            Some(LiveMusicPlaybackControl::Pause)
        ));

        session.stop().await.unwrap();
        let msg = outgoing_rx.recv().await.unwrap();
        assert!(matches!(
            msg.playback_control,
            Some(LiveMusicPlaybackControl::Stop)
        ));

        session.reset_context().await.unwrap();
        let msg = outgoing_rx.recv().await.unwrap();
        assert!(matches!(
            msg.playback_control,
            Some(LiveMusicPlaybackControl::ResetContext)
        ));

        session.close().await.unwrap();
        assert!(shutdown_rx.await.is_ok());
    }

    #[tokio::test]
    async fn test_live_music_session_send_channel_closed() {
        let (outgoing_tx, outgoing_rx) = mpsc::unbounded_channel();
        drop(outgoing_rx);
        let (_incoming_tx, incoming_rx) = mpsc::unbounded_channel();
        let session = LiveMusicSession {
            outgoing_tx,
            incoming_rx,
            shutdown_tx: None,
        };
        let err = session.play().await.unwrap_err();
        assert!(matches!(err, Error::ChannelClosed));
    }

    #[tokio::test]
    async fn test_connect_live_music_session_errors() {
        let inner = Arc::new(test_client_inner_with_api_key(
            Backend::VertexAi,
            Some("key"),
        ));
        let err = connect_live_music_session(inner, "model".to_string())
            .await
            .err()
            .unwrap();
        assert!(matches!(err, Error::InvalidConfig { .. }));

        let inner = Arc::new(test_client_inner_with_api_key(Backend::GeminiApi, None));
        let err = connect_live_music_session(inner, "model".to_string())
            .await
            .err()
            .unwrap();
        assert!(matches!(err, Error::InvalidConfig { .. }));

        let inner = Arc::new(test_client_inner_with_api_key(
            Backend::GeminiApi,
            Some("auth_tokens/abc"),
        ));
        let err = connect_live_music_session(inner, "model".to_string())
            .await
            .err()
            .unwrap();
        assert!(matches!(err, Error::InvalidConfig { .. }));
    }

    #[test]
    fn test_build_live_music_ws_url_invalid_inputs() {
        let err = build_live_music_ws_url("://bad", "v1beta", "test-key").unwrap_err();
        assert!(matches!(err, Error::InvalidConfig { .. }));

        let err =
            build_live_music_ws_url("https://example.com/", "v1beta", "bad\nkey").unwrap_err();
        assert!(matches!(err, Error::InvalidConfig { .. }));
    }

    #[test]
    fn test_parse_live_music_message_variants() {
        let text_message = Message::Text(
            serde_json::to_string(&LiveMusicServerMessage {
                setup_complete: Some(LiveMusicServerSetupComplete::default()),
                ..Default::default()
            })
            .unwrap()
            .into(),
        );
        assert!(parse_server_message(text_message).unwrap().is_some());

        let bin_message = Message::Binary(
            serde_json::to_vec(&LiveMusicServerMessage {
                setup_complete: Some(LiveMusicServerSetupComplete::default()),
                ..Default::default()
            })
            .unwrap()
            .into(),
        );
        assert!(parse_server_message(bin_message).unwrap().is_some());

        assert!(parse_server_message(Message::Ping(vec![1].into()))
            .unwrap()
            .is_none());
        assert!(parse_server_message(Message::Close(None))
            .unwrap()
            .is_none());
        assert!(parse_server_message(Message::Text("bad-json".into())).is_err());
    }
}