openai 0.90.0 → 0.92.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.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +31 -0
  3. data/README.md +1 -1
  4. data/examples/realtime/README.md +8 -0
  5. data/examples/realtime/browser/README.md +167 -0
  6. data/examples/realtime/browser/index.html +19 -0
  7. data/examples/realtime/browser/page.js +21 -0
  8. data/examples/realtime/browser/peer.js +180 -0
  9. data/examples/realtime/browser/server.rb +281 -0
  10. data/examples/responses/websocket_workflows.rb +66 -6
  11. data/lib/openai/auth/workload_identity.rb +5 -1
  12. data/lib/openai/auth/workload_identity_auth.rb +2 -2
  13. data/lib/openai/auth/x509_token_exchange.rb +1 -1
  14. data/lib/openai/helpers/local_audio/process.rb +1 -1
  15. data/lib/openai/helpers/responses_websocket/connection.rb +2 -1
  16. data/lib/openai/helpers/responses_websocket/session.rb +551 -0
  17. data/lib/openai/helpers/responses_websocket.rb +1 -0
  18. data/lib/openai/helpers/sorbet.rb +1 -1
  19. data/lib/openai/helpers/websocket/async_websocket_transport.rb +6 -1
  20. data/lib/openai/internal/poller.rb +2 -2
  21. data/lib/openai/internal/transport/base_client.rb +1 -1
  22. data/lib/openai/internal/util.rb +1 -1
  23. data/lib/openai/models/beta/agents/session_update_params.rb +108 -1
  24. data/lib/openai/models/beta/beta_response.rb +9 -3
  25. data/lib/openai/models/beta/beta_response_compaction_compacting_event.rb +75 -0
  26. data/lib/openai/models/beta/beta_response_stream_event.rb +4 -1
  27. data/lib/openai/models/beta/beta_responses_client_event.rb +25 -4
  28. data/lib/openai/models/beta/beta_responses_server_event.rb +39 -1
  29. data/lib/openai/models/beta/beta_tool.rb +16 -0
  30. data/lib/openai/models/beta/response_compact_params.rb +9 -3
  31. data/lib/openai/models/beta/response_create_params.rb +21 -4
  32. data/lib/openai/models/beta/session_turn_error.rb +3 -0
  33. data/lib/openai/models/chat_model.rb +3 -1
  34. data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +16 -0
  35. data/lib/openai/models/realtime/realtime_session_create_response.rb +16 -0
  36. data/lib/openai/models/realtime/realtime_tools_config_union.rb +16 -0
  37. data/lib/openai/models/responses/response_compact_params.rb +9 -3
  38. data/lib/openai/models/responses/response_compaction_compacting_event.rb +49 -0
  39. data/lib/openai/models/responses/response_create_params.rb +12 -1
  40. data/lib/openai/models/responses/response_stream_event.rb +4 -1
  41. data/lib/openai/models/responses/responses_client_event.rb +12 -1
  42. data/lib/openai/models/responses/responses_server_event.rb +36 -1
  43. data/lib/openai/models/responses/tool.rb +16 -0
  44. data/lib/openai/models/webhooks/deleted_webhook_endpoint.rb +38 -0
  45. data/lib/openai/models/webhooks/event_type_list_params.rb +16 -0
  46. data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +6 -8
  47. data/lib/openai/models/webhooks/webhook_create_params.rb +73 -0
  48. data/lib/openai/models/webhooks/webhook_delete_params.rb +22 -0
  49. data/lib/openai/models/webhooks/webhook_endpoint.rb +85 -0
  50. data/lib/openai/models/webhooks/webhook_endpoint_list.rb +55 -0
  51. data/lib/openai/models/webhooks/webhook_endpoint_test_result.rb +58 -0
  52. data/lib/openai/models/webhooks/webhook_endpoint_with_secret.rb +105 -0
  53. data/lib/openai/models/webhooks/webhook_event_type_list.rb +28 -0
  54. data/lib/openai/models/webhooks/webhook_list_params.rb +34 -0
  55. data/lib/openai/models/webhooks/webhook_retrieve_params.rb +22 -0
  56. data/lib/openai/models/webhooks/webhook_rotate_secret_params.rb +34 -0
  57. data/lib/openai/models/webhooks/webhook_test_params.rb +59 -0
  58. data/lib/openai/models/webhooks/webhook_update_params.rb +80 -0
  59. data/lib/openai/resources/beta/agents/sessions.rb +6 -2
  60. data/lib/openai/resources/beta/responses.rb +2 -2
  61. data/lib/openai/resources/responses.rb +2 -2
  62. data/lib/openai/resources/webhooks/event_types.rb +35 -0
  63. data/lib/openai/resources/webhooks.rb +195 -0
  64. data/lib/openai/version.rb +1 -1
  65. data/lib/openai.rb +17 -0
  66. data/rbi/openai/helpers/responses_websocket/connection.rbi +5 -0
  67. data/rbi/openai/helpers/responses_websocket/session.rbi +206 -0
  68. data/rbi/openai/models/beta/agents/session_update_params.rbi +178 -0
  69. data/rbi/openai/models/beta/beta_response.rbi +6 -1
  70. data/rbi/openai/models/beta/beta_response_compaction_compacting_event.rbi +136 -0
  71. data/rbi/openai/models/beta/beta_response_stream_event.rbi +1 -0
  72. data/rbi/openai/models/beta/beta_responses_client_event.rbi +27 -4
  73. data/rbi/openai/models/beta/beta_responses_server_event.rbi +77 -0
  74. data/rbi/openai/models/beta/beta_tool.rbi +12 -0
  75. data/rbi/openai/models/beta/response_compact_params.rbi +6 -1
  76. data/rbi/openai/models/beta/response_create_params.rbi +21 -1
  77. data/rbi/openai/models/beta/session_turn_error.rbi +6 -0
  78. data/rbi/openai/models/chat_model.rbi +3 -1
  79. data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +12 -0
  80. data/rbi/openai/models/realtime/realtime_session_create_response.rbi +12 -0
  81. data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +12 -0
  82. data/rbi/openai/models/responses/response_compact_params.rbi +6 -1
  83. data/rbi/openai/models/responses/response_compaction_compacting_event.rbi +78 -0
  84. data/rbi/openai/models/responses/response_create_params.rbi +15 -0
  85. data/rbi/openai/models/responses/response_stream_event.rbi +1 -0
  86. data/rbi/openai/models/responses/responses_client_event.rbi +15 -0
  87. data/rbi/openai/models/responses/responses_server_event.rbi +71 -0
  88. data/rbi/openai/models/responses/tool.rbi +12 -0
  89. data/rbi/openai/models/webhooks/deleted_webhook_endpoint.rbi +67 -0
  90. data/rbi/openai/models/webhooks/event_type_list_params.rbi +37 -0
  91. data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +6 -8
  92. data/rbi/openai/models/webhooks/webhook_create_params.rbi +139 -0
  93. data/rbi/openai/models/webhooks/webhook_delete_params.rbi +53 -0
  94. data/rbi/openai/models/webhooks/webhook_endpoint.rbi +126 -0
  95. data/rbi/openai/models/webhooks/webhook_endpoint_list.rbi +91 -0
  96. data/rbi/openai/models/webhooks/webhook_endpoint_test_result.rbi +87 -0
  97. data/rbi/openai/models/webhooks/webhook_endpoint_with_secret.rbi +138 -0
  98. data/rbi/openai/models/webhooks/webhook_event_type_list.rbi +58 -0
  99. data/rbi/openai/models/webhooks/webhook_list_params.rbi +67 -0
  100. data/rbi/openai/models/webhooks/webhook_retrieve_params.rbi +53 -0
  101. data/rbi/openai/models/webhooks/webhook_rotate_secret_params.rbi +71 -0
  102. data/rbi/openai/models/webhooks/webhook_test_params.rbi +124 -0
  103. data/rbi/openai/models/webhooks/webhook_update_params.rbi +156 -0
  104. data/rbi/openai/resources/beta/agents/sessions.rbi +5 -1
  105. data/rbi/openai/resources/webhooks/event_types.rbi +24 -0
  106. data/rbi/openai/resources/webhooks.rbi +126 -0
  107. data/responses-websocket.md +117 -10
  108. data/sig/openai/helpers/responses_websocket/connection.rbs +5 -0
  109. data/sig/openai/helpers/responses_websocket/session.rbs +123 -0
  110. data/sig/openai/models/beta/agents/session_update_params.rbs +99 -0
  111. data/sig/openai/models/beta/beta_response.rbs +6 -2
  112. data/sig/openai/models/beta/beta_response_compaction_compacting_event.rbs +58 -0
  113. data/sig/openai/models/beta/beta_response_stream_event.rbs +1 -0
  114. data/sig/openai/models/beta/beta_responses_client_event.rbs +13 -2
  115. data/sig/openai/models/beta/beta_responses_server_event.rbs +35 -0
  116. data/sig/openai/models/beta/response_compact_params.rbs +6 -2
  117. data/sig/openai/models/beta/response_create_params.rbs +13 -2
  118. data/sig/openai/models/beta/session_turn_error.rbs +4 -0
  119. data/sig/openai/models/chat_model.rbs +6 -2
  120. data/sig/openai/models/responses/response_compact_params.rbs +6 -2
  121. data/sig/openai/models/responses/response_compaction_compacting_event.rbs +37 -0
  122. data/sig/openai/models/responses/response_create_params.rbs +7 -0
  123. data/sig/openai/models/responses/response_stream_event.rbs +1 -0
  124. data/sig/openai/models/responses/responses_client_event.rbs +7 -0
  125. data/sig/openai/models/responses/responses_server_event.rbs +32 -0
  126. data/sig/openai/models/webhooks/deleted_webhook_endpoint.rbs +28 -0
  127. data/sig/openai/models/webhooks/event_type_list_params.rbs +16 -0
  128. data/sig/openai/models/webhooks/webhook_create_params.rbs +83 -0
  129. data/sig/openai/models/webhooks/webhook_delete_params.rbs +25 -0
  130. data/sig/openai/models/webhooks/webhook_endpoint.rbs +59 -0
  131. data/sig/openai/models/webhooks/webhook_endpoint_list.rbs +42 -0
  132. data/sig/openai/models/webhooks/webhook_endpoint_test_result.rbs +42 -0
  133. data/sig/openai/models/webhooks/webhook_endpoint_with_secret.rbs +64 -0
  134. data/sig/openai/models/webhooks/webhook_event_type_list.rbs +17 -0
  135. data/sig/openai/models/webhooks/webhook_list_params.rbs +35 -0
  136. data/sig/openai/models/webhooks/webhook_retrieve_params.rbs +25 -0
  137. data/sig/openai/models/webhooks/webhook_rotate_secret_params.rbs +35 -0
  138. data/sig/openai/models/webhooks/webhook_test_params.rbs +78 -0
  139. data/sig/openai/models/webhooks/webhook_update_params.rbs +96 -0
  140. data/sig/openai/resources/beta/agents/sessions.rbs +1 -0
  141. data/sig/openai/resources/webhooks/event_types.rbs +13 -0
  142. data/sig/openai/resources/webhooks.rbs +45 -0
  143. metadata +61 -2
