openai 0.124.0 → 0.125.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 (49) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/openai/internal/stream.rb +1 -1
  5. data/lib/openai/internal/transport/base_client.rb +11 -2
  6. data/lib/openai/internal/type/base_stream.rb +10 -0
  7. data/lib/openai/models/beta/agent.rb +2 -2
  8. data/lib/openai/models/beta/agent_create_params.rb +9 -9
  9. data/lib/openai/models/beta/agent_session.rb +2 -2
  10. data/lib/openai/models/beta/agent_update_params.rb +9 -12
  11. data/lib/openai/models/beta/agents/automation_agent_config.rb +2 -2
  12. data/lib/openai/models/beta/agents/automation_target_param.rb +9 -12
  13. data/lib/openai/models/beta/agents/one_time_automation.rb +28 -1
  14. data/lib/openai/models/beta/agents/periodic_automation.rb +28 -1
  15. data/lib/openai/models/beta/agents/session_create_params.rb +9 -12
  16. data/lib/openai/models/live/session_config.rb +12 -1
  17. data/lib/openai/models/live/session_resource.rb +12 -1
  18. data/lib/openai/resources/beta/agents/sessions/events.rb +1 -0
  19. data/lib/openai/resources/beta/agents/sessions.rb +1 -0
  20. data/lib/openai/resources/beta/agents.rb +2 -3
  21. data/lib/openai/version.rb +1 -1
  22. data/rbi/openai/internal/transport/base_client.rbi +4 -1
  23. data/rbi/openai/internal/type/base_stream.rbi +5 -0
  24. data/rbi/openai/models/beta/agent.rbi +2 -2
  25. data/rbi/openai/models/beta/agent_create_params.rbi +9 -9
  26. data/rbi/openai/models/beta/agent_session.rbi +2 -2
  27. data/rbi/openai/models/beta/agent_update_params.rbi +9 -12
  28. data/rbi/openai/models/beta/agents/automation_agent_config.rbi +2 -2
  29. data/rbi/openai/models/beta/agents/automation_target_param.rbi +9 -12
  30. data/rbi/openai/models/beta/agents/one_time_automation.rbi +28 -1
  31. data/rbi/openai/models/beta/agents/periodic_automation.rbi +28 -1
  32. data/rbi/openai/models/beta/agents/session_create_params.rbi +9 -12
  33. data/rbi/openai/models/live/session_config.rbi +12 -0
  34. data/rbi/openai/models/live/session_resource.rbi +12 -0
  35. data/rbi/openai/resources/beta/agents.rbi +2 -3
  36. data/sig/openai/internal/transport/base_client.rbs +1 -0
  37. data/sig/openai/internal/type/base_stream.rbs +2 -0
  38. data/sig/openai/models/beta/agent.rbs +2 -2
  39. data/sig/openai/models/beta/agent_create_params.rbs +8 -8
  40. data/sig/openai/models/beta/agent_session.rbs +2 -2
  41. data/sig/openai/models/beta/agent_update_params.rbs +8 -10
  42. data/sig/openai/models/beta/agents/automation_agent_config.rbs +2 -2
  43. data/sig/openai/models/beta/agents/automation_target_param.rbs +8 -10
  44. data/sig/openai/models/beta/agents/one_time_automation.rbs +20 -2
  45. data/sig/openai/models/beta/agents/periodic_automation.rbs +20 -2
  46. data/sig/openai/models/beta/agents/session_create_params.rbs +8 -10
  47. data/sig/openai/models/live/session_config.rbs +10 -0
  48. data/sig/openai/models/live/session_resource.rbs +10 -0
  49. metadata +1 -1
@@ -238,7 +238,7 @@ module OpenAI
238
238
  )
239
239
  end
240
240
 
241
- # Whether context is compacted in the background. Defaults to true.
241
+ # Whether context is compacted in the background. Defaults to false.
242
242
  sig { returns(T::Boolean) }
243
243
  attr_accessor :async
244
244
 
@@ -252,7 +252,7 @@ module OpenAI
252
252
  end
253
253
  def self.new(
254
254
 
255
- # Whether context is compacted in the background. Defaults to true.
255
+ # Whether context is compacted in the background. Defaults to false.
256
256
 
257
257
  async:
258
258
  )
@@ -21,7 +21,7 @@ module OpenAI
21
21
  sig { returns(String) }
