openai 0.125.0 → 0.127.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 (54) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/openai/helpers/agents/session_stream.rb +3 -0
  5. data/lib/openai/helpers/beta/agents/result.rb +5 -0
  6. data/lib/openai/models/all_models.rb +1 -0
  7. data/lib/openai/models/beta/agent_session.rb +17 -11
  8. data/lib/openai/models/beta/agent_session_budget_reached_event.rb +48 -0
  9. data/lib/openai/models/beta/agent_session_event.rb +4 -1
  10. data/lib/openai/models/beta/beta_response.rb +9 -0
  11. data/lib/openai/models/beta/beta_responses_client_event.rb +76 -1
  12. data/lib/openai/models/beta/response_compact_params.rb +9 -0
  13. data/lib/openai/models/beta/response_create_params.rb +70 -1
  14. data/lib/openai/models/chat_model.rb +2 -0
  15. data/lib/openai/models/responses/response_compact_params.rb +9 -0
  16. data/lib/openai/models/responses/response_create_params.rb +61 -1
  17. data/lib/openai/models/responses/responses_client_event.rb +65 -1
  18. data/lib/openai/models/responses_model.rb +1 -0
  19. data/lib/openai/resources/beta/agents/sessions/events.rb +1 -1
  20. data/lib/openai/resources/beta/responses.rb +12 -2
  21. data/lib/openai/resources/responses.rb +12 -2
  22. data/lib/openai/version.rb +1 -1
  23. data/lib/openai.rb +1 -0
  24. data/rbi/openai/models/all_models.rbi +1 -0
  25. data/rbi/openai/models/beta/agent_session.rbi +17 -11
  26. data/rbi/openai/models/beta/agent_session_budget_reached_event.rbi +83 -0
  27. data/rbi/openai/models/beta/agent_session_event.rbi +1 -0
  28. data/rbi/openai/models/beta/beta_response.rbi +3 -0
  29. data/rbi/openai/models/beta/beta_responses_client_event.rbi +145 -0
  30. data/rbi/openai/models/beta/response_compact_params.rbi +3 -0
  31. data/rbi/openai/models/beta/response_create_params.rbi +116 -0
  32. data/rbi/openai/models/chat_model.rbi +2 -0
  33. data/rbi/openai/models/responses/response_compact_params.rbi +3 -0
  34. data/rbi/openai/models/responses/response_create_params.rbi +117 -0
  35. data/rbi/openai/models/responses/responses_client_event.rbi +135 -0
  36. data/rbi/openai/models/responses_model.rbi +1 -0
  37. data/rbi/openai/resources/beta/responses.rbi +10 -0
  38. data/rbi/openai/resources/responses.rbi +12 -0
  39. data/sig/openai/models/all_models.rbs +2 -0
  40. data/sig/openai/models/beta/agent_session.rbs +20 -13
  41. data/sig/openai/models/beta/agent_session_budget_reached_event.rbs +52 -0
  42. data/sig/openai/models/beta/agent_session_event.rbs +1 -0
  43. data/sig/openai/models/beta/beta_response.rbs +6 -0
  44. data/sig/openai/models/beta/beta_responses_client_event.rbs +79 -0
  45. data/sig/openai/models/beta/response_compact_params.rbs +6 -0
  46. data/sig/openai/models/beta/response_create_params.rbs +79 -0
  47. data/sig/openai/models/chat_model.rbs +4 -0
  48. data/sig/openai/models/responses/response_compact_params.rbs +6 -0
  49. data/sig/openai/models/responses/response_create_params.rbs +73 -0
  50. data/sig/openai/models/responses/responses_client_event.rbs +73 -0
  51. data/sig/openai/models/responses_model.rbs +2 -0
  52. data/sig/openai/resources/beta/responses.rbs +2 -0
  53. data/sig/openai/resources/responses.rbs +3 -0
  54. metadata +4 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b5cd2a7ee337aebf6fbf11cdeb052a2851dfadc9fcefb7b0ca6bf84b2a8c68e5