@@ -25,7 +25,6 @@ module OpenAI
25
25
  GPT_5_1 = :"gpt-5.1"
26
26
  GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
27
27
  GPT_5_1_CODEX = :"gpt-5.1-codex"
28
- GPT_5_1_MINI = :"gpt-5.1-mini"
29
28
  GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
30
29
  GPT_5 = :"gpt-5"
31
30
  GPT_5_MINI = :"gpt-5-mini"
@@ -56,6 +55,8 @@ module OpenAI
56
55
  GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
57
56
  GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
58
57
  GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
58
+ GPT_AUDIO_MINI = :"gpt-audio-mini"
59
+ GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
59
60
  GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
60
61
  GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
61
62
  GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
@@ -89,6 +90,7 @@ module OpenAI
89
90
  GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
90
91
  GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
91
92
  GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
93
+ GPT_5_1_MINI = :"gpt-5.1-mini"
92
94
 
93
95
  # @!method self.values
94
96
  # @return [Array<Symbol>]
@@ -47,11 +47,17 @@ module OpenAI
47
47
  optional :authorization, String
48
48
 
49
49
  # @!attribute connector_id
50
+ # @deprecated
51
+ #
50
52
  # Identifier for service connectors, like those available in ChatGPT. One of
51
53
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
52
54
  # service connectors