22
22
  attr_accessor :model
23
23
 
24
- # Context compaction settings. Omission or null enables background compaction.
24
+ # Context compaction settings. Omission or null uses blocking compaction.
25
25
  sig { returns(T.nilable(OpenAI::Beta::AgentCreateParams::Compaction)) }
26
26
  attr_reader :compaction
27
27
 
@@ -143,7 +143,7 @@ module OpenAI
143
143
  # The model to use for the agent. The requested model name is preserved.
144
144
  model:,
145
145
 
146
- # Context compaction settings. Omission or null enables background compaction.
146
+ # Context compaction settings. Omission or null uses blocking compaction.
147
147
  compaction: nil,
148
148
 
149
149
  # Experimental agent settings. All experimental features default to disabled.
@@ -223,13 +223,13 @@ module OpenAI
223
223
  )
224
224
  end
225
225
 
226
- # Whether to compact context in the background. Omission or null defaults to true.
227
- # Set to false to use blocking compaction. Background compaction may increase
228
- # token usage.
226
+ # Whether to compact context in the background. Omission or null defaults to
227
+ # false. Set to true to enable background compaction. Background compaction may
228
+ # increase token usage.
229
229
  sig { returns(T.nilable(T::Boolean)) }
230
230
  attr_accessor :async
231
231
 
232
- # Context compaction settings. Omission or null enables background compaction.
232
+ # Context compaction settings. Omission or null uses blocking compaction.
233
233
  sig do
234
234
  params(
235
235
 
@@ -239,9 +239,9 @@ module OpenAI
239
239
  end
240
240
  def self.new(
241
241
 
242
- # Whether to compact context in the background. Omission or null defaults to true.
243
- # Set to false to use blocking compaction. Background compaction may increase
244
- # token usage.
242
+ # Whether to compact context in the background. Omission or null defaults to
243
+ # false. Set to true to enable background compaction. Background compaction may
244
+ # increase token usage.
245
245
 
246
246
  async: nil
247
247
  )
@@ -407,7 +407,7 @@ module OpenAI
407
407
  )
408
408
  end
409
409
 
410
- # Whether context is compacted in the background. Defaults to true.
410
+ # Whether context is compacted in the background. Defaults to false.
411
411
  sig { returns(T::Boolean) }
412
412
  attr_accessor :async
413
413
 
@@ -421,7 +421,7 @@ module OpenAI
421
421
  end
422
422
  def self.new(
423
423
 
424
- # Whether context is compacted in the background. Defaults to true.
424
+ # Whether context is compacted in the background. Defaults to false.
425
425
 
426
426
  async:
427
427
  )
@@ -21,8 +21,7 @@ module OpenAI
21
21
  attr_accessor :agent_id
22
22
 
23
23
  # Context compaction settings. Omit to keep the current settings. A supplied
24
- # object replaces the settings; null or an empty object enables background
25
- # compaction.
24
+ # object replaces the settings; null or an empty object uses blocking compaction.
26
25
  sig { returns(T.nilable(OpenAI::Beta::AgentUpdateParams::Compaction)) }
27
26
  attr_reader :compaction
28
27
 
@@ -154,8 +153,7 @@ module OpenAI
154
153
  agent_id:,
155
154
 
156
155
  # Context compaction settings. Omit to keep the current settings. A supplied
157
- # object replaces the settings; null or an empty object enables background
158
- # compaction.
156
+ # object replaces the settings; null or an empty object uses blocking compaction.
159
157
  compaction: nil,
160
158
 
161
159
  # Experimental settings to merge by key. Omitted settings keep their current
@@ -240,15 +238,14 @@ module OpenAI
240
238
  )
241
239
  end
242
240
 
243
- # Whether to compact context in the background. Omission or null defaults to true.
244
- # Set to false to use blocking compaction. Background compaction may increase
245
- # token usage.
241
+ # Whether to compact context in the background. Omission or null defaults to
242
+ # false. Set to true to enable background compaction. Background compaction may
243
+ # increase token usage.
246
244
  sig { returns(T.nilable(T::Boolean)) }
247
245
  attr_accessor :async
248
246
 
249
247
  # Context compaction settings. Omit to keep the current settings. A supplied
250
- # object replaces the settings; null or an empty object enables background
251
- # compaction.
248
+ # object replaces the settings; null or an empty object uses blocking compaction.
252
249
  sig do
