openai 0.95.0 → 0.97.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 (197) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +51 -0
  3. data/README.md +5 -2
  4. data/docs/architecture/security-model.md +2 -2
  5. data/examples/audio/record_and_play.rb +1 -1
  6. data/lib/openai/helpers/live/transcript_grouper.rb +264 -0
  7. data/lib/openai/helpers/live/transcript_grouping.rb +309 -0
  8. data/lib/openai/helpers/live/websocket.rb +454 -0
  9. data/lib/openai/helpers/realtime/translation.rb +440 -0
  10. data/lib/openai/helpers/realtime.rb +1 -0
  11. data/lib/openai/helpers/responses_websocket/incremental.rb +246 -0
  12. data/lib/openai/helpers/responses_websocket/transports/async_websocket.rb +183 -0
  13. data/lib/openai/helpers/responses_websocket.rb +1 -0
  14. data/lib/openai/helpers/streaming/response_stream.rb +19 -11
  15. data/lib/openai/helpers/structured_output/chat_completion_parser.rb +0 -2
  16. data/lib/openai/helpers/structured_output/response_parser.rb +1 -2
  17. data/lib/openai/helpers/structured_output/union_of.rb +0 -2
  18. data/lib/openai/helpers/websocket/async_websocket_transport.rb +11 -6
  19. data/lib/openai/helpers/websocket/connection_manager.rb +9 -0
  20. data/lib/openai/internal/read_io_adapter.rb +0 -2
  21. data/lib/openai/internal/stream.rb +0 -2
  22. data/lib/openai/internal/type/base_model.rb +4 -6
  23. data/lib/openai/internal/type/converter.rb +5 -3
  24. data/lib/openai/internal/type/enum.rb +0 -2
  25. data/lib/openai/internal/type/union.rb +0 -6
  26. data/lib/openai/internal/type/unknown.rb +34 -6
  27. data/lib/openai/internal/util.rb +0 -4
  28. data/lib/openai/models/audio/speech_create_params.rb +9 -0
  29. data/lib/openai/models/audio/transcription_create_response.rb +4 -1
  30. data/lib/openai/models/audio/translation_create_response.rb +4 -1
  31. data/lib/openai/models/beta/agent.rb +3 -2
  32. data/lib/openai/models/beta/agent_browser_authentication_cancel_param.rb +23 -0
  33. data/lib/openai/models/beta/agent_browser_authentication_submit_param.rb +70 -0
  34. data/lib/openai/models/beta/agent_browser_origin_access_param.rb +45 -0
  35. data/lib/openai/models/beta/agent_create_params.rb +5 -2
  36. data/lib/openai/models/beta/agent_output_item.rb +276 -1
  37. data/lib/openai/models/beta/agent_session.rb +252 -5
  38. data/lib/openai/models/beta/agent_session_input_param.rb +64 -1
  39. data/lib/openai/models/beta/agent_session_item.rb +391 -1
  40. data/lib/openai/models/beta/agent_session_turn_item_added_event.rb +2 -2
  41. data/lib/openai/models/beta/agent_session_turn_item_done_event.rb +2 -2
  42. data/lib/openai/models/beta/agent_tool.rb +27 -1
  43. data/lib/openai/models/beta/agent_tool_param.rb +27 -1
  44. data/lib/openai/models/beta/agent_update_params.rb +5 -2
  45. data/lib/openai/models/beta/agents/environments/environment_template.rb +26 -2
  46. data/lib/openai/models/beta/agents/environments/template_create_params.rb +51 -6
  47. data/lib/openai/models/beta/agents/environments/template_update_params.rb +51 -9
  48. data/lib/openai/models/beta/agents/session_create_params.rb +5 -2
  49. data/lib/openai/models/beta/agents/session_update_params.rb +3 -0
  50. data/lib/openai/models/beta/agents/sessions/event_create_params.rb +2 -2
  51. data/lib/openai/models/beta/agents/vaults/credential.rb +10 -1
  52. data/lib/openai/models/beta/agents/vaults/credential_create_params.rb +12 -1
  53. data/lib/openai/models/beta/agents/vaults/credential_update_params.rb +14 -3
  54. data/lib/openai/models/beta/beta_response.rb +38 -1
  55. data/lib/openai/models/beta/beta_responses_client_event.rb +73 -1
  56. data/lib/openai/models/beta/beta_web_search_preview_tool.rb +9 -3
  57. data/lib/openai/models/beta/beta_web_search_tool.rb +9 -3
  58. data/lib/openai/models/beta/environment.rb +26 -2
  59. data/lib/openai/models/beta/environment_param.rb +46 -6
  60. data/lib/openai/models/beta/persisted_agent_tool.rb +27 -1
  61. data/lib/openai/models/beta/persisted_agent_tool_param.rb +27 -1
  62. data/lib/openai/models/beta/response_compact_params.rb +3 -0
  63. data/lib/openai/models/beta/response_create_params.rb +68 -1
  64. data/lib/openai/models/beta/session_turn_error.rb +3 -0
  65. data/lib/openai/models/chat_model.rb +1 -0
  66. data/lib/openai/models/responses/response.rb +35 -1
  67. data/lib/openai/models/responses/response_compact_params.rb +3 -0
  68. data/lib/openai/models/responses/response_create_params.rb +65 -1
  69. data/lib/openai/models/responses/responses_client_event.rb +70 -1
  70. data/lib/openai/models/responses/web_search_preview_tool.rb +9 -3
  71. data/lib/openai/models/responses/web_search_tool.rb +9 -3
  72. data/lib/openai/net_http_client.rb +0 -2
  73. data/lib/openai/resources/audio/transcriptions.rb +5 -3
  74. data/lib/openai/resources/audio/translations.rb +1 -1
  75. data/lib/openai/resources/beta/agents/environments/templates.rb +12 -5
  76. data/lib/openai/resources/beta/agents/sessions/events.rb +1 -1
  77. data/lib/openai/resources/beta/agents/sessions/items.rb +1 -1
  78. data/lib/openai/resources/beta/agents/sessions/subagents/items.rb +1 -1
  79. data/lib/openai/resources/beta/agents/sessions/subagents/turns/items.rb +1 -1
  80. data/lib/openai/resources/beta/agents/vaults/credentials.rb +12 -4
  81. data/lib/openai/resources/beta/agents.rb +2 -2
  82. data/lib/openai/resources/beta/responses.rb +8 -2
  83. data/lib/openai/resources/responses.rb +8 -1
  84. data/lib/openai/version.rb +1 -1
  85. data/lib/openai.rb +4 -0
  86. data/rbi/openai/helpers/live/transcript_grouper.rbi +67 -0
  87. data/rbi/openai/helpers/live/websocket.rbi +299 -0
  88. data/rbi/openai/helpers/realtime/translation.rbi +137 -0
  89. data/rbi/openai/helpers/responses_websocket/incremental.rbi +32 -0
  90. data/rbi/openai/helpers/responses_websocket/transports/async_websocket.rbi +24 -0
  91. data/rbi/openai/helpers/streaming/response_stream.rbi +5 -0
  92. data/rbi/openai/internal/type/converter.rbi +3 -2
  93. data/rbi/openai/models/audio/speech_create_params.rbi +3 -0
  94. data/rbi/openai/models/audio/transcription_create_response.rbi +2 -1
  95. data/rbi/openai/models/audio/translation_create_response.rbi +2 -1
  96. data/rbi/openai/models/beta/agent.rbi +3 -1
  97. data/rbi/openai/models/beta/agent_browser_authentication_cancel_param.rbi +53 -0
  98. data/rbi/openai/models/beta/agent_browser_authentication_submit_param.rbi +125 -0
  99. data/rbi/openai/models/beta/agent_browser_origin_access_param.rbi +76 -0
  100. data/rbi/openai/models/beta/agent_create_params.rbi +9 -3
  101. data/rbi/openai/models/beta/agent_output_item.rbi +422 -0
  102. data/rbi/openai/models/beta/agent_session.rbi +374 -1
  103. data/rbi/openai/models/beta/agent_session_input_param.rbi +102 -0
  104. data/rbi/openai/models/beta/agent_session_item.rbi +614 -0
  105. data/rbi/openai/models/beta/agent_session_turn_item_added_event.rbi +3 -0
  106. data/rbi/openai/models/beta/agent_session_turn_item_done_event.rbi +2 -0
  107. data/rbi/openai/models/beta/agent_tool.rbi +49 -1
  108. data/rbi/openai/models/beta/agent_tool_param.rbi +52 -1
  109. data/rbi/openai/models/beta/agent_update_params.rbi +9 -3
  110. data/rbi/openai/models/beta/agents/environments/environment_template.rbi +53 -2
  111. data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +77 -7
  112. data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +77 -10
  113. data/rbi/openai/models/beta/agents/session_create_params.rbi +9 -3
  114. data/rbi/openai/models/beta/agents/session_update_params.rbi +3 -0
  115. data/rbi/openai/models/beta/agents/sessions/event_create_params.rbi +3 -0
  116. data/rbi/openai/models/beta/agents/vaults/credential.rbi +10 -0
  117. data/rbi/openai/models/beta/agents/vaults/credential_create_params.rbi +15 -0
  118. data/rbi/openai/models/beta/agents/vaults/credential_update_params.rbi +35 -6
  119. data/rbi/openai/models/beta/beta_response.rbi +64 -0
  120. data/rbi/openai/models/beta/beta_responses_client_event.rbi +128 -0
  121. data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +9 -3
  122. data/rbi/openai/models/beta/beta_web_search_tool.rbi +9 -3
  123. data/rbi/openai/models/beta/environment.rbi +53 -2
  124. data/rbi/openai/models/beta/environment_param.rbi +75 -7
  125. data/rbi/openai/models/beta/persisted_agent_tool.rbi +49 -1
  126. data/rbi/openai/models/beta/persisted_agent_tool_param.rbi +52 -1
  127. data/rbi/openai/models/beta/response_compact_params.rbi +1 -0
  128. data/rbi/openai/models/beta/response_create_params.rbi +100 -0
  129. data/rbi/openai/models/beta/session_turn_error.rbi +6 -0
  130. data/rbi/openai/models/chat_model.rbi +1 -0
  131. data/rbi/openai/models/responses/response.rbi +63 -0
  132. data/rbi/openai/models/responses/response_compact_params.rbi +1 -0
  133. data/rbi/openai/models/responses/response_create_params.rbi +106 -0
  134. data/rbi/openai/models/responses/responses_client_event.rbi +125 -0
  135. data/rbi/openai/models/responses/web_search_preview_tool.rbi +9 -3
  136. data/rbi/openai/models/responses/web_search_tool.rbi +9 -3
  137. data/rbi/openai/resources/audio/transcriptions.rbi +4 -2
  138. data/rbi/openai/resources/beta/agents/environments/templates.rbi +10 -3
  139. data/rbi/openai/resources/beta/agents/sessions/events.rbi +1 -0
  140. data/rbi/openai/resources/beta/agents/vaults/credentials.rbi +11 -3
  141. data/rbi/openai/resources/beta/agents.rbi +4 -2
  142. data/rbi/openai/resources/beta/responses.rbi +6 -0
  143. data/rbi/openai/resources/responses.rbi +11 -0
  144. data/responses-websocket.md +55 -0
  145. data/sig/openai/helpers/live/transcript_grouper.rbs +42 -0
  146. data/sig/openai/helpers/live/websocket.rbs +152 -0
  147. data/sig/openai/helpers/realtime/translation.rbs +81 -0
  148. data/sig/openai/helpers/responses_websocket/incremental.rbs +14 -0
  149. data/sig/openai/helpers/responses_websocket/transports/async_websocket.rbs +21 -0
  150. data/sig/openai/helpers/streaming/response_stream.rbs +9 -0
  151. data/sig/openai/internal/type/converter.rbs +3 -1
  152. data/sig/openai/models/audio/speech_create_params.rbs +6 -0
  153. data/sig/openai/models/audio/transcription_create_response.rbs +1 -0
  154. data/sig/openai/models/audio/translation_create_response.rbs +3 -1
  155. data/sig/openai/models/beta/agent.rbs +3 -1
  156. data/sig/openai/models/beta/agent_browser_authentication_cancel_param.rbs +21 -0
  157. data/sig/openai/models/beta/agent_browser_authentication_submit_param.rbs +63 -0
  158. data/sig/openai/models/beta/agent_browser_origin_access_param.rbs +47 -0
  159. data/sig/openai/models/beta/agent_create_params.rbs +5 -1
  160. data/sig/openai/models/beta/agent_output_item.rbs +254 -0
  161. data/sig/openai/models/beta/agent_session.rbs +218 -2
  162. data/sig/openai/models/beta/agent_session_input_param.rbs +51 -1
  163. data/sig/openai/models/beta/agent_session_item.rbs +362 -0
  164. data/sig/openai/models/beta/agent_tool.rbs +22 -0
  165. data/sig/openai/models/beta/agent_tool_param.rbs +25 -0
  166. data/sig/openai/models/beta/agent_update_params.rbs +5 -1
  167. data/sig/openai/models/beta/agents/environments/environment_template.rbs +29 -3
  168. data/sig/openai/models/beta/agents/environments/template_create_params.rbs +41 -6
  169. data/sig/openai/models/beta/agents/environments/template_update_params.rbs +41 -8
  170. data/sig/openai/models/beta/agents/session_create_params.rbs +5 -1
  171. data/sig/openai/models/beta/agents/session_update_params.rbs +5 -1
  172. data/sig/openai/models/beta/agents/vaults/credential.rbs +8 -0
  173. data/sig/openai/models/beta/agents/vaults/credential_create_params.rbs +14 -0
  174. data/sig/openai/models/beta/agents/vaults/credential_update_params.rbs +23 -4
  175. data/sig/openai/models/beta/beta_response.rbs +37 -0
  176. data/sig/openai/models/beta/beta_responses_client_event.rbs +79 -0
  177. data/sig/openai/models/beta/beta_web_search_preview_tool.rbs +6 -2
  178. data/sig/openai/models/beta/beta_web_search_tool.rbs +6 -2
  179. data/sig/openai/models/beta/environment.rbs +29 -3
  180. data/sig/openai/models/beta/environment_param.rbs +41 -6
  181. data/sig/openai/models/beta/persisted_agent_tool.rbs +22 -0
  182. data/sig/openai/models/beta/persisted_agent_tool_param.rbs +25 -0
  183. data/sig/openai/models/beta/response_compact_params.rbs +2 -0
  184. data/sig/openai/models/beta/response_create_params.rbs +79 -0
  185. data/sig/openai/models/beta/session_turn_error.rbs +4 -0
  186. data/sig/openai/models/chat_model.rbs +2 -0
  187. data/sig/openai/models/responses/response.rbs +35 -0
  188. data/sig/openai/models/responses/response_compact_params.rbs +2 -0
  189. data/sig/openai/models/responses/response_create_params.rbs +77 -0
  190. data/sig/openai/models/responses/responses_client_event.rbs +77 -0
  191. data/sig/openai/models/responses/web_search_preview_tool.rbs +6 -2
  192. data/sig/openai/models/responses/web_search_tool.rbs +6 -2
  193. data/sig/openai/resources/beta/agents/environments/templates.rbs +2 -0
  194. data/sig/openai/resources/beta/agents/vaults/credentials.rbs +3 -1
  195. data/sig/openai/resources/beta/responses.rbs +2 -0
  196. data/sig/openai/resources/responses.rbs +4 -0
  197. metadata +23 -1