53
55
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
54
56
  #
57
+ # This field is deprecated for models released after September 1, 2026. Use
58
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
59
+ # through a Secure MCP Tunnel.
60
+ #
55
61
  # Currently supported `connector_id` values are:
56
62
  #
57
63
  # - Dropbox: `connector_dropbox`
@@ -134,6 +140,10 @@ module OpenAI
134
140
  # service connectors
135
141
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
136
142
  #
143
+ # This field is deprecated for models released after September 1, 2026. Use
144
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
145
+ # through a Secure MCP Tunnel.
146
+ #
137
147
  # Currently supported `connector_id` values are:
138
148
  #
139
149
  # - Dropbox: `connector_dropbox`
@@ -226,11 +236,17 @@ module OpenAI
226
236
  StringArray = OpenAI::Internal::Type::ArrayOf[String]
227
237
  end
228
238
 
239
+ # @deprecated
240
+ #
229
241
  # Identifier for service connectors, like those available in ChatGPT. One of
230
242
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
231
243
  # service connectors
232
244
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
233
245
  #
246
+ # This field is deprecated for models released after September 1, 2026. Use
247
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
248
+ # through a Secure MCP Tunnel.
249
+ #
234
250
  # Currently supported `connector_id` values are:
235
251
  #
236
252
  # - Dropbox: `connector_dropbox`
