@effect/ai-openai 4.0.0-beta.7 → 4.0.0-beta.70
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Generated.d.ts +66734 -37723
- package/dist/Generated.d.ts.map +1 -1
- package/dist/Generated.js +1 -1
- package/dist/Generated.js.map +1 -1
- package/dist/OpenAiClient.d.ts +81 -25
- package/dist/OpenAiClient.d.ts.map +1 -1
- package/dist/OpenAiClient.js +220 -39
- package/dist/OpenAiClient.js.map +1 -1
- package/dist/OpenAiClientGenerated.d.ts +91 -0
- package/dist/OpenAiClientGenerated.d.ts.map +1 -0
- package/dist/OpenAiClientGenerated.js +84 -0
- package/dist/OpenAiClientGenerated.js.map +1 -0
- package/dist/OpenAiConfig.d.ts +45 -10
- package/dist/OpenAiConfig.d.ts.map +1 -1
- package/dist/OpenAiConfig.js +31 -7
- package/dist/OpenAiConfig.js.map +1 -1
- package/dist/OpenAiEmbeddingModel.d.ts +89 -0
- package/dist/OpenAiEmbeddingModel.d.ts.map +1 -0
- package/dist/OpenAiEmbeddingModel.js +121 -0
- package/dist/OpenAiEmbeddingModel.js.map +1 -0
- package/dist/OpenAiError.d.ts +168 -35
- package/dist/OpenAiError.d.ts.map +1 -1
- package/dist/OpenAiError.js +1 -1
- package/dist/OpenAiLanguageModel.d.ts +250 -57
- package/dist/OpenAiLanguageModel.d.ts.map +1 -1
- package/dist/OpenAiLanguageModel.js +311 -160
- package/dist/OpenAiLanguageModel.js.map +1 -1
- package/dist/OpenAiSchema.d.ts +2029 -0
- package/dist/OpenAiSchema.d.ts.map +1 -0
- package/dist/OpenAiSchema.js +591 -0
- package/dist/OpenAiSchema.js.map +1 -0
- package/dist/OpenAiTelemetry.d.ts +31 -18
- package/dist/OpenAiTelemetry.d.ts.map +1 -1
- package/dist/OpenAiTelemetry.js +6 -4
- package/dist/OpenAiTelemetry.js.map +1 -1
- package/dist/OpenAiTool.d.ts +56 -67
- package/dist/OpenAiTool.d.ts.map +1 -1
- package/dist/OpenAiTool.js +33 -44
- package/dist/OpenAiTool.js.map +1 -1
- package/dist/index.d.ts +42 -8
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +42 -8
- package/dist/index.js.map +1 -1
- package/dist/internal/errors.js +4 -4
- package/dist/internal/errors.js.map +1 -1
- package/package.json +3 -3
- package/src/Generated.ts +9858 -5044
- package/src/OpenAiClient.ts +396 -90
- package/src/OpenAiClientGenerated.ts +202 -0
- package/src/OpenAiConfig.ts +46 -11
- package/src/OpenAiEmbeddingModel.ts +207 -0
- package/src/OpenAiError.ts +170 -35
- package/src/OpenAiLanguageModel.ts +633 -157
- package/src/OpenAiSchema.ts +984 -0
- package/src/OpenAiTelemetry.ts +32 -19
- package/src/OpenAiTool.ts +34 -45
- package/src/index.ts +45 -8
- package/src/internal/errors.ts +6 -4
|
@@ -0,0 +1,2029 @@
|
|
|
1
|
+
import * as Schema from "effect/Schema";
|
|
2
|
+
/**
|
|
3
|
+
* Schema for optional `include` values on OpenAI Responses requests.
|
|
4
|
+
*
|
|
5
|
+
* **Details**
|
|
6
|
+
*
|
|
7
|
+
* These values request additional response fields such as image URLs, encrypted reasoning content, output logprobs, code interpreter outputs, or web search sources.
|
|
8
|
+
*
|
|
9
|
+
* @category schemas
|
|
10
|
+
* @since 4.0.0
|
|
11
|
+
*/
|
|
12
|
+
export declare const IncludeEnum: Schema.Literals<readonly ["message.input_image.image_url", "reasoning.encrypted_content", "message.output_text.logprobs", "code_interpreter_call.outputs", "web_search_call.action.sources"]>;
|
|
13
|
+
/**
|
|
14
|
+
* Type of optional `include` values accepted by OpenAI Responses requests.
|
|
15
|
+
*
|
|
16
|
+
* @category models
|
|
17
|
+
* @since 4.0.0
|
|
18
|
+
*/
|
|
19
|
+
export type IncludeEnum = typeof IncludeEnum.Type;
|
|
20
|
+
/**
|
|
21
|
+
* Schema for lifecycle statuses shared by messages, reasoning items, and tool calls.
|
|
22
|
+
*
|
|
23
|
+
* @category schemas
|
|
24
|
+
* @since 4.0.0
|
|
25
|
+
*/
|
|
26
|
+
export declare const MessageStatus: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
27
|
+
/**
|
|
28
|
+
* Lifecycle status shared by messages, reasoning items, and tool calls.
|
|
29
|
+
*
|
|
30
|
+
* @category models
|
|
31
|
+
* @since 4.0.0
|
|
32
|
+
*/
|
|
33
|
+
export type MessageStatus = typeof MessageStatus.Type;
|
|
34
|
+
/**
|
|
35
|
+
* Schema for content blocks accepted in OpenAI Responses input messages.
|
|
36
|
+
*
|
|
37
|
+
* @category schemas
|
|
38
|
+
* @since 4.0.0
|
|
39
|
+
*/
|
|
40
|
+
export declare const InputContent: Schema.Union<readonly [Schema.Struct<{
|
|
41
|
+
readonly type: Schema.Literal<"input_text">;
|
|
42
|
+
readonly text: Schema.String;
|
|
43
|
+
}>, Schema.Struct<{
|
|
44
|
+
readonly type: Schema.Literal<"input_image">;
|
|
45
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
46
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
47
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
48
|
+
}>, Schema.Struct<{
|
|
49
|
+
readonly type: Schema.Literal<"input_file">;
|
|
50
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
51
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
52
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
53
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
54
|
+
}>]>;
|
|
55
|
+
/**
|
|
56
|
+
* Content block accepted in OpenAI Responses input messages.
|
|
57
|
+
*
|
|
58
|
+
* @category models
|
|
59
|
+
* @since 4.0.0
|
|
60
|
+
*/
|
|
61
|
+
export type InputContent = typeof InputContent.Type;
|
|
62
|
+
/**
|
|
63
|
+
* Schema for a text block containing a model-provided reasoning summary.
|
|
64
|
+
*
|
|
65
|
+
* @category schemas
|
|
66
|
+
* @since 4.0.0
|
|
67
|
+
*/
|
|
68
|
+
export declare const SummaryTextContent: Schema.Struct<{
|
|
69
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
70
|
+
readonly text: Schema.String;
|
|
71
|
+
}>;
|
|
72
|
+
/**
|
|
73
|
+
* Text content block used for model-provided reasoning summaries.
|
|
74
|
+
*
|
|
75
|
+
* @category models
|
|
76
|
+
* @since 4.0.0
|
|
77
|
+
*/
|
|
78
|
+
export type SummaryTextContent = typeof SummaryTextContent.Type;
|
|
79
|
+
/**
|
|
80
|
+
* Schema for citation and file-path annotations attached to output text content.
|
|
81
|
+
*
|
|
82
|
+
* @category schemas
|
|
83
|
+
* @since 4.0.0
|
|
84
|
+
*/
|
|
85
|
+
export declare const Annotation: Schema.Union<readonly [Schema.Struct<{
|
|
86
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
87
|
+
readonly file_id: Schema.String;
|
|
88
|
+
readonly index: Schema.Number;
|
|
89
|
+
readonly filename: Schema.String;
|
|
90
|
+
}>, Schema.Struct<{
|
|
91
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
92
|
+
readonly url: Schema.String;
|
|
93
|
+
readonly start_index: Schema.Number;
|
|
94
|
+
readonly end_index: Schema.Number;
|
|
95
|
+
readonly title: Schema.String;
|
|
96
|
+
}>, Schema.Struct<{
|
|
97
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
98
|
+
readonly container_id: Schema.String;
|
|
99
|
+
readonly file_id: Schema.String;
|
|
100
|
+
readonly start_index: Schema.Number;
|
|
101
|
+
readonly end_index: Schema.Number;
|
|
102
|
+
readonly filename: Schema.String;
|
|
103
|
+
}>, Schema.Struct<{
|
|
104
|
+
readonly type: Schema.Literal<"file_path">;
|
|
105
|
+
readonly file_id: Schema.String;
|
|
106
|
+
readonly index: Schema.Number;
|
|
107
|
+
}>]>;
|
|
108
|
+
/**
|
|
109
|
+
* Citation or file-path annotation attached to output text content.
|
|
110
|
+
*
|
|
111
|
+
* @category models
|
|
112
|
+
* @since 4.0.0
|
|
113
|
+
*/
|
|
114
|
+
export type Annotation = typeof Annotation.Type;
|
|
115
|
+
/**
|
|
116
|
+
* Schema for a reasoning output item containing encrypted content, summaries, and optional reasoning text.
|
|
117
|
+
*
|
|
118
|
+
* @category schemas
|
|
119
|
+
* @since 4.0.0
|
|
120
|
+
*/
|
|
121
|
+
export declare const ReasoningItem: Schema.Struct<{
|
|
122
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
123
|
+
readonly id: Schema.String;
|
|
124
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
125
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
126
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
127
|
+
readonly text: Schema.String;
|
|
128
|
+
}>>;
|
|
129
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
130
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
131
|
+
readonly text: Schema.String;
|
|
132
|
+
}>>>;
|
|
133
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
134
|
+
}>;
|
|
135
|
+
/**
|
|
136
|
+
* Reasoning output item containing encrypted content, summaries, and optional reasoning text.
|
|
137
|
+
*
|
|
138
|
+
* @category models
|
|
139
|
+
* @since 4.0.0
|
|
140
|
+
*/
|
|
141
|
+
export type ReasoningItem = typeof ReasoningItem.Type;
|
|
142
|
+
/**
|
|
143
|
+
* Schema for item shapes accepted by an OpenAI Responses request `input` field.
|
|
144
|
+
*
|
|
145
|
+
* @category schemas
|
|
146
|
+
* @since 4.0.0
|
|
147
|
+
*/
|
|
148
|
+
export declare const InputItem: Schema.Union<readonly [Schema.Struct<{
|
|
149
|
+
readonly type: Schema.optionalKey<Schema.Literal<"message">>;
|
|
150
|
+
readonly role: Schema.Literals<readonly ["system", "developer", "user", "assistant"]>;
|
|
151
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
152
|
+
readonly content: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
153
|
+
readonly type: Schema.Literal<"input_text">;
|
|
154
|
+
readonly text: Schema.String;
|
|
155
|
+
}>, Schema.Struct<{
|
|
156
|
+
readonly type: Schema.Literal<"input_image">;
|
|
157
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
158
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
159
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
160
|
+
}>, Schema.Struct<{
|
|
161
|
+
readonly type: Schema.Literal<"input_file">;
|
|
162
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
163
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
164
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
165
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
166
|
+
}>]>>]>;
|
|
167
|
+
}>, Schema.Struct<{
|
|
168
|
+
readonly id: Schema.String;
|
|
169
|
+
readonly type: Schema.Literal<"message">;
|
|
170
|
+
readonly role: Schema.Literal<"assistant">;
|
|
171
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
172
|
+
readonly type: Schema.Literal<"input_text">;
|
|
173
|
+
readonly text: Schema.String;
|
|
174
|
+
}>, Schema.Struct<{
|
|
175
|
+
readonly type: Schema.Literal<"output_text">;
|
|
176
|
+
readonly text: Schema.String;
|
|
177
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
178
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
179
|
+
readonly file_id: Schema.String;
|
|
180
|
+
readonly index: Schema.Number;
|
|
181
|
+
readonly filename: Schema.String;
|
|
182
|
+
}>, Schema.Struct<{
|
|
183
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
184
|
+
readonly url: Schema.String;
|
|
185
|
+
readonly start_index: Schema.Number;
|
|
186
|
+
readonly end_index: Schema.Number;
|
|
187
|
+
readonly title: Schema.String;
|
|
188
|
+
}>, Schema.Struct<{
|
|
189
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
190
|
+
readonly container_id: Schema.String;
|
|
191
|
+
readonly file_id: Schema.String;
|
|
192
|
+
readonly start_index: Schema.Number;
|
|
193
|
+
readonly end_index: Schema.Number;
|
|
194
|
+
readonly filename: Schema.String;
|
|
195
|
+
}>, Schema.Struct<{
|
|
196
|
+
readonly type: Schema.Literal<"file_path">;
|
|
197
|
+
readonly file_id: Schema.String;
|
|
198
|
+
readonly index: Schema.Number;
|
|
199
|
+
}>]>>;
|
|
200
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
201
|
+
}>, Schema.Struct<{
|
|
202
|
+
readonly type: Schema.Literal<"text">;
|
|
203
|
+
readonly text: Schema.String;
|
|
204
|
+
}>, Schema.Struct<{
|
|
205
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
206
|
+
readonly text: Schema.String;
|
|
207
|
+
}>, Schema.Struct<{
|
|
208
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
209
|
+
readonly text: Schema.String;
|
|
210
|
+
}>, Schema.Struct<{
|
|
211
|
+
readonly type: Schema.Literal<"refusal">;
|
|
212
|
+
readonly refusal: Schema.String;
|
|
213
|
+
}>, Schema.Struct<{
|
|
214
|
+
readonly type: Schema.Literal<"input_image">;
|
|
215
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
216
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
217
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
218
|
+
}>, Schema.Struct<{
|
|
219
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
220
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
221
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
222
|
+
}>, Schema.Struct<{
|
|
223
|
+
readonly type: Schema.Literal<"input_file">;
|
|
224
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
225
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
226
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
227
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
228
|
+
}>]>>;
|
|
229
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
230
|
+
}>, Schema.Struct<{
|
|
231
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
232
|
+
readonly type: Schema.Literal<"function_call">;
|
|
233
|
+
readonly call_id: Schema.String;
|
|
234
|
+
readonly name: Schema.String;
|
|
235
|
+
readonly arguments: Schema.String;
|
|
236
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
237
|
+
}>, Schema.Struct<{
|
|
238
|
+
readonly id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
239
|
+
readonly type: Schema.Literal<"function_call_output">;
|
|
240
|
+
readonly call_id: Schema.String;
|
|
241
|
+
readonly output: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
242
|
+
readonly type: Schema.Literal<"input_text">;
|
|
243
|
+
readonly text: Schema.String;
|
|
244
|
+
}>, Schema.Struct<{
|
|
245
|
+
readonly type: Schema.Literal<"input_image">;
|
|
246
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
247
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
248
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
249
|
+
}>, Schema.Struct<{
|
|
250
|
+
readonly type: Schema.Literal<"input_file">;
|
|
251
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
252
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
253
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
254
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
255
|
+
}>]>>]>;
|
|
256
|
+
readonly status: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>>;
|
|
257
|
+
}>, Schema.Struct<{
|
|
258
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
259
|
+
readonly id: Schema.String;
|
|
260
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
261
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
262
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
263
|
+
readonly text: Schema.String;
|
|
264
|
+
}>>;
|
|
265
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
266
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
267
|
+
readonly text: Schema.String;
|
|
268
|
+
}>>>;
|
|
269
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
270
|
+
}>, Schema.Struct<{
|
|
271
|
+
readonly type: Schema.Literal<"item_reference">;
|
|
272
|
+
readonly id: Schema.String;
|
|
273
|
+
}>, Schema.Struct<{
|
|
274
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
275
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
276
|
+
readonly call_id: Schema.String;
|
|
277
|
+
readonly action: Schema.Unknown;
|
|
278
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
279
|
+
}>, Schema.Struct<{
|
|
280
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
281
|
+
readonly type: Schema.Literal<"local_shell_call_output">;
|
|
282
|
+
readonly call_id: Schema.String;
|
|
283
|
+
readonly output: Schema.Unknown;
|
|
284
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
285
|
+
}>, Schema.Struct<{
|
|
286
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
287
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
288
|
+
readonly call_id: Schema.String;
|
|
289
|
+
readonly action: Schema.Unknown;
|
|
290
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
291
|
+
}>, Schema.Struct<{
|
|
292
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
293
|
+
readonly type: Schema.Literal<"shell_call_output">;
|
|
294
|
+
readonly call_id: Schema.String;
|
|
295
|
+
readonly output: Schema.Unknown;
|
|
296
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
297
|
+
}>, Schema.Struct<{
|
|
298
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
299
|
+
readonly type: Schema.Literal<"apply_patch_call_output">;
|
|
300
|
+
readonly call_id: Schema.String;
|
|
301
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
302
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
303
|
+
}>, Schema.Struct<{
|
|
304
|
+
readonly type: Schema.Literal<"mcp_approval_response">;
|
|
305
|
+
readonly approval_request_id: Schema.String;
|
|
306
|
+
readonly approve: Schema.Boolean;
|
|
307
|
+
}>]>;
|
|
308
|
+
/**
|
|
309
|
+
* Item shape accepted by an OpenAI Responses request `input` field.
|
|
310
|
+
*
|
|
311
|
+
* @category models
|
|
312
|
+
* @since 4.0.0
|
|
313
|
+
*/
|
|
314
|
+
export type InputItem = typeof InputItem.Type;
|
|
315
|
+
/**
|
|
316
|
+
* Schema for tool definitions that can be supplied to an OpenAI Responses request.
|
|
317
|
+
*
|
|
318
|
+
* @category schemas
|
|
319
|
+
* @since 4.0.0
|
|
320
|
+
*/
|
|
321
|
+
export declare const Tool: Schema.Union<readonly [Schema.Struct<{
|
|
322
|
+
readonly type: Schema.Literal<"function">;
|
|
323
|
+
readonly name: Schema.String;
|
|
324
|
+
readonly description: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
325
|
+
readonly parameters: Schema.optionalKey<Schema.NullOr<Schema.$Record<Schema.String, Schema.Unknown>>>;
|
|
326
|
+
readonly strict: Schema.optionalKey<Schema.NullOr<Schema.Boolean>>;
|
|
327
|
+
}>, Schema.Struct<{
|
|
328
|
+
readonly type: Schema.Literal<"custom">;
|
|
329
|
+
readonly name: Schema.String;
|
|
330
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
331
|
+
readonly format: Schema.optionalKey<Schema.Unknown>;
|
|
332
|
+
}>, Schema.StructWithRest<Schema.Struct<{
|
|
333
|
+
readonly type: Schema.Literals<readonly ["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"]>;
|
|
334
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>]>;
|
|
335
|
+
/**
|
|
336
|
+
* Tool definition that can be supplied to an OpenAI Responses request.
|
|
337
|
+
*
|
|
338
|
+
* @category models
|
|
339
|
+
* @since 4.0.0
|
|
340
|
+
*/
|
|
341
|
+
export type Tool = typeof Tool.Type;
|
|
342
|
+
/**
|
|
343
|
+
* Schema for selecting whether and which tools the model may call in a Responses request.
|
|
344
|
+
*
|
|
345
|
+
* @category schemas
|
|
346
|
+
* @since 4.0.0
|
|
347
|
+
*/
|
|
348
|
+
export declare const ToolChoice: Schema.Union<readonly [Schema.Literals<readonly ["none", "auto", "required"]>, Schema.Struct<{
|
|
349
|
+
readonly type: Schema.Literal<"allowed_tools">;
|
|
350
|
+
readonly mode: Schema.Literals<readonly ["auto", "required"]>;
|
|
351
|
+
readonly tools: Schema.$Array<Schema.$Record<Schema.String, Schema.Unknown>>;
|
|
352
|
+
}>, Schema.Struct<{
|
|
353
|
+
readonly type: Schema.Literal<"function">;
|
|
354
|
+
readonly name: Schema.String;
|
|
355
|
+
}>, Schema.Struct<{
|
|
356
|
+
readonly type: Schema.Literal<"custom">;
|
|
357
|
+
readonly name: Schema.String;
|
|
358
|
+
}>, Schema.StructWithRest<Schema.Struct<{
|
|
359
|
+
readonly type: Schema.Literals<readonly ["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"]>;
|
|
360
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>]>;
|
|
361
|
+
/**
|
|
362
|
+
* Tool selection mode or named tool choice for a Responses request.
|
|
363
|
+
*
|
|
364
|
+
* @category models
|
|
365
|
+
* @since 4.0.0
|
|
366
|
+
*/
|
|
367
|
+
export type ToolChoice = typeof ToolChoice.Type;
|
|
368
|
+
/**
|
|
369
|
+
* Schema for text output format configuration, including plain text, JSON object, and JSON Schema responses.
|
|
370
|
+
*
|
|
371
|
+
* @category schemas
|
|
372
|
+
* @since 4.0.0
|
|
373
|
+
*/
|
|
374
|
+
export declare const TextResponseFormatConfiguration: Schema.Union<readonly [Schema.Struct<{
|
|
375
|
+
readonly type: Schema.Literal<"text">;
|
|
376
|
+
}>, Schema.Struct<{
|
|
377
|
+
readonly type: Schema.Literal<"json_schema">;
|
|
378
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
379
|
+
readonly name: Schema.String;
|
|
380
|
+
readonly schema: Schema.$Record<Schema.String, Schema.Unknown>;
|
|
381
|
+
readonly strict: Schema.optionalKey<Schema.NullOr<Schema.Boolean>>;
|
|
382
|
+
}>, Schema.Struct<{
|
|
383
|
+
readonly type: Schema.Literal<"json_object">;
|
|
384
|
+
}>]>;
|
|
385
|
+
/**
|
|
386
|
+
* Text output format configuration for plain text, JSON object, or JSON Schema responses.
|
|
387
|
+
*
|
|
388
|
+
* @category models
|
|
389
|
+
* @since 4.0.0
|
|
390
|
+
*/
|
|
391
|
+
export type TextResponseFormatConfiguration = typeof TextResponseFormatConfiguration.Type;
|
|
392
|
+
/**
|
|
393
|
+
* Schema for request options used to create an OpenAI Responses API response.
|
|
394
|
+
*
|
|
395
|
+
* @category schemas
|
|
396
|
+
* @since 4.0.0
|
|
397
|
+
*/
|
|
398
|
+
export declare const CreateResponse: Schema.Struct<{
|
|
399
|
+
readonly metadata: Schema.optional<Schema.$Record<Schema.String, Schema.String>>;
|
|
400
|
+
readonly top_logprobs: Schema.optional<Schema.Number>;
|
|
401
|
+
readonly temperature: Schema.optional<Schema.Number>;
|
|
402
|
+
readonly top_p: Schema.optional<Schema.Number>;
|
|
403
|
+
readonly user: Schema.optional<Schema.String>;
|
|
404
|
+
readonly service_tier: Schema.optional<Schema.String>;
|
|
405
|
+
readonly previous_response_id: Schema.optional<Schema.String>;
|
|
406
|
+
readonly model: Schema.optional<Schema.String>;
|
|
407
|
+
readonly reasoning: Schema.optional<Schema.Struct<{
|
|
408
|
+
readonly effort: Schema.optional<Schema.Literals<readonly ["none", "minimal", "low", "medium", "high", "xhigh"]>>;
|
|
409
|
+
readonly summary: Schema.optional<Schema.Literals<readonly ["auto", "concise", "detailed"]>>;
|
|
410
|
+
readonly generate_summary: Schema.optional<Schema.Literals<readonly ["auto", "concise", "detailed"]>>;
|
|
411
|
+
}>>;
|
|
412
|
+
readonly background: Schema.optional<Schema.Boolean>;
|
|
413
|
+
readonly max_output_tokens: Schema.optional<Schema.Number>;
|
|
414
|
+
readonly max_tool_calls: Schema.optional<Schema.Number>;
|
|
415
|
+
readonly text: Schema.optional<Schema.Struct<{
|
|
416
|
+
readonly format: Schema.optional<Schema.Union<readonly [Schema.Struct<{
|
|
417
|
+
readonly type: Schema.Literal<"text">;
|
|
418
|
+
}>, Schema.Struct<{
|
|
419
|
+
readonly type: Schema.Literal<"json_schema">;
|
|
420
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
421
|
+
readonly name: Schema.String;
|
|
422
|
+
readonly schema: Schema.$Record<Schema.String, Schema.Unknown>;
|
|
423
|
+
readonly strict: Schema.optionalKey<Schema.NullOr<Schema.Boolean>>;
|
|
424
|
+
}>, Schema.Struct<{
|
|
425
|
+
readonly type: Schema.Literal<"json_object">;
|
|
426
|
+
}>]>>;
|
|
427
|
+
readonly verbosity: Schema.optional<Schema.Literals<readonly ["low", "medium", "high"]>>;
|
|
428
|
+
}>>;
|
|
429
|
+
readonly tools: Schema.optional<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
430
|
+
readonly type: Schema.Literal<"function">;
|
|
431
|
+
readonly name: Schema.String;
|
|
432
|
+
readonly description: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
433
|
+
readonly parameters: Schema.optionalKey<Schema.NullOr<Schema.$Record<Schema.String, Schema.Unknown>>>;
|
|
434
|
+
readonly strict: Schema.optionalKey<Schema.NullOr<Schema.Boolean>>;
|
|
435
|
+
}>, Schema.Struct<{
|
|
436
|
+
readonly type: Schema.Literal<"custom">;
|
|
437
|
+
readonly name: Schema.String;
|
|
438
|
+
readonly description: Schema.optionalKey<Schema.String>;
|
|
439
|
+
readonly format: Schema.optionalKey<Schema.Unknown>;
|
|
440
|
+
}>, Schema.StructWithRest<Schema.Struct<{
|
|
441
|
+
readonly type: Schema.Literals<readonly ["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"]>;
|
|
442
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>]>>>;
|
|
443
|
+
readonly tool_choice: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly ["none", "auto", "required"]>, Schema.Struct<{
|
|
444
|
+
readonly type: Schema.Literal<"allowed_tools">;
|
|
445
|
+
readonly mode: Schema.Literals<readonly ["auto", "required"]>;
|
|
446
|
+
readonly tools: Schema.$Array<Schema.$Record<Schema.String, Schema.Unknown>>;
|
|
447
|
+
}>, Schema.Struct<{
|
|
448
|
+
readonly type: Schema.Literal<"function">;
|
|
449
|
+
readonly name: Schema.String;
|
|
450
|
+
}>, Schema.Struct<{
|
|
451
|
+
readonly type: Schema.Literal<"custom">;
|
|
452
|
+
readonly name: Schema.String;
|
|
453
|
+
}>, Schema.StructWithRest<Schema.Struct<{
|
|
454
|
+
readonly type: Schema.Literals<readonly ["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"]>;
|
|
455
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>]>>;
|
|
456
|
+
readonly truncation: Schema.optional<Schema.Literals<readonly ["auto", "disabled"]>>;
|
|
457
|
+
readonly input: Schema.optional<Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
458
|
+
readonly type: Schema.optionalKey<Schema.Literal<"message">>;
|
|
459
|
+
readonly role: Schema.Literals<readonly ["system", "developer", "user", "assistant"]>;
|
|
460
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
461
|
+
readonly content: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
462
|
+
readonly type: Schema.Literal<"input_text">;
|
|
463
|
+
readonly text: Schema.String;
|
|
464
|
+
}>, Schema.Struct<{
|
|
465
|
+
readonly type: Schema.Literal<"input_image">;
|
|
466
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
467
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
468
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
469
|
+
}>, Schema.Struct<{
|
|
470
|
+
readonly type: Schema.Literal<"input_file">;
|
|
471
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
472
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
473
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
474
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
475
|
+
}>]>>]>;
|
|
476
|
+
}>, Schema.Struct<{
|
|
477
|
+
readonly id: Schema.String;
|
|
478
|
+
readonly type: Schema.Literal<"message">;
|
|
479
|
+
readonly role: Schema.Literal<"assistant">;
|
|
480
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
481
|
+
readonly type: Schema.Literal<"input_text">;
|
|
482
|
+
readonly text: Schema.String;
|
|
483
|
+
}>, Schema.Struct<{
|
|
484
|
+
readonly type: Schema.Literal<"output_text">;
|
|
485
|
+
readonly text: Schema.String;
|
|
486
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
487
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
488
|
+
readonly file_id: Schema.String;
|
|
489
|
+
readonly index: Schema.Number;
|
|
490
|
+
readonly filename: Schema.String;
|
|
491
|
+
}>, Schema.Struct<{
|
|
492
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
493
|
+
readonly url: Schema.String;
|
|
494
|
+
readonly start_index: Schema.Number;
|
|
495
|
+
readonly end_index: Schema.Number;
|
|
496
|
+
readonly title: Schema.String;
|
|
497
|
+
}>, Schema.Struct<{
|
|
498
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
499
|
+
readonly container_id: Schema.String;
|
|
500
|
+
readonly file_id: Schema.String;
|
|
501
|
+
readonly start_index: Schema.Number;
|
|
502
|
+
readonly end_index: Schema.Number;
|
|
503
|
+
readonly filename: Schema.String;
|
|
504
|
+
}>, Schema.Struct<{
|
|
505
|
+
readonly type: Schema.Literal<"file_path">;
|
|
506
|
+
readonly file_id: Schema.String;
|
|
507
|
+
readonly index: Schema.Number;
|
|
508
|
+
}>]>>;
|
|
509
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
510
|
+
}>, Schema.Struct<{
|
|
511
|
+
readonly type: Schema.Literal<"text">;
|
|
512
|
+
readonly text: Schema.String;
|
|
513
|
+
}>, Schema.Struct<{
|
|
514
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
515
|
+
readonly text: Schema.String;
|
|
516
|
+
}>, Schema.Struct<{
|
|
517
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
518
|
+
readonly text: Schema.String;
|
|
519
|
+
}>, Schema.Struct<{
|
|
520
|
+
readonly type: Schema.Literal<"refusal">;
|
|
521
|
+
readonly refusal: Schema.String;
|
|
522
|
+
}>, Schema.Struct<{
|
|
523
|
+
readonly type: Schema.Literal<"input_image">;
|
|
524
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
525
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
526
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
527
|
+
}>, Schema.Struct<{
|
|
528
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
529
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
530
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
531
|
+
}>, Schema.Struct<{
|
|
532
|
+
readonly type: Schema.Literal<"input_file">;
|
|
533
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
534
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
535
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
536
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
537
|
+
}>]>>;
|
|
538
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
539
|
+
}>, Schema.Struct<{
|
|
540
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
541
|
+
readonly type: Schema.Literal<"function_call">;
|
|
542
|
+
readonly call_id: Schema.String;
|
|
543
|
+
readonly name: Schema.String;
|
|
544
|
+
readonly arguments: Schema.String;
|
|
545
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
546
|
+
}>, Schema.Struct<{
|
|
547
|
+
readonly id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
548
|
+
readonly type: Schema.Literal<"function_call_output">;
|
|
549
|
+
readonly call_id: Schema.String;
|
|
550
|
+
readonly output: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
551
|
+
readonly type: Schema.Literal<"input_text">;
|
|
552
|
+
readonly text: Schema.String;
|
|
553
|
+
}>, Schema.Struct<{
|
|
554
|
+
readonly type: Schema.Literal<"input_image">;
|
|
555
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
556
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
557
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
558
|
+
}>, Schema.Struct<{
|
|
559
|
+
readonly type: Schema.Literal<"input_file">;
|
|
560
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
561
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
562
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
563
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
564
|
+
}>]>>]>;
|
|
565
|
+
readonly status: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>>;
|
|
566
|
+
}>, Schema.Struct<{
|
|
567
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
568
|
+
readonly id: Schema.String;
|
|
569
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
570
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
571
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
572
|
+
readonly text: Schema.String;
|
|
573
|
+
}>>;
|
|
574
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
575
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
576
|
+
readonly text: Schema.String;
|
|
577
|
+
}>>>;
|
|
578
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
579
|
+
}>, Schema.Struct<{
|
|
580
|
+
readonly type: Schema.Literal<"item_reference">;
|
|
581
|
+
readonly id: Schema.String;
|
|
582
|
+
}>, Schema.Struct<{
|
|
583
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
584
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
585
|
+
readonly call_id: Schema.String;
|
|
586
|
+
readonly action: Schema.Unknown;
|
|
587
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
588
|
+
}>, Schema.Struct<{
|
|
589
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
590
|
+
readonly type: Schema.Literal<"local_shell_call_output">;
|
|
591
|
+
readonly call_id: Schema.String;
|
|
592
|
+
readonly output: Schema.Unknown;
|
|
593
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
594
|
+
}>, Schema.Struct<{
|
|
595
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
596
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
597
|
+
readonly call_id: Schema.String;
|
|
598
|
+
readonly action: Schema.Unknown;
|
|
599
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
600
|
+
}>, Schema.Struct<{
|
|
601
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
602
|
+
readonly type: Schema.Literal<"shell_call_output">;
|
|
603
|
+
readonly call_id: Schema.String;
|
|
604
|
+
readonly output: Schema.Unknown;
|
|
605
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
606
|
+
}>, Schema.Struct<{
|
|
607
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
608
|
+
readonly type: Schema.Literal<"apply_patch_call_output">;
|
|
609
|
+
readonly call_id: Schema.String;
|
|
610
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
611
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
612
|
+
}>, Schema.Struct<{
|
|
613
|
+
readonly type: Schema.Literal<"mcp_approval_response">;
|
|
614
|
+
readonly approval_request_id: Schema.String;
|
|
615
|
+
readonly approve: Schema.Boolean;
|
|
616
|
+
}>]>>]>>;
|
|
617
|
+
readonly include: Schema.optional<Schema.$Array<Schema.Literals<readonly ["message.input_image.image_url", "reasoning.encrypted_content", "message.output_text.logprobs", "code_interpreter_call.outputs", "web_search_call.action.sources"]>>>;
|
|
618
|
+
readonly store: Schema.optional<Schema.Boolean>;
|
|
619
|
+
readonly instructions: Schema.optional<Schema.String>;
|
|
620
|
+
readonly stream: Schema.optional<Schema.Boolean>;
|
|
621
|
+
readonly conversation: Schema.optional<Schema.String>;
|
|
622
|
+
readonly modalities: Schema.optional<Schema.$Array<Schema.Literals<readonly ["text", "audio"]>>>;
|
|
623
|
+
readonly seed: Schema.optional<Schema.Number>;
|
|
624
|
+
}>;
|
|
625
|
+
/**
|
|
626
|
+
* Request options used to create an OpenAI Responses API response.
|
|
627
|
+
*
|
|
628
|
+
* @category models
|
|
629
|
+
* @since 4.0.0
|
|
630
|
+
*/
|
|
631
|
+
export type CreateResponse = typeof CreateResponse.Type;
|
|
632
|
+
/**
|
|
633
|
+
* Schema for token accounting reported on OpenAI Responses API response objects.
|
|
634
|
+
*
|
|
635
|
+
* @category schemas
|
|
636
|
+
* @since 4.0.0
|
|
637
|
+
*/
|
|
638
|
+
export declare const ResponseUsage: Schema.StructWithRest<Schema.Struct<{
|
|
639
|
+
readonly input_tokens: Schema.Number;
|
|
640
|
+
readonly output_tokens: Schema.Number;
|
|
641
|
+
readonly total_tokens: Schema.Number;
|
|
642
|
+
readonly input_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
643
|
+
readonly output_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
644
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>;
|
|
645
|
+
/**
|
|
646
|
+
* Token accounting reported on OpenAI Responses API response objects.
|
|
647
|
+
*
|
|
648
|
+
* @category models
|
|
649
|
+
* @since 4.0.0
|
|
650
|
+
*/
|
|
651
|
+
export type ResponseUsage = typeof ResponseUsage.Type;
|
|
652
|
+
/**
|
|
653
|
+
* Schema for an OpenAI Responses API response object.
|
|
654
|
+
*
|
|
655
|
+
* @category schemas
|
|
656
|
+
* @since 4.0.0
|
|
657
|
+
*/
|
|
658
|
+
export declare const Response: Schema.Struct<{
|
|
659
|
+
readonly id: Schema.String;
|
|
660
|
+
readonly object: Schema.optionalKey<Schema.Literal<"response">>;
|
|
661
|
+
readonly model: Schema.String;
|
|
662
|
+
readonly created_at: Schema.Number;
|
|
663
|
+
readonly output: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
664
|
+
readonly id: Schema.String;
|
|
665
|
+
readonly type: Schema.Literal<"apply_patch_call">;
|
|
666
|
+
readonly call_id: Schema.String;
|
|
667
|
+
readonly operation: Schema.Struct<{
|
|
668
|
+
readonly type: Schema.String;
|
|
669
|
+
readonly path: Schema.String;
|
|
670
|
+
readonly diff: Schema.optionalKey<Schema.String>;
|
|
671
|
+
}>;
|
|
672
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
673
|
+
}>, Schema.Struct<{
|
|
674
|
+
readonly id: Schema.String;
|
|
675
|
+
readonly type: Schema.Literal<"code_interpreter_call">;
|
|
676
|
+
readonly code: Schema.optionalKey<Schema.String>;
|
|
677
|
+
readonly container_id: Schema.String;
|
|
678
|
+
readonly outputs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
679
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
680
|
+
}>, Schema.Struct<{
|
|
681
|
+
readonly id: Schema.String;
|
|
682
|
+
readonly type: Schema.Literal<"computer_call">;
|
|
683
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
684
|
+
}>, Schema.Struct<{
|
|
685
|
+
readonly id: Schema.String;
|
|
686
|
+
readonly type: Schema.Literal<"file_search_call">;
|
|
687
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
688
|
+
readonly queries: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
689
|
+
readonly results: Schema.optionalKey<Schema.NullOr<Schema.Unknown>>;
|
|
690
|
+
}>, Schema.Struct<{
|
|
691
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
692
|
+
readonly type: Schema.Literal<"function_call">;
|
|
693
|
+
readonly call_id: Schema.String;
|
|
694
|
+
readonly name: Schema.String;
|
|
695
|
+
readonly arguments: Schema.String;
|
|
696
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
697
|
+
}>, Schema.Struct<{
|
|
698
|
+
readonly id: Schema.String;
|
|
699
|
+
readonly type: Schema.Literal<"image_generation_call">;
|
|
700
|
+
readonly result: Schema.optionalKey<Schema.String>;
|
|
701
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
702
|
+
}>, Schema.Struct<{
|
|
703
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
704
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
705
|
+
readonly call_id: Schema.String;
|
|
706
|
+
readonly action: Schema.Unknown;
|
|
707
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
708
|
+
}>, Schema.Struct<{
|
|
709
|
+
readonly id: Schema.String;
|
|
710
|
+
readonly type: Schema.Literal<"mcp_call">;
|
|
711
|
+
readonly approval_request_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
712
|
+
readonly name: Schema.String;
|
|
713
|
+
readonly arguments: Schema.Unknown;
|
|
714
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
715
|
+
readonly error: Schema.optionalKey<Schema.Unknown>;
|
|
716
|
+
readonly server_label: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
717
|
+
}>, Schema.Struct<{
|
|
718
|
+
readonly id: Schema.String;
|
|
719
|
+
readonly type: Schema.Literal<"mcp_list_tools">;
|
|
720
|
+
}>, Schema.Struct<{
|
|
721
|
+
readonly id: Schema.String;
|
|
722
|
+
readonly type: Schema.Literal<"mcp_approval_request">;
|
|
723
|
+
readonly approval_request_id: Schema.optionalKey<Schema.String>;
|
|
724
|
+
readonly name: Schema.String;
|
|
725
|
+
readonly arguments: Schema.Unknown;
|
|
726
|
+
}>, Schema.Struct<{
|
|
727
|
+
readonly id: Schema.String;
|
|
728
|
+
readonly type: Schema.Literal<"message">;
|
|
729
|
+
readonly role: Schema.Literal<"assistant">;
|
|
730
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
731
|
+
readonly type: Schema.Literal<"input_text">;
|
|
732
|
+
readonly text: Schema.String;
|
|
733
|
+
}>, Schema.Struct<{
|
|
734
|
+
readonly type: Schema.Literal<"output_text">;
|
|
735
|
+
readonly text: Schema.String;
|
|
736
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
737
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
738
|
+
readonly file_id: Schema.String;
|
|
739
|
+
readonly index: Schema.Number;
|
|
740
|
+
readonly filename: Schema.String;
|
|
741
|
+
}>, Schema.Struct<{
|
|
742
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
743
|
+
readonly url: Schema.String;
|
|
744
|
+
readonly start_index: Schema.Number;
|
|
745
|
+
readonly end_index: Schema.Number;
|
|
746
|
+
readonly title: Schema.String;
|
|
747
|
+
}>, Schema.Struct<{
|
|
748
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
749
|
+
readonly container_id: Schema.String;
|
|
750
|
+
readonly file_id: Schema.String;
|
|
751
|
+
readonly start_index: Schema.Number;
|
|
752
|
+
readonly end_index: Schema.Number;
|
|
753
|
+
readonly filename: Schema.String;
|
|
754
|
+
}>, Schema.Struct<{
|
|
755
|
+
readonly type: Schema.Literal<"file_path">;
|
|
756
|
+
readonly file_id: Schema.String;
|
|
757
|
+
readonly index: Schema.Number;
|
|
758
|
+
}>]>>;
|
|
759
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
760
|
+
}>, Schema.Struct<{
|
|
761
|
+
readonly type: Schema.Literal<"text">;
|
|
762
|
+
readonly text: Schema.String;
|
|
763
|
+
}>, Schema.Struct<{
|
|
764
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
765
|
+
readonly text: Schema.String;
|
|
766
|
+
}>, Schema.Struct<{
|
|
767
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
768
|
+
readonly text: Schema.String;
|
|
769
|
+
}>, Schema.Struct<{
|
|
770
|
+
readonly type: Schema.Literal<"refusal">;
|
|
771
|
+
readonly refusal: Schema.String;
|
|
772
|
+
}>, Schema.Struct<{
|
|
773
|
+
readonly type: Schema.Literal<"input_image">;
|
|
774
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
775
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
776
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
777
|
+
}>, Schema.Struct<{
|
|
778
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
779
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
780
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
781
|
+
}>, Schema.Struct<{
|
|
782
|
+
readonly type: Schema.Literal<"input_file">;
|
|
783
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
784
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
785
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
786
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
787
|
+
}>]>>;
|
|
788
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
789
|
+
}>, Schema.Struct<{
|
|
790
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
791
|
+
readonly id: Schema.String;
|
|
792
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
793
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
794
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
795
|
+
readonly text: Schema.String;
|
|
796
|
+
}>>;
|
|
797
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
798
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
799
|
+
readonly text: Schema.String;
|
|
800
|
+
}>>>;
|
|
801
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
802
|
+
}>, Schema.Struct<{
|
|
803
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
804
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
805
|
+
readonly call_id: Schema.String;
|
|
806
|
+
readonly action: Schema.Unknown;
|
|
807
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
808
|
+
}>, Schema.Struct<{
|
|
809
|
+
readonly id: Schema.String;
|
|
810
|
+
readonly type: Schema.Literal<"web_search_call">;
|
|
811
|
+
readonly action: Schema.optionalKey<Schema.Unknown>;
|
|
812
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
813
|
+
}>]>>;
|
|
814
|
+
readonly usage: Schema.optionalKey<Schema.NullOr<Schema.StructWithRest<Schema.Struct<{
|
|
815
|
+
readonly input_tokens: Schema.Number;
|
|
816
|
+
readonly output_tokens: Schema.Number;
|
|
817
|
+
readonly total_tokens: Schema.Number;
|
|
818
|
+
readonly input_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
819
|
+
readonly output_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
820
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>>>;
|
|
821
|
+
readonly incomplete_details: Schema.optionalKey<Schema.NullOr<Schema.Struct<{
|
|
822
|
+
readonly reason: Schema.optionalKey<Schema.Literals<readonly ["max_output_tokens", "content_filter"]>>;
|
|
823
|
+
}>>>;
|
|
824
|
+
readonly service_tier: Schema.optionalKey<Schema.String>;
|
|
825
|
+
}>;
|
|
826
|
+
/**
|
|
827
|
+
* OpenAI Responses API response object.
|
|
828
|
+
*
|
|
829
|
+
* @category models
|
|
830
|
+
* @since 4.0.0
|
|
831
|
+
*/
|
|
832
|
+
export type Response = typeof Response.Type;
|
|
833
|
+
/**
|
|
834
|
+
* Fallback event shape for future or provider-specific response stream events.
|
|
835
|
+
*
|
|
836
|
+
* @category models
|
|
837
|
+
* @since 4.0.0
|
|
838
|
+
*/
|
|
839
|
+
export type UnknownResponseStreamEvent = {
|
|
840
|
+
readonly type: string;
|
|
841
|
+
readonly [key: string]: unknown;
|
|
842
|
+
};
|
|
843
|
+
/**
|
|
844
|
+
* Schema for server-sent event shapes emitted by OpenAI Responses API streams.
|
|
845
|
+
*
|
|
846
|
+
* @category schemas
|
|
847
|
+
* @since 4.0.0
|
|
848
|
+
*/
|
|
849
|
+
export declare const ResponseStreamEvent: Schema.Union<readonly [Schema.Struct<{
|
|
850
|
+
readonly type: Schema.Literal<"response.created">;
|
|
851
|
+
readonly response: Schema.Struct<{
|
|
852
|
+
readonly id: Schema.String;
|
|
853
|
+
readonly object: Schema.optionalKey<Schema.Literal<"response">>;
|
|
854
|
+
readonly model: Schema.String;
|
|
855
|
+
readonly created_at: Schema.Number;
|
|
856
|
+
readonly output: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
857
|
+
readonly id: Schema.String;
|
|
858
|
+
readonly type: Schema.Literal<"apply_patch_call">;
|
|
859
|
+
readonly call_id: Schema.String;
|
|
860
|
+
readonly operation: Schema.Struct<{
|
|
861
|
+
readonly type: Schema.String;
|
|
862
|
+
readonly path: Schema.String;
|
|
863
|
+
readonly diff: Schema.optionalKey<Schema.String>;
|
|
864
|
+
}>;
|
|
865
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
866
|
+
}>, Schema.Struct<{
|
|
867
|
+
readonly id: Schema.String;
|
|
868
|
+
readonly type: Schema.Literal<"code_interpreter_call">;
|
|
869
|
+
readonly code: Schema.optionalKey<Schema.String>;
|
|
870
|
+
readonly container_id: Schema.String;
|
|
871
|
+
readonly outputs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
872
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
873
|
+
}>, Schema.Struct<{
|
|
874
|
+
readonly id: Schema.String;
|
|
875
|
+
readonly type: Schema.Literal<"computer_call">;
|
|
876
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
877
|
+
}>, Schema.Struct<{
|
|
878
|
+
readonly id: Schema.String;
|
|
879
|
+
readonly type: Schema.Literal<"file_search_call">;
|
|
880
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
881
|
+
readonly queries: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
882
|
+
readonly results: Schema.optionalKey<Schema.NullOr<Schema.Unknown>>;
|
|
883
|
+
}>, Schema.Struct<{
|
|
884
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
885
|
+
readonly type: Schema.Literal<"function_call">;
|
|
886
|
+
readonly call_id: Schema.String;
|
|
887
|
+
readonly name: Schema.String;
|
|
888
|
+
readonly arguments: Schema.String;
|
|
889
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
890
|
+
}>, Schema.Struct<{
|
|
891
|
+
readonly id: Schema.String;
|
|
892
|
+
readonly type: Schema.Literal<"image_generation_call">;
|
|
893
|
+
readonly result: Schema.optionalKey<Schema.String>;
|
|
894
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
895
|
+
}>, Schema.Struct<{
|
|
896
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
897
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
898
|
+
readonly call_id: Schema.String;
|
|
899
|
+
readonly action: Schema.Unknown;
|
|
900
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
901
|
+
}>, Schema.Struct<{
|
|
902
|
+
readonly id: Schema.String;
|
|
903
|
+
readonly type: Schema.Literal<"mcp_call">;
|
|
904
|
+
readonly approval_request_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
905
|
+
readonly name: Schema.String;
|
|
906
|
+
readonly arguments: Schema.Unknown;
|
|
907
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
908
|
+
readonly error: Schema.optionalKey<Schema.Unknown>;
|
|
909
|
+
readonly server_label: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
910
|
+
}>, Schema.Struct<{
|
|
911
|
+
readonly id: Schema.String;
|
|
912
|
+
readonly type: Schema.Literal<"mcp_list_tools">;
|
|
913
|
+
}>, Schema.Struct<{
|
|
914
|
+
readonly id: Schema.String;
|
|
915
|
+
readonly type: Schema.Literal<"mcp_approval_request">;
|
|
916
|
+
readonly approval_request_id: Schema.optionalKey<Schema.String>;
|
|
917
|
+
readonly name: Schema.String;
|
|
918
|
+
readonly arguments: Schema.Unknown;
|
|
919
|
+
}>, Schema.Struct<{
|
|
920
|
+
readonly id: Schema.String;
|
|
921
|
+
readonly type: Schema.Literal<"message">;
|
|
922
|
+
readonly role: Schema.Literal<"assistant">;
|
|
923
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
924
|
+
readonly type: Schema.Literal<"input_text">;
|
|
925
|
+
readonly text: Schema.String;
|
|
926
|
+
}>, Schema.Struct<{
|
|
927
|
+
readonly type: Schema.Literal<"output_text">;
|
|
928
|
+
readonly text: Schema.String;
|
|
929
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
930
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
931
|
+
readonly file_id: Schema.String;
|
|
932
|
+
readonly index: Schema.Number;
|
|
933
|
+
readonly filename: Schema.String;
|
|
934
|
+
}>, Schema.Struct<{
|
|
935
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
936
|
+
readonly url: Schema.String;
|
|
937
|
+
readonly start_index: Schema.Number;
|
|
938
|
+
readonly end_index: Schema.Number;
|
|
939
|
+
readonly title: Schema.String;
|
|
940
|
+
}>, Schema.Struct<{
|
|
941
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
942
|
+
readonly container_id: Schema.String;
|
|
943
|
+
readonly file_id: Schema.String;
|
|
944
|
+
readonly start_index: Schema.Number;
|
|
945
|
+
readonly end_index: Schema.Number;
|
|
946
|
+
readonly filename: Schema.String;
|
|
947
|
+
}>, Schema.Struct<{
|
|
948
|
+
readonly type: Schema.Literal<"file_path">;
|
|
949
|
+
readonly file_id: Schema.String;
|
|
950
|
+
readonly index: Schema.Number;
|
|
951
|
+
}>]>>;
|
|
952
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
953
|
+
}>, Schema.Struct<{
|
|
954
|
+
readonly type: Schema.Literal<"text">;
|
|
955
|
+
readonly text: Schema.String;
|
|
956
|
+
}>, Schema.Struct<{
|
|
957
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
958
|
+
readonly text: Schema.String;
|
|
959
|
+
}>, Schema.Struct<{
|
|
960
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
961
|
+
readonly text: Schema.String;
|
|
962
|
+
}>, Schema.Struct<{
|
|
963
|
+
readonly type: Schema.Literal<"refusal">;
|
|
964
|
+
readonly refusal: Schema.String;
|
|
965
|
+
}>, Schema.Struct<{
|
|
966
|
+
readonly type: Schema.Literal<"input_image">;
|
|
967
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
968
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
969
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
970
|
+
}>, Schema.Struct<{
|
|
971
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
972
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
973
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
974
|
+
}>, Schema.Struct<{
|
|
975
|
+
readonly type: Schema.Literal<"input_file">;
|
|
976
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
977
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
978
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
979
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
980
|
+
}>]>>;
|
|
981
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
982
|
+
}>, Schema.Struct<{
|
|
983
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
984
|
+
readonly id: Schema.String;
|
|
985
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
986
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
987
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
988
|
+
readonly text: Schema.String;
|
|
989
|
+
}>>;
|
|
990
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
991
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
992
|
+
readonly text: Schema.String;
|
|
993
|
+
}>>>;
|
|
994
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
995
|
+
}>, Schema.Struct<{
|
|
996
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
997
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
998
|
+
readonly call_id: Schema.String;
|
|
999
|
+
readonly action: Schema.Unknown;
|
|
1000
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1001
|
+
}>, Schema.Struct<{
|
|
1002
|
+
readonly id: Schema.String;
|
|
1003
|
+
readonly type: Schema.Literal<"web_search_call">;
|
|
1004
|
+
readonly action: Schema.optionalKey<Schema.Unknown>;
|
|
1005
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1006
|
+
}>]>>;
|
|
1007
|
+
readonly usage: Schema.optionalKey<Schema.NullOr<Schema.StructWithRest<Schema.Struct<{
|
|
1008
|
+
readonly input_tokens: Schema.Number;
|
|
1009
|
+
readonly output_tokens: Schema.Number;
|
|
1010
|
+
readonly total_tokens: Schema.Number;
|
|
1011
|
+
readonly input_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1012
|
+
readonly output_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1013
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>>>;
|
|
1014
|
+
readonly incomplete_details: Schema.optionalKey<Schema.NullOr<Schema.Struct<{
|
|
1015
|
+
readonly reason: Schema.optionalKey<Schema.Literals<readonly ["max_output_tokens", "content_filter"]>>;
|
|
1016
|
+
}>>>;
|
|
1017
|
+
readonly service_tier: Schema.optionalKey<Schema.String>;
|
|
1018
|
+
}>;
|
|
1019
|
+
readonly sequence_number: Schema.Number;
|
|
1020
|
+
}>, Schema.Struct<{
|
|
1021
|
+
readonly type: Schema.Literal<"response.completed">;
|
|
1022
|
+
readonly response: Schema.Struct<{
|
|
1023
|
+
readonly id: Schema.String;
|
|
1024
|
+
readonly object: Schema.optionalKey<Schema.Literal<"response">>;
|
|
1025
|
+
readonly model: Schema.String;
|
|
1026
|
+
readonly created_at: Schema.Number;
|
|
1027
|
+
readonly output: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1028
|
+
readonly id: Schema.String;
|
|
1029
|
+
readonly type: Schema.Literal<"apply_patch_call">;
|
|
1030
|
+
readonly call_id: Schema.String;
|
|
1031
|
+
readonly operation: Schema.Struct<{
|
|
1032
|
+
readonly type: Schema.String;
|
|
1033
|
+
readonly path: Schema.String;
|
|
1034
|
+
readonly diff: Schema.optionalKey<Schema.String>;
|
|
1035
|
+
}>;
|
|
1036
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1037
|
+
}>, Schema.Struct<{
|
|
1038
|
+
readonly id: Schema.String;
|
|
1039
|
+
readonly type: Schema.Literal<"code_interpreter_call">;
|
|
1040
|
+
readonly code: Schema.optionalKey<Schema.String>;
|
|
1041
|
+
readonly container_id: Schema.String;
|
|
1042
|
+
readonly outputs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1043
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1044
|
+
}>, Schema.Struct<{
|
|
1045
|
+
readonly id: Schema.String;
|
|
1046
|
+
readonly type: Schema.Literal<"computer_call">;
|
|
1047
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1048
|
+
}>, Schema.Struct<{
|
|
1049
|
+
readonly id: Schema.String;
|
|
1050
|
+
readonly type: Schema.Literal<"file_search_call">;
|
|
1051
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1052
|
+
readonly queries: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1053
|
+
readonly results: Schema.optionalKey<Schema.NullOr<Schema.Unknown>>;
|
|
1054
|
+
}>, Schema.Struct<{
|
|
1055
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1056
|
+
readonly type: Schema.Literal<"function_call">;
|
|
1057
|
+
readonly call_id: Schema.String;
|
|
1058
|
+
readonly name: Schema.String;
|
|
1059
|
+
readonly arguments: Schema.String;
|
|
1060
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1061
|
+
}>, Schema.Struct<{
|
|
1062
|
+
readonly id: Schema.String;
|
|
1063
|
+
readonly type: Schema.Literal<"image_generation_call">;
|
|
1064
|
+
readonly result: Schema.optionalKey<Schema.String>;
|
|
1065
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1066
|
+
}>, Schema.Struct<{
|
|
1067
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1068
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
1069
|
+
readonly call_id: Schema.String;
|
|
1070
|
+
readonly action: Schema.Unknown;
|
|
1071
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1072
|
+
}>, Schema.Struct<{
|
|
1073
|
+
readonly id: Schema.String;
|
|
1074
|
+
readonly type: Schema.Literal<"mcp_call">;
|
|
1075
|
+
readonly approval_request_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1076
|
+
readonly name: Schema.String;
|
|
1077
|
+
readonly arguments: Schema.Unknown;
|
|
1078
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
1079
|
+
readonly error: Schema.optionalKey<Schema.Unknown>;
|
|
1080
|
+
readonly server_label: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1081
|
+
}>, Schema.Struct<{
|
|
1082
|
+
readonly id: Schema.String;
|
|
1083
|
+
readonly type: Schema.Literal<"mcp_list_tools">;
|
|
1084
|
+
}>, Schema.Struct<{
|
|
1085
|
+
readonly id: Schema.String;
|
|
1086
|
+
readonly type: Schema.Literal<"mcp_approval_request">;
|
|
1087
|
+
readonly approval_request_id: Schema.optionalKey<Schema.String>;
|
|
1088
|
+
readonly name: Schema.String;
|
|
1089
|
+
readonly arguments: Schema.Unknown;
|
|
1090
|
+
}>, Schema.Struct<{
|
|
1091
|
+
readonly id: Schema.String;
|
|
1092
|
+
readonly type: Schema.Literal<"message">;
|
|
1093
|
+
readonly role: Schema.Literal<"assistant">;
|
|
1094
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1095
|
+
readonly type: Schema.Literal<"input_text">;
|
|
1096
|
+
readonly text: Schema.String;
|
|
1097
|
+
}>, Schema.Struct<{
|
|
1098
|
+
readonly type: Schema.Literal<"output_text">;
|
|
1099
|
+
readonly text: Schema.String;
|
|
1100
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1101
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
1102
|
+
readonly file_id: Schema.String;
|
|
1103
|
+
readonly index: Schema.Number;
|
|
1104
|
+
readonly filename: Schema.String;
|
|
1105
|
+
}>, Schema.Struct<{
|
|
1106
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
1107
|
+
readonly url: Schema.String;
|
|
1108
|
+
readonly start_index: Schema.Number;
|
|
1109
|
+
readonly end_index: Schema.Number;
|
|
1110
|
+
readonly title: Schema.String;
|
|
1111
|
+
}>, Schema.Struct<{
|
|
1112
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
1113
|
+
readonly container_id: Schema.String;
|
|
1114
|
+
readonly file_id: Schema.String;
|
|
1115
|
+
readonly start_index: Schema.Number;
|
|
1116
|
+
readonly end_index: Schema.Number;
|
|
1117
|
+
readonly filename: Schema.String;
|
|
1118
|
+
}>, Schema.Struct<{
|
|
1119
|
+
readonly type: Schema.Literal<"file_path">;
|
|
1120
|
+
readonly file_id: Schema.String;
|
|
1121
|
+
readonly index: Schema.Number;
|
|
1122
|
+
}>]>>;
|
|
1123
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1124
|
+
}>, Schema.Struct<{
|
|
1125
|
+
readonly type: Schema.Literal<"text">;
|
|
1126
|
+
readonly text: Schema.String;
|
|
1127
|
+
}>, Schema.Struct<{
|
|
1128
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1129
|
+
readonly text: Schema.String;
|
|
1130
|
+
}>, Schema.Struct<{
|
|
1131
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1132
|
+
readonly text: Schema.String;
|
|
1133
|
+
}>, Schema.Struct<{
|
|
1134
|
+
readonly type: Schema.Literal<"refusal">;
|
|
1135
|
+
readonly refusal: Schema.String;
|
|
1136
|
+
}>, Schema.Struct<{
|
|
1137
|
+
readonly type: Schema.Literal<"input_image">;
|
|
1138
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1139
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1140
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
1141
|
+
}>, Schema.Struct<{
|
|
1142
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
1143
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
1144
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
1145
|
+
}>, Schema.Struct<{
|
|
1146
|
+
readonly type: Schema.Literal<"input_file">;
|
|
1147
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1148
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
1149
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
1150
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
1151
|
+
}>]>>;
|
|
1152
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
1153
|
+
}>, Schema.Struct<{
|
|
1154
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
1155
|
+
readonly id: Schema.String;
|
|
1156
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1157
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
1158
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1159
|
+
readonly text: Schema.String;
|
|
1160
|
+
}>>;
|
|
1161
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1162
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1163
|
+
readonly text: Schema.String;
|
|
1164
|
+
}>>>;
|
|
1165
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1166
|
+
}>, Schema.Struct<{
|
|
1167
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1168
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
1169
|
+
readonly call_id: Schema.String;
|
|
1170
|
+
readonly action: Schema.Unknown;
|
|
1171
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1172
|
+
}>, Schema.Struct<{
|
|
1173
|
+
readonly id: Schema.String;
|
|
1174
|
+
readonly type: Schema.Literal<"web_search_call">;
|
|
1175
|
+
readonly action: Schema.optionalKey<Schema.Unknown>;
|
|
1176
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1177
|
+
}>]>>;
|
|
1178
|
+
readonly usage: Schema.optionalKey<Schema.NullOr<Schema.StructWithRest<Schema.Struct<{
|
|
1179
|
+
readonly input_tokens: Schema.Number;
|
|
1180
|
+
readonly output_tokens: Schema.Number;
|
|
1181
|
+
readonly total_tokens: Schema.Number;
|
|
1182
|
+
readonly input_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1183
|
+
readonly output_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1184
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>>>;
|
|
1185
|
+
readonly incomplete_details: Schema.optionalKey<Schema.NullOr<Schema.Struct<{
|
|
1186
|
+
readonly reason: Schema.optionalKey<Schema.Literals<readonly ["max_output_tokens", "content_filter"]>>;
|
|
1187
|
+
}>>>;
|
|
1188
|
+
readonly service_tier: Schema.optionalKey<Schema.String>;
|
|
1189
|
+
}>;
|
|
1190
|
+
readonly sequence_number: Schema.Number;
|
|
1191
|
+
}>, Schema.Struct<{
|
|
1192
|
+
readonly type: Schema.Literal<"response.incomplete">;
|
|
1193
|
+
readonly response: Schema.Struct<{
|
|
1194
|
+
readonly id: Schema.String;
|
|
1195
|
+
readonly object: Schema.optionalKey<Schema.Literal<"response">>;
|
|
1196
|
+
readonly model: Schema.String;
|
|
1197
|
+
readonly created_at: Schema.Number;
|
|
1198
|
+
readonly output: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1199
|
+
readonly id: Schema.String;
|
|
1200
|
+
readonly type: Schema.Literal<"apply_patch_call">;
|
|
1201
|
+
readonly call_id: Schema.String;
|
|
1202
|
+
readonly operation: Schema.Struct<{
|
|
1203
|
+
readonly type: Schema.String;
|
|
1204
|
+
readonly path: Schema.String;
|
|
1205
|
+
readonly diff: Schema.optionalKey<Schema.String>;
|
|
1206
|
+
}>;
|
|
1207
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1208
|
+
}>, Schema.Struct<{
|
|
1209
|
+
readonly id: Schema.String;
|
|
1210
|
+
readonly type: Schema.Literal<"code_interpreter_call">;
|
|
1211
|
+
readonly code: Schema.optionalKey<Schema.String>;
|
|
1212
|
+
readonly container_id: Schema.String;
|
|
1213
|
+
readonly outputs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1214
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1215
|
+
}>, Schema.Struct<{
|
|
1216
|
+
readonly id: Schema.String;
|
|
1217
|
+
readonly type: Schema.Literal<"computer_call">;
|
|
1218
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1219
|
+
}>, Schema.Struct<{
|
|
1220
|
+
readonly id: Schema.String;
|
|
1221
|
+
readonly type: Schema.Literal<"file_search_call">;
|
|
1222
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1223
|
+
readonly queries: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1224
|
+
readonly results: Schema.optionalKey<Schema.NullOr<Schema.Unknown>>;
|
|
1225
|
+
}>, Schema.Struct<{
|
|
1226
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1227
|
+
readonly type: Schema.Literal<"function_call">;
|
|
1228
|
+
readonly call_id: Schema.String;
|
|
1229
|
+
readonly name: Schema.String;
|
|
1230
|
+
readonly arguments: Schema.String;
|
|
1231
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1232
|
+
}>, Schema.Struct<{
|
|
1233
|
+
readonly id: Schema.String;
|
|
1234
|
+
readonly type: Schema.Literal<"image_generation_call">;
|
|
1235
|
+
readonly result: Schema.optionalKey<Schema.String>;
|
|
1236
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1237
|
+
}>, Schema.Struct<{
|
|
1238
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1239
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
1240
|
+
readonly call_id: Schema.String;
|
|
1241
|
+
readonly action: Schema.Unknown;
|
|
1242
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1243
|
+
}>, Schema.Struct<{
|
|
1244
|
+
readonly id: Schema.String;
|
|
1245
|
+
readonly type: Schema.Literal<"mcp_call">;
|
|
1246
|
+
readonly approval_request_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1247
|
+
readonly name: Schema.String;
|
|
1248
|
+
readonly arguments: Schema.Unknown;
|
|
1249
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
1250
|
+
readonly error: Schema.optionalKey<Schema.Unknown>;
|
|
1251
|
+
readonly server_label: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1252
|
+
}>, Schema.Struct<{
|
|
1253
|
+
readonly id: Schema.String;
|
|
1254
|
+
readonly type: Schema.Literal<"mcp_list_tools">;
|
|
1255
|
+
}>, Schema.Struct<{
|
|
1256
|
+
readonly id: Schema.String;
|
|
1257
|
+
readonly type: Schema.Literal<"mcp_approval_request">;
|
|
1258
|
+
readonly approval_request_id: Schema.optionalKey<Schema.String>;
|
|
1259
|
+
readonly name: Schema.String;
|
|
1260
|
+
readonly arguments: Schema.Unknown;
|
|
1261
|
+
}>, Schema.Struct<{
|
|
1262
|
+
readonly id: Schema.String;
|
|
1263
|
+
readonly type: Schema.Literal<"message">;
|
|
1264
|
+
readonly role: Schema.Literal<"assistant">;
|
|
1265
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1266
|
+
readonly type: Schema.Literal<"input_text">;
|
|
1267
|
+
readonly text: Schema.String;
|
|
1268
|
+
}>, Schema.Struct<{
|
|
1269
|
+
readonly type: Schema.Literal<"output_text">;
|
|
1270
|
+
readonly text: Schema.String;
|
|
1271
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1272
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
1273
|
+
readonly file_id: Schema.String;
|
|
1274
|
+
readonly index: Schema.Number;
|
|
1275
|
+
readonly filename: Schema.String;
|
|
1276
|
+
}>, Schema.Struct<{
|
|
1277
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
1278
|
+
readonly url: Schema.String;
|
|
1279
|
+
readonly start_index: Schema.Number;
|
|
1280
|
+
readonly end_index: Schema.Number;
|
|
1281
|
+
readonly title: Schema.String;
|
|
1282
|
+
}>, Schema.Struct<{
|
|
1283
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
1284
|
+
readonly container_id: Schema.String;
|
|
1285
|
+
readonly file_id: Schema.String;
|
|
1286
|
+
readonly start_index: Schema.Number;
|
|
1287
|
+
readonly end_index: Schema.Number;
|
|
1288
|
+
readonly filename: Schema.String;
|
|
1289
|
+
}>, Schema.Struct<{
|
|
1290
|
+
readonly type: Schema.Literal<"file_path">;
|
|
1291
|
+
readonly file_id: Schema.String;
|
|
1292
|
+
readonly index: Schema.Number;
|
|
1293
|
+
}>]>>;
|
|
1294
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1295
|
+
}>, Schema.Struct<{
|
|
1296
|
+
readonly type: Schema.Literal<"text">;
|
|
1297
|
+
readonly text: Schema.String;
|
|
1298
|
+
}>, Schema.Struct<{
|
|
1299
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1300
|
+
readonly text: Schema.String;
|
|
1301
|
+
}>, Schema.Struct<{
|
|
1302
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1303
|
+
readonly text: Schema.String;
|
|
1304
|
+
}>, Schema.Struct<{
|
|
1305
|
+
readonly type: Schema.Literal<"refusal">;
|
|
1306
|
+
readonly refusal: Schema.String;
|
|
1307
|
+
}>, Schema.Struct<{
|
|
1308
|
+
readonly type: Schema.Literal<"input_image">;
|
|
1309
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1310
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1311
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
1312
|
+
}>, Schema.Struct<{
|
|
1313
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
1314
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
1315
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
1316
|
+
}>, Schema.Struct<{
|
|
1317
|
+
readonly type: Schema.Literal<"input_file">;
|
|
1318
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1319
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
1320
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
1321
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
1322
|
+
}>]>>;
|
|
1323
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
1324
|
+
}>, Schema.Struct<{
|
|
1325
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
1326
|
+
readonly id: Schema.String;
|
|
1327
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1328
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
1329
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1330
|
+
readonly text: Schema.String;
|
|
1331
|
+
}>>;
|
|
1332
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1333
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1334
|
+
readonly text: Schema.String;
|
|
1335
|
+
}>>>;
|
|
1336
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1337
|
+
}>, Schema.Struct<{
|
|
1338
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1339
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
1340
|
+
readonly call_id: Schema.String;
|
|
1341
|
+
readonly action: Schema.Unknown;
|
|
1342
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1343
|
+
}>, Schema.Struct<{
|
|
1344
|
+
readonly id: Schema.String;
|
|
1345
|
+
readonly type: Schema.Literal<"web_search_call">;
|
|
1346
|
+
readonly action: Schema.optionalKey<Schema.Unknown>;
|
|
1347
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1348
|
+
}>]>>;
|
|
1349
|
+
readonly usage: Schema.optionalKey<Schema.NullOr<Schema.StructWithRest<Schema.Struct<{
|
|
1350
|
+
readonly input_tokens: Schema.Number;
|
|
1351
|
+
readonly output_tokens: Schema.Number;
|
|
1352
|
+
readonly total_tokens: Schema.Number;
|
|
1353
|
+
readonly input_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1354
|
+
readonly output_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1355
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>>>;
|
|
1356
|
+
readonly incomplete_details: Schema.optionalKey<Schema.NullOr<Schema.Struct<{
|
|
1357
|
+
readonly reason: Schema.optionalKey<Schema.Literals<readonly ["max_output_tokens", "content_filter"]>>;
|
|
1358
|
+
}>>>;
|
|
1359
|
+
readonly service_tier: Schema.optionalKey<Schema.String>;
|
|
1360
|
+
}>;
|
|
1361
|
+
readonly sequence_number: Schema.Number;
|
|
1362
|
+
}>, Schema.Struct<{
|
|
1363
|
+
readonly type: Schema.Literal<"response.failed">;
|
|
1364
|
+
readonly response: Schema.Struct<{
|
|
1365
|
+
readonly id: Schema.String;
|
|
1366
|
+
readonly object: Schema.optionalKey<Schema.Literal<"response">>;
|
|
1367
|
+
readonly model: Schema.String;
|
|
1368
|
+
readonly created_at: Schema.Number;
|
|
1369
|
+
readonly output: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1370
|
+
readonly id: Schema.String;
|
|
1371
|
+
readonly type: Schema.Literal<"apply_patch_call">;
|
|
1372
|
+
readonly call_id: Schema.String;
|
|
1373
|
+
readonly operation: Schema.Struct<{
|
|
1374
|
+
readonly type: Schema.String;
|
|
1375
|
+
readonly path: Schema.String;
|
|
1376
|
+
readonly diff: Schema.optionalKey<Schema.String>;
|
|
1377
|
+
}>;
|
|
1378
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1379
|
+
}>, Schema.Struct<{
|
|
1380
|
+
readonly id: Schema.String;
|
|
1381
|
+
readonly type: Schema.Literal<"code_interpreter_call">;
|
|
1382
|
+
readonly code: Schema.optionalKey<Schema.String>;
|
|
1383
|
+
readonly container_id: Schema.String;
|
|
1384
|
+
readonly outputs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1385
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1386
|
+
}>, Schema.Struct<{
|
|
1387
|
+
readonly id: Schema.String;
|
|
1388
|
+
readonly type: Schema.Literal<"computer_call">;
|
|
1389
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1390
|
+
}>, Schema.Struct<{
|
|
1391
|
+
readonly id: Schema.String;
|
|
1392
|
+
readonly type: Schema.Literal<"file_search_call">;
|
|
1393
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1394
|
+
readonly queries: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1395
|
+
readonly results: Schema.optionalKey<Schema.NullOr<Schema.Unknown>>;
|
|
1396
|
+
}>, Schema.Struct<{
|
|
1397
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1398
|
+
readonly type: Schema.Literal<"function_call">;
|
|
1399
|
+
readonly call_id: Schema.String;
|
|
1400
|
+
readonly name: Schema.String;
|
|
1401
|
+
readonly arguments: Schema.String;
|
|
1402
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1403
|
+
}>, Schema.Struct<{
|
|
1404
|
+
readonly id: Schema.String;
|
|
1405
|
+
readonly type: Schema.Literal<"image_generation_call">;
|
|
1406
|
+
readonly result: Schema.optionalKey<Schema.String>;
|
|
1407
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1408
|
+
}>, Schema.Struct<{
|
|
1409
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1410
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
1411
|
+
readonly call_id: Schema.String;
|
|
1412
|
+
readonly action: Schema.Unknown;
|
|
1413
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1414
|
+
}>, Schema.Struct<{
|
|
1415
|
+
readonly id: Schema.String;
|
|
1416
|
+
readonly type: Schema.Literal<"mcp_call">;
|
|
1417
|
+
readonly approval_request_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1418
|
+
readonly name: Schema.String;
|
|
1419
|
+
readonly arguments: Schema.Unknown;
|
|
1420
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
1421
|
+
readonly error: Schema.optionalKey<Schema.Unknown>;
|
|
1422
|
+
readonly server_label: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1423
|
+
}>, Schema.Struct<{
|
|
1424
|
+
readonly id: Schema.String;
|
|
1425
|
+
readonly type: Schema.Literal<"mcp_list_tools">;
|
|
1426
|
+
}>, Schema.Struct<{
|
|
1427
|
+
readonly id: Schema.String;
|
|
1428
|
+
readonly type: Schema.Literal<"mcp_approval_request">;
|
|
1429
|
+
readonly approval_request_id: Schema.optionalKey<Schema.String>;
|
|
1430
|
+
readonly name: Schema.String;
|
|
1431
|
+
readonly arguments: Schema.Unknown;
|
|
1432
|
+
}>, Schema.Struct<{
|
|
1433
|
+
readonly id: Schema.String;
|
|
1434
|
+
readonly type: Schema.Literal<"message">;
|
|
1435
|
+
readonly role: Schema.Literal<"assistant">;
|
|
1436
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1437
|
+
readonly type: Schema.Literal<"input_text">;
|
|
1438
|
+
readonly text: Schema.String;
|
|
1439
|
+
}>, Schema.Struct<{
|
|
1440
|
+
readonly type: Schema.Literal<"output_text">;
|
|
1441
|
+
readonly text: Schema.String;
|
|
1442
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1443
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
1444
|
+
readonly file_id: Schema.String;
|
|
1445
|
+
readonly index: Schema.Number;
|
|
1446
|
+
readonly filename: Schema.String;
|
|
1447
|
+
}>, Schema.Struct<{
|
|
1448
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
1449
|
+
readonly url: Schema.String;
|
|
1450
|
+
readonly start_index: Schema.Number;
|
|
1451
|
+
readonly end_index: Schema.Number;
|
|
1452
|
+
readonly title: Schema.String;
|
|
1453
|
+
}>, Schema.Struct<{
|
|
1454
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
1455
|
+
readonly container_id: Schema.String;
|
|
1456
|
+
readonly file_id: Schema.String;
|
|
1457
|
+
readonly start_index: Schema.Number;
|
|
1458
|
+
readonly end_index: Schema.Number;
|
|
1459
|
+
readonly filename: Schema.String;
|
|
1460
|
+
}>, Schema.Struct<{
|
|
1461
|
+
readonly type: Schema.Literal<"file_path">;
|
|
1462
|
+
readonly file_id: Schema.String;
|
|
1463
|
+
readonly index: Schema.Number;
|
|
1464
|
+
}>]>>;
|
|
1465
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1466
|
+
}>, Schema.Struct<{
|
|
1467
|
+
readonly type: Schema.Literal<"text">;
|
|
1468
|
+
readonly text: Schema.String;
|
|
1469
|
+
}>, Schema.Struct<{
|
|
1470
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1471
|
+
readonly text: Schema.String;
|
|
1472
|
+
}>, Schema.Struct<{
|
|
1473
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1474
|
+
readonly text: Schema.String;
|
|
1475
|
+
}>, Schema.Struct<{
|
|
1476
|
+
readonly type: Schema.Literal<"refusal">;
|
|
1477
|
+
readonly refusal: Schema.String;
|
|
1478
|
+
}>, Schema.Struct<{
|
|
1479
|
+
readonly type: Schema.Literal<"input_image">;
|
|
1480
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1481
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1482
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
1483
|
+
}>, Schema.Struct<{
|
|
1484
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
1485
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
1486
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
1487
|
+
}>, Schema.Struct<{
|
|
1488
|
+
readonly type: Schema.Literal<"input_file">;
|
|
1489
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1490
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
1491
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
1492
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
1493
|
+
}>]>>;
|
|
1494
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
1495
|
+
}>, Schema.Struct<{
|
|
1496
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
1497
|
+
readonly id: Schema.String;
|
|
1498
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1499
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
1500
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1501
|
+
readonly text: Schema.String;
|
|
1502
|
+
}>>;
|
|
1503
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1504
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1505
|
+
readonly text: Schema.String;
|
|
1506
|
+
}>>>;
|
|
1507
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1508
|
+
}>, Schema.Struct<{
|
|
1509
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1510
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
1511
|
+
readonly call_id: Schema.String;
|
|
1512
|
+
readonly action: Schema.Unknown;
|
|
1513
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1514
|
+
}>, Schema.Struct<{
|
|
1515
|
+
readonly id: Schema.String;
|
|
1516
|
+
readonly type: Schema.Literal<"web_search_call">;
|
|
1517
|
+
readonly action: Schema.optionalKey<Schema.Unknown>;
|
|
1518
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1519
|
+
}>]>>;
|
|
1520
|
+
readonly usage: Schema.optionalKey<Schema.NullOr<Schema.StructWithRest<Schema.Struct<{
|
|
1521
|
+
readonly input_tokens: Schema.Number;
|
|
1522
|
+
readonly output_tokens: Schema.Number;
|
|
1523
|
+
readonly total_tokens: Schema.Number;
|
|
1524
|
+
readonly input_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1525
|
+
readonly output_tokens_details: Schema.optionalKey<Schema.Unknown>;
|
|
1526
|
+
}>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>>>;
|
|
1527
|
+
readonly incomplete_details: Schema.optionalKey<Schema.NullOr<Schema.Struct<{
|
|
1528
|
+
readonly reason: Schema.optionalKey<Schema.Literals<readonly ["max_output_tokens", "content_filter"]>>;
|
|
1529
|
+
}>>>;
|
|
1530
|
+
readonly service_tier: Schema.optionalKey<Schema.String>;
|
|
1531
|
+
}>;
|
|
1532
|
+
readonly sequence_number: Schema.Number;
|
|
1533
|
+
}>, Schema.Struct<{
|
|
1534
|
+
readonly type: Schema.Literal<"response.output_item.added">;
|
|
1535
|
+
readonly output_index: Schema.Number;
|
|
1536
|
+
readonly sequence_number: Schema.Number;
|
|
1537
|
+
readonly item: Schema.Union<readonly [Schema.Struct<{
|
|
1538
|
+
readonly id: Schema.String;
|
|
1539
|
+
readonly type: Schema.Literal<"apply_patch_call">;
|
|
1540
|
+
readonly call_id: Schema.String;
|
|
1541
|
+
readonly operation: Schema.Struct<{
|
|
1542
|
+
readonly type: Schema.String;
|
|
1543
|
+
readonly path: Schema.String;
|
|
1544
|
+
readonly diff: Schema.optionalKey<Schema.String>;
|
|
1545
|
+
}>;
|
|
1546
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1547
|
+
}>, Schema.Struct<{
|
|
1548
|
+
readonly id: Schema.String;
|
|
1549
|
+
readonly type: Schema.Literal<"code_interpreter_call">;
|
|
1550
|
+
readonly code: Schema.optionalKey<Schema.String>;
|
|
1551
|
+
readonly container_id: Schema.String;
|
|
1552
|
+
readonly outputs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1553
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1554
|
+
}>, Schema.Struct<{
|
|
1555
|
+
readonly id: Schema.String;
|
|
1556
|
+
readonly type: Schema.Literal<"computer_call">;
|
|
1557
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1558
|
+
}>, Schema.Struct<{
|
|
1559
|
+
readonly id: Schema.String;
|
|
1560
|
+
readonly type: Schema.Literal<"file_search_call">;
|
|
1561
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1562
|
+
readonly queries: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1563
|
+
readonly results: Schema.optionalKey<Schema.NullOr<Schema.Unknown>>;
|
|
1564
|
+
}>, Schema.Struct<{
|
|
1565
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1566
|
+
readonly type: Schema.Literal<"function_call">;
|
|
1567
|
+
readonly call_id: Schema.String;
|
|
1568
|
+
readonly name: Schema.String;
|
|
1569
|
+
readonly arguments: Schema.String;
|
|
1570
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1571
|
+
}>, Schema.Struct<{
|
|
1572
|
+
readonly id: Schema.String;
|
|
1573
|
+
readonly type: Schema.Literal<"image_generation_call">;
|
|
1574
|
+
readonly result: Schema.optionalKey<Schema.String>;
|
|
1575
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1576
|
+
}>, Schema.Struct<{
|
|
1577
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1578
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
1579
|
+
readonly call_id: Schema.String;
|
|
1580
|
+
readonly action: Schema.Unknown;
|
|
1581
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1582
|
+
}>, Schema.Struct<{
|
|
1583
|
+
readonly id: Schema.String;
|
|
1584
|
+
readonly type: Schema.Literal<"mcp_call">;
|
|
1585
|
+
readonly approval_request_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1586
|
+
readonly name: Schema.String;
|
|
1587
|
+
readonly arguments: Schema.Unknown;
|
|
1588
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
1589
|
+
readonly error: Schema.optionalKey<Schema.Unknown>;
|
|
1590
|
+
readonly server_label: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1591
|
+
}>, Schema.Struct<{
|
|
1592
|
+
readonly id: Schema.String;
|
|
1593
|
+
readonly type: Schema.Literal<"mcp_list_tools">;
|
|
1594
|
+
}>, Schema.Struct<{
|
|
1595
|
+
readonly id: Schema.String;
|
|
1596
|
+
readonly type: Schema.Literal<"mcp_approval_request">;
|
|
1597
|
+
readonly approval_request_id: Schema.optionalKey<Schema.String>;
|
|
1598
|
+
readonly name: Schema.String;
|
|
1599
|
+
readonly arguments: Schema.Unknown;
|
|
1600
|
+
}>, Schema.Struct<{
|
|
1601
|
+
readonly id: Schema.String;
|
|
1602
|
+
readonly type: Schema.Literal<"message">;
|
|
1603
|
+
readonly role: Schema.Literal<"assistant">;
|
|
1604
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1605
|
+
readonly type: Schema.Literal<"input_text">;
|
|
1606
|
+
readonly text: Schema.String;
|
|
1607
|
+
}>, Schema.Struct<{
|
|
1608
|
+
readonly type: Schema.Literal<"output_text">;
|
|
1609
|
+
readonly text: Schema.String;
|
|
1610
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1611
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
1612
|
+
readonly file_id: Schema.String;
|
|
1613
|
+
readonly index: Schema.Number;
|
|
1614
|
+
readonly filename: Schema.String;
|
|
1615
|
+
}>, Schema.Struct<{
|
|
1616
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
1617
|
+
readonly url: Schema.String;
|
|
1618
|
+
readonly start_index: Schema.Number;
|
|
1619
|
+
readonly end_index: Schema.Number;
|
|
1620
|
+
readonly title: Schema.String;
|
|
1621
|
+
}>, Schema.Struct<{
|
|
1622
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
1623
|
+
readonly container_id: Schema.String;
|
|
1624
|
+
readonly file_id: Schema.String;
|
|
1625
|
+
readonly start_index: Schema.Number;
|
|
1626
|
+
readonly end_index: Schema.Number;
|
|
1627
|
+
readonly filename: Schema.String;
|
|
1628
|
+
}>, Schema.Struct<{
|
|
1629
|
+
readonly type: Schema.Literal<"file_path">;
|
|
1630
|
+
readonly file_id: Schema.String;
|
|
1631
|
+
readonly index: Schema.Number;
|
|
1632
|
+
}>]>>;
|
|
1633
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1634
|
+
}>, Schema.Struct<{
|
|
1635
|
+
readonly type: Schema.Literal<"text">;
|
|
1636
|
+
readonly text: Schema.String;
|
|
1637
|
+
}>, Schema.Struct<{
|
|
1638
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1639
|
+
readonly text: Schema.String;
|
|
1640
|
+
}>, Schema.Struct<{
|
|
1641
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1642
|
+
readonly text: Schema.String;
|
|
1643
|
+
}>, Schema.Struct<{
|
|
1644
|
+
readonly type: Schema.Literal<"refusal">;
|
|
1645
|
+
readonly refusal: Schema.String;
|
|
1646
|
+
}>, Schema.Struct<{
|
|
1647
|
+
readonly type: Schema.Literal<"input_image">;
|
|
1648
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1649
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1650
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
1651
|
+
}>, Schema.Struct<{
|
|
1652
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
1653
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
1654
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
1655
|
+
}>, Schema.Struct<{
|
|
1656
|
+
readonly type: Schema.Literal<"input_file">;
|
|
1657
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1658
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
1659
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
1660
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
1661
|
+
}>]>>;
|
|
1662
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
1663
|
+
}>, Schema.Struct<{
|
|
1664
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
1665
|
+
readonly id: Schema.String;
|
|
1666
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1667
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
1668
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1669
|
+
readonly text: Schema.String;
|
|
1670
|
+
}>>;
|
|
1671
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1672
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1673
|
+
readonly text: Schema.String;
|
|
1674
|
+
}>>>;
|
|
1675
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1676
|
+
}>, Schema.Struct<{
|
|
1677
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1678
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
1679
|
+
readonly call_id: Schema.String;
|
|
1680
|
+
readonly action: Schema.Unknown;
|
|
1681
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1682
|
+
}>, Schema.Struct<{
|
|
1683
|
+
readonly id: Schema.String;
|
|
1684
|
+
readonly type: Schema.Literal<"web_search_call">;
|
|
1685
|
+
readonly action: Schema.optionalKey<Schema.Unknown>;
|
|
1686
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1687
|
+
}>]>;
|
|
1688
|
+
}>, Schema.Struct<{
|
|
1689
|
+
readonly type: Schema.Literal<"response.output_item.done">;
|
|
1690
|
+
readonly output_index: Schema.Number;
|
|
1691
|
+
readonly sequence_number: Schema.Number;
|
|
1692
|
+
readonly item: Schema.Union<readonly [Schema.Struct<{
|
|
1693
|
+
readonly id: Schema.String;
|
|
1694
|
+
readonly type: Schema.Literal<"apply_patch_call">;
|
|
1695
|
+
readonly call_id: Schema.String;
|
|
1696
|
+
readonly operation: Schema.Struct<{
|
|
1697
|
+
readonly type: Schema.String;
|
|
1698
|
+
readonly path: Schema.String;
|
|
1699
|
+
readonly diff: Schema.optionalKey<Schema.String>;
|
|
1700
|
+
}>;
|
|
1701
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1702
|
+
}>, Schema.Struct<{
|
|
1703
|
+
readonly id: Schema.String;
|
|
1704
|
+
readonly type: Schema.Literal<"code_interpreter_call">;
|
|
1705
|
+
readonly code: Schema.optionalKey<Schema.String>;
|
|
1706
|
+
readonly container_id: Schema.String;
|
|
1707
|
+
readonly outputs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1708
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1709
|
+
}>, Schema.Struct<{
|
|
1710
|
+
readonly id: Schema.String;
|
|
1711
|
+
readonly type: Schema.Literal<"computer_call">;
|
|
1712
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1713
|
+
}>, Schema.Struct<{
|
|
1714
|
+
readonly id: Schema.String;
|
|
1715
|
+
readonly type: Schema.Literal<"file_search_call">;
|
|
1716
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1717
|
+
readonly queries: Schema.optionalKey<Schema.$Array<Schema.String>>;
|
|
1718
|
+
readonly results: Schema.optionalKey<Schema.NullOr<Schema.Unknown>>;
|
|
1719
|
+
}>, Schema.Struct<{
|
|
1720
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1721
|
+
readonly type: Schema.Literal<"function_call">;
|
|
1722
|
+
readonly call_id: Schema.String;
|
|
1723
|
+
readonly name: Schema.String;
|
|
1724
|
+
readonly arguments: Schema.String;
|
|
1725
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1726
|
+
}>, Schema.Struct<{
|
|
1727
|
+
readonly id: Schema.String;
|
|
1728
|
+
readonly type: Schema.Literal<"image_generation_call">;
|
|
1729
|
+
readonly result: Schema.optionalKey<Schema.String>;
|
|
1730
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1731
|
+
}>, Schema.Struct<{
|
|
1732
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1733
|
+
readonly type: Schema.Literal<"local_shell_call">;
|
|
1734
|
+
readonly call_id: Schema.String;
|
|
1735
|
+
readonly action: Schema.Unknown;
|
|
1736
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1737
|
+
}>, Schema.Struct<{
|
|
1738
|
+
readonly id: Schema.String;
|
|
1739
|
+
readonly type: Schema.Literal<"mcp_call">;
|
|
1740
|
+
readonly approval_request_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1741
|
+
readonly name: Schema.String;
|
|
1742
|
+
readonly arguments: Schema.Unknown;
|
|
1743
|
+
readonly output: Schema.optionalKey<Schema.Unknown>;
|
|
1744
|
+
readonly error: Schema.optionalKey<Schema.Unknown>;
|
|
1745
|
+
readonly server_label: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1746
|
+
}>, Schema.Struct<{
|
|
1747
|
+
readonly id: Schema.String;
|
|
1748
|
+
readonly type: Schema.Literal<"mcp_list_tools">;
|
|
1749
|
+
}>, Schema.Struct<{
|
|
1750
|
+
readonly id: Schema.String;
|
|
1751
|
+
readonly type: Schema.Literal<"mcp_approval_request">;
|
|
1752
|
+
readonly approval_request_id: Schema.optionalKey<Schema.String>;
|
|
1753
|
+
readonly name: Schema.String;
|
|
1754
|
+
readonly arguments: Schema.Unknown;
|
|
1755
|
+
}>, Schema.Struct<{
|
|
1756
|
+
readonly id: Schema.String;
|
|
1757
|
+
readonly type: Schema.Literal<"message">;
|
|
1758
|
+
readonly role: Schema.Literal<"assistant">;
|
|
1759
|
+
readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1760
|
+
readonly type: Schema.Literal<"input_text">;
|
|
1761
|
+
readonly text: Schema.String;
|
|
1762
|
+
}>, Schema.Struct<{
|
|
1763
|
+
readonly type: Schema.Literal<"output_text">;
|
|
1764
|
+
readonly text: Schema.String;
|
|
1765
|
+
readonly annotations: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1766
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
1767
|
+
readonly file_id: Schema.String;
|
|
1768
|
+
readonly index: Schema.Number;
|
|
1769
|
+
readonly filename: Schema.String;
|
|
1770
|
+
}>, Schema.Struct<{
|
|
1771
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
1772
|
+
readonly url: Schema.String;
|
|
1773
|
+
readonly start_index: Schema.Number;
|
|
1774
|
+
readonly end_index: Schema.Number;
|
|
1775
|
+
readonly title: Schema.String;
|
|
1776
|
+
}>, Schema.Struct<{
|
|
1777
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
1778
|
+
readonly container_id: Schema.String;
|
|
1779
|
+
readonly file_id: Schema.String;
|
|
1780
|
+
readonly start_index: Schema.Number;
|
|
1781
|
+
readonly end_index: Schema.Number;
|
|
1782
|
+
readonly filename: Schema.String;
|
|
1783
|
+
}>, Schema.Struct<{
|
|
1784
|
+
readonly type: Schema.Literal<"file_path">;
|
|
1785
|
+
readonly file_id: Schema.String;
|
|
1786
|
+
readonly index: Schema.Number;
|
|
1787
|
+
}>]>>;
|
|
1788
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1789
|
+
}>, Schema.Struct<{
|
|
1790
|
+
readonly type: Schema.Literal<"text">;
|
|
1791
|
+
readonly text: Schema.String;
|
|
1792
|
+
}>, Schema.Struct<{
|
|
1793
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1794
|
+
readonly text: Schema.String;
|
|
1795
|
+
}>, Schema.Struct<{
|
|
1796
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1797
|
+
readonly text: Schema.String;
|
|
1798
|
+
}>, Schema.Struct<{
|
|
1799
|
+
readonly type: Schema.Literal<"refusal">;
|
|
1800
|
+
readonly refusal: Schema.String;
|
|
1801
|
+
}>, Schema.Struct<{
|
|
1802
|
+
readonly type: Schema.Literal<"input_image">;
|
|
1803
|
+
readonly image_url: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1804
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1805
|
+
readonly detail: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["low", "high", "auto"]>>>;
|
|
1806
|
+
}>, Schema.Struct<{
|
|
1807
|
+
readonly type: Schema.Literal<"computer_screenshot">;
|
|
1808
|
+
readonly image_url: Schema.NullOr<Schema.String>;
|
|
1809
|
+
readonly file_id: Schema.NullOr<Schema.String>;
|
|
1810
|
+
}>, Schema.Struct<{
|
|
1811
|
+
readonly type: Schema.Literal<"input_file">;
|
|
1812
|
+
readonly file_id: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1813
|
+
readonly filename: Schema.optionalKey<Schema.String>;
|
|
1814
|
+
readonly file_url: Schema.optionalKey<Schema.String>;
|
|
1815
|
+
readonly file_data: Schema.optionalKey<Schema.String>;
|
|
1816
|
+
}>]>>;
|
|
1817
|
+
readonly status: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
|
|
1818
|
+
}>, Schema.Struct<{
|
|
1819
|
+
readonly type: Schema.Literal<"reasoning">;
|
|
1820
|
+
readonly id: Schema.String;
|
|
1821
|
+
readonly encrypted_content: Schema.optionalKey<Schema.NullOr<Schema.String>>;
|
|
1822
|
+
readonly summary: Schema.$Array<Schema.Struct<{
|
|
1823
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1824
|
+
readonly text: Schema.String;
|
|
1825
|
+
}>>;
|
|
1826
|
+
readonly content: Schema.optionalKey<Schema.$Array<Schema.Struct<{
|
|
1827
|
+
readonly type: Schema.Literal<"reasoning_text">;
|
|
1828
|
+
readonly text: Schema.String;
|
|
1829
|
+
}>>>;
|
|
1830
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1831
|
+
}>, Schema.Struct<{
|
|
1832
|
+
readonly id: Schema.optionalKey<Schema.String>;
|
|
1833
|
+
readonly type: Schema.Literal<"shell_call">;
|
|
1834
|
+
readonly call_id: Schema.String;
|
|
1835
|
+
readonly action: Schema.Unknown;
|
|
1836
|
+
readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
|
|
1837
|
+
}>, Schema.Struct<{
|
|
1838
|
+
readonly id: Schema.String;
|
|
1839
|
+
readonly type: Schema.Literal<"web_search_call">;
|
|
1840
|
+
readonly action: Schema.optionalKey<Schema.Unknown>;
|
|
1841
|
+
readonly status: Schema.optionalKey<Schema.String>;
|
|
1842
|
+
}>]>;
|
|
1843
|
+
}>, Schema.Struct<{
|
|
1844
|
+
readonly type: Schema.Literal<"response.output_text.delta">;
|
|
1845
|
+
readonly item_id: Schema.String;
|
|
1846
|
+
readonly output_index: Schema.Number;
|
|
1847
|
+
readonly content_index: Schema.Number;
|
|
1848
|
+
readonly delta: Schema.String;
|
|
1849
|
+
readonly sequence_number: Schema.Number;
|
|
1850
|
+
readonly logprobs: Schema.optionalKey<Schema.$Array<Schema.Unknown>>;
|
|
1851
|
+
}>, Schema.Struct<{
|
|
1852
|
+
readonly type: Schema.Literal<"response.output_text.annotation.added">;
|
|
1853
|
+
readonly item_id: Schema.String;
|
|
1854
|
+
readonly output_index: Schema.Number;
|
|
1855
|
+
readonly content_index: Schema.Number;
|
|
1856
|
+
readonly annotation_index: Schema.Number;
|
|
1857
|
+
readonly sequence_number: Schema.Number;
|
|
1858
|
+
readonly annotation: Schema.Union<readonly [Schema.Struct<{
|
|
1859
|
+
readonly type: Schema.Literal<"file_citation">;
|
|
1860
|
+
readonly file_id: Schema.String;
|
|
1861
|
+
readonly index: Schema.Number;
|
|
1862
|
+
readonly filename: Schema.String;
|
|
1863
|
+
}>, Schema.Struct<{
|
|
1864
|
+
readonly type: Schema.Literal<"url_citation">;
|
|
1865
|
+
readonly url: Schema.String;
|
|
1866
|
+
readonly start_index: Schema.Number;
|
|
1867
|
+
readonly end_index: Schema.Number;
|
|
1868
|
+
readonly title: Schema.String;
|
|
1869
|
+
}>, Schema.Struct<{
|
|
1870
|
+
readonly type: Schema.Literal<"container_file_citation">;
|
|
1871
|
+
readonly container_id: Schema.String;
|
|
1872
|
+
readonly file_id: Schema.String;
|
|
1873
|
+
readonly start_index: Schema.Number;
|
|
1874
|
+
readonly end_index: Schema.Number;
|
|
1875
|
+
readonly filename: Schema.String;
|
|
1876
|
+
}>, Schema.Struct<{
|
|
1877
|
+
readonly type: Schema.Literal<"file_path">;
|
|
1878
|
+
readonly file_id: Schema.String;
|
|
1879
|
+
readonly index: Schema.Number;
|
|
1880
|
+
}>]>;
|
|
1881
|
+
}>, Schema.Struct<{
|
|
1882
|
+
readonly type: Schema.Literal<"response.reasoning_summary_part.added">;
|
|
1883
|
+
readonly item_id: Schema.String;
|
|
1884
|
+
readonly output_index: Schema.Number;
|
|
1885
|
+
readonly summary_index: Schema.Number;
|
|
1886
|
+
readonly sequence_number: Schema.Number;
|
|
1887
|
+
readonly part: Schema.Struct<{
|
|
1888
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1889
|
+
readonly text: Schema.String;
|
|
1890
|
+
}>;
|
|
1891
|
+
}>, Schema.Struct<{
|
|
1892
|
+
readonly type: Schema.Literal<"response.reasoning_summary_part.done">;
|
|
1893
|
+
readonly item_id: Schema.String;
|
|
1894
|
+
readonly output_index: Schema.Number;
|
|
1895
|
+
readonly summary_index: Schema.Number;
|
|
1896
|
+
readonly sequence_number: Schema.Number;
|
|
1897
|
+
readonly part: Schema.Struct<{
|
|
1898
|
+
readonly type: Schema.Literal<"summary_text">;
|
|
1899
|
+
readonly text: Schema.String;
|
|
1900
|
+
}>;
|
|
1901
|
+
}>, Schema.Struct<{
|
|
1902
|
+
readonly type: Schema.Literal<"response.reasoning_summary_text.delta">;
|
|
1903
|
+
readonly item_id: Schema.String;
|
|
1904
|
+
readonly output_index: Schema.Number;
|
|
1905
|
+
readonly summary_index: Schema.Number;
|
|
1906
|
+
readonly delta: Schema.String;
|
|
1907
|
+
readonly sequence_number: Schema.Number;
|
|
1908
|
+
}>, Schema.Struct<{
|
|
1909
|
+
readonly type: Schema.Literal<"response.function_call_arguments.delta">;
|
|
1910
|
+
readonly item_id: Schema.String;
|
|
1911
|
+
readonly output_index: Schema.Number;
|
|
1912
|
+
readonly sequence_number: Schema.Number;
|
|
1913
|
+
readonly delta: Schema.String;
|
|
1914
|
+
}>, Schema.Struct<{
|
|
1915
|
+
readonly type: Schema.Literal<"response.function_call_arguments.done">;
|
|
1916
|
+
readonly item_id: Schema.String;
|
|
1917
|
+
readonly output_index: Schema.Number;
|
|
1918
|
+
readonly sequence_number: Schema.Number;
|
|
1919
|
+
readonly arguments: Schema.String;
|
|
1920
|
+
}>, Schema.Struct<{
|
|
1921
|
+
readonly type: Schema.Literal<"response.code_interpreter_call_code.delta">;
|
|
1922
|
+
readonly item_id: Schema.String;
|
|
1923
|
+
readonly output_index: Schema.Number;
|
|
1924
|
+
readonly sequence_number: Schema.Number;
|
|
1925
|
+
readonly delta: Schema.String;
|
|
1926
|
+
}>, Schema.Struct<{
|
|
1927
|
+
readonly type: Schema.Literal<"response.code_interpreter_call_code.done">;
|
|
1928
|
+
readonly item_id: Schema.String;
|
|
1929
|
+
readonly output_index: Schema.Number;
|
|
1930
|
+
readonly sequence_number: Schema.Number;
|
|
1931
|
+
readonly code: Schema.String;
|
|
1932
|
+
}>, Schema.Struct<{
|
|
1933
|
+
readonly type: Schema.Literal<"response.apply_patch_call_operation_diff.delta">;
|
|
1934
|
+
readonly item_id: Schema.String;
|
|
1935
|
+
readonly output_index: Schema.Number;
|
|
1936
|
+
readonly sequence_number: Schema.Number;
|
|
1937
|
+
readonly delta: Schema.String;
|
|
1938
|
+
}>, Schema.Struct<{
|
|
1939
|
+
readonly type: Schema.Literal<"response.apply_patch_call_operation_diff.done">;
|
|
1940
|
+
readonly item_id: Schema.String;
|
|
1941
|
+
readonly output_index: Schema.Number;
|
|
1942
|
+
readonly sequence_number: Schema.Number;
|
|
1943
|
+
readonly delta: Schema.optionalKey<Schema.String>;
|
|
1944
|
+
}>, Schema.Struct<{
|
|
1945
|
+
readonly type: Schema.Literal<"response.image_generation_call.partial_image">;
|
|
1946
|
+
readonly item_id: Schema.String;
|
|
1947
|
+
readonly output_index: Schema.Number;
|
|
1948
|
+
readonly sequence_number: Schema.Number;
|
|
1949
|
+
readonly partial_image_b64: Schema.String;
|
|
1950
|
+
}>, Schema.Struct<{
|
|
1951
|
+
readonly type: Schema.Literal<"error">;
|
|
1952
|
+
readonly code: Schema.NullOr<Schema.String>;
|
|
1953
|
+
readonly message: Schema.String;
|
|
1954
|
+
readonly param: Schema.NullOr<Schema.String>;
|
|
1955
|
+
readonly sequence_number: Schema.Number;
|
|
1956
|
+
readonly status: Schema.optionalKey<Schema.Number>;
|
|
1957
|
+
}>, Schema.declare<UnknownResponseStreamEvent, UnknownResponseStreamEvent>]>;
|
|
1958
|
+
/**
|
|
1959
|
+
* Server-sent event shape emitted by OpenAI Responses API streams.
|
|
1960
|
+
*
|
|
1961
|
+
* @category models
|
|
1962
|
+
* @since 4.0.0
|
|
1963
|
+
*/
|
|
1964
|
+
export type ResponseStreamEvent = typeof ResponseStreamEvent.Type;
|
|
1965
|
+
/**
|
|
1966
|
+
* Schema for one embedding item returned by the OpenAI embeddings API.
|
|
1967
|
+
*
|
|
1968
|
+
* @category schemas
|
|
1969
|
+
* @since 4.0.0
|
|
1970
|
+
*/
|
|
1971
|
+
export declare const Embedding: Schema.Struct<{
|
|
1972
|
+
readonly embedding: Schema.Union<readonly [Schema.$Array<Schema.Number>, Schema.String]>;
|
|
1973
|
+
readonly index: Schema.Number;
|
|
1974
|
+
readonly object: Schema.optionalKey<Schema.String>;
|
|
1975
|
+
}>;
|
|
1976
|
+
/**
|
|
1977
|
+
* One embedding item returned by the OpenAI embeddings API.
|
|
1978
|
+
*
|
|
1979
|
+
* @category models
|
|
1980
|
+
* @since 4.0.0
|
|
1981
|
+
*/
|
|
1982
|
+
export type Embedding = typeof Embedding.Type;
|
|
1983
|
+
/**
|
|
1984
|
+
* Schema for the request payload sent to the OpenAI embeddings endpoint.
|
|
1985
|
+
*
|
|
1986
|
+
* @category schemas
|
|
1987
|
+
* @since 4.0.0
|
|
1988
|
+
*/
|
|
1989
|
+
export declare const CreateEmbeddingRequest: Schema.Struct<{
|
|
1990
|
+
readonly input: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.String>, Schema.$Array<Schema.Number>, Schema.$Array<Schema.$Array<Schema.Number>>]>;
|
|
1991
|
+
readonly model: Schema.String;
|
|
1992
|
+
readonly encoding_format: Schema.optionalKey<Schema.Literals<readonly ["float", "base64"]>>;
|
|
1993
|
+
readonly dimensions: Schema.optionalKey<Schema.Number>;
|
|
1994
|
+
readonly user: Schema.optionalKey<Schema.String>;
|
|
1995
|
+
}>;
|
|
1996
|
+
/**
|
|
1997
|
+
* Request payload sent to the OpenAI embeddings endpoint.
|
|
1998
|
+
*
|
|
1999
|
+
* @category models
|
|
2000
|
+
* @since 4.0.0
|
|
2001
|
+
*/
|
|
2002
|
+
export type CreateEmbeddingRequest = typeof CreateEmbeddingRequest.Type;
|
|
2003
|
+
/**
|
|
2004
|
+
* Schema for a successful response payload returned by the OpenAI embeddings endpoint.
|
|
2005
|
+
*
|
|
2006
|
+
* @category schemas
|
|
2007
|
+
* @since 4.0.0
|
|
2008
|
+
*/
|
|
2009
|
+
export declare const CreateEmbeddingResponse: Schema.Struct<{
|
|
2010
|
+
readonly data: Schema.$Array<Schema.Struct<{
|
|
2011
|
+
readonly embedding: Schema.Union<readonly [Schema.$Array<Schema.Number>, Schema.String]>;
|
|
2012
|
+
readonly index: Schema.Number;
|
|
2013
|
+
readonly object: Schema.optionalKey<Schema.String>;
|
|
2014
|
+
}>>;
|
|
2015
|
+
readonly model: Schema.String;
|
|
2016
|
+
readonly object: Schema.optionalKey<Schema.Literal<"list">>;
|
|
2017
|
+
readonly usage: Schema.optionalKey<Schema.Struct<{
|
|
2018
|
+
readonly prompt_tokens: Schema.Number;
|
|
2019
|
+
readonly total_tokens: Schema.Number;
|
|
2020
|
+
}>>;
|
|
2021
|
+
}>;
|
|
2022
|
+
/**
|
|
2023
|
+
* Successful response payload returned by the OpenAI embeddings endpoint.
|
|
2024
|
+
*
|
|
2025
|
+
* @category models
|
|
2026
|
+
* @since 4.0.0
|
|
2027
|
+
*/
|
|
2028
|
+
export type CreateEmbeddingResponse = typeof CreateEmbeddingResponse.Type;
|
|
2029
|
+
//# sourceMappingURL=OpenAiSchema.d.ts.map
|