openai 0.126.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6cf2d06fc17ac7caa92c7604d9789aa070bce9371f5938d575235dd7e453ed02
4
- data.tar.gz: 8c35bc035788d11b2846612ba7b203544eaafabf962f7a6486438aba958cd9ed
3
+ metadata.gz: 03bcbe3bb37e1209bf9bdc0234e2a00f68a9db978a030437f2640e4c04eaaa4c
4
+ data.tar.gz: ae345a47832b80737f53c46b8bab5364d0f7da377979f4f7e3ad9a07ab4e834d
5
5
  SHA512:
6
- metadata.gz: 1622920a4dab1c2c238d76a5e1fa7b58e4cc326dc564a58836b6d94943bf639ed94edf1a6fc95e28b2806baf5a9ff423e819848e9e883c9013200ef9f84f682e
7
- data.tar.gz: 8631e42cf7e49bc7a9c140ddd920baf1683e72df94cda1298398bb2e5e02aca459470959675a35b724c09475994fbccac0a986b337b36183064bfc8fe83fa5c0
6
+ metadata.gz: 5ae82c1ecad7eef2877c3d49e55629c621bfa0fdab9b31b674bc43ff254e205b9a9011b4ab7f79b6058891f1f78efeb11be094821ddae9ded3a830a7cf033ab2
7
+ data.tar.gz: a02c70fe86e35e418c63088f2a7b5df0ed7457bd3b7a1726eb2744cb1700b70eccda83757a122934cf594e013c927eda742b785a9bb82f9dbbc0174974da4fad
data/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
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
+
3
10
  ## [0.126.0](https://github.com/openai/openai-ruby/compare/v0.125.0...v0.126.0) (2026-11-17)
4
11
 
5
12
 
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.126.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
@@ -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
@@ -61,7 +61,7 @@ module OpenAI
61
61
  #
62
62
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
63
63
  #
64
- # @return [OpenAI::Internal::Stream<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>]
64
+ # @return [OpenAI::Internal::Stream<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>]
65
65
  #
66
66
  # @see OpenAI::Models::Beta::Agents::Sessions::EventStreamParams
67
67
  def stream_streaming(session_id, params = {})
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module OpenAI
4
- VERSION = "0.126.0"
4
+ VERSION = "0.127.0"
5
5
  end
data/lib/openai.rb CHANGED
@@ -624,6 +624,7 @@ require_relative "openai/models/beta/agents/vault_update_params"
624
624
  require_relative "openai/models/beta/agent_send_subagent_input_call_item"
625
625
  require_relative "openai/models/beta/agent_session"
626
626
  require_relative "openai/models/beta/agent_session_assistant_message"
627
+ require_relative "openai/models/beta/agent_session_budget_reached_event"
627
628
  require_relative "openai/models/beta/agent_session_created_event"
628
629
  require_relative "openai/models/beta/agent_session_deleted"
629
630
  require_relative "openai/models/beta/agent_session_environment_connected_event"
@@ -84,8 +84,9 @@ module OpenAI
84
84
  sig { params(review: OpenAI::Beta::AgentSession::Review::OrSymbol).void }
85
85
  attr_writer :review
86
86
 
87
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
88
- # sessions omit this object.
87
+ # Spending limit and best-effort consumption, in USD cents. Present when
88
+ # spending-control visibility is enabled; limit is null without a cap. Older
89
+ # server responses may omit this object.
89
90
  sig { returns(T.nilable(OpenAI::Beta::AgentSession::SpendControl)) }
90
91
  attr_reader :spend_control
91
92
 
@@ -182,8 +183,9 @@ module OpenAI
182
183
  # and automatic review is not enabled. Omission means none.
183
184
  review: nil,
184
185
 
185
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
186
- # sessions omit this object.
186
+ # Spending limit and best-effort consumption, in USD cents. Present when
187
+ # spending-control visibility is enabled; limit is null without a cap. Older
188
+ # server responses may omit this object.
187
189
  spend_control: nil,
188
190
 
189
191
  # The object type. Always `agent.session`.
@@ -1148,6 +1150,9 @@ module OpenAI
1148
1150
  # The session failed.
1149
1151
  FAILED = T.let(:failed, OpenAI::Beta::AgentSession::Status::TaggedSymbol)
1150
1152
 