@@ -960,11 +960,17 @@ module OpenAI
960
960
  optional :authorization, String
961
961
 
962
962
  # @!attribute connector_id
963
+ # @deprecated
964
+ #
963
965
  # Identifier for service connectors, like those available in ChatGPT. One of
964
966
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
965
967
  # service connectors
966
968
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
967
969
  #
970
+ # This field is deprecated for models released after September 1, 2026. Use
971
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
972
+ # through a Secure MCP Tunnel.
973
+ #
968
974
  # Currently supported `connector_id` values are:
969
975
  #
970
976
  # - Dropbox: `connector_dropbox`
@@ -1052,6 +1058,10 @@ module OpenAI
1052
1058
  # service connectors
1053
1059
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
1054
1060
  #
1061
+ # This field is deprecated for models released after September 1, 2026. Use
1062
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
1063
+ # through a Secure MCP Tunnel.
1064
+ #
1055
1065
  # Currently supported `connector_id` values are:
1056
1066
  #
1057
1067
  # - Dropbox: `connector_dropbox`
@@ -1150,11 +1160,17 @@ module OpenAI
1150
1160
  StringArray = OpenAI::Internal::Type::ArrayOf[String]
1151
1161
  end
1152
1162
 
1163
+ # @deprecated
1164
+ #
1153
1165
  # Identifier for service connectors, like those available in ChatGPT. One of
1154
1166
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
1155
1167
  # service connectors
1156
1168
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
1157
1169
  #
1170
+ # This field is deprecated for models released after September 1, 2026. Use
1171
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
1172
+ # through a Secure MCP Tunnel.
1173
+ #
1158
1174
  # Currently supported `connector_id` values are:
1159
1175
  #
1160
1176
  # - Dropbox: `connector_dropbox`
@@ -61,11 +61,17 @@ module OpenAI
61
61
  optional :authorization, String
62
62
 
63
63
  # @!attribute connector_id
64
+ # @deprecated
65
+ #
64
66
  # Identifier for service connectors, like those available in ChatGPT. One of
65
67
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
66
68
  # service connectors
67
69
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
68
70
  #
71
+ # This field is deprecated for models released after September 1, 2026. Use
72
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
73
+ # through a Secure MCP Tunnel.
74
+ #
69
75
  # Currently supported `connector_id` values are:
70
76
  #
71
77
  # - Dropbox: `connector_dropbox`
@@ -148,6 +154,10 @@ module OpenAI
148
154
  # service connectors
149
155
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
150
156
  #
157
+ # This field is deprecated for models released after September 1, 2026. Use
158
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
159
+ # through a Secure MCP Tunnel.
160
+ #
151
161
  # Currently supported `connector_id` values are:
152
162
  #
153
163
  # - Dropbox: `connector_dropbox`
@@ -240,11 +250,17 @@ module OpenAI
240
250
  StringArray = OpenAI::Internal::Type::ArrayOf[String]
241
251
  end
242
252
 
253
+ # @deprecated
254
+ #
243
255
  # Identifier for service connectors, like those available in ChatGPT. One of
244
256
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
245
257
  # service connectors
246
258
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
247
259
  #
260
+ # This field is deprecated for models released after September 1, 2026. Use
261
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
262
+ # through a Secure MCP Tunnel.
263
+ #
248
264
  # Currently supported `connector_id` values are:
249
265
  #
250
266
  # - Dropbox: `connector_dropbox`
@@ -207,8 +207,6 @@ module OpenAI
207
207
 
208
208
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_CODEX }
209
209
 
210
- variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_MINI }
211
-
212
210
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_CHAT_LATEST }
213
211
 
214
212
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5 }
@@ -269,6 +267,10 @@ module OpenAI
269
267
 
270
268
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_2024_05_13 }
271
269
 
270
+ variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_AUDIO_MINI }
271
+
272
+ variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_AUDIO_MINI_2025_12_15 }
273
+
272
274
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW }
273
275
 
274
276
  variant(
@@ -349,6 +351,8 @@ module OpenAI
349
351
 
350
352
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO_16K_0613 }
351
353
 
354
+ variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_MINI }
355
+
352
356
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_PRO }
353
357
 
354
358
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_PRO_2025_03_19 }
@@ -422,7 +426,6 @@ module OpenAI
422
426
  GPT_5_1 = :"gpt-5.1"
423
427
  GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
424
428
  GPT_5_1_CODEX = :"gpt-5.1-codex"