4
- data.tar.gz: f9f4fd6019c8dbc2822f739df88cb57ae01fa66b081d4bbe571676a2eec79734
3
+ metadata.gz: 03bcbe3bb37e1209bf9bdc0234e2a00f68a9db978a030437f2640e4c04eaaa4c
4
+ data.tar.gz: ae345a47832b80737f53c46b8bab5364d0f7da377979f4f7e3ad9a07ab4e834d
5
5
  SHA512:
6
- metadata.gz: fa3c1a6bcb6ba2982c9cadd983bc61b96975b13b11a9a4661be125c1f4affc75e14de83daadcb0f33d23b4f629523994d3db7cc0a85f5e755846419a6f1fbfe4
7
- data.tar.gz: 674c65a1a2a2f725082597dbd96bb9114d6375a74dcd14761697c2ba1330fb8c25450e78973eec380f5cf3cb6896b8bd8d5436236d366e7484bb5501f71fecdc
6
+ metadata.gz: 5ae82c1ecad7eef2877c3d49e55629c621bfa0fdab9b31b674bc43ff254e205b9a9011b4ab7f79b6058891f1f78efeb11be094821ddae9ded3a830a7cf033ab2
7
+ data.tar.gz: a02c70fe86e35e418c63088f2a7b5df0ed7457bd3b7a1726eb2744cb1700b70eccda83757a122934cf594e013c927eda742b785a9bb82f9dbbc0174974da4fad
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.127.0](https://github.com/openai/openai-ruby/compare/v0.126.0...v0.127.0) (2026-11-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** type Managed Agents budget events ([#1074](https://github.com/openai/openai-ruby/issues/1074)) ([a8eaf26](https://github.com/openai/openai-ruby/commit/a8eaf268613fa16e351b3dc1afce98a3e34b4e73))
9
+
10
+ ## [0.126.0](https://github.com/openai/openai-ruby/compare/v0.125.0...v0.126.0) (2026-11-17)
11
+
12
+
13
+ ### Features
14
+
15
+ * **api:** add 2-hour and 8-hour Responses background windows ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
16
+ * **api:** add the GPT-6.2 Astra Law Responses model identifier ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
17
+ * **api:** add the GPT-6.2 Astra model identifier ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
18
+ * **api:** add the GPT-6.2 Sol model identifier ([bf79adf](https://github.com/openai/openai-ruby/commit/bf79adf60b8fb1a529fc261fa7c23dcc50673ff0))
19
+
3
20
  ## [0.125.0](https://github.com/openai/openai-ruby/compare/v0.124.0...v0.125.0) (2026-11-16)
4
21
 
5
22
 
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "openai", "~> 0.125.0"
18
+ gem "openai", "~> 0.127.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -160,6 +160,9 @@ module OpenAI
160
160
  end
161
161
 
162
162
  terminal = event.type == :"agent.session.failed" ||
163
+ (event.type == :"agent.session.budget_reached" &&
164
+ event.session.id == @session_id &&
165
+ (@turn_id.nil? || @turn_ended)) ||
163
166
  (event.type == :"agent.session.idle" && @turn_ended)
164
167
  invocation = @dispatcher.prepare_call(event) unless terminal
165
168
  close if terminal
@@ -74,6 +74,8 @@ module OpenAI
74
74
  case event.type
75
75
  when :"agent.session.created"
76
76
  @session_id ||= event.session.id.dup
77
+ when :error
78
+ @session_id ||= event.session_id.dup
77
79
  when :"agent.session.turn.created"
78
80
  if @turn.nil? && event.turn.subagent_id.nil? && (@session_id.nil? || event.session_id == @session_id)
79
81
  @turn = copy(event.turn)
@@ -112,6 +114,9 @@ module OpenAI
112
114
  @required_actions = [] if event.session.id == @session_id
113
115
  when :"agent.session.idle"
114
116
  @finished = true if @terminal && event.session.id == @session_id
117
+ when :"agent.session.budget_reached"
118
+ @session_id ||= event.session.id.dup
119
+ @finished = true if (@turn.nil? || @terminal) && event.session.id == @session_id
115
120
  when :"agent.session.failed"
116
121
  @session_id ||= event.session.id.dup
117
122
  @failure = :failed
@@ -78,6 +78,7 @@ module OpenAI
78
78
  GPT_6_CYBER = :"gpt-6-cyber"
79
79
  GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
80
80
  GPT_6_ROSALIND = :"gpt-6-rosalind"
81
+ GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
81
82
 
82
83
  # @!method self.values
83
84
  # @return [Array<Symbol>]
@@ -94,8 +94,9 @@ module OpenAI
94
94
  optional :review, enum: -> { OpenAI::Beta::AgentSession::Review }
95
95
 
96
96
  # @!attribute spend_control
97
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
98
- # sessions omit this object.
97
+ # Spending limit and best-effort consumption, in USD cents. Present when
98
+ # spending-control visibility is enabled; limit is null without a cap. Older
99
+ # server responses may omit this object.
99
100
  #
100
101
  # @return [OpenAI::Models::Beta::AgentSession::SpendControl, nil]
101
102
  optional :spend_control, -> { OpenAI::Beta::AgentSession::SpendControl }
@@ -145,8 +146,9 @@ module OpenAI
145
146
  # and automatic review is not enabled. Omission means none.
146
147
  #
147
148
  # @param spend_control [OpenAI::Models::Beta::AgentSession::SpendControl]
148
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
149
- # sessions omit this object.
149
+ # Spending limit and best-effort consumption, in USD cents. Present when
150
+ # spending-control visibility is enabled; limit is null without a cap. Older
151
+ # server responses may omit this object.
150
152
  #
151
153
  # @param object [Symbol, :"agent.session"]
152
154
  # The object type. Always `agent.session`.
@@ -749,6 +751,9 @@ module OpenAI
749
751
  # The session failed.
750
752
  FAILED = :failed
751
753
 
754
+ # The session is paused because its spending limit was reached.
755
+ BUDGET_REACHED = :budget_reached
756
+
752
757
  # @!method self.values
753
758
  # @return [Array<Symbol>]
754
759
  end
@@ -800,20 +805,21 @@ module OpenAI
800
805
  required :consumed, Integer, nil?: true
801
806
 
802
807
  # @!attribute limit
803
- # The configured positive limit in USD cents.
808
+ # The configured positive limit in USD cents, or null when unlimited.
804
809
  #
805
- # @return [Integer]
806
- required :limit, Integer
810
+ # @return [Integer, nil]
811
+ required :limit, Integer, nil?: true
807
812
 
808
813
  # @!method initialize(consumed:, limit:)
809
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
810
- # sessions omit this object.
814
+ # Spending limit and best-effort consumption, in USD cents. Present when
815
+ # spending-control visibility is enabled; limit is null without a cap. Older
816
+ # server responses may omit this object.
811
817
  #
812
818
  # @param consumed [Integer, nil]
813
819
  # Best-effort recorded spend floored to whole USD cents, or null when unavailable.
814
820
  #
815
- # @param limit [Integer]
816
- # The configured positive limit in USD cents.
821
+ # @param limit [Integer, nil]
822
+ # The configured positive limit in USD cents, or null when unlimited.
817
823
  end
818
824
  end
819
825
  end
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ module Beta
6
+ class AgentSessionBudgetReachedEvent < OpenAI::Internal::Type::BaseModel
7
+ # @!attribute event_id
8
+ # The unique ID of the event.
9
+ #
10
+ # @return [String]
11
+ required :event_id, String
12
+
13
+ # @!attribute session
14
+ # The paused session.
15
+ #
16
+ # @return [OpenAI::Models::Beta::AgentSession]
17
+ required :session, -> { OpenAI::Beta::AgentSession }
18
+
19
+ # @!attribute type
20
+ # The type of the object. Always `agent.session.budget_reached`.
21
+ #
22
+ # @return [Symbol, :"agent.session.budget_reached"]
23
+ required :type, const: :"agent.session.budget_reached"
24
+
25
+ # @!attribute obfuscation
26
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
27
+ #
28
+ # @return [String, nil]
29
+ optional :obfuscation, String
30
+
31
+ # @!method initialize(event_id:, session:, obfuscation: nil, type: :"agent.session.budget_reached")
32
+ # Emitted when a session pauses because its spending limit was reached.
33
+ #
34
+ # @param event_id [String]
35
+ # The unique ID of the event.
36
+ #
37
+ # @param session [OpenAI::Models::Beta::AgentSession]
38
+ # The paused session.
39
+ #
40
+ # @param obfuscation [String]
41
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
42
+ #
43
+ # @param type [Symbol, :"agent.session.budget_reached"]
44
+ # The type of the object. Always `agent.session.budget_reached`.
45
+ end
46
+ end
47
+ end
48
+ end
@@ -54,6 +54,9 @@ module OpenAI
54
54
  # Emitted when a session becomes idle.
55
55
  variant :"agent.session.idle", -> { OpenAI::Beta::AgentSessionIdleEvent }
56
56
 
57
+ # Emitted when a session pauses because its spending limit was reached.
58
+ variant :"agent.session.budget_reached", -> { OpenAI::Beta::AgentSessionBudgetReachedEvent }
59
+
57
60
  # Emitted when a session starts processing a turn.
58
61
  variant :"agent.session.in_progress", -> { OpenAI::Beta::AgentSessionInProgressEvent }
59
62
 
@@ -130,7 +133,7 @@ module OpenAI
130
133
  )
131
134
 
132
135
  # @!method self.variants
133
- # @return [Array(OpenAI::Models::Beta::AgentSessionErrorEvent, OpenAI::Models::Beta::AgentSessionEnvironmentReadyEvent, OpenAI::Models::Beta::AgentSessionEnvironmentSuspendedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentExpiredEvent, OpenAI::Models::Beta::AgentSessionEnvironmentResetEvent, OpenAI::Models::Beta::AgentOutputCommandExecutionOutputDeltaEvent, OpenAI::Models::Beta::AgentSessionCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnInProgressEvent, OpenAI::Models::Beta::AgentSessionTurnCompletedEvent, OpenAI::Models::Beta::AgentSessionTurnFailedEvent, OpenAI::Models::Beta::AgentSessionTurnCancelledEvent, OpenAI::Models::Beta::AgentSessionTurnItemAddedEvent, OpenAI::Models::Beta::AgentSessionIdleEvent, OpenAI::Models::Beta::AgentSessionInProgressEvent, OpenAI::Models::Beta::AgentSessionRequiresActionEvent, OpenAI::Models::Beta::AgentSessionFailedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentPendingEvent, OpenAI::Models::Beta::AgentSessionEnvironmentConnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentDisconnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentFailedEvent, OpenAI::Models::Beta::AgentSessionSubagentCreatedEvent, OpenAI::Models::Beta::AgentSessionSubagentActiveEvent, OpenAI::Models::Beta::AgentSessionSubagentClosedEvent, OpenAI::Models::Beta::AgentSessionTurnItemDoneEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent)]
136
+ # @return [Array(OpenAI::Models::Beta::AgentSessionErrorEvent, OpenAI::Models::Beta::AgentSessionEnvironmentReadyEvent, OpenAI::Models::Beta::AgentSessionEnvironmentSuspendedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentExpiredEvent, OpenAI::Models::Beta::AgentSessionEnvironmentResetEvent, OpenAI::Models::Beta::AgentOutputCommandExecutionOutputDeltaEvent, OpenAI::Models::Beta::AgentSessionCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnInProgressEvent, OpenAI::Models::Beta::AgentSessionTurnCompletedEvent, OpenAI::Models::Beta::AgentSessionTurnFailedEvent, OpenAI::Models::Beta::AgentSessionTurnCancelledEvent, OpenAI::Models::Beta::AgentSessionTurnItemAddedEvent, OpenAI::Models::Beta::AgentSessionIdleEvent, OpenAI::Models::Beta::AgentSessionBudgetReachedEvent, OpenAI::Models::Beta::AgentSessionInProgressEvent, OpenAI::Models::Beta::AgentSessionRequiresActionEvent, OpenAI::Models::Beta::AgentSessionFailedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentPendingEvent, OpenAI::Models::Beta::AgentSessionEnvironmentConnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentDisconnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentFailedEvent, OpenAI::Models::Beta::AgentSessionSubagentCreatedEvent, OpenAI::Models::Beta::AgentSessionSubagentActiveEvent, OpenAI::Models::Beta::AgentSessionSubagentClosedEvent, OpenAI::Models::Beta::AgentSessionTurnItemDoneEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent)]
134
137
  end
135
138
  end
136
139
  end
@@ -750,8 +750,12 @@ module OpenAI
750
750
 
751
751
  variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_ASTRA }
752
752
 
753
+ variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_2_ASTRA }
754
+
753
755
  variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_1_SOL }
