openai 0.64.0 → 0.65.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 (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/openai/models/admin/organization/audit_log_list_params.rb +6 -0
  5. data/lib/openai/models/admin/organization/audit_log_list_response.rb +231 -1
  6. data/lib/openai/models/chat/completion_create_params.rb +16 -0
  7. data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
  8. data/lib/openai/models/conversations/conversation_item.rb +57 -1
  9. data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
  10. data/lib/openai/models/conversations/item_create_params.rb +2 -2
  11. data/lib/openai/models/responses/compacted_response.rb +2 -2
  12. data/lib/openai/models/responses/input_token_count_params.rb +41 -4
  13. data/lib/openai/models/responses/response.rb +21 -5
  14. data/lib/openai/models/responses/response_compact_params.rb +3 -3
  15. data/lib/openai/models/responses/response_create_params.rb +19 -3
  16. data/lib/openai/models/responses/response_function_web_search.rb +11 -9
  17. data/lib/openai/models/responses/response_input_item.rb +38 -1
  18. data/lib/openai/models/responses/response_item.rb +57 -1
  19. data/lib/openai/models/responses/response_item_list.rb +2 -2
  20. data/lib/openai/models/responses/response_output_item.rb +57 -1
  21. data/lib/openai/models/responses/response_output_item_added_event.rb +2 -2
  22. data/lib/openai/models/responses/response_output_item_done_event.rb +2 -2
  23. data/lib/openai/models/responses/responses_client_event.rb +19 -3
  24. data/lib/openai/resources/conversations/items.rb +3 -3
  25. data/lib/openai/resources/conversations.rb +1 -1
  26. data/lib/openai/resources/responses/input_items.rb +1 -1
  27. data/lib/openai/resources/responses/input_tokens.rb +4 -2
  28. data/lib/openai/resources/responses.rb +3 -3
  29. data/lib/openai/version.rb +1 -1
  30. data/rbi/openai/models/admin/organization/audit_log_list_params.rbi +30 -0
  31. data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +489 -3
  32. data/rbi/openai/models/chat/completion_create_params.rbi +24 -0
  33. data/rbi/openai/models/conversations/conversation_create_params.rbi +3 -0
  34. data/rbi/openai/models/conversations/conversation_item.rbi +150 -0
  35. data/rbi/openai/models/conversations/conversation_item_list.rbi +1 -0
  36. data/rbi/openai/models/conversations/item_create_params.rbi +3 -0
  37. data/rbi/openai/models/responses/compacted_response.rbi +1 -0
  38. data/rbi/openai/models/responses/input_token_count_params.rbi +85 -0
  39. data/rbi/openai/models/responses/response.rbi +25 -0
  40. data/rbi/openai/models/responses/response_create_params.rbi +24 -0
  41. data/rbi/openai/models/responses/response_function_web_search.rbi +11 -8
  42. data/rbi/openai/models/responses/response_input_item.rbi +120 -0
  43. data/rbi/openai/models/responses/response_item.rbi +150 -0
  44. data/rbi/openai/models/responses/response_item_list.rbi +1 -0
  45. data/rbi/openai/models/responses/response_output_item.rbi +150 -0
  46. data/rbi/openai/models/responses/response_output_item_added_event.rbi +1 -0
  47. data/rbi/openai/models/responses/response_output_item_done_event.rbi +1 -0
  48. data/rbi/openai/models/responses/responses_client_event.rbi +24 -0
  49. data/rbi/openai/resources/chat/completions.rbi +16 -0
  50. data/rbi/openai/resources/conversations/items.rbi +1 -0
  51. data/rbi/openai/resources/conversations.rbi +1 -0
  52. data/rbi/openai/resources/responses/input_tokens.rbi +9 -0
  53. data/rbi/openai/resources/responses.rbi +16 -0
  54. data/sig/openai/models/admin/organization/audit_log_list_params.rbs +12 -0
  55. data/sig/openai/models/admin/organization/audit_log_list_response.rbs +216 -3
  56. data/sig/openai/models/conversations/conversation_item.rbs +58 -0
  57. data/sig/openai/models/responses/input_token_count_params.rbs +20 -0
  58. data/sig/openai/models/responses/response_function_web_search.rbs +7 -5
  59. data/sig/openai/models/responses/response_input_item.rbs +33 -0
  60. data/sig/openai/models/responses/response_item.rbs +58 -0
  61. data/sig/openai/models/responses/response_output_item.rbs +58 -0
  62. data/sig/openai/resources/responses/input_tokens.rbs +1 -0
  63. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d7881988f192fdd1d2822a4e7d7cdcfad36e20a36a808e06924d2c628f1cea5d
4
- data.tar.gz: 7984c7e0bf61f6b7fc662a871b1ca1fe44d5347823308b34fce054de9b03b3ff
3
+ metadata.gz: 1a5fa30c047f790a8b47104b540af59fa63faead196ff665b549fca8fdcbc389
4
+ data.tar.gz: 0f1c46ebe4c7124a099ccdc6e62cddf49450503fb2eb7457ee112cb5cd4d7a4a
5
5
  SHA512:
6
- metadata.gz: 7f792c8ac766e1f89f5b625471001091f71246d1e47b680c1b291e57099b058432bbcc4b93b7d2e1f789dec81d9c25f551a551a8b7212167c93f77537bb6fde1
7
- data.tar.gz: 182dbdcf82c3a5708b76996472b44c8b5e557d9e5c8e066a1b07723f89cff0992fe23f792c63e89469011ce7802321aae592ffc1f5ea548b26a27dfd18825da0
6
+ metadata.gz: 79597c5c13502bb29dec186d69641c8d5df202c0d08af665b14b3169327c294a97a0c011a061d36ce7b30a9a44a6ca76ce47ab6aef8b25ed706aadaf9aa08d01
7
+ data.tar.gz: 1eafbf4d2a836289e33500620ac9a1d258a252462437ae468bec5370867ed51423bf1de2e6e50dac3909f2b4d3b6dbca83c51e05d155948e2e43083971aae4b4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.65.0 (2026-06-01)
4
+
5
+ Full Changelog: [v0.64.0...v0.65.0](https://github.com/openai/openai-ruby/compare/v0.64.0...v0.65.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** workload identity in audit logs, additional_tools item in responses, fix ActionSearch.query to be optional. ([5d44823](https://github.com/openai/openai-ruby/commit/5d4482389d152decbc9e8b90ad2ed8e1d1243d43))
10
+
3
11
  ## 0.64.0 (2026-05-21)
4
12
 
5
13
  Full Changelog: [v0.63.0...v0.64.0](https://github.com/openai/openai-ruby/compare/v0.63.0...v0.64.0)
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.64.0"
18
+ gem "openai", "~> 0.65.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -185,6 +185,12 @@ module OpenAI
185
185
  TUNNEL_CREATED = :"tunnel.created"
186
186
  TUNNEL_UPDATED = :"tunnel.updated"
187
187
  TUNNEL_DELETED = :"tunnel.deleted"
188
+ WORKLOAD_IDENTITY_PROVIDER_CREATED = :"workload_identity_provider.created"
189
+ WORKLOAD_IDENTITY_PROVIDER_UPDATED = :"workload_identity_provider.updated"
190
+ WORKLOAD_IDENTITY_PROVIDER_DELETED = :"workload_identity_provider.deleted"
191
+ WORKLOAD_IDENTITY_PROVIDER_MAPPING_CREATED = :"workload_identity_provider_mapping.created"
192
+ WORKLOAD_IDENTITY_PROVIDER_MAPPING_UPDATED = :"workload_identity_provider_mapping.updated"
193
+ WORKLOAD_IDENTITY_PROVIDER_MAPPING_DELETED = :"workload_identity_provider_mapping.deleted"
188
194
  ROLE_CREATED = :"role.created"
189
195
  ROLE_UPDATED = :"role.updated"
190
196
  ROLE_DELETED = :"role.deleted"
@@ -411,7 +411,55 @@ module OpenAI
411
411
  -> { OpenAI::Models::Admin::Organization::AuditLogListResponse::UserUpdated },
412
412
  api_name: :"user.updated"
413
413
 
414
- # @!method initialize(id:, effective_at:, type:, actor: nil, api_key_created: nil, api_key_deleted: nil, api_key_updated: nil, certificate_created: nil, certificate_deleted: nil, certificate_updated: nil, certificates_activated: nil, certificates_deactivated: nil, checkpoint_permission_created: nil, checkpoint_permission_deleted: nil, external_key_registered: nil, external_key_removed: nil, group_created: nil, group_deleted: nil, group_updated: nil, invite_accepted: nil, invite_deleted: nil, invite_sent: nil, ip_allowlist_config_activated: nil, ip_allowlist_config_deactivated: nil, ip_allowlist_created: nil, ip_allowlist_deleted: nil, ip_allowlist_updated: nil, login_failed: nil, login_succeeded: nil, logout_failed: nil, logout_succeeded: nil, organization_updated: nil, project: nil, project_archived: nil, project_created: nil, project_deleted: nil, project_updated: nil, rate_limit_deleted: nil, rate_limit_updated: nil, role_assignment_created: nil, role_assignment_deleted: nil, role_created: nil, role_deleted: nil, role_updated: nil, scim_disabled: nil, scim_enabled: nil, service_account_created: nil, service_account_deleted: nil, service_account_updated: nil, user_added: nil, user_deleted: nil, user_updated: nil)
414
+ # @!attribute workload_identity_provider_mapping_created
415
+ # The details for events with this `type`.
416
+ #
417
+ # @return [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingCreated, nil]
418
+ optional :workload_identity_provider_mapping_created,
419
+ -> { OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingCreated },
420
+ api_name: :"workload_identity_provider_mapping.created"
421
+
422
+ # @!attribute workload_identity_provider_mapping_deleted
423
+ # The details for events with this `type`.
424
+ #
425
+ # @return [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingDeleted, nil]
426
+ optional :workload_identity_provider_mapping_deleted,
427
+ -> { OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingDeleted },
428
+ api_name: :"workload_identity_provider_mapping.deleted"
429
+
430
+ # @!attribute workload_identity_provider_mapping_updated
431
+ # The details for events with this `type`.
432
+ #
433
+ # @return [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingUpdated, nil]
434
+ optional :workload_identity_provider_mapping_updated,
435
+ -> { OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingUpdated },
436
+ api_name: :"workload_identity_provider_mapping.updated"
437
+
438
+ # @!attribute workload_identity_provider_created
439
+ # The details for events with this `type`.
440
+ #
441
+ # @return [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderCreated, nil]
442
+ optional :workload_identity_provider_created,
443
+ -> { OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderCreated },
444
+ api_name: :"workload_identity_provider.created"
445
+
446
+ # @!attribute workload_identity_provider_deleted
447
+ # The details for events with this `type`.
448
+ #
449
+ # @return [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderDeleted, nil]
450
+ optional :workload_identity_provider_deleted,
451
+ -> { OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderDeleted },
452
+ api_name: :"workload_identity_provider.deleted"
453
+
454
+ # @!attribute workload_identity_provider_updated
455
+ # The details for events with this `type`.
456
+ #
457
+ # @return [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderUpdated, nil]
458
+ optional :workload_identity_provider_updated,
459
+ -> { OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderUpdated },
460
+ api_name: :"workload_identity_provider.updated"
461
+
462
+ # @!method initialize(id:, effective_at:, type:, actor: nil, api_key_created: nil, api_key_deleted: nil, api_key_updated: nil, certificate_created: nil, certificate_deleted: nil, certificate_updated: nil, certificates_activated: nil, certificates_deactivated: nil, checkpoint_permission_created: nil, checkpoint_permission_deleted: nil, external_key_registered: nil, external_key_removed: nil, group_created: nil, group_deleted: nil, group_updated: nil, invite_accepted: nil, invite_deleted: nil, invite_sent: nil, ip_allowlist_config_activated: nil, ip_allowlist_config_deactivated: nil, ip_allowlist_created: nil, ip_allowlist_deleted: nil, ip_allowlist_updated: nil, login_failed: nil, login_succeeded: nil, logout_failed: nil, logout_succeeded: nil, organization_updated: nil, project: nil, project_archived: nil, project_created: nil, project_deleted: nil, project_updated: nil, rate_limit_deleted: nil, rate_limit_updated: nil, role_assignment_created: nil, role_assignment_deleted: nil, role_created: nil, role_deleted: nil, role_updated: nil, scim_disabled: nil, scim_enabled: nil, service_account_created: nil, service_account_deleted: nil, service_account_updated: nil, user_added: nil, user_deleted: nil, user_updated: nil, workload_identity_provider_mapping_created: nil, workload_identity_provider_mapping_deleted: nil, workload_identity_provider_mapping_updated: nil, workload_identity_provider_created: nil, workload_identity_provider_deleted: nil, workload_identity_provider_updated: nil)
415
463
  # Some parameter documentations has been truncated, see
416
464
  # {OpenAI::Models::Admin::Organization::AuditLogListResponse} for more details.
417
465
  #
@@ -520,6 +568,18 @@ module OpenAI
520
568
  # @param user_deleted [OpenAI::Models::Admin::Organization::AuditLogListResponse::UserDeleted] The details for events with this `type`.
521
569
  #
522
570
  # @param user_updated [OpenAI::Models::Admin::Organization::AuditLogListResponse::UserUpdated] The details for events with this `type`.
571
+ #
572
+ # @param workload_identity_provider_mapping_created [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingCreated] The details for events with this `type`.
573
+ #
574
+ # @param workload_identity_provider_mapping_deleted [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingDeleted] The details for events with this `type`.
575
+ #
576
+ # @param workload_identity_provider_mapping_updated [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderMappingUpdated] The details for events with this `type`.
577
+ #
578
+ # @param workload_identity_provider_created [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderCreated] The details for events with this `type`.
579
+ #
580
+ # @param workload_identity_provider_deleted [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderDeleted] The details for events with this `type`.
581
+ #
582
+ # @param workload_identity_provider_updated [OpenAI::Models::Admin::Organization::AuditLogListResponse::WorkloadIdentityProviderUpdated] The details for events with this `type`.
523
583
 
524
584
  # The event type.
525
585
  #
@@ -565,6 +625,12 @@ module OpenAI
565
625
  TUNNEL_CREATED = :"tunnel.created"
566
626
  TUNNEL_UPDATED = :"tunnel.updated"
567
627
  TUNNEL_DELETED = :"tunnel.deleted"
628
+ WORKLOAD_IDENTITY_PROVIDER_CREATED = :"workload_identity_provider.created"
629
+ WORKLOAD_IDENTITY_PROVIDER_UPDATED = :"workload_identity_provider.updated"
630
+ WORKLOAD_IDENTITY_PROVIDER_DELETED = :"workload_identity_provider.deleted"
631
+ WORKLOAD_IDENTITY_PROVIDER_MAPPING_CREATED = :"workload_identity_provider_mapping.created"
632
+ WORKLOAD_IDENTITY_PROVIDER_MAPPING_UPDATED = :"workload_identity_provider_mapping.updated"
633
+ WORKLOAD_IDENTITY_PROVIDER_MAPPING_DELETED = :"workload_identity_provider_mapping.deleted"
568
634
  ROLE_CREATED = :"role.created"
569
635
  ROLE_UPDATED = :"role.updated"
570
636
  ROLE_DELETED = :"role.deleted"
@@ -2192,6 +2258,170 @@ module OpenAI
2192
2258
  # @param role [String] The role of the user. Is either `owner` or `member`.
2193
2259
  end
2194
2260
  end
2261
+
2262
+ # @see OpenAI::Models::Admin::Organization::AuditLogListResponse#workload_identity_provider_mapping_created
2263
+ class WorkloadIdentityProviderMappingCreated < OpenAI::Internal::Type::BaseModel
2264
+ # @!attribute id
2265
+ # The workload identity provider mapping ID.
2266
+ #
2267
+ # @return [String, nil]
2268
+ optional :id, String
2269
+
2270
+ # @!attribute data
2271
+ # The payload used to create the workload identity provider mapping.
2272
+ #
2273
+ # @return [Object, nil]
2274
+ optional :data, OpenAI::Internal::Type::Unknown
2275
+
2276
+ # @!attribute identity_provider_id
2277
+ # The workload identity provider ID.
2278
+ #
2279
+ # @return [String, nil]
2280
+ optional :identity_provider_id, String
2281
+
2282
+ # @!method initialize(id: nil, data: nil, identity_provider_id: nil)
2283
+ # The details for events with this `type`.
2284
+ #
2285
+ # @param id [String] The workload identity provider mapping ID.
2286
+ #
2287
+ # @param data [Object] The payload used to create the workload identity provider mapping.
2288
+ #
2289
+ # @param identity_provider_id [String] The workload identity provider ID.
2290
+ end
2291
+
2292
+ # @see OpenAI::Models::Admin::Organization::AuditLogListResponse#workload_identity_provider_mapping_deleted
2293
+ class WorkloadIdentityProviderMappingDeleted < OpenAI::Internal::Type::BaseModel
2294
+ # @!attribute id
2295
+ # The workload identity provider mapping ID.
2296
+ #
2297
+ # @return [String, nil]
2298
+ optional :id, String
2299
+
2300
+ # @!attribute identity_provider_id
2301
+ # The workload identity provider ID.
2302
+ #
2303
+ # @return [String, nil]
2304
+ optional :identity_provider_id, String
2305
+
2306
+ # @!attribute project_id
2307
+ # The project ID.
2308
+ #
2309
+ # @return [String, nil]
2310
+ optional :project_id, String
2311
+
2312
+ # @!attribute service_account_id
2313
+ # The mapped service account ID.
2314
+ #
2315
+ # @return [String, nil]
2316
+ optional :service_account_id, String
2317
+
2318
+ # @!method initialize(id: nil, identity_provider_id: nil, project_id: nil, service_account_id: nil)
2319
+ # The details for events with this `type`.
2320
+ #
2321
+ # @param id [String] The workload identity provider mapping ID.
2322
+ #
2323
+ # @param identity_provider_id [String] The workload identity provider ID.
2324
+ #
2325
+ # @param project_id [String] The project ID.
2326
+ #
2327
+ # @param service_account_id [String] The mapped service account ID.
2328
+ end
2329
+
2330
+ # @see OpenAI::Models::Admin::Organization::AuditLogListResponse#workload_identity_provider_mapping_updated
2331
+ class WorkloadIdentityProviderMappingUpdated < OpenAI::Internal::Type::BaseModel
2332
+ # @!attribute id
2333
+ # The workload identity provider mapping ID.
2334
+ #
2335
+ # @return [String, nil]
2336
+ optional :id, String
2337
+
2338
+ # @!attribute changes_requested
2339
+ # The payload used to update the workload identity provider mapping.
2340
+ #
2341
+ # @return [Object, nil]
2342
+ optional :changes_requested, OpenAI::Internal::Type::Unknown
2343
+
2344
+ # @!attribute identity_provider_id
2345
+ # The workload identity provider ID.
2346
+ #
2347
+ # @return [String, nil]
2348
+ optional :identity_provider_id, String
2349
+
2350
+ # @!method initialize(id: nil, changes_requested: nil, identity_provider_id: nil)
2351
+ # The details for events with this `type`.
2352
+ #
2353
+ # @param id [String] The workload identity provider mapping ID.
2354
+ #
2355
+ # @param changes_requested [Object] The payload used to update the workload identity provider mapping.
2356
+ #
2357
+ # @param identity_provider_id [String] The workload identity provider ID.
2358
+ end
2359
+
2360
+ # @see OpenAI::Models::Admin::Organization::AuditLogListResponse#workload_identity_provider_created
2361
+ class WorkloadIdentityProviderCreated < OpenAI::Internal::Type::BaseModel
2362
+ # @!attribute id
2363
+ # The workload identity provider ID.
2364
+ #
2365
+ # @return [String, nil]
2366
+ optional :id, String
2367
+
2368
+ # @!attribute data
2369
+ # The payload used to create the workload identity provider.
2370
+ #
2371
+ # @return [Object, nil]
2372
+ optional :data, OpenAI::Internal::Type::Unknown
2373
+
2374
+ # @!method initialize(id: nil, data: nil)
2375
+ # The details for events with this `type`.
2376
+ #
2377
+ # @param id [String] The workload identity provider ID.
2378
+ #
2379
+ # @param data [Object] The payload used to create the workload identity provider.
2380
+ end
2381
+
2382
+ # @see OpenAI::Models::Admin::Organization::AuditLogListResponse#workload_identity_provider_deleted
2383
+ class WorkloadIdentityProviderDeleted < OpenAI::Internal::Type::BaseModel
2384
+ # @!attribute id
2385
+ # The workload identity provider ID.
2386
+ #
2387
+ # @return [String, nil]
2388
+ optional :id, String
2389
+
2390
+ # @!attribute name
2391
+ # The workload identity provider name.
2392
+ #
2393
+ # @return [String, nil]
2394
+ optional :name, String
2395
+
2396
+ # @!method initialize(id: nil, name: nil)
2397
+ # The details for events with this `type`.
2398
+ #
2399
+ # @param id [String] The workload identity provider ID.
2400
+ #
2401
+ # @param name [String] The workload identity provider name.
2402
+ end
2403
+
2404
+ # @see OpenAI::Models::Admin::Organization::AuditLogListResponse#workload_identity_provider_updated
2405
+ class WorkloadIdentityProviderUpdated < OpenAI::Internal::Type::BaseModel
2406
+ # @!attribute id
2407
+ # The workload identity provider ID.
2408
+ #
2409
+ # @return [String, nil]
2410
+ optional :id, String
2411
+
2412
+ # @!attribute changes_requested
2413
+ # The payload used to update the workload identity provider.
2414
+ #
2415
+ # @return [Object, nil]
2416
+ optional :changes_requested, OpenAI::Internal::Type::Unknown
2417
+
2418
+ # @!method initialize(id: nil, changes_requested: nil)
2419
+ # The details for events with this `type`.
2420
+ #
2421
+ # @param id [String] The workload identity provider ID.
2422
+ #
2423
+ # @param changes_requested [Object] The payload used to update the workload identity provider.
2424
+ end
2195
2425
  end
2196
2426
  end
2197
2427
  end
@@ -195,6 +195,14 @@ module OpenAI
195
195
  # prompt caching, which keeps cached prefixes active for longer, up to a maximum
196
196
  # of 24 hours.
197
197
  # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
198
+ # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
199
+ #
200
+ # For older models that support both `in_memory` and `24h`, the default depends on
201
+ # your organization's data retention policy:
202
+ #
203
+ # - Organizations without ZDR enabled default to `24h`.
204
+ # - Organizations with ZDR enabled default to `in_memory` when
205
+ # `prompt_cache_retention` is not specified.
198
206
  #
199
207
  # @return [Symbol, OpenAI::Models::Chat::CompletionCreateParams::PromptCacheRetention, nil]
200
208
  optional :prompt_cache_retention,
@@ -575,6 +583,14 @@ module OpenAI
575
583
  # prompt caching, which keeps cached prefixes active for longer, up to a maximum
576
584
  # of 24 hours.
577
585
  # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
586
+ # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
587
+ #
588
+ # For older models that support both `in_memory` and `24h`, the default depends on
589
+ # your organization's data retention policy:
590
+ #
591
+ # - Organizations without ZDR enabled default to `24h`.
592
+ # - Organizations with ZDR enabled default to `in_memory` when
593
+ # `prompt_cache_retention` is not specified.
578
594
  module PromptCacheRetention
579
595
  extend OpenAI::Internal::Type::Enum
580
596
 
@@ -12,7 +12,7 @@ module OpenAI
12
12
  # Initial items to include in the conversation context. You may add up to 20 items
13
13
  # at a time.
14
14
  #
15
- # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
15
+ # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
16
16
  optional :items,
17
17
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] },
18
18
  nil?: true
@@ -32,7 +32,7 @@ module OpenAI
32
32
  # Some parameter documentations has been truncated, see
33
33
  # {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
34
34
  #
35
- # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
35
+ # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
36
36
  #
37
37
  # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
38
38
  #
@@ -43,6 +43,8 @@ module OpenAI
43
43
 
44
44
  variant :tool_search_output, -> { OpenAI::Responses::ResponseToolSearchOutputItem }
45
45
 
46
+ variant :additional_tools, -> { OpenAI::Conversations::ConversationItem::AdditionalTools }
47
+
46
48
  # A description of the chain of thought used by a reasoning model while generating
47
49
  # a response. Be sure to include these items in your `input` to the Responses API
48
50
  # for subsequent turns of a conversation if you are manually
@@ -147,6 +149,60 @@ module OpenAI
147
149
  end
148
150
  end
149
151
 
152
+ class AdditionalTools < OpenAI::Internal::Type::BaseModel
153
+ # @!attribute id
154
+ # The unique ID of the additional tools item.
155
+ #
156
+ # @return [String]
157
+ required :id, String
158
+
159
+ # @!attribute role
160
+ # The role that provided the additional tools.
161
+ #
162
+ # @return [Symbol, OpenAI::Models::Conversations::ConversationItem::AdditionalTools::Role]
163
+ required :role, enum: -> { OpenAI::Conversations::ConversationItem::AdditionalTools::Role }
164
+
165
+ # @!attribute tools
166
+ # The additional tool definitions made available at this item.
167
+ #
168
+ # @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
169
+ required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
170
+
171
+ # @!attribute type
172
+ # The type of the item. Always `additional_tools`.
173
+ #
174
+ # @return [Symbol, :additional_tools]
175
+ required :type, const: :additional_tools
176
+
177
+ # @!method initialize(id:, role:, tools:, type: :additional_tools)
178
+ # @param id [String] The unique ID of the additional tools item.
179
+ #
180
+ # @param role [Symbol, OpenAI::Models::Conversations::ConversationItem::AdditionalTools::Role] The role that provided the additional tools.
181
+ #
182
+ # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The additional tool definitions made available at this item.
183
+ #
184
+ # @param type [Symbol, :additional_tools] The type of the item. Always `additional_tools`.
185
+
186
+ # The role that provided the additional tools.
187
+ #
188
+ # @see OpenAI::Models::Conversations::ConversationItem::AdditionalTools#role
189
+ module Role
190
+ extend OpenAI::Internal::Type::Enum
191
+
192
+ UNKNOWN = :unknown
193
+ USER = :user
194
+ ASSISTANT = :assistant
195
+ SYSTEM = :system
196
+ CRITIC = :critic
197
+ DISCRIMINATOR = :discriminator
198
+ DEVELOPER = :developer
199
+ TOOL = :tool
200
+
201
+ # @!method self.values
202
+ # @return [Array<Symbol>]
203
+ end
204
+ end
205
+
150
206
  class LocalShellCall < OpenAI::Internal::Type::BaseModel
151
207
  # @!attribute id
152
208
  # The unique ID of the local shell call.
@@ -611,7 +667,7 @@ module OpenAI
611
667
  end
612
668
 
613
669
  # @!method self.variants
614
- # @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
670
+ # @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
615
671
  end
616
672
  end
617
673
 
@@ -8,7 +8,7 @@ module OpenAI
8
8
  # @!attribute data
9
9
  # A list of conversation items.
10
10
  #
11
- # @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
11
+ # @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
12
12
  required :data, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Conversations::ConversationItem] }
