openai_struct/models/realtime_client_event_output_audio_buffer_clear.rs
1/*
2 * OpenAI API
3 *
4 * The OpenAI REST API. Please see pub https://platform.openai.com/docs/api-reference for more details.
5 *
6 * OpenAPI spec pub version: 2.3.0
7 *
8 * Generated pub by: https://github.com/swagger-api/swagger-codegen.git
9 */
10
11/// pub RealtimeClientEventOutputAudioBufferClear : **WebRTC Only:** Emit to cut off the current audio response. This will trigger the server to stop generating audio and emit a `output_audio_buffer.cleared` event. This event should be preceded by a `response.cancel` client event to stop the generation of the current response. [Learn more](/docs/guides/realtime-model-capabilities#client-and-server-events-for-audio-in-webrtc).
12
13#[allow(unused_imports)]
14use serde_json::Value;
15
16#[derive(Debug, Serialize, Deserialize)]
17pub struct RealtimeClientEventOutputAudioBufferClear {
18 /// The unique ID of the client event used for error handling.
19 #[serde(rename = "event_id")]
20 pub event_id: Option<String>,
21 /// The event type, must be `output_audio_buffer.clear`.
22 #[serde(rename = "type")]
23 pub _type: String,
24}