openai 0.124.0 → 0.126.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 (85) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -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/all_models.rb +1 -0
  8. data/lib/openai/models/beta/agent.rb +2 -2
  9. data/lib/openai/models/beta/agent_create_params.rb +9 -9
  10. data/lib/openai/models/beta/agent_session.rb +2 -2
  11. data/lib/openai/models/beta/agent_update_params.rb +9 -12
  12. data/lib/openai/models/beta/agents/automation_agent_config.rb +2 -2
  13. data/lib/openai/models/beta/agents/automation_target_param.rb +9 -12
  14. data/lib/openai/models/beta/agents/one_time_automation.rb +28 -1
  15. data/lib/openai/models/beta/agents/periodic_automation.rb +28 -1
  16. data/lib/openai/models/beta/agents/session_create_params.rb +9 -12
  17. data/lib/openai/models/beta/beta_response.rb +9 -0
  18. data/lib/openai/models/beta/beta_responses_client_event.rb +76 -1
  19. data/lib/openai/models/beta/response_compact_params.rb +9 -0
  20. data/lib/openai/models/beta/response_create_params.rb +70 -1
  21. data/lib/openai/models/chat_model.rb +2 -0
  22. data/lib/openai/models/live/session_config.rb +12 -1
  23. data/lib/openai/models/live/session_resource.rb +12 -1
  24. data/lib/openai/models/responses/response_compact_params.rb +9 -0
  25. data/lib/openai/models/responses/response_create_params.rb +61 -1
  26. data/lib/openai/models/responses/responses_client_event.rb +65 -1
  27. data/lib/openai/models/responses_model.rb +1 -0
  28. data/lib/openai/resources/beta/agents/sessions/events.rb +1 -0
  29. data/lib/openai/resources/beta/agents/sessions.rb +1 -0
  30. data/lib/openai/resources/beta/agents.rb +2 -3
  31. data/lib/openai/resources/beta/responses.rb +12 -2
  32. data/lib/openai/resources/responses.rb +12 -2
  33. data/lib/openai/version.rb +1 -1
  34. data/rbi/openai/internal/transport/base_client.rbi +4 -1
  35. data/rbi/openai/internal/type/base_stream.rbi +5 -0
  36. data/rbi/openai/models/all_models.rbi +1 -0
  37. data/rbi/openai/models/beta/agent.rbi +2 -2
  38. data/rbi/openai/models/beta/agent_create_params.rbi +9 -9
  39. data/rbi/openai/models/beta/agent_session.rbi +2 -2
  40. data/rbi/openai/models/beta/agent_update_params.rbi +9 -12
  41. data/rbi/openai/models/beta/agents/automation_agent_config.rbi +2 -2
  42. data/rbi/openai/models/beta/agents/automation_target_param.rbi +9 -12
  43. data/rbi/openai/models/beta/agents/one_time_automation.rbi +28 -1
  44. data/rbi/openai/models/beta/agents/periodic_automation.rbi +28 -1
  45. data/rbi/openai/models/beta/agents/session_create_params.rbi +9 -12
  46. data/rbi/openai/models/beta/beta_response.rbi +3 -0
  47. data/rbi/openai/models/beta/beta_responses_client_event.rbi +145 -0
  48. data/rbi/openai/models/beta/response_compact_params.rbi +3 -0
  49. data/rbi/openai/models/beta/response_create_params.rbi +116 -0
  50. data/rbi/openai/models/chat_model.rbi +2 -0
  51. data/rbi/openai/models/live/session_config.rbi +12 -0
  52. data/rbi/openai/models/live/session_resource.rbi +12 -0
  53. data/rbi/openai/models/responses/response_compact_params.rbi +3 -0
  54. data/rbi/openai/models/responses/response_create_params.rbi +117 -0
  55. data/rbi/openai/models/responses/responses_client_event.rbi +135 -0
  56. data/rbi/openai/models/responses_model.rbi +1 -0
  57. data/rbi/openai/resources/beta/agents.rbi +2 -3
  58. data/rbi/openai/resources/beta/responses.rbi +10 -0
  59. data/rbi/openai/resources/responses.rbi +12 -0
  60. data/sig/openai/internal/transport/base_client.rbs +1 -0
  61. data/sig/openai/internal/type/base_stream.rbs +2 -0
  62. data/sig/openai/models/all_models.rbs +2 -0
  63. data/sig/openai/models/beta/agent.rbs +2 -2
  64. data/sig/openai/models/beta/agent_create_params.rbs +8 -8
  65. data/sig/openai/models/beta/agent_session.rbs +2 -2
  66. data/sig/openai/models/beta/agent_update_params.rbs +8 -10
  67. data/sig/openai/models/beta/agents/automation_agent_config.rbs +2 -2
  68. data/sig/openai/models/beta/agents/automation_target_param.rbs +8 -10
  69. data/sig/openai/models/beta/agents/one_time_automation.rbs +20 -2
  70. data/sig/openai/models/beta/agents/periodic_automation.rbs +20 -2
  71. data/sig/openai/models/beta/agents/session_create_params.rbs +8 -10
  72. data/sig/openai/models/beta/beta_response.rbs +6 -0
  73. data/sig/openai/models/beta/beta_responses_client_event.rbs +79 -0
  74. data/sig/openai/models/beta/response_compact_params.rbs +6 -0
  75. data/sig/openai/models/beta/response_create_params.rbs +79 -0
  76. data/sig/openai/models/chat_model.rbs +4 -0
  77. data/sig/openai/models/live/session_config.rbs +10 -0
  78. data/sig/openai/models/live/session_resource.rbs +10 -0
  79. data/sig/openai/models/responses/response_compact_params.rbs +6 -0
  80. data/sig/openai/models/responses/response_create_params.rbs +73 -0
  81. data/sig/openai/models/responses/responses_client_event.rbs +73 -0
  82. data/sig/openai/models/responses_model.rbs +2 -0
  83. data/sig/openai/resources/beta/responses.rbs +2 -0
  84. data/sig/openai/resources/responses.rbs +3 -0
  85. metadata +1 -1