@@ -11,6 +11,7 @@ module OpenAI
11
11
  type response_create =
12
12
  {
13
13
  ?type: :"response.create",
14
+ ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
14
15
  ?background: bool?,
15
16
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
16
17
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
@@ -49,6 +50,14 @@ module OpenAI
49
50
  # The type of the client event. Always `response.create`.
50
51
  attr_accessor type: :"response.create"
51
52
 
53
+ # Domain-specific access programs to use for this request.
54
+ attr_reader access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms?
55
+
56
+ # Domain-specific access programs to use for this request.
57
+ def access_programs=: (
58
+ OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms
59
+ ) -> OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms
60
+
52
61
  # Whether to run the model response in the background.
53
62
  # [Learn more](https://developers.openai.com/api/docs/guides/background).
54
63
  attr_accessor background: bool?
@@ -398,6 +407,8 @@ module OpenAI
398
407
  # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
399
408
  def user=: (String) -> String
400
409
 
410
+ # @param access_programs
411
+ # Domain-specific access programs to use for this request.
401
412
  # @param background
402
413
  # Whether to run the model response in the background.
403
414
  # [Learn more](https://developers.openai.com/api/docs/guides/background).
@@ -629,6 +640,7 @@ module OpenAI
629
640
  # @param type
630
641
  # The type of the client event. Always `response.create`.
631
642
  def initialize: (
643
+ ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
632
644
  ?background: bool?,
633
645
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
634
646
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
@@ -666,6 +678,7 @@ module OpenAI
666
678
 
667
679
  def to_hash: -> {
668
680
  ?type: :"response.create",
681
+ ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
669
682
  ?background: bool?,
670
683
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
671
684
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
@@ -700,6 +713,70 @@ module OpenAI
700
713
  ?user: String
701
714
  }
702
715
 
716
+ type access_programs =
717
+ {
718
+ ?cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
719
+ }
720
+
721
+ class AccessPrograms < OpenAI::Internal::Type::BaseModel
722
+ # The Cyber access program to use for this request. Supported values are
723
+ # `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
724
+ # the program from the model's Cyber tier and your organization and project
725
+ # access, subject to model-specific eligibility restrictions. By default, models
726
+ # without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
727
+ # authorized; otherwise they fall back to Standard unless the model requires
728
+ # Daybreak access. Red-tier models use Daybreak Red and require authorization.
729
+ # Requests that require unavailable Daybreak access return 403. An implicit
730
+ # Standard fallback is represented by null in the response's access_programs
731
+ # field, rather than an explicit Standard selection.
732
+ attr_reader cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber?
733
+
734
+ # The Cyber access program to use for this request. Supported values are
735
+ # `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
736
+ # the program from the model's Cyber tier and your organization and project
737
+ # access, subject to model-specific eligibility restrictions. By default, models
738
+ # without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
739
+ # authorized; otherwise they fall back to Standard unless the model requires
740
+ # Daybreak access. Red-tier models use Daybreak Red and require authorization.
741
+ # Requests that require unavailable Daybreak access return 403. An implicit
742
+ # Standard fallback is represented by null in the response's access_programs
743
+ # field, rather than an explicit Standard selection.
744
+ def cyber=: (
745
+ OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
746
+ ) -> OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
747
+
748
+ # @param cyber
749
+ # The Cyber access program to use for this request. Supported values are
750
+ # `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
751
+ # the program from the model's Cyber tier and your organization and project
752
+ # access, subject to model-specific eligibility restrictions. By default, models
753
+ # without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
754
+ # authorized; otherwise they fall back to Standard unless the model requires
755
+ # Daybreak access. Red-tier models use Daybreak Red and require authorization.
756
+ # Requests that require unavailable Daybreak access return 403. An implicit
757
+ # Standard fallback is represented by null in the response's access_programs
758
+ # field, rather than an explicit Standard selection.
759
+ def initialize: (
760
+ ?cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
761
+ ) -> void
762
+
763
+ def to_hash: -> {
764
+ ?cyber: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber
765
+ }
766
+
767
+ type cyber = :standard | :daybreak_blue | :daybreak_red
768
+
769
+ module Cyber
770
+ extend OpenAI::Internal::Type::Enum
771
+
772
+ STANDARD: :standard
773
+ DAYBREAK_BLUE: :daybreak_blue
774
+ DAYBREAK_RED: :daybreak_red
775
+
776
+ def self?.values: -> ::Array[OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms::cyber]
777
+ end
778
+ end
779
+
703
780
  type context_management =
704
781
  { type: String, ?compact_threshold: Integer? }
705
782
 
@@ -30,7 +30,9 @@ module OpenAI
30
30
  OpenAI::Models::Responses::WebSearchPreviewTool::search_context_size
31
31
  ) -> OpenAI::Models::Responses::WebSearchPreviewTool::search_context_size
32
32
 
33
- # The user's location.
33
+ # The approximate location of the user. If omitted or null, defaults to the United
34
+ # States. To avoid this fallback, pass `{"type": "approximate"}` without location
35
+ # fields. To localize results, provide the relevant location fields.
34
36
  attr_accessor user_location: OpenAI::Responses::WebSearchPreviewTool::UserLocation?
35
37
 
36
38
  # @param type
@@ -40,7 +42,9 @@ module OpenAI
40
42
  # High level guidance for the amount of context window space to use for the
41
43
  # search. One of `low`, `medium`, or `high`. `medium` is the default.
42
44
  # @param user_location
43
- # The user's location.
45
+ # The approximate location of the user. If omitted or null, defaults to the United
46
+ # States. To avoid this fallback, pass `{"type": "approximate"}` without location
47
+ # fields. To localize results, provide the relevant location fields.
44
48
  def initialize: (
45
49
  type: OpenAI::Models::Responses::WebSearchPreviewTool::type_,
46
50
  ?search_content_types: ::Array[OpenAI::Models::Responses::WebSearchPreviewTool::search_content_type],
@@ -37,7 +37,9 @@ module OpenAI
37
37
  OpenAI::Models::Responses::WebSearchTool::search_context_size
38
38
  ) -> OpenAI::Models::Responses::WebSearchTool::search_context_size
39
39
 
40
- # The approximate location of the user.
40
+ # The approximate location of the user. If omitted or null, defaults to the United
41
+ # States. To avoid this fallback, pass `{"type": "approximate"}` without location
42
+ # fields. To localize results, provide the relevant location fields.
41
43
  attr_accessor user_location: OpenAI::Responses::WebSearchTool::UserLocation?
42
44
 
43
45
  # @param type
@@ -52,7 +54,9 @@ module OpenAI
52
54
  # High level guidance for the amount of context window space to use for the
53
55
  # search. One of `low`, `medium`, or `high`. `medium` is the default.
54
56
  # @param user_location
55
- # The approximate location of the user.
57
+ # The approximate location of the user. If omitted or null, defaults to the United
58
+ # States. To avoid this fallback, pass `{"type": "approximate"}` without location
59
+ # fields. To localize results, provide the relevant location fields.
56
60
  def initialize: (
57
61
  type: OpenAI::Models::Responses::WebSearchTool::type_,
58
62
  ?external_web_access: bool,
@@ -6,6 +6,7 @@ module OpenAI
6
6
  class Templates
7
7
  def create: (
8
8
  ?capability_directories: ::Array[String]?,
9
+ ?desktop: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Desktop?,
9
10
  ?env: ::Hash[Symbol, String]?,
10
11
  ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
11
12
  ?name: String?,
@@ -25,6 +26,7 @@ module OpenAI
25
26
  def update: (
26
27
  String environment_template_id,
27
28
  ?capability_directories: ::Array[String]?,
29
+ ?desktop: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Desktop?,
28
30
  ?env: ::Hash[Symbol, String]?,
29
31
  ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
30
32
  ?name: String?,
@@ -8,6 +8,7 @@ module OpenAI
8
8
  String vault_id,
9
9
  auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth_create_param,
10
10
  name: String,
11
+ ?metadata: ::Hash[Symbol, String],
11
12
  ?request_options: OpenAI::request_opts
12
13
  ) -> OpenAI::Beta::Agents::Vaults::Credential
13
14
 
@@ -20,7 +21,8 @@ module OpenAI
20
21
  def update: (
21
22
  String credential_id,
22
23
  vault_id: String,
23
- auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth_rotate_param,
24
+ ?auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth_rotate_param,
25
+ ?metadata: ::Hash[Symbol, String],
24
26
  ?request_options: OpenAI::request_opts
25
27
  ) -> OpenAI::Beta::Agents::Vaults::Credential
26
28
 
@@ -7,6 +7,7 @@ module OpenAI
7
7
  attr_reader input_tokens: OpenAI::Resources::Beta::Responses::InputTokens
8
8
 
9
9
  def create: (
10
+ ?access_programs: OpenAI::Beta::ResponseCreateParams::AccessPrograms,
10
11
  ?background: bool?,
11
12
  ?context_management: ::Array[OpenAI::Beta::ResponseCreateParams::ContextManagement]?,
12
13
  ?conversation: OpenAI::Models::Beta::ResponseCreateParams::conversation?,
@@ -43,6 +44,7 @@ module OpenAI
43
44
  ) -> OpenAI::Beta::BetaResponse
44
45
 
45
46
  def stream_raw: (
47
+ ?access_programs: OpenAI::Beta::ResponseCreateParams::AccessPrograms,
46
48
  ?background: bool?,
47
49
  ?context_management: ::Array[OpenAI::Beta::ResponseCreateParams::ContextManagement]?,
48
50
  ?conversation: OpenAI::Models::Beta::ResponseCreateParams::conversation?,
@@ -6,6 +6,7 @@ module OpenAI
6
6
  attr_reader input_tokens: OpenAI::Resources::Responses::InputTokens
7
7
 
8
8
  def create: (
9
+ ?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
9
10
  ?background: bool?,
10
11
  ?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
11
12
  ?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
@@ -40,6 +41,7 @@ module OpenAI
40
41
  ) -> OpenAI::Responses::Response
41
42
 
42
43
  def stream_raw: (
44
+ ?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
43
45
  ?background: bool?,
44
46
  ?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
45
47
  ?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
@@ -75,6 +77,7 @@ module OpenAI
75
77
  | OpenAI::Streaming::UnknownStreamEvent)]
76
78
 
77
79
  def stream: (
80
+ ?access_programs: OpenAI::Responses::ResponseCreateParams::AccessPrograms,
78
81
  ?background: bool?,
79
82
  ?include: ::Array[OpenAI::Models::Responses::response_includable]?,
80
83
  ?input: OpenAI::Models::Responses::ResponseCreateParams::input,
@@ -156,6 +159,7 @@ module OpenAI
156
159
  module ConnectionResources
157
160
  class Response
158
161
  def create: (
162
+ ?access_programs: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::AccessPrograms,
159
163
  ?background: bool?,
160
164
  ?context_management: ::Array[OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ContextManagement]?,
161
165
  ?conversation: OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::conversation?,
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.95.0
4
+ version: 0.97.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAI
@@ -94,6 +94,9 @@ files:
94
94
  - lib/openai/helpers/agents/tools.rb
95
95
  - lib/openai/helpers/client_options.rb
96
96
  - lib/openai/helpers/data_residency.rb
97
+ - lib/openai/helpers/live/transcript_grouper.rb
98
+ - lib/openai/helpers/live/transcript_grouping.rb
99
+ - lib/openai/helpers/live/websocket.rb
97
100
  - lib/openai/helpers/local_audio.rb
98
101
  - lib/openai/helpers/local_audio/errors.rb
99
102
  - lib/openai/helpers/local_audio/process.rb
@@ -107,6 +110,7 @@ files:
107
110
  - lib/openai/helpers/realtime/recovery.rb
108
111
  - lib/openai/helpers/realtime/resources/realtime_extension.rb
109
112
  - lib/openai/helpers/realtime/sideband_connection.rb
113
+ - lib/openai/helpers/realtime/translation.rb
110
114
  - lib/openai/helpers/realtime/transports/async_websocket.rb
111
115
  - lib/openai/helpers/realtime/unknown_server_event.rb
112
116
  - lib/openai/helpers/resource_polling.rb
@@ -116,6 +120,7 @@ files:
116
120
  - lib/openai/helpers/responses_websocket/connection_manager.rb
117
121
  - lib/openai/helpers/responses_websocket/connection_resources.rb
118
122
  - lib/openai/helpers/responses_websocket/errors.rb
123
+ - lib/openai/helpers/responses_websocket/incremental.rb
119
124
  - lib/openai/helpers/responses_websocket/resources/responses_extension.rb
120
125
  - lib/openai/helpers/responses_websocket/session.rb
121
126
  - lib/openai/helpers/responses_websocket/transports/async_websocket.rb
@@ -418,6 +423,9 @@ files:
418
423
  - lib/openai/models/batch_retrieve_params.rb
419
424
  - lib/openai/models/batch_usage.rb
420
425
  - lib/openai/models/beta/agent.rb
426
+ - lib/openai/models/beta/agent_browser_authentication_cancel_param.rb
427
+ - lib/openai/models/beta/agent_browser_authentication_submit_param.rb
428
+ - lib/openai/models/beta/agent_browser_origin_access_param.rb
421
429
  - lib/openai/models/beta/agent_close_subagent_call_item.rb
422
430
  - lib/openai/models/beta/agent_command_execution_item.rb
423
431
  - lib/openai/models/beta/agent_content.rb
@@ -1694,6 +1702,8 @@ files:
1694
1702
  - rbi/openai/helpers/agents.rbi
1695
1703
  - rbi/openai/helpers/client_options.rbi
1696
1704
  - rbi/openai/helpers/data_residency.rbi
1705
+ - rbi/openai/helpers/live/transcript_grouper.rbi
1706
+ - rbi/openai/helpers/live/websocket.rbi
1697
1707
  - rbi/openai/helpers/local_audio/interface.rbi
1698
1708
  - rbi/openai/helpers/realtime/connection.rbi
1699
1709
  - rbi/openai/helpers/realtime/connection_manager.rbi
@@ -1701,6 +1711,7 @@ files:
1701
1711
  - rbi/openai/helpers/realtime/extensions.rbi
1702
1712
  - rbi/openai/helpers/realtime/recovery.rbi
1703
1713
  - rbi/openai/helpers/realtime/sideband_connection.rbi
1714
+ - rbi/openai/helpers/realtime/translation.rbi
1704
1715
  - rbi/openai/helpers/realtime/transports/async_websocket.rbi
1705
1716
  - rbi/openai/helpers/realtime/unknown_server_event.rbi
1706
1717
  - rbi/openai/helpers/resource_polling.rbi
@@ -1708,6 +1719,7 @@ files:
1708
1719
  - rbi/openai/helpers/responses_websocket/connection_manager.rbi
1709
1720
  - rbi/openai/helpers/responses_websocket/connection_resources.rbi
1710
1721
  - rbi/openai/helpers/responses_websocket/extensions.rbi
1722
+ - rbi/openai/helpers/responses_websocket/incremental.rbi
1711
1723
  - rbi/openai/helpers/responses_websocket/session.rbi
1712
1724
  - rbi/openai/helpers/responses_websocket/transports/async_websocket.rbi
1713
1725
  - rbi/openai/helpers/responses_websocket/unknown_server_event.rbi
@@ -1999,6 +2011,9 @@ files:
1999
2011
  - rbi/openai/models/batch_retrieve_params.rbi
2000
2012
  - rbi/openai/models/batch_usage.rbi
2001
2013
  - rbi/openai/models/beta/agent.rbi
2014
+ - rbi/openai/models/beta/agent_browser_authentication_cancel_param.rbi
2015
+ - rbi/openai/models/beta/agent_browser_authentication_submit_param.rbi
2016
+ - rbi/openai/models/beta/agent_browser_origin_access_param.rbi
2002
2017
  - rbi/openai/models/beta/agent_close_subagent_call_item.rbi
2003
2018
  - rbi/openai/models/beta/agent_command_execution_item.rbi
2004
2019
  - rbi/openai/models/beta/agent_content.rbi
@@ -3273,6 +3288,8 @@ files:
3273
3288
  - sig/openai/helpers/agents.rbs
3274
3289
  - sig/openai/helpers/client_options.rbs
3275
3290
  - sig/openai/helpers/data_residency.rbs
3291
+ - sig/openai/helpers/live/transcript_grouper.rbs
3292
+ - sig/openai/helpers/live/websocket.rbs
3276
3293
  - sig/openai/helpers/local_audio/interface.rbs
3277
3294
  - sig/openai/helpers/realtime/connection.rbs
3278
3295
  - sig/openai/helpers/realtime/connection_manager.rbs
@@ -3280,6 +3297,7 @@ files:
3280
3297
  - sig/openai/helpers/realtime/extensions.rbs
3281
3298
  - sig/openai/helpers/realtime/recovery.rbs
3282
3299
  - sig/openai/helpers/realtime/sideband_connection.rbs
3300
+ - sig/openai/helpers/realtime/translation.rbs
3283
3301
  - sig/openai/helpers/realtime/transports/async_websocket.rbs
3284
3302
  - sig/openai/helpers/realtime/unknown_server_event.rbs
3285
3303
  - sig/openai/helpers/resource_polling.rbs
@@ -3287,6 +3305,7 @@ files:
3287
3305
  - sig/openai/helpers/responses_websocket/connection_manager.rbs
3288
3306
  - sig/openai/helpers/responses_websocket/connection_resources.rbs
3289
3307
  - sig/openai/helpers/responses_websocket/extensions.rbs
3308
+ - sig/openai/helpers/responses_websocket/incremental.rbs
3290
3309
  - sig/openai/helpers/responses_websocket/session.rbs
3291
3310
  - sig/openai/helpers/responses_websocket/transports/async_websocket.rbs
3292
3311
  - sig/openai/helpers/responses_websocket/unknown_server_event.rbs
@@ -3569,6 +3588,9 @@ files:
3569
3588
  - sig/openai/models/batch_retrieve_params.rbs
3570
3589
  - sig/openai/models/batch_usage.rbs
3571
3590
  - sig/openai/models/beta/agent.rbs
3591
+ - sig/openai/models/beta/agent_browser_authentication_cancel_param.rbs
3592
+ - sig/openai/models/beta/agent_browser_authentication_submit_param.rbs
3593
+ - sig/openai/models/beta/agent_browser_origin_access_param.rbs
3572
3594
  - sig/openai/models/beta/agent_close_subagent_call_item.rbs
3573
3595
  - sig/openai/models/beta/agent_command_execution_item.rbs
3574
3596
  - sig/openai/models/beta/agent_content.rbs