1153
+ # The session is paused because its spending limit was reached.
1154
+ BUDGET_REACHED = T.let(:budget_reached, OpenAI::Beta::AgentSession::Status::TaggedSymbol)
1155
+
1151
1156
  sig { override.returns(T::Array[OpenAI::Beta::AgentSession::Status::TaggedSymbol]) }
1152
1157
  def self.values
1153
1158
  end
@@ -1229,18 +1234,19 @@ module OpenAI
1229
1234
  sig { returns(T.nilable(Integer)) }
1230
1235
  attr_accessor :consumed
1231
1236
 
1232
- # The configured positive limit in USD cents.
1233
- sig { returns(Integer) }
1237
+ # The configured positive limit in USD cents, or null when unlimited.
1238
+ sig { returns(T.nilable(Integer)) }
1234
1239
  attr_accessor :limit
1235
1240
 
1236
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
1237
- # sessions omit this object.
1241
+ # Spending limit and best-effort consumption, in USD cents. Present when
1242
+ # spending-control visibility is enabled; limit is null without a cap. Older
1243
+ # server responses may omit this object.
1238
1244
  sig do
1239
1245
  params(
1240
1246
 
1241
1247
  consumed: T.nilable(Integer),
1242
1248
 
1243
- limit: Integer
1249
+ limit: T.nilable(Integer)
1244
1250
  )
1245
1251
  .returns(T.attached_class)
1246
1252
  end
@@ -1249,7 +1255,7 @@ module OpenAI
1249
1255
  # Best-effort recorded spend floored to whole USD cents, or null when unavailable.
1250
1256
  consumed:,
1251
1257
 
1252
- # The configured positive limit in USD cents.
1258
+ # The configured positive limit in USD cents, or null when unlimited.
1253
1259
 
1254
1260
  limit:
1255
1261
  )
@@ -1257,7 +1263,7 @@ module OpenAI
1257
1263
 
1258
1264
  sig do
1259
1265
  override.returns(
1260
- {consumed: T.nilable(Integer), limit: Integer}
1266
+ {consumed: T.nilable(Integer), limit: T.nilable(Integer)}
1261
1267
  )
1262
1268
  end
1263
1269
  def to_hash
@@ -0,0 +1,83 @@
1
+ # typed: strong
2
+
3
+ module OpenAI
4
+ module Models
5
+
6
+ module Beta
7
+
8
+ class AgentSessionBudgetReachedEvent < OpenAI::Internal::Type::BaseModel
9
+
10
+ OrHash = T.type_alias do
11
+ T.any(
12
+ OpenAI::Beta::AgentSessionBudgetReachedEvent,
13
+ OpenAI::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # The unique ID of the event.
18
+ sig { returns(String) }
19
+ attr_accessor :event_id
20
+
21
+ # The paused session.
22
+ sig { returns(OpenAI::Beta::AgentSession) }
23
+ attr_reader :session
24
+
25
+ sig { params(session: OpenAI::Beta::AgentSession::OrHash).void }
26
+ attr_writer :session
27
+
28
+ # The type of the object. Always `agent.session.budget_reached`.
29
+ sig { returns(Symbol) }
30
+ attr_accessor :type
31
+
32
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
33
+ sig { returns(T.nilable(String)) }
34
+ attr_reader :obfuscation
35
+
36
+ sig { params(obfuscation: String).void }
37
+ attr_writer :obfuscation
38
+
39
+ # Emitted when a session pauses because its spending limit was reached.
40
+ sig do
41
+ params(
42
+
43
+ event_id: String,
44
+
45
+ session: OpenAI::Beta::AgentSession::OrHash,
46
+
47
+ obfuscation: String,
48
+
49
+ type: Symbol
50
+ )
51
+ .returns(T.attached_class)
52
+ end
53
+ def self.new(
54
+
55
+ # The unique ID of the event.
56
+ event_id:,
57
+
58
+ # The paused session.
59
+ session:,
60
+
61
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
62
+ obfuscation: nil,
63
+
64
+ # The type of the object. Always `agent.session.budget_reached`.
65
+
66
+ type: :"agent.session.budget_reached"
67
+ )
68
+ end
69
+
70
+ sig do
71
+ override.returns(
72
+ {event_id: String, session: OpenAI::Beta::AgentSession, type: Symbol, obfuscation: String}
73
+ )
74
+ end
75
+ def to_hash
76
+ end
77
+
78
+ end
79
+
80
+ end
81
+
82
+ end
83
+ end
@@ -25,6 +25,7 @@ module OpenAI
25
25
  OpenAI::Beta::AgentSessionTurnCancelledEvent,
26
26
  OpenAI::Beta::AgentSessionTurnItemAddedEvent,
27
27
  OpenAI::Beta::AgentSessionIdleEvent,
28
+ OpenAI::Beta::AgentSessionBudgetReachedEvent,
28
29
  OpenAI::Beta::AgentSessionInProgressEvent,
29
30
  OpenAI::Beta::AgentSessionRequiresActionEvent,
30
31
  OpenAI::Beta::AgentSessionFailedEvent,
@@ -71,12 +71,14 @@ module OpenAI
71
71
  OpenAI::Models::Beta::AgentSession::review
72
72
  ) -> OpenAI::Models::Beta::AgentSession::review