@@ -13,6 +13,7 @@ module OpenAI
13
13
  ?type: :"response.create",
14
14
  ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
15
15
  ?background: bool?,
16
+ ?background_options: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions,
16
17
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
17
18
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
18
19
  ?generate: bool,
@@ -64,6 +65,18 @@ module OpenAI
64
65
  # [Learn more](https://developers.openai.com/api/docs/guides/background).
65
66
  attr_accessor background: bool?
66
67
 
68
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
69
+ # windows require `background: true`, Standard processing, and `stream: false` or
70
+ # omitted.
71
+ attr_reader background_options: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions?
72
+
73
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
74
+ # windows require `background: true`, Standard processing, and `stream: false` or
75
+ # omitted.
76
+ def background_options=: (
77
+ OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions
78
+ ) -> OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions
79
+
67
80
  # Context management configuration for this request.
68
81
  attr_accessor context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?
69
82
 
@@ -434,6 +447,10 @@ module OpenAI
434
447
  # @param background
435
448
  # Whether to run the model response in the background.
436
449
  # [Learn more](https://developers.openai.com/api/docs/guides/background).
450
+ # @param background_options
451
+ # Options for background execution on HTTP requests. The `2h` and `8h` completion
452
+ # windows require `background: true`, Standard processing, and `stream: false` or
453
+ # omitted.
437
454
  # @param context_management
438
455
  # Context management configuration for this request.
439
456
  # @param conversation
