openai-tools 1.1.0

Tools for OpenAI API
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

//! Audio types for the Realtime API.

use serde::{Deserialize, Serialize};

/// Audio formats supported by the Realtime API.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum AudioFormat {
    /// PCM 16-bit linear encoding (24kHz, mono)
    #[default]
    Pcm16,
    /// G.711 mu-law encoding
    G711Ulaw,
    /// G.711 A-law encoding
    G711Alaw,
}

/// Voice options for text-to-speech output.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum Voice {
    #[default]
    Alloy,
    Ash,
    Ballad,
    Coral,
    Echo,
    Sage,
    Shimmer,
    Verse,
}

/// Transcription model options for input audio.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub enum TranscriptionModel {
    #[serde(rename = "whisper-1")]
    #[default]
    Whisper1,
}

/// Input audio transcription configuration.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct InputAudioTranscription {
    /// The transcription model to use.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub model: Option<TranscriptionModel>,

    /// Language hint for transcription (ISO-639-1 code).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub language: Option<String>,

    /// Optional prompt to guide transcription.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prompt: Option<String>,
}

impl InputAudioTranscription {
    /// Create a new transcription configuration with the specified model.
    pub fn new(model: TranscriptionModel) -> Self {
        Self { model: Some(model), language: None, prompt: None }
    }

    /// Set the language hint.
    pub fn with_language(mut self, language: impl Into<String>) -> Self {
        self.language = Some(language.into());
        self
    }

    /// Set the transcription prompt.
    pub fn with_prompt(mut self, prompt: impl Into<String>) -> Self {
        self.prompt = Some(prompt.into());
        self
    }
}

/// Input audio noise reduction configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InputAudioNoiseReduction {
    /// Type of noise reduction to apply.
    #[serde(rename = "type")]
    pub noise_type: NoiseReductionType,
}

/// Noise reduction type options.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum NoiseReductionType {
    /// Optimized for near-field audio (close microphone).
    NearField,
    /// Optimized for far-field audio (distant microphone).
    FarField,
}