llama-stack-client 0.2.16 → 0.2.17-rc1
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/LICENSE +4 -198
- package/index.d.mts +2 -2
- package/index.d.ts +2 -2
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -1
- package/index.mjs.map +1 -1
- package/package.json +2 -6
- package/resources/agents/agents.d.ts +29 -2
- package/resources/agents/agents.d.ts.map +1 -1
- package/resources/agents/agents.js.map +1 -1
- package/resources/agents/agents.mjs.map +1 -1
- package/resources/agents/session.d.ts +18 -0
- package/resources/agents/session.d.ts.map +1 -1
- package/resources/agents/steps.d.ts +4 -1
- package/resources/agents/steps.d.ts.map +1 -1
- package/resources/agents/turn.d.ts +113 -8
- package/resources/agents/turn.d.ts.map +1 -1
- package/resources/benchmarks.d.ts +15 -0
- package/resources/benchmarks.d.ts.map +1 -1
- package/resources/chat/chat.d.ts +24 -0
- package/resources/chat/chat.d.ts.map +1 -1
- package/resources/chat/chat.js.map +1 -1
- package/resources/chat/chat.mjs.map +1 -1
- package/resources/chat/completions.d.ts +648 -6
- package/resources/chat/completions.d.ts.map +1 -1
- package/resources/datasets.d.ts +42 -6
- package/resources/datasets.d.ts.map +1 -1
- package/resources/eval/eval.d.ts +9 -0
- package/resources/eval/eval.d.ts.map +1 -1
- package/resources/eval/eval.js.map +1 -1
- package/resources/eval/eval.mjs.map +1 -1
- package/resources/files.d.ts +9 -0
- package/resources/files.d.ts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/inference.d.ts +36 -0
- package/resources/inference.d.ts.map +1 -1
- package/resources/inspect.d.ts +45 -1
- package/resources/inspect.d.ts.map +1 -1
- package/resources/inspect.js +1 -1
- package/resources/inspect.mjs +1 -1
- package/resources/models.d.ts +21 -0
- package/resources/models.d.ts.map +1 -1
- package/resources/post-training/job.d.ts +95 -2
- package/resources/post-training/job.d.ts.map +1 -1
- package/resources/post-training/post-training.d.ts +206 -0
- package/resources/post-training/post-training.d.ts.map +1 -1
- package/resources/post-training/post-training.js.map +1 -1
- package/resources/post-training/post-training.mjs.map +1 -1
- package/resources/providers.d.ts +9 -0
- package/resources/providers.d.ts.map +1 -1
- package/resources/responses/input-items.d.ts +114 -0
- package/resources/responses/input-items.d.ts.map +1 -1
- package/resources/responses/responses.d.ts +1265 -12
- package/resources/responses/responses.d.ts.map +1 -1
- package/resources/responses/responses.js.map +1 -1
- package/resources/responses/responses.mjs.map +1 -1
- package/resources/routes.d.ts +10 -1
- package/resources/routes.d.ts.map +1 -1
- package/resources/routes.js +1 -1
- package/resources/routes.mjs +1 -1
- package/resources/safety.d.ts +72 -1
- package/resources/safety.d.ts.map +1 -1
- package/resources/safety.js +6 -0
- package/resources/safety.js.map +1 -1
- package/resources/safety.mjs +6 -0
- package/resources/safety.mjs.map +1 -1
- package/resources/scoring-functions.d.ts +51 -0
- package/resources/scoring-functions.d.ts.map +1 -1
- package/resources/scoring.d.ts +9 -0
- package/resources/scoring.d.ts.map +1 -1
- package/resources/shared.d.ts +209 -3
- package/resources/shared.d.ts.map +1 -1
- package/resources/shields.d.ts +7 -1
- package/resources/shields.d.ts.map +1 -1
- package/resources/synthetic-data-generation.d.ts +18 -1
- package/resources/synthetic-data-generation.d.ts.map +1 -1
- package/resources/synthetic-data-generation.js +3 -0
- package/resources/synthetic-data-generation.js.map +1 -1
- package/resources/synthetic-data-generation.mjs +3 -0
- package/resources/synthetic-data-generation.mjs.map +1 -1
- package/resources/telemetry.d.ts +214 -0
- package/resources/telemetry.d.ts.map +1 -1
- package/resources/tool-runtime/rag-tool.d.ts +16 -4
- package/resources/tool-runtime/rag-tool.d.ts.map +1 -1
- package/resources/tool-runtime/rag-tool.js +2 -2
- package/resources/tool-runtime/rag-tool.mjs +2 -2
- package/resources/tool-runtime/tool-runtime.d.ts +52 -1
- package/resources/tool-runtime/tool-runtime.d.ts.map +1 -1
- package/resources/tool-runtime/tool-runtime.js.map +1 -1
- package/resources/tool-runtime/tool-runtime.mjs.map +1 -1
- package/resources/toolgroups.d.ts +30 -0
- package/resources/toolgroups.d.ts.map +1 -1
- package/resources/tools.d.ts +45 -0
- package/resources/tools.d.ts.map +1 -1
- package/resources/vector-dbs.d.ts +45 -0
- package/resources/vector-dbs.d.ts.map +1 -1
- package/resources/vector-io.d.ts +9 -0
- package/resources/vector-io.d.ts.map +1 -1
- package/resources/vector-stores/files.d.ts +149 -1
- package/resources/vector-stores/files.d.ts.map +1 -1
- package/resources/vector-stores/vector-stores.d.ts +121 -1
- package/resources/vector-stores/vector-stores.d.ts.map +1 -1
- package/resources/vector-stores/vector-stores.js.map +1 -1
- package/resources/vector-stores/vector-stores.mjs.map +1 -1
- package/src/index.ts +9 -1
- package/src/resources/agents/agents.ts +29 -2
- package/src/resources/agents/session.ts +18 -0
- package/src/resources/agents/steps.ts +4 -1
- package/src/resources/agents/turn.ts +113 -8
- package/src/resources/benchmarks.ts +15 -0
- package/src/resources/chat/chat.ts +24 -0
- package/src/resources/chat/completions.ts +678 -0
- package/src/resources/datasets.ts +42 -6
- package/src/resources/eval/eval.ts +9 -0
- package/src/resources/files.ts +9 -0
- package/src/resources/index.ts +7 -1
- package/src/resources/inference.ts +36 -0
- package/src/resources/inspect.ts +45 -1
- package/src/resources/models.ts +21 -0
- package/src/resources/post-training/job.ts +95 -2
- package/src/resources/post-training/post-training.ts +206 -0
- package/src/resources/providers.ts +9 -0
- package/src/resources/responses/input-items.ts +114 -0
- package/src/resources/responses/responses.ts +1265 -12
- package/src/resources/routes.ts +10 -1
- package/src/resources/safety.ts +83 -1
- package/src/resources/scoring-functions.ts +51 -0
- package/src/resources/scoring.ts +9 -0
- package/src/resources/shared.ts +209 -3
- package/src/resources/shields.ts +7 -1
- package/src/resources/synthetic-data-generation.ts +18 -1
- package/src/resources/telemetry.ts +214 -0
- package/src/resources/tool-runtime/rag-tool.ts +16 -4
- package/src/resources/tool-runtime/tool-runtime.ts +52 -1
- package/src/resources/toolgroups.ts +30 -0
- package/src/resources/tools.ts +45 -0
- package/src/resources/vector-dbs.ts +45 -0
- package/src/resources/vector-io.ts +9 -0
- package/src/resources/vector-stores/files.ts +149 -1
- package/src/resources/vector-stores/vector-stores.ts +121 -1
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -58,15 +58,33 @@ export class Responses extends APIResource {
|
|
|
58
58
|
}
|
|
59
59
|
}
|
|
60
60
|
|
|
61
|
+
/**
|
|
62
|
+
* Complete OpenAI response object containing generation results and metadata.
|
|
63
|
+
*/
|
|
61
64
|
export interface ResponseObject {
|
|
65
|
+
/**
|
|
66
|
+
* Unique identifier for this response
|
|
67
|
+
*/
|
|
62
68
|
id: string;
|
|
63
69
|
|
|
70
|
+
/**
|
|
71
|
+
* Unix timestamp when the response was created
|
|
72
|
+
*/
|
|
64
73
|
created_at: number;
|
|
65
74
|
|
|
75
|
+
/**
|
|
76
|
+
* Model identifier used for generation
|
|
77
|
+
*/
|
|
66
78
|
model: string;
|
|
67
79
|
|
|
80
|
+
/**
|
|
81
|
+
* Object type identifier, always "response"
|
|
82
|
+
*/
|
|
68
83
|
object: 'response';
|
|
69
84
|
|
|
85
|
+
/**
|
|
86
|
+
* List of generated output items (messages, tool calls, etc.)
|
|
87
|
+
*/
|
|
70
88
|
output: Array<
|
|
71
89
|
| ResponseObject.OpenAIResponseMessage
|
|
72
90
|
| ResponseObject.OpenAIResponseOutputMessageWebSearchToolCall
|
|
@@ -76,22 +94,49 @@ export interface ResponseObject {
|
|
|
76
94
|
| ResponseObject.OpenAIResponseOutputMessageMcpListTools
|
|
77
95
|
>;
|
|
78
96
|
|
|
97
|
+
/**
|
|
98
|
+
* Whether tool calls can be executed in parallel
|
|
99
|
+
*/
|
|
79
100
|
parallel_tool_calls: boolean;
|
|
80
101
|
|
|
102
|
+
/**
|
|
103
|
+
* Current status of the response generation
|
|
104
|
+
*/
|
|
81
105
|
status: string;
|
|
82
106
|
|
|
107
|
+
/**
|
|
108
|
+
* Text formatting configuration for the response
|
|
109
|
+
*/
|
|
83
110
|
text: ResponseObject.Text;
|
|
84
111
|
|
|
112
|
+
/**
|
|
113
|
+
* (Optional) Error details if the response generation failed
|
|
114
|
+
*/
|
|
85
115
|
error?: ResponseObject.Error;
|
|
86
116
|
|
|
117
|
+
/**
|
|
118
|
+
* (Optional) ID of the previous response in a conversation
|
|
119
|
+
*/
|
|
87
120
|
previous_response_id?: string;
|
|
88
121
|
|
|
122
|
+
/**
|
|
123
|
+
* (Optional) Sampling temperature used for generation
|
|
124
|
+
*/
|
|
89
125
|
temperature?: number;
|
|
90
126
|
|
|
127
|
+
/**
|
|
128
|
+
* (Optional) Nucleus sampling parameter used for generation
|
|
129
|
+
*/
|
|
91
130
|
top_p?: number;
|
|
92
131
|
|
|
132
|
+
/**
|
|
133
|
+
* (Optional) Truncation strategy applied to the response
|
|
134
|
+
*/
|
|
93
135
|
truncation?: string;
|
|
94
136
|
|
|
137
|
+
/**
|
|
138
|
+
* (Optional) User identifier associated with the request
|
|
139
|
+
*/
|
|
95
140
|
user?: string;
|
|
96
141
|
}
|
|
97
142
|
|
|
@@ -120,17 +165,38 @@ export namespace ResponseObject {
|
|
|
120
165
|
}
|
|
121
166
|
|
|
122
167
|
export namespace OpenAIResponseMessage {
|
|
168
|
+
/**
|
|
169
|
+
* Text content for input messages in OpenAI response format.
|
|
170
|
+
*/
|
|
123
171
|
export interface OpenAIResponseInputMessageContentText {
|
|
172
|
+
/**
|
|
173
|
+
* The text content of the input message
|
|
174
|
+
*/
|
|
124
175
|
text: string;
|
|
125
176
|
|
|
177
|
+
/**
|
|
178
|
+
* Content type identifier, always "input_text"
|
|
179
|
+
*/
|
|
126
180
|
type: 'input_text';
|
|
127
181
|
}
|
|
128
182
|
|
|
183
|
+
/**
|
|
184
|
+
* Image content for input messages in OpenAI response format.
|
|
185
|
+
*/
|
|
129
186
|
export interface OpenAIResponseInputMessageContentImage {
|
|
187
|
+
/**
|
|
188
|
+
* Level of detail for image processing, can be "low", "high", or "auto"
|
|
189
|
+
*/
|
|
130
190
|
detail: 'low' | 'high' | 'auto';
|
|
131
191
|
|
|
192
|
+
/**
|
|
193
|
+
* Content type identifier, always "input_image"
|
|
194
|
+
*/
|
|
132
195
|
type: 'input_image';
|
|
133
196
|
|
|
197
|
+
/**
|
|
198
|
+
* (Optional) URL of the image content
|
|
199
|
+
*/
|
|
134
200
|
image_url?: string;
|
|
135
201
|
}
|
|
136
202
|
|
|
@@ -148,25 +214,58 @@ export namespace ResponseObject {
|
|
|
148
214
|
}
|
|
149
215
|
|
|
150
216
|
export namespace UnionMember2 {
|
|
217
|
+
/**
|
|
218
|
+
* File citation annotation for referencing specific files in response content.
|
|
219
|
+
*/
|
|
151
220
|
export interface OpenAIResponseAnnotationFileCitation {
|
|
221
|
+
/**
|
|
222
|
+
* Unique identifier of the referenced file
|
|
223
|
+
*/
|
|
152
224
|
file_id: string;
|
|
153
225
|
|
|
226
|
+
/**
|
|
227
|
+
* Name of the referenced file
|
|
228
|
+
*/
|
|
154
229
|
filename: string;
|
|
155
230
|
|
|
231
|
+
/**
|
|
232
|
+
* Position index of the citation within the content
|
|
233
|
+
*/
|
|
156
234
|
index: number;
|
|
157
235
|
|
|
236
|
+
/**
|
|
237
|
+
* Annotation type identifier, always "file_citation"
|
|
238
|
+
*/
|
|
158
239
|
type: 'file_citation';
|
|
159
240
|
}
|
|
160
241
|
|
|
242
|
+
/**
|
|
243
|
+
* URL citation annotation for referencing external web resources.
|
|
244
|
+
*/
|
|
161
245
|
export interface OpenAIResponseAnnotationCitation {
|
|
246
|
+
/**
|
|
247
|
+
* End position of the citation span in the content
|
|
248
|
+
*/
|
|
162
249
|
end_index: number;
|
|
163
250
|
|
|
251
|
+
/**
|
|
252
|
+
* Start position of the citation span in the content
|
|
253
|
+
*/
|
|
164
254
|
start_index: number;
|
|
165
255
|
|
|
256
|
+
/**
|
|
257
|
+
* Title of the referenced web resource
|
|
258
|
+
*/
|
|
166
259
|
title: string;
|
|
167
260
|
|
|
261
|
+
/**
|
|
262
|
+
* Annotation type identifier, always "url_citation"
|
|
263
|
+
*/
|
|
168
264
|
type: 'url_citation';
|
|
169
265
|
|
|
266
|
+
/**
|
|
267
|
+
* URL of the referenced web resource
|
|
268
|
+
*/
|
|
170
269
|
url: string;
|
|
171
270
|
}
|
|
172
271
|
|
|
@@ -194,86 +293,191 @@ export namespace ResponseObject {
|
|
|
194
293
|
}
|
|
195
294
|
}
|
|
196
295
|
|
|
296
|
+
/**
|
|
297
|
+
* Web search tool call output message for OpenAI responses.
|
|
298
|
+
*/
|
|
197
299
|
export interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
300
|
+
/**
|
|
301
|
+
* Unique identifier for this tool call
|
|
302
|
+
*/
|
|
198
303
|
id: string;
|
|
199
304
|
|
|
305
|
+
/**
|
|
306
|
+
* Current status of the web search operation
|
|
307
|
+
*/
|
|
200
308
|
status: string;
|
|
201
309
|
|
|
310
|
+
/**
|
|
311
|
+
* Tool call type identifier, always "web_search_call"
|
|
312
|
+
*/
|
|
202
313
|
type: 'web_search_call';
|
|
203
314
|
}
|
|
204
315
|
|
|
316
|
+
/**
|
|
317
|
+
* File search tool call output message for OpenAI responses.
|
|
318
|
+
*/
|
|
205
319
|
export interface OpenAIResponseOutputMessageFileSearchToolCall {
|
|
320
|
+
/**
|
|
321
|
+
* Unique identifier for this tool call
|
|
322
|
+
*/
|
|
206
323
|
id: string;
|
|
207
324
|
|
|
325
|
+
/**
|
|
326
|
+
* List of search queries executed
|
|
327
|
+
*/
|
|
208
328
|
queries: Array<string>;
|
|
209
329
|
|
|
330
|
+
/**
|
|
331
|
+
* Current status of the file search operation
|
|
332
|
+
*/
|
|
210
333
|
status: string;
|
|
211
334
|
|
|
335
|
+
/**
|
|
336
|
+
* Tool call type identifier, always "file_search_call"
|
|
337
|
+
*/
|
|
212
338
|
type: 'file_search_call';
|
|
213
339
|
|
|
340
|
+
/**
|
|
341
|
+
* (Optional) Search results returned by the file search operation
|
|
342
|
+
*/
|
|
214
343
|
results?: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
|
|
215
344
|
}
|
|
216
345
|
|
|
346
|
+
/**
|
|
347
|
+
* Function tool call output message for OpenAI responses.
|
|
348
|
+
*/
|
|
217
349
|
export interface OpenAIResponseOutputMessageFunctionToolCall {
|
|
350
|
+
/**
|
|
351
|
+
* JSON string containing the function arguments
|
|
352
|
+
*/
|
|
218
353
|
arguments: string;
|
|
219
354
|
|
|
355
|
+
/**
|
|
356
|
+
* Unique identifier for the function call
|
|
357
|
+
*/
|
|
220
358
|
call_id: string;
|
|
221
359
|
|
|
360
|
+
/**
|
|
361
|
+
* Name of the function being called
|
|
362
|
+
*/
|
|
222
363
|
name: string;
|
|
223
364
|
|
|
365
|
+
/**
|
|
366
|
+
* Tool call type identifier, always "function_call"
|
|
367
|
+
*/
|
|
224
368
|
type: 'function_call';
|
|
225
369
|
|
|
370
|
+
/**
|
|
371
|
+
* (Optional) Additional identifier for the tool call
|
|
372
|
+
*/
|
|
226
373
|
id?: string;
|
|
227
374
|
|
|
375
|
+
/**
|
|
376
|
+
* (Optional) Current status of the function call execution
|
|
377
|
+
*/
|
|
228
378
|
status?: string;
|
|
229
379
|
}
|
|
230
380
|
|
|
381
|
+
/**
|
|
382
|
+
* Model Context Protocol (MCP) call output message for OpenAI responses.
|
|
383
|
+
*/
|
|
231
384
|
export interface OpenAIResponseOutputMessageMcpCall {
|
|
385
|
+
/**
|
|
386
|
+
* Unique identifier for this MCP call
|
|
387
|
+
*/
|
|
232
388
|
id: string;
|
|
233
389
|
|
|
390
|
+
/**
|
|
391
|
+
* JSON string containing the MCP call arguments
|
|
392
|
+
*/
|
|
234
393
|
arguments: string;
|
|
235
394
|
|
|
395
|
+
/**
|
|
396
|
+
* Name of the MCP method being called
|
|
397
|
+
*/
|
|
236
398
|
name: string;
|
|
237
399
|
|
|
400
|
+
/**
|
|
401
|
+
* Label identifying the MCP server handling the call
|
|
402
|
+
*/
|
|
238
403
|
server_label: string;
|
|
239
404
|
|
|
405
|
+
/**
|
|
406
|
+
* Tool call type identifier, always "mcp_call"
|
|
407
|
+
*/
|
|
240
408
|
type: 'mcp_call';
|
|
241
409
|
|
|
410
|
+
/**
|
|
411
|
+
* (Optional) Error message if the MCP call failed
|
|
412
|
+
*/
|
|
242
413
|
error?: string;
|
|
243
414
|
|
|
415
|
+
/**
|
|
416
|
+
* (Optional) Output result from the successful MCP call
|
|
417
|
+
*/
|
|
244
418
|
output?: string;
|
|
245
419
|
}
|
|
246
420
|
|
|
421
|
+
/**
|
|
422
|
+
* MCP list tools output message containing available tools from an MCP server.
|
|
423
|
+
*/
|
|
247
424
|
export interface OpenAIResponseOutputMessageMcpListTools {
|
|
425
|
+
/**
|
|
426
|
+
* Unique identifier for this MCP list tools operation
|
|
427
|
+
*/
|
|
248
428
|
id: string;
|
|
249
429
|
|
|
430
|
+
/**
|
|
431
|
+
* Label identifying the MCP server providing the tools
|
|
432
|
+
*/
|
|
250
433
|
server_label: string;
|
|
251
434
|
|
|
435
|
+
/**
|
|
436
|
+
* List of available tools provided by the MCP server
|
|
437
|
+
*/
|
|
252
438
|
tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
|
|
253
439
|
|
|
440
|
+
/**
|
|
441
|
+
* Tool call type identifier, always "mcp_list_tools"
|
|
442
|
+
*/
|
|
254
443
|
type: 'mcp_list_tools';
|
|
255
444
|
}
|
|
256
445
|
|
|
257
446
|
export namespace OpenAIResponseOutputMessageMcpListTools {
|
|
447
|
+
/**
|
|
448
|
+
* Tool definition returned by MCP list tools operation.
|
|
449
|
+
*/
|
|
258
450
|
export interface Tool {
|
|
451
|
+
/**
|
|
452
|
+
* JSON schema defining the tool's input parameters
|
|
453
|
+
*/
|
|
259
454
|
input_schema: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
|
|
260
455
|
|
|
456
|
+
/**
|
|
457
|
+
* Name of the tool
|
|
458
|
+
*/
|
|
261
459
|
name: string;
|
|
262
460
|
|
|
461
|
+
/**
|
|
462
|
+
* (Optional) Description of what the tool does
|
|
463
|
+
*/
|
|
263
464
|
description?: string;
|
|
264
465
|
}
|
|
265
466
|
}
|
|
266
467
|
|
|
468
|
+
/**
|
|
469
|
+
* Text formatting configuration for the response
|
|
470
|
+
*/
|
|
267
471
|
export interface Text {
|
|
268
472
|
/**
|
|
269
|
-
*
|
|
473
|
+
* (Optional) Text format configuration specifying output format requirements
|
|
270
474
|
*/
|
|
271
475
|
format?: Text.Format;
|
|
272
476
|
}
|
|
273
477
|
|
|
274
478
|
export namespace Text {
|
|
275
479
|
/**
|
|
276
|
-
*
|
|
480
|
+
* (Optional) Text format configuration specifying output format requirements
|
|
277
481
|
*/
|
|
278
482
|
export interface Format {
|
|
279
483
|
/**
|
|
@@ -305,13 +509,25 @@ export namespace ResponseObject {
|
|
|
305
509
|
}
|
|
306
510
|
}
|
|
307
511
|
|
|
512
|
+
/**
|
|
513
|
+
* (Optional) Error details if the response generation failed
|
|
514
|
+
*/
|
|
308
515
|
export interface Error {
|
|
516
|
+
/**
|
|
517
|
+
* Error code identifying the type of failure
|
|
518
|
+
*/
|
|
309
519
|
code: string;
|
|
310
520
|
|
|
521
|
+
/**
|
|
522
|
+
* Human-readable error message describing the failure
|
|
523
|
+
*/
|
|
311
524
|
message: string;
|
|
312
525
|
}
|
|
313
526
|
}
|
|
314
527
|
|
|
528
|
+
/**
|
|
529
|
+
* Streaming event indicating a new response has been created.
|
|
530
|
+
*/
|
|
315
531
|
export type ResponseObjectStream =
|
|
316
532
|
| ResponseObjectStream.OpenAIResponseObjectStreamResponseCreated
|
|
317
533
|
| ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputItemAdded
|
|
@@ -334,17 +550,27 @@ export type ResponseObjectStream =
|
|
|
334
550
|
| ResponseObjectStream.OpenAIResponseObjectStreamResponseCompleted;
|
|
335
551
|
|
|
336
552
|
export namespace ResponseObjectStream {
|
|
553
|
+
/**
|
|
554
|
+
* Streaming event indicating a new response has been created.
|
|
555
|
+
*/
|
|
337
556
|
export interface OpenAIResponseObjectStreamResponseCreated {
|
|
557
|
+
/**
|
|
558
|
+
* The newly created response object
|
|
559
|
+
*/
|
|
338
560
|
response: ResponsesAPI.ResponseObject;
|
|
339
561
|
|
|
562
|
+
/**
|
|
563
|
+
* Event type identifier, always "response.created"
|
|
564
|
+
*/
|
|
340
565
|
type: 'response.created';
|
|
341
566
|
}
|
|
342
567
|
|
|
568
|
+
/**
|
|
569
|
+
* Streaming event for when a new output item is added to the response.
|
|
570
|
+
*/
|
|
343
571
|
export interface OpenAIResponseObjectStreamResponseOutputItemAdded {
|
|
344
572
|
/**
|
|
345
|
-
*
|
|
346
|
-
* under one type because the Responses API gives them all the same "type" value,
|
|
347
|
-
* and there is no way to tell them apart in certain scenarios.
|
|
573
|
+
* The output item that was added (message, tool call, etc.)
|
|
348
574
|
*/
|
|
349
575
|
item:
|
|
350
576
|
| OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMessage
|
|
@@ -354,12 +580,24 @@ export namespace ResponseObjectStream {
|
|
|
354
580
|
| OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpCall
|
|
355
581
|
| OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpListTools;
|
|
356
582
|
|
|
583
|
+
/**
|
|
584
|
+
* Index position of this item in the output list
|
|
585
|
+
*/
|
|
357
586
|
output_index: number;
|
|
358
587
|
|
|
588
|
+
/**
|
|
589
|
+
* Unique identifier of the response containing this output
|
|
590
|
+
*/
|
|
359
591
|
response_id: string;
|
|
360
592
|
|
|
593
|
+
/**
|
|
594
|
+
* Sequential number for ordering streaming events
|
|
595
|
+
*/
|
|
361
596
|
sequence_number: number;
|
|
362
597
|
|
|
598
|
+
/**
|
|
599
|
+
* Event type identifier, always "response.output_item.added"
|
|
600
|
+
*/
|
|
363
601
|
type: 'response.output_item.added';
|
|
364
602
|
}
|
|
365
603
|
|
|
@@ -388,17 +626,38 @@ export namespace ResponseObjectStream {
|
|
|
388
626
|
}
|
|
389
627
|
|
|
390
628
|
export namespace OpenAIResponseMessage {
|
|
629
|
+
/**
|
|
630
|
+
* Text content for input messages in OpenAI response format.
|
|
631
|
+
*/
|
|
391
632
|
export interface OpenAIResponseInputMessageContentText {
|
|
633
|
+
/**
|
|
634
|
+
* The text content of the input message
|
|
635
|
+
*/
|
|
392
636
|
text: string;
|
|
393
637
|
|
|
638
|
+
/**
|
|
639
|
+
* Content type identifier, always "input_text"
|
|
640
|
+
*/
|
|
394
641
|
type: 'input_text';
|
|
395
642
|
}
|
|
396
643
|
|
|
644
|
+
/**
|
|
645
|
+
* Image content for input messages in OpenAI response format.
|
|
646
|
+
*/
|
|
397
647
|
export interface OpenAIResponseInputMessageContentImage {
|
|
648
|
+
/**
|
|
649
|
+
* Level of detail for image processing, can be "low", "high", or "auto"
|
|
650
|
+
*/
|
|
398
651
|
detail: 'low' | 'high' | 'auto';
|
|
399
652
|
|
|
653
|
+
/**
|
|
654
|
+
* Content type identifier, always "input_image"
|
|
655
|
+
*/
|
|
400
656
|
type: 'input_image';
|
|
401
657
|
|
|
658
|
+
/**
|
|
659
|
+
* (Optional) URL of the image content
|
|
660
|
+
*/
|
|
402
661
|
image_url?: string;
|
|
403
662
|
}
|
|
404
663
|
|
|
@@ -416,25 +675,58 @@ export namespace ResponseObjectStream {
|
|
|
416
675
|
}
|
|
417
676
|
|
|
418
677
|
export namespace UnionMember2 {
|
|
678
|
+
/**
|
|
679
|
+
* File citation annotation for referencing specific files in response content.
|
|
680
|
+
*/
|
|
419
681
|
export interface OpenAIResponseAnnotationFileCitation {
|
|
682
|
+
/**
|
|
683
|
+
* Unique identifier of the referenced file
|
|
684
|
+
*/
|
|
420
685
|
file_id: string;
|
|
421
686
|
|
|
687
|
+
/**
|
|
688
|
+
* Name of the referenced file
|
|
689
|
+
*/
|
|
422
690
|
filename: string;
|
|
423
691
|
|
|
692
|
+
/**
|
|
693
|
+
* Position index of the citation within the content
|
|
694
|
+
*/
|
|
424
695
|
index: number;
|
|
425
696
|
|
|
697
|
+
/**
|
|
698
|
+
* Annotation type identifier, always "file_citation"
|
|
699
|
+
*/
|
|
426
700
|
type: 'file_citation';
|
|
427
701
|
}
|
|
428
702
|
|
|
703
|
+
/**
|
|
704
|
+
* URL citation annotation for referencing external web resources.
|
|
705
|
+
*/
|
|
429
706
|
export interface OpenAIResponseAnnotationCitation {
|
|
707
|
+
/**
|
|
708
|
+
* End position of the citation span in the content
|
|
709
|
+
*/
|
|
430
710
|
end_index: number;
|
|
431
711
|
|
|
712
|
+
/**
|
|
713
|
+
* Start position of the citation span in the content
|
|
714
|
+
*/
|
|
432
715
|
start_index: number;
|
|
433
716
|
|
|
717
|
+
/**
|
|
718
|
+
* Title of the referenced web resource
|
|
719
|
+
*/
|
|
434
720
|
title: string;
|
|
435
721
|
|
|
722
|
+
/**
|
|
723
|
+
* Annotation type identifier, always "url_citation"
|
|
724
|
+
*/
|
|
436
725
|
type: 'url_citation';
|
|
437
726
|
|
|
727
|
+
/**
|
|
728
|
+
* URL of the referenced web resource
|
|
729
|
+
*/
|
|
438
730
|
url: string;
|
|
439
731
|
}
|
|
440
732
|
|
|
@@ -462,82 +754,185 @@ export namespace ResponseObjectStream {
|
|
|
462
754
|
}
|
|
463
755
|
}
|
|
464
756
|
|
|
757
|
+
/**
|
|
758
|
+
* Web search tool call output message for OpenAI responses.
|
|
759
|
+
*/
|
|
465
760
|
export interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
761
|
+
/**
|
|
762
|
+
* Unique identifier for this tool call
|
|
763
|
+
*/
|
|
466
764
|
id: string;
|
|
467
765
|
|
|
766
|
+
/**
|
|
767
|
+
* Current status of the web search operation
|
|
768
|
+
*/
|
|
468
769
|
status: string;
|
|
469
770
|
|
|
771
|
+
/**
|
|
772
|
+
* Tool call type identifier, always "web_search_call"
|
|
773
|
+
*/
|
|
470
774
|
type: 'web_search_call';
|
|
471
775
|
}
|
|
472
776
|
|
|
777
|
+
/**
|
|
778
|
+
* File search tool call output message for OpenAI responses.
|
|
779
|
+
*/
|
|
473
780
|
export interface OpenAIResponseOutputMessageFileSearchToolCall {
|
|
781
|
+
/**
|
|
782
|
+
* Unique identifier for this tool call
|
|
783
|
+
*/
|
|
474
784
|
id: string;
|
|
475
785
|
|
|
786
|
+
/**
|
|
787
|
+
* List of search queries executed
|
|
788
|
+
*/
|
|
476
789
|
queries: Array<string>;
|
|
477
790
|
|
|
791
|
+
/**
|
|
792
|
+
* Current status of the file search operation
|
|
793
|
+
*/
|
|
478
794
|
status: string;
|
|
479
795
|
|
|
796
|
+
/**
|
|
797
|
+
* Tool call type identifier, always "file_search_call"
|
|
798
|
+
*/
|
|
480
799
|
type: 'file_search_call';
|
|
481
800
|
|
|
801
|
+
/**
|
|
802
|
+
* (Optional) Search results returned by the file search operation
|
|
803
|
+
*/
|
|
482
804
|
results?: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
|
|
483
805
|
}
|
|
484
806
|
|
|
807
|
+
/**
|
|
808
|
+
* Function tool call output message for OpenAI responses.
|
|
809
|
+
*/
|
|
485
810
|
export interface OpenAIResponseOutputMessageFunctionToolCall {
|
|
811
|
+
/**
|
|
812
|
+
* JSON string containing the function arguments
|
|
813
|
+
*/
|
|
486
814
|
arguments: string;
|
|
487
815
|
|
|
816
|
+
/**
|
|
817
|
+
* Unique identifier for the function call
|
|
818
|
+
*/
|
|
488
819
|
call_id: string;
|
|
489
820
|
|
|
821
|
+
/**
|
|
822
|
+
* Name of the function being called
|
|
823
|
+
*/
|
|
490
824
|
name: string;
|
|
491
825
|
|
|
826
|
+
/**
|
|
827
|
+
* Tool call type identifier, always "function_call"
|
|
828
|
+
*/
|
|
492
829
|
type: 'function_call';
|
|
493
830
|
|
|
831
|
+
/**
|
|
832
|
+
* (Optional) Additional identifier for the tool call
|
|
833
|
+
*/
|
|
494
834
|
id?: string;
|
|
495
835
|
|
|
836
|
+
/**
|
|
837
|
+
* (Optional) Current status of the function call execution
|
|
838
|
+
*/
|
|
496
839
|
status?: string;
|
|
497
840
|
}
|
|
498
841
|
|
|
842
|
+
/**
|
|
843
|
+
* Model Context Protocol (MCP) call output message for OpenAI responses.
|
|
844
|
+
*/
|
|
499
845
|
export interface OpenAIResponseOutputMessageMcpCall {
|
|
846
|
+
/**
|
|
847
|
+
* Unique identifier for this MCP call
|
|
848
|
+
*/
|
|
500
849
|
id: string;
|
|
501
850
|
|
|
851
|
+
/**
|
|
852
|
+
* JSON string containing the MCP call arguments
|
|
853
|
+
*/
|
|
502
854
|
arguments: string;
|
|
503
855
|
|
|
856
|
+
/**
|
|
857
|
+
* Name of the MCP method being called
|
|
858
|
+
*/
|
|
504
859
|
name: string;
|
|
505
860
|
|
|
861
|
+
/**
|
|
862
|
+
* Label identifying the MCP server handling the call
|
|
863
|
+
*/
|
|
506
864
|
server_label: string;
|
|
507
865
|
|
|
866
|
+
/**
|
|
867
|
+
* Tool call type identifier, always "mcp_call"
|
|
868
|
+
*/
|
|
508
869
|
type: 'mcp_call';
|
|
509
870
|
|
|
871
|
+
/**
|
|
872
|
+
* (Optional) Error message if the MCP call failed
|
|
873
|
+
*/
|
|
510
874
|
error?: string;
|
|
511
875
|
|
|
876
|
+
/**
|
|
877
|
+
* (Optional) Output result from the successful MCP call
|
|
878
|
+
*/
|
|
512
879
|
output?: string;
|
|
513
880
|
}
|
|
514
881
|
|
|
882
|
+
/**
|
|
883
|
+
* MCP list tools output message containing available tools from an MCP server.
|
|
884
|
+
*/
|
|
515
885
|
export interface OpenAIResponseOutputMessageMcpListTools {
|
|
886
|
+
/**
|
|
887
|
+
* Unique identifier for this MCP list tools operation
|
|
888
|
+
*/
|
|
516
889
|
id: string;
|
|
517
890
|
|
|
891
|
+
/**
|
|
892
|
+
* Label identifying the MCP server providing the tools
|
|
893
|
+
*/
|
|
518
894
|
server_label: string;
|
|
519
895
|
|
|
896
|
+
/**
|
|
897
|
+
* List of available tools provided by the MCP server
|
|
898
|
+
*/
|
|
520
899
|
tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
|
|
521
900
|
|
|
901
|
+
/**
|
|
902
|
+
* Tool call type identifier, always "mcp_list_tools"
|
|
903
|
+
*/
|
|
522
904
|
type: 'mcp_list_tools';
|
|
523
905
|
}
|
|
524
906
|
|
|
525
907
|
export namespace OpenAIResponseOutputMessageMcpListTools {
|
|
908
|
+
/**
|
|
909
|
+
* Tool definition returned by MCP list tools operation.
|
|
910
|
+
*/
|
|
526
911
|
export interface Tool {
|
|
912
|
+
/**
|
|
913
|
+
* JSON schema defining the tool's input parameters
|
|
914
|
+
*/
|
|
527
915
|
input_schema: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
|
|
528
916
|
|
|
917
|
+
/**
|
|
918
|
+
* Name of the tool
|
|
919
|
+
*/
|
|
529
920
|
name: string;
|
|
530
921
|
|
|
922
|
+
/**
|
|
923
|
+
* (Optional) Description of what the tool does
|
|
924
|
+
*/
|
|
531
925
|
description?: string;
|
|
532
926
|
}
|
|
533
927
|
}
|
|
534
928
|
}
|
|
535
929
|
|
|
930
|
+
/**
|
|
931
|
+
* Streaming event for when an output item is completed.
|
|
932
|
+
*/
|
|
536
933
|
export interface OpenAIResponseObjectStreamResponseOutputItemDone {
|
|
537
934
|
/**
|
|
538
|
-
*
|
|
539
|
-
* under one type because the Responses API gives them all the same "type" value,
|
|
540
|
-
* and there is no way to tell them apart in certain scenarios.
|
|
935
|
+
* The completed output item (message, tool call, etc.)
|
|
541
936
|
*/
|
|
542
937
|
item:
|
|
543
938
|
| OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMessage
|
|
@@ -547,12 +942,24 @@ export namespace ResponseObjectStream {
|
|
|
547
942
|
| OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpCall
|
|
548
943
|
| OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpListTools;
|
|
549
944
|
|
|
945
|
+
/**
|
|
946
|
+
* Index position of this item in the output list
|
|
947
|
+
*/
|
|
550
948
|
output_index: number;
|
|
551
949
|
|
|
950
|
+
/**
|
|
951
|
+
* Unique identifier of the response containing this output
|
|
952
|
+
*/
|
|
552
953
|
response_id: string;
|
|
553
954
|
|
|
955
|
+
/**
|
|
956
|
+
* Sequential number for ordering streaming events
|
|
957
|
+
*/
|
|
554
958
|
sequence_number: number;
|
|
555
959
|
|
|
960
|
+
/**
|
|
961
|
+
* Event type identifier, always "response.output_item.done"
|
|
962
|
+
*/
|
|
556
963
|
type: 'response.output_item.done';
|
|
557
964
|
}
|
|
558
965
|
|
|
@@ -581,17 +988,38 @@ export namespace ResponseObjectStream {
|
|
|
581
988
|
}
|
|
582
989
|
|
|
583
990
|
export namespace OpenAIResponseMessage {
|
|
991
|
+
/**
|
|
992
|
+
* Text content for input messages in OpenAI response format.
|
|
993
|
+
*/
|
|
584
994
|
export interface OpenAIResponseInputMessageContentText {
|
|
995
|
+
/**
|
|
996
|
+
* The text content of the input message
|
|
997
|
+
*/
|
|
585
998
|
text: string;
|
|
586
999
|
|
|
1000
|
+
/**
|
|
1001
|
+
* Content type identifier, always "input_text"
|
|
1002
|
+
*/
|
|
587
1003
|
type: 'input_text';
|
|
588
1004
|
}
|
|
589
1005
|
|
|
1006
|
+
/**
|
|
1007
|
+
* Image content for input messages in OpenAI response format.
|
|
1008
|
+
*/
|
|
590
1009
|
export interface OpenAIResponseInputMessageContentImage {
|
|
1010
|
+
/**
|
|
1011
|
+
* Level of detail for image processing, can be "low", "high", or "auto"
|
|
1012
|
+
*/
|
|
591
1013
|
detail: 'low' | 'high' | 'auto';
|
|
592
1014
|
|
|
1015
|
+
/**
|
|
1016
|
+
* Content type identifier, always "input_image"
|
|
1017
|
+
*/
|
|
593
1018
|
type: 'input_image';
|
|
594
1019
|
|
|
1020
|
+
/**
|
|
1021
|
+
* (Optional) URL of the image content
|
|
1022
|
+
*/
|
|
595
1023
|
image_url?: string;
|
|
596
1024
|
}
|
|
597
1025
|
|
|
@@ -609,25 +1037,58 @@ export namespace ResponseObjectStream {
|
|
|
609
1037
|
}
|
|
610
1038
|
|
|
611
1039
|
export namespace UnionMember2 {
|
|
1040
|
+
/**
|
|
1041
|
+
* File citation annotation for referencing specific files in response content.
|
|
1042
|
+
*/
|
|
612
1043
|
export interface OpenAIResponseAnnotationFileCitation {
|
|
1044
|
+
/**
|
|
1045
|
+
* Unique identifier of the referenced file
|
|
1046
|
+
*/
|
|
613
1047
|
file_id: string;
|
|
614
1048
|
|
|
1049
|
+
/**
|
|
1050
|
+
* Name of the referenced file
|
|
1051
|
+
*/
|
|
615
1052
|
filename: string;
|
|
616
1053
|
|
|
1054
|
+
/**
|
|
1055
|
+
* Position index of the citation within the content
|
|
1056
|
+
*/
|
|
617
1057
|
index: number;
|
|
618
1058
|
|
|
1059
|
+
/**
|
|
1060
|
+
* Annotation type identifier, always "file_citation"
|
|
1061
|
+
*/
|
|
619
1062
|
type: 'file_citation';
|
|
620
1063
|
}
|
|
621
1064
|
|
|
1065
|
+
/**
|
|
1066
|
+
* URL citation annotation for referencing external web resources.
|
|
1067
|
+
*/
|
|
622
1068
|
export interface OpenAIResponseAnnotationCitation {
|
|
1069
|
+
/**
|
|
1070
|
+
* End position of the citation span in the content
|
|
1071
|
+
*/
|
|
623
1072
|
end_index: number;
|
|
624
1073
|
|
|
1074
|
+
/**
|
|
1075
|
+
* Start position of the citation span in the content
|
|
1076
|
+
*/
|
|
625
1077
|
start_index: number;
|
|
626
1078
|
|
|
1079
|
+
/**
|
|
1080
|
+
* Title of the referenced web resource
|
|
1081
|
+
*/
|
|
627
1082
|
title: string;
|
|
628
1083
|
|
|
1084
|
+
/**
|
|
1085
|
+
* Annotation type identifier, always "url_citation"
|
|
1086
|
+
*/
|
|
629
1087
|
type: 'url_citation';
|
|
630
1088
|
|
|
1089
|
+
/**
|
|
1090
|
+
* URL of the referenced web resource
|
|
1091
|
+
*/
|
|
631
1092
|
url: string;
|
|
632
1093
|
}
|
|
633
1094
|
|
|
@@ -655,136 +1116,331 @@ export namespace ResponseObjectStream {
|
|
|
655
1116
|
}
|
|
656
1117
|
}
|
|
657
1118
|
|
|
1119
|
+
/**
|
|
1120
|
+
* Web search tool call output message for OpenAI responses.
|
|
1121
|
+
*/
|
|
658
1122
|
export interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
1123
|
+
/**
|
|
1124
|
+
* Unique identifier for this tool call
|
|
1125
|
+
*/
|
|
659
1126
|
id: string;
|
|
660
1127
|
|
|
1128
|
+
/**
|
|
1129
|
+
* Current status of the web search operation
|
|
1130
|
+
*/
|
|
661
1131
|
status: string;
|
|
662
1132
|
|
|
1133
|
+
/**
|
|
1134
|
+
* Tool call type identifier, always "web_search_call"
|
|
1135
|
+
*/
|
|
663
1136
|
type: 'web_search_call';
|
|
664
1137
|
}
|
|
665
1138
|
|
|
1139
|
+
/**
|
|
1140
|
+
* File search tool call output message for OpenAI responses.
|
|
1141
|
+
*/
|
|
666
1142
|
export interface OpenAIResponseOutputMessageFileSearchToolCall {
|
|
1143
|
+
/**
|
|
1144
|
+
* Unique identifier for this tool call
|
|
1145
|
+
*/
|
|
667
1146
|
id: string;
|
|
668
1147
|
|
|
1148
|
+
/**
|
|
1149
|
+
* List of search queries executed
|
|
1150
|
+
*/
|
|
669
1151
|
queries: Array<string>;
|
|
670
1152
|
|
|
1153
|
+
/**
|
|
1154
|
+
* Current status of the file search operation
|
|
1155
|
+
*/
|
|
671
1156
|
status: string;
|
|
672
1157
|
|
|
1158
|
+
/**
|
|
1159
|
+
* Tool call type identifier, always "file_search_call"
|
|
1160
|
+
*/
|
|
673
1161
|
type: 'file_search_call';
|
|
674
1162
|
|
|
1163
|
+
/**
|
|
1164
|
+
* (Optional) Search results returned by the file search operation
|
|
1165
|
+
*/
|
|
675
1166
|
results?: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
|
|
676
1167
|
}
|
|
677
1168
|
|
|
1169
|
+
/**
|
|
1170
|
+
* Function tool call output message for OpenAI responses.
|
|
1171
|
+
*/
|
|
678
1172
|
export interface OpenAIResponseOutputMessageFunctionToolCall {
|
|
1173
|
+
/**
|
|
1174
|
+
* JSON string containing the function arguments
|
|
1175
|
+
*/
|
|
679
1176
|
arguments: string;
|
|
680
1177
|
|
|
1178
|
+
/**
|
|
1179
|
+
* Unique identifier for the function call
|
|
1180
|
+
*/
|
|
681
1181
|
call_id: string;
|
|
682
1182
|
|
|
1183
|
+
/**
|
|
1184
|
+
* Name of the function being called
|
|
1185
|
+
*/
|
|
683
1186
|
name: string;
|
|
684
1187
|
|
|
1188
|
+
/**
|
|
1189
|
+
* Tool call type identifier, always "function_call"
|
|
1190
|
+
*/
|
|
685
1191
|
type: 'function_call';
|
|
686
1192
|
|
|
1193
|
+
/**
|
|
1194
|
+
* (Optional) Additional identifier for the tool call
|
|
1195
|
+
*/
|
|
687
1196
|
id?: string;
|
|
688
1197
|
|
|
1198
|
+
/**
|
|
1199
|
+
* (Optional) Current status of the function call execution
|
|
1200
|
+
*/
|
|
689
1201
|
status?: string;
|
|
690
1202
|
}
|
|
691
1203
|
|
|
1204
|
+
/**
|
|
1205
|
+
* Model Context Protocol (MCP) call output message for OpenAI responses.
|
|
1206
|
+
*/
|
|
692
1207
|
export interface OpenAIResponseOutputMessageMcpCall {
|
|
1208
|
+
/**
|
|
1209
|
+
* Unique identifier for this MCP call
|
|
1210
|
+
*/
|
|
693
1211
|
id: string;
|
|
694
1212
|
|
|
1213
|
+
/**
|
|
1214
|
+
* JSON string containing the MCP call arguments
|
|
1215
|
+
*/
|
|
695
1216
|
arguments: string;
|
|
696
1217
|
|
|
1218
|
+
/**
|
|
1219
|
+
* Name of the MCP method being called
|
|
1220
|
+
*/
|
|
697
1221
|
name: string;
|
|
698
1222
|
|
|
1223
|
+
/**
|
|
1224
|
+
* Label identifying the MCP server handling the call
|
|
1225
|
+
*/
|
|
699
1226
|
server_label: string;
|
|
700
1227
|
|
|
1228
|
+
/**
|
|
1229
|
+
* Tool call type identifier, always "mcp_call"
|
|
1230
|
+
*/
|
|
701
1231
|
type: 'mcp_call';
|
|
702
1232
|
|
|
1233
|
+
/**
|
|
1234
|
+
* (Optional) Error message if the MCP call failed
|
|
1235
|
+
*/
|
|
703
1236
|
error?: string;
|
|
704
1237
|
|
|
1238
|
+
/**
|
|
1239
|
+
* (Optional) Output result from the successful MCP call
|
|
1240
|
+
*/
|
|
705
1241
|
output?: string;
|
|
706
1242
|
}
|
|
707
1243
|
|
|
1244
|
+
/**
|
|
1245
|
+
* MCP list tools output message containing available tools from an MCP server.
|
|
1246
|
+
*/
|
|
708
1247
|
export interface OpenAIResponseOutputMessageMcpListTools {
|
|
1248
|
+
/**
|
|
1249
|
+
* Unique identifier for this MCP list tools operation
|
|
1250
|
+
*/
|
|
709
1251
|
id: string;
|
|
710
1252
|
|
|
1253
|
+
/**
|
|
1254
|
+
* Label identifying the MCP server providing the tools
|
|
1255
|
+
*/
|
|
711
1256
|
server_label: string;
|
|
712
1257
|
|
|
1258
|
+
/**
|
|
1259
|
+
* List of available tools provided by the MCP server
|
|
1260
|
+
*/
|
|
713
1261
|
tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
|
|
714
1262
|
|
|
1263
|
+
/**
|
|
1264
|
+
* Tool call type identifier, always "mcp_list_tools"
|
|
1265
|
+
*/
|
|
715
1266
|
type: 'mcp_list_tools';
|
|
716
1267
|
}
|
|
717
1268
|
|
|
718
1269
|
export namespace OpenAIResponseOutputMessageMcpListTools {
|
|
1270
|
+
/**
|
|
1271
|
+
* Tool definition returned by MCP list tools operation.
|
|
1272
|
+
*/
|
|
719
1273
|
export interface Tool {
|
|
1274
|
+
/**
|
|
1275
|
+
* JSON schema defining the tool's input parameters
|
|
1276
|
+
*/
|
|
720
1277
|
input_schema: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
|
|
721
1278
|
|
|
1279
|
+
/**
|
|
1280
|
+
* Name of the tool
|
|
1281
|
+
*/
|
|
722
1282
|
name: string;
|
|
723
1283
|
|
|
1284
|
+
/**
|
|
1285
|
+
* (Optional) Description of what the tool does
|
|
1286
|
+
*/
|
|
724
1287
|
description?: string;
|
|
725
1288
|
}
|
|
726
1289
|
}
|
|
727
1290
|
}
|
|
728
1291
|
|
|
1292
|
+
/**
|
|
1293
|
+
* Streaming event for incremental text content updates.
|
|
1294
|
+
*/
|
|
729
1295
|
export interface OpenAIResponseObjectStreamResponseOutputTextDelta {
|
|
1296
|
+
/**
|
|
1297
|
+
* Index position within the text content
|
|
1298
|
+
*/
|
|
730
1299
|
content_index: number;
|
|
731
1300
|
|
|
1301
|
+
/**
|
|
1302
|
+
* Incremental text content being added
|
|
1303
|
+
*/
|
|
732
1304
|
delta: string;
|
|
733
1305
|
|
|
1306
|
+
/**
|
|
1307
|
+
* Unique identifier of the output item being updated
|
|
1308
|
+
*/
|
|
734
1309
|
item_id: string;
|
|
735
1310
|
|
|
1311
|
+
/**
|
|
1312
|
+
* Index position of the item in the output list
|
|
1313
|
+
*/
|
|
736
1314
|
output_index: number;
|
|
737
1315
|
|
|
1316
|
+
/**
|
|
1317
|
+
* Sequential number for ordering streaming events
|
|
1318
|
+
*/
|
|
738
1319
|
sequence_number: number;
|
|
739
1320
|
|
|
1321
|
+
/**
|
|
1322
|
+
* Event type identifier, always "response.output_text.delta"
|
|
1323
|
+
*/
|
|
740
1324
|
type: 'response.output_text.delta';
|
|
741
1325
|
}
|
|
742
1326
|
|
|
1327
|
+
/**
|
|
1328
|
+
* Streaming event for when text output is completed.
|
|
1329
|
+
*/
|
|
743
1330
|
export interface OpenAIResponseObjectStreamResponseOutputTextDone {
|
|
1331
|
+
/**
|
|
1332
|
+
* Index position within the text content
|
|
1333
|
+
*/
|
|
744
1334
|
content_index: number;
|
|
745
1335
|
|
|
1336
|
+
/**
|
|
1337
|
+
* Unique identifier of the completed output item
|
|
1338
|
+
*/
|
|
746
1339
|
item_id: string;
|
|
747
1340
|
|
|
1341
|
+
/**
|
|
1342
|
+
* Index position of the item in the output list
|
|
1343
|
+
*/
|
|
748
1344
|
output_index: number;
|
|
749
1345
|
|
|
1346
|
+
/**
|
|
1347
|
+
* Sequential number for ordering streaming events
|
|
1348
|
+
*/
|
|
750
1349
|
sequence_number: number;
|
|
751
1350
|
|
|
1351
|
+
/**
|
|
1352
|
+
* Final complete text content of the output item
|
|
1353
|
+
*/
|
|
752
1354
|
text: string;
|
|
753
1355
|
|
|
1356
|
+
/**
|
|
1357
|
+
* Event type identifier, always "response.output_text.done"
|
|
1358
|
+
*/
|
|
754
1359
|
type: 'response.output_text.done';
|
|
755
1360
|
}
|
|
756
1361
|
|
|
1362
|
+
/**
|
|
1363
|
+
* Streaming event for incremental function call argument updates.
|
|
1364
|
+
*/
|
|
757
1365
|
export interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta {
|
|
1366
|
+
/**
|
|
1367
|
+
* Incremental function call arguments being added
|
|
1368
|
+
*/
|
|
758
1369
|
delta: string;
|
|
759
1370
|
|
|
1371
|
+
/**
|
|
1372
|
+
* Unique identifier of the function call being updated
|
|
1373
|
+
*/
|
|
760
1374
|
item_id: string;
|
|
761
1375
|
|
|
1376
|
+
/**
|
|
1377
|
+
* Index position of the item in the output list
|
|
1378
|
+
*/
|
|
762
1379
|
output_index: number;
|
|
763
1380
|
|
|
1381
|
+
/**
|
|
1382
|
+
* Sequential number for ordering streaming events
|
|
1383
|
+
*/
|
|
764
1384
|
sequence_number: number;
|
|
765
1385
|
|
|
1386
|
+
/**
|
|
1387
|
+
* Event type identifier, always "response.function_call_arguments.delta"
|
|
1388
|
+
*/
|
|
766
1389
|
type: 'response.function_call_arguments.delta';
|
|
767
1390
|
}
|
|
768
1391
|
|
|
1392
|
+
/**
|
|
1393
|
+
* Streaming event for when function call arguments are completed.
|
|
1394
|
+
*/
|
|
769
1395
|
export interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone {
|
|
1396
|
+
/**
|
|
1397
|
+
* Final complete arguments JSON string for the function call
|
|
1398
|
+
*/
|
|
770
1399
|
arguments: string;
|
|
771
1400
|
|
|
1401
|
+
/**
|
|
1402
|
+
* Unique identifier of the completed function call
|
|
1403
|
+
*/
|
|
772
1404
|
item_id: string;
|
|
773
1405
|
|
|
1406
|
+
/**
|
|
1407
|
+
* Index position of the item in the output list
|
|
1408
|
+
*/
|
|
774
1409
|
output_index: number;
|
|
775
1410
|
|
|
1411
|
+
/**
|
|
1412
|
+
* Sequential number for ordering streaming events
|
|
1413
|
+
*/
|
|
776
1414
|
sequence_number: number;
|
|
777
1415
|
|
|
1416
|
+
/**
|
|
1417
|
+
* Event type identifier, always "response.function_call_arguments.done"
|
|
1418
|
+
*/
|
|
778
1419
|
type: 'response.function_call_arguments.done';
|
|
779
1420
|
}
|
|
780
1421
|
|
|
1422
|
+
/**
|
|
1423
|
+
* Streaming event for web search calls in progress.
|
|
1424
|
+
*/
|
|
781
1425
|
export interface OpenAIResponseObjectStreamResponseWebSearchCallInProgress {
|
|
1426
|
+
/**
|
|
1427
|
+
* Unique identifier of the web search call
|
|
1428
|
+
*/
|
|
782
1429
|
item_id: string;
|
|
783
1430
|
|
|
1431
|
+
/**
|
|
1432
|
+
* Index position of the item in the output list
|
|
1433
|
+
*/
|
|
784
1434
|
output_index: number;
|
|
785
1435
|
|
|
1436
|
+
/**
|
|
1437
|
+
* Sequential number for ordering streaming events
|
|
1438
|
+
*/
|
|
786
1439
|
sequence_number: number;
|
|
787
1440
|
|
|
1441
|
+
/**
|
|
1442
|
+
* Event type identifier, always "response.web_search_call.in_progress"
|
|
1443
|
+
*/
|
|
788
1444
|
type: 'response.web_search_call.in_progress';
|
|
789
1445
|
}
|
|
790
1446
|
|
|
@@ -798,13 +1454,28 @@ export namespace ResponseObjectStream {
|
|
|
798
1454
|
type: 'response.web_search_call.searching';
|
|
799
1455
|
}
|
|
800
1456
|
|
|
1457
|
+
/**
|
|
1458
|
+
* Streaming event for completed web search calls.
|
|
1459
|
+
*/
|
|
801
1460
|
export interface OpenAIResponseObjectStreamResponseWebSearchCallCompleted {
|
|
1461
|
+
/**
|
|
1462
|
+
* Unique identifier of the completed web search call
|
|
1463
|
+
*/
|
|
802
1464
|
item_id: string;
|
|
803
1465
|
|
|
1466
|
+
/**
|
|
1467
|
+
* Index position of the item in the output list
|
|
1468
|
+
*/
|
|
804
1469
|
output_index: number;
|
|
805
1470
|
|
|
1471
|
+
/**
|
|
1472
|
+
* Sequential number for ordering streaming events
|
|
1473
|
+
*/
|
|
806
1474
|
sequence_number: number;
|
|
807
1475
|
|
|
1476
|
+
/**
|
|
1477
|
+
* Event type identifier, always "response.web_search_call.completed"
|
|
1478
|
+
*/
|
|
808
1479
|
type: 'response.web_search_call.completed';
|
|
809
1480
|
}
|
|
810
1481
|
|
|
@@ -850,53 +1521,125 @@ export namespace ResponseObjectStream {
|
|
|
850
1521
|
type: 'response.mcp_call.arguments.done';
|
|
851
1522
|
}
|
|
852
1523
|
|
|
1524
|
+
/**
|
|
1525
|
+
* Streaming event for MCP calls in progress.
|
|
1526
|
+
*/
|
|
853
1527
|
export interface OpenAIResponseObjectStreamResponseMcpCallInProgress {
|
|
1528
|
+
/**
|
|
1529
|
+
* Unique identifier of the MCP call
|
|
1530
|
+
*/
|
|
854
1531
|
item_id: string;
|
|
855
1532
|
|
|
1533
|
+
/**
|
|
1534
|
+
* Index position of the item in the output list
|
|
1535
|
+
*/
|
|
856
1536
|
output_index: number;
|
|
857
1537
|
|
|
1538
|
+
/**
|
|
1539
|
+
* Sequential number for ordering streaming events
|
|
1540
|
+
*/
|
|
858
1541
|
sequence_number: number;
|
|
859
1542
|
|
|
1543
|
+
/**
|
|
1544
|
+
* Event type identifier, always "response.mcp_call.in_progress"
|
|
1545
|
+
*/
|
|
860
1546
|
type: 'response.mcp_call.in_progress';
|
|
861
1547
|
}
|
|
862
1548
|
|
|
1549
|
+
/**
|
|
1550
|
+
* Streaming event for failed MCP calls.
|
|
1551
|
+
*/
|
|
863
1552
|
export interface OpenAIResponseObjectStreamResponseMcpCallFailed {
|
|
1553
|
+
/**
|
|
1554
|
+
* Sequential number for ordering streaming events
|
|
1555
|
+
*/
|
|
864
1556
|
sequence_number: number;
|
|
865
1557
|
|
|
1558
|
+
/**
|
|
1559
|
+
* Event type identifier, always "response.mcp_call.failed"
|
|
1560
|
+
*/
|
|
866
1561
|
type: 'response.mcp_call.failed';
|
|
867
1562
|
}
|
|
868
1563
|
|
|
1564
|
+
/**
|
|
1565
|
+
* Streaming event for completed MCP calls.
|
|
1566
|
+
*/
|
|
869
1567
|
export interface OpenAIResponseObjectStreamResponseMcpCallCompleted {
|
|
1568
|
+
/**
|
|
1569
|
+
* Sequential number for ordering streaming events
|
|
1570
|
+
*/
|
|
870
1571
|
sequence_number: number;
|
|
871
1572
|
|
|
1573
|
+
/**
|
|
1574
|
+
* Event type identifier, always "response.mcp_call.completed"
|
|
1575
|
+
*/
|
|
872
1576
|
type: 'response.mcp_call.completed';
|
|
873
1577
|
}
|
|
874
1578
|
|
|
1579
|
+
/**
|
|
1580
|
+
* Streaming event indicating a response has been completed.
|
|
1581
|
+
*/
|
|
875
1582
|
export interface OpenAIResponseObjectStreamResponseCompleted {
|
|
1583
|
+
/**
|
|
1584
|
+
* The completed response object
|
|
1585
|
+
*/
|
|
876
1586
|
response: ResponsesAPI.ResponseObject;
|
|
877
1587
|
|
|
1588
|
+
/**
|
|
1589
|
+
* Event type identifier, always "response.completed"
|
|
1590
|
+
*/
|
|
878
1591
|
type: 'response.completed';
|
|
879
1592
|
}
|
|
880
1593
|
}
|
|
881
1594
|
|
|
1595
|
+
/**
|
|
1596
|
+
* Paginated list of OpenAI response objects with navigation metadata.
|
|
1597
|
+
*/
|
|
882
1598
|
export interface ResponseListResponse {
|
|
1599
|
+
/**
|
|
1600
|
+
* List of response objects with their input context
|
|
1601
|
+
*/
|
|
883
1602
|
data: Array<ResponseListResponse.Data>;
|
|
884
1603
|
|
|
1604
|
+
/**
|
|
1605
|
+
* Identifier of the first item in this page
|
|
1606
|
+
*/
|
|
885
1607
|
first_id: string;
|
|
886
1608
|
|
|
1609
|
+
/**
|
|
1610
|
+
* Whether there are more results available beyond this page
|
|
1611
|
+
*/
|
|
887
1612
|
has_more: boolean;
|
|
888
1613
|
|
|
1614
|
+
/**
|
|
1615
|
+
* Identifier of the last item in this page
|
|
1616
|
+
*/
|
|
889
1617
|
last_id: string;
|
|
890
1618
|
|
|
1619
|
+
/**
|
|
1620
|
+
* Object type identifier, always "list"
|
|
1621
|
+
*/
|
|
891
1622
|
object: 'list';
|
|
892
1623
|
}
|
|
893
1624
|
|
|
894
1625
|
export namespace ResponseListResponse {
|
|
1626
|
+
/**
|
|
1627
|
+
* OpenAI response object extended with input context information.
|
|
1628
|
+
*/
|
|
895
1629
|
export interface Data {
|
|
1630
|
+
/**
|
|
1631
|
+
* Unique identifier for this response
|
|
1632
|
+
*/
|
|
896
1633
|
id: string;
|
|
897
1634
|
|
|
1635
|
+
/**
|
|
1636
|
+
* Unix timestamp when the response was created
|
|
1637
|
+
*/
|
|
898
1638
|
created_at: number;
|
|
899
1639
|
|
|
1640
|
+
/**
|
|
1641
|
+
* List of input items that led to this response
|
|
1642
|
+
*/
|
|
900
1643
|
input: Array<
|
|
901
1644
|
| Data.OpenAIResponseOutputMessageWebSearchToolCall
|
|
902
1645
|
| Data.OpenAIResponseOutputMessageFileSearchToolCall
|
|
@@ -905,10 +1648,19 @@ export namespace ResponseListResponse {
|
|
|
905
1648
|
| Data.OpenAIResponseMessage
|
|
906
1649
|
>;
|
|
907
1650
|
|
|
1651
|
+
/**
|
|
1652
|
+
* Model identifier used for generation
|
|
1653
|
+
*/
|
|
908
1654
|
model: string;
|
|
909
1655
|
|
|
1656
|
+
/**
|
|
1657
|
+
* Object type identifier, always "response"
|
|
1658
|
+
*/
|
|
910
1659
|
object: 'response';
|
|
911
1660
|
|
|
1661
|
+
/**
|
|
1662
|
+
* List of generated output items (messages, tool calls, etc.)
|
|
1663
|
+
*/
|
|
912
1664
|
output: Array<
|
|
913
1665
|
| Data.OpenAIResponseMessage
|
|
914
1666
|
| Data.OpenAIResponseOutputMessageWebSearchToolCall
|
|
@@ -918,57 +1670,135 @@ export namespace ResponseListResponse {
|
|
|
918
1670
|
| Data.OpenAIResponseOutputMessageMcpListTools
|
|
919
1671
|
>;
|
|
920
1672
|
|
|
1673
|
+
/**
|
|
1674
|
+
* Whether tool calls can be executed in parallel
|
|
1675
|
+
*/
|
|
921
1676
|
parallel_tool_calls: boolean;
|
|
922
1677
|
|
|
1678
|
+
/**
|
|
1679
|
+
* Current status of the response generation
|
|
1680
|
+
*/
|
|
923
1681
|
status: string;
|
|
924
1682
|
|
|
1683
|
+
/**
|
|
1684
|
+
* Text formatting configuration for the response
|
|
1685
|
+
*/
|
|
925
1686
|
text: Data.Text;
|
|
926
1687
|
|
|
1688
|
+
/**
|
|
1689
|
+
* (Optional) Error details if the response generation failed
|
|
1690
|
+
*/
|
|
927
1691
|
error?: Data.Error;
|
|
928
1692
|
|
|
1693
|
+
/**
|
|
1694
|
+
* (Optional) ID of the previous response in a conversation
|
|
1695
|
+
*/
|
|
929
1696
|
previous_response_id?: string;
|
|
930
1697
|
|
|
1698
|
+
/**
|
|
1699
|
+
* (Optional) Sampling temperature used for generation
|
|
1700
|
+
*/
|
|
931
1701
|
temperature?: number;
|
|
932
1702
|
|
|
1703
|
+
/**
|
|
1704
|
+
* (Optional) Nucleus sampling parameter used for generation
|
|
1705
|
+
*/
|
|
933
1706
|
top_p?: number;
|
|
934
1707
|
|
|
1708
|
+
/**
|
|
1709
|
+
* (Optional) Truncation strategy applied to the response
|
|
1710
|
+
*/
|
|
935
1711
|
truncation?: string;
|
|
936
1712
|
|
|
1713
|
+
/**
|
|
1714
|
+
* (Optional) User identifier associated with the request
|
|
1715
|
+
*/
|
|
937
1716
|
user?: string;
|
|
938
1717
|
}
|
|
939
1718
|
|
|
940
1719
|
export namespace Data {
|
|
1720
|
+
/**
|
|
1721
|
+
* Web search tool call output message for OpenAI responses.
|
|
1722
|
+
*/
|
|
941
1723
|
export interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
1724
|
+
/**
|
|
1725
|
+
* Unique identifier for this tool call
|
|
1726
|
+
*/
|
|
942
1727
|
id: string;
|
|
943
1728
|
|
|
1729
|
+
/**
|
|
1730
|
+
* Current status of the web search operation
|
|
1731
|
+
*/
|
|
944
1732
|
status: string;
|
|
945
1733
|
|
|
1734
|
+
/**
|
|
1735
|
+
* Tool call type identifier, always "web_search_call"
|
|
1736
|
+
*/
|
|
946
1737
|
type: 'web_search_call';
|
|
947
1738
|
}
|
|
948
1739
|
|
|
1740
|
+
/**
|
|
1741
|
+
* File search tool call output message for OpenAI responses.
|
|
1742
|
+
*/
|
|
949
1743
|
export interface OpenAIResponseOutputMessageFileSearchToolCall {
|
|
1744
|
+
/**
|
|
1745
|
+
* Unique identifier for this tool call
|
|
1746
|
+
*/
|
|
950
1747
|
id: string;
|
|
951
1748
|
|
|
1749
|
+
/**
|
|
1750
|
+
* List of search queries executed
|
|
1751
|
+
*/
|
|
952
1752
|
queries: Array<string>;
|
|
953
1753
|
|
|
1754
|
+
/**
|
|
1755
|
+
* Current status of the file search operation
|
|
1756
|
+
*/
|
|
954
1757
|
status: string;
|
|
955
1758
|
|
|
1759
|
+
/**
|
|
1760
|
+
* Tool call type identifier, always "file_search_call"
|
|
1761
|
+
*/
|
|
956
1762
|
type: 'file_search_call';
|
|
957
1763
|
|
|
1764
|
+
/**
|
|
1765
|
+
* (Optional) Search results returned by the file search operation
|
|
1766
|
+
*/
|
|
958
1767
|
results?: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
|
|
959
1768
|
}
|
|
960
1769
|
|
|
1770
|
+
/**
|
|
1771
|
+
* Function tool call output message for OpenAI responses.
|
|
1772
|
+
*/
|
|
961
1773
|
export interface OpenAIResponseOutputMessageFunctionToolCall {
|
|
1774
|
+
/**
|
|
1775
|
+
* JSON string containing the function arguments
|
|
1776
|
+
*/
|
|
962
1777
|
arguments: string;
|
|
963
1778
|
|
|
1779
|
+
/**
|
|
1780
|
+
* Unique identifier for the function call
|
|
1781
|
+
*/
|
|
964
1782
|
call_id: string;
|
|
965
1783
|
|
|
1784
|
+
/**
|
|
1785
|
+
* Name of the function being called
|
|
1786
|
+
*/
|
|
966
1787
|
name: string;
|
|
967
1788
|
|
|
1789
|
+
/**
|
|
1790
|
+
* Tool call type identifier, always "function_call"
|
|
1791
|
+
*/
|
|
968
1792
|
type: 'function_call';
|
|
969
1793
|
|
|
1794
|
+
/**
|
|
1795
|
+
* (Optional) Additional identifier for the tool call
|
|
1796
|
+
*/
|
|
970
1797
|
id?: string;
|
|
971
1798
|
|
|
1799
|
+
/**
|
|
1800
|
+
* (Optional) Current status of the function call execution
|
|
1801
|
+
*/
|
|
972
1802
|
status?: string;
|
|
973
1803
|
}
|
|
974
1804
|
|
|
@@ -1012,17 +1842,38 @@ export namespace ResponseListResponse {
|
|
|
1012
1842
|
}
|
|
1013
1843
|
|
|
1014
1844
|
export namespace OpenAIResponseMessage {
|
|
1845
|
+
/**
|
|
1846
|
+
* Text content for input messages in OpenAI response format.
|
|
1847
|
+
*/
|
|
1015
1848
|
export interface OpenAIResponseInputMessageContentText {
|
|
1849
|
+
/**
|
|
1850
|
+
* The text content of the input message
|
|
1851
|
+
*/
|
|
1016
1852
|
text: string;
|
|
1017
1853
|
|
|
1854
|
+
/**
|
|
1855
|
+
* Content type identifier, always "input_text"
|
|
1856
|
+
*/
|
|
1018
1857
|
type: 'input_text';
|
|
1019
1858
|
}
|
|
1020
1859
|
|
|
1860
|
+
/**
|
|
1861
|
+
* Image content for input messages in OpenAI response format.
|
|
1862
|
+
*/
|
|
1021
1863
|
export interface OpenAIResponseInputMessageContentImage {
|
|
1864
|
+
/**
|
|
1865
|
+
* Level of detail for image processing, can be "low", "high", or "auto"
|
|
1866
|
+
*/
|
|
1022
1867
|
detail: 'low' | 'high' | 'auto';
|
|
1023
1868
|
|
|
1869
|
+
/**
|
|
1870
|
+
* Content type identifier, always "input_image"
|
|
1871
|
+
*/
|
|
1024
1872
|
type: 'input_image';
|
|
1025
1873
|
|
|
1874
|
+
/**
|
|
1875
|
+
* (Optional) URL of the image content
|
|
1876
|
+
*/
|
|
1026
1877
|
image_url?: string;
|
|
1027
1878
|
}
|
|
1028
1879
|
|
|
@@ -1040,25 +1891,58 @@ export namespace ResponseListResponse {
|
|
|
1040
1891
|
}
|
|
1041
1892
|
|
|
1042
1893
|
export namespace UnionMember2 {
|
|
1894
|
+
/**
|
|
1895
|
+
* File citation annotation for referencing specific files in response content.
|
|
1896
|
+
*/
|
|
1043
1897
|
export interface OpenAIResponseAnnotationFileCitation {
|
|
1898
|
+
/**
|
|
1899
|
+
* Unique identifier of the referenced file
|
|
1900
|
+
*/
|
|
1044
1901
|
file_id: string;
|
|
1045
1902
|
|
|
1903
|
+
/**
|
|
1904
|
+
* Name of the referenced file
|
|
1905
|
+
*/
|
|
1046
1906
|
filename: string;
|
|
1047
1907
|
|
|
1908
|
+
/**
|
|
1909
|
+
* Position index of the citation within the content
|
|
1910
|
+
*/
|
|
1048
1911
|
index: number;
|
|
1049
1912
|
|
|
1913
|
+
/**
|
|
1914
|
+
* Annotation type identifier, always "file_citation"
|
|
1915
|
+
*/
|
|
1050
1916
|
type: 'file_citation';
|
|
1051
1917
|
}
|
|
1052
1918
|
|
|
1919
|
+
/**
|
|
1920
|
+
* URL citation annotation for referencing external web resources.
|
|
1921
|
+
*/
|
|
1053
1922
|
export interface OpenAIResponseAnnotationCitation {
|
|
1923
|
+
/**
|
|
1924
|
+
* End position of the citation span in the content
|
|
1925
|
+
*/
|
|
1054
1926
|
end_index: number;
|
|
1055
1927
|
|
|
1928
|
+
/**
|
|
1929
|
+
* Start position of the citation span in the content
|
|
1930
|
+
*/
|
|
1056
1931
|
start_index: number;
|
|
1057
1932
|
|
|
1933
|
+
/**
|
|
1934
|
+
* Title of the referenced web resource
|
|
1935
|
+
*/
|
|
1058
1936
|
title: string;
|
|
1059
1937
|
|
|
1938
|
+
/**
|
|
1939
|
+
* Annotation type identifier, always "url_citation"
|
|
1940
|
+
*/
|
|
1060
1941
|
type: 'url_citation';
|
|
1061
1942
|
|
|
1943
|
+
/**
|
|
1944
|
+
* URL of the referenced web resource
|
|
1945
|
+
*/
|
|
1062
1946
|
url: string;
|
|
1063
1947
|
}
|
|
1064
1948
|
|
|
@@ -1110,17 +1994,38 @@ export namespace ResponseListResponse {
|
|
|
1110
1994
|
}
|
|
1111
1995
|
|
|
1112
1996
|
export namespace OpenAIResponseMessage {
|
|
1997
|
+
/**
|
|
1998
|
+
* Text content for input messages in OpenAI response format.
|
|
1999
|
+
*/
|
|
1113
2000
|
export interface OpenAIResponseInputMessageContentText {
|
|
2001
|
+
/**
|
|
2002
|
+
* The text content of the input message
|
|
2003
|
+
*/
|
|
1114
2004
|
text: string;
|
|
1115
2005
|
|
|
2006
|
+
/**
|
|
2007
|
+
* Content type identifier, always "input_text"
|
|
2008
|
+
*/
|
|
1116
2009
|
type: 'input_text';
|
|
1117
2010
|
}
|
|
1118
2011
|
|
|
2012
|
+
/**
|
|
2013
|
+
* Image content for input messages in OpenAI response format.
|
|
2014
|
+
*/
|
|
1119
2015
|
export interface OpenAIResponseInputMessageContentImage {
|
|
2016
|
+
/**
|
|
2017
|
+
* Level of detail for image processing, can be "low", "high", or "auto"
|
|
2018
|
+
*/
|
|
1120
2019
|
detail: 'low' | 'high' | 'auto';
|
|
1121
2020
|
|
|
2021
|
+
/**
|
|
2022
|
+
* Content type identifier, always "input_image"
|
|
2023
|
+
*/
|
|
1122
2024
|
type: 'input_image';
|
|
1123
2025
|
|
|
2026
|
+
/**
|
|
2027
|
+
* (Optional) URL of the image content
|
|
2028
|
+
*/
|
|
1124
2029
|
image_url?: string;
|
|
1125
2030
|
}
|
|
1126
2031
|
|
|
@@ -1138,25 +2043,58 @@ export namespace ResponseListResponse {
|
|
|
1138
2043
|
}
|
|
1139
2044
|
|
|
1140
2045
|
export namespace UnionMember2 {
|
|
2046
|
+
/**
|
|
2047
|
+
* File citation annotation for referencing specific files in response content.
|
|
2048
|
+
*/
|
|
1141
2049
|
export interface OpenAIResponseAnnotationFileCitation {
|
|
2050
|
+
/**
|
|
2051
|
+
* Unique identifier of the referenced file
|
|
2052
|
+
*/
|
|
1142
2053
|
file_id: string;
|
|
1143
2054
|
|
|
2055
|
+
/**
|
|
2056
|
+
* Name of the referenced file
|
|
2057
|
+
*/
|
|
1144
2058
|
filename: string;
|
|
1145
2059
|
|
|
2060
|
+
/**
|
|
2061
|
+
* Position index of the citation within the content
|
|
2062
|
+
*/
|
|
1146
2063
|
index: number;
|
|
1147
2064
|
|
|
2065
|
+
/**
|
|
2066
|
+
* Annotation type identifier, always "file_citation"
|
|
2067
|
+
*/
|
|
1148
2068
|
type: 'file_citation';
|
|
1149
2069
|
}
|
|
1150
2070
|
|
|
2071
|
+
/**
|
|
2072
|
+
* URL citation annotation for referencing external web resources.
|
|
2073
|
+
*/
|
|
1151
2074
|
export interface OpenAIResponseAnnotationCitation {
|
|
2075
|
+
/**
|
|
2076
|
+
* End position of the citation span in the content
|
|
2077
|
+
*/
|
|
1152
2078
|
end_index: number;
|
|
1153
2079
|
|
|
2080
|
+
/**
|
|
2081
|
+
* Start position of the citation span in the content
|
|
2082
|
+
*/
|
|
1154
2083
|
start_index: number;
|
|
1155
2084
|
|
|
2085
|
+
/**
|
|
2086
|
+
* Title of the referenced web resource
|
|
2087
|
+
*/
|
|
1156
2088
|
title: string;
|
|
1157
2089
|
|
|
2090
|
+
/**
|
|
2091
|
+
* Annotation type identifier, always "url_citation"
|
|
2092
|
+
*/
|
|
1158
2093
|
type: 'url_citation';
|
|
1159
2094
|
|
|
2095
|
+
/**
|
|
2096
|
+
* URL of the referenced web resource
|
|
2097
|
+
*/
|
|
1160
2098
|
url: string;
|
|
1161
2099
|
}
|
|
1162
2100
|
|
|
@@ -1184,86 +2122,191 @@ export namespace ResponseListResponse {
|
|
|
1184
2122
|
}
|
|
1185
2123
|
}
|
|
1186
2124
|
|
|
2125
|
+
/**
|
|
2126
|
+
* Web search tool call output message for OpenAI responses.
|
|
2127
|
+
*/
|
|
1187
2128
|
export interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
2129
|
+
/**
|
|
2130
|
+
* Unique identifier for this tool call
|
|
2131
|
+
*/
|
|
1188
2132
|
id: string;
|
|
1189
2133
|
|
|
2134
|
+
/**
|
|
2135
|
+
* Current status of the web search operation
|
|
2136
|
+
*/
|
|
1190
2137
|
status: string;
|
|
1191
2138
|
|
|
2139
|
+
/**
|
|
2140
|
+
* Tool call type identifier, always "web_search_call"
|
|
2141
|
+
*/
|
|
1192
2142
|
type: 'web_search_call';
|
|
1193
2143
|
}
|
|
1194
2144
|
|
|
2145
|
+
/**
|
|
2146
|
+
* File search tool call output message for OpenAI responses.
|
|
2147
|
+
*/
|
|
1195
2148
|
export interface OpenAIResponseOutputMessageFileSearchToolCall {
|
|
2149
|
+
/**
|
|
2150
|
+
* Unique identifier for this tool call
|
|
2151
|
+
*/
|
|
1196
2152
|
id: string;
|
|
1197
2153
|
|
|
2154
|
+
/**
|
|
2155
|
+
* List of search queries executed
|
|
2156
|
+
*/
|
|
1198
2157
|
queries: Array<string>;
|
|
1199
2158
|
|
|
2159
|
+
/**
|
|
2160
|
+
* Current status of the file search operation
|
|
2161
|
+
*/
|
|
1200
2162
|
status: string;
|
|
1201
2163
|
|
|
2164
|
+
/**
|
|
2165
|
+
* Tool call type identifier, always "file_search_call"
|
|
2166
|
+
*/
|
|
1202
2167
|
type: 'file_search_call';
|
|
1203
2168
|
|
|
2169
|
+
/**
|
|
2170
|
+
* (Optional) Search results returned by the file search operation
|
|
2171
|
+
*/
|
|
1204
2172
|
results?: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
|
|
1205
2173
|
}
|
|
1206
2174
|
|
|
2175
|
+
/**
|
|
2176
|
+
* Function tool call output message for OpenAI responses.
|
|
2177
|
+
*/
|
|
1207
2178
|
export interface OpenAIResponseOutputMessageFunctionToolCall {
|
|
2179
|
+
/**
|
|
2180
|
+
* JSON string containing the function arguments
|
|
2181
|
+
*/
|
|
1208
2182
|
arguments: string;
|
|
1209
2183
|
|
|
2184
|
+
/**
|
|
2185
|
+
* Unique identifier for the function call
|
|
2186
|
+
*/
|
|
1210
2187
|
call_id: string;
|
|
1211
2188
|
|
|
2189
|
+
/**
|
|
2190
|
+
* Name of the function being called
|
|
2191
|
+
*/
|
|
1212
2192
|
name: string;
|
|
1213
2193
|
|
|
2194
|
+
/**
|
|
2195
|
+
* Tool call type identifier, always "function_call"
|
|
2196
|
+
*/
|
|
1214
2197
|
type: 'function_call';
|
|
1215
2198
|
|
|
2199
|
+
/**
|
|
2200
|
+
* (Optional) Additional identifier for the tool call
|
|
2201
|
+
*/
|
|
1216
2202
|
id?: string;
|
|
1217
2203
|
|
|
2204
|
+
/**
|
|
2205
|
+
* (Optional) Current status of the function call execution
|
|
2206
|
+
*/
|
|
1218
2207
|
status?: string;
|
|
1219
2208
|
}
|
|
1220
2209
|
|
|
2210
|
+
/**
|
|
2211
|
+
* Model Context Protocol (MCP) call output message for OpenAI responses.
|
|
2212
|
+
*/
|
|
1221
2213
|
export interface OpenAIResponseOutputMessageMcpCall {
|
|
2214
|
+
/**
|
|
2215
|
+
* Unique identifier for this MCP call
|
|
2216
|
+
*/
|
|
1222
2217
|
id: string;
|
|
1223
2218
|
|
|
2219
|
+
/**
|
|
2220
|
+
* JSON string containing the MCP call arguments
|
|
2221
|
+
*/
|
|
1224
2222
|
arguments: string;
|
|
1225
2223
|
|
|
2224
|
+
/**
|
|
2225
|
+
* Name of the MCP method being called
|
|
2226
|
+
*/
|
|
1226
2227
|
name: string;
|
|
1227
2228
|
|
|
2229
|
+
/**
|
|
2230
|
+
* Label identifying the MCP server handling the call
|
|
2231
|
+
*/
|
|
1228
2232
|
server_label: string;
|
|
1229
2233
|
|
|
2234
|
+
/**
|
|
2235
|
+
* Tool call type identifier, always "mcp_call"
|
|
2236
|
+
*/
|
|
1230
2237
|
type: 'mcp_call';
|
|
1231
2238
|
|
|
2239
|
+
/**
|
|
2240
|
+
* (Optional) Error message if the MCP call failed
|
|
2241
|
+
*/
|
|
1232
2242
|
error?: string;
|
|
1233
2243
|
|
|
2244
|
+
/**
|
|
2245
|
+
* (Optional) Output result from the successful MCP call
|
|
2246
|
+
*/
|
|
1234
2247
|
output?: string;
|
|
1235
2248
|
}
|
|
1236
2249
|
|
|
2250
|
+
/**
|
|
2251
|
+
* MCP list tools output message containing available tools from an MCP server.
|
|
2252
|
+
*/
|
|
1237
2253
|
export interface OpenAIResponseOutputMessageMcpListTools {
|
|
2254
|
+
/**
|
|
2255
|
+
* Unique identifier for this MCP list tools operation
|
|
2256
|
+
*/
|
|
1238
2257
|
id: string;
|
|
1239
2258
|
|
|
2259
|
+
/**
|
|
2260
|
+
* Label identifying the MCP server providing the tools
|
|
2261
|
+
*/
|
|
1240
2262
|
server_label: string;
|
|
1241
2263
|
|
|
2264
|
+
/**
|
|
2265
|
+
* List of available tools provided by the MCP server
|
|
2266
|
+
*/
|
|
1242
2267
|
tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
|
|
1243
2268
|
|
|
2269
|
+
/**
|
|
2270
|
+
* Tool call type identifier, always "mcp_list_tools"
|
|
2271
|
+
*/
|
|
1244
2272
|
type: 'mcp_list_tools';
|
|
1245
2273
|
}
|
|
1246
2274
|
|
|
1247
2275
|
export namespace OpenAIResponseOutputMessageMcpListTools {
|
|
2276
|
+
/**
|
|
2277
|
+
* Tool definition returned by MCP list tools operation.
|
|
2278
|
+
*/
|
|
1248
2279
|
export interface Tool {
|
|
2280
|
+
/**
|
|
2281
|
+
* JSON schema defining the tool's input parameters
|
|
2282
|
+
*/
|
|
1249
2283
|
input_schema: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
|
|
1250
2284
|
|
|
2285
|
+
/**
|
|
2286
|
+
* Name of the tool
|
|
2287
|
+
*/
|
|
1251
2288
|
name: string;
|
|
1252
2289
|
|
|
2290
|
+
/**
|
|
2291
|
+
* (Optional) Description of what the tool does
|
|
2292
|
+
*/
|
|
1253
2293
|
description?: string;
|
|
1254
2294
|
}
|
|
1255
2295
|
}
|
|
1256
2296
|
|
|
2297
|
+
/**
|
|
2298
|
+
* Text formatting configuration for the response
|
|
2299
|
+
*/
|
|
1257
2300
|
export interface Text {
|
|
1258
2301
|
/**
|
|
1259
|
-
*
|
|
2302
|
+
* (Optional) Text format configuration specifying output format requirements
|
|
1260
2303
|
*/
|
|
1261
2304
|
format?: Text.Format;
|
|
1262
2305
|
}
|
|
1263
2306
|
|
|
1264
2307
|
export namespace Text {
|
|
1265
2308
|
/**
|
|
1266
|
-
*
|
|
2309
|
+
* (Optional) Text format configuration specifying output format requirements
|
|
1267
2310
|
*/
|
|
1268
2311
|
export interface Format {
|
|
1269
2312
|
/**
|
|
@@ -1295,9 +2338,18 @@ export namespace ResponseListResponse {
|
|
|
1295
2338
|
}
|
|
1296
2339
|
}
|
|
1297
2340
|
|
|
2341
|
+
/**
|
|
2342
|
+
* (Optional) Error details if the response generation failed
|
|
2343
|
+
*/
|
|
1298
2344
|
export interface Error {
|
|
2345
|
+
/**
|
|
2346
|
+
* Error code identifying the type of failure
|
|
2347
|
+
*/
|
|
1299
2348
|
code: string;
|
|
1300
2349
|
|
|
2350
|
+
/**
|
|
2351
|
+
* Human-readable error message describing the failure
|
|
2352
|
+
*/
|
|
1301
2353
|
message: string;
|
|
1302
2354
|
}
|
|
1303
2355
|
}
|
|
@@ -1341,6 +2393,9 @@ export interface ResponseCreateParamsBase {
|
|
|
1341
2393
|
|
|
1342
2394
|
temperature?: number;
|
|
1343
2395
|
|
|
2396
|
+
/**
|
|
2397
|
+
* Text response configuration for OpenAI responses.
|
|
2398
|
+
*/
|
|
1344
2399
|
text?: ResponseCreateParams.Text;
|
|
1345
2400
|
|
|
1346
2401
|
tools?: Array<
|
|
@@ -1352,37 +2407,88 @@ export interface ResponseCreateParamsBase {
|
|
|
1352
2407
|
}
|
|
1353
2408
|
|
|
1354
2409
|
export namespace ResponseCreateParams {
|
|
2410
|
+
/**
|
|
2411
|
+
* Web search tool call output message for OpenAI responses.
|
|
2412
|
+
*/
|
|
1355
2413
|
export interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
2414
|
+
/**
|
|
2415
|
+
* Unique identifier for this tool call
|
|
2416
|
+
*/
|
|
1356
2417
|
id: string;
|
|
1357
2418
|
|
|
2419
|
+
/**
|
|
2420
|
+
* Current status of the web search operation
|
|
2421
|
+
*/
|
|
1358
2422
|
status: string;
|
|
1359
2423
|
|
|
2424
|
+
/**
|
|
2425
|
+
* Tool call type identifier, always "web_search_call"
|
|
2426
|
+
*/
|
|
1360
2427
|
type: 'web_search_call';
|
|
1361
2428
|
}
|
|
1362
2429
|
|
|
2430
|
+
/**
|
|
2431
|
+
* File search tool call output message for OpenAI responses.
|
|
2432
|
+
*/
|
|
1363
2433
|
export interface OpenAIResponseOutputMessageFileSearchToolCall {
|
|
2434
|
+
/**
|
|
2435
|
+
* Unique identifier for this tool call
|
|
2436
|
+
*/
|
|
1364
2437
|
id: string;
|
|
1365
2438
|
|
|
2439
|
+
/**
|
|
2440
|
+
* List of search queries executed
|
|
2441
|
+
*/
|
|
1366
2442
|
queries: Array<string>;
|
|
1367
2443
|
|
|
2444
|
+
/**
|
|
2445
|
+
* Current status of the file search operation
|
|
2446
|
+
*/
|
|
1368
2447
|
status: string;
|
|
1369
2448
|
|
|
2449
|
+
/**
|
|
2450
|
+
* Tool call type identifier, always "file_search_call"
|
|
2451
|
+
*/
|
|
1370
2452
|
type: 'file_search_call';
|
|
1371
2453
|
|
|
2454
|
+
/**
|
|
2455
|
+
* (Optional) Search results returned by the file search operation
|
|
2456
|
+
*/
|
|
1372
2457
|
results?: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
|
|
1373
2458
|
}
|
|
1374
2459
|
|
|
2460
|
+
/**
|
|
2461
|
+
* Function tool call output message for OpenAI responses.
|
|
2462
|
+
*/
|
|
1375
2463
|
export interface OpenAIResponseOutputMessageFunctionToolCall {
|
|
2464
|
+
/**
|
|
2465
|
+
* JSON string containing the function arguments
|
|
2466
|
+
*/
|
|
1376
2467
|
arguments: string;
|
|
1377
2468
|
|
|
2469
|
+
/**
|
|
2470
|
+
* Unique identifier for the function call
|
|
2471
|
+
*/
|
|
1378
2472
|
call_id: string;
|
|
1379
2473
|
|
|
2474
|
+
/**
|
|
2475
|
+
* Name of the function being called
|
|
2476
|
+
*/
|
|
1380
2477
|
name: string;
|
|
1381
2478
|
|
|
2479
|
+
/**
|
|
2480
|
+
* Tool call type identifier, always "function_call"
|
|
2481
|
+
*/
|
|
1382
2482
|
type: 'function_call';
|
|
1383
2483
|
|
|
2484
|
+
/**
|
|
2485
|
+
* (Optional) Additional identifier for the tool call
|
|
2486
|
+
*/
|
|
1384
2487
|
id?: string;
|
|
1385
2488
|
|
|
2489
|
+
/**
|
|
2490
|
+
* (Optional) Current status of the function call execution
|
|
2491
|
+
*/
|
|
1386
2492
|
status?: string;
|
|
1387
2493
|
}
|
|
1388
2494
|
|
|
@@ -1426,17 +2532,38 @@ export namespace ResponseCreateParams {
|
|
|
1426
2532
|
}
|
|
1427
2533
|
|
|
1428
2534
|
export namespace OpenAIResponseMessage {
|
|
2535
|
+
/**
|
|
2536
|
+
* Text content for input messages in OpenAI response format.
|
|
2537
|
+
*/
|
|
1429
2538
|
export interface OpenAIResponseInputMessageContentText {
|
|
2539
|
+
/**
|
|
2540
|
+
* The text content of the input message
|
|
2541
|
+
*/
|
|
1430
2542
|
text: string;
|
|
1431
2543
|
|
|
2544
|
+
/**
|
|
2545
|
+
* Content type identifier, always "input_text"
|
|
2546
|
+
*/
|
|
1432
2547
|
type: 'input_text';
|
|
1433
2548
|
}
|
|
1434
2549
|
|
|
2550
|
+
/**
|
|
2551
|
+
* Image content for input messages in OpenAI response format.
|
|
2552
|
+
*/
|
|
1435
2553
|
export interface OpenAIResponseInputMessageContentImage {
|
|
2554
|
+
/**
|
|
2555
|
+
* Level of detail for image processing, can be "low", "high", or "auto"
|
|
2556
|
+
*/
|
|
1436
2557
|
detail: 'low' | 'high' | 'auto';
|
|
1437
2558
|
|
|
2559
|
+
/**
|
|
2560
|
+
* Content type identifier, always "input_image"
|
|
2561
|
+
*/
|
|
1438
2562
|
type: 'input_image';
|
|
1439
2563
|
|
|
2564
|
+
/**
|
|
2565
|
+
* (Optional) URL of the image content
|
|
2566
|
+
*/
|
|
1440
2567
|
image_url?: string;
|
|
1441
2568
|
}
|
|
1442
2569
|
|
|
@@ -1454,25 +2581,58 @@ export namespace ResponseCreateParams {
|
|
|
1454
2581
|
}
|
|
1455
2582
|
|
|
1456
2583
|
export namespace UnionMember2 {
|
|
2584
|
+
/**
|
|
2585
|
+
* File citation annotation for referencing specific files in response content.
|
|
2586
|
+
*/
|
|
1457
2587
|
export interface OpenAIResponseAnnotationFileCitation {
|
|
2588
|
+
/**
|
|
2589
|
+
* Unique identifier of the referenced file
|
|
2590
|
+
*/
|
|
1458
2591
|
file_id: string;
|
|
1459
2592
|
|
|
2593
|
+
/**
|
|
2594
|
+
* Name of the referenced file
|
|
2595
|
+
*/
|
|
1460
2596
|
filename: string;
|
|
1461
2597
|
|
|
2598
|
+
/**
|
|
2599
|
+
* Position index of the citation within the content
|
|
2600
|
+
*/
|
|
1462
2601
|
index: number;
|
|
1463
2602
|
|
|
2603
|
+
/**
|
|
2604
|
+
* Annotation type identifier, always "file_citation"
|
|
2605
|
+
*/
|
|
1464
2606
|
type: 'file_citation';
|
|
1465
2607
|
}
|
|
1466
2608
|
|
|
2609
|
+
/**
|
|
2610
|
+
* URL citation annotation for referencing external web resources.
|
|
2611
|
+
*/
|
|
1467
2612
|
export interface OpenAIResponseAnnotationCitation {
|
|
2613
|
+
/**
|
|
2614
|
+
* End position of the citation span in the content
|
|
2615
|
+
*/
|
|
1468
2616
|
end_index: number;
|
|
1469
2617
|
|
|
2618
|
+
/**
|
|
2619
|
+
* Start position of the citation span in the content
|
|
2620
|
+
*/
|
|
1470
2621
|
start_index: number;
|
|
1471
2622
|
|
|
2623
|
+
/**
|
|
2624
|
+
* Title of the referenced web resource
|
|
2625
|
+
*/
|
|
1472
2626
|
title: string;
|
|
1473
2627
|
|
|
2628
|
+
/**
|
|
2629
|
+
* Annotation type identifier, always "url_citation"
|
|
2630
|
+
*/
|
|
1474
2631
|
type: 'url_citation';
|
|
1475
2632
|
|
|
2633
|
+
/**
|
|
2634
|
+
* URL of the referenced web resource
|
|
2635
|
+
*/
|
|
1476
2636
|
url: string;
|
|
1477
2637
|
}
|
|
1478
2638
|
|
|
@@ -1500,16 +2660,19 @@ export namespace ResponseCreateParams {
|
|
|
1500
2660
|
}
|
|
1501
2661
|
}
|
|
1502
2662
|
|
|
2663
|
+
/**
|
|
2664
|
+
* Text response configuration for OpenAI responses.
|
|
2665
|
+
*/
|
|
1503
2666
|
export interface Text {
|
|
1504
2667
|
/**
|
|
1505
|
-
*
|
|
2668
|
+
* (Optional) Text format configuration specifying output format requirements
|
|
1506
2669
|
*/
|
|
1507
2670
|
format?: Text.Format;
|
|
1508
2671
|
}
|
|
1509
2672
|
|
|
1510
2673
|
export namespace Text {
|
|
1511
2674
|
/**
|
|
1512
|
-
*
|
|
2675
|
+
* (Optional) Text format configuration specifying output format requirements
|
|
1513
2676
|
*/
|
|
1514
2677
|
export interface Format {
|
|
1515
2678
|
/**
|
|
@@ -1541,66 +2704,156 @@ export namespace ResponseCreateParams {
|
|
|
1541
2704
|
}
|
|
1542
2705
|
}
|
|
1543
2706
|
|
|
2707
|
+
/**
|
|
2708
|
+
* Web search tool configuration for OpenAI response inputs.
|
|
2709
|
+
*/
|
|
1544
2710
|
export interface OpenAIResponseInputToolWebSearch {
|
|
2711
|
+
/**
|
|
2712
|
+
* Web search tool type variant to use
|
|
2713
|
+
*/
|
|
1545
2714
|
type: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11';
|
|
1546
2715
|
|
|
2716
|
+
/**
|
|
2717
|
+
* (Optional) Size of search context, must be "low", "medium", or "high"
|
|
2718
|
+
*/
|
|
1547
2719
|
search_context_size?: string;
|
|
1548
2720
|
}
|
|
1549
2721
|
|
|
2722
|
+
/**
|
|
2723
|
+
* File search tool configuration for OpenAI response inputs.
|
|
2724
|
+
*/
|
|
1550
2725
|
export interface OpenAIResponseInputToolFileSearch {
|
|
2726
|
+
/**
|
|
2727
|
+
* Tool type identifier, always "file_search"
|
|
2728
|
+
*/
|
|
1551
2729
|
type: 'file_search';
|
|
1552
2730
|
|
|
2731
|
+
/**
|
|
2732
|
+
* List of vector store identifiers to search within
|
|
2733
|
+
*/
|
|
1553
2734
|
vector_store_ids: Array<string>;
|
|
1554
2735
|
|
|
2736
|
+
/**
|
|
2737
|
+
* (Optional) Additional filters to apply to the search
|
|
2738
|
+
*/
|
|
1555
2739
|
filters?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
|
|
1556
2740
|
|
|
2741
|
+
/**
|
|
2742
|
+
* (Optional) Maximum number of search results to return (1-50)
|
|
2743
|
+
*/
|
|
1557
2744
|
max_num_results?: number;
|
|
1558
2745
|
|
|
2746
|
+
/**
|
|
2747
|
+
* (Optional) Options for ranking and scoring search results
|
|
2748
|
+
*/
|
|
1559
2749
|
ranking_options?: OpenAIResponseInputToolFileSearch.RankingOptions;
|
|
1560
2750
|
}
|
|
1561
2751
|
|
|
1562
2752
|
export namespace OpenAIResponseInputToolFileSearch {
|
|
2753
|
+
/**
|
|
2754
|
+
* (Optional) Options for ranking and scoring search results
|
|
2755
|
+
*/
|
|
1563
2756
|
export interface RankingOptions {
|
|
2757
|
+
/**
|
|
2758
|
+
* (Optional) Name of the ranking algorithm to use
|
|
2759
|
+
*/
|
|
1564
2760
|
ranker?: string;
|
|
1565
2761
|
|
|
2762
|
+
/**
|
|
2763
|
+
* (Optional) Minimum relevance score threshold for results
|
|
2764
|
+
*/
|
|
1566
2765
|
score_threshold?: number;
|
|
1567
2766
|
}
|
|
1568
2767
|
}
|
|
1569
2768
|
|
|
2769
|
+
/**
|
|
2770
|
+
* Function tool configuration for OpenAI response inputs.
|
|
2771
|
+
*/
|
|
1570
2772
|
export interface OpenAIResponseInputToolFunction {
|
|
2773
|
+
/**
|
|
2774
|
+
* Name of the function that can be called
|
|
2775
|
+
*/
|
|
1571
2776
|
name: string;
|
|
1572
2777
|
|
|
2778
|
+
/**
|
|
2779
|
+
* Tool type identifier, always "function"
|
|
2780
|
+
*/
|
|
1573
2781
|
type: 'function';
|
|
1574
2782
|
|
|
2783
|
+
/**
|
|
2784
|
+
* (Optional) Description of what the function does
|
|
2785
|
+
*/
|
|
1575
2786
|
description?: string;
|
|
1576
2787
|
|
|
2788
|
+
/**
|
|
2789
|
+
* (Optional) JSON schema defining the function's parameters
|
|
2790
|
+
*/
|
|
1577
2791
|
parameters?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
|
|
1578
2792
|
|
|
2793
|
+
/**
|
|
2794
|
+
* (Optional) Whether to enforce strict parameter validation
|
|
2795
|
+
*/
|
|
1579
2796
|
strict?: boolean;
|
|
1580
2797
|
}
|
|
1581
2798
|
|
|
2799
|
+
/**
|
|
2800
|
+
* Model Context Protocol (MCP) tool configuration for OpenAI response inputs.
|
|
2801
|
+
*/
|
|
1582
2802
|
export interface OpenAIResponseInputToolMcp {
|
|
2803
|
+
/**
|
|
2804
|
+
* Approval requirement for tool calls ("always", "never", or filter)
|
|
2805
|
+
*/
|
|
1583
2806
|
require_approval: 'always' | 'never' | OpenAIResponseInputToolMcp.ApprovalFilter;
|
|
1584
2807
|
|
|
2808
|
+
/**
|
|
2809
|
+
* Label to identify this MCP server
|
|
2810
|
+
*/
|
|
1585
2811
|
server_label: string;
|
|
1586
2812
|
|
|
2813
|
+
/**
|
|
2814
|
+
* URL endpoint of the MCP server
|
|
2815
|
+
*/
|
|
1587
2816
|
server_url: string;
|
|
1588
2817
|
|
|
2818
|
+
/**
|
|
2819
|
+
* Tool type identifier, always "mcp"
|
|
2820
|
+
*/
|
|
1589
2821
|
type: 'mcp';
|
|
1590
2822
|
|
|
2823
|
+
/**
|
|
2824
|
+
* (Optional) Restriction on which tools can be used from this server
|
|
2825
|
+
*/
|
|
1591
2826
|
allowed_tools?: Array<string> | OpenAIResponseInputToolMcp.AllowedToolsFilter;
|
|
1592
2827
|
|
|
2828
|
+
/**
|
|
2829
|
+
* (Optional) HTTP headers to include when connecting to the server
|
|
2830
|
+
*/
|
|
1593
2831
|
headers?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
|
|
1594
2832
|
}
|
|
1595
2833
|
|
|
1596
2834
|
export namespace OpenAIResponseInputToolMcp {
|
|
2835
|
+
/**
|
|
2836
|
+
* Filter configuration for MCP tool approval requirements.
|
|
2837
|
+
*/
|
|
1597
2838
|
export interface ApprovalFilter {
|
|
2839
|
+
/**
|
|
2840
|
+
* (Optional) List of tool names that always require approval
|
|
2841
|
+
*/
|
|
1598
2842
|
always?: Array<string>;
|
|
1599
2843
|
|
|
2844
|
+
/**
|
|
2845
|
+
* (Optional) List of tool names that never require approval
|
|
2846
|
+
*/
|
|
1600
2847
|
never?: Array<string>;
|
|
1601
2848
|
}
|
|
1602
2849
|
|
|
2850
|
+
/**
|
|
2851
|
+
* Filter configuration for restricting which MCP tools can be used.
|
|
2852
|
+
*/
|
|
1603
2853
|
export interface AllowedToolsFilter {
|
|
2854
|
+
/**
|
|
2855
|
+
* (Optional) List of specific tool names that are allowed
|
|
2856
|
+
*/
|
|
1604
2857
|
tool_names?: Array<string>;
|
|
1605
2858
|
}
|
|
1606
2859
|
}
|