425
- GPT_5_1_MINI = :"gpt-5.1-mini"
426
429
  GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
427
430
  GPT_5 = :"gpt-5"
428
431
  GPT_5_MINI = :"gpt-5-mini"
@@ -453,6 +456,8 @@ module OpenAI
453
456
  GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
454
457
  GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
455
458
  GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
459
+ GPT_AUDIO_MINI = :"gpt-audio-mini"
460
+ GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
456
461
  GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
457
462
  GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
458
463
  GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
@@ -486,6 +491,7 @@ module OpenAI
486
491
  GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
487
492
  GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
488
493
  GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
494
+ GPT_5_1_MINI = :"gpt-5.1-mini"
489
495
  O1_PRO = :"o1-pro"
490
496
  O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
491
497
  O3_PRO = :"o3-pro"
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Responses
6
+ class ResponseCompactionCompactingEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute item_id
8
+ # The ID of the compaction output item.
9
+ #
10
+ # @return [String]
11
+ required :item_id, String
12
+
13
+ # @!attribute output_index
14
+ # The index of the compaction output item.
15
+ #
16
+ # @return [Integer]
17
+ required :output_index, Integer
18
+
19
+ # @!attribute sequence_number
20
+ # The sequence number of the event that was emitted.
21
+ #
22
+ # @return [Integer]
23
+ required :sequence_number, Integer
24
+
25
+ # @!attribute type
26
+ # The type of the event, always `response.compaction.compacting`.
27
+ #
28
+ # @return [Symbol, :"response.compaction.compacting"]
29
+ required :type, const: :"response.compaction.compacting"
30
+
31
+ # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.compaction.compacting")
32
+ # Emitted when new summary content is sampled for a compaction trigger. Contains
33
+ # no summary content.
34
+ #
35
+ # @param item_id [String]
36
+ # The ID of the compaction output item.
37
+ #
38
+ # @param output_index [Integer]
39
+ # The index of the compaction output item.
40
+ #
41
+ # @param sequence_number [Integer]
42
+ # The sequence number of the event that was emitted.
43
+ #
44
+ # @param type [Symbol, :"response.compaction.compacting"]
45
+ # The type of the event, always `response.compaction.compacting`.
46
+ end
47
+ end
48
+ end
49
+ end
@@ -817,6 +817,13 @@ module OpenAI
817
817
  # @return [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::Mode, nil]
818
818
  optional :mode, enum: -> { OpenAI::Responses::ResponseCreateParams::PromptCacheOptions::Mode }
819
819
 
820
+ # @!attribute prewarm
821
+ # Prepares the prompt cache without generating output. Defaults to `false`. When
822
+ # set to `true`, overrides the `generate` field to `false`.
823
+ #
824
+ # @return [Boolean, nil]
825
+ optional :prewarm, OpenAI::Internal::Type::Boolean
826
+
820
827
  # @!attribute ttl
821
828
  # The minimum lifetime applied to every implicit and explicit cache breakpoint
822
829
  # written by the request. Defaults to `30m`, which is currently the only supported
@@ -825,7 +832,7 @@ module OpenAI
825
832
  # @return [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::Ttl, nil]
826
833
  optional :ttl, enum: -> { OpenAI::Responses::ResponseCreateParams::PromptCacheOptions::Ttl }
827
834
 
828
- # @!method initialize(comparison_response_id: nil, mode: nil, ttl: nil)
835
+ # @!method initialize(comparison_response_id: nil, mode: nil, prewarm: nil, ttl: nil)
829
836
  # Options for prompt caching. Supported for `gpt-5.6` and later models. By
830
837
  # default, OpenAI automatically chooses one implicit cache breakpoint. You can add
831
838
  # explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
@@ -848,6 +855,10 @@ module OpenAI
848
855
  # latest four explicit breakpoints. If there are no explicit breakpoints, the
849
856
  # request does not use prompt caching.
850
857
  #
858
+ # @param prewarm [Boolean]
859
+ # Prepares the prompt cache without generating output. Defaults to `false`. When
860
+ # set to `true`, overrides the `generate` field to `false`.
861
+ #
851
862
  # @param ttl [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::Ttl]
852
863
  # The minimum lifetime applied to every implicit and explicit cache breakpoint
853
864
  # written by the request. Defaults to `30m`, which is currently the only supported
@@ -51,6 +51,9 @@ module OpenAI
51
51
  -> { OpenAI::Responses::ResponseCodeInterpreterCallInterpretingEvent }
52
52
  )
53
53
 
