async-openai 0.34.0

Rust library for OpenAI
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use serde::{Deserialize, Serialize};

use crate::types::InputSource;

/// Reference a skill by ID when providing it to a tool or container.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct SkillReferenceParam {
    /// The ID of the skill to reference.
    pub skill_id: String,
    /// An optional specific version to use.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
}

/// The source for an inline skill (base64-encoded zip archive).
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct InlineSkillSourceParam {
    /// The media type. Always `"application/zip"`.
    pub media_type: String,
    /// The base64-encoded skill data.
    pub data: String,
}

/// An inline skill definition provided directly in a request.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct InlineSkillParam {
    /// The name of the skill.
    pub name: String,
    /// The description of the skill.
    pub description: String,
    /// The inline source for the skill.
    pub source: InlineSkillSourceParam,
}

/// Represents a skill object.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct SkillResource {
    /// Unique identifier for the skill.
    pub id: String,
    /// The object type, which is always `skill`.
    pub object: String,
    /// Name of the skill.
    pub name: String,
    /// Description of the skill.
    pub description: String,
    /// Unix timestamp (in seconds) for when the skill was created.
    pub created_at: u64,
    /// Default version for the skill.
    pub default_version: String,
    /// Latest version for the skill.
    pub latest_version: String,
}

/// List of skills.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct SkillListResource {
    /// The object type, which is always `list`.
    pub object: String,
    /// A list of skill objects.
    pub data: Vec<SkillResource>,
    /// The ID of the first item in the list.
    pub first_id: Option<String>,
    /// The ID of the last item in the list.
    pub last_id: Option<String>,
    /// Whether there are more items available.
    pub has_more: bool,
}

/// Request to create a skill by uploading files.
#[derive(Debug, Default, Clone, PartialEq)]
pub struct CreateSkillRequest {
    /// Skill files to upload (directory upload) or a single zip file.
    pub files: Vec<InputSource>,
}

/// Request to update the default version pointer for a skill.
#[derive(Debug, Clone, PartialEq, Serialize)]
pub struct SetDefaultSkillVersionRequest {
    /// The skill version number to set as default.
    pub default_version: String,
}

/// Confirmation of skill deletion.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct DeletedSkillResource {
    /// The object type, which is always `skill.deleted`.
    pub object: String,
    /// Whether the skill was deleted.
    pub deleted: bool,
    /// The skill ID.
    pub id: String,
}

/// Represents a skill version object.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct SkillVersionResource {
    /// The object type, which is always `skill.version`.
    pub object: String,
    /// Unique identifier for the skill version.
    pub id: String,
    /// Identifier of the skill for this version.
    pub skill_id: String,
    /// Version number for this skill.
    pub version: String,
    /// Unix timestamp (in seconds) for when the skill version was created.
    pub created_at: u64,
    /// Name of the skill version.
    pub name: String,
    /// Description of the skill version.
    pub description: String,
}

/// List of skill versions.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct SkillVersionListResource {
    /// The object type, which is always `list`.
    pub object: String,
    /// A list of skill version objects.
    pub data: Vec<SkillVersionResource>,
    /// The ID of the first item in the list.
    pub first_id: Option<String>,
    /// The ID of the last item in the list.
    pub last_id: Option<String>,
    /// Whether there are more items available.
    pub has_more: bool,
}

/// Request to create a new skill version by uploading files.
#[derive(Debug, Default, Clone, PartialEq)]
pub struct CreateSkillVersionRequest {
    /// Skill files to upload (directory upload) or a single zip file.
    pub files: Vec<InputSource>,
    /// Whether to set this version as the default.
    pub default: Option<bool>,
}

/// Confirmation of skill version deletion.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct DeletedSkillVersionResource {
    /// The object type, which is always `skill.version.deleted`.
    pub object: String,
    /// Whether the skill version was deleted.
    pub deleted: bool,
    /// The skill version ID.
    pub id: String,
    /// The deleted skill version number.
    pub version: String,
}