754
756
 
757
+ variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_2_SOL }
758
+
755
759
  variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_1_TERRA }
756
760
 
757
761
  variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_SOL }
@@ -970,6 +974,8 @@ module OpenAI
970
974
 
971
975
  variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_ROSALIND_RESEARCH }
972
976
 
977
+ variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_2_ASTRA_LAW }
978
+
973
979
  variant String
974
980
 
975
981
  # @!method self.variants
@@ -982,7 +988,9 @@ module OpenAI
982
988
  # @!group
983
989
 
984
990
  GPT_6_ASTRA = :"gpt-6-astra"
991
+ GPT_6_2_ASTRA = :"gpt-6.2-astra"
985
992
  GPT_6_1_SOL = :"gpt-6.1-sol"
993
+ GPT_6_2_SOL = :"gpt-6.2-sol"
986
994
  GPT_6_1_TERRA = :"gpt-6.1-terra"
987
995
  GPT_6_SOL = :"gpt-6-sol"
988
996
  GPT_6_LUNA = :"gpt-6-luna"
@@ -1351,6 +1359,7 @@ module OpenAI
1351
1359
  GPT_5_6_CYBER = :"gpt-5.6-cyber"
1352
1360
  GPT_6_CYBER = :"gpt-6-cyber"