253
250
  params(
254
251
 
@@ -258,9 +255,9 @@ module OpenAI
258
255
  end
259
256
  def self.new(
260
257
 
261
- # Whether to compact context in the background. Omission or null defaults to true.
262
- # Set to false to use blocking compaction. Background compaction may increase
263
- # token usage.
258
+ # Whether to compact context in the background. Omission or null defaults to
259
+ # false. Set to true to enable background compaction. Background compaction may
260
+ # increase token usage.
264
261
 
265
262
  async: nil
266
263
  )
@@ -177,7 +177,7 @@ module OpenAI
177
177
  )
178
178
  end
179
179
 
180
- # Whether context is compacted in the background. Defaults to true.
180
+ # Whether context is compacted in the background. Defaults to false.
181
181
  sig { returns(T::Boolean) }
182
182
  attr_accessor :async
183
183
 
@@ -191,7 +191,7 @@ module OpenAI
191
191
  end
192
192
  def self.new(
193
193
 
194
- # Whether context is compacted in the background. Defaults to true.
194
+ # Whether context is compacted in the background. Defaults to false.
195
195
 
196
196
  async:
197
197
  )
@@ -147,8 +147,7 @@ module OpenAI
147
147
  end
148
148
 
149
149
  # Context compaction settings. Omit to keep the current settings. A supplied
150
- # object replaces the settings; null or an empty object enables background
151
- # compaction.
150
+ # object replaces the settings; null or an empty object uses blocking compaction.
152
151
  sig { returns(T.nilable(OpenAI::Beta::Agents::AutomationTargetParam::NewSession::Agent::Compaction)) }
153
152
  attr_reader :compaction
154
153
 
@@ -282,8 +281,7 @@ module OpenAI
282
281
  def self.new(
283
282
 
284
283
  # Context compaction settings. Omit to keep the current settings. A supplied
285
- # object replaces the settings; null or an empty object enables background
286
- # compaction.
284
+ # object replaces the settings; null or an empty object uses blocking compaction.
287
285
  compaction: nil,
288
286
 
289
287
  # Experimental settings to merge by key. Omitted settings keep their current
@@ -358,15 +356,14 @@ module OpenAI
358
356
  )
359
357
  end
360
358
 
361
- # Whether to compact context in the background. Omission or null defaults to true.
362
- # Set to false to use blocking compaction. Background compaction may increase
363
- # token usage.
359
+ # Whether to compact context in the background. Omission or null defaults to
360
+ # false. Set to true to enable background compaction. Background compaction may
361
+ # increase token usage.
364
362
  sig { returns(T.nilable(T::Boolean)) }
365
363
  attr_accessor :async
366
364
 
367
365
  # Context compaction settings. Omit to keep the current settings. A supplied
368
- # object replaces the settings; null or an empty object enables background
369
- # compaction.
366
+ # object replaces the settings; null or an empty object uses blocking compaction.
370
367
  sig do
371
368
  params(
372
369
 
@@ -376,9 +373,9 @@ module OpenAI
376
373
  end
377
374
  def self.new(
378
375
 
379
- # Whether to compact context in the background. Omission or null defaults to true.
380
- # Set to false to use blocking compaction. Background compaction may increase
381
- # token usage.
376
+ # Whether to compact context in the background. Omission or null defaults to
377
+ # false. Set to true to enable background compaction. Background compaction may
378
+ # increase token usage.
382
379
 
383
380
  async: nil
384
381
  )
@@ -56,6 +56,10 @@ module OpenAI
56
56
  sig { returns(Symbol) }
57
57
  attr_accessor :type
58
58
 
59
+ # Why the service paused this schedule, or null for other schedules.
60
+ sig { returns(T.nilable(OpenAI::Beta::Agents::OneTimeAutomation::PauseReason::TaggedSymbol)) }
61
+ attr_accessor :pause_reason
62
+
59
63
  # Fields shared by periodic and one-time automations.
60
64
  sig do
61
65
  params(
@@ -82,6 +86,8 @@ module OpenAI
82
86
  OpenAI::Beta::Agents::AutomationTarget::ExistingSession::OrHash
83
87
  ),
84
88
 
89
+ pause_reason: T.nilable(OpenAI::Beta::Agents::OneTimeAutomation::PauseReason::OrSymbol),
90
+
85
91
  object: Symbol,
86
92
 
87
93
  type: Symbol
@@ -114,6 +120,9 @@ module OpenAI
114
120
  # The session configuration or existing session receiving invocations.
115
121
  target:,
116
122
 
123
+ # Why the service paused this schedule, or null for other schedules.
124
+ pause_reason: nil,
125
+
117
126
  # Always `agent.automation`.
118
127
  object: :"agent.automation",
119
128
 
@@ -135,7 +144,8 @@ module OpenAI
135
144
  run_at: Integer,
136
145
  status: OpenAI::Beta::Agents::OneTimeAutomation::Status::TaggedSymbol,
137
146
  target: OpenAI::Beta::Agents::AutomationTarget::Variants,
138
- type: Symbol
147
+ type: Symbol,
148
+ pause_reason: T.nilable(OpenAI::Beta::Agents::OneTimeAutomation::PauseReason::TaggedSymbol)
139
149
  }
