openai 7.9.0 → 7.10.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.
- package/CHANGELOG.md +12 -0
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/lib/responses/ResponseInputItems.d.mts.map +1 -1
- package/lib/responses/ResponseInputItems.d.ts.map +1 -1
- package/lib/responses/ResponseInputItems.js +1 -0
- package/lib/responses/ResponseInputItems.js.map +1 -1
- package/lib/responses/ResponseInputItems.mjs +1 -0
- package/lib/responses/ResponseInputItems.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/admin/organization/usage.d.mts +1 -1
- package/resources/admin/organization/usage.d.ts +1 -1
- package/resources/batches.d.mts +1 -1
- package/resources/batches.d.ts +1 -1
- package/resources/beta/beta.d.mts +2 -2
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +2 -2
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/index.d.mts +1 -1
- package/resources/beta/index.d.mts.map +1 -1
- package/resources/beta/index.d.ts +1 -1
- package/resources/beta/index.d.ts.map +1 -1
- package/resources/beta/index.js.map +1 -1
- package/resources/beta/index.mjs.map +1 -1
- package/resources/beta/responses/index.d.mts +1 -1
- package/resources/beta/responses/index.d.mts.map +1 -1
- package/resources/beta/responses/index.d.ts +1 -1
- package/resources/beta/responses/index.d.ts.map +1 -1
- package/resources/beta/responses/index.js.map +1 -1
- package/resources/beta/responses/index.mjs.map +1 -1
- package/resources/beta/responses/responses.d.mts +660 -17
- package/resources/beta/responses/responses.d.mts.map +1 -1
- package/resources/beta/responses/responses.d.ts +660 -17
- package/resources/beta/responses/responses.d.ts.map +1 -1
- package/resources/beta/responses/responses.js +1 -1
- package/resources/beta/responses/responses.js.map +1 -1
- package/resources/beta/responses/responses.mjs +1 -1
- package/resources/beta/responses/responses.mjs.map +1 -1
- package/resources/chat/completions/completions.d.mts +2 -2
- package/resources/chat/completions/completions.d.ts +2 -2
- package/resources/conversations/items.d.mts +1 -1
- package/resources/conversations/items.d.mts.map +1 -1
- package/resources/conversations/items.d.ts +1 -1
- package/resources/conversations/items.d.ts.map +1 -1
- package/resources/evals/evals.d.mts +4 -4
- package/resources/evals/evals.d.ts +4 -4
- package/resources/evals/runs/runs.d.mts +1 -1
- package/resources/evals/runs/runs.d.ts +1 -1
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/responses/responses.d.mts +1098 -480
- package/resources/responses/responses.d.mts.map +1 -1
- package/resources/responses/responses.d.ts +1098 -480
- package/resources/responses/responses.d.ts.map +1 -1
- package/resources/responses/responses.js +1 -1
- package/resources/responses/responses.js.map +1 -1
- package/resources/responses/responses.mjs +1 -1
- package/resources/responses/responses.mjs.map +1 -1
- package/resources/safety/alerts.d.mts +32 -0
- package/resources/safety/alerts.d.mts.map +1 -0
- package/resources/safety/alerts.d.ts +32 -0
- package/resources/safety/alerts.d.ts.map +1 -0
- package/resources/safety/alerts.js +16 -0
- package/resources/safety/alerts.js.map +1 -0
- package/resources/safety/alerts.mjs +12 -0
- package/resources/safety/alerts.mjs.map +1 -0
- package/resources/safety/index.d.mts +3 -0
- package/resources/safety/index.d.mts.map +1 -0
- package/resources/safety/index.d.ts +3 -0
- package/resources/safety/index.d.ts.map +1 -0
- package/resources/safety/index.js +9 -0
- package/resources/safety/index.js.map +1 -0
- package/resources/safety/index.mjs +4 -0
- package/resources/safety/index.mjs.map +1 -0
- package/resources/safety/safety.d.mts +10 -0
- package/resources/safety/safety.d.mts.map +1 -0
- package/resources/safety/safety.d.ts +10 -0
- package/resources/safety/safety.d.ts.map +1 -0
- package/resources/safety/safety.js +17 -0
- package/resources/safety/safety.js.map +1 -0
- package/resources/safety/safety.mjs +12 -0
- package/resources/safety/safety.mjs.map +1 -0
- package/resources/safety.d.mts +2 -0
- package/resources/safety.d.mts.map +1 -0
- package/resources/safety.d.ts +2 -0
- package/resources/safety.d.ts.map +1 -0
- package/resources/safety.js +6 -0
- package/resources/safety.js.map +1 -0
- package/resources/safety.mjs +3 -0
- package/resources/safety.mjs.map +1 -0
- package/resources/shared.d.mts +29 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +29 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/videos.d.mts +28 -0
- package/resources/videos.d.mts.map +1 -1
- package/resources/videos.d.ts +28 -0
- package/resources/videos.d.ts.map +1 -1
- package/resources/webhooks/webhooks.d.mts +62 -2
- package/resources/webhooks/webhooks.d.mts.map +1 -1
- package/resources/webhooks/webhooks.d.ts +62 -2
- package/resources/webhooks/webhooks.d.ts.map +1 -1
- package/src/client.ts +5 -0
- package/src/lib/responses/ResponseInputItems.ts +1 -0
- package/src/resources/admin/organization/usage.ts +1 -1
- package/src/resources/batches.ts +1 -1
- package/src/resources/beta/beta.ts +22 -0
- package/src/resources/beta/index.ts +11 -0
- package/src/resources/beta/responses/index.ts +11 -0
- package/src/resources/beta/responses/responses.ts +801 -8
- package/src/resources/chat/completions/completions.ts +2 -2
- package/src/resources/conversations/items.ts +1 -0
- package/src/resources/evals/evals.ts +4 -4
- package/src/resources/evals/runs/runs.ts +1 -1
- package/src/resources/index.ts +1 -0
- package/src/resources/responses/api.md +11 -0
- package/src/resources/responses/responses.ts +1280 -518
- package/src/resources/safety/alerts.ts +51 -0
- package/src/resources/safety/index.ts +4 -0
- package/src/resources/safety/safety.ts +15 -0
- package/src/resources/safety.ts +3 -0
- package/src/resources/shared.ts +39 -0
- package/src/resources/videos.ts +38 -0
- package/src/resources/webhooks/api.md +2 -0
- package/src/resources/webhooks/webhooks.ts +77 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -170,7 +170,7 @@ export class Responses extends APIResource {
|
|
|
170
170
|
* ```ts
|
|
171
171
|
* const betaCompactedResponse =
|
|
172
172
|
* await client.beta.responses.compact({
|
|
173
|
-
* model: 'gpt-
|
|
173
|
+
* model: 'gpt-6-astra',
|
|
174
174
|
* });
|
|
175
175
|
* ```
|
|
176
176
|
*/
|
|
@@ -613,6 +613,12 @@ export interface BetaCustomTool {
|
|
|
613
613
|
*/
|
|
614
614
|
allowed_callers?: Array<'direct' | 'programmatic'> | null;
|
|
615
615
|
|
|
616
|
+
/**
|
|
617
|
+
* Whether the tool response can be returned asynchronously versus immediately
|
|
618
|
+
* returned on next response creation.
|
|
619
|
+
*/
|
|
620
|
+
async?: boolean;
|
|
621
|
+
|
|
616
622
|
/**
|
|
617
623
|
* Whether this tool should be deferred and discovered via tool search.
|
|
618
624
|
*/
|
|
@@ -901,6 +907,8 @@ export interface BetaFunctionTool {
|
|
|
901
907
|
*/
|
|
902
908
|
allowed_callers?: Array<'direct' | 'programmatic'> | null;
|
|
903
909
|
|
|
910
|
+
async?: boolean;
|
|
911
|
+
|
|
904
912
|
/**
|
|
905
913
|
* Whether this function is deferred and loaded via tool search.
|
|
906
914
|
*/
|
|
@@ -1057,6 +1065,12 @@ export namespace BetaNamespaceTool {
|
|
|
1057
1065
|
*/
|
|
1058
1066
|
allowed_callers?: Array<'direct' | 'programmatic'> | null;
|
|
1059
1067
|
|
|
1068
|
+
/**
|
|
1069
|
+
* Whether the tool response can be returned asynchronously versus immediately
|
|
1070
|
+
* returned on next response creation.
|
|
1071
|
+
*/
|
|
1072
|
+
async?: boolean;
|
|
1073
|
+
|
|
1060
1074
|
/**
|
|
1061
1075
|
* Whether this function should be deferred and discovered via tool search.
|
|
1062
1076
|
*/
|
|
@@ -1122,13 +1136,14 @@ export interface BetaResponse {
|
|
|
1122
1136
|
metadata: { [key: string]: string } | null;
|
|
1123
1137
|
|
|
1124
1138
|
/**
|
|
1125
|
-
* Model ID used to generate the response, like `gpt-
|
|
1139
|
+
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
1126
1140
|
* range of models with different capabilities, performance characteristics, and
|
|
1127
1141
|
* price points. Refer to the
|
|
1128
1142
|
* [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
1129
1143
|
* available models.
|
|
1130
1144
|
*/
|
|
1131
1145
|
model:
|
|
1146
|
+
| 'gpt-6-astra'
|
|
1132
1147
|
| 'gpt-5.6-sol'
|
|
1133
1148
|
| 'gpt-5.6-terra'
|
|
1134
1149
|
| 'gpt-5.6-luna'
|
|
@@ -1497,9 +1512,11 @@ export namespace BetaResponse {
|
|
|
1497
1512
|
*/
|
|
1498
1513
|
export interface IncompleteDetails {
|
|
1499
1514
|
/**
|
|
1500
|
-
* The reason why the response is incomplete.
|
|
1515
|
+
* The reason why the response is incomplete. `steered` means the response stopped
|
|
1516
|
+
* at a safe output boundary after a WebSocket `response.steer` event. The server
|
|
1517
|
+
* can then create a successor response automatically with the queued input.
|
|
1501
1518
|
*/
|
|
1502
|
-
reason?: 'max_output_tokens' | 'max_messages' | 'content_filter';
|
|
1519
|
+
reason?: 'max_output_tokens' | 'max_messages' | 'content_filter' | 'steered';
|
|
1503
1520
|
}
|
|
1504
1521
|
|
|
1505
1522
|
export interface BetaSpecificProgrammaticToolCallingParam {
|
|
@@ -2664,6 +2681,105 @@ export interface BetaResponseComputerToolCallOutputScreenshot {
|
|
|
2664
2681
|
image_url?: string;
|
|
2665
2682
|
}
|
|
2666
2683
|
|
|
2684
|
+
/**
|
|
2685
|
+
* A configuration update that applies to subsequent responses until it is replaced
|
|
2686
|
+
* by another configuration update.
|
|
2687
|
+
*/
|
|
2688
|
+
export interface BetaResponseConfigurationUpdateItem {
|
|
2689
|
+
/**
|
|
2690
|
+
* The unique ID of the configuration update item.
|
|
2691
|
+
*/
|
|
2692
|
+
id: string;
|
|
2693
|
+
|
|
2694
|
+
/**
|
|
2695
|
+
* The item type. Always `configuration_update`.
|
|
2696
|
+
*/
|
|
2697
|
+
type: 'configuration_update';
|
|
2698
|
+
|
|
2699
|
+
/**
|
|
2700
|
+
* The agent that produced this item.
|
|
2701
|
+
*/
|
|
2702
|
+
agent?: BetaResponseConfigurationUpdateItem.Agent;
|
|
2703
|
+
|
|
2704
|
+
/**
|
|
2705
|
+
* The reasoning configuration applied by this update.
|
|
2706
|
+
*/
|
|
2707
|
+
reasoning?: BetaResponseConfigurationUpdateItem.Reasoning;
|
|
2708
|
+
}
|
|
2709
|
+
|
|
2710
|
+
export namespace BetaResponseConfigurationUpdateItem {
|
|
2711
|
+
/**
|
|
2712
|
+
* The agent that produced this item.
|
|
2713
|
+
*/
|
|
2714
|
+
export interface Agent {
|
|
2715
|
+
/**
|
|
2716
|
+
* The canonical name of the agent that produced this item.
|
|
2717
|
+
*/
|
|
2718
|
+
agent_name: string;
|
|
2719
|
+
}
|
|
2720
|
+
|
|
2721
|
+
/**
|
|
2722
|
+
* The reasoning configuration applied by this update.
|
|
2723
|
+
*/
|
|
2724
|
+
export interface Reasoning {
|
|
2725
|
+
/**
|
|
2726
|
+
* The reasoning effort used for subsequent responses until another configuration
|
|
2727
|
+
* update replaces it.
|
|
2728
|
+
*/
|
|
2729
|
+
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
2730
|
+
}
|
|
2731
|
+
}
|
|
2732
|
+
|
|
2733
|
+
/**
|
|
2734
|
+
* An update to the conversation's response configuration. The configuration
|
|
2735
|
+
* remains in effect for subsequent responses until it is replaced by another
|
|
2736
|
+
* configuration update.
|
|
2737
|
+
*/
|
|
2738
|
+
export interface BetaResponseConfigurationUpdateItemParam {
|
|
2739
|
+
/**
|
|
2740
|
+
* The item type. Always `configuration_update`.
|
|
2741
|
+
*/
|
|
2742
|
+
type: 'configuration_update';
|
|
2743
|
+
|
|
2744
|
+
/**
|
|
2745
|
+
* The unique ID of the configuration update item.
|
|
2746
|
+
*/
|
|
2747
|
+
id?: string | null;
|
|
2748
|
+
|
|
2749
|
+
/**
|
|
2750
|
+
* The agent that produced this item.
|
|
2751
|
+
*/
|
|
2752
|
+
agent?: BetaResponseConfigurationUpdateItemParam.Agent | null;
|
|
2753
|
+
|
|
2754
|
+
/**
|
|
2755
|
+
* Updates to reasoning configuration. Only effort is supported.
|
|
2756
|
+
*/
|
|
2757
|
+
reasoning?: BetaResponseConfigurationUpdateItemParam.Reasoning;
|
|
2758
|
+
}
|
|
2759
|
+
|
|
2760
|
+
export namespace BetaResponseConfigurationUpdateItemParam {
|
|
2761
|
+
/**
|
|
2762
|
+
* The agent that produced this item.
|
|
2763
|
+
*/
|
|
2764
|
+
export interface Agent {
|
|
2765
|
+
/**
|
|
2766
|
+
* The canonical name of the agent that produced this item.
|
|
2767
|
+
*/
|
|
2768
|
+
agent_name: string;
|
|
2769
|
+
}
|
|
2770
|
+
|
|
2771
|
+
/**
|
|
2772
|
+
* Updates to reasoning configuration. Only effort is supported.
|
|
2773
|
+
*/
|
|
2774
|
+
export interface Reasoning {
|
|
2775
|
+
/**
|
|
2776
|
+
* The reasoning effort to use for subsequent responses until another configuration
|
|
2777
|
+
* update replaces it.
|
|
2778
|
+
*/
|
|
2779
|
+
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
2780
|
+
}
|
|
2781
|
+
}
|
|
2782
|
+
|
|
2667
2783
|
/**
|
|
2668
2784
|
* Represents a container created with /v1/containers.
|
|
2669
2785
|
*/
|
|
@@ -2919,6 +3035,11 @@ export interface BetaResponseCustomToolCall {
|
|
|
2919
3035
|
*/
|
|
2920
3036
|
agent?: BetaResponseCustomToolCall.Agent | null;
|
|
2921
3037
|
|
|
3038
|
+
/**
|
|
3039
|
+
* Whether the custom tool call runs asynchronously.
|
|
3040
|
+
*/
|
|
3041
|
+
async?: boolean;
|
|
3042
|
+
|
|
2922
3043
|
/**
|
|
2923
3044
|
* The execution context that produced this tool call.
|
|
2924
3045
|
*/
|
|
@@ -3171,6 +3292,7 @@ export interface BetaResponseError {
|
|
|
3171
3292
|
| 'invalid_prompt'
|
|
3172
3293
|
| 'data_residency_mismatch'
|
|
3173
3294
|
| 'bio_policy'
|
|
3295
|
+
| 'misalignment_policy_violation'
|
|
3174
3296
|
| 'vector_store_timeout'
|
|
3175
3297
|
| 'invalid_image'
|
|
3176
3298
|
| 'invalid_image_format'
|
|
@@ -3191,6 +3313,44 @@ export interface BetaResponseError {
|
|
|
3191
3313
|
* A human-readable description of the error.
|
|
3192
3314
|
*/
|
|
3193
3315
|
message: string;
|
|
3316
|
+
|
|
3317
|
+
misalignment?: BetaResponseError.Misalignment;
|
|
3318
|
+
}
|
|
3319
|
+
|
|
3320
|
+
export namespace BetaResponseError {
|
|
3321
|
+
export interface Misalignment {
|
|
3322
|
+
/**
|
|
3323
|
+
* The public explanation for this block.
|
|
3324
|
+
*/
|
|
3325
|
+
detailed_explanation?: string;
|
|
3326
|
+
|
|
3327
|
+
/**
|
|
3328
|
+
* An optional classification; clients must accept additional values.
|
|
3329
|
+
*/
|
|
3330
|
+
error_type?:
|
|
3331
|
+
| (string & {})
|
|
3332
|
+
| 'potentially_unintended_data_transfer'
|
|
3333
|
+
| 'potentially_unintended_data_access'
|
|
3334
|
+
| 'potentially_unintended_destructive_activity'
|
|
3335
|
+
| 'other';
|
|
3336
|
+
|
|
3337
|
+
/**
|
|
3338
|
+
* An optional public continuation instruction.
|
|
3339
|
+
*/
|
|
3340
|
+
steer?: Misalignment.Steer;
|
|
3341
|
+
}
|
|
3342
|
+
|
|
3343
|
+
export namespace Misalignment {
|
|
3344
|
+
/**
|
|
3345
|
+
* An optional public continuation instruction.
|
|
3346
|
+
*/
|
|
3347
|
+
export interface Steer {
|
|
3348
|
+
/**
|
|
3349
|
+
* The public continuation instruction.
|
|
3350
|
+
*/
|
|
3351
|
+
message: string;
|
|
3352
|
+
}
|
|
3353
|
+
}
|
|
3194
3354
|
}
|
|
3195
3355
|
|
|
3196
3356
|
/**
|
|
@@ -3989,6 +4149,11 @@ export interface BetaResponseFunctionToolCall {
|
|
|
3989
4149
|
*/
|
|
3990
4150
|
agent?: BetaResponseFunctionToolCall.Agent | null;
|
|
3991
4151
|
|
|
4152
|
+
/**
|
|
4153
|
+
* Whether the function tool call runs asynchronously.
|
|
4154
|
+
*/
|
|
4155
|
+
async?: boolean;
|
|
4156
|
+
|
|
3992
4157
|
/**
|
|
3993
4158
|
* The execution context that produced this tool call.
|
|
3994
4159
|
*/
|
|
@@ -4539,6 +4704,10 @@ export type BetaResponseIncludable =
|
|
|
4539
4704
|
|
|
4540
4705
|
/**
|
|
4541
4706
|
* An event that is emitted when a response finishes as incomplete.
|
|
4707
|
+
*
|
|
4708
|
+
* Over WebSocket, steering can finish a response with
|
|
4709
|
+
* `response.incomplete_details.reason` set to `steered`, followed automatically by
|
|
4710
|
+
* a successor `response.created` that commits the queued steering input.
|
|
4542
4711
|
*/
|
|
4543
4712
|
export interface BetaResponseIncompleteEvent {
|
|
4544
4713
|
/**
|
|
@@ -4956,6 +5125,7 @@ export type BetaResponseInputItem =
|
|
|
4956
5125
|
| BetaResponseInputItem.ToolSearchCall
|
|
4957
5126
|
| BetaResponseToolSearchOutputItemParam
|
|
4958
5127
|
| BetaResponseInputItem.AdditionalTools
|
|
5128
|
+
| BetaResponseConfigurationUpdateItemParam
|
|
4959
5129
|
| BetaResponseReasoningItem
|
|
4960
5130
|
| BetaResponseCompactionItemParam
|
|
4961
5131
|
| BetaResponseInputItem.ImageGenerationCall
|
|
@@ -6608,6 +6778,7 @@ export type BetaResponseItem =
|
|
|
6608
6778
|
| BetaResponseToolSearchCall
|
|
6609
6779
|
| BetaResponseToolSearchOutputItem
|
|
6610
6780
|
| BetaResponseItem.AdditionalTools
|
|
6781
|
+
| BetaResponseConfigurationUpdateItem
|
|
6611
6782
|
| BetaResponseReasoningItem
|
|
6612
6783
|
| BetaResponseItem.Program
|
|
6613
6784
|
| BetaResponseItem.ProgramOutput
|
|
@@ -10052,6 +10223,566 @@ export type BetaResponseStatus =
|
|
|
10052
10223
|
| 'queued'
|
|
10053
10224
|
| 'incomplete';
|
|
10054
10225
|
|
|
10226
|
+
/**
|
|
10227
|
+
* Emitted when steering input has been validated and queued. Acceptance means the
|
|
10228
|
+
* server owns the input, not that it has been applied. The successor's
|
|
10229
|
+
* `response.created` event is the commit point. If accepted input cannot be
|
|
10230
|
+
* committed, `response.steer.failed` returns it with the same steering ID.
|
|
10231
|
+
*
|
|
10232
|
+
* When the response stops for client-owned tool output or approval, the input
|
|
10233
|
+
* remains queued and `response.steer.pending` is emitted after
|
|
10234
|
+
* `response.completed`. Fill the pending event's `required_input` stubs with saved
|
|
10235
|
+
* results and send one matching explicit `response.create` per parent. Do not
|
|
10236
|
+
* resend accepted input while it is still queued.
|
|
10237
|
+
*/
|
|
10238
|
+
export interface BetaResponseSteerAcceptedEvent {
|
|
10239
|
+
/**
|
|
10240
|
+
* The sequence number for this event.
|
|
10241
|
+
*/
|
|
10242
|
+
sequence_number: number;
|
|
10243
|
+
|
|
10244
|
+
/**
|
|
10245
|
+
* The accepted steering submission.
|
|
10246
|
+
*/
|
|
10247
|
+
steer: BetaResponseSteerAcceptedEvent.Steer;
|
|
10248
|
+
|
|
10249
|
+
/**
|
|
10250
|
+
* The event discriminator. Always `response.steer.accepted`.
|
|
10251
|
+
*/
|
|
10252
|
+
type: 'response.steer.accepted';
|
|
10253
|
+
|
|
10254
|
+
/**
|
|
10255
|
+
* The WebSocket lane that emitted this event. This field is present when the
|
|
10256
|
+
* target response's `response.create` event supplied a `stream_id`.
|
|
10257
|
+
*/
|
|
10258
|
+
stream_id?: string;
|
|
10259
|
+
}
|
|
10260
|
+
|
|
10261
|
+
export namespace BetaResponseSteerAcceptedEvent {
|
|
10262
|
+
/**
|
|
10263
|
+
* The accepted steering submission.
|
|
10264
|
+
*/
|
|
10265
|
+
export interface Steer {
|
|
10266
|
+
/**
|
|
10267
|
+
* The ID assigned to the steering submission.
|
|
10268
|
+
*/
|
|
10269
|
+
id: string;
|
|
10270
|
+
|
|
10271
|
+
/**
|
|
10272
|
+
* The ID of the response being steered.
|
|
10273
|
+
*/
|
|
10274
|
+
previous_response_id: string;
|
|
10275
|
+
}
|
|
10276
|
+
}
|
|
10277
|
+
|
|
10278
|
+
/**
|
|
10279
|
+
* A machine-readable steering error code. Clients should handle unknown values
|
|
10280
|
+
* because additional codes may be introduced. Known values include:
|
|
10281
|
+
*
|
|
10282
|
+
* - `response_not_found`: The target response is not available on this connection.
|
|
10283
|
+
* - `invalid_input`: The event or input failed validation.
|
|
10284
|
+
* - `steering_not_supported`: The model or response execution mode does not
|
|
10285
|
+
* support steering.
|
|
10286
|
+
* - `too_many_pending_steers`: Too much steering input is pending for the
|
|
10287
|
+
* response.
|
|
10288
|
+
* - `response_already_completed`: The response completed and is no longer
|
|
10289
|
+
* accepting steering input.
|
|
10290
|
+
* - `response_not_active`: The response is no longer accepting steering input.
|
|
10291
|
+
* - `successor_creation_failed`: The successor response could not be created.
|
|
10292
|
+
*/
|
|
10293
|
+
export type BetaResponseSteerErrorCode =
|
|
10294
|
+
| 'response_not_found'
|
|
10295
|
+
| 'invalid_input'
|
|
10296
|
+
| 'steering_not_supported'
|
|
10297
|
+
| 'too_many_pending_steers'
|
|
10298
|
+
| 'response_already_completed'
|
|
10299
|
+
| 'response_not_active'
|
|
10300
|
+
| 'successor_creation_failed'
|
|
10301
|
+
| (string & {});
|
|
10302
|
+
|
|
10303
|
+
/**
|
|
10304
|
+
* Queues user input to steer a response on this WebSocket connection. Input can
|
|
10305
|
+
* contain text, images, and files. Steering is supported only for single-agent
|
|
10306
|
+
* responses on models and execution modes that support steering. Responses bound
|
|
10307
|
+
* to a conversation or using automatic compaction do not support steering.
|
|
10308
|
+
*
|
|
10309
|
+
* A `response.steer.accepted` event acknowledges that the server owns the queued
|
|
10310
|
+
* input, not that it has been applied. The successor's `response.created` event is
|
|
10311
|
+
* the commit point. Input that cannot be committed is returned in
|
|
10312
|
+
* `response.steer.failed`.
|
|
10313
|
+
*
|
|
10314
|
+
* Steering may cause the active response to finish at a safe output boundary with
|
|
10315
|
+
* `response.incomplete` and `incomplete_details.reason` set to `steered`, followed
|
|
10316
|
+
* automatically by a successor `response.created`. Normal completion can also be
|
|
10317
|
+
* followed by an automatic successor. Automatic successors inherit the previous
|
|
10318
|
+
* response's settings and continue from it with the queued input.
|
|
10319
|
+
*
|
|
10320
|
+
* If the response stops for client-owned tool output or approval, accepted
|
|
10321
|
+
* steering input remains queued and `response.steer.pending` is emitted after
|
|
10322
|
+
* `response.completed`. Fill the `required_input` stubs from that event with saved
|
|
10323
|
+
* tool results or approval decisions, and send one explicit `response.create` per
|
|
10324
|
+
* parent with the same `previous_response_id` and WebSocket lane. Do not rerun
|
|
10325
|
+
* tools or resend accepted steering input. The queued input is prepended in
|
|
10326
|
+
* submission order to that request's input, and the explicit request retains its
|
|
10327
|
+
* own settings.
|
|
10328
|
+
*
|
|
10329
|
+
* This event accepts only `type`, `previous_response_id`, and `input`. Do not send
|
|
10330
|
+
* `stream_id`; the target response determines the WebSocket lane.
|
|
10331
|
+
*/
|
|
10332
|
+
export interface BetaResponseSteerEvent {
|
|
10333
|
+
/**
|
|
10334
|
+
* Input to queue for a continuation of the response. Uses the same string or
|
|
10335
|
+
* input-item shape as `response.create.input`, with a non-empty array when
|
|
10336
|
+
* supplying input items.
|
|
10337
|
+
*
|
|
10338
|
+
* Steering accepts only messages with the `user` role. Each message may contain
|
|
10339
|
+
* only `type`, `role`, and `content`, with `content` as a string or an array of
|
|
10340
|
+
* `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
|
|
10341
|
+
* `message`. Other roles, tool outputs, and item types are not supported for
|
|
10342
|
+
* steering.
|
|
10343
|
+
*/
|
|
10344
|
+
input: BetaResponseSteerInput;
|
|
10345
|
+
|
|
10346
|
+
/**
|
|
10347
|
+
* The ID of the response to steer on this WebSocket connection.
|
|
10348
|
+
*/
|
|
10349
|
+
previous_response_id: string;
|
|
10350
|
+
|
|
10351
|
+
/**
|
|
10352
|
+
* The event discriminator. Always `response.steer`.
|
|
10353
|
+
*/
|
|
10354
|
+
type: 'response.steer';
|
|
10355
|
+
}
|
|
10356
|
+
|
|
10357
|
+
/**
|
|
10358
|
+
* Emitted when steering input is rejected or cannot be committed to a successor
|
|
10359
|
+
* response. Returns the original, uncommitted input so the client can carry it
|
|
10360
|
+
* into `response.create` when appropriate. Invalid input must be corrected before
|
|
10361
|
+
* retrying.
|
|
10362
|
+
*
|
|
10363
|
+
* Failures after acceptance include the same steering ID. Failures before an ID is
|
|
10364
|
+
* allocated omit `steer.id`. A lost connection or missing acknowledgement leaves
|
|
10365
|
+
* the outcome unknown; it is not proof that the input was rejected.
|
|
10366
|
+
*/
|
|
10367
|
+
export interface BetaResponseSteerFailedEvent {
|
|
10368
|
+
/**
|
|
10369
|
+
* Information about why the input could not be committed.
|
|
10370
|
+
*/
|
|
10371
|
+
error: BetaResponseSteerFailedEvent.Error;
|
|
10372
|
+
|
|
10373
|
+
/**
|
|
10374
|
+
* The sequence number for this event.
|
|
10375
|
+
*/
|
|
10376
|
+
sequence_number: number;
|
|
10377
|
+
|
|
10378
|
+
/**
|
|
10379
|
+
* The steering submission that could not be committed.
|
|
10380
|
+
*/
|
|
10381
|
+
steer: BetaResponseSteerFailedEvent.Steer;
|
|
10382
|
+
|
|
10383
|
+
/**
|
|
10384
|
+
* The event discriminator. Always `response.steer.failed`.
|
|
10385
|
+
*/
|
|
10386
|
+
type: 'response.steer.failed';
|
|
10387
|
+
|
|
10388
|
+
/**
|
|
10389
|
+
* The WebSocket lane that emitted this event, when the target response is
|
|
10390
|
+
* available and its `response.create` event supplied a `stream_id`.
|
|
10391
|
+
*/
|
|
10392
|
+
stream_id?: string;
|
|
10393
|
+
}
|
|
10394
|
+
|
|
10395
|
+
export namespace BetaResponseSteerFailedEvent {
|
|
10396
|
+
/**
|
|
10397
|
+
* Information about why the input could not be committed.
|
|
10398
|
+
*/
|
|
10399
|
+
export interface Error {
|
|
10400
|
+
/**
|
|
10401
|
+
* A machine-readable steering error code. Clients should handle unknown values
|
|
10402
|
+
* because additional codes may be introduced. Known values include:
|
|
10403
|
+
*
|
|
10404
|
+
* - `response_not_found`: The target response is not available on this connection.
|
|
10405
|
+
* - `invalid_input`: The event or input failed validation.
|
|
10406
|
+
* - `steering_not_supported`: The model or response execution mode does not
|
|
10407
|
+
* support steering.
|
|
10408
|
+
* - `too_many_pending_steers`: Too much steering input is pending for the
|
|
10409
|
+
* response.
|
|
10410
|
+
* - `response_already_completed`: The response completed and is no longer
|
|
10411
|
+
* accepting steering input.
|
|
10412
|
+
* - `response_not_active`: The response is no longer accepting steering input.
|
|
10413
|
+
* - `successor_creation_failed`: The successor response could not be created.
|
|
10414
|
+
*/
|
|
10415
|
+
code: ResponsesAPI.BetaResponseSteerErrorCode;
|
|
10416
|
+
|
|
10417
|
+
/**
|
|
10418
|
+
* A human-readable description of the error.
|
|
10419
|
+
*/
|
|
10420
|
+
message: string;
|
|
10421
|
+
|
|
10422
|
+
/**
|
|
10423
|
+
* The error type. Always `invalid_request_error`.
|
|
10424
|
+
*/
|
|
10425
|
+
type: 'invalid_request_error';
|
|
10426
|
+
}
|
|
10427
|
+
|
|
10428
|
+
/**
|
|
10429
|
+
* The steering submission that could not be committed.
|
|
10430
|
+
*/
|
|
10431
|
+
export interface Steer {
|
|
10432
|
+
/**
|
|
10433
|
+
* Input to queue for a continuation of the response. Uses the same string or
|
|
10434
|
+
* input-item shape as `response.create.input`, with a non-empty array when
|
|
10435
|
+
* supplying input items.
|
|
10436
|
+
*
|
|
10437
|
+
* Steering accepts only messages with the `user` role. Each message may contain
|
|
10438
|
+
* only `type`, `role`, and `content`, with `content` as a string or an array of
|
|
10439
|
+
* `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
|
|
10440
|
+
* `message`. Other roles, tool outputs, and item types are not supported for
|
|
10441
|
+
* steering.
|
|
10442
|
+
*/
|
|
10443
|
+
input: ResponsesAPI.BetaResponseSteerInput;
|
|
10444
|
+
|
|
10445
|
+
/**
|
|
10446
|
+
* The ID of the response that was targeted for steering.
|
|
10447
|
+
*/
|
|
10448
|
+
previous_response_id: string;
|
|
10449
|
+
|
|
10450
|
+
/**
|
|
10451
|
+
* The ID assigned to the steering submission, if one was allocated.
|
|
10452
|
+
*/
|
|
10453
|
+
id?: string;
|
|
10454
|
+
}
|
|
10455
|
+
}
|
|
10456
|
+
|
|
10457
|
+
/**
|
|
10458
|
+
* Input to queue for a continuation of the response. Uses the same string or
|
|
10459
|
+
* input-item shape as `response.create.input`, with a non-empty array when
|
|
10460
|
+
* supplying input items.
|
|
10461
|
+
*
|
|
10462
|
+
* Steering accepts only messages with the `user` role. Each message may contain
|
|
10463
|
+
* only `type`, `role`, and `content`, with `content` as a string or an array of
|
|
10464
|
+
* `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
|
|
10465
|
+
* `message`. Other roles, tool outputs, and item types are not supported for
|
|
10466
|
+
* steering.
|
|
10467
|
+
*/
|
|
10468
|
+
export type BetaResponseSteerInput =
|
|
10469
|
+
| string
|
|
10470
|
+
| Array<ResponseSteerInputItemList.Message | ResponseSteerInputItemList.FunctionCallOutput>;
|
|
10471
|
+
|
|
10472
|
+
export namespace ResponseSteerInputItemList {
|
|
10473
|
+
export interface Message {
|
|
10474
|
+
/**
|
|
10475
|
+
* The message content, as an array of content parts.
|
|
10476
|
+
*/
|
|
10477
|
+
content: Array<ResponsesAPI.BetaResponseSteerInputContent> | string;
|
|
10478
|
+
|
|
10479
|
+
/**
|
|
10480
|
+
* The message role. Always `user`.
|
|
10481
|
+
*/
|
|
10482
|
+
role: 'user';
|
|
10483
|
+
|
|
10484
|
+
/**
|
|
10485
|
+
* The item type. Always `message`.
|
|
10486
|
+
*/
|
|
10487
|
+
type: 'message';
|
|
10488
|
+
|
|
10489
|
+
/**
|
|
10490
|
+
* The unique ID of this message item.
|
|
10491
|
+
*/
|
|
10492
|
+
id?: string | null;
|
|
10493
|
+
|
|
10494
|
+
/**
|
|
10495
|
+
* The agent that produced this item.
|
|
10496
|
+
*/
|
|
10497
|
+
agent?: Message.Agent | null;
|
|
10498
|
+
|
|
10499
|
+
/**
|
|
10500
|
+
* The status of the message item.
|
|
10501
|
+
*/
|
|
10502
|
+
status?: string | null;
|
|
10503
|
+
}
|
|
10504
|
+
|
|
10505
|
+
export namespace Message {
|
|
10506
|
+
/**
|
|
10507
|
+
* The agent that produced this item.
|
|
10508
|
+
*/
|
|
10509
|
+
export interface Agent {
|
|
10510
|
+
/**
|
|
10511
|
+
* The canonical name of the agent that produced this item.
|
|
10512
|
+
*/
|
|
10513
|
+
agent_name: string;
|
|
10514
|
+
}
|
|
10515
|
+
}
|
|
10516
|
+
|
|
10517
|
+
/**
|
|
10518
|
+
* The output of a function tool call.
|
|
10519
|
+
*/
|
|
10520
|
+
export interface FunctionCallOutput {
|
|
10521
|
+
/**
|
|
10522
|
+
* Text, image, or file output of the function tool call.
|
|
10523
|
+
*/
|
|
10524
|
+
output: string | ResponsesAPI.BetaResponseFunctionCallOutputItemList;
|
|
10525
|
+
|
|
10526
|
+
/**
|
|
10527
|
+
* The type of the function tool call output. Always `function_call_output`.
|
|
10528
|
+
*/
|
|
10529
|
+
type: 'function_call_output';
|
|
10530
|
+
|
|
10531
|
+
/**
|
|
10532
|
+
* The unique ID of the function tool call output. Populated when this item is
|
|
10533
|
+
* returned via API.
|
|
10534
|
+
*/
|
|
10535
|
+
id?: string | null;
|
|
10536
|
+
|
|
10537
|
+
/**
|
|
10538
|
+
* The agent that produced this item.
|
|
10539
|
+
*/
|
|
10540
|
+
agent?: FunctionCallOutput.Agent | null;
|
|
10541
|
+
|
|
10542
|
+
/**
|
|
10543
|
+
* The unique ID of the function tool call generated by the model.
|
|
10544
|
+
*/
|
|
10545
|
+
call_id?: string | null;
|
|
10546
|
+
|
|
10547
|
+
/**
|
|
10548
|
+
* The execution context that produced this tool call.
|
|
10549
|
+
*/
|
|
10550
|
+
caller?: FunctionCallOutput.Direct | FunctionCallOutput.Program | null;
|
|
10551
|
+
|
|
10552
|
+
/**
|
|
10553
|
+
* The name of the tool that produced the output.
|
|
10554
|
+
*/
|
|
10555
|
+
name?: string | null;
|
|
10556
|
+
|
|
10557
|
+
/**
|
|
10558
|
+
* The namespace of the tool that produced the output.
|
|
10559
|
+
*/
|
|
10560
|
+
namespace?: string | null;
|
|
10561
|
+
|
|
10562
|
+
/**
|
|
10563
|
+
* The status of the item. One of `in_progress`, `completed`, or `incomplete`.
|
|
10564
|
+
* Populated when items are returned via API.
|
|
10565
|
+
*/
|
|
10566
|
+
status?: 'in_progress' | 'completed' | 'incomplete' | null;
|
|
10567
|
+
}
|
|
10568
|
+
|
|
10569
|
+
export namespace FunctionCallOutput {
|
|
10570
|
+
/**
|
|
10571
|
+
* The agent that produced this item.
|
|
10572
|
+
*/
|
|
10573
|
+
export interface Agent {
|
|
10574
|
+
/**
|
|
10575
|
+
* The canonical name of the agent that produced this item.
|
|
10576
|
+
*/
|
|
10577
|
+
agent_name: string;
|
|
10578
|
+
}
|
|
10579
|
+
|
|
10580
|
+
export interface Direct {
|
|
10581
|
+
/**
|
|
10582
|
+
* The caller type. Always `direct`.
|
|
10583
|
+
*/
|
|
10584
|
+
type: 'direct';
|
|
10585
|
+
}
|
|
10586
|
+
|
|
10587
|
+
export interface Program {
|
|
10588
|
+
/**
|
|
10589
|
+
* The call ID of the program item that produced this tool call.
|
|
10590
|
+
*/
|
|
10591
|
+
caller_id: string;
|
|
10592
|
+
|
|
10593
|
+
/**
|
|
10594
|
+
* The caller type. Always `program`.
|
|
10595
|
+
*/
|
|
10596
|
+
type: 'program';
|
|
10597
|
+
}
|
|
10598
|
+
}
|
|
10599
|
+
}
|
|
10600
|
+
|
|
10601
|
+
/**
|
|
10602
|
+
* A piece of message content, such as text, an image, or a file.
|
|
10603
|
+
*/
|
|
10604
|
+
export type BetaResponseSteerInputContent =
|
|
10605
|
+
| BetaResponseInputTextContent
|
|
10606
|
+
| BetaResponseInputImageContent
|
|
10607
|
+
| BetaResponseInputFileContent;
|
|
10608
|
+
|
|
10609
|
+
/**
|
|
10610
|
+
* Emitted when accepted steering input remains queued after the target response
|
|
10611
|
+
* completes. The server still owns the input. Do not resend it. The successor's
|
|
10612
|
+
* `response.created` event is the commit point.
|
|
10613
|
+
*
|
|
10614
|
+
* When `reason` is `waiting_for_required_input`, this event follows
|
|
10615
|
+
* `response.completed` while the response waits for the tool results or approval
|
|
10616
|
+
* decisions identified by `required_input`. Copy those stubs, fill their result
|
|
10617
|
+
* fields using the ordinary `response.create` input schemas, and submit one
|
|
10618
|
+
* continuation per parent with the same `previous_response_id` and WebSocket lane.
|
|
10619
|
+
* Use saved results without rerunning tools. The queued steering input is
|
|
10620
|
+
* prepended in submission order to the continuation's input. That explicit request
|
|
10621
|
+
* retains its own settings.
|
|
10622
|
+
*
|
|
10623
|
+
* This notification is emitted at most once per steering submission. Multiple
|
|
10624
|
+
* submissions for the same parent can report the same required inputs; they do not
|
|
10625
|
+
* each require a separate continuation.
|
|
10626
|
+
*/
|
|
10627
|
+
export interface BetaResponseSteerPendingEvent {
|
|
10628
|
+
/**
|
|
10629
|
+
* An extensible enum describing why accepted steering input is still queued.
|
|
10630
|
+
* Clients should handle unknown values because additional reasons may be
|
|
10631
|
+
* introduced. Known values include:
|
|
10632
|
+
*
|
|
10633
|
+
* - `waiting_for_required_input`: The response is waiting for the tool results or
|
|
10634
|
+
* approval decisions identified by `required_input`.
|
|
10635
|
+
*/
|
|
10636
|
+
reason: BetaResponseSteerPendingReason;
|
|
10637
|
+
|
|
10638
|
+
/**
|
|
10639
|
+
* Input stubs identifying outstanding client-owned tool results or approval
|
|
10640
|
+
* decisions. Each stub contains identifying fields only; the client supplies the
|
|
10641
|
+
* result before including it in `response.create`.
|
|
10642
|
+
*/
|
|
10643
|
+
required_input: Array<BetaResponseSteerRequiredInput>;
|
|
10644
|
+
|
|
10645
|
+
/**
|
|
10646
|
+
* The sequence number for this event.
|
|
10647
|
+
*/
|
|
10648
|
+
sequence_number: number;
|
|
10649
|
+
|
|
10650
|
+
/**
|
|
10651
|
+
* The steering submission that remains queued.
|
|
10652
|
+
*/
|
|
10653
|
+
steer: BetaResponseSteerPendingEvent.Steer;
|
|
10654
|
+
|
|
10655
|
+
/**
|
|
10656
|
+
* The event discriminator. Always `response.steer.pending`.
|
|
10657
|
+
*/
|
|
10658
|
+
type: 'response.steer.pending';
|
|
10659
|
+
|
|
10660
|
+
/**
|
|
10661
|
+
* The WebSocket lane that emitted this event. This field is present when the
|
|
10662
|
+
* target response's `response.create` event supplied a `stream_id`.
|
|
10663
|
+
*/
|
|
10664
|
+
stream_id?: string;
|
|
10665
|
+
}
|
|
10666
|
+
|
|
10667
|
+
export namespace BetaResponseSteerPendingEvent {
|
|
10668
|
+
/**
|
|
10669
|
+
* The steering submission that remains queued.
|
|
10670
|
+
*/
|
|
10671
|
+
export interface Steer {
|
|
10672
|
+
/**
|
|
10673
|
+
* The ID assigned to the steering submission.
|
|
10674
|
+
*/
|
|
10675
|
+
id: string;
|
|
10676
|
+
|
|
10677
|
+
/**
|
|
10678
|
+
* The ID of the response being steered.
|
|
10679
|
+
*/
|
|
10680
|
+
previous_response_id: string;
|
|
10681
|
+
}
|
|
10682
|
+
}
|
|
10683
|
+
|
|
10684
|
+
/**
|
|
10685
|
+
* An extensible enum describing why accepted steering input is still queued.
|
|
10686
|
+
* Clients should handle unknown values because additional reasons may be
|
|
10687
|
+
* introduced. Known values include:
|
|
10688
|
+
*
|
|
10689
|
+
* - `waiting_for_required_input`: The response is waiting for the tool results or
|
|
10690
|
+
* approval decisions identified by `required_input`.
|
|
10691
|
+
*/
|
|
10692
|
+
export type BetaResponseSteerPendingReason = 'waiting_for_required_input' | (string & {});
|
|
10693
|
+
|
|
10694
|
+
/**
|
|
10695
|
+
* An input stub identifying an outstanding client-owned tool result or approval
|
|
10696
|
+
* decision. Copy the stub and fill the result fields using the corresponding
|
|
10697
|
+
* `response.create` input schema. Use saved results without rerunning the tool.
|
|
10698
|
+
* The server does not supply results, approval decisions, or safety
|
|
10699
|
+
* acknowledgements in these stubs.
|
|
10700
|
+
*/
|
|
10701
|
+
export type BetaResponseSteerRequiredInput =
|
|
10702
|
+
| BetaResponseSteerRequiredInput.FunctionCallOutput
|
|
10703
|
+
| BetaResponseSteerRequiredInput.CustomToolCallOutput
|
|
10704
|
+
| BetaResponseSteerRequiredInput.ComputerCallOutput
|
|
10705
|
+
| BetaResponseSteerRequiredInput.ShellCallOutput
|
|
10706
|
+
| BetaResponseSteerRequiredInput.ApplyPatchCallOutput
|
|
10707
|
+
| BetaResponseSteerRequiredInput.ToolSearchOutput
|
|
10708
|
+
| BetaResponseSteerRequiredInput.McpApprovalResponse;
|
|
10709
|
+
|
|
10710
|
+
export namespace BetaResponseSteerRequiredInput {
|
|
10711
|
+
/**
|
|
10712
|
+
* Supply `output` using the function tool call output input schema.
|
|
10713
|
+
*/
|
|
10714
|
+
export interface FunctionCallOutput {
|
|
10715
|
+
call_id: string;
|
|
10716
|
+
|
|
10717
|
+
name: string;
|
|
10718
|
+
|
|
10719
|
+
type: 'function_call_output';
|
|
10720
|
+
}
|
|
10721
|
+
|
|
10722
|
+
/**
|
|
10723
|
+
* Supply `output` using the custom tool call output input schema. The original
|
|
10724
|
+
* custom tool call supplies the tool's name.
|
|
10725
|
+
*/
|
|
10726
|
+
export interface CustomToolCallOutput {
|
|
10727
|
+
call_id: string;
|
|
10728
|
+
|
|
10729
|
+
type: 'custom_tool_call_output';
|
|
10730
|
+
}
|
|
10731
|
+
|
|
10732
|
+
/**
|
|
10733
|
+
* Supply `output` using the computer tool call output input schema, including any
|
|
10734
|
+
* required `acknowledged_safety_checks`.
|
|
10735
|
+
*/
|
|
10736
|
+
export interface ComputerCallOutput {
|
|
10737
|
+
call_id: string;
|
|
10738
|
+
|
|
10739
|
+
type: 'computer_call_output';
|
|
10740
|
+
}
|
|
10741
|
+
|
|
10742
|
+
/**
|
|
10743
|
+
* Supply `output` using the shell tool call output input schema. Each output entry
|
|
10744
|
+
* includes `stdout`, `stderr`, and `outcome`.
|
|
10745
|
+
*/
|
|
10746
|
+
export interface ShellCallOutput {
|
|
10747
|
+
call_id: string;
|
|
10748
|
+
|
|
10749
|
+
type: 'shell_call_output';
|
|
10750
|
+
}
|
|
10751
|
+
|
|
10752
|
+
/**
|
|
10753
|
+
* Supply `status` and optional `output` using the apply patch tool call output
|
|
10754
|
+
* input schema.
|
|
10755
|
+
*/
|
|
10756
|
+
export interface ApplyPatchCallOutput {
|
|
10757
|
+
call_id: string;
|
|
10758
|
+
|
|
10759
|
+
type: 'apply_patch_call_output';
|
|
10760
|
+
}
|
|
10761
|
+
|
|
10762
|
+
/**
|
|
10763
|
+
* Supply `tools` using the tool search output input schema, retaining
|
|
10764
|
+
* `execution: "client"`.
|
|
10765
|
+
*/
|
|
10766
|
+
export interface ToolSearchOutput {
|
|
10767
|
+
call_id: string;
|
|
10768
|
+
|
|
10769
|
+
execution: 'client';
|
|
10770
|
+
|
|
10771
|
+
type: 'tool_search_output';
|
|
10772
|
+
}
|
|
10773
|
+
|
|
10774
|
+
/**
|
|
10775
|
+
* Supply `approve` using the MCP approval response input schema. An optional
|
|
10776
|
+
* `reason` can be supplied when denying the request. The original approval request
|
|
10777
|
+
* identifies the tool and server.
|
|
10778
|
+
*/
|
|
10779
|
+
export interface McpApprovalResponse {
|
|
10780
|
+
approval_request_id: string;
|
|
10781
|
+
|
|
10782
|
+
type: 'mcp_approval_response';
|
|
10783
|
+
}
|
|
10784
|
+
}
|
|
10785
|
+
|
|
10055
10786
|
/**
|
|
10056
10787
|
* Event emitted while a response is streamed.
|
|
10057
10788
|
*/
|
|
@@ -10680,7 +11411,10 @@ export namespace BetaResponseWebSearchCallSearchingEvent {
|
|
|
10680
11411
|
/**
|
|
10681
11412
|
* Client events accepted by the Responses WebSocket server.
|
|
10682
11413
|
*/
|
|
10683
|
-
export type BetaResponsesClientEvent =
|
|
11414
|
+
export type BetaResponsesClientEvent =
|
|
11415
|
+
| BetaResponsesClientEvent.ResponseCreate
|
|
11416
|
+
| BetaResponseSteerEvent
|
|
11417
|
+
| BetaResponseInjectEvent;
|
|
10684
11418
|
|
|
10685
11419
|
export namespace BetaResponsesClientEvent {
|
|
10686
11420
|
/**
|
|
@@ -10789,13 +11523,14 @@ export namespace BetaResponsesClientEvent {
|
|
|
10789
11523
|
metadata?: { [key: string]: string } | null;
|
|
10790
11524
|
|
|
10791
11525
|
/**
|
|
10792
|
-
* Model ID used to generate the response, like `gpt-
|
|
11526
|
+
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
10793
11527
|
* range of models with different capabilities, performance characteristics, and
|
|
10794
11528
|
* price points. Refer to the
|
|
10795
11529
|
* [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
10796
11530
|
* available models.
|
|
10797
11531
|
*/
|
|
10798
11532
|
model?:
|
|
11533
|
+
| 'gpt-6-astra'
|
|
10799
11534
|
| 'gpt-5.6-sol'
|
|
10800
11535
|
| 'gpt-5.6-terra'
|
|
10801
11536
|
| 'gpt-5.6-luna'
|
|
@@ -11388,6 +12123,9 @@ export type BetaResponsesServerEvent =
|
|
|
11388
12123
|
| BetaResponsesServerEvent.BetaResponseCustomToolCallInputWsDone
|
|
11389
12124
|
| BetaResponsesServerEvent.BetaResponseWsStreamingError
|
|
11390
12125
|
| BetaResponsesServerEvent.BetaResponseWsError
|
|
12126
|
+
| BetaResponseSteerAcceptedEvent
|
|
12127
|
+
| BetaResponseSteerPendingEvent
|
|
12128
|
+
| BetaResponseSteerFailedEvent
|
|
11391
12129
|
| BetaResponseInjectCreatedEvent
|
|
11392
12130
|
| BetaResponseInjectFailedEvent;
|
|
11393
12131
|
|
|
@@ -11669,6 +12407,10 @@ export namespace BetaResponsesServerEvent {
|
|
|
11669
12407
|
|
|
11670
12408
|
/**
|
|
11671
12409
|
* An event that is emitted when a response finishes as incomplete.
|
|
12410
|
+
*
|
|
12411
|
+
* Over WebSocket, steering can finish a response with
|
|
12412
|
+
* `response.incomplete_details.reason` set to `steered`, followed automatically by
|
|
12413
|
+
* a successor `response.created` that commits the queued steering input.
|
|
11672
12414
|
*/
|
|
11673
12415
|
export interface BetaResponseWsIncomplete extends BetaResponseIncompleteEvent {
|
|
11674
12416
|
/**
|
|
@@ -12099,6 +12841,44 @@ export namespace BetaResponsesServerEvent {
|
|
|
12099
12841
|
* The response headers that were emitted with the error, if any.
|
|
12100
12842
|
*/
|
|
12101
12843
|
headers?: { [key: string]: string };
|
|
12844
|
+
|
|
12845
|
+
misalignment?: Error.Misalignment;
|
|
12846
|
+
}
|
|
12847
|
+
|
|
12848
|
+
export namespace Error {
|
|
12849
|
+
export interface Misalignment {
|
|
12850
|
+
/**
|
|
12851
|
+
* The public explanation for this block.
|
|
12852
|
+
*/
|
|
12853
|
+
detailed_explanation?: string;
|
|
12854
|
+
|
|
12855
|
+
/**
|
|
12856
|
+
* An optional classification; clients must accept additional values.
|
|
12857
|
+
*/
|
|
12858
|
+
error_type?:
|
|
12859
|
+
| (string & {})
|
|
12860
|
+
| 'potentially_unintended_data_transfer'
|
|
12861
|
+
| 'potentially_unintended_data_access'
|
|
12862
|
+
| 'potentially_unintended_destructive_activity'
|
|
12863
|
+
| 'other';
|
|
12864
|
+
|
|
12865
|
+
/**
|
|
12866
|
+
* An optional public continuation instruction.
|
|
12867
|
+
*/
|
|
12868
|
+
steer?: Misalignment.Steer;
|
|
12869
|
+
}
|
|
12870
|
+
|
|
12871
|
+
export namespace Misalignment {
|
|
12872
|
+
/**
|
|
12873
|
+
* An optional public continuation instruction.
|
|
12874
|
+
*/
|
|
12875
|
+
export interface Steer {
|
|
12876
|
+
/**
|
|
12877
|
+
* The public continuation instruction.
|
|
12878
|
+
*/
|
|
12879
|
+
message: string;
|
|
12880
|
+
}
|
|
12881
|
+
}
|
|
12102
12882
|
}
|
|
12103
12883
|
|
|
12104
12884
|
/**
|
|
@@ -12948,13 +13728,14 @@ export interface ResponseCreateParamsBase {
|
|
|
12948
13728
|
metadata?: { [key: string]: string } | null;
|
|
12949
13729
|
|
|
12950
13730
|
/**
|
|
12951
|
-
* Body param: Model ID used to generate the response, like `gpt-
|
|
13731
|
+
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
12952
13732
|
* offers a wide range of models with different capabilities, performance
|
|
12953
13733
|
* characteristics, and price points. Refer to the
|
|
12954
13734
|
* [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
12955
13735
|
* available models.
|
|
12956
13736
|
*/
|
|
12957
13737
|
model?:
|
|
13738
|
+
| 'gpt-6-astra'
|
|
12958
13739
|
| 'gpt-5.6-sol'
|
|
12959
13740
|
| 'gpt-5.6-terra'
|
|
12960
13741
|
| 'gpt-5.6-luna'
|
|
@@ -13598,13 +14379,14 @@ export interface ResponseCancelParams {
|
|
|
13598
14379
|
|
|
13599
14380
|
export interface ResponseCompactParams {
|
|
13600
14381
|
/**
|
|
13601
|
-
* Body param: Model ID used to generate the response, like `gpt-
|
|
14382
|
+
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
13602
14383
|
* offers a wide range of models with different capabilities, performance
|
|
13603
14384
|
* characteristics, and price points. Refer to the
|
|
13604
14385
|
* [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
13605
14386
|
* available models.
|
|
13606
14387
|
*/
|
|
13607
14388
|
model:
|
|
14389
|
+
| 'gpt-6-astra'
|
|
13608
14390
|
| 'gpt-5.6-sol'
|
|
13609
14391
|
| 'gpt-5.6-terra'
|
|
13610
14392
|
| 'gpt-5.6-luna'
|
|
@@ -13861,6 +14643,8 @@ export declare namespace Responses {
|
|
|
13861
14643
|
type BetaResponseComputerToolCall as BetaResponseComputerToolCall,
|
|
13862
14644
|
type BetaResponseComputerToolCallOutputItem as BetaResponseComputerToolCallOutputItem,
|
|
13863
14645
|
type BetaResponseComputerToolCallOutputScreenshot as BetaResponseComputerToolCallOutputScreenshot,
|
|
14646
|
+
type BetaResponseConfigurationUpdateItem as BetaResponseConfigurationUpdateItem,
|
|
14647
|
+
type BetaResponseConfigurationUpdateItemParam as BetaResponseConfigurationUpdateItemParam,
|
|
13864
14648
|
type BetaResponseContainerReference as BetaResponseContainerReference,
|
|
13865
14649
|
type BetaResponseContent as BetaResponseContent,
|
|
13866
14650
|
type BetaResponseContentPartAddedEvent as BetaResponseContentPartAddedEvent,
|
|
@@ -13950,6 +14734,15 @@ export declare namespace Responses {
|
|
|
13950
14734
|
type BetaResponseShellCallOutputContentDeltaEvent as BetaResponseShellCallOutputContentDeltaEvent,
|
|
13951
14735
|
type BetaResponseShellCallOutputContentDoneEvent as BetaResponseShellCallOutputContentDoneEvent,
|
|
13952
14736
|
type BetaResponseStatus as BetaResponseStatus,
|
|
14737
|
+
type BetaResponseSteerAcceptedEvent as BetaResponseSteerAcceptedEvent,
|
|
14738
|
+
type BetaResponseSteerErrorCode as BetaResponseSteerErrorCode,
|
|
14739
|
+
type BetaResponseSteerEvent as BetaResponseSteerEvent,
|
|
14740
|
+
type BetaResponseSteerFailedEvent as BetaResponseSteerFailedEvent,
|
|
14741
|
+
type BetaResponseSteerInput as BetaResponseSteerInput,
|
|
14742
|
+
type BetaResponseSteerInputContent as BetaResponseSteerInputContent,
|
|
14743
|
+
type BetaResponseSteerPendingEvent as BetaResponseSteerPendingEvent,
|
|
14744
|
+
type BetaResponseSteerPendingReason as BetaResponseSteerPendingReason,
|
|
14745
|
+
type BetaResponseSteerRequiredInput as BetaResponseSteerRequiredInput,
|
|
13953
14746
|
type BetaResponseStreamEvent as BetaResponseStreamEvent,
|
|
13954
14747
|
type BetaResponseTextConfig as BetaResponseTextConfig,
|
|
13955
14748
|
type BetaResponseTextDeltaEvent as BetaResponseTextDeltaEvent,
|