54
+ # Emitted when new summary content is sampled for a compaction trigger. Contains no summary content.
55
+ variant :"response.compaction.compacting", -> { OpenAI::Responses::ResponseCompactionCompactingEvent }
56
+
54
57
  # Emitted when the model response is complete.
55
58
  variant :"response.completed", -> { OpenAI::Responses::ResponseCompletedEvent }
56
59
 
@@ -269,7 +272,7 @@ module OpenAI
269
272
  )
270
273
 
271
274
  # @!method self.variants
272
- # @return [Array(OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent)]
275
+ # @return [Array(OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompactionCompactingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent)]
273
276
  end
274
277
  end
275
278
  end
@@ -941,6 +941,13 @@ module OpenAI
941
941
  enum: -> { OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Mode }
942
942
  )
943
943
 
944
+ # @!attribute prewarm
945
+ # Prepares the prompt cache without generating output. Defaults to `false`. When
946
+ # set to `true`, overrides the `generate` field to `false`.
947
+ #
948
+ # @return [Boolean, nil]
949
+ optional :prewarm, OpenAI::Internal::Type::Boolean
950
+
944
951
  # @!attribute ttl
945
952
  # The minimum lifetime applied to every implicit and explicit cache breakpoint
946
953
  # written by the request. Defaults to `30m`, which is currently the only supported
@@ -952,7 +959,7 @@ module OpenAI
952
959
  enum: -> { OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Ttl }
953
960
  )
954
961
 
955
- # @!method initialize(comparison_response_id: nil, mode: nil, ttl: nil)
962
+ # @!method initialize(comparison_response_id: nil, mode: nil, prewarm: nil, ttl: nil)
956
963
  # Options for prompt caching. Supported for `gpt-5.6` and later models. By
957
964
  # default, OpenAI automatically chooses one implicit cache breakpoint. You can add
958
965
  # explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
@@ -975,6 +982,10 @@ module OpenAI
975
982
  # latest four explicit breakpoints. If there are no explicit breakpoints, the
976
983
  # request does not use prompt caching.
977
984
  #
985
+ # @param prewarm [Boolean]
986
+ # Prepares the prompt cache without generating output. Defaults to `false`. When
987
+ # set to `true`, overrides the `generate` field to `false`.
988
+ #
978
989
  # @param ttl [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Ttl]
979
990
  # The minimum lifetime applied to every implicit and explicit cache breakpoint
980
991
  # written by the request. Defaults to `30m`, which is currently the only supported
@@ -100,6 +100,12 @@ module OpenAI
100
100
  -> { OpenAI::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsInterpreting }
101
101
  )
102
102
 
103
+ # Emitted when new summary content is sampled for a compaction trigger. Contains no summary content.
104
+ variant(
105
+ :"response.compaction.compacting",
106
+ -> { OpenAI::Responses::ResponsesServerEvent::ResponseCompactionWsCompacting }
107
+ )
108
+
103
109
  # Emitted when the model response is complete.
104
110
  variant :"response.completed", -> { OpenAI::Responses::ResponsesServerEvent::ResponseWsCompleted }
105
111
 
@@ -606,6 +612,35 @@ module OpenAI
606
612
  # The type of the event. Always `response.code_interpreter_call.interpreting`.
607
613
  end
608
614
 
615
+ class ResponseCompactionWsCompacting < OpenAI::Models::Responses::ResponseCompactionCompactingEvent
616
+ # @!attribute stream_id
617
+ # The WebSocket lane that emitted this event. This field is present when the
618
+ # originating `response.create` event supplied a `stream_id`.
619
+ #
620
+ # @return [String, nil]
621
+ optional :stream_id, String
622
+
623
+ # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.compaction.compacting")
624
+ # Emitted when new summary content is sampled for a compaction trigger. Contains
625
+ # no summary content.
626
+ #
627
+ # @param item_id [String]
628
+ # The ID of the compaction output item.
629
+ #
630
+ # @param output_index [Integer]
631
+ # The index of the compaction output item.
632
+ #
633
+ # @param sequence_number [Integer]
634
+ # The sequence number of the event that was emitted.
635
+ #
636
+ # @param stream_id [String]
637
+ # The WebSocket lane that emitted this event. This field is present when the
638
+ # originating `response.create` event supplied a `stream_id`.
639
+ #
640
+ # @param type [Symbol, :"response.compaction.compacting"]
641
+ # The type of the event, always `response.compaction.compacting`.
642
+ end
643
+
609
644
  class ResponseWsCompleted < OpenAI::Models::Responses::ResponseCompletedEvent
610
645
  # @!attribute stream_id
611
646
  # The WebSocket lane that emitted this event. This field is present when the
@@ -2315,7 +2350,7 @@ module OpenAI
2315
2350
  end