140
150
  )
141
151
  end
@@ -158,6 +168,23 @@ module OpenAI
158
168
  end
159
169
  end
160
170
 
171
+ # Why the service paused this schedule, or null for other schedules.
172
+ module PauseReason
173
+ extend OpenAI::Internal::Type::Enum
174
+
175
+ TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::OneTimeAutomation::PauseReason) }
176
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
177
+
178
+ TARGET_SESSION_FAILED = T.let(
179
+ :target_session_failed,
180
+ OpenAI::Beta::Agents::OneTimeAutomation::PauseReason::TaggedSymbol
181
+ )
182
+
183
+ sig { override.returns(T::Array[OpenAI::Beta::Agents::OneTimeAutomation::PauseReason::TaggedSymbol]) }
184
+ def self.values
185
+ end
186
+ end
187
+
161
188
  end
162
189
 
163
190
  end
@@ -60,6 +60,10 @@ module OpenAI
60
60
  sig { returns(Symbol) }
61
61
  attr_accessor :type
62
62
 
63
+ # Why the service paused this schedule, or null for other schedules.
64
+ sig { returns(T.nilable(OpenAI::Beta::Agents::PeriodicAutomation::PauseReason::TaggedSymbol)) }
65
+ attr_accessor :pause_reason
66
+
63
67
  # Fields shared by periodic and one-time automations.
64
68
  sig do
65
69
  params(
@@ -88,6 +92,8 @@ module OpenAI
88
92
 
89
93
  timezone: String,
90
94
 
95
+ pause_reason: T.nilable(OpenAI::Beta::Agents::PeriodicAutomation::PauseReason::OrSymbol),
96
+
91
97
  object: Symbol,
92
98
 
93
99
  type: Symbol
@@ -123,6 +129,9 @@ module OpenAI
123
129
  # The timezone used to interpret the expression.
124
130
  timezone:,
125
131
 
132
+ # Why the service paused this schedule, or null for other schedules.
133
+ pause_reason: nil,
134
+
126
135
  # Always `agent.automation`.
127
136
  object: :"agent.automation",
128
137
 
@@ -145,7 +154,8 @@ module OpenAI
145
154
  status: OpenAI::Beta::Agents::PeriodicAutomation::Status::TaggedSymbol,
146
155
  target: OpenAI::Beta::Agents::AutomationTarget::Variants,
147
156
  timezone: String,
148
- type: Symbol
157
+ type: Symbol,
158
+ pause_reason: T.nilable(OpenAI::Beta::Agents::PeriodicAutomation::PauseReason::TaggedSymbol)
149
159
  }
150
160
  )
151
161
  end
@@ -167,6 +177,23 @@ module OpenAI
167
177
  end
168
178
  end
169
179
 
180
+ # Why the service paused this schedule, or null for other schedules.
181
+ module PauseReason
182
+ extend OpenAI::Internal::Type::Enum
183
+
184
+ TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::PeriodicAutomation::PauseReason) }
185
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
186
+
187
+ TARGET_SESSION_FAILED = T.let(
188
+ :target_session_failed,
189
+ OpenAI::Beta::Agents::PeriodicAutomation::PauseReason::TaggedSymbol
190
+ )
191
+
192
+ sig { override.returns(T::Array[OpenAI::Beta::Agents::PeriodicAutomation::PauseReason::TaggedSymbol]) }
193
+ def self.values
194
+ end
195
+ end
196
+
170
197
  end
