openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
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

/*
 * 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};

/// RealtimeConversationItemFunctionCall : A function call item in a Realtime conversation.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct RealtimeConversationItemFunctionCall {
    /// The unique ID of the item. This may be provided by the client or generated by the server.
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.
    #[serde(rename = "object", skip_serializing_if = "Option::is_none")]
    pub object: Option<Object>,
    /// The type of the item. Always `function_call`.
    #[serde(rename = "type")]
    pub r#type: Type,
    /// The status of the item. Has no effect on the conversation.
    #[serde(rename = "status", skip_serializing_if = "Option::is_none")]
    pub status: Option<Status>,
    /// The ID of the function call.
    #[serde(rename = "call_id", skip_serializing_if = "Option::is_none")]
    pub call_id: Option<String>,
    /// The name of the function being called.
    #[serde(rename = "name")]
    pub name: String,
    /// The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.
    #[serde(rename = "arguments")]
    pub arguments: String,
}

impl RealtimeConversationItemFunctionCall {
    /// A function call item in a Realtime conversation.
    pub fn new(
        r#type: Type,
        name: String,
        arguments: String,
    ) -> RealtimeConversationItemFunctionCall {
        RealtimeConversationItemFunctionCall {
            id: None,
            object: None,
            r#type,
            status: None,
            call_id: None,
            name,
            arguments,
        }
    }
}
/// Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Object {
    #[serde(rename = "realtime.item")]
    RealtimeItem,
}

impl Default for Object {
    fn default() -> Object {
        Self::RealtimeItem
    }
}
/// The type of the item. Always `function_call`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
    #[serde(rename = "function_call")]
    FunctionCall,
}

impl Default for Type {
    fn default() -> Type {
        Self::FunctionCall
    }
}
/// The status of the item. Has no effect on the conversation.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Status {
    #[serde(rename = "completed")]
    Completed,
    #[serde(rename = "incomplete")]
    Incomplete,
    #[serde(rename = "in_progress")]
    InProgress,
}

impl Default for Status {
    fn default() -> Status {
        Self::Completed
    }
}

impl std::fmt::Display for RealtimeConversationItemFunctionCall {
    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),
        }
    }
}