1353
1361
  GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
1362
+ GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
1354
1363
 
1355
1364
  # @!endgroup
1356
1365
  end
@@ -74,6 +74,17 @@ module OpenAI
74
74
  # @return [Boolean, nil]
75
75
  optional :background, OpenAI::Internal::Type::Boolean, nil?: true
76
76
 
77
+ # @!attribute background_options
78
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
79
+ # windows require `background: true`, Standard processing, and `stream: false` or
80
+ # omitted.
81
+ #
82
+ # @return [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions, nil]
83
+ optional(
84
+ :background_options,
85
+ -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions }
86
+ )
87
+
77
88
  # @!attribute context_management
78
89
  # Context management configuration for this request.
79
90
  #
@@ -498,7 +509,7 @@ module OpenAI
498
509
  # @return [String, nil]
499
510
  optional :user, String
500
511
 
501
- # @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, generate: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
512
+ # @!method initialize(access_programs: nil, background: nil, background_options: nil, context_management: nil, conversation: nil, generate: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
502
513
  # Client event for creating a response over a persistent WebSocket connection.
503
514
  # This payload uses the same top-level fields as `POST /v1/responses`, plus
504
515
  # WebSocket-only envelope metadata.
@@ -516,6 +527,11 @@ module OpenAI
516
527
  # Whether to run the model response in the background.