171
198
 
172
199
  end
@@ -208,8 +208,7 @@ module OpenAI
208
208
  end
209
209
 
210
210
  # Context compaction settings. Omit to keep the current settings. A supplied
211
- # object replaces the settings; null or an empty object enables background
212
- # compaction.
211
+ # object replaces the settings; null or an empty object uses blocking compaction.
213
212
  sig { returns(T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Agent::Compaction)) }
214
213
  attr_reader :compaction
215
214
 
@@ -326,8 +325,7 @@ module OpenAI
326
325
  def self.new(
327
326
 
328
327
  # Context compaction settings. Omit to keep the current settings. A supplied
329
- # object replaces the settings; null or an empty object enables background
330
- # compaction.
328
+ # object replaces the settings; null or an empty object uses blocking compaction.
331
329
  compaction: nil,
332
330
 
333
331
  # Experimental settings to merge by key. Omitted settings keep their current
@@ -400,15 +398,14 @@ module OpenAI
400
398
  )
401
399
  end
402
400
 
403
- # Whether to compact context in the background. Omission or null defaults to true.
404
- # Set to false to use blocking compaction. Background compaction may increase
405
- # token usage.
401
+ # Whether to compact context in the background. Omission or null defaults to
402
+ # false. Set to true to enable background compaction. Background compaction may
403
+ # increase token usage.
406
404
  sig { returns(T.nilable(T::Boolean)) }
407
405
  attr_accessor :async
408
406
 
409
407
  # Context compaction settings. Omit to keep the current settings. A supplied
410
- # object replaces the settings; null or an empty object enables background
411
- # compaction.
408
+ # object replaces the settings; null or an empty object uses blocking compaction.
412
409
  sig do
413
410
  params(
414
411
 
@@ -418,9 +415,9 @@ module OpenAI
418
415
  end
419
416
  def self.new(
420
417
 
421
- # Whether to compact context in the background. Omission or null defaults to true.
422
- # Set to false to use blocking compaction. Background compaction may increase
423
- # token usage.
418
+ # Whether to compact context in the background. Omission or null defaults to
419
+ # false. Set to true to enable background compaction. Background compaction may
420
+ # increase token usage.
424
421
 
425
422
  async: nil
426
423
  )
@@ -94,6 +94,11 @@ module OpenAI
94
94
  sig { returns(T.nilable(String)) }
95
95
  attr_accessor :instructions
96
96
 
97
+ # A stable identifier for your end user, used for safety monitoring and abuse
98
+ # detection.
99
+ sig { returns(T.nilable(String)) }
100
+ attr_accessor :safety_identifier
101
+
97
102
  # Whether to store the session for later forking and recording download. Defaults
98
103
  # to false for new sessions.
99
104
  sig { returns(T.nilable(T::Boolean)) }
@@ -141,6 +146,8 @@ module OpenAI
141
146
 
142
147
  instructions: T.nilable(String),
143
148
 
149
+ safety_identifier: T.nilable(String),
150
+
144
151
  store: T::Boolean,
145
152
 
146
153
  triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash]
@@ -181,6 +188,10 @@ module OpenAI
181
188
  # server defaults. Immutable after startup.
182
189
  instructions: nil,
183
190
 
191
+ # A stable identifier for your end user, used for safety monitoring and abuse
192
+ # detection.
193
+ safety_identifier: nil,
194
+
184
195
  # Whether to store the session for later forking and recording download. Defaults
185
196
  # to false for new sessions.
186
197
  store: nil,
@@ -215,6 +226,7 @@ module OpenAI
215
226
  )
216
227
  ],
217
228
  instructions: T.nilable(String),
229
+ safety_identifier: T.nilable(String),
218
230
  store: T::Boolean,
219
231
  triggers: T::Array[OpenAI::Live::DecisionTrigger]
220
232
  }
@@ -99,6 +99,11 @@ module OpenAI
99
99
  sig { returns(T.nilable(String)) }
100
100
  attr_accessor :instructions
101
101
 
102
+ # A stable identifier for your end user, used for safety monitoring and abuse
103
+ # detection.
104
+ sig { returns(T.nilable(String)) }
105
+ attr_accessor :safety_identifier
106
+
102
107
  # Whether to store the session for later forking and recording download. Defaults
103
108
  # to false for new sessions.
104
109
  sig { returns(T.nilable(T::Boolean)) }
