openai-compat 0.3.0

Async Rust client for OpenAI-compatible LLM provider APIs
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

//! `/audio` resources, mirroring `resources/audio/speech.py` and
//! `resources/audio/transcriptions.py`.

use bytes::Bytes;
use reqwest::Method;

use crate::client::Client;
use crate::error::OpenAIError;
use crate::request::{MultipartField, RequestOptions};
use crate::types::audio::{SpeechRequest, Transcription, TranscriptionRequest};
use crate::types::files::FileUpload;

/// Accessor for audio endpoints: `client.audio().speech(...)`.
#[derive(Debug, Clone)]
pub struct Audio {
    client: Client,
}

impl Audio {
    pub(crate) fn new(client: Client) -> Self {
        Self { client }
    }

    /// Text-to-speech: returns the raw audio bytes.
    pub async fn speech(&self, request: SpeechRequest) -> Result<Bytes, OpenAIError> {
        let body = serde_json::to_value(&request)?;
        self.client
            .execute_bytes(Method::POST, "/audio/speech", RequestOptions::json(body))
            .await
    }

    /// Speech-to-text: transcribe an audio file (multipart upload).
    ///
    /// Parses the JSON response shapes (`response_format` of `json`, the
    /// default, or `verbose_json`). For the plain-text formats (`text`,
    /// `srt`, `vtt`) use [`Audio::transcriptions_raw`].
    pub async fn transcriptions(
        &self,
        file: FileUpload,
        request: TranscriptionRequest,
    ) -> Result<Transcription, OpenAIError> {
        if matches!(
            request.response_format.as_deref(),
            Some("text") | Some("srt") | Some("vtt")
        ) {
            return Err(OpenAIError::Config(format!(
                "response_format {:?} returns plain text; use transcriptions_raw",
                request.response_format.as_deref().unwrap_or_default()
            )));
        }
        let fields = transcription_fields(file, request);
        self.client
            .execute(
                Method::POST,
                "/audio/transcriptions",
                RequestOptions::multipart(fields),
            )
            .await
    }

    /// Speech-to-text returning the raw response body as text — for the
    /// non-JSON `response_format`s (`text`, `srt`, `vtt`).
    pub async fn transcriptions_raw(
        &self,
        file: FileUpload,
        request: TranscriptionRequest,
    ) -> Result<String, OpenAIError> {
        let fields = transcription_fields(file, request);
        let bytes = self
            .client
            .execute_bytes(
                Method::POST,
                "/audio/transcriptions",
                RequestOptions::multipart(fields),
            )
            .await?;
        Ok(String::from_utf8_lossy(&bytes).into_owned())
    }
}

fn transcription_fields(file: FileUpload, request: TranscriptionRequest) -> Vec<MultipartField> {
    {
        let mut fields = vec![
            MultipartField::File {
                name: "file".into(),
                filename: file.filename,
                bytes: file.bytes,
                content_type: file.content_type,
            },
            MultipartField::Text {
                name: "model".into(),
                value: request.model,
            },
        ];
        if let Some(language) = request.language {
            fields.push(MultipartField::Text {
                name: "language".into(),
                value: language,
            });
        }
        if let Some(prompt) = request.prompt {
            fields.push(MultipartField::Text {
                name: "prompt".into(),
                value: prompt,
            });
        }
        if let Some(response_format) = request.response_format {
            fields.push(MultipartField::Text {
                name: "response_format".into(),
                value: response_format,
            });
        }
        if let Some(temperature) = request.temperature {
            fields.push(MultipartField::Text {
                name: "temperature".into(),
                value: temperature.to_string(),
            });
        }
        fields
    }
}