517
528
  # [Learn more](https://developers.openai.com/api/docs/guides/background).
518
529
  #
530
+ # @param background_options [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions]
531
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
532
+ # windows require `background: true`, Standard processing, and `stream: false` or
533
+ # omitted.
534
+ #
519
535
  # @param context_management [Array<OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::ContextManagement>, nil]
520
536
  # Context management configuration for this request.
521
537
  #
@@ -847,6 +863,54 @@ module OpenAI
847
863
  end
848
864
  end
849
865
 
866
+ # @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate#background_options
867
+ class BackgroundOptions < OpenAI::Internal::Type::BaseModel
868
+ # @!attribute completion_window
869
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
870
+ # `8h` select discounted background execution.
871
+ #
872
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow, nil]
873
+ optional(
874
+ :completion_window,
875
+ enum: -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow }
876
+ )
877
+
878
+ # @!attribute continuation_id
879
+ # A customer-provided opaque identifier used to prioritize related background
880
+ # requests. It does not add prior history to the input.
881
+ #
882
+ # @return [String, nil]
883
+ optional :continuation_id, String
884
+
885
+ # @!method initialize(completion_window: nil, continuation_id: nil)
886
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
887
+ # windows require `background: true`, Standard processing, and `stream: false` or
888
+ # omitted.
889
+ #
890
+ # @param completion_window [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions::CompletionWindow]
891
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
892
+ # `8h` select discounted background execution.
893
+ #
894
+ # @param continuation_id [String]
895
+ # A customer-provided opaque identifier used to prioritize related background
896
+ # requests. It does not add prior history to the input.
897
+
898
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
899
+ # `8h` select discounted background execution.
900
+ #
901
+ # @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::BackgroundOptions#completion_window
902
+ module CompletionWindow
903
+ extend OpenAI::Internal::Type::Enum
904
+
905
+ SOONEST = :soonest
906
+ COMPLETION_WINDOW_2H = :"2h"
907
+ COMPLETION_WINDOW_8H = :"8h"
908
+
909
+ # @!method self.values
910
+ # @return [Array<Symbol>]
911
+ end
912
+ end
913
+
850
914
  class ContextManagement < OpenAI::Internal::Type::BaseModel
