llama-stack-client 0.2.16-rc1 → 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.
Files changed (149) hide show
  1. package/LICENSE +4 -198
  2. package/index.d.mts +2 -2
  3. package/index.d.ts +2 -2
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs +1 -1
  7. package/index.mjs.map +1 -1
  8. package/package.json +2 -6
  9. package/resources/agents/agents.d.ts +29 -2
  10. package/resources/agents/agents.d.ts.map +1 -1
  11. package/resources/agents/agents.js.map +1 -1
  12. package/resources/agents/agents.mjs.map +1 -1
  13. package/resources/agents/session.d.ts +18 -0
  14. package/resources/agents/session.d.ts.map +1 -1
  15. package/resources/agents/steps.d.ts +4 -1
  16. package/resources/agents/steps.d.ts.map +1 -1
  17. package/resources/agents/turn.d.ts +113 -8
  18. package/resources/agents/turn.d.ts.map +1 -1
  19. package/resources/benchmarks.d.ts +15 -0
  20. package/resources/benchmarks.d.ts.map +1 -1
  21. package/resources/chat/chat.d.ts +24 -0
  22. package/resources/chat/chat.d.ts.map +1 -1
  23. package/resources/chat/chat.js.map +1 -1
  24. package/resources/chat/chat.mjs.map +1 -1
  25. package/resources/chat/completions.d.ts +648 -6
  26. package/resources/chat/completions.d.ts.map +1 -1
  27. package/resources/datasets.d.ts +42 -6
  28. package/resources/datasets.d.ts.map +1 -1
  29. package/resources/eval/eval.d.ts +9 -0
  30. package/resources/eval/eval.d.ts.map +1 -1
  31. package/resources/eval/eval.js.map +1 -1
  32. package/resources/eval/eval.mjs.map +1 -1
  33. package/resources/files.d.ts +9 -0
  34. package/resources/files.d.ts.map +1 -1
  35. package/resources/index.d.ts +1 -1
  36. package/resources/index.d.ts.map +1 -1
  37. package/resources/index.js.map +1 -1
  38. package/resources/index.mjs +1 -1
  39. package/resources/index.mjs.map +1 -1
  40. package/resources/inference.d.ts +36 -0
  41. package/resources/inference.d.ts.map +1 -1
  42. package/resources/inspect.d.ts +45 -1
  43. package/resources/inspect.d.ts.map +1 -1
  44. package/resources/inspect.js +1 -1
  45. package/resources/inspect.mjs +1 -1
  46. package/resources/models.d.ts +21 -0
  47. package/resources/models.d.ts.map +1 -1
  48. package/resources/post-training/job.d.ts +95 -2
  49. package/resources/post-training/job.d.ts.map +1 -1
  50. package/resources/post-training/post-training.d.ts +206 -0
  51. package/resources/post-training/post-training.d.ts.map +1 -1
  52. package/resources/post-training/post-training.js.map +1 -1
  53. package/resources/post-training/post-training.mjs.map +1 -1
  54. package/resources/providers.d.ts +9 -0
  55. package/resources/providers.d.ts.map +1 -1
  56. package/resources/responses/input-items.d.ts +114 -0
  57. package/resources/responses/input-items.d.ts.map +1 -1
  58. package/resources/responses/responses.d.ts +1265 -12
  59. package/resources/responses/responses.d.ts.map +1 -1
  60. package/resources/responses/responses.js.map +1 -1
  61. package/resources/responses/responses.mjs.map +1 -1
  62. package/resources/routes.d.ts +10 -1
  63. package/resources/routes.d.ts.map +1 -1
  64. package/resources/routes.js +1 -1
  65. package/resources/routes.mjs +1 -1
  66. package/resources/safety.d.ts +72 -1
  67. package/resources/safety.d.ts.map +1 -1
  68. package/resources/safety.js +6 -0
  69. package/resources/safety.js.map +1 -1
  70. package/resources/safety.mjs +6 -0
  71. package/resources/safety.mjs.map +1 -1
  72. package/resources/scoring-functions.d.ts +51 -0
  73. package/resources/scoring-functions.d.ts.map +1 -1
  74. package/resources/scoring.d.ts +9 -0
  75. package/resources/scoring.d.ts.map +1 -1
  76. package/resources/shared.d.ts +209 -3
  77. package/resources/shared.d.ts.map +1 -1
  78. package/resources/shields.d.ts +7 -1
  79. package/resources/shields.d.ts.map +1 -1
  80. package/resources/synthetic-data-generation.d.ts +18 -1
  81. package/resources/synthetic-data-generation.d.ts.map +1 -1
  82. package/resources/synthetic-data-generation.js +3 -0
  83. package/resources/synthetic-data-generation.js.map +1 -1
  84. package/resources/synthetic-data-generation.mjs +3 -0
  85. package/resources/synthetic-data-generation.mjs.map +1 -1
  86. package/resources/telemetry.d.ts +214 -0
  87. package/resources/telemetry.d.ts.map +1 -1
  88. package/resources/tool-runtime/rag-tool.d.ts +16 -4
  89. package/resources/tool-runtime/rag-tool.d.ts.map +1 -1
  90. package/resources/tool-runtime/rag-tool.js +2 -2
  91. package/resources/tool-runtime/rag-tool.mjs +2 -2
  92. package/resources/tool-runtime/tool-runtime.d.ts +52 -1
  93. package/resources/tool-runtime/tool-runtime.d.ts.map +1 -1
  94. package/resources/tool-runtime/tool-runtime.js.map +1 -1
  95. package/resources/tool-runtime/tool-runtime.mjs.map +1 -1
  96. package/resources/toolgroups.d.ts +30 -0
  97. package/resources/toolgroups.d.ts.map +1 -1
  98. package/resources/tools.d.ts +45 -0
  99. package/resources/tools.d.ts.map +1 -1
  100. package/resources/vector-dbs.d.ts +45 -0
  101. package/resources/vector-dbs.d.ts.map +1 -1
  102. package/resources/vector-io.d.ts +9 -0
  103. package/resources/vector-io.d.ts.map +1 -1
  104. package/resources/vector-stores/files.d.ts +149 -1
  105. package/resources/vector-stores/files.d.ts.map +1 -1
  106. package/resources/vector-stores/vector-stores.d.ts +121 -1
  107. package/resources/vector-stores/vector-stores.d.ts.map +1 -1
  108. package/resources/vector-stores/vector-stores.js.map +1 -1
  109. package/resources/vector-stores/vector-stores.mjs.map +1 -1
  110. package/src/index.ts +9 -1
  111. package/src/resources/agents/agents.ts +29 -2
  112. package/src/resources/agents/session.ts +18 -0
  113. package/src/resources/agents/steps.ts +4 -1
  114. package/src/resources/agents/turn.ts +113 -8
  115. package/src/resources/benchmarks.ts +15 -0
  116. package/src/resources/chat/chat.ts +24 -0
  117. package/src/resources/chat/completions.ts +678 -0
  118. package/src/resources/datasets.ts +42 -6
  119. package/src/resources/eval/eval.ts +9 -0
  120. package/src/resources/files.ts +9 -0
  121. package/src/resources/index.ts +7 -1
  122. package/src/resources/inference.ts +36 -0
  123. package/src/resources/inspect.ts +45 -1
  124. package/src/resources/models.ts +21 -0
  125. package/src/resources/post-training/job.ts +95 -2
  126. package/src/resources/post-training/post-training.ts +206 -0
  127. package/src/resources/providers.ts +9 -0
  128. package/src/resources/responses/input-items.ts +114 -0
  129. package/src/resources/responses/responses.ts +1265 -12
  130. package/src/resources/routes.ts +10 -1
  131. package/src/resources/safety.ts +83 -1
  132. package/src/resources/scoring-functions.ts +51 -0
  133. package/src/resources/scoring.ts +9 -0
  134. package/src/resources/shared.ts +209 -3
  135. package/src/resources/shields.ts +7 -1
  136. package/src/resources/synthetic-data-generation.ts +18 -1
  137. package/src/resources/telemetry.ts +214 -0
  138. package/src/resources/tool-runtime/rag-tool.ts +16 -4
  139. package/src/resources/tool-runtime/tool-runtime.ts +52 -1
  140. package/src/resources/toolgroups.ts +30 -0
  141. package/src/resources/tools.ts +45 -0
  142. package/src/resources/vector-dbs.ts +45 -0
  143. package/src/resources/vector-io.ts +9 -0
  144. package/src/resources/vector-stores/files.ts +149 -1
  145. package/src/resources/vector-stores/vector-stores.ts +121 -1
  146. package/src/version.ts +1 -1
  147. package/version.d.ts +1 -1
  148. package/version.js +1 -1
  149. package/version.mjs +1 -1
@@ -23,20 +23,65 @@ export declare class Responses extends APIResource {
23
23
  list(query?: ResponseListParams, options?: Core.RequestOptions): Core.APIPromise<ResponseListResponse>;
24
24
  list(options?: Core.RequestOptions): Core.APIPromise<ResponseListResponse>;
25
25
  }
26
+ /**
27
+ * Complete OpenAI response object containing generation results and metadata.
28
+ */
26
29
  export interface ResponseObject {
30
+ /**
31
+ * Unique identifier for this response
32
+ */
27
33
  id: string;
34
+ /**
35
+ * Unix timestamp when the response was created
36
+ */
28
37
  created_at: number;
38
+ /**
39
+ * Model identifier used for generation
40
+ */
29
41
  model: string;
42
+ /**
43
+ * Object type identifier, always "response"
44
+ */
30
45
  object: 'response';
46
+ /**
47
+ * List of generated output items (messages, tool calls, etc.)
48
+ */
31
49
  output: Array<ResponseObject.OpenAIResponseMessage | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFunctionToolCall | ResponseObject.OpenAIResponseOutputMessageMcpCall | ResponseObject.OpenAIResponseOutputMessageMcpListTools>;
50
+ /**
51
+ * Whether tool calls can be executed in parallel
52
+ */
32
53
  parallel_tool_calls: boolean;
54
+ /**
55
+ * Current status of the response generation
56
+ */
33
57
  status: string;
58
+ /**
59
+ * Text formatting configuration for the response
60
+ */
34
61
  text: ResponseObject.Text;
62
+ /**
63
+ * (Optional) Error details if the response generation failed
64
+ */
35
65
  error?: ResponseObject.Error;
66
+ /**
67
+ * (Optional) ID of the previous response in a conversation
68
+ */
36
69
  previous_response_id?: string;
70
+ /**
71
+ * (Optional) Sampling temperature used for generation
72
+ */
37
73
  temperature?: number;
74
+ /**
75
+ * (Optional) Nucleus sampling parameter used for generation
76
+ */
38
77
  top_p?: number;
78
+ /**
79
+ * (Optional) Truncation strategy applied to the response
80
+ */
39
81
  truncation?: string;
82
+ /**
83
+ * (Optional) User identifier associated with the request
84
+ */
40
85
  user?: string;
41
86
  }
