api_openai 0.3.0

OpenAI's API for accessing large language models (LLMs).
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

//! Transcription-specific session structures for the Realtime API.

/// Define a private namespace for transcription-related items.
mod private
{
  // Use full paths from crate root for components
  use crate::components::realtime_shared::session::
  {
    RealtimeSessionInputAudioTranscription,
    RealtimeSessionTurnDetection,
    RealtimeSessionInputAudioNoiseReduction,
    RealtimeClientSecret,
  };

  // Serde imports
  use serde::{ Serialize, Deserialize };

  /// Response object returned when creating a Realtime transcription session via REST API.
  ///
  /// # Used By
  /// - `/realtime/transcription_sessions` (POST)
  /// - `RealtimeServerEventTranscriptionSessionUpdated`
  #[ derive( Debug, Serialize, Deserialize, Clone, PartialEq ) ] // Added Serialize
  pub struct RealtimeTranscriptionSessionCreateResponse
  {
    /// Ephemeral key for client authentication (only present on creation via REST).
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub client_secret : Option< RealtimeClientSecret >,
    /// Unique identifier for the session.
    pub id : String,
    /// The object type, always "`realtime.transcription_session`".
    pub object : String,
    /// The set of modalities supported (always [`"audio"`, `"text"`] for transcription).
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub modalities : Option< Vec< String > >,
    /// The format of input audio.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub input_audio_format : Option< String >,
    /// Configuration for input audio transcription.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub input_audio_transcription : Option< RealtimeSessionInputAudioTranscription >,
    /// Configuration for turn detection.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub turn_detection : Option< RealtimeSessionTurnDetection >,
    /// Configuration for input audio noise reduction.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub input_audio_noise_reduction : Option< RealtimeSessionInputAudioNoiseReduction >,
    /// Items to include in the transcription response (e.g., logprobs).
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub include : Option< Vec< String > >,
  }

  /// Represents the request body for creating or updating a Realtime transcription session.
  ///
  /// # Used By
  /// - `/realtime/transcription_sessions` (POST)
  /// - `RealtimeClientEventTranscriptionSessionUpdate`
  #[ derive( Debug, Serialize, Deserialize, Clone, PartialEq, Default, former::Former ) ] // Added Serialize, Default
  pub struct RealtimeTranscriptionSessionCreateRequest
  {
    /// Supported modalities (always [`"audio"`, `"text"`] for transcription).
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub modalities : Option< Vec< String > >,
    /// Format of input audio.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub input_audio_format : Option< String >,
    /// Input audio transcription configuration.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub input_audio_transcription : Option< RealtimeSessionInputAudioTranscription >,
    /// Turn detection configuration.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub turn_detection : Option< RealtimeSessionTurnDetection >,
    /// Input audio noise reduction configuration.
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub input_audio_noise_reduction : Option< RealtimeSessionInputAudioNoiseReduction >,
    /// Items to include in the transcription response (e.g., logprobs).
    #[ serde( skip_serializing_if = "Option::is_none" ) ]
    pub include : Option< Vec< String > >,
  }

} // end mod private

crate ::mod_interface!
{
  exposed use
  {
    RealtimeTranscriptionSessionCreateResponse,
    RealtimeTranscriptionSessionCreateRequest,
  };
}