851
915
  # @!attribute type
852
916
  # The context management entry type. Currently only 'compaction' is supported.
@@ -963,8 +1027,12 @@ module OpenAI
963
1027
 
964
1028
  variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_ASTRA }
965
1029
 
1030
+ variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_2_ASTRA }
1031
+
966
1032
  variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_1_SOL }
967
1033
 
1034
+ variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_2_SOL }
1035
+
968
1036
  variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_1_TERRA }
969
1037
 
970
1038
  variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_SOL }
@@ -1367,6 +1435,10 @@ module OpenAI
1367
1435
 
1368
1436
  variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_ROSALIND }
1369
1437
 
1438
+ variant(
1439
+ const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_6_2_ASTRA_LAW }
1440
+ )
1441
+
1370
1442
  variant String
1371
1443
 
1372
1444
  # @!method self.variants
@@ -1381,7 +1453,9 @@ module OpenAI
1381
1453
  # @!group
1382
1454
 
1383
1455
  GPT_6_ASTRA = :"gpt-6-astra"
1456
+ GPT_6_2_ASTRA = :"gpt-6.2-astra"
1384
1457
  GPT_6_1_SOL = :"gpt-6.1-sol"
1458
+ GPT_6_2_SOL = :"gpt-6.2-sol"
1385
1459
  GPT_6_1_TERRA = :"gpt-6.1-terra"
1386
1460
  GPT_6_SOL = :"gpt-6-sol"
1387
1461
  GPT_6_LUNA = :"gpt-6-luna"
@@ -1751,6 +1825,7 @@ module OpenAI
1751
1825
  GPT_6_CYBER = :"gpt-6-cyber"
1752
1826
  GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
1753
1827
  GPT_6_ROSALIND = :"gpt-6-rosalind"
1828
+ GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
1754
1829
 
1755
1830
  # @!endgroup
1756
1831
  end
@@ -189,8 +189,12 @@ module OpenAI
189
189
 
190
190
  variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_ASTRA }
191
191
 
192
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_2_ASTRA }
193
+
192
194
  variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_1_SOL }
193
195
 
196
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_2_SOL }
197
+
194
198
  variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_1_TERRA }
195
199
 
196
200
  variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_SOL }
@@ -415,6 +419,8 @@ module OpenAI
415
419
 
416
420
  variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_ROSALIND }
417
421
 
422
+ variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_6_2_ASTRA_LAW }
423
+
418
424
  variant String
419
425
 
420
426
  # @!method self.variants
@@ -427,7 +433,9 @@ module OpenAI
427
433
  # @!group
428
434
 
429
435
  GPT_6_ASTRA = :"gpt-6-astra"
436
+ GPT_6_2_ASTRA = :"gpt-6.2-astra"
430
437
  GPT_6_1_SOL = :"gpt-6.1-sol"
438
+ GPT_6_2_SOL = :"gpt-6.2-sol"
431
439
  GPT_6_1_TERRA = :"gpt-6.1-terra"