@@ -149,6 +154,8 @@ module OpenAI
149
154
 
150
155
  instructions: T.nilable(String),
151
156
 
157
+ safety_identifier: T.nilable(String),
158
+
152
159
  store: T::Boolean,
153
160
 
154
161
  triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash],
@@ -198,6 +205,10 @@ module OpenAI
198
205
  # server defaults. Immutable after startup.
199
206
  instructions: nil,
200
207
 
208
+ # A stable identifier for your end user, used for safety monitoring and abuse
209
+ # detection.
210
+ safety_identifier: nil,
211
+
201
212
  # Whether to store the session for later forking and recording download. Defaults
202
213
  # to false for new sessions.
203
214
  store: nil,
@@ -234,6 +245,7 @@ module OpenAI
234
245
  )
235
246
  ],
236
247
  instructions: T.nilable(String),
248
+ safety_identifier: T.nilable(String),
237
249
  store: T::Boolean,
238
250
  triggers: T::Array[OpenAI::Live::DecisionTrigger]
239
251
  }
@@ -53,7 +53,7 @@ module OpenAI
53
53
  def create(
54
54
  # The model to use for the agent. The requested model name is preserved.
55
55
  model:,
56
- # Context compaction settings. Omission or null enables background compaction.
56
+ # Context compaction settings. Omission or null uses blocking compaction.
57
57
  compaction: nil,
58
58
  # Experimental agent settings. All experimental features default to disabled.
59
59
  experimental: nil,
@@ -128,8 +128,7 @@ module OpenAI
128
128
  # The ID of the reusable agent.
129
129
  agent_id,
130
130
  # Context compaction settings. Omit to keep the current settings. A supplied
131
- # object replaces the settings; null or an empty object enables background
132
- # compaction.
131
+ # object replaces the settings; null or an empty object uses blocking compaction.
133
132
  compaction: nil,
134
133
  # Experimental settings to merge by key. Omitted settings keep their current
135
134
  # values.
@@ -19,6 +19,7 @@ module OpenAI
19
19
  | (^(top arg0) -> top))?,
20
20
  page: Class?,
21
21
  stream: Class?,
22
+ ?stream_mode: (:legacy | :events)?,
22
23
  model: OpenAI::Internal::Type::Converter::input?,
23
24
  security: ::Hash[(:bearer_auth | :admin_api_key_auth), bool]?,
24
25
  options: OpenAI::request_opts?
@@ -14,6 +14,8 @@ module OpenAI
14
14
 
15
15
  def close: -> void
16
16
 