2316
2351
 
2317
2352
  # @!method self.variants
2318
- # @return [Array(OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError, OpenAI::Models::Responses::ResponseSteerAcceptedEvent, OpenAI::Models::Responses::ResponseSteerPendingEvent, OpenAI::Models::Responses::ResponseSteerFailedEvent, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsInterpreting, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCreated, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsSearching, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallOutputContentWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallOutputContentWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsIncomplete, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsSearching, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsGenerating, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallPartialWsImage, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputTextAnnotationWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsQueued, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDone)]
2353
+ # @return [Array(OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError, OpenAI::Models::Responses::ResponseSteerAcceptedEvent, OpenAI::Models::Responses::ResponseSteerPendingEvent, OpenAI::Models::Responses::ResponseSteerFailedEvent, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsInterpreting, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCompactionWsCompacting, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCreated, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsSearching, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallOutputContentWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallOutputContentWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsIncomplete, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsSearching, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsGenerating, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallPartialWsImage, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputTextAnnotationWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsQueued, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDone)]
2319
2354
  end
2320
2355
  end
2321
2356
  end
@@ -98,11 +98,17 @@ module OpenAI
98
98
  optional :authorization, String
99
99
 
100
100
  # @!attribute connector_id
101
+ # @deprecated
102
+ #
101
103
  # Identifier for service connectors, like those available in ChatGPT. One of
102
104
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
103
105
  # service connectors
104
106
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
105
107
  #
108
+ # This field is deprecated for models released after September 1, 2026. Use
109
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
110
+ # through a Secure MCP Tunnel.
111
+ #
106
112
  # Currently supported `connector_id` values are:
107
113
  #
108
114
  # - Dropbox: `connector_dropbox`
@@ -181,6 +187,10 @@ module OpenAI
181
187
  # service connectors
182
188
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
183
189
  #
190
+ # This field is deprecated for models released after September 1, 2026. Use
191
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
192
+ # through a Secure MCP Tunnel.
193
+ #
184
194
  # Currently supported `connector_id` values are:
185
195
  #
186
196
  # - Dropbox: `connector_dropbox`
@@ -273,11 +283,17 @@ module OpenAI
273
283
  StringArray = OpenAI::Internal::Type::ArrayOf[String]
274
284
  end
275
285
 
286
+ # @deprecated
287
+ #
276
288
  # Identifier for service connectors, like those available in ChatGPT. One of
277
289
  # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
278
290
  # service connectors
279
291
  # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
280
292
  #
293
+ # This field is deprecated for models released after September 1, 2026. Use
294
+ # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
295
+ # through a Secure MCP Tunnel.
296
+ #
281
297
  # Currently supported `connector_id` values are:
282
298
  #
283
299
  # - Dropbox: `connector_dropbox`
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ # @see OpenAI::Resources::Webhooks#delete
7
+ class DeletedWebhookEndpoint < OpenAI::Internal::Type::BaseModel
8
+ # @!attribute id
9
+ # The ID of the deleted webhook endpoint.
10
+ #
11
+ # @return [String]
12
+ required :id, String
13
+
14
+ # @!attribute deleted
15
+ # Whether the endpoint was deleted.
16
+ #
17
+ # @return [Boolean]
18
+ required :deleted, OpenAI::Internal::Type::Boolean
19
+
20
+ # @!attribute object
21
+ # The object type, which is always webhook_endpoint.deleted.
22
+ #
23
+ # @return [Symbol, :"webhook_endpoint.deleted"]
24
+ required :object, const: :"webhook_endpoint.deleted"
25
+
26
+ # @!method initialize(id:, deleted:, object: :"webhook_endpoint.deleted")
27
+ # @param id [String]
28
+ # The ID of the deleted webhook endpoint.
29
+ #
30
+ # @param deleted [Boolean]
31
+ # Whether the endpoint was deleted.
32
+ #
33
+ # @param object [Symbol, :"webhook_endpoint.deleted"]
34
+ # The object type, which is always webhook_endpoint.deleted.
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ # @see OpenAI::Resources::Webhooks::EventTypes#list
7
+ class EventTypeListParams < OpenAI::Internal::Type::BaseModel
8
+ extend OpenAI::Internal::Type::RequestParameters::Converter
9
+ include OpenAI::Internal::Type::RequestParameters
10
+
11
+ # @!method initialize(request_options: {})
12
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
13
+ end
14
+ end
15
+ end
16
+ end
@@ -57,10 +57,9 @@ module OpenAI
57
57
  # @see OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent#data
58
58
  class Data < OpenAI::Internal::Type::BaseModel