73
73
 
74
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
75
- # sessions omit this object.
74
+ # Spending limit and best-effort consumption, in USD cents. Present when
75
+ # spending-control visibility is enabled; limit is null without a cap. Older
76
+ # server responses may omit this object.
76
77
  attr_reader spend_control: OpenAI::Beta::AgentSession::SpendControl?
77
78
 
78
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
79
- # sessions omit this object.
79
+ # Spending limit and best-effort consumption, in USD cents. Present when
80
+ # spending-control visibility is enabled; limit is null without a cap. Older
81
+ # server responses may omit this object.
80
82
  def spend_control=: (
81
83
  OpenAI::Beta::AgentSession::SpendControl
82
84
  ) -> OpenAI::Beta::AgentSession::SpendControl
@@ -110,8 +112,9 @@ module OpenAI
110
112
  # Review applied to eligible actions in this session. Omitted when review is none
111
113
  # and automatic review is not enabled. Omission means none.
112
114
  # @param spend_control
113
- # Configured spending limit and best-effort consumption, in USD cents. Unlimited
114
- # sessions omit this object.
115
+ # Spending limit and best-effort consumption, in USD cents. Present when
116
+ # spending-control visibility is enabled; limit is null without a cap. Older
117
+ # server responses may omit this object.
115
118
  # @param object
116
119
  # The object type. Always `agent.session`.
117
120
  def initialize: (
@@ -696,7 +699,8 @@ module OpenAI
696
699
  def self?.variants: -> ::Array[OpenAI::Models::Beta::AgentSession::required_action]
697
700
  end
698
701
 
699
- type status = :idle | :in_progress | :requires_action | :failed
702
+ type status =
703
+ :idle | :in_progress | :requires_action | :failed | :budget_reached
700
704
 
701
705
  module Status
702
706
  extend OpenAI::Internal::Type::Enum
@@ -713,6 +717,9 @@ module OpenAI
713
717
  # The session failed.
714
718
  FAILED: :failed
715
719
 
720
+ # The session is paused because its spending limit was reached.
721
+ BUDGET_REACHED: :budget_reached
722
+
716
723
  def self?.values: -> ::Array[OpenAI::Models::Beta::AgentSession::status]
717
724
  end
718
725
 
@@ -753,22 +760,22 @@ module OpenAI
753
760
  def self?.values: -> ::Array[OpenAI::Models::Beta::AgentSession::review]
754
761
  end
755
762
 
756
- type spend_control = { consumed: Integer?, limit: Integer }
763
+ type spend_control = { consumed: Integer?, limit: Integer? }
757
764
 
758
765
  class SpendControl < OpenAI::Internal::Type::BaseModel
759
766
  # Best-effort recorded spend floored to whole USD cents, or null when unavailable.
760
767
  attr_accessor consumed: Integer?
761
768
 
762
- # The configured positive limit in USD cents.
763
- attr_accessor limit: Integer
769
+ # The configured positive limit in USD cents, or null when unlimited.
770
+ attr_accessor limit: Integer?
764
771
 
765
772
  # @param consumed
766
773
  # Best-effort recorded spend floored to whole USD cents, or null when unavailable.
767
774
  # @param limit
768
- # The configured positive limit in USD cents.
769
- def initialize: (consumed: Integer?, limit: Integer) -> void
775
+ # The configured positive limit in USD cents, or null when unlimited.
776
+ def initialize: (consumed: Integer?, limit: Integer?) -> void
770
777
 
771
- def to_hash: -> { consumed: Integer?, limit: Integer }
778
+ def to_hash: -> { consumed: Integer?, limit: Integer? }
772
779
  end
773
780
  end
774
781
  end
@@ -0,0 +1,52 @@
1
+ module OpenAI
2
+ module Models
3
+ module Beta
4
+ type agent_session_budget_reached_event =
5
+ {
6
+ event_id: String,
7
+ session: OpenAI::Beta::AgentSession,
8
+ ?type: :"agent.session.budget_reached",
9
+ ?obfuscation: String
10
+ }
11
+
12
+ class AgentSessionBudgetReachedEvent < OpenAI::Internal::Type::BaseModel
13
+ # The unique ID of the event.
14
+ attr_accessor event_id: String
15
+
16
+ # The paused session.
17
+ attr_accessor session: OpenAI::Beta::AgentSession
18
+
19
+ # The type of the object. Always `agent.session.budget_reached`.
20
+ attr_accessor type: :"agent.session.budget_reached"
21
+
22
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
23
+ attr_reader obfuscation: String?
24
+
25
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
26
+ def obfuscation=: (String) -> String
27
+
28
+ # @param event_id
29
+ # The unique ID of the event.
30
+ # @param session
31
+ # The paused session.
32
+ # @param obfuscation
33
+ # Random alphanumeric padding. Present when stream obfuscation is enabled.
34
+ # @param type
35
+ # The type of the object. Always `agent.session.budget_reached`.
36
+ def initialize: (
37
+ event_id: String,
38
+ session: OpenAI::Beta::AgentSession,
39
+ ?obfuscation: String,
40
+ ?type: :"agent.session.budget_reached"
41
+ ) -> void
42
+
43
+ def to_hash: -> {
44
+ event_id: String,
45
+ session: OpenAI::Beta::AgentSession,
46
+ ?type: :"agent.session.budget_reached",
47
+ ?obfuscation: String
48
+ }
49
+ end
50
+ end
51
+ end
52
+ end
@@ -16,6 +16,7 @@ module OpenAI
16
16
  | OpenAI::Beta::AgentSessionTurnCancelledEvent
17
17
  | OpenAI::Beta::AgentSessionTurnItemAddedEvent
18
18
  | OpenAI::Beta::AgentSessionIdleEvent
19
+ | OpenAI::Beta::AgentSessionBudgetReachedEvent
19
20
  | OpenAI::Beta::AgentSessionInProgressEvent
20
21
  | OpenAI::Beta::AgentSessionRequiresActionEvent
21
22
  | OpenAI::Beta::AgentSessionFailedEvent
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: openai
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.126.0
4
+ version: 0.127.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAI
@@ -538,6 +538,7 @@ files:
538
538
  - lib/openai/models/beta/agent_send_subagent_input_call_item.rb
539
539
  - lib/openai/models/beta/agent_session.rb
540
540
  - lib/openai/models/beta/agent_session_assistant_message.rb
541
+ - lib/openai/models/beta/agent_session_budget_reached_event.rb
541
542
  - lib/openai/models/beta/agent_session_created_event.rb
542
543
  - lib/openai/models/beta/agent_session_deleted.rb
543
544
  - lib/openai/models/beta/agent_session_environment_connected_event.rb
@@ -2276,6 +2277,7 @@ files:
2276
2277
  - rbi/openai/models/beta/agent_send_subagent_input_call_item.rbi
2277
2278
  - rbi/openai/models/beta/agent_session.rbi
2278
2279
  - rbi/openai/models/beta/agent_session_assistant_message.rbi
2280
+ - rbi/openai/models/beta/agent_session_budget_reached_event.rbi
2279
2281
  - rbi/openai/models/beta/agent_session_created_event.rbi
2280
2282
  - rbi/openai/models/beta/agent_session_deleted.rbi
2281
2283
  - rbi/openai/models/beta/agent_session_environment_connected_event.rbi
@@ -4001,6 +4003,7 @@ files:
4001
4003
  - sig/openai/models/beta/agent_send_subagent_input_call_item.rbs
4002
4004
  - sig/openai/models/beta/agent_session.rbs
4003
4005
  - sig/openai/models/beta/agent_session_assistant_message.rbs
4006
+ - sig/openai/models/beta/agent_session_budget_reached_event.rbs
4004
4007
  - sig/openai/models/beta/agent_session_created_event.rbs
4005
4008
  - sig/openai/models/beta/agent_session_deleted.rbs
4006
4009
  - sig/openai/models/beta/agent_session_environment_connected_event.rbs