17
+ def set_stream_mode: (:legacy | :events mode) -> self
18
+
17
19
  def observe: (
18
20
  context: OpenAI::Internal::Logging::Context,
19
21
  response: OpenAI::HTTPClient::Response
@@ -163,11 +163,11 @@ module OpenAI
163
163
  type compaction = { async: bool }
164
164
 
165
165
  class Compaction < OpenAI::Internal::Type::BaseModel
166
- # Whether context is compacted in the background. Defaults to true.
166
+ # Whether context is compacted in the background. Defaults to false.
167
167
  attr_accessor async: bool
168
168
 
169
169
  # @param async
170
- # Whether context is compacted in the background. Defaults to true.
170
+ # Whether context is compacted in the background. Defaults to false.
171
171
  def initialize: (async: bool) -> void
172
172
 
173
173
  def to_hash: -> { async: bool }
@@ -24,7 +24,7 @@ module OpenAI
24
24
  # The model to use for the agent. The requested model name is preserved.
25
25
  attr_accessor model: String
26
26
 
27
- # Context compaction settings. Omission or null enables background compaction.
27
+ # Context compaction settings. Omission or null uses blocking compaction.
28
28
  attr_accessor compaction: OpenAI::Beta::AgentCreateParams::Compaction?
29
29
 
30
30
  # Experimental agent settings. All experimental features default to disabled.
@@ -67,7 +67,7 @@ module OpenAI
67
67
  # @param model
68
68
  # The model to use for the agent. The requested model name is preserved.
69
69
  # @param compaction
70
- # Context compaction settings. Omission or null enables background compaction.
70
+ # Context compaction settings. Omission or null uses blocking compaction.
71
71
  # @param experimental
72
72
  # Experimental agent settings. All experimental features default to disabled.
73
73
  # @param instructions
@@ -124,15 +124,15 @@ module OpenAI
124
124
  type compaction = { ?async: bool? }
125
125
 
126
126
  class Compaction < OpenAI::Internal::Type::BaseModel
127
- # Whether to compact context in the background. Omission or null defaults to true.
128
- # Set to false to use blocking compaction. Background compaction may increase
129
- # token usage.
127
+ # Whether to compact context in the background. Omission or null defaults to
128
+ # false. Set to true to enable background compaction. Background compaction may
129
+ # increase token usage.
130
130
  attr_accessor async: bool?
131
131
 
132
132
  # @param async
133
- # Whether to compact context in the background. Omission or null defaults to true.
134
- # Set to false to use blocking compaction. Background compaction may increase
135
- # token usage.
133
+ # Whether to compact context in the background. Omission or null defaults to
134
+ # false. Set to true to enable background compaction. Background compaction may
135
+ # increase token usage.
136
136
  def initialize: (?async: bool?) -> void
137
137
 
138
138
  def to_hash: -> { ?async: bool? }
@@ -280,11 +280,11 @@ module OpenAI
280
280
  type compaction = { async: bool }
281
281
 
282
282
  class Compaction < OpenAI::Internal::Type::BaseModel
283
- # Whether context is compacted in the background. Defaults to true.
283
+ # Whether context is compacted in the background. Defaults to false.
284
284
  attr_accessor async: bool
285
285
 
286
286
  # @param async
287
- # Whether context is compacted in the background. Defaults to true.
287
+ # Whether context is compacted in the background. Defaults to false.
288
288
  def initialize: (async: bool) -> void
289
289
 
290
290
  def to_hash: -> { async: bool }
@@ -25,8 +25,7 @@ module OpenAI
25
25
  attr_accessor agent_id: String
26
26
 
27
27
  # Context compaction settings. Omit to keep the current settings. A supplied
28
- # object replaces the settings; null or an empty object enables background
29
- # compaction.
28
+ # object replaces the settings; null or an empty object uses blocking compaction.
30
29
  attr_accessor compaction: OpenAI::Beta::AgentUpdateParams::Compaction?
31
30
 
32
31
  # Experimental settings to merge by key. Omitted settings keep their current
@@ -76,8 +75,7 @@ module OpenAI
76
75
 
77
76
  # @param compaction
78
77
  # Context compaction settings. Omit to keep the current settings. A supplied
79
- # object replaces the settings; null or an empty object enables background
80
- # compaction.
78
+ # object replaces the settings; null or an empty object uses blocking compaction.
81
79
  # @param experimental
82
80
  # Experimental settings to merge by key. Omitted settings keep their current
83
81
  # values.
@@ -139,15 +137,15 @@ module OpenAI
139
137
  type compaction = { ?async: bool? }
140
138
 
141
139
  class Compaction < OpenAI::Internal::Type::BaseModel
142
- # Whether to compact context in the background. Omission or null defaults to true.
143
- # Set to false to use blocking compaction. Background compaction may increase
144
- # token usage.
140
+ # Whether to compact context in the background. Omission or null defaults to
141
+ # false. Set to true to enable background compaction. Background compaction may
142
+ # increase token usage.
145
143
  attr_accessor async: bool?
146
144
 
147
145
  # @param async
148
- # Whether to compact context in the background. Omission or null defaults to true.
149
- # Set to false to use blocking compaction. Background compaction may increase
150
- # token usage.
146
+ # Whether to compact context in the background. Omission or null defaults to
147
+ # false. Set to true to enable background compaction. Background compaction may
148
+ # increase token usage.
151
149
  def initialize: (?async: bool?) -> void
152
150
 
153
151
  def to_hash: -> { ?async: bool? }
@@ -114,11 +114,11 @@ module OpenAI
114
114
  type compaction = { async: bool }
115
115
 
116
116
  class Compaction < OpenAI::Internal::Type::BaseModel
117
- # Whether context is compacted in the background. Defaults to true.
117
+ # Whether context is compacted in the background. Defaults to false.
118
118
  attr_accessor async: bool
119
119
 
120
120
  # @param async
121
- # Whether context is compacted in the background. Defaults to true.
121
+ # Whether context is compacted in the background. Defaults to false.
122
122
  def initialize: (async: bool) -> void
123
123
 
124
124
  def to_hash: -> { async: bool }