@@ -672,6 +689,7 @@ module OpenAI
672
689
  def initialize: (
673
690
  ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
674
691
  ?background: bool?,
692
+ ?background_options: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions,
675
693
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
676
694
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
677
695
  ?generate: bool,
@@ -712,6 +730,7 @@ module OpenAI
712
730
  ?type: :"response.create",
713
731
  ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
714
732
  ?background: bool?,
733
+ ?background_options: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions,
715
734
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
716
735
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
717
736
  ?generate: bool,
@@ -811,6 +830,60 @@ module OpenAI
811
830
  end
812
831
  end
813
832
 
833
+ type background_options =
834
+ {
835
+ ?completion_window: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::completion_window,
836
+ ?continuation_id: String
837
+ }
838
+
839
+ class BackgroundOptions < OpenAI::Internal::Type::BaseModel
840
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
841
+ # `8h` select discounted background execution.
842
+ attr_reader completion_window: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::completion_window?
843
+
844
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
845
+ # `8h` select discounted background execution.
846
+ def completion_window=: (
847
+ OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::completion_window
848
+ ) -> OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::completion_window
849
+
850
+ # A customer-provided opaque identifier used to prioritize related background
851
+ # requests. It does not add prior history to the input.
852
+ attr_reader continuation_id: String?
853
+
854
+ # A customer-provided opaque identifier used to prioritize related background
855
+ # requests. It does not add prior history to the input.
856
+ def continuation_id=: (String) -> String
857
+
858
+ # @param completion_window
859
+ # The completion window for background execution. Defaults to `soonest`; `2h` and
860
+ # `8h` select discounted background execution.
861
+ # @param continuation_id
862
+ # A customer-provided opaque identifier used to prioritize related background
863
+ # requests. It does not add prior history to the input.
864
+ def initialize: (
865
+ ?completion_window: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::completion_window,
866
+ ?continuation_id: String
867
+ ) -> void
868
+
869
+ def to_hash: -> {
870
+ ?completion_window: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::completion_window,
871
+ ?continuation_id: String
872
+ }
873
+
874
+ type completion_window = :soonest | :"2h" | :"8h"
875
+
876
+ module CompletionWindow
877
+ extend OpenAI::Internal::Type::Enum
878
+
879
+ SOONEST: :soonest
880
+ COMPLETION_WINDOW_2H: :"2h"
881
+ COMPLETION_WINDOW_8H: :"8h"
882
+
883
+ def self?.values: -> ::Array[OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions::completion_window]
884
+ end
885
+ end
886
+
814
887
  type context_management =
815
888
  { type: String, ?compact_threshold: Integer? }
816
889
 
@@ -31,6 +31,7 @@ module OpenAI
31
31
  | :"gpt-6-cyber"
32
32
  | :"gpt-rosalind-research"
33
33
  | :"gpt-6-rosalind"
34
+ | :"gpt-6.2-astra-law"
34
35
 
35
36
  module ResponsesOnlyModel
36
37
  extend OpenAI::Internal::Type::Enum
@@ -57,6 +58,7 @@ module OpenAI
57
58
  GPT_6_CYBER: :"gpt-6-cyber"
58
59
  GPT_ROSALIND_RESEARCH: :"gpt-rosalind-research"
59
60
  GPT_6_ROSALIND: :"gpt-6-rosalind"
61
+ GPT_6_2_ASTRA_LAW: :"gpt-6.2-astra-law"
60
62
 
61
63
  def self?.values: -> ::Array[OpenAI::Models::ResponsesModel::responses_only_model]
62
64
  end
@@ -17,6 +17,7 @@ module OpenAI
17
17
  def create: (
18
18
  ?access_programs: OpenAI::Beta::ResponseCreateParams::AccessPrograms,
19
19
  ?background: bool?,
20
+ ?background_options: OpenAI::Beta::ResponseCreateParams::BackgroundOptions,
20
21
  ?context_management: ::Array[OpenAI::Beta::ResponseCreateParams::ContextManagement]?,
21
22
  ?conversation: OpenAI::Models::Beta::ResponseCreateParams::conversation?,
22
23
  ?image: OpenAI::Beta::ResponseCreateParams::Image,
@@ -56,6 +57,7 @@ module OpenAI
56
57
  def stream_raw: (
57
58
  ?access_programs: OpenAI::Beta::ResponseCreateParams::AccessPrograms,
58
59
  ?background: bool?,
60
+ ?background_options: OpenAI::Beta::ResponseCreateParams::BackgroundOptions,
59
61
  ?context_management: ::Array[OpenAI::Beta::ResponseCreateParams::ContextManagement]?,
60
62
  ?conversation: OpenAI::Models::Beta::ResponseCreateParams::conversation?,
61
63
  ?image: OpenAI::Beta::ResponseCreateParams::Image,
@@ -16,6 +16,7 @@ module OpenAI
16
16
  def create: (
17
17
  ?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
18
18
  ?background: bool?,
19
+ ?background_options: OpenAI::Responses::ResponseCreateParams::BackgroundOptions,
19
20
  ?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
20
21
  ?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
21
22
  ?image: OpenAI::Responses::ResponseCreateParams::Image,
@@ -53,6 +54,7 @@ module OpenAI
53
54
  def stream_raw: (
54
55
  ?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
55
56
  ?background: bool?,
57
+ ?background_options: OpenAI::Responses::ResponseCreateParams::BackgroundOptions,
56
58
  ?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
57
59
  ?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
58
60
  ?image: OpenAI::Responses::ResponseCreateParams::Image,
@@ -143,6 +145,7 @@ module OpenAI
143
145
  def create: (
144
146
  ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
145
147
  ?background: bool?,
148
+ ?background_options: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::BackgroundOptions,
146
149
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
147
150
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
148
151
  ?generate: bool,
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.124.0
4
+ version: 0.126.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAI