@stagewhisper/stagewhisper 0.51.0 → 0.52.0

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.
@@ -1,1361 +0,0 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
-
6
- export interface paths {
7
- "/responses": {
8
- parameters: {
9
- query?: never;
10
- header?: never;
11
- path?: never;
12
- cookie?: never;
13
- };
14
- get?: never;
15
- put?: never;
16
- /**
17
- * Create response
18
- * @description Creates a response.
19
- */
20
- post: operations["createResponse"];
21
- delete?: never;
22
- options?: never;
23
- head?: never;
24
- patch?: never;
25
- trace?: never;
26
- };
27
- }
28
- export type webhooks = Record<string, never>;
29
- export interface components {
30
- schemas: {
31
- /**
32
- * Item reference
33
- * @description An internal identifier for an item to reference.
34
- */
35
- ItemReferenceParam: {
36
- /**
37
- * @description discriminator enum property added by openapi-typescript
38
- * @enum {string}
39
- */
40
- type: "item_reference";
41
- /** @description The ID of the item to reference. */
42
- id: string;
43
- };
44
- ReasoningSummaryContentParam: {
45
- /**
46
- * @description The content type. Always `summary_text`.
47
- * @default summary_text
48
- * @enum {string}
49
- */
50
- type: "summary_text";
51
- /** @description The reasoning summary text. */
52
- text: string;
53
- };
54
- ReasoningItemParam: {
55
- id?: string | null;
56
- /**
57
- * @description The item type. Always `reasoning`. (enum property replaced by openapi-typescript)
58
- * @enum {string}
59
- */
60
- type: "reasoning";
61
- /** @description Reasoning summary content associated with this item. */
62
- summary: components["schemas"]["ReasoningSummaryContentParam"][];
63
- content?: null;
64
- encrypted_content?: string | null;
65
- };
66
- /**
67
- * Input text
68
- * @description A text input to the model.
69
- */
70
- InputTextContentParam: {
71
- /**
72
- * @description The type of the input item. Always `input_text`. (enum property replaced by openapi-typescript)
73
- * @enum {string}
74
- */
75
- type: "input_text";
76
- /** @description The text input to the model. */
77
- text: string;
78
- };
79
- /** @enum {string} */
80
- DetailEnum: "low" | "high" | "auto";
81
- /**
82
- * Input image
83
- * @description An image input to the model. Learn about [image inputs](/docs/guides/vision)
84
- */
85
- InputImageContentParamAutoParam: {
86
- /**
87
- * @description The type of the input item. Always `input_image`. (enum property replaced by openapi-typescript)
88
- * @enum {string}
89
- */
90
- type: "input_image";
91
- image_url?: string | null;
92
- detail?: (components["schemas"]["ImageDetail"] & unknown) | null;
93
- };
94
- /**
95
- * Input file
96
- * @description A file input to the model.
97
- */
98
- InputFileContentParam: {
99
- /**
100
- * @description The type of the input item. Always `input_file`. (enum property replaced by openapi-typescript)
101
- * @enum {string}
102
- */
103
- type: "input_file";
104
- filename?: string | null;
105
- file_data?: string | null;
106
- file_url?: string | null;
107
- };
108
- UserMessageItemParam: {
109
- id?: string | null;
110
- /**
111
- * @description The item type. Always `message`. (enum property replaced by openapi-typescript)
112
- * @enum {string}
113
- */
114
- type: "message";
115
- /**
116
- * @description The message role. Always `user`.
117
- * @default user
118
- * @enum {string}
119
- */
120
- role: "user";
121
- /** @description The message content, as an array of content parts. */
122
- content: (components["schemas"]["InputTextContentParam"] | components["schemas"]["InputImageContentParamAutoParam"] | components["schemas"]["InputFileContentParam"])[] | string;
123
- status?: string | null;
124
- };
125
- SystemMessageItemParam: {
126
- id?: string | null;
127
- /**
128
- * @description The item type. Always `message`. (enum property replaced by openapi-typescript)
129
- * @enum {string}
130
- */
131
- type: "message";
132
- /**
133
- * @description The message role. Always `system`.
134
- * @default system
135
- * @enum {string}
136
- */
137
- role: "system";
138
- /** @description The message content, as an array of content parts. */
139
- content: components["schemas"]["InputTextContentParam"][] | string;
140
- status?: string | null;
141
- };
142
- DeveloperMessageItemParam: {
143
- id?: string | null;
144
- /**
145
- * @description The item type. Always `message`. (enum property replaced by openapi-typescript)
146
- * @enum {string}
147
- */
148
- type: "message";
149
- /**
150
- * @description The message role. Always `developer`.
151
- * @default developer
152
- * @enum {string}
153
- */
154
- role: "developer";
155
- /** @description The message content, as an array of content parts. */
156
- content: components["schemas"]["InputTextContentParam"][] | string;
157
- status?: string | null;
158
- };
159
- UrlCitationParam: {
160
- /**
161
- * @description The citation type. Always `url_citation`.
162
- * @default url_citation
163
- * @enum {string}
164
- */
165
- type: "url_citation";
166
- /** @description The index of the first character of the citation in the message. */
167
- start_index: number;
168
- /** @description The index of the last character of the citation in the message. */
169
- end_index: number;
170
- /** @description The URL of the cited resource. */
171
- url: string;
172
- /** @description The title of the cited resource. */
173
- title: string;
174
- };
175
- OutputTextContentParam: {
176
- /**
177
- * @description The content type. Always `output_text`. (enum property replaced by openapi-typescript)
178
- * @enum {string}
179
- */
180
- type: "output_text";
181
- /** @description The text content. */
182
- text: string;
183
- /** @description Citations associated with the text content. */
184
- annotations?: components["schemas"]["UrlCitationParam"][];
185
- };
186
- RefusalContentParam: {
187
- /**
188
- * @description The content type. Always `refusal`. (enum property replaced by openapi-typescript)
189
- * @enum {string}
190
- */
191
- type: "refusal";
192
- /** @description The refusal text. */
193
- refusal: string;
194
- };
195
- AssistantMessageItemParam: {
196
- id?: string | null;
197
- /**
198
- * @description The item type. Always `message`. (enum property replaced by openapi-typescript)
199
- * @enum {string}
200
- */
201
- type: "message";
202
- /**
203
- * @description The role of the message author. Always `assistant`.
204
- * @default assistant
205
- * @enum {string}
206
- */
207
- role: "assistant";
208
- /** @description The message content, as an array of content parts. */
209
- content: (components["schemas"]["OutputTextContentParam"] | components["schemas"]["RefusalContentParam"])[] | string;
210
- status?: string | null;
211
- };
212
- /** @enum {string} */
213
- FunctionCallItemStatus: "in_progress" | "completed" | "incomplete";
214
- FunctionCallItemParam: {
215
- id?: string | null;
216
- /** @description The unique ID of the function tool call generated by the model. */
217
- call_id: string;
218
- /**
219
- * @description The item type. Always `function_call`. (enum property replaced by openapi-typescript)
220
- * @enum {string}
221
- */
222
- type: "function_call";
223
- /** @description The name of the function to call. */
224
- name: string;
225
- /** @description The function arguments as a JSON string. */
226
- arguments: string;
227
- status?: (components["schemas"]["FunctionCallStatus"] & unknown) | null;
228
- };
229
- /**
230
- * Function tool call output
231
- * @description The output of a function tool call.
232
- */
233
- FunctionCallOutputItemParam: {
234
- id?: string | null;
235
- /** @description The unique ID of the function tool call generated by the model. */
236
- call_id: string;
237
- /**
238
- * @description The type of the function tool call output. Always `function_call_output`. (enum property replaced by openapi-typescript)
239
- * @enum {string}
240
- */
241
- type: "function_call_output";
242
- /** @description Text, image, or file output of the function tool call. */
243
- output: string | (components["schemas"]["InputTextContentParam"] | components["schemas"]["InputImageContentParamAutoParam"] | components["schemas"]["InputFileContentParam"] | components["schemas"]["InputVideoContent"])[];
244
- status?: (components["schemas"]["FunctionCallStatus"] & unknown) | null;
245
- };
246
- ItemParam: components["schemas"]["ItemReferenceParam"] | components["schemas"]["ReasoningItemParam"] | components["schemas"]["UserMessageItemParam"] | components["schemas"]["SystemMessageItemParam"] | components["schemas"]["DeveloperMessageItemParam"] | components["schemas"]["AssistantMessageItemParam"] | components["schemas"]["FunctionCallItemParam"] | components["schemas"]["FunctionCallOutputItemParam"];
247
- /** @enum {string} */
248
- IncludeEnum: "reasoning.encrypted_content" | "message.output_text.logprobs";
249
- EmptyModelParam: Record<string, never>;
250
- FunctionToolParam: {
251
- name: string;
252
- description?: string | null;
253
- parameters?: components["schemas"]["EmptyModelParam"] | null;
254
- strict?: boolean;
255
- /**
256
- * @description discriminator enum property added by openapi-typescript
257
- * @enum {string}
258
- */
259
- type: "function";
260
- };
261
- ResponsesToolParam: components["schemas"]["FunctionToolParam"];
262
- SpecificFunctionParam: {
263
- /**
264
- * @description The tool to call. Always `function`.
265
- * @default function
266
- * @enum {string}
267
- */
268
- type: "function";
269
- /** @description The name of the function tool to call. */
270
- name: string;
271
- };
272
- SpecificToolChoiceParam: components["schemas"]["SpecificFunctionParam"];
273
- /** @enum {string} */
274
- ToolChoiceValueEnum: "none" | "auto" | "required";
275
- AllowedToolsParam: {
276
- /**
277
- * @description The tool choice type. Always `allowed_tools`.
278
- * @default allowed_tools
279
- * @enum {string}
280
- */
281
- type: "allowed_tools";
282
- /** @description The list of tools that are permitted for this request. */
283
- tools: components["schemas"]["SpecificToolChoiceParam"][];
284
- mode?: components["schemas"]["ToolChoiceValueEnum"] & unknown;
285
- };
286
- /** @description Controls which tool the model should use, if any. */
287
- ToolChoiceParam: components["schemas"]["SpecificToolChoiceParam"] | components["schemas"]["ToolChoiceValueEnum"] | components["schemas"]["AllowedToolsParam"];
288
- /**
289
- * @description Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
290
- * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
291
- */
292
- MetadataParam: {
293
- [key: string]: string;
294
- };
295
- /** @enum {string} */
296
- VerbosityEnum: "low" | "medium" | "high";
297
- TextParam: {
298
- /** @description The format configuration for text output. */
299
- format?: components["schemas"]["TextFormatParam"] | null;
300
- verbosity?: components["schemas"]["VerbosityEnum"] & unknown;
301
- };
302
- /** @description Options that control streamed response behavior. */
303
- StreamOptionsParam: {
304
- /** @description Whether to obfuscate sensitive information in streamed output. Defaults to `true`. */
305
- include_obfuscation?: boolean;
306
- };
307
- /** @enum {string} */
308
- ReasoningEffortEnum: "none" | "low" | "medium" | "high" | "xhigh";
309
- /** @enum {string} */
310
- ReasoningSummaryEnum: "concise" | "detailed" | "auto";
311
- /** @description **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). */
312
- ReasoningParam: {
313
- effort?: components["schemas"]["ReasoningEffortEnum"] | null;
314
- summary?: (components["schemas"]["ReasoningSummaryEnum"] & unknown) | null;
315
- };
316
- /** @enum {string} */
317
- TruncationEnum: "auto" | "disabled";
318
- /** @enum {string} */
319
- ServiceTierEnum: "auto" | "default" | "flex" | "priority";
320
- CreateResponseBody: {
321
- model?: string | null;
322
- input?: (string | components["schemas"]["ItemParam"][]) | null;
323
- previous_response_id?: string | null;
324
- include?: components["schemas"]["IncludeEnum"][];
325
- tools?: components["schemas"]["ResponsesToolParam"][] | null;
326
- tool_choice?: (components["schemas"]["ToolChoiceParam"] & unknown) | null;
327
- metadata?: (components["schemas"]["MetadataParam"] & unknown) | null;
328
- text?: (components["schemas"]["TextParam"] & unknown) | null;
329
- temperature?: number | null;
330
- top_p?: number | null;
331
- presence_penalty?: number | null;
332
- frequency_penalty?: number | null;
333
- parallel_tool_calls?: boolean | null;
334
- /** @description Whether to stream response events as server-sent events. */
335
- stream?: boolean;
336
- stream_options?: (components["schemas"]["StreamOptionsParam"] & unknown) | null;
337
- /** @description Whether to run the request in the background and return immediately. */
338
- background?: boolean;
339
- max_output_tokens?: number | null;
340
- max_tool_calls?: number | null;
341
- reasoning?: (components["schemas"]["ReasoningParam"] & unknown) | null;
342
- safety_identifier?: string | null;
343
- prompt_cache_key?: string | null;
344
- truncation?: components["schemas"]["TruncationEnum"] & unknown;
345
- instructions?: string | null;
346
- /** @description Whether to store the response so it can be retrieved later. */
347
- store?: boolean;
348
- service_tier?: components["schemas"]["ServiceTierEnum"] & unknown;
349
- top_logprobs?: number | null;
350
- };
351
- /**
352
- * Incomplete details
353
- * @description Details about why the response was incomplete.
354
- */
355
- IncompleteDetails: {
356
- /** @description The reason the response could not be completed. */
357
- reason: string;
358
- };
359
- /** @enum {string} */
360
- MessageRole: "user" | "assistant" | "system" | "developer";
361
- /**
362
- * Input text
363
- * @description A text input to the model.
364
- */
365
- InputTextContent: {
366
- /**
367
- * @description The type of the input item. Always `input_text`. (enum property replaced by openapi-typescript)
368
- * @enum {string}
369
- */
370
- type: "input_text";
371
- /** @description The text input to the model. */
372
- text: string;
373
- };
374
- /**
375
- * URL citation
376
- * @description A citation for a web resource used to generate a model response.
377
- */
378
- UrlCitationBody: {
379
- /**
380
- * @description The type of the URL citation. Always `url_citation`. (enum property replaced by openapi-typescript)
381
- * @enum {string}
382
- */
383
- type: "url_citation";
384
- /** @description The URL of the web resource. */
385
- url: string;
386
- /** @description The index of the first character of the URL citation in the message. */
387
- start_index: number;
388
- /** @description The index of the last character of the URL citation in the message. */
389
- end_index: number;
390
- /** @description The title of the web resource. */
391
- title: string;
392
- };
393
- /** @description An annotation that applies to a span of output text. */
394
- Annotation: components["schemas"]["UrlCitationBody"];
395
- /**
396
- * Top log probability
397
- * @description The top log probability of a token.
398
- */
399
- TopLogProb: {
400
- token: string;
401
- logprob: number;
402
- bytes: number[];
403
- };
404
- /**
405
- * Log probability
406
- * @description The log probability of a token.
407
- */
408
- LogProb: {
409
- token: string;
410
- logprob: number;
411
- bytes: number[];
412
- top_logprobs: components["schemas"]["TopLogProb"][];
413
- };
414
- /**
415
- * Output text
416
- * @description A text output from the model.
417
- */
418
- OutputTextContent: {
419
- /**
420
- * @description The type of the output text. Always `output_text`. (enum property replaced by openapi-typescript)
421
- * @enum {string}
422
- */
423
- type: "output_text";
424
- /** @description The text output from the model. */
425
- text: string;
426
- /** @description The annotations of the text output. */
427
- annotations: components["schemas"]["Annotation"][];
428
- logprobs?: components["schemas"]["LogProb"][];
429
- };
430
- /**
431
- * Text Content
432
- * @description A text content.
433
- */
434
- TextContent: {
435
- /**
436
- * @description discriminator enum property added by openapi-typescript
437
- * @enum {string}
438
- */
439
- type: "text";
440
- text: string;
441
- };
442
- /**
443
- * Summary text
444
- * @description A summary text from the model.
445
- */
446
- SummaryTextContent: {
447
- /**
448
- * @description The type of the object. Always `summary_text`. (enum property replaced by openapi-typescript)
449
- * @enum {string}
450
- */
451
- type: "summary_text";
452
- /** @description A summary of the reasoning output from the model so far. */
453
- text: string;
454
- };
455
- /**
456
- * Reasoning text
457
- * @description Reasoning text from the model.
458
- */
459
- ReasoningTextContent: {
460
- /**
461
- * @description The type of the reasoning text. Always `reasoning_text`. (enum property replaced by openapi-typescript)
462
- * @enum {string}
463
- */
464
- type: "reasoning_text";
465
- /** @description The reasoning text from the model. */
466
- text: string;
467
- };
468
- /**
469
- * Refusal
470
- * @description A refusal from the model.
471
- */
472
- RefusalContent: {
473
- /**
474
- * @description The type of the refusal. Always `refusal`. (enum property replaced by openapi-typescript)
475
- * @enum {string}
476
- */
477
- type: "refusal";
478
- /** @description The refusal explanation from the model. */
479
- refusal: string;
480
- };
481
- /** @enum {string} */
482
- ImageDetail: "low" | "high" | "auto";
483
- /**
484
- * Input image
485
- * @description An image input to the model. Learn about [image inputs](/docs/guides/vision).
486
- */
487
- InputImageContent: {
488
- /**
489
- * @description The type of the input item. Always `input_image`. (enum property replaced by openapi-typescript)
490
- * @enum {string}
491
- */
492
- type: "input_image";
493
- image_url: string | null;
494
- detail: components["schemas"]["ImageDetail"] & unknown;
495
- };
496
- /**
497
- * Input file
498
- * @description A file input to the model.
499
- */
500
- InputFileContent: {
501
- /**
502
- * @description The type of the input item. Always `input_file`. (enum property replaced by openapi-typescript)
503
- * @enum {string}
504
- */
505
- type: "input_file";
506
- /** @description The name of the file to be sent to the model. */
507
- filename?: string;
508
- /** @description The URL of the file to be sent to the model. */
509
- file_url?: string;
510
- };
511
- /** @enum {string} */
512
- MessageStatus: "in_progress" | "completed" | "incomplete";
513
- /**
514
- * Message
515
- * @description A message to or from the model.
516
- */
517
- Message: {
518
- /**
519
- * @description The type of the message. Always set to `message`. (enum property replaced by openapi-typescript)
520
- * @enum {string}
521
- */
522
- type: "message";
523
- /** @description The unique ID of the message. */
524
- id: string;
525
- status: components["schemas"]["MessageStatus"] & unknown;
526
- role: components["schemas"]["MessageRole"] & unknown;
527
- /** @description The content of the message */
528
- content: (components["schemas"]["InputTextContent"] | components["schemas"]["OutputTextContent"] | components["schemas"]["TextContent"] | components["schemas"]["SummaryTextContent"] | components["schemas"]["ReasoningTextContent"] | components["schemas"]["RefusalContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"] | components["schemas"]["InputVideoContent"])[];
529
- };
530
- /** @enum {string} */
531
- FunctionCallStatus: "in_progress" | "completed" | "incomplete";
532
- /**
533
- * Function call
534
- * @description A function tool call that was generated by the model.
535
- */
536
- FunctionCall: {
537
- /**
538
- * @description The type of the item. Always `function_call`. (enum property replaced by openapi-typescript)
539
- * @enum {string}
540
- */
541
- type: "function_call";
542
- /** @description The unique ID of the function call item. */
543
- id: string;
544
- /** @description The unique ID of the function tool call that was generated. */
545
- call_id: string;
546
- /** @description The name of the function that was called. */
547
- name: string;
548
- /** @description The arguments JSON string that was generated. */
549
- arguments: string;
550
- status: components["schemas"]["FunctionCallStatus"] & unknown;
551
- };
552
- /**
553
- * @description Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.
554
- * @enum {string}
555
- */
556
- FunctionCallOutputStatusEnum: "in_progress" | "completed" | "incomplete";
557
- /**
558
- * Function call output
559
- * @description A function tool call output that was returned by the tool.
560
- */
561
- FunctionCallOutput: {
562
- /**
563
- * @description The type of the function tool call output. Always `function_call_output`. (enum property replaced by openapi-typescript)
564
- * @enum {string}
565
- */
566
- type: "function_call_output";
567
- /** @description The unique ID of the function tool call output. Populated when this item is returned via API. */
568
- id: string;
569
- /** @description The unique ID of the function tool call generated by the model. */
570
- call_id: string;
571
- output: string | (components["schemas"]["InputTextContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"])[];
572
- status: components["schemas"]["FunctionCallOutputStatusEnum"] & unknown;
573
- };
574
- /**
575
- * Reasoning item
576
- * @description A reasoning item that was generated by the model.
577
- */
578
- ReasoningBody: {
579
- /**
580
- * @description The type of the item. Always `reasoning`. (enum property replaced by openapi-typescript)
581
- * @enum {string}
582
- */
583
- type: "reasoning";
584
- /** @description The unique ID of the reasoning item. */
585
- id: string;
586
- /** @description The reasoning content that was generated. */
587
- content?: (components["schemas"]["InputTextContent"] | components["schemas"]["OutputTextContent"] | components["schemas"]["TextContent"] | components["schemas"]["SummaryTextContent"] | components["schemas"]["ReasoningTextContent"] | components["schemas"]["RefusalContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"])[];
588
- /** @description The reasoning summary content that was generated. */
589
- summary: (components["schemas"]["InputTextContent"] | components["schemas"]["OutputTextContent"] | components["schemas"]["TextContent"] | components["schemas"]["SummaryTextContent"] | components["schemas"]["ReasoningTextContent"] | components["schemas"]["RefusalContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"])[];
590
- /** @description The encrypted reasoning content that was generated. */
591
- encrypted_content?: string;
592
- };
593
- /** @description An item representing a message, tool call, tool output, reasoning, or other response element. */
594
- ItemField: components["schemas"]["Message"] | components["schemas"]["FunctionCall"] | components["schemas"]["FunctionCallOutput"] | components["schemas"]["ReasoningBody"];
595
- /**
596
- * Error
597
- * @description An error that occurred while generating the response.
598
- */
599
- Error: {
600
- /** @description A machine-readable error code that was returned. */
601
- code: string;
602
- /** @description A human-readable description of the error that was returned. */
603
- message: string;
604
- };
605
- /**
606
- * Function
607
- * @description Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).
608
- */
609
- FunctionTool: {
610
- /**
611
- * @description The type of the function tool. Always `function`. (enum property replaced by openapi-typescript)
612
- * @enum {string}
613
- */
614
- type: "function";
615
- /** @description The name of the function to call. */
616
- name: string;
617
- description: string | null;
618
- parameters: {
619
- [key: string]: unknown;
620
- } | null;
621
- strict: boolean | null;
622
- };
623
- /** @description A tool that can be used to generate a response. */
624
- Tool: components["schemas"]["FunctionTool"];
625
- FunctionToolChoice: {
626
- /**
627
- * @default function
628
- * @enum {string}
629
- */
630
- type: "function";
631
- name?: string;
632
- };
633
- AllowedToolChoice: {
634
- /**
635
- * @default allowed_tools
636
- * @enum {string}
637
- */
638
- type: "allowed_tools";
639
- tools: components["schemas"]["FunctionToolChoice"][];
640
- mode: components["schemas"]["ToolChoiceValueEnum"];
641
- };
642
- TextResponseFormat: {
643
- /**
644
- * @default text
645
- * @enum {string}
646
- */
647
- type: "text";
648
- };
649
- JsonObjectResponseFormat: {
650
- /**
651
- * @default json_object
652
- * @enum {string}
653
- */
654
- type: "json_object";
655
- };
656
- JsonSchemaResponseFormat: {
657
- /**
658
- * @default json_schema
659
- * @enum {string}
660
- */
661
- type: "json_schema";
662
- name: string;
663
- description: string | null;
664
- schema: null;
665
- strict: boolean;
666
- };
667
- TextField: {
668
- format: components["schemas"]["TextResponseFormat"] | components["schemas"]["JsonObjectResponseFormat"] | components["schemas"]["JsonSchemaResponseFormat"];
669
- verbosity?: components["schemas"]["VerbosityEnum"];
670
- };
671
- /**
672
- * Reasoning
673
- * @description Reasoning configuration and metadata that were used for the response.
674
- */
675
- Reasoning: {
676
- effort: components["schemas"]["ReasoningEffortEnum"] | null;
677
- summary: (components["schemas"]["ReasoningSummaryEnum"] & unknown) | null;
678
- };
679
- /**
680
- * Input tokens details
681
- * @description A breakdown of input token usage that was recorded.
682
- */
683
- InputTokensDetails: {
684
- /** @description The number of input tokens that were served from cache. */
685
- cached_tokens: number;
686
- };
687
- /**
688
- * Output tokens details
689
- * @description A breakdown of output token usage that was recorded.
690
- */
691
- OutputTokensDetails: {
692
- /** @description The number of output tokens that were attributed to reasoning. */
693
- reasoning_tokens: number;
694
- };
695
- /**
696
- * Usage
697
- * @description Token usage statistics that were recorded for the response.
698
- */
699
- Usage: {
700
- /** @description The number of input tokens that were used to generate the response. */
701
- input_tokens: number;
702
- /** @description The number of output tokens that were generated by the model. */
703
- output_tokens: number;
704
- /** @description The total number of tokens that were used. */
705
- total_tokens: number;
706
- input_tokens_details: components["schemas"]["InputTokensDetails"] & unknown;
707
- output_tokens_details: components["schemas"]["OutputTokensDetails"] & unknown;
708
- };
709
- /**
710
- * The response object
711
- * @description The complete response object that was returned by the Responses API.
712
- * @example {
713
- * "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",
714
- * "object": "response",
715
- * "created_at": 1741476777,
716
- * "status": "completed",
717
- * "completed_at": 1741476778,
718
- * "model": "gpt-4o-2024-08-06",
719
- * "output": [
720
- * {
721
- * "type": "message",
722
- * "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",
723
- * "status": "completed",
724
- * "role": "assistant",
725
- * "content": [
726
- * {
727
- * "type": "output_text",
728
- * "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",
729
- * "annotations": []
730
- * }
731
- * ]
732
- * }
733
- * ],
734
- * "parallel_tool_calls": true,
735
- * "reasoning": {},
736
- * "store": true,
737
- * "background": false,
738
- * "temperature": 1,
739
- * "presence_penalty": 0,
740
- * "frequency_penalty": 0,
741
- * "text": {
742
- * "format": {
743
- * "type": "text"
744
- * }
745
- * },
746
- * "tool_choice": "auto",
747
- * "tools": [],
748
- * "top_p": 1,
749
- * "truncation": "disabled",
750
- * "usage": {
751
- * "input_tokens": 328,
752
- * "input_tokens_details": {
753
- * "cached_tokens": 0
754
- * },
755
- * "output_tokens": 52,
756
- * "output_tokens_details": {
757
- * "reasoning_tokens": 0
758
- * },
759
- * "total_tokens": 380
760
- * },
761
- * "metadata": {},
762
- * "service_tier": "default",
763
- * "top_logprobs": 0
764
- * }
765
- */
766
- ResponseResource: {
767
- /** @description The unique ID of the response that was created. */
768
- id: string;
769
- /**
770
- * @description The object type, which was always `response`.
771
- * @default response
772
- * @enum {string}
773
- */
774
- object: "response";
775
- /** @description The Unix timestamp (in seconds) for when the response was created. */
776
- created_at: number;
777
- completed_at: number | null;
778
- /** @description The status that was set for the response. */
779
- status: string;
780
- incomplete_details: (components["schemas"]["IncompleteDetails"] & unknown) | null;
781
- /** @description The model that generated this response. */
782
- model: string;
783
- previous_response_id: string | null;
784
- instructions: string | null;
785
- /** @description The output items that were generated by the model. */
786
- output: components["schemas"]["ItemField"][];
787
- error: (components["schemas"]["Error"] & unknown) | null;
788
- /** @description The tools that were available to the model during response generation. */
789
- tools: components["schemas"]["Tool"][];
790
- tool_choice: components["schemas"]["FunctionToolChoice"] | components["schemas"]["ToolChoiceValueEnum"] | components["schemas"]["AllowedToolChoice"];
791
- truncation: components["schemas"]["TruncationEnum"] & unknown;
792
- /** @description Whether the model was allowed to call multiple tools in parallel. */
793
- parallel_tool_calls: boolean;
794
- text: components["schemas"]["TextField"] & unknown;
795
- /** @description The nucleus sampling parameter that was used for this response. */
796
- top_p: number;
797
- /** @description The presence penalty that was used to penalize new tokens based on whether they appear in the text so far. */
798
- presence_penalty: number;
799
- /** @description The frequency penalty that was used to penalize new tokens based on their frequency in the text so far. */
800
- frequency_penalty: number;
801
- /** @description The number of most likely tokens that were returned at each position, along with their log probabilities. */
802
- top_logprobs: number;
803
- /** @description The sampling temperature that was used for this response. */
804
- temperature: number;
805
- reasoning: (components["schemas"]["Reasoning"] & unknown) | null;
806
- usage: (components["schemas"]["Usage"] & unknown) | null;
807
- max_output_tokens: number | null;
808
- max_tool_calls: number | null;
809
- /** @description Whether this response was stored so it can be retrieved later. */
810
- store: boolean;
811
- /** @description Whether this request was run in the background. */
812
- background: boolean;
813
- /** @description The service tier that was used for this response. */
814
- service_tier: string;
815
- /** @description Developer-defined metadata that was associated with the response. */
816
- metadata: unknown;
817
- safety_identifier: string | null;
818
- prompt_cache_key: string | null;
819
- };
820
- /**
821
- * Response created event
822
- * @description A streaming event that indicated the response was created.
823
- */
824
- ResponseCreatedStreamingEvent: {
825
- /**
826
- * @description The type of the event, always `response.created`. (enum property replaced by openapi-typescript)
827
- * @enum {string}
828
- */
829
- type: "response.created";
830
- /** @description The sequence number of the event that was emitted. */
831
- sequence_number: number;
832
- response: components["schemas"]["ResponseResource"] & unknown;
833
- };
834
- /**
835
- * Response queued event
836
- * @description A streaming event that indicated the response was queued.
837
- */
838
- ResponseQueuedStreamingEvent: {
839
- /**
840
- * @description The type of the event, always `response.queued`. (enum property replaced by openapi-typescript)
841
- * @enum {string}
842
- */
843
- type: "response.queued";
844
- /** @description The sequence number of the event that was emitted. */
845
- sequence_number: number;
846
- response: components["schemas"]["ResponseResource"] & unknown;
847
- };
848
- /**
849
- * Response in progress event
850
- * @description A streaming event that indicated the response was in progress.
851
- */
852
- ResponseInProgressStreamingEvent: {
853
- /**
854
- * @description The type of the event, always `response.in_progress`. (enum property replaced by openapi-typescript)
855
- * @enum {string}
856
- */
857
- type: "response.in_progress";
858
- /** @description The sequence number of the event that was emitted. */
859
- sequence_number: number;
860
- response: components["schemas"]["ResponseResource"] & unknown;
861
- };
862
- /**
863
- * Response completed event
864
- * @description A streaming event that indicated the response was completed.
865
- */
866
- ResponseCompletedStreamingEvent: {
867
- /**
868
- * @description The type of the event, always `response.completed`. (enum property replaced by openapi-typescript)
869
- * @enum {string}
870
- */
871
- type: "response.completed";
872
- /** @description The sequence number of the event that was emitted. */
873
- sequence_number: number;
874
- response: components["schemas"]["ResponseResource"] & unknown;
875
- };
876
- /**
877
- * Response failed event
878
- * @description A streaming event that indicated the response had failed.
879
- */
880
- ResponseFailedStreamingEvent: {
881
- /**
882
- * @description The type of the event, always `response.failed`. (enum property replaced by openapi-typescript)
883
- * @enum {string}
884
- */
885
- type: "response.failed";
886
- /** @description The sequence number of the event that was emitted. */
887
- sequence_number: number;
888
- response: components["schemas"]["ResponseResource"] & unknown;
889
- };
890
- /**
891
- * Response incomplete event
892
- * @description A streaming event that indicated the response was incomplete.
893
- */
894
- ResponseIncompleteStreamingEvent: {
895
- /**
896
- * @description The type of the event, always `response.incomplete`. (enum property replaced by openapi-typescript)
897
- * @enum {string}
898
- */
899
- type: "response.incomplete";
900
- /** @description The sequence number of the event that was emitted. */
901
- sequence_number: number;
902
- response: components["schemas"]["ResponseResource"] & unknown;
903
- };
904
- /**
905
- * Response output item added event
906
- * @description A streaming event that indicated an output item was added to the response.
907
- */
908
- ResponseOutputItemAddedStreamingEvent: {
909
- /**
910
- * @description The type of the event, always `response.output_item.added`. (enum property replaced by openapi-typescript)
911
- * @enum {string}
912
- */
913
- type: "response.output_item.added";
914
- /** @description The sequence number of the event that was emitted. */
915
- sequence_number: number;
916
- /** @description The index of the output item that was added. */
917
- output_index: number;
918
- item: (Omit<components["schemas"]["ItemField"], "type"> & unknown) | null;
919
- };
920
- /**
921
- * Response output item done event
922
- * @description A streaming event that indicated an output item was completed.
923
- */
924
- ResponseOutputItemDoneStreamingEvent: {
925
- /**
926
- * @description The type of the event, always `response.output_item.done`. (enum property replaced by openapi-typescript)
927
- * @enum {string}
928
- */
929
- type: "response.output_item.done";
930
- /** @description The sequence number of the event that was emitted. */
931
- sequence_number: number;
932
- /** @description The index of the output item that was completed. */
933
- output_index: number;
934
- item: (Omit<components["schemas"]["ItemField"], "type"> & unknown) | null;
935
- };
936
- /**
937
- * Response reasoning summary part added event
938
- * @description A streaming event that indicated a reasoning summary part was added.
939
- */
940
- ResponseReasoningSummaryPartAddedStreamingEvent: {
941
- /**
942
- * @description The type of the event, always `response.reasoning_summary_part.added`. (enum property replaced by openapi-typescript)
943
- * @enum {string}
944
- */
945
- type: "response.reasoning_summary_part.added";
946
- /** @description The sequence number of the event that was emitted. */
947
- sequence_number: number;
948
- /** @description The ID of the item that was updated. */
949
- item_id: string;
950
- /** @description The index of the output item that was updated. */
951
- output_index: number;
952
- /** @description The index of the summary part that was added. */
953
- summary_index: number;
954
- /** @description A content part that makes up an input or output item. */
955
- part: components["schemas"]["InputTextContent"] | components["schemas"]["OutputTextContent"] | components["schemas"]["TextContent"] | components["schemas"]["SummaryTextContent"] | components["schemas"]["ReasoningTextContent"] | components["schemas"]["RefusalContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"];
956
- };
957
- /**
958
- * Response reasoning summary part done event
959
- * @description A streaming event that indicated a reasoning summary part was completed.
960
- */
961
- ResponseReasoningSummaryPartDoneStreamingEvent: {
962
- /**
963
- * @description The type of the event, always `response.reasoning_summary_part.done`. (enum property replaced by openapi-typescript)
964
- * @enum {string}
965
- */
966
- type: "response.reasoning_summary_part.done";
967
- /** @description The sequence number of the event that was emitted. */
968
- sequence_number: number;
969
- /** @description The ID of the item that was updated. */
970
- item_id: string;
971
- /** @description The index of the output item that was updated. */
972
- output_index: number;
973
- /** @description The index of the summary part that was completed. */
974
- summary_index: number;
975
- /** @description A content part that makes up an input or output item. */
976
- part: components["schemas"]["InputTextContent"] | components["schemas"]["OutputTextContent"] | components["schemas"]["TextContent"] | components["schemas"]["SummaryTextContent"] | components["schemas"]["ReasoningTextContent"] | components["schemas"]["RefusalContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"];
977
- };
978
- /**
979
- * Response content part added event
980
- * @description A streaming event that indicated a content part was added.
981
- */
982
- ResponseContentPartAddedStreamingEvent: {
983
- /**
984
- * @description The type of the event, always `response.content_part.added`. (enum property replaced by openapi-typescript)
985
- * @enum {string}
986
- */
987
- type: "response.content_part.added";
988
- /** @description The sequence number of the event that was emitted. */
989
- sequence_number: number;
990
- /** @description The ID of the item that was updated. */
991
- item_id: string;
992
- /** @description The index of the output item that was updated. */
993
- output_index: number;
994
- /** @description The index of the content part that was added. */
995
- content_index: number;
996
- /** @description A content part that makes up an input or output item. */
997
- part: components["schemas"]["InputTextContent"] | components["schemas"]["OutputTextContent"] | components["schemas"]["TextContent"] | components["schemas"]["SummaryTextContent"] | components["schemas"]["ReasoningTextContent"] | components["schemas"]["RefusalContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"];
998
- };
999
- /**
1000
- * Response content part done event
1001
- * @description A streaming event that indicated a content part was completed.
1002
- */
1003
- ResponseContentPartDoneStreamingEvent: {
1004
- /**
1005
- * @description The type of the event, always `response.content_part.done`. (enum property replaced by openapi-typescript)
1006
- * @enum {string}
1007
- */
1008
- type: "response.content_part.done";
1009
- /** @description The sequence number of the event that was emitted. */
1010
- sequence_number: number;
1011
- /** @description The ID of the item that was updated. */
1012
- item_id: string;
1013
- /** @description The index of the output item that was updated. */
1014
- output_index: number;
1015
- /** @description The index of the content part that was completed. */
1016
- content_index: number;
1017
- /** @description A content part that makes up an input or output item. */
1018
- part: components["schemas"]["InputTextContent"] | components["schemas"]["OutputTextContent"] | components["schemas"]["TextContent"] | components["schemas"]["SummaryTextContent"] | components["schemas"]["ReasoningTextContent"] | components["schemas"]["RefusalContent"] | components["schemas"]["InputImageContent"] | components["schemas"]["InputFileContent"];
1019
- };
1020
- /**
1021
- * Response output text delta event
1022
- * @description A streaming event that indicated output text was incrementally added.
1023
- */
1024
- ResponseOutputTextDeltaStreamingEvent: {
1025
- /**
1026
- * @description The type of the event, always `response.output_text.delta`. (enum property replaced by openapi-typescript)
1027
- * @enum {string}
1028
- */
1029
- type: "response.output_text.delta";
1030
- /** @description The sequence number of the event that was emitted. */
1031
- sequence_number: number;
1032
- /** @description The ID of the item that was updated. */
1033
- item_id: string;
1034
- /** @description The index of the output item that was updated. */
1035
- output_index: number;
1036
- /** @description The index of the content part that was updated. */
1037
- content_index: number;
1038
- /** @description The text delta that was appended. */
1039
- delta: string;
1040
- /** @description The token log probabilities that were emitted with the delta, if any. */
1041
- logprobs?: components["schemas"]["LogProb"][];
1042
- /** @description An obfuscation string that was added to pad the event payload. */
1043
- obfuscation?: string;
1044
- };
1045
- /**
1046
- * Response output text done event
1047
- * @description A streaming event that indicated output text was completed.
1048
- */
1049
- ResponseOutputTextDoneStreamingEvent: {
1050
- /**
1051
- * @description The type of the event, always `response.output_text.done`. (enum property replaced by openapi-typescript)
1052
- * @enum {string}
1053
- */
1054
- type: "response.output_text.done";
1055
- /** @description The sequence number of the event that was emitted. */
1056
- sequence_number: number;
1057
- /** @description The ID of the item that was updated. */
1058
- item_id: string;
1059
- /** @description The index of the output item that was updated. */
1060
- output_index: number;
1061
- /** @description The index of the content part that was completed. */
1062
- content_index: number;
1063
- /** @description The final text that was emitted. */
1064
- text: string;
1065
- /** @description The token log probabilities that were emitted with the final text, if any. */
1066
- logprobs?: components["schemas"]["LogProb"][];
1067
- };
1068
- /**
1069
- * Response refusal delta event
1070
- * @description A streaming event that indicated refusal text was incrementally added.
1071
- */
1072
- ResponseRefusalDeltaStreamingEvent: {
1073
- /**
1074
- * @description The type of the event, always `response.refusal.delta`. (enum property replaced by openapi-typescript)
1075
- * @enum {string}
1076
- */
1077
- type: "response.refusal.delta";
1078
- /** @description The sequence number of the event that was emitted. */
1079
- sequence_number: number;
1080
- /** @description The ID of the item that was updated. */
1081
- item_id: string;
1082
- /** @description The index of the output item that was updated. */
1083
- output_index: number;
1084
- /** @description The index of the refusal content that was updated. */
1085
- content_index: number;
1086
- /** @description The refusal text delta that was appended. */
1087
- delta: string;
1088
- };
1089
- /**
1090
- * Response refusal done event
1091
- * @description A streaming event that indicated refusal text was completed.
1092
- */
1093
- ResponseRefusalDoneStreamingEvent: {
1094
- /**
1095
- * @description The type of the event, always `response.refusal.done`. (enum property replaced by openapi-typescript)
1096
- * @enum {string}
1097
- */
1098
- type: "response.refusal.done";
1099
- /** @description The sequence number of the event that was emitted. */
1100
- sequence_number: number;
1101
- /** @description The ID of the item that was updated. */
1102
- item_id: string;
1103
- /** @description The index of the output item that was updated. */
1104
- output_index: number;
1105
- /** @description The index of the refusal content that was completed. */
1106
- content_index: number;
1107
- /** @description The final refusal text that was emitted. */
1108
- refusal: string;
1109
- };
1110
- /**
1111
- * Response reasoning delta event
1112
- * @description A streaming event that indicated reasoning text was incrementally added.
1113
- */
1114
- ResponseReasoningDeltaStreamingEvent: {
1115
- /**
1116
- * @description The type of the event, always `response.reasoning.delta`. (enum property replaced by openapi-typescript)
1117
- * @enum {string}
1118
- */
1119
- type: "response.reasoning.delta";
1120
- /** @description The sequence number of the event that was emitted. */
1121
- sequence_number: number;
1122
- /** @description The ID of the item that was updated. */
1123
- item_id: string;
1124
- /** @description The index of the output item that was updated. */
1125
- output_index: number;
1126
- /** @description The index of the reasoning content that was updated. */
1127
- content_index: number;
1128
- /** @description The reasoning text delta that was appended. */
1129
- delta: string;
1130
- /** @description An obfuscation string that was added to pad the event payload. */
1131
- obfuscation?: string;
1132
- };
1133
- /**
1134
- * Response reasoning done event
1135
- * @description A streaming event that indicated reasoning text was completed.
1136
- */
1137
- ResponseReasoningDoneStreamingEvent: {
1138
- /**
1139
- * @description The type of the event, always `response.reasoning.done`. (enum property replaced by openapi-typescript)
1140
- * @enum {string}
1141
- */
1142
- type: "response.reasoning.done";
1143
- /** @description The sequence number of the event that was emitted. */
1144
- sequence_number: number;
1145
- /** @description The ID of the item that was updated. */
1146
- item_id: string;
1147
- /** @description The index of the output item that was updated. */
1148
- output_index: number;
1149
- /** @description The index of the reasoning content that was completed. */
1150
- content_index: number;
1151
- /** @description The final reasoning text that was emitted. */
1152
- text: string;
1153
- };
1154
- /**
1155
- * Response reasoning summary delta event
1156
- * @description A streaming event that indicated a reasoning summary was incrementally added.
1157
- */
1158
- ResponseReasoningSummaryDeltaStreamingEvent: {
1159
- /**
1160
- * @description The type of the event, always `response.reasoning_summary.delta`. (enum property replaced by openapi-typescript)
1161
- * @enum {string}
1162
- */
1163
- type: "response.reasoning_summary_text.delta";
1164
- /** @description The sequence number of the event that was emitted. */
1165
- sequence_number: number;
1166
- /** @description The ID of the item that was updated. */
1167
- item_id: string;
1168
- /** @description The index of the output item that was updated. */
1169
- output_index: number;
1170
- /** @description The index of the summary content that was updated. */
1171
- summary_index: number;
1172
- /** @description The summary text delta that was appended. */
1173
- delta: string;
1174
- /** @description An obfuscation string that was added to pad the event payload. */
1175
- obfuscation?: string;
1176
- };
1177
- /**
1178
- * Response reasoning summary done event
1179
- * @description A streaming event that indicated a reasoning summary was completed.
1180
- */
1181
- ResponseReasoningSummaryDoneStreamingEvent: {
1182
- /**
1183
- * @description The type of the event, always `response.reasoning_summary.done`. (enum property replaced by openapi-typescript)
1184
- * @enum {string}
1185
- */
1186
- type: "response.reasoning_summary_text.done";
1187
- /** @description The sequence number of the event that was emitted. */
1188
- sequence_number: number;
1189
- /** @description The ID of the item that was updated. */
1190
- item_id: string;
1191
- /** @description The index of the output item that was updated. */
1192
- output_index: number;
1193
- /** @description The index of the summary content that was completed. */
1194
- summary_index: number;
1195
- /** @description The final summary text that was emitted. */
1196
- text: string;
1197
- };
1198
- /**
1199
- * Response output text annotation added event
1200
- * @description A streaming event that indicated an output text annotation was added.
1201
- */
1202
- ResponseOutputTextAnnotationAddedStreamingEvent: {
1203
- /**
1204
- * @description The type of the event, always `response.output_text.annotation.added`. (enum property replaced by openapi-typescript)
1205
- * @enum {string}
1206
- */
1207
- type: "response.output_text.annotation.added";
1208
- /** @description The sequence number of the event that was emitted. */
1209
- sequence_number: number;
1210
- /** @description The ID of the item that was updated. */
1211
- item_id: string;
1212
- /** @description The index of the output item that was updated. */
1213
- output_index: number;
1214
- /** @description The index of the output text content that was updated. */
1215
- content_index: number;
1216
- /** @description The index of the annotation that was added. */
1217
- annotation_index: number;
1218
- annotation: (Omit<components["schemas"]["Annotation"], "type"> & unknown) | null;
1219
- };
1220
- /**
1221
- * Response function call arguments delta event
1222
- * @description A streaming event that indicated function call arguments were incrementally added.
1223
- */
1224
- ResponseFunctionCallArgumentsDeltaStreamingEvent: {
1225
- /**
1226
- * @description The type of the event, always `response.function_call_arguments.delta`. (enum property replaced by openapi-typescript)
1227
- * @enum {string}
1228
- */
1229
- type: "response.function_call_arguments.delta";
1230
- /** @description The sequence number of the event that was emitted. */
1231
- sequence_number: number;
1232
- /** @description The ID of the tool call item that was updated. */
1233
- item_id: string;
1234
- /** @description The index of the output item that was updated. */
1235
- output_index: number;
1236
- /** @description The arguments delta that was appended. */
1237
- delta: string;
1238
- /** @description An obfuscation string that was added to pad the event payload. */
1239
- obfuscation?: string;
1240
- };
1241
- /**
1242
- * Response function call arguments done event
1243
- * @description A streaming event that indicated function call arguments were completed.
1244
- */
1245
- ResponseFunctionCallArgumentsDoneStreamingEvent: {
1246
- /**
1247
- * @description The type of the event, always `response.function_call_arguments.done`. (enum property replaced by openapi-typescript)
1248
- * @enum {string}
1249
- */
1250
- type: "response.function_call_arguments.done";
1251
- /** @description The sequence number of the event that was emitted. */
1252
- sequence_number: number;
1253
- /** @description The ID of the tool call item that was updated. */
1254
- item_id: string;
1255
- /** @description The index of the output item that was updated. */
1256
- output_index: number;
1257
- /** @description The final arguments string that was emitted. */
1258
- arguments: string;
1259
- };
1260
- /**
1261
- * Error payload
1262
- * @description An error payload that was emitted for a streaming error event.
1263
- */
1264
- ErrorPayload: {
1265
- /** @description The error type that was emitted. */
1266
- type: string;
1267
- code: string | null;
1268
- /** @description The human-readable error message that was emitted. */
1269
- message: string;
1270
- param: string | null;
1271
- /** @description The response headers that were emitted with the error, if any. */
1272
- headers?: {
1273
- [key: string]: string;
1274
- };
1275
- };
1276
- /**
1277
- * Error event
1278
- * @description A streaming event that indicated an error was emitted.
1279
- */
1280
- ErrorStreamingEvent: {
1281
- /**
1282
- * @description The type of the event, always `error`. (enum property replaced by openapi-typescript)
1283
- * @enum {string}
1284
- */
1285
- type: "error";
1286
- /** @description The sequence number of the event that was emitted. */
1287
- sequence_number: number;
1288
- error: components["schemas"]["ErrorPayload"] & unknown;
1289
- };
1290
- /** @description A content block representing a video input to the model. */
1291
- InputVideoContent: {
1292
- /**
1293
- * @description The type of the input content. Always `input_video`. (enum property replaced by openapi-typescript)
1294
- * @enum {string}
1295
- */
1296
- type: "input_video";
1297
- /** @description A base64 or remote url that resolves to a video file. */
1298
- video_url: string;
1299
- };
1300
- JsonSchemaResponseFormatParam: {
1301
- /**
1302
- * @description The type of response format being defined. Always `json_schema`.
1303
- * @enum {string}
1304
- */
1305
- type?: "json_schema";
1306
- /**
1307
- * @description A description of what the response format is for, used by the model to
1308
- * determine how to respond in the format.
1309
- */
1310
- description?: string;
1311
- /**
1312
- * @description The name of the response format. Must be a-z, A-Z, 0-9, or contain
1313
- * underscores and dashes, with a maximum length of 64.
1314
- */
1315
- name?: string;
1316
- /**
1317
- * JSON schema
1318
- * @description The schema for the response format, described as a JSON Schema object.
1319
- */
1320
- schema?: {
1321
- [key: string]: unknown;
1322
- };
1323
- strict?: boolean | null;
1324
- };
1325
- TextFormatParam: components["schemas"]["TextResponseFormat"] | components["schemas"]["JsonSchemaResponseFormatParam"];
1326
- };
1327
- responses: never;
1328
- parameters: never;
1329
- requestBodies: never;
1330
- headers: never;
1331
- pathItems: never;
1332
- }
1333
- export type $defs = Record<string, never>;
1334
- export interface operations {
1335
- createResponse: {
1336
- parameters: {
1337
- query?: never;
1338
- header?: never;
1339
- path?: never;
1340
- cookie?: never;
1341
- };
1342
- requestBody?: {
1343
- content: {
1344
- "application/json": components["schemas"]["CreateResponseBody"];
1345
- "application/x-www-form-urlencoded": components["schemas"]["CreateResponseBody"];
1346
- };
1347
- };
1348
- responses: {
1349
- /** @description Success */
1350
- 200: {
1351
- headers: {
1352
- [name: string]: unknown;
1353
- };
1354
- content: {
1355
- "application/json": components["schemas"]["ResponseResource"];
1356
- "text/event-stream": components["schemas"]["ResponseCreatedStreamingEvent"] | components["schemas"]["ResponseQueuedStreamingEvent"] | components["schemas"]["ResponseInProgressStreamingEvent"] | components["schemas"]["ResponseCompletedStreamingEvent"] | components["schemas"]["ResponseFailedStreamingEvent"] | components["schemas"]["ResponseIncompleteStreamingEvent"] | components["schemas"]["ResponseOutputItemAddedStreamingEvent"] | components["schemas"]["ResponseOutputItemDoneStreamingEvent"] | components["schemas"]["ResponseReasoningSummaryPartAddedStreamingEvent"] | components["schemas"]["ResponseReasoningSummaryPartDoneStreamingEvent"] | components["schemas"]["ResponseContentPartAddedStreamingEvent"] | components["schemas"]["ResponseContentPartDoneStreamingEvent"] | components["schemas"]["ResponseOutputTextDeltaStreamingEvent"] | components["schemas"]["ResponseOutputTextDoneStreamingEvent"] | components["schemas"]["ResponseRefusalDeltaStreamingEvent"] | components["schemas"]["ResponseRefusalDoneStreamingEvent"] | components["schemas"]["ResponseReasoningDeltaStreamingEvent"] | components["schemas"]["ResponseReasoningDoneStreamingEvent"] | components["schemas"]["ResponseReasoningSummaryDeltaStreamingEvent"] | components["schemas"]["ResponseReasoningSummaryDoneStreamingEvent"] | components["schemas"]["ResponseOutputTextAnnotationAddedStreamingEvent"] | components["schemas"]["ResponseFunctionCallArgumentsDeltaStreamingEvent"] | components["schemas"]["ResponseFunctionCallArgumentsDoneStreamingEvent"] | components["schemas"]["ErrorStreamingEvent"];
1357
- };
1358
- };
1359
- };
1360
- };
1361
- }