Merge branch 'dongri:main' into main

Author: Folyd

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "openai-api-rs"
-version = "5.2.4"
+version = "6.0.0"
 edition = "2021"
 authors = ["Dongri Jin <[email protected]>"]
 license = "MIT"

README.md

@@ -7,21 +7,32 @@ Check out the [docs.rs](https://docs.rs/openai-api-rs/).
 Cargo.toml
 ```toml
 [dependencies]
-openai-api-rs = "5.2.4"
+openai-api-rs = "6.0.0"
 ```
 
 ## Usage
 The library needs to be configured with your account's secret key, which is available on the [website](https://platform.openai.com/account/api-keys). We recommend setting it as an environment variable. Here's an example of initializing the library with the API key loaded from an environment variable and creating a completion:
 
-### Set OPENAI_API_KEY to environment variable
+### Set OPENAI_API_KEY or OPENROUTER_API_KEY to environment variable
 ```bash
 $ export OPENAI_API_KEY=sk-xxxxxxx
+or
+$ export OPENROUTER_API_KEY=sk-xxxxxxx
 ```
 
-### Create client
+### Create OpenAI client
 ```rust
 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
+```
+
+### Create OpenRouter client
+```rust
+let api_key = env::var("OPENROUTER_API_KEY").unwrap().to_string();
+let mut client = OpenAIClient::builder()
+    .with_endpoint("https://openrouter.ai/api/v1")
+    .with_api_key(api_key)
+    .build()?;
 ```
 
 ### Create request
@@ -42,6 +53,10 @@ let req = ChatCompletionRequest::new(
 ```rust
 let result = client.chat_completion(req)?;
 println!("Content: {:?}", result.choices[0].message.content);
+
+for (key, value) in client.headers.unwrap().iter() {
+    println!("{}: {:?}", key, value);
+}
 ```
 
 ### Set OPENAI_API_BASE to environment variable (optional)
@@ -59,7 +74,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let req = ChatCompletionRequest::new(
         GPT4_O.to_string(),
@@ -74,11 +89,52 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let result = client.chat_completion(req).await?;
     println!("Content: {:?}", result.choices[0].message.content);
-    println!("Response Headers: {:?}", result.headers);
+
+    for (key, value) in client.headers.unwrap().iter() {
+        println!("{}: {:?}", key, value);
+    }
+
+    Ok(())
+}
+```
+
+## Example for OpenRouter
+```rust
+use openai_api_rs::v1::api::OpenAIClient;
+use openai_api_rs::v1::chat_completion::{self, ChatCompletionRequest};
+use openai_api_rs::v1::common::GPT4_O_MINI;
+use std::env;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let api_key = env::var("OPENROUTER_API_KEY").unwrap().to_string();
+    let mut client = OpenAIClient::builder()
+        .with_endpoint("https://openrouter.ai/api/v1")
+        .with_api_key(api_key)
+        .build()?;
+
+    let req = ChatCompletionRequest::new(
+        GPT4_O_MINI.to_string(),
+        vec![chat_completion::ChatCompletionMessage {
+            role: chat_completion::MessageRole::user,
+            content: chat_completion::Content::Text(String::from("What is bitcoin?")),
+            name: None,
+            tool_calls: None,
+            tool_call_id: None,
+        }],
+    );
+
+    let result = client.chat_completion(req).await?;
+    println!("Content: {:?}", result.choices[0].message.content);
+    
+    for (key, value) in client.headers.unwrap().iter() {
+        println!("{}: {:?}", key, value);
+    }
 
     Ok(())
 }
 ```
+
 More Examples: [examples](https://github.com/dongri/openai-api-rs/tree/main/examples)
 
 Check out the [full API documentation](https://platform.openai.com/docs/api-reference/completions) for examples of all the available functions.

examples/assistant.rs

@@ -10,7 +10,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let mut tools = HashMap::new();
     tools.insert("type".to_string(), "code_interpreter".to_string());

examples/audio_speech.rs

@@ -5,7 +5,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let req = AudioSpeechRequest::new(
         TTS_1.to_string(),

examples/audio_transcriptions.rs

@@ -1,16 +1,18 @@
 use openai_api_rs::v1::api::OpenAIClient;
 use openai_api_rs::v1::audio::{AudioTranscriptionRequest, WHISPER_1};
 use std::env;
+use std::fs::File;
+use std::io::Read;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
-    let req = AudioTranscriptionRequest::new(
-        "examples/data/problem.mp3".to_string(),
-        WHISPER_1.to_string(),
-    );
+    let file_path = "examples/data/problem.mp3";
+
+    // Test with file
+    let req = AudioTranscriptionRequest::new(file_path.to_string(), WHISPER_1.to_string());
 
     let req_json = req.clone().response_format("json".to_string());
 
@@ -22,7 +24,19 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let result = client.audio_transcription_raw(req_raw).await?;
     println!("{:?}", result);
 
+    // Test with bytes
+    let mut file = File::open(file_path)?;
+    let mut buffer = Vec::new();
+    file.read_to_end(&mut buffer)?;
+
+    let req = AudioTranscriptionRequest::new_bytes(buffer, WHISPER_1.to_string());
+
+    let req_json = req.clone().response_format("json".to_string());
+
+    let result = client.audio_transcription(req_json).await?;
+    println!("{:?}", result);
+
     Ok(())
 }
 
-// OPENAI_API_KEY=xxxx cargo run --package openai-api-rs --example audio_translations
+// OPENAI_API_KEY=xxxx cargo run --package openai-api-rs --example audio_transcriptions

examples/audio_translations.rs

@@ -5,7 +5,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let req = AudioTranslationRequest::new(
         "examples/data/problem_cn.mp3".to_string(),

examples/batch.rs

@@ -10,7 +10,7 @@ use std::str;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let req = FileUploadRequest::new(
         "examples/data/batch_request.json".to_string(),

examples/chat_completion.rs

@@ -6,7 +6,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let req = ChatCompletionRequest::new(
         GPT4_O_MINI.to_string(),
@@ -21,7 +21,11 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let result = client.chat_completion(req).await?;
     println!("Content: {:?}", result.choices[0].message.content);
-    println!("Response Headers: {:?}", result.headers);
+
+    // print response headers
+    for (key, value) in client.headers.unwrap().iter() {
+        println!("{}: {:?}", key, value);
+    }
 
     Ok(())
 }

examples/completion.rs

@@ -5,7 +5,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let req = CompletionRequest::new(
         completion::GPT3_TEXT_DAVINCI_003.to_string(),

examples/embedding.rs

@@ -6,7 +6,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let mut req = EmbeddingRequest::new(
         TEXT_EMBEDDING_3_SMALL.to_string(),

examples/function_call.rs

@@ -18,7 +18,7 @@ fn get_coin_price(coin: &str) -> f64 {
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let mut properties = HashMap::new();
     properties.insert(

examples/function_call_role.rs

@@ -18,7 +18,7 @@ fn get_coin_price(coin: &str) -> f64 {
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let mut properties = HashMap::new();
     properties.insert(

examples/openrouter.rs

@@ -0,0 +1,32 @@
+use openai_api_rs::v1::api::OpenAIClient;
+use openai_api_rs::v1::chat_completion::{self, ChatCompletionRequest};
+use openai_api_rs::v1::common::GPT4_O_MINI;
+use std::env;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let api_key = env::var("OPENROUTER_API_KEY").unwrap().to_string();
+    let mut client = OpenAIClient::builder()
+        .with_endpoint("https://openrouter.ai/api/v1")
+        .with_api_key(api_key)
+        .build()?;
+
+    let req = ChatCompletionRequest::new(
+        GPT4_O_MINI.to_string(),
+        vec![chat_completion::ChatCompletionMessage {
+            role: chat_completion::MessageRole::user,
+            content: chat_completion::Content::Text(String::from("What is bitcoin?")),
+            name: None,
+            tool_calls: None,
+            tool_call_id: None,
+        }],
+    );
+
+    let result = client.chat_completion(req).await?;
+    println!("Content: {:?}", result.choices[0].message.content);
+    println!("Response Headers: {:?}", client.headers);
+
+    Ok(())
+}
+
+// OPENROUTER_API_KEY=xxxx cargo run --package openai-api-rs --example openrouter

examples/vision.rs

@@ -6,7 +6,7 @@ use std::env;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
-    let client = OpenAIClient::builder().with_api_key(api_key).build()?;
+    let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
 
     let req = ChatCompletionRequest::new(
         GPT4_O.to_string(),

src/realtime/types.rs

@@ -30,17 +30,22 @@ pub struct Session {
 #[serde(rename_all = "lowercase")]
 pub enum RealtimeVoice {
     Alloy,
-    Shimmer,
+    Ash,
+    Ballad,
+    Coral,
     Echo,
+    Sage,
+    Shimmer,
+    Verse,
 }
 
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub enum AudioFormat {
     #[serde(rename = "pcm16")]
     PCM16,
-    #[serde(rename = "g711-ulaw")]
+    #[serde(rename = "g711_ulaw")]
     G711ULAW,
-    #[serde(rename = "g711-alaw")]
+    #[serde(rename = "g711_alaw")]
     G711ALAW,
 }