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
/*
* OpenAI API
*
* The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
*
* The version of the OpenAPI document: 2.3.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// RealtimeBetaClientEventResponseCancel : Send this event to cancel an in-progress response. The server will respond with a `response.done` event with a status of `response.status=cancelled`. If there is no response to cancel, the server will respond with an error.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct RealtimeBetaClientEventResponseCancel {
/// Optional client-generated ID used to identify this event.
#[serde(rename = "event_id", skip_serializing_if = "Option::is_none")]
pub event_id: Option<String>,
/// The event type, must be `response.cancel`.
#[serde(rename = "type")]
pub r#type: Type,
/// A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.
#[serde(rename = "response_id", skip_serializing_if = "Option::is_none")]
pub response_id: Option<String>,
}
impl RealtimeBetaClientEventResponseCancel {
/// Send this event to cancel an in-progress response. The server will respond with a `response.done` event with a status of `response.status=cancelled`. If there is no response to cancel, the server will respond with an error.
pub fn new(r#type: Type) -> RealtimeBetaClientEventResponseCancel {
RealtimeBetaClientEventResponseCancel {
event_id: None,
r#type,
response_id: None,
}
}
}
/// The event type, must be `response.cancel`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
#[serde(rename = "response.cancel")]
ResponseCancel,
}
impl Default for Type {
fn default() -> Type {
Self::ResponseCancel
}
}
impl std::fmt::Display for RealtimeBetaClientEventResponseCancel {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match serde_json::to_string(self) {
Ok(s) => write!(f, "{}", s),
Err(_) => Err(std::fmt::Error),
}
}
}