432
440
  GPT_6_SOL = :"gpt-6-sol"
433
441
  GPT_6_LUNA = :"gpt-6-luna"
@@ -797,6 +805,7 @@ module OpenAI
797
805
  GPT_6_CYBER = :"gpt-6-cyber"
798
806
  GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
799
807
  GPT_6_ROSALIND = :"gpt-6-rosalind"
808
+ GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
800
809
 
801
810
  # @!endgroup
802
811
  end
@@ -23,6 +23,14 @@ module OpenAI
23
23
  # @return [Boolean, nil]
24
24
  optional :background, OpenAI::Internal::Type::Boolean, nil?: true
25
25
 
26
+ # @!attribute background_options
27
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
28
+ # windows require `background: true`, Standard processing, and `stream: false` or
29
+ # omitted.
30
+ #
31
+ # @return [OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions, nil]
32
+ optional :background_options, -> { OpenAI::Beta::ResponseCreateParams::BackgroundOptions }
33
+
26
34
  # @!attribute context_management
27
35
  # Context management configuration for this request.
28
36
  #
@@ -390,7 +398,7 @@ module OpenAI
390
398
  # @return [Array<Symbol, OpenAI::Models::Beta::ResponseCreateParams::Beta>, nil]
391
399
  optional :betas, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::ResponseCreateParams::Beta] }
392
400
 
393
- # @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, betas: nil, request_options: {})
401
+ # @!method initialize(access_programs: nil, background: nil, background_options: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, betas: nil, request_options: {})
394
402
  # @param access_programs [OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms]
395
403
  # Domain-specific access programs to use for this request.
396
404
  #
@@ -398,6 +406,11 @@ module OpenAI
398
406
  # Whether to run the model response in the background.
399
407
  # [Learn more](https://developers.openai.com/api/docs/guides/background).
400
408
  #
409
+ # @param background_options [OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions]
410
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
411
+ # windows require `background: true`, Standard processing, and `stream: false` or
412
+ # omitted.
413
+ #
401
414
  # @param context_management [Array<OpenAI::Models::Beta::ResponseCreateParams::ContextManagement>, nil]
402
415
  # Context management configuration for this request.
403
416
  #
@@ -706,6 +719,53 @@ module OpenAI
706
719
  end
707
720
  end
708
721
 
722
+ class BackgroundOptions < OpenAI::Internal::Type::BaseModel
723
+ # @!attribute completion_window
724
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
725
+ # `8h` select discounted background execution.
726
+ #
727
+ # @return [Symbol, OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions::CompletionWindow, nil]
728
+ optional(
729
+ :completion_window,
730
+ enum: -> { OpenAI::Beta::ResponseCreateParams::BackgroundOptions::CompletionWindow }
731
+ )
732
+
733
+ # @!attribute continuation_id
734
+ # A customer-provided opaque identifier used to prioritize related background
735
+ # requests. It does not add prior history to the input.
736
+ #
737
+ # @return [String, nil]
738
+ optional :continuation_id, String
739
+
740
+ # @!method initialize(completion_window: nil, continuation_id: nil)
741
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
742
+ # windows require `background: true`, Standard processing, and `stream: false` or
743
+ # omitted.
744
+ #
745
+ # @param completion_window [Symbol, OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions::CompletionWindow]
746
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
747
+ # `8h` select discounted background execution.
748
+ #
749
+ # @param continuation_id [String]
750
+ # A customer-provided opaque identifier used to prioritize related background
751
+ # requests. It does not add prior history to the input.
752
+
753
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
754
+ # `8h` select discounted background execution.
755
+ #
756
+ # @see OpenAI::Models::Beta::ResponseCreateParams::BackgroundOptions#completion_window
757
+ module CompletionWindow
758
+ extend OpenAI::Internal::Type::Enum
759
+
760
+ SOONEST = :soonest
761
+ COMPLETION_WINDOW_2H = :"2h"
762
+ COMPLETION_WINDOW_8H = :"8h"
763
+
764
+ # @!method self.values
765
+ # @return [Array<Symbol>]
766
+ end
767
+ end
768
+
709
769
  class ContextManagement < OpenAI::Internal::Type::BaseModel
710
770
  # @!attribute type
711
771
  # The context management entry type. Currently only 'compaction' is supported.
@@ -812,8 +872,12 @@ module OpenAI
812
872
 
813
873
  variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_ASTRA }
814
874
 
875
+ variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_2_ASTRA }
876
+
815
877
  variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_1_SOL }
816
878
 
879
+ variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_2_SOL }
880
+
817
881
  variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_1_TERRA }
818
882
 
819
883
  variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_SOL }
@@ -1036,6 +1100,8 @@ module OpenAI
1036
1100
 
1037
1101
  variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_ROSALIND }
1038
1102
 
1103
+ variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_6_2_ASTRA_LAW }
1104
+
1039
1105
  variant String
1040
1106
 
1041
1107
  # @!method self.variants
@@ -1048,7 +1114,9 @@ module OpenAI
1048
1114
  # @!group
1049
1115
 
1050
1116
  GPT_6_ASTRA = :"gpt-6-astra"
1117
+ GPT_6_2_ASTRA = :"gpt-6.2-astra"
1051
1118
  GPT_6_1_SOL = :"gpt-6.1-sol"
1119
+ GPT_6_2_SOL = :"gpt-6.2-sol"
1052
1120
  GPT_6_1_TERRA = :"gpt-6.1-terra"
1053
1121
  GPT_6_SOL = :"gpt-6-sol"
1054
1122
  GPT_6_LUNA = :"gpt-6-luna"
@@ -1418,6 +1486,7 @@ module OpenAI
1418
1486
  GPT_6_CYBER = :"gpt-6-cyber"
1419
1487
  GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
1420
1488
  GPT_6_ROSALIND = :"gpt-6-rosalind"
1489
+ GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
1421
1490
 
1422
1491
  # @!endgroup
1423
1492
  end
@@ -6,7 +6,9 @@ module OpenAI
6
6
  extend OpenAI::Internal::Type::Enum
7
7
 
8
8
  GPT_6_ASTRA = :"gpt-6-astra"
9
+ GPT_6_2_ASTRA = :"gpt-6.2-astra"
9
10
  GPT_6_1_SOL = :"gpt-6.1-sol"
11
+ GPT_6_2_SOL = :"gpt-6.2-sol"
10
12
  GPT_6_1_TERRA = :"gpt-6.1-terra"
11
13
  GPT_6_SOL = :"gpt-6-sol"
12
14
  GPT_6_LUNA = :"gpt-6-luna"
@@ -180,8 +180,12 @@ module OpenAI
180
180
 
181
181
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_ASTRA }
182
182
 
183
+ variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_2_ASTRA }
184
+
183
185
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_1_SOL }
184
186
 
187
+ variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_2_SOL }
188
+
185
189
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_1_TERRA }
186
190
 
187
191
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_SOL }
@@ -420,6 +424,8 @@ module OpenAI
420
424
 
421
425
  variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_ROSALIND }
422
426
 
427
+ variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_2_ASTRA_LAW }
428
+
423
429
  variant String
424
430
 
425
431
  # @!method self.variants
@@ -432,7 +438,9 @@ module OpenAI
432
438
  # @!group
433
439
 
434
440
  GPT_6_ASTRA = :"gpt-6-astra"
441
+ GPT_6_2_ASTRA = :"gpt-6.2-astra"
435
442
  GPT_6_1_SOL = :"gpt-6.1-sol"
443
+ GPT_6_2_SOL = :"gpt-6.2-sol"
436
444
  GPT_6_1_TERRA = :"gpt-6.1-terra"
437
445
  GPT_6_SOL = :"gpt-6-sol"
438
446
  GPT_6_LUNA = :"gpt-6-luna"
@@ -802,6 +810,7 @@ module OpenAI
802
810
  GPT_6_CYBER = :"gpt-6-cyber"
803
811
  GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
804
812
  GPT_6_ROSALIND = :"gpt-6-rosalind"
813
+ GPT_6_2_ASTRA_LAW = :"gpt-6.2-astra-law"
805
814
 
806
815
  # @!endgroup
807
816
  end