42
87
  export declare namespace ResponseObject {
@@ -53,13 +98,34 @@ export declare namespace ResponseObject {
53
98
  status?: string;
54
99
  }
55
100
  namespace OpenAIResponseMessage {
101
+ /**
102
+ * Text content for input messages in OpenAI response format.
103
+ */
56
104
  interface OpenAIResponseInputMessageContentText {
105
+ /**
106
+ * The text content of the input message
107
+ */
57
108
  text: string;
109
+ /**
110
+ * Content type identifier, always "input_text"
111
+ */
58
112
  type: 'input_text';
59
113
  }
114
+ /**
115
+ * Image content for input messages in OpenAI response format.
116
+ */
60
117
  interface OpenAIResponseInputMessageContentImage {
118
+ /**
119
+ * Level of detail for image processing, can be "low", "high", or "auto"
120
+ */
61
121
  detail: 'low' | 'high' | 'auto';
122
+ /**
123
+ * Content type identifier, always "input_image"
124
+ */
62
125
  type: 'input_image';
126
+ /**
127
+ * (Optional) URL of the image content
128
+ */
63
129
  image_url?: string;
64
130
  }
65
131
  interface UnionMember2 {
@@ -68,17 +134,50 @@ export declare namespace ResponseObject {
68
134
  type: 'output_text';
69
135
  }
70
136
  namespace UnionMember2 {
137
+ /**
138
+ * File citation annotation for referencing specific files in response content.
139
+ */
71
140
  interface OpenAIResponseAnnotationFileCitation {
141
+ /**
142
+ * Unique identifier of the referenced file
143
+ */
72
144
  file_id: string;
145
+ /**
146
+ * Name of the referenced file
147
+ */
73
148
  filename: string;
149
+ /**
150
+ * Position index of the citation within the content
151
+ */
74
152
  index: number;
153
+ /**
154
+ * Annotation type identifier, always "file_citation"
155
+ */
75
156
  type: 'file_citation';
76
157
  }
158
+ /**
159
+ * URL citation annotation for referencing external web resources.
160
+ */
77
161
  interface OpenAIResponseAnnotationCitation {
162
+ /**
163
+ * End position of the citation span in the content
164
+ */
78
165
  end_index: number;
166
+ /**
167
+ * Start position of the citation span in the content
168
+ */
79
169
  start_index: number;
170
+ /**
171
+ * Title of the referenced web resource
172
+ */
80
173
  title: string;
174
+ /**
175
+ * Annotation type identifier, always "url_citation"
176
+ */
81
177
  type: 'url_citation';
178
+ /**
179
+ * URL of the referenced web resource
180
+ */
82
181
  url: string;
83
182
  }
84
183
  interface OpenAIResponseAnnotationContainerFileCitation {
@@ -96,61 +195,166 @@ export declare namespace ResponseObject {
96
195
  }
97
196
  }
98
197
  }
198
+ /**
199
+ * Web search tool call output message for OpenAI responses.
200
+ */
99
201
  interface OpenAIResponseOutputMessageWebSearchToolCall {
202
+ /**
203
+ * Unique identifier for this tool call
204
+ */
100
205
  id: string;
206
+ /**
207
+ * Current status of the web search operation
208
+ */
101
209
  status: string;
210
+ /**
211
+ * Tool call type identifier, always "web_search_call"
212
+ */
102
213
  type: 'web_search_call';
103
214
  }
215
+ /**
216
+ * File search tool call output message for OpenAI responses.
217
+ */
104
218
  interface OpenAIResponseOutputMessageFileSearchToolCall {
219
+ /**
220
+ * Unique identifier for this tool call
221
+ */
105
222
  id: string;
223
+ /**
224
+ * List of search queries executed
225
+ */
106
226
  queries: Array<string>;
227
+ /**
228
+ * Current status of the file search operation
229
+ */
107
230
  status: string;
231
+ /**
232
+ * Tool call type identifier, always "file_search_call"
233
+ */
108
234
  type: 'file_search_call';
235
+ /**
236
+ * (Optional) Search results returned by the file search operation
237
+ */
109
238
  results?: Array<{
110
239
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
111
240
  }>;
112
241
  }
242
+ /**
243
+ * Function tool call output message for OpenAI responses.
244
+ */
113
245
  interface OpenAIResponseOutputMessageFunctionToolCall {
246
+ /**
247
+ * JSON string containing the function arguments
248
+ */
114
249
  arguments: string;
250
+ /**
251
+ * Unique identifier for the function call
252
+ */
115
253
  call_id: string;
254
+ /**
255
+ * Name of the function being called
256
+ */
116
257
  name: string;
258
+ /**
259
+ * Tool call type identifier, always "function_call"
260
+ */
117
261
  type: 'function_call';
262
+ /**
263
+ * (Optional) Additional identifier for the tool call
264
+ */
118
265
  id?: string;
266
+ /**
267
+ * (Optional) Current status of the function call execution
268
+ */
119
269
  status?: string;
120
270
  }
271
+ /**
272
+ * Model Context Protocol (MCP) call output message for OpenAI responses.
273
+ */
121
274
  interface OpenAIResponseOutputMessageMcpCall {
275
+ /**
276
+ * Unique identifier for this MCP call
277
+ */
122
278
  id: string;
279
+ /**
280
+ * JSON string containing the MCP call arguments
281
+ */
123
282
  arguments: string;
283
+ /**
284
+ * Name of the MCP method being called
285
+ */
124
286
  name: string;
287
+ /**
288
+ * Label identifying the MCP server handling the call
289
+ */
125
290
  server_label: string;
291
+ /**
292
+ * Tool call type identifier, always "mcp_call"
293
+ */
126
294
  type: 'mcp_call';
295
+ /**
296
+ * (Optional) Error message if the MCP call failed
297
+ */
127
298
  error?: string;
299
+ /**
300
+ * (Optional) Output result from the successful MCP call
301
+ */
128
302
  output?: string;
129
303
  }
304
+ /**
305
+ * MCP list tools output message containing available tools from an MCP server.
306
+ */
130
307
  interface OpenAIResponseOutputMessageMcpListTools {
308
+ /**
309
+ * Unique identifier for this MCP list tools operation
310
+ */
131
311
  id: string;
312
+ /**
313
+ * Label identifying the MCP server providing the tools
314
+ */
132
315
  server_label: string;
316
+ /**
317
+ * List of available tools provided by the MCP server
318
+ */
133
319
  tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
320
+ /**
321
+ * Tool call type identifier, always "mcp_list_tools"
322
+ */
134
323
  type: 'mcp_list_tools';
135
324
  }
136
325
  namespace OpenAIResponseOutputMessageMcpListTools {
326
+ /**
327
+ * Tool definition returned by MCP list tools operation.
328
+ */
137
329
  interface Tool {
330
+ /**
331
+ * JSON schema defining the tool's input parameters
332
+ */
138
333
  input_schema: {
139
334
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
140
335
  };
336
+ /**
337
+ * Name of the tool
338
+ */
141
339
  name: string;
340
+ /**
341
+ * (Optional) Description of what the tool does
342
+ */
142
343
  description?: string;
143
344
  }
144
345
  }
346
+ /**
347
+ * Text formatting configuration for the response
348
+ */
145
349
  interface Text {
146
350
  /**
147
- * Configuration for Responses API text format.
351
+ * (Optional) Text format configuration specifying output format requirements
148
352
  */
149
353
  format?: Text.Format;
150
354
  }
151
355
  namespace Text {
152
356
  /**
153
- * Configuration for Responses API text format.
357
+ * (Optional) Text format configuration specifying output format requirements
154
358
  */
155
359
  interface Format {
156
360
  /**
@@ -179,27 +383,61 @@ export declare namespace ResponseObject {
179
383
  strict?: boolean;
180
384
  }
181
385
  }
386
+ /**
387
+ * (Optional) Error details if the response generation failed
388
+ */
182
389
  interface Error {
390
+ /**
391
+ * Error code identifying the type of failure
392
+ */
183
393
  code: string;
394
+ /**
395
+ * Human-readable error message describing the failure
396
+ */
184
397
  message: string;
185
398
  }
186
399
  }
400
+ /**
401
+ * Streaming event indicating a new response has been created.
402
+ */
187
403
  export type ResponseObjectStream = ResponseObjectStream.OpenAIResponseObjectStreamResponseCreated | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputItemAdded | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputItemDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputTextDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputTextDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallSearching | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsFailed | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallArgumentsDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallFailed | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseCompleted;
188
404
  export declare namespace ResponseObjectStream {
405
+ /**
406
+ * Streaming event indicating a new response has been created.
407
+ */
189
408
  interface OpenAIResponseObjectStreamResponseCreated {
409
+ /**
410
+ * The newly created response object
411
+ */
190
412
  response: ResponsesAPI.ResponseObject;
413
+ /**
414
+ * Event type identifier, always "response.created"
415
+ */
191
416
  type: 'response.created';
192
417
  }
418
+ /**
419
+ * Streaming event for when a new output item is added to the response.
420
+ */
193
421
  interface OpenAIResponseObjectStreamResponseOutputItemAdded {
194
422
  /**
195
- * Corresponds to the various Message types in the Responses API. They are all
196
- * under one type because the Responses API gives them all the same "type" value,
197
- * and there is no way to tell them apart in certain scenarios.
423
+ * The output item that was added (message, tool call, etc.)
198
424
  */
199
425
  item: OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpListTools;
426
+ /**
427
+ * Index position of this item in the output list
428
+ */
200
429
  output_index: number;
430
+ /**
431
+ * Unique identifier of the response containing this output
432
+ */
201
433
  response_id: string;
434
+ /**
435
+ * Sequential number for ordering streaming events
436
+ */
202
437
  sequence_number: number;
438
+ /**
439
+ * Event type identifier, always "response.output_item.added"
440
+ */
203
441
  type: 'response.output_item.added';
204
442
  }
205
443
  namespace OpenAIResponseObjectStreamResponseOutputItemAdded {
@@ -216,13 +454,34 @@ export declare namespace ResponseObjectStream {
216
454
  status?: string;
217
455
  }
218
456
  namespace OpenAIResponseMessage {
457
+ /**
458
+ * Text content for input messages in OpenAI response format.
459
+ */
219
460
  interface OpenAIResponseInputMessageContentText {
461
+ /**
462
+ * The text content of the input message
463
+ */
220
464
  text: string;
465
+ /**
466
+ * Content type identifier, always "input_text"
467
+ */
221
468
  type: 'input_text';
222
469
  }
470
+ /**
471
+ * Image content for input messages in OpenAI response format.
472
+ */
223
473
  interface OpenAIResponseInputMessageContentImage {
474
+ /**
475
+ * Level of detail for image processing, can be "low", "high", or "auto"
476
+ */
224
477
  detail: 'low' | 'high' | 'auto';
478
+ /**
479
+ * Content type identifier, always "input_image"
480
+ */
225
481
  type: 'input_image';
482
+ /**
483
+ * (Optional) URL of the image content
484
+ */
226
485
  image_url?: string;
227
486
  }
228
487
  interface UnionMember2 {
@@ -231,17 +490,50 @@ export declare namespace ResponseObjectStream {
231
490
  type: 'output_text';
232
491
  }
233
492
  namespace UnionMember2 {
493
+ /**
494
+ * File citation annotation for referencing specific files in response content.
495
+ */
234
496
  interface OpenAIResponseAnnotationFileCitation {
497
+ /**
498
+ * Unique identifier of the referenced file
499
+ */
235
500
  file_id: string;
501
+ /**
502
+ * Name of the referenced file
503
+ */
236
504
  filename: string;
505
+ /**
506
+ * Position index of the citation within the content
507
+ */
237
508
  index: number;
509
+ /**
510
+ * Annotation type identifier, always "file_citation"
511
+ */
238
512
  type: 'file_citation';
239
513
  }
514
+ /**
515
+ * URL citation annotation for referencing external web resources.
516
+ */
240
517
  interface OpenAIResponseAnnotationCitation {
518
+ /**
519
+ * End position of the citation span in the content
520
+ */
241
521
  end_index: number;
522
+ /**
523
+ * Start position of the citation span in the content
524
+ */
242
525
  start_index: number;
526
+ /**
527
+ * Title of the referenced web resource
528
+ */
243
529
  title: string;
530
+ /**
531
+ * Annotation type identifier, always "url_citation"
532
+ */
244
533
  type: 'url_citation';
534
+ /**
535
+ * URL of the referenced web resource
536
+ */
245
537
  url: string;
246
538
  }
247
539
  interface OpenAIResponseAnnotationContainerFileCitation {
@@ -259,63 +551,178 @@ export declare namespace ResponseObjectStream {
259
551
  }
260
552
  }
261
553
  }
554
+ /**
555
+ * Web search tool call output message for OpenAI responses.
556
+ */
262
557
  interface OpenAIResponseOutputMessageWebSearchToolCall {
558
+ /**
559
+ * Unique identifier for this tool call
560
+ */
263
561
  id: string;
562
+ /**
563
+ * Current status of the web search operation
564
+ */
264
565
  status: string;
566
+ /**
567
+ * Tool call type identifier, always "web_search_call"
568
+ */
265
569
  type: 'web_search_call';
266
570
  }
571
+ /**
572
+ * File search tool call output message for OpenAI responses.
573
+ */
267
574
  interface OpenAIResponseOutputMessageFileSearchToolCall {
575
+ /**
576
+ * Unique identifier for this tool call
577
+ */
268
578
  id: string;
579
+ /**
580
+ * List of search queries executed
581
+ */
269
582
  queries: Array<string>;
583
+ /**
584
+ * Current status of the file search operation
585
+ */
270
586
  status: string;
587
+ /**
588
+ * Tool call type identifier, always "file_search_call"
589
+ */
271
590
  type: 'file_search_call';
591
+ /**
592
+ * (Optional) Search results returned by the file search operation
593
+ */
272
594
  results?: Array<{
273
595
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
274
596
  }>;
275
597
  }
598
+ /**
599
+ * Function tool call output message for OpenAI responses.
600
+ */
276
601
  interface OpenAIResponseOutputMessageFunctionToolCall {
602
+ /**
603
+ * JSON string containing the function arguments
604
+ */
277
605
  arguments: string;
606
+ /**
607
+ * Unique identifier for the function call
608
+ */
278
609
  call_id: string;
610
+ /**
611
+ * Name of the function being called
612
+ */
279
613
  name: string;
614
+ /**
615
+ * Tool call type identifier, always "function_call"
616
+ */
280
617
  type: 'function_call';
618
+ /**
619
+ * (Optional) Additional identifier for the tool call
620
+ */
281
621
  id?: string;
622
+ /**
623
+ * (Optional) Current status of the function call execution
624
+ */
282
625
  status?: string;
283
626
  }
627
+ /**
628
+ * Model Context Protocol (MCP) call output message for OpenAI responses.
629
+ */
284
630
  interface OpenAIResponseOutputMessageMcpCall {
631
+ /**
632
+ * Unique identifier for this MCP call
633
+ */
285
634
  id: string;
635
+ /**
636
+ * JSON string containing the MCP call arguments
637
+ */
286
638
  arguments: string;
639
+ /**
640
+ * Name of the MCP method being called
641
+ */
287
642
  name: string;
643
+ /**
644
+ * Label identifying the MCP server handling the call
645
+ */
288
646
  server_label: string;
647
+ /**
648
+ * Tool call type identifier, always "mcp_call"
649
+ */
289
650
  type: 'mcp_call';
651
+ /**
652
+ * (Optional) Error message if the MCP call failed
653
+ */
290
654
  error?: string;
655
+ /**
656
+ * (Optional) Output result from the successful MCP call
657
+ */
291
658
  output?: string;
292
659
  }
660
+ /**
661
+ * MCP list tools output message containing available tools from an MCP server.
662
+ */
293
663
  interface OpenAIResponseOutputMessageMcpListTools {
664
+ /**
665
+ * Unique identifier for this MCP list tools operation
666
+ */
294
667
  id: string;
668
+ /**
669
+ * Label identifying the MCP server providing the tools
670
+ */
295
671
  server_label: string;
672
+ /**
673
+ * List of available tools provided by the MCP server
674
+ */
296
675
  tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
676
+ /**
677
+ * Tool call type identifier, always "mcp_list_tools"
678
+ */
297
679
  type: 'mcp_list_tools';
298
680
  }
299
681
  namespace OpenAIResponseOutputMessageMcpListTools {
682
+ /**
683
+ * Tool definition returned by MCP list tools operation.
684
+ */
300
685
  interface Tool {
686
+ /**
687
+ * JSON schema defining the tool's input parameters
688
+ */
301
689
  input_schema: {
302
690
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
303
691
  };
692
+ /**
693
+ * Name of the tool
694
+ */
304
695
  name: string;
696
+ /**
697
+ * (Optional) Description of what the tool does
698
+ */
305
699
  description?: string;
306
700
  }
307
701
  }
308
702
  }
703
+ /**
704
+ * Streaming event for when an output item is completed.
705
+ */
309
706
  interface OpenAIResponseObjectStreamResponseOutputItemDone {
310
707
  /**
311
- * Corresponds to the various Message types in the Responses API. They are all
312
- * under one type because the Responses API gives them all the same "type" value,
313
- * and there is no way to tell them apart in certain scenarios.
708
+ * The completed output item (message, tool call, etc.)
314
709
  */
315
710
  item: OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpListTools;
711
+ /**
712
+ * Index position of this item in the output list
713
+ */
316
714
  output_index: number;
715
+ /**
716
+ * Unique identifier of the response containing this output
717
+ */
317
718
  response_id: string;
719
+ /**
720
+ * Sequential number for ordering streaming events
721
+ */
318
722
  sequence_number: number;
723
+ /**
724
+ * Event type identifier, always "response.output_item.done"
725
+ */
319
726
  type: 'response.output_item.done';
320
727
  }
321
728
  namespace OpenAIResponseObjectStreamResponseOutputItemDone {
@@ -332,13 +739,34 @@ export declare namespace ResponseObjectStream {
332
739
  status?: string;
333
740
  }
334
741
  namespace OpenAIResponseMessage {
742
+ /**
743
+ * Text content for input messages in OpenAI response format.
744
+ */
335
745
  interface OpenAIResponseInputMessageContentText {
746
+ /**
747
+ * The text content of the input message
748
+ */
336
749
  text: string;
750
+ /**
751
+ * Content type identifier, always "input_text"
752
+ */
337
753
  type: 'input_text';
338
754
  }
755
+ /**
756
+ * Image content for input messages in OpenAI response format.
757
+ */
339
758
  interface OpenAIResponseInputMessageContentImage {
759
+ /**
760
+ * Level of detail for image processing, can be "low", "high", or "auto"
761
+ */
340
762
  detail: 'low' | 'high' | 'auto';
763
+ /**
764
+ * Content type identifier, always "input_image"
765
+ */
341
766
  type: 'input_image';
767
+ /**
768
+ * (Optional) URL of the image content
769
+ */
342
770
  image_url?: string;
343
771
  }
344
772
  interface UnionMember2 {
@@ -347,17 +775,50 @@ export declare namespace ResponseObjectStream {
347
775
  type: 'output_text';
348
776
  }
349
777
  namespace UnionMember2 {
778
+ /**
779
+ * File citation annotation for referencing specific files in response content.
780
+ */
350
781
  interface OpenAIResponseAnnotationFileCitation {
782
+ /**
783
+ * Unique identifier of the referenced file
784
+ */
351
785
  file_id: string;
786
+ /**
787
+ * Name of the referenced file
788
+ */
352
789
  filename: string;
790
+ /**
791
+ * Position index of the citation within the content
792
+ */
353
793
  index: number;
794
+ /**
795
+ * Annotation type identifier, always "file_citation"
796
+ */
354
797
  type: 'file_citation';
355
798
  }
799
+ /**
800
+ * URL citation annotation for referencing external web resources.
801
+ */
356
802
  interface OpenAIResponseAnnotationCitation {
803
+ /**
804
+ * End position of the citation span in the content
805
+ */
357
806
  end_index: number;
807
+ /**
808
+ * Start position of the citation span in the content
809
+ */
358
810
  start_index: number;
811
+ /**
812
+ * Title of the referenced web resource
813
+ */
359
814
  title: string;
815
+ /**
816
+ * Annotation type identifier, always "url_citation"
817
+ */
360
818
  type: 'url_citation';
819
+ /**
820
+ * URL of the referenced web resource
821
+ */
361
822
  url: string;
362
823
  }
363
824
  interface OpenAIResponseAnnotationContainerFileCitation {
@@ -375,87 +836,282 @@ export declare namespace ResponseObjectStream {
375
836
  }
376
837
  }
377
838
  }
839
+ /**
840
+ * Web search tool call output message for OpenAI responses.
841
+ */
378
842
  interface OpenAIResponseOutputMessageWebSearchToolCall {
843
+ /**
844
+ * Unique identifier for this tool call
845
+ */
379
846
  id: string;
847
+ /**
848
+ * Current status of the web search operation
849
+ */
380
850
  status: string;
851
+ /**
852
+ * Tool call type identifier, always "web_search_call"
853
+ */
381
854
  type: 'web_search_call';
382
855
  }
856
+ /**
857
+ * File search tool call output message for OpenAI responses.
858
+ */
383
859
  interface OpenAIResponseOutputMessageFileSearchToolCall {
860
+ /**
861
+ * Unique identifier for this tool call
862
+ */
384
863
  id: string;
864
+ /**
865
+ * List of search queries executed
866
+ */
385
867
  queries: Array<string>;
868
+ /**
869
+ * Current status of the file search operation
870
+ */
386
871
  status: string;
872
+ /**
873
+ * Tool call type identifier, always "file_search_call"
874
+ */
387
875
  type: 'file_search_call';
876
+ /**
877
+ * (Optional) Search results returned by the file search operation
878
+ */
388
879
  results?: Array<{
389
880
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
390
881
  }>;
391
882
  }
883
+ /**
884
+ * Function tool call output message for OpenAI responses.
885
+ */
392
886
  interface OpenAIResponseOutputMessageFunctionToolCall {
887
+ /**
888
+ * JSON string containing the function arguments
889
+ */
393
890
  arguments: string;
891
+ /**
892
+ * Unique identifier for the function call
893
+ */
394
894
  call_id: string;
895
+ /**
896
+ * Name of the function being called
897
+ */
395
898
  name: string;
899
+ /**
900
+ * Tool call type identifier, always "function_call"
901
+ */
396
902
  type: 'function_call';
903
+ /**
904
+ * (Optional) Additional identifier for the tool call
905
+ */
397
906
  id?: string;
907
+ /**
908
+ * (Optional) Current status of the function call execution
909
+ */
398
910
  status?: string;
399
911
  }
912
+ /**
913
+ * Model Context Protocol (MCP) call output message for OpenAI responses.
914
+ */
400
915
  interface OpenAIResponseOutputMessageMcpCall {
916
+ /**
917
+ * Unique identifier for this MCP call
918
+ */
401
919
  id: string;
920
+ /**
921
+ * JSON string containing the MCP call arguments
922
+ */
402
923
  arguments: string;
924
+ /**
925
+ * Name of the MCP method being called
926
+ */
403
927
  name: string;
928
+ /**
929
+ * Label identifying the MCP server handling the call
930
+ */
404
931
  server_label: string;
932
+ /**
933
+ * Tool call type identifier, always "mcp_call"
934
+ */
405
935
  type: 'mcp_call';
936
+ /**
937
+ * (Optional) Error message if the MCP call failed
938
+ */
406
939
  error?: string;
940
+ /**
941
+ * (Optional) Output result from the successful MCP call
942
+ */
407
943
  output?: string;
408
944
  }
945
+ /**
946
+ * MCP list tools output message containing available tools from an MCP server.
947
+ */
409
948
  interface OpenAIResponseOutputMessageMcpListTools {
949
+ /**
950
+ * Unique identifier for this MCP list tools operation
951
+ */
410
952
  id: string;
953
+ /**
954
+ * Label identifying the MCP server providing the tools
955
+ */
411
956
  server_label: string;
957
+ /**
958
+ * List of available tools provided by the MCP server
959
+ */
412
960
  tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
961
+ /**
962
+ * Tool call type identifier, always "mcp_list_tools"
963
+ */
413
964
  type: 'mcp_list_tools';
414
965
  }
415
966
  namespace OpenAIResponseOutputMessageMcpListTools {
967
+ /**
968
+ * Tool definition returned by MCP list tools operation.
969
+ */
416
970
  interface Tool {
971
+ /**
972
+ * JSON schema defining the tool's input parameters
973
+ */
417
974
  input_schema: {
418
975
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
419
976
  };
977
+ /**
978
+ * Name of the tool
979
+ */
420
980
  name: string;
981
+ /**
982
+ * (Optional) Description of what the tool does
983
+ */
421
984
  description?: string;
422
985
  }
423
986
  }
424
987
  }
988
+ /**
989
+ * Streaming event for incremental text content updates.
990
+ */
425
991
  interface OpenAIResponseObjectStreamResponseOutputTextDelta {
992
+ /**
993
+ * Index position within the text content
994
+ */
426
995
  content_index: number;
996
+ /**
997
+ * Incremental text content being added
998
+ */
427
999
  delta: string;
1000
+ /**
1001
+ * Unique identifier of the output item being updated
1002
+ */
428
1003
  item_id: string;
1004
+ /**
1005
+ * Index position of the item in the output list
1006
+ */
429
1007
  output_index: number;
1008
+ /**
1009
+ * Sequential number for ordering streaming events
1010
+ */
430
1011
  sequence_number: number;
1012
+ /**
1013
+ * Event type identifier, always "response.output_text.delta"
1014
+ */
431
1015
  type: 'response.output_text.delta';
432
1016
  }
1017
+ /**
1018
+ * Streaming event for when text output is completed.
1019
+ */
433
1020
  interface OpenAIResponseObjectStreamResponseOutputTextDone {
1021
+ /**
1022
+ * Index position within the text content
1023
+ */
434
1024
  content_index: number;
1025
+ /**
1026
+ * Unique identifier of the completed output item
1027
+ */
435
1028
  item_id: string;
1029
+ /**
1030
+ * Index position of the item in the output list
1031
+ */
436
1032
  output_index: number;
1033
+ /**
1034
+ * Sequential number for ordering streaming events
1035
+ */
437
1036
  sequence_number: number;
1037
+ /**
1038
+ * Final complete text content of the output item
1039
+ */
438
1040
  text: string;
1041
+ /**
1042
+ * Event type identifier, always "response.output_text.done"
1043
+ */
439
1044
  type: 'response.output_text.done';
440
1045
  }
1046
+ /**
1047
+ * Streaming event for incremental function call argument updates.
1048
+ */
441
1049
  interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta {
1050
+ /**
1051
+ * Incremental function call arguments being added
1052
+ */
442
1053
  delta: string;
1054
+ /**
1055
+ * Unique identifier of the function call being updated
1056
+ */
443
1057
  item_id: string;
1058
+ /**
1059
+ * Index position of the item in the output list
1060
+ */
444
1061
  output_index: number;
1062
+ /**
1063
+ * Sequential number for ordering streaming events
1064
+ */
445
1065
  sequence_number: number;
1066
+ /**
1067
+ * Event type identifier, always "response.function_call_arguments.delta"
1068
+ */
446
1069
  type: 'response.function_call_arguments.delta';
447
1070
  }
1071
+ /**
1072
+ * Streaming event for when function call arguments are completed.
1073
+ */
448
1074
  interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone {
1075
+ /**
1076
+ * Final complete arguments JSON string for the function call
1077
+ */
449
1078
  arguments: string;
1079
+ /**
1080
+ * Unique identifier of the completed function call
1081
+ */
450
1082
  item_id: string;
1083
+ /**
1084
+ * Index position of the item in the output list
1085
+ */
451
1086
  output_index: number;
1087
+ /**
1088
+ * Sequential number for ordering streaming events
1089
+ */
452
1090
  sequence_number: number;
1091
+ /**
1092
+ * Event type identifier, always "response.function_call_arguments.done"
1093
+ */
453
1094
  type: 'response.function_call_arguments.done';
454
1095
  }
1096
+ /**
1097
+ * Streaming event for web search calls in progress.
1098
+ */
455
1099
  interface OpenAIResponseObjectStreamResponseWebSearchCallInProgress {
1100
+ /**
1101
+ * Unique identifier of the web search call
1102
+ */
456
1103
  item_id: string;
1104
+ /**
1105
+ * Index position of the item in the output list
1106
+ */
457
1107
  output_index: number;
1108
+ /**
1109
+ * Sequential number for ordering streaming events
1110
+ */
458
1111
  sequence_number: number;
1112
+ /**
1113
+ * Event type identifier, always "response.web_search_call.in_progress"
1114
+ */
459
1115
  type: 'response.web_search_call.in_progress';
460
1116
  }
461
1117
  interface OpenAIResponseObjectStreamResponseWebSearchCallSearching {
@@ -464,10 +1120,25 @@ export declare namespace ResponseObjectStream {
464
1120
  sequence_number: number;
465
1121
  type: 'response.web_search_call.searching';
466
1122
  }
1123
+ /**
1124
+ * Streaming event for completed web search calls.
1125
+ */
467
1126
  interface OpenAIResponseObjectStreamResponseWebSearchCallCompleted {
1127
+ /**
1128
+ * Unique identifier of the completed web search call
1129
+ */
468
1130
  item_id: string;
1131
+ /**
1132
+ * Index position of the item in the output list
1133
+ */
469
1134
  output_index: number;
1135
+ /**
1136
+ * Sequential number for ordering streaming events
1137
+ */
470
1138
  sequence_number: number;
1139
+ /**
1140
+ * Event type identifier, always "response.web_search_call.completed"
1141
+ */
471
1142
  type: 'response.web_search_call.completed';
472
1143
  }
473
1144
  interface OpenAIResponseObjectStreamResponseMcpListToolsInProgress {
@@ -496,71 +1167,230 @@ export declare namespace ResponseObjectStream {
496
1167
  sequence_number: number;
497
1168
  type: 'response.mcp_call.arguments.done';
498
1169
  }
1170
+ /**
1171
+ * Streaming event for MCP calls in progress.
1172
+ */
499
1173
  interface OpenAIResponseObjectStreamResponseMcpCallInProgress {
1174
+ /**
1175
+ * Unique identifier of the MCP call
1176
+ */
500
1177
  item_id: string;
1178
+ /**
1179
+ * Index position of the item in the output list
1180
+ */
501
1181
  output_index: number;
1182
+ /**
1183
+ * Sequential number for ordering streaming events
1184
+ */
502
1185
  sequence_number: number;
1186
+ /**
1187
+ * Event type identifier, always "response.mcp_call.in_progress"
1188
+ */
503
1189
  type: 'response.mcp_call.in_progress';
504
1190
  }
1191
+ /**
1192
+ * Streaming event for failed MCP calls.
1193
+ */
505
1194
  interface OpenAIResponseObjectStreamResponseMcpCallFailed {
1195
+ /**
1196
+ * Sequential number for ordering streaming events
1197
+ */
506
1198
  sequence_number: number;
1199
+ /**
1200
+ * Event type identifier, always "response.mcp_call.failed"
1201
+ */
507
1202
  type: 'response.mcp_call.failed';
508
1203
  }
1204
+ /**
1205
+ * Streaming event for completed MCP calls.
1206
+ */
509
1207
  interface OpenAIResponseObjectStreamResponseMcpCallCompleted {
1208
+ /**
1209
+ * Sequential number for ordering streaming events
1210
+ */
510
1211
  sequence_number: number;
1212
+ /**
1213
+ * Event type identifier, always "response.mcp_call.completed"
1214
+ */
511
1215
  type: 'response.mcp_call.completed';
512
1216
  }
1217
+ /**
1218
+ * Streaming event indicating a response has been completed.
1219
+ */
513
1220
  interface OpenAIResponseObjectStreamResponseCompleted {
1221
+ /**
1222
+ * The completed response object
1223
+ */
514
1224
  response: ResponsesAPI.ResponseObject;
1225
+ /**
1226
+ * Event type identifier, always "response.completed"
1227
+ */
515
1228
  type: 'response.completed';
516
1229
  }
517
1230
  }
1231
+ /**
1232
+ * Paginated list of OpenAI response objects with navigation metadata.
1233
+ */
518
1234
  export interface ResponseListResponse {
1235
+ /**
1236
+ * List of response objects with their input context
1237
+ */
519
1238
  data: Array<ResponseListResponse.Data>;
1239
+ /**
1240
+ * Identifier of the first item in this page
1241
+ */
520
1242
  first_id: string;
1243
+ /**
1244
+ * Whether there are more results available beyond this page
1245
+ */
521
1246
  has_more: boolean;
1247
+ /**
1248
+ * Identifier of the last item in this page
1249
+ */
522
1250
  last_id: string;
1251
+ /**
1252
+ * Object type identifier, always "list"
1253
+ */
523
1254
  object: 'list';
524
1255
  }
525
1256
  export declare namespace ResponseListResponse {
1257
+ /**
1258
+ * OpenAI response object extended with input context information.
1259
+ */
526
1260
  interface Data {
1261
+ /**
1262
+ * Unique identifier for this response
1263
+ */
527
1264
  id: string;
1265
+ /**
1266
+ * Unix timestamp when the response was created
1267
+ */
528
1268
  created_at: number;
1269
+ /**
1270
+ * List of input items that led to this response
1271
+ */
529
1272
  input: Array<Data.OpenAIResponseOutputMessageWebSearchToolCall | Data.OpenAIResponseOutputMessageFileSearchToolCall | Data.OpenAIResponseOutputMessageFunctionToolCall | Data.OpenAIResponseInputFunctionToolCallOutput | Data.OpenAIResponseMessage>;
1273
+ /**
1274
+ * Model identifier used for generation
1275
+ */
530
1276
  model: string;
1277
+ /**
1278
+ * Object type identifier, always "response"
1279
+ */
531
1280
  object: 'response';
1281
+ /**
1282
+ * List of generated output items (messages, tool calls, etc.)
1283
+ */
532
1284
  output: Array<Data.OpenAIResponseMessage | Data.OpenAIResponseOutputMessageWebSearchToolCall | Data.OpenAIResponseOutputMessageFileSearchToolCall | Data.OpenAIResponseOutputMessageFunctionToolCall | Data.OpenAIResponseOutputMessageMcpCall | Data.OpenAIResponseOutputMessageMcpListTools>;
1285
+ /**
1286
+ * Whether tool calls can be executed in parallel
1287
+ */
533
1288
  parallel_tool_calls: boolean;
1289
+ /**
1290
+ * Current status of the response generation
1291
+ */
534
1292
  status: string;
1293
+ /**
1294
+ * Text formatting configuration for the response
1295
+ */
535
1296
  text: Data.Text;
1297
+ /**
1298
+ * (Optional) Error details if the response generation failed
1299
+ */
536
1300
  error?: Data.Error;
1301
+ /**
1302
+ * (Optional) ID of the previous response in a conversation
1303
+ */
537
1304
  previous_response_id?: string;
1305
+ /**
1306
+ * (Optional) Sampling temperature used for generation
1307
+ */
538
1308
  temperature?: number;
1309
+ /**
1310
+ * (Optional) Nucleus sampling parameter used for generation
1311
+ */
539
1312
  top_p?: number;
1313
+ /**
1314
+ * (Optional) Truncation strategy applied to the response
1315
+ */
540
1316
  truncation?: string;
1317
+ /**
1318
+ * (Optional) User identifier associated with the request
1319
+ */
541
1320
  user?: string;
542
1321
  }
543
1322
  namespace Data {
1323
+ /**
1324
+ * Web search tool call output message for OpenAI responses.
1325
+ */
544
1326
  interface OpenAIResponseOutputMessageWebSearchToolCall {
1327
+ /**
1328
+ * Unique identifier for this tool call
1329
+ */
545
1330
  id: string;
1331
+ /**
1332
+ * Current status of the web search operation
1333
+ */
546
1334
  status: string;
1335
+ /**
1336
+ * Tool call type identifier, always "web_search_call"
1337
+ */
547
1338
  type: 'web_search_call';
548
1339
  }
1340
+ /**
1341
+ * File search tool call output message for OpenAI responses.
1342
+ */
549
1343
  interface OpenAIResponseOutputMessageFileSearchToolCall {
1344
+ /**
1345
+ * Unique identifier for this tool call
1346
+ */
550
1347
  id: string;
1348
+ /**
1349
+ * List of search queries executed
1350
+ */
551
1351
  queries: Array<string>;
1352
+ /**
1353
+ * Current status of the file search operation
1354
+ */
552
1355
  status: string;
1356
+ /**
1357
+ * Tool call type identifier, always "file_search_call"
1358
+ */
553
1359
  type: 'file_search_call';
1360
+ /**
1361
+ * (Optional) Search results returned by the file search operation
1362
+ */
554
1363
  results?: Array<{
555
1364
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
556
1365
  }>;
557
1366
  }
1367
+ /**
1368
+ * Function tool call output message for OpenAI responses.
1369
+ */
558
1370
  interface OpenAIResponseOutputMessageFunctionToolCall {
1371
+ /**
1372
+ * JSON string containing the function arguments
1373
+ */
559
1374
  arguments: string;
1375
+ /**
1376
+ * Unique identifier for the function call
1377
+ */
560
1378
  call_id: string;
1379
+ /**
1380
+ * Name of the function being called
1381
+ */
561
1382
  name: string;
1383
+ /**
1384
+ * Tool call type identifier, always "function_call"
1385
+ */
562
1386
  type: 'function_call';
1387
+ /**
1388
+ * (Optional) Additional identifier for the tool call
1389
+ */
563
1390
  id?: string;
1391
+ /**
1392
+ * (Optional) Current status of the function call execution
1393
+ */
564
1394
  status?: string;
565
1395
  }
566
1396
  /**
@@ -587,13 +1417,34 @@ export declare namespace ResponseListResponse {
587
1417
  status?: string;
588
1418
  }
589
1419
  namespace OpenAIResponseMessage {
1420
+ /**
1421
+ * Text content for input messages in OpenAI response format.
1422
+ */
590
1423
  interface OpenAIResponseInputMessageContentText {
1424
+ /**
1425
+ * The text content of the input message
1426
+ */
591
1427
  text: string;
1428
+ /**
1429
+ * Content type identifier, always "input_text"
1430
+ */
592
1431
  type: 'input_text';
593
1432
  }
1433
+ /**
1434
+ * Image content for input messages in OpenAI response format.
1435
+ */
594
1436
  interface OpenAIResponseInputMessageContentImage {
1437
+ /**
1438
+ * Level of detail for image processing, can be "low", "high", or "auto"
1439
+ */
595
1440
  detail: 'low' | 'high' | 'auto';
1441
+ /**
1442
+ * Content type identifier, always "input_image"
1443
+ */
596
1444
  type: 'input_image';
1445
+ /**
1446
+ * (Optional) URL of the image content
1447
+ */
597
1448
  image_url?: string;
598
1449
  }
599
1450
  interface UnionMember2 {
@@ -602,17 +1453,50 @@ export declare namespace ResponseListResponse {
602
1453
  type: 'output_text';
603
1454
  }
604
1455
  namespace UnionMember2 {
1456
+ /**
1457
+ * File citation annotation for referencing specific files in response content.
1458
+ */
605
1459
  interface OpenAIResponseAnnotationFileCitation {
1460
+ /**
1461
+ * Unique identifier of the referenced file
1462
+ */
606
1463
  file_id: string;
1464
+ /**
1465
+ * Name of the referenced file
1466
+ */
607
1467
  filename: string;
1468
+ /**
1469
+ * Position index of the citation within the content
1470
+ */
608
1471
  index: number;
1472
+ /**
1473
+ * Annotation type identifier, always "file_citation"
1474
+ */
609
1475
  type: 'file_citation';
610
1476
  }
1477
+ /**
1478
+ * URL citation annotation for referencing external web resources.
1479
+ */
611
1480
  interface OpenAIResponseAnnotationCitation {
1481
+ /**
1482
+ * End position of the citation span in the content
1483
+ */
612
1484
  end_index: number;
1485
+ /**
1486
+ * Start position of the citation span in the content
1487
+ */
613
1488
  start_index: number;
1489
+ /**
1490
+ * Title of the referenced web resource
1491
+ */
614
1492
  title: string;
1493
+ /**
1494
+ * Annotation type identifier, always "url_citation"
1495
+ */
615
1496
  type: 'url_citation';
1497
+ /**
1498
+ * URL of the referenced web resource
1499
+ */
616
1500
  url: string;
617
1501
  }
618
1502
  interface OpenAIResponseAnnotationContainerFileCitation {
@@ -643,13 +1527,34 @@ export declare namespace ResponseListResponse {
643
1527
  status?: string;
644
1528
  }
645
1529
  namespace OpenAIResponseMessage {
1530
+ /**
1531
+ * Text content for input messages in OpenAI response format.
1532
+ */
646
1533
  interface OpenAIResponseInputMessageContentText {
1534
+ /**
1535
+ * The text content of the input message
1536
+ */
647
1537
  text: string;
1538
+ /**
1539
+ * Content type identifier, always "input_text"
1540
+ */
648
1541
  type: 'input_text';
649
1542
  }
1543
+ /**
1544
+ * Image content for input messages in OpenAI response format.
1545
+ */
650
1546
  interface OpenAIResponseInputMessageContentImage {
1547
+ /**
1548
+ * Level of detail for image processing, can be "low", "high", or "auto"
1549
+ */
651
1550
  detail: 'low' | 'high' | 'auto';
1551
+ /**
1552
+ * Content type identifier, always "input_image"
1553
+ */
652
1554
  type: 'input_image';
1555
+ /**
1556
+ * (Optional) URL of the image content
1557
+ */
653
1558
  image_url?: string;
654
1559
  }
655
1560
  interface UnionMember2 {
@@ -658,17 +1563,50 @@ export declare namespace ResponseListResponse {
658
1563
  type: 'output_text';
659
1564
  }
660
1565
  namespace UnionMember2 {
1566
+ /**
1567
+ * File citation annotation for referencing specific files in response content.
1568
+ */
661
1569
  interface OpenAIResponseAnnotationFileCitation {
1570
+ /**
1571
+ * Unique identifier of the referenced file
1572
+ */
662
1573
  file_id: string;
1574
+ /**
1575
+ * Name of the referenced file
1576
+ */
663
1577
  filename: string;
1578
+ /**
1579
+ * Position index of the citation within the content
1580
+ */
664
1581
  index: number;
1582
+ /**
1583
+ * Annotation type identifier, always "file_citation"
1584
+ */
665
1585
  type: 'file_citation';
666
1586
  }
1587
+ /**
1588
+ * URL citation annotation for referencing external web resources.
1589
+ */
667
1590
  interface OpenAIResponseAnnotationCitation {
1591
+ /**
1592
+ * End position of the citation span in the content
1593
+ */
668
1594
  end_index: number;
1595
+ /**
1596
+ * Start position of the citation span in the content
1597
+ */
669
1598
  start_index: number;
1599
+ /**
1600
+ * Title of the referenced web resource
1601
+ */
670
1602
  title: string;
1603
+ /**
1604
+ * Annotation type identifier, always "url_citation"
1605
+ */
671
1606
  type: 'url_citation';
1607
+ /**
1608
+ * URL of the referenced web resource
1609
+ */
672
1610
  url: string;
673
1611
  }
674
1612
  interface OpenAIResponseAnnotationContainerFileCitation {
@@ -686,61 +1624,166 @@ export declare namespace ResponseListResponse {
686
1624
  }
687
1625
  }
688
1626
  }
1627
+ /**
1628
+ * Web search tool call output message for OpenAI responses.
1629
+ */
689
1630
  interface OpenAIResponseOutputMessageWebSearchToolCall {
1631
+ /**
1632
+ * Unique identifier for this tool call
1633
+ */
690
1634
  id: string;
1635
+ /**
1636
+ * Current status of the web search operation
1637
+ */
691
1638
  status: string;
1639
+ /**
1640
+ * Tool call type identifier, always "web_search_call"
1641
+ */
692
1642
  type: 'web_search_call';
693
1643
  }
1644
+ /**
1645
+ * File search tool call output message for OpenAI responses.
1646
+ */
694
1647
  interface OpenAIResponseOutputMessageFileSearchToolCall {
1648
+ /**
1649
+ * Unique identifier for this tool call
1650
+ */
695
1651
  id: string;
1652
+ /**
1653
+ * List of search queries executed
1654
+ */
696
1655
  queries: Array<string>;
1656
+ /**
1657
+ * Current status of the file search operation
1658
+ */
697
1659
  status: string;
1660
+ /**
1661
+ * Tool call type identifier, always "file_search_call"
1662
+ */
698
1663
  type: 'file_search_call';
1664
+ /**
1665
+ * (Optional) Search results returned by the file search operation
1666
+ */
699
1667
  results?: Array<{
700
1668
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
701
1669
  }>;
702
1670
  }
1671
+ /**
1672
+ * Function tool call output message for OpenAI responses.
1673
+ */
703
1674
  interface OpenAIResponseOutputMessageFunctionToolCall {
1675
+ /**
1676
+ * JSON string containing the function arguments
1677
+ */
704
1678
  arguments: string;
1679
+ /**
1680
+ * Unique identifier for the function call
1681
+ */
705
1682
  call_id: string;
1683
+ /**
1684
+ * Name of the function being called
1685
+ */
706
1686
  name: string;
1687
+ /**
1688
+ * Tool call type identifier, always "function_call"
1689
+ */
707
1690
  type: 'function_call';
1691
+ /**
1692
+ * (Optional) Additional identifier for the tool call
1693
+ */
708
1694
  id?: string;
1695
+ /**
1696
+ * (Optional) Current status of the function call execution
1697
+ */
709
1698
  status?: string;
710
1699
  }
1700
+ /**
1701
+ * Model Context Protocol (MCP) call output message for OpenAI responses.
1702
+ */
711
1703
  interface OpenAIResponseOutputMessageMcpCall {
1704
+ /**
1705
+ * Unique identifier for this MCP call
1706
+ */
712
1707
  id: string;
1708
+ /**
1709
+ * JSON string containing the MCP call arguments
1710
+ */
713
1711
  arguments: string;
1712
+ /**
1713
+ * Name of the MCP method being called
1714
+ */
714
1715
  name: string;
1716
+ /**
1717
+ * Label identifying the MCP server handling the call
1718
+ */
715
1719
  server_label: string;
1720
+ /**
1721
+ * Tool call type identifier, always "mcp_call"
1722
+ */
716
1723
  type: 'mcp_call';
1724
+ /**
1725
+ * (Optional) Error message if the MCP call failed
1726
+ */
717
1727
  error?: string;
1728
+ /**
1729
+ * (Optional) Output result from the successful MCP call
1730
+ */
718
1731
  output?: string;
719
1732
  }
1733
+ /**
1734
+ * MCP list tools output message containing available tools from an MCP server.
1735
+ */
720
1736
  interface OpenAIResponseOutputMessageMcpListTools {
1737
+ /**
1738
+ * Unique identifier for this MCP list tools operation
1739
+ */
721
1740
  id: string;
1741
+ /**
1742
+ * Label identifying the MCP server providing the tools
1743
+ */
722
1744
  server_label: string;
1745
+ /**
1746
+ * List of available tools provided by the MCP server
1747
+ */
723
1748
  tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
1749
+ /**
1750
+ * Tool call type identifier, always "mcp_list_tools"
1751
+ */
724
1752
  type: 'mcp_list_tools';
725
1753
  }
726
1754
  namespace OpenAIResponseOutputMessageMcpListTools {
1755
+ /**
1756
+ * Tool definition returned by MCP list tools operation.
1757
+ */
727
1758
  interface Tool {
1759
+ /**
1760
+ * JSON schema defining the tool's input parameters
1761
+ */
728
1762
  input_schema: {
729
1763
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
730
1764
  };
1765
+ /**
1766
+ * Name of the tool
1767
+ */
731
1768
  name: string;
1769
+ /**
1770
+ * (Optional) Description of what the tool does
1771
+ */
732
1772
  description?: string;
733
1773
  }
734
1774
  }
1775
+ /**
1776
+ * Text formatting configuration for the response
1777
+ */
735
1778
  interface Text {
736
1779
  /**
737
- * Configuration for Responses API text format.
1780
+ * (Optional) Text format configuration specifying output format requirements
738
1781
  */
739
1782
  format?: Text.Format;
740
1783
  }
741
1784
  namespace Text {
742
1785
  /**
743
- * Configuration for Responses API text format.
1786
+ * (Optional) Text format configuration specifying output format requirements
744
1787
  */
745
1788
  interface Format {
746
1789
  /**
@@ -769,8 +1812,17 @@ export declare namespace ResponseListResponse {
769
1812
  strict?: boolean;
770
1813
  }
771
1814
  }
1815
+ /**
1816
+ * (Optional) Error details if the response generation failed
1817
+ */
772
1818
  interface Error {
1819
+ /**
1820
+ * Error code identifying the type of failure
1821
+ */
773
1822
  code: string;
1823
+ /**
1824
+ * Human-readable error message describing the failure
1825
+ */
774
1826
  message: string;
775
1827
  }
776
1828
  }
@@ -796,30 +1848,84 @@ export interface ResponseCreateParamsBase {
796
1848
  store?: boolean;
797
1849
  stream?: boolean;
798
1850
  temperature?: number;
1851
+ /**
1852
+ * Text response configuration for OpenAI responses.
1853
+ */
799
1854
  text?: ResponseCreateParams.Text;
800
1855
  tools?: Array<ResponseCreateParams.OpenAIResponseInputToolWebSearch | ResponseCreateParams.OpenAIResponseInputToolFileSearch | ResponseCreateParams.OpenAIResponseInputToolFunction | ResponseCreateParams.OpenAIResponseInputToolMcp>;
801
1856
  }
802
1857
  export declare namespace ResponseCreateParams {
1858
+ /**
1859
+ * Web search tool call output message for OpenAI responses.
1860
+ */
803
1861
  interface OpenAIResponseOutputMessageWebSearchToolCall {
1862
+ /**
1863
+ * Unique identifier for this tool call
1864
+ */
804
1865
  id: string;
1866
+ /**
1867
+ * Current status of the web search operation
1868
+ */
805
1869
  status: string;
1870
+ /**
1871
+ * Tool call type identifier, always "web_search_call"
1872
+ */
806
1873
  type: 'web_search_call';
807
1874
  }
1875
+ /**
1876
+ * File search tool call output message for OpenAI responses.
1877
+ */
808
1878
  interface OpenAIResponseOutputMessageFileSearchToolCall {
1879
+ /**
1880
+ * Unique identifier for this tool call
1881
+ */
809
1882
  id: string;
1883
+ /**
1884
+ * List of search queries executed
1885
+ */
810
1886
  queries: Array<string>;
1887
+ /**
1888
+ * Current status of the file search operation
1889
+ */
811
1890
  status: string;
1891
+ /**
1892
+ * Tool call type identifier, always "file_search_call"
1893
+ */
812
1894
  type: 'file_search_call';
1895
+ /**
1896
+ * (Optional) Search results returned by the file search operation
1897
+ */
813
1898
  results?: Array<{
814
1899
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
815
1900
  }>;
816
1901
  }
1902
+ /**
1903
+ * Function tool call output message for OpenAI responses.
1904
+ */
817
1905
  interface OpenAIResponseOutputMessageFunctionToolCall {
1906
+ /**
1907
+ * JSON string containing the function arguments
1908
+ */
818
1909
  arguments: string;
1910
+ /**
1911
+ * Unique identifier for the function call
1912
+ */
819
1913
  call_id: string;
1914
+ /**
1915
+ * Name of the function being called
1916
+ */
820
1917
  name: string;
1918
+ /**
1919
+ * Tool call type identifier, always "function_call"
1920
+ */
821
1921
  type: 'function_call';
1922
+ /**
1923
+ * (Optional) Additional identifier for the tool call
1924
+ */
822
1925
  id?: string;
1926
+ /**
1927
+ * (Optional) Current status of the function call execution
1928
+ */
823
1929
  status?: string;
824
1930
  }
825
1931
  /**
@@ -846,13 +1952,34 @@ export declare namespace ResponseCreateParams {
846
1952
  status?: string;
847
1953
  }
848
1954
  namespace OpenAIResponseMessage {
1955
+ /**
1956
+ * Text content for input messages in OpenAI response format.
1957
+ */
849
1958
  interface OpenAIResponseInputMessageContentText {
1959
+ /**
1960
+ * The text content of the input message
1961
+ */
850
1962
  text: string;
1963
+ /**
1964
+ * Content type identifier, always "input_text"
1965
+ */
851
1966
  type: 'input_text';
852
1967
  }
1968
+ /**
1969
+ * Image content for input messages in OpenAI response format.
1970
+ */
853
1971
  interface OpenAIResponseInputMessageContentImage {
1972
+ /**
1973
+ * Level of detail for image processing, can be "low", "high", or "auto"
1974
+ */
854
1975
  detail: 'low' | 'high' | 'auto';
1976
+ /**
1977
+ * Content type identifier, always "input_image"
1978
+ */
855
1979
  type: 'input_image';
1980
+ /**
1981
+ * (Optional) URL of the image content
1982
+ */
856
1983
  image_url?: string;
857
1984
  }
858
1985
  interface UnionMember2 {
@@ -861,17 +1988,50 @@ export declare namespace ResponseCreateParams {
861
1988
  type: 'output_text';
862
1989
  }
863
1990
  namespace UnionMember2 {
1991
+ /**
1992
+ * File citation annotation for referencing specific files in response content.
1993
+ */
864
1994
  interface OpenAIResponseAnnotationFileCitation {
1995
+ /**
1996
+ * Unique identifier of the referenced file
1997
+ */
865
1998
  file_id: string;
1999
+ /**
2000
+ * Name of the referenced file
2001
+ */
866
2002
  filename: string;
2003
+ /**
2004
+ * Position index of the citation within the content
2005
+ */
867
2006
  index: number;
2007
+ /**
2008
+ * Annotation type identifier, always "file_citation"
2009
+ */
868
2010
  type: 'file_citation';
869
2011
  }
2012
+ /**
2013
+ * URL citation annotation for referencing external web resources.
2014
+ */
870
2015
  interface OpenAIResponseAnnotationCitation {
2016
+ /**
2017
+ * End position of the citation span in the content
2018
+ */
871
2019
  end_index: number;
2020
+ /**
2021
+ * Start position of the citation span in the content
2022
+ */
872
2023
  start_index: number;
2024
+ /**
2025
+ * Title of the referenced web resource
2026
+ */
873
2027
  title: string;
2028
+ /**
2029
+ * Annotation type identifier, always "url_citation"
2030
+ */
874
2031
  type: 'url_citation';
2032
+ /**
2033
+ * URL of the referenced web resource
2034
+ */
875
2035
  url: string;
876
2036
  }
877
2037
  interface OpenAIResponseAnnotationContainerFileCitation {
@@ -889,15 +2049,18 @@ export declare namespace ResponseCreateParams {
889
2049
  }
890
2050
  }
891
2051
  }
2052
+ /**
2053
+ * Text response configuration for OpenAI responses.
2054
+ */
892
2055
  interface Text {
893
2056
  /**
894
- * Configuration for Responses API text format.
2057
+ * (Optional) Text format configuration specifying output format requirements
895
2058
  */
896
2059
  format?: Text.Format;
897
2060
  }
898
2061
  namespace Text {
899
2062
  /**
900
- * Configuration for Responses API text format.
2063
+ * (Optional) Text format configuration specifying output format requirements
901
2064
  */
902
2065
  interface Format {
903
2066
  /**
@@ -926,50 +2089,140 @@ export declare namespace ResponseCreateParams {
926
2089
  strict?: boolean;
927
2090
  }
928
2091
  }
2092
+ /**
2093
+ * Web search tool configuration for OpenAI response inputs.
2094
+ */
929
2095
  interface OpenAIResponseInputToolWebSearch {
2096
+ /**
2097
+ * Web search tool type variant to use
2098
+ */
930
2099
  type: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11';
2100
+ /**
2101
+ * (Optional) Size of search context, must be "low", "medium", or "high"
2102
+ */
931
2103
  search_context_size?: string;
932
2104
  }
2105
+ /**
2106
+ * File search tool configuration for OpenAI response inputs.
2107
+ */
933
2108
  interface OpenAIResponseInputToolFileSearch {
2109
+ /**
2110
+ * Tool type identifier, always "file_search"
2111
+ */
934
2112
  type: 'file_search';
2113
+ /**
2114
+ * List of vector store identifiers to search within
2115
+ */
935
2116
  vector_store_ids: Array<string>;
2117
+ /**
2118
+ * (Optional) Additional filters to apply to the search
2119
+ */
936
2120
  filters?: {
937
2121
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
938
2122
  };
2123
+ /**
2124
+ * (Optional) Maximum number of search results to return (1-50)
2125
+ */
939
2126
  max_num_results?: number;
2127
+ /**
2128
+ * (Optional) Options for ranking and scoring search results
2129
+ */
940
2130
  ranking_options?: OpenAIResponseInputToolFileSearch.RankingOptions;
941
2131
  }
942
2132
  namespace OpenAIResponseInputToolFileSearch {
2133
+ /**
2134
+ * (Optional) Options for ranking and scoring search results
2135
+ */
943
2136
  interface RankingOptions {
2137
+ /**
2138
+ * (Optional) Name of the ranking algorithm to use
2139
+ */
944
2140
  ranker?: string;
2141
+ /**
2142
+ * (Optional) Minimum relevance score threshold for results
2143
+ */
945
2144
  score_threshold?: number;
946
2145
  }
947
2146
  }
2147
+ /**
2148
+ * Function tool configuration for OpenAI response inputs.
2149
+ */
948
2150
  interface OpenAIResponseInputToolFunction {
2151
+ /**
2152
+ * Name of the function that can be called
2153
+ */
949
2154
  name: string;
2155
+ /**
2156
+ * Tool type identifier, always "function"
2157
+ */
950
2158
  type: 'function';
2159
+ /**
2160
+ * (Optional) Description of what the function does
2161
+ */
951
2162
  description?: string;
2163
+ /**
2164
+ * (Optional) JSON schema defining the function's parameters
2165
+ */
952
2166
  parameters?: {
953
2167
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
954
2168
  };
2169
+ /**
2170
+ * (Optional) Whether to enforce strict parameter validation
2171
+ */
955
2172
  strict?: boolean;
956
2173
  }
2174
+ /**
2175
+ * Model Context Protocol (MCP) tool configuration for OpenAI response inputs.
2176
+ */
957
2177
  interface OpenAIResponseInputToolMcp {
2178
+ /**
2179
+ * Approval requirement for tool calls ("always", "never", or filter)
2180
+ */
958
2181
  require_approval: 'always' | 'never' | OpenAIResponseInputToolMcp.ApprovalFilter;
2182
+ /**
2183
+ * Label to identify this MCP server
2184
+ */
959
2185
  server_label: string;
2186
+ /**
2187
+ * URL endpoint of the MCP server
2188
+ */
960
2189
  server_url: string;
2190
+ /**
2191
+ * Tool type identifier, always "mcp"
2192
+ */
961
2193
  type: 'mcp';
2194
+ /**
2195
+ * (Optional) Restriction on which tools can be used from this server
2196
+ */
962
2197
  allowed_tools?: Array<string> | OpenAIResponseInputToolMcp.AllowedToolsFilter;
2198
+ /**
2199
+ * (Optional) HTTP headers to include when connecting to the server
2200
+ */
963
2201
  headers?: {
964
2202
  [key: string]: boolean | number | string | Array<unknown> | unknown | null;
965
2203
  };
966
2204
  }
967
2205
  namespace OpenAIResponseInputToolMcp {
2206
+ /**
2207
+ * Filter configuration for MCP tool approval requirements.
2208
+ */
968
2209
  interface ApprovalFilter {
2210
+ /**
2211
+ * (Optional) List of tool names that always require approval
2212
+ */
969
2213
  always?: Array<string>;
2214
+ /**
2215
+ * (Optional) List of tool names that never require approval
2216
+ */
970
2217
  never?: Array<string>;
971
2218
  }
2219
+ /**
2220
+ * Filter configuration for restricting which MCP tools can be used.
2221
+ */
972
2222
  interface AllowedToolsFilter {
2223
+ /**
2224
+ * (Optional) List of specific tool names that are allowed
2225
+ */
973
2226
  tool_names?: Array<string>;
974
2227
  }
975
2228
  }