59
59
  # @!attribute call_id
60
- # The Transceiver `rtc_...` ID of the pending SIP session. The paired
61
- # `live.transport.incoming` event derives its `session_id` by replacing the `rtc_`
62
- # prefix with `live_`. Use the ID returned by the event with the corresponding
63
- # Realtime or Live API.
60
+ # The ID of the pending SIP call. Pass this value unchanged when accepting or
61
+ # rejecting the call through the Realtime API. For the Live API, use the
62
+ # `session_id` from `live.transport.incoming` instead.
64
63
  #
65
64
  # @return [String]
66
65
  required :call_id, String
@@ -80,10 +79,9 @@ module OpenAI
80
79
  # Event data payload.
81
80
  #
82
81
  # @param call_id [String]
83
- # The Transceiver `rtc_...` ID of the pending SIP session. The paired
84
- # `live.transport.incoming` event derives its `session_id` by replacing the `rtc_`
85
- # prefix with `live_`. Use the ID returned by the event with the corresponding
86
- # Realtime or Live API.
82
+ # The ID of the pending SIP call. Pass this value unchanged when accepting or
83
+ # rejecting the call through the Realtime API. For the Live API, use the
84
+ # `session_id` from `live.transport.incoming` instead.
87
85
  #
88
86
  # @param sip_headers [Array<OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader>]
89
87
  # Headers from the SIP INVITE, excluding SIP authorization headers. Retained
@@ -0,0 +1,73 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Webhooks
6
+ # @see OpenAI::Resources::Webhooks#create
7
+ class WebhookCreateParams < OpenAI::Internal::Type::BaseModel
8
+ extend OpenAI::Internal::Type::RequestParameters::Converter
9
+ include OpenAI::Internal::Type::RequestParameters
10
+
11
+ # @!attribute event_types
12
+ # The event types that trigger deliveries to this endpoint.
13
+ #
14
+ # @return [Array<Symbol, OpenAI::Models::Webhooks::WebhookCreateParams::EventType>]
15
+ required(
16
+ :event_types,
17
+ -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Webhooks::WebhookCreateParams::EventType] }
18
+ )
19
+
20
+ # @!attribute name
21
+ # A human-readable name for the webhook endpoint.
22
+ #
23
+ # @return [String]
24
+ required :name, String
25
+
26
+ # @!attribute url
27
+ # The HTTPS URL that receives webhook deliveries.
28
+ #
29
+ # @return [String]
30
+ required :url, String
31
+
32
+ # @!method initialize(event_types:, name:, url:, request_options: {})
33
+ # @param event_types [Array<Symbol, OpenAI::Models::Webhooks::WebhookCreateParams::EventType>]
34
+ # The event types that trigger deliveries to this endpoint.
35
+ #
36
+ # @param name [String]
37
+ # A human-readable name for the webhook endpoint.
38
+ #
39
+ # @param url [String]
40
+ # The HTTPS URL that receives webhook deliveries.
41
+ #
42
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
43
+
44
+ # The event type to send as a sample delivery.
45
+ module EventType
46
+ extend OpenAI::Internal::Type::Enum
47
+
48
+ BATCH_COMPLETED = :"batch.completed"
49
+ BATCH_FAILED = :"batch.failed"
50
+ BATCH_EXPIRED = :"batch.expired"
51
+ BATCH_CANCELLED = :"batch.cancelled"
52
+ RESPONSE_COMPLETED = :"response.completed"
53
+ RESPONSE_FAILED = :"response.failed"
54
+ RESPONSE_CANCELLED = :"response.cancelled"
55
+ RESPONSE_INCOMPLETE = :"response.incomplete"
56
+ EVAL_RUN_SUCCEEDED = :"eval.run.succeeded"
57
+ EVAL_RUN_FAILED = :"eval.run.failed"
58
+ EVAL_RUN_CANCELED = :"eval.run.canceled"
59
+ FINE_TUNING_JOB_SUCCEEDED = :"fine_tuning.job.succeeded"
60
+ FINE_TUNING_JOB_FAILED = :"fine_tuning.job.failed"
61
+ FINE_TUNING_JOB_CANCELLED = :"fine_tuning.job.cancelled"
62
+ REALTIME_CALL_INCOMING = :"realtime.call.incoming"
63
+ VIDEO_COMPLETED = :"video.completed"
64
+ VIDEO_FAILED = :"video.failed"
65
+ SAFETY_ALERT_CREATED = :"safety.alert.created"
66
+
67
+ # @!method self.values
68
+ # @return [Array<Symbol>]
69
+ end
70
+ end
71
+ end
72
+ end
73
+ end