13
13
 
14
14
  # @!attribute first_id
@@ -38,7 +38,7 @@ module OpenAI
38
38
  # @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
39
39
  # A list of Conversation items.
40
40
  #
41
- # @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
41
+ # @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
42
42
  #
43
43
  # @param first_id [String] The ID of the first item in the list.
44
44
  #
@@ -16,7 +16,7 @@ module OpenAI
16
16
  # @!attribute items
17
17
  # The items to add to the conversation. You may add up to 20 items at a time.
18
18
  #
19
- # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
19
+ # @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
20
20
  required :items, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] }
21
21
 
22
22
  # @!attribute include
@@ -33,7 +33,7 @@ module OpenAI
33
33
  #
34
34
  # @param conversation_id [String]
35
35
  #
36
- # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] The items to add to the conversation. You may add up to 20 items at a time.
36
+ # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] The items to add to the conversation. You may add up to 20 items at a time.
37
37
  #
38
38
  # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
39
39
  #
@@ -27,7 +27,7 @@ module OpenAI
27
27
  # The compacted list of output items. This is a list of all user messages,
28
28
  # followed by a single compaction item.
29
29
  #
30
- # @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
30
+ # @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
31
31
  required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }
32
32
 
33
33
  # @!attribute usage
@@ -45,7 +45,7 @@ module OpenAI
45
45
  #
46
46
  # @param created_at [Integer] Unix timestamp (in seconds) when the compacted conversation was created.
47
47
  #
48
- # @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] The compacted list of output items. This is a list of all user messages, followe
48
+ # @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] The compacted list of output items. This is a list of all user messages, followe
49
49
  #
50
50
  # @param usage [OpenAI::Models::Responses::ResponseUsage] Token accounting for the compaction pass, including cached, reasoning, and total
51
51
  #