openai 0.98.0 → 0.100.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 (245) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/bedrock.md +17 -1
  5. data/lib/openai/client.rb +9 -0
  6. data/lib/openai/helpers/agents/session_stream.rb +11 -36
  7. data/lib/openai/helpers/agents/tools.rb +34 -4
  8. data/lib/openai/helpers/beta/agents/creation_stream.rb +26 -0
  9. data/lib/openai/helpers/beta/agents/function_tool.rb +11 -4
  10. data/lib/openai/helpers/beta/agents/tool_dispatcher.rb +74 -0
  11. data/lib/openai/helpers/beta/agents/tool_error.rb +28 -0
  12. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +140 -5
  13. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +140 -5
  14. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +140 -5
  15. data/lib/openai/models/admin/organization/usage_completions_params.rb +9 -4
  16. data/lib/openai/models/admin/organization/usage_completions_response.rb +140 -5
  17. data/lib/openai/models/admin/organization/usage_costs_params.rb +16 -4
  18. data/lib/openai/models/admin/organization/usage_costs_response.rb +140 -5
  19. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +140 -5
  20. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +140 -5
  21. data/lib/openai/models/admin/organization/usage_images_response.rb +140 -5
  22. data/lib/openai/models/admin/organization/usage_moderations_response.rb +140 -5
  23. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +140 -5
  24. data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +9 -4
  25. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +140 -5
  26. data/lib/openai/models/all_models.rb +42 -0
  27. data/lib/openai/models/audio/speech_create_params.rb +6 -0
  28. data/lib/openai/models/audio/voice.rb +75 -0
  29. data/lib/openai/models/audio/voice_create_params.rb +217 -0
  30. data/lib/openai/models/beta/agent_create_params.rb +0 -3
  31. data/lib/openai/models/beta/agent_update_params.rb +0 -3
  32. data/lib/openai/models/beta/agents/environments/template_create_params.rb +6 -6
  33. data/lib/openai/models/beta/agents/environments/template_update_params.rb +3 -6
  34. data/lib/openai/models/beta/agents/session_create_params.rb +0 -3
  35. data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
  36. data/lib/openai/models/beta/agents/sessions/turns/item_list_params.rb +79 -0
  37. data/lib/openai/models/beta/beta_response.rb +220 -0
  38. data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +2 -2
  39. data/lib/openai/models/beta/beta_response_error.rb +12 -1
  40. data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
  41. data/lib/openai/models/beta/beta_responses_server_event.rb +12 -1
  42. data/lib/openai/models/beta/beta_tool.rb +15 -18
  43. data/lib/openai/models/beta/environment_param.rb +6 -6
  44. data/lib/openai/models/beta/response_compact_params.rb +220 -0
  45. data/lib/openai/models/beta/response_create_params.rb +220 -0
  46. data/lib/openai/models/beta/session_turn_error.rb +9 -0
  47. data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
  48. data/lib/openai/models/chat/chat_completion_chunk.rb +85 -18
  49. data/lib/openai/models/chat_model.rb +178 -0
  50. data/lib/openai/models/error_object.rb +12 -1
  51. data/lib/openai/models/eval_create_params.rb +1 -1
  52. data/lib/openai/models/eval_create_response.rb +1 -1
  53. data/lib/openai/models/eval_list_response.rb +1 -1
  54. data/lib/openai/models/eval_retrieve_response.rb +1 -1
  55. data/lib/openai/models/eval_update_response.rb +1 -1
  56. data/lib/openai/models/fine_tuning/job_list_params.rb +14 -4
  57. data/lib/openai/models/graders/score_model_grader.rb +2 -2
  58. data/lib/openai/models/image.rb +14 -14
  59. data/lib/openai/models/image_create_variation_params.rb +7 -7
  60. data/lib/openai/models/image_edit_params.rb +88 -96
  61. data/lib/openai/models/image_generate_params.rb +51 -62
  62. data/lib/openai/models/image_model.rb +5 -3
  63. data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
  64. data/lib/openai/models/realtime/realtime_client_event.rb +9 -0
  65. data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
  66. data/lib/openai/models/realtime/session_update_event.rb +16 -0
  67. data/lib/openai/models/responses/response_compact_params.rb +220 -0
  68. data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +2 -2
  69. data/lib/openai/models/responses/response_error.rb +12 -1
  70. data/lib/openai/models/responses/responses_server_event.rb +12 -1
  71. data/lib/openai/models/responses/tool.rb +15 -18
  72. data/lib/openai/models/responses_model.rb +42 -0
  73. data/lib/openai/models/video_create_error.rb +12 -1
  74. data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +109 -0
  75. data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb +106 -0
  76. data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb +86 -0
  77. data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb +86 -0
  78. data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb +86 -0
  79. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +18 -2
  80. data/lib/openai/models/webhooks/webhook_create_params.rb +5 -0
  81. data/lib/openai/models/webhooks/webhook_test_params.rb +5 -0
  82. data/lib/openai/models/webhooks/webhook_update_params.rb +5 -0
  83. data/lib/openai/providers/bedrock.rb +20 -1
  84. data/lib/openai/resources/admin/organization/usage.rb +15 -6
  85. data/lib/openai/resources/audio/speech.rb +2 -0
  86. data/lib/openai/resources/audio/voices.rb +53 -0
  87. data/lib/openai/resources/audio.rb +5 -0
  88. data/lib/openai/resources/beta/agents/environments/templates.rb +3 -4
  89. data/lib/openai/resources/beta/agents/sessions/turns/items.rb +68 -0
  90. data/lib/openai/resources/beta/agents/sessions/turns.rb +4 -0
  91. data/lib/openai/resources/beta/agents/sessions.rb +22 -2
  92. data/lib/openai/resources/fine_tuning/jobs.rb +7 -2
  93. data/lib/openai/resources/images.rb +79 -109
  94. data/lib/openai/resources/webhooks.rb +1 -1
  95. data/lib/openai/version.rb +1 -1
  96. data/lib/openai.rb +10 -0
  97. data/rbi/openai/helpers/agents.rbi +2 -0
  98. data/rbi/openai/helpers/beta/agents/function_tool.rbi +8 -3
  99. data/rbi/openai/helpers/beta/agents/tool_error.rbi +19 -0
  100. data/rbi/openai/helpers/beta/agents.rbi +12 -0
  101. data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +213 -3
  102. data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +213 -3
  103. data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +213 -3
  104. data/rbi/openai/models/admin/organization/usage_completions_params.rbi +9 -4
  105. data/rbi/openai/models/admin/organization/usage_completions_response.rbi +213 -3
  106. data/rbi/openai/models/admin/organization/usage_costs_params.rbi +16 -4
  107. data/rbi/openai/models/admin/organization/usage_costs_response.rbi +213 -3
  108. data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +213 -3
  109. data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +213 -3
  110. data/rbi/openai/models/admin/organization/usage_images_response.rbi +213 -3
  111. data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +213 -3
  112. data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +213 -3
  113. data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +12 -4
  114. data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +213 -3
  115. data/rbi/openai/models/audio/speech_create_params.rbi +6 -0
  116. data/rbi/openai/models/audio/voice.rbi +111 -0
  117. data/rbi/openai/models/audio/voice_create_params.rbi +321 -0
  118. data/rbi/openai/models/beta/agent_create_params.rbi +0 -3
  119. data/rbi/openai/models/beta/agent_update_params.rbi +0 -3
  120. data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +6 -6
  121. data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +3 -6
  122. data/rbi/openai/models/beta/agents/session_create_params.rbi +0 -3
  123. data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
  124. data/rbi/openai/models/beta/agents/sessions/turns/item_list_params.rbi +139 -0
  125. data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +2 -2
  126. data/rbi/openai/models/beta/beta_response_error.rbi +12 -0
  127. data/rbi/openai/models/beta/beta_responses_server_event.rbi +12 -0
  128. data/rbi/openai/models/beta/beta_tool.rbi +15 -18
  129. data/rbi/openai/models/beta/environment_param.rbi +6 -6
  130. data/rbi/openai/models/beta/session_turn_error.rbi +18 -0
  131. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
  132. data/rbi/openai/models/chat/chat_completion_chunk.rbi +123 -17
  133. data/rbi/openai/models/error_object.rbi +12 -0
  134. data/rbi/openai/models/eval_create_params.rbi +1 -1
  135. data/rbi/openai/models/eval_create_response.rbi +1 -1
  136. data/rbi/openai/models/eval_list_response.rbi +1 -1
  137. data/rbi/openai/models/eval_retrieve_response.rbi +1 -1
  138. data/rbi/openai/models/eval_update_response.rbi +1 -1
  139. data/rbi/openai/models/fine_tuning/job_list_params.rbi +14 -4
  140. data/rbi/openai/models/graders/score_model_grader.rbi +2 -2
  141. data/rbi/openai/models/image.rbi +14 -14
  142. data/rbi/openai/models/image_create_variation_params.rbi +6 -6
  143. data/rbi/openai/models/image_edit_params.rbi +73 -91
  144. data/rbi/openai/models/image_generate_params.rbi +30 -61
  145. data/rbi/openai/models/image_model.rbi +3 -3
  146. data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +9 -6
  147. data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +9 -6
  148. data/rbi/openai/models/realtime/session_update_event.rbi +16 -0
  149. data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +2 -2
  150. data/rbi/openai/models/responses/response_error.rbi +12 -0
  151. data/rbi/openai/models/responses/responses_server_event.rbi +12 -0
  152. data/rbi/openai/models/responses/tool.rbi +15 -18
  153. data/rbi/openai/models/video_create_error.rbi +12 -0
  154. data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +222 -0
  155. data/rbi/openai/models/webhooks/agent_session_created_webhook_event.rbi +202 -0
  156. data/rbi/openai/models/webhooks/agent_session_failed_webhook_event.rbi +151 -0
  157. data/rbi/openai/models/webhooks/agent_session_idle_webhook_event.rbi +151 -0
  158. data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi +151 -0
  159. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +7 -1
  160. data/rbi/openai/models/webhooks/webhook_create_params.rbi +20 -0
  161. data/rbi/openai/models/webhooks/webhook_test_params.rbi +20 -0
  162. data/rbi/openai/models/webhooks/webhook_update_params.rbi +20 -0
  163. data/rbi/openai/resources/admin/organization/usage.rbi +15 -6
  164. data/rbi/openai/resources/audio/speech.rbi +2 -0
  165. data/rbi/openai/resources/audio/voices.rbi +49 -0
  166. data/rbi/openai/resources/audio.rbi +4 -0
  167. data/rbi/openai/resources/beta/agents/environments/templates.rbi +3 -4
  168. data/rbi/openai/resources/beta/agents/sessions/turns/items.rbi +62 -0
  169. data/rbi/openai/resources/beta/agents/sessions/turns.rbi +3 -0
  170. data/rbi/openai/resources/beta/agents/sessions.rbi +2 -0
  171. data/rbi/openai/resources/fine_tuning/jobs.rbi +7 -2
  172. data/rbi/openai/resources/images.rbi +77 -109
  173. data/rbi/openai/resources/webhooks.rbi +5 -0
  174. data/sig/openai/helpers/agents.rbs +3 -0
  175. data/sig/openai/helpers/beta/agents/function_tool.rbs +5 -2
  176. data/sig/openai/helpers/beta/agents/tool_error.rbs +17 -0
  177. data/sig/openai/helpers/beta/agents.rbs +5 -0
  178. data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +107 -5
  179. data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +107 -5
  180. data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +107 -5
  181. data/sig/openai/models/admin/organization/usage_completions_params.rbs +14 -6
  182. data/sig/openai/models/admin/organization/usage_completions_response.rbs +107 -5
  183. data/sig/openai/models/admin/organization/usage_costs_params.rbs +25 -7
  184. data/sig/openai/models/admin/organization/usage_costs_response.rbs +107 -5
  185. data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +107 -5
  186. data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +107 -5
  187. data/sig/openai/models/admin/organization/usage_images_response.rbs +107 -5
  188. data/sig/openai/models/admin/organization/usage_moderations_response.rbs +107 -5
  189. data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +107 -5
  190. data/sig/openai/models/admin/organization/usage_web_search_calls_params.rbs +19 -7
  191. data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +107 -5
  192. data/sig/openai/models/audio/speech_create_params.rbs +4 -0
  193. data/sig/openai/models/audio/voice.rbs +70 -0
  194. data/sig/openai/models/audio/voice_create_params.rbs +203 -0
  195. data/sig/openai/models/beta/agent_create_params.rbs +1 -5
  196. data/sig/openai/models/beta/agent_update_params.rbs +1 -5
  197. data/sig/openai/models/beta/agents/environments/template_create_params.rbs +4 -4
  198. data/sig/openai/models/beta/agents/environments/template_update_params.rbs +2 -4
  199. data/sig/openai/models/beta/agents/session_create_params.rbs +1 -5
  200. data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
  201. data/sig/openai/models/beta/agents/sessions/turns/item_list_params.rbs +91 -0
  202. data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +2 -2
  203. data/sig/openai/models/beta/beta_response_error.rbs +10 -0
  204. data/sig/openai/models/beta/beta_responses_server_event.rbs +10 -0
  205. data/sig/openai/models/beta/beta_tool.rbs +11 -15
  206. data/sig/openai/models/beta/environment_param.rbs +4 -4
  207. data/sig/openai/models/beta/session_turn_error.rbs +12 -0
  208. data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
  209. data/sig/openai/models/chat/chat_completion_chunk.rbs +96 -12
  210. data/sig/openai/models/error_object.rbs +10 -0
  211. data/sig/openai/models/eval_create_params.rbs +1 -1
  212. data/sig/openai/models/eval_create_response.rbs +1 -1
  213. data/sig/openai/models/eval_list_response.rbs +1 -1
  214. data/sig/openai/models/eval_retrieve_response.rbs +1 -1
  215. data/sig/openai/models/eval_update_response.rbs +1 -1
  216. data/sig/openai/models/fine_tuning/job_list_params.rbs +14 -4
  217. data/sig/openai/models/graders/score_model_grader.rbs +3 -3
  218. data/sig/openai/models/image.rbs +21 -21
  219. data/sig/openai/models/image_create_variation_params.rbs +4 -4
  220. data/sig/openai/models/image_edit_params.rbs +54 -66
  221. data/sig/openai/models/image_generate_params.rbs +23 -45
  222. data/sig/openai/models/image_model.rbs +6 -6
  223. data/sig/openai/models/realtime/realtime_audio_config_output.rbs +9 -6
  224. data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +9 -6
  225. data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs +2 -2
  226. data/sig/openai/models/responses/response_error.rbs +10 -0
  227. data/sig/openai/models/responses/responses_server_event.rbs +10 -0
  228. data/sig/openai/models/responses/tool.rbs +11 -15
  229. data/sig/openai/models/video_create_error.rbs +10 -0
  230. data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +114 -0
  231. data/sig/openai/models/webhooks/agent_session_created_webhook_event.rbs +115 -0
  232. data/sig/openai/models/webhooks/agent_session_failed_webhook_event.rbs +89 -0
  233. data/sig/openai/models/webhooks/agent_session_idle_webhook_event.rbs +89 -0
  234. data/sig/openai/models/webhooks/agent_session_in_progress_webhook_event.rbs +89 -0
  235. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +6 -1
  236. data/sig/openai/models/webhooks/webhook_create_params.rbs +10 -0
  237. data/sig/openai/models/webhooks/webhook_test_params.rbs +10 -0
  238. data/sig/openai/models/webhooks/webhook_update_params.rbs +10 -0
  239. data/sig/openai/resources/audio/voices.rbs +14 -0
  240. data/sig/openai/resources/audio.rbs +2 -0
  241. data/sig/openai/resources/beta/agents/sessions/turns/items.rbs +24 -0
  242. data/sig/openai/resources/beta/agents/sessions/turns.rbs +2 -0
  243. data/sig/openai/resources/beta/agents/sessions.rbs +1 -0
  244. data/sig/openai/resources/webhooks.rbs +6 -1
  245. metadata +35 -1
@@ -129,8 +129,7 @@ module OpenAI
129
129
  end
130
130
  end
131
131
 
132
- type service_tier =
133
- :auto | :default | :flex | :priority | :fast | :ultrafast
132
+ type service_tier = :auto | :default | :flex | :priority | :fast
134
133
 
135
134
  module ServiceTier
136
135
  extend OpenAI::Internal::Type::Enum
@@ -150,9 +149,6 @@ module OpenAI
150
149
  # Uses the fast service tier.
151
150
  FAST: :fast
152
151
 
153
- # Uses the ultrafast service tier.
154
- ULTRAFAST: :ultrafast
155
-
156
152
  def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::service_tier]
157
153
  end
158
154
  end
@@ -0,0 +1,91 @@
1
+ module OpenAI
2
+ module Models
3
+ module Beta
4
+ module Agents
5
+ module Sessions
6
+ module Turns
7
+ type item_list_params =
8
+ {
9
+ session_id: String,
10
+ turn_id: String,
11
+ ?after: String,
12
+ ?limit: Integer,
13
+ ?order: OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::order,
14
+ ?request_options: OpenAI::request_opts
15
+ }
16
+
17
+ class ItemListParams < OpenAI::Internal::Type::BaseModel
18
+ extend OpenAI::Internal::Type::RequestParameters::Converter
19
+ include OpenAI::Internal::Type::RequestParameters
20
+
21
+ attr_accessor session_id: String
22
+
23
+ attr_accessor turn_id: String
24
+
25
+ # Return items after this cursor in the selected order. Pass the previous
26
+ # response's last_id, which can differ from the last item's ID.
27
+ attr_reader after: String?
28
+
29
+ # Return items after this cursor in the selected order. Pass the previous
30
+ # response's last_id, which can differ from the last item's ID.
31
+ def after=: (String) -> String
32
+
33
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
34
+ attr_reader limit: Integer?
35
+
36
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
37
+ def limit=: (Integer) -> Integer
38
+
39
+ # The order in which resources are returned. Defaults to `desc`.
40
+ attr_reader order: OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::order?
41
+
42
+ # The order in which resources are returned. Defaults to `desc`.
43
+ def order=: (
44
+ OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::order
45
+ ) -> OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::order
46
+
47
+ # @param after
48
+ # Return items after this cursor in the selected order. Pass the previous
49
+ # response's last_id, which can differ from the last item's ID.
50
+ # @param limit
51
+ # The maximum number of resources to return, between 1 and 100. Defaults to 20.
52
+ # @param order
53
+ # The order in which resources are returned. Defaults to `desc`.
54
+ def initialize: (
55
+ session_id: String,
56
+ turn_id: String,
57
+ ?after: String,
58
+ ?limit: Integer,
59
+ ?order: OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::order,
60
+ ?request_options: OpenAI::request_opts
61
+ ) -> void
62
+
63
+ def to_hash: -> {
64
+ session_id: String,
65
+ turn_id: String,
66
+ ?after: String,
67
+ ?limit: Integer,
68
+ ?order: OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::order,
69
+ ?request_options: OpenAI::RequestOptions
70
+ }
71
+
72
+ type order = :asc | :desc
73
+
74
+ module Order
75
+ extend OpenAI::Internal::Type::Enum
76
+
77
+ # Returns resources in ascending order.
78
+ ASC: :asc
79
+
80
+ # Returns resources in descending order.
81
+ DESC: :desc
82
+
83
+ def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::Sessions::Turns::ItemListParams::order]
84
+ end
85
+ end
86
+ end
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end
@@ -16,7 +16,7 @@ module OpenAI
16
16
  }
17
17
 
18
18
  class BetaResponseComputerToolCallOutputItem < OpenAI::Internal::Type::BaseModel
19
- # The unique ID of the computer call tool output.
19
+ # The ID of the computer tool call output.
20
20
  attr_accessor id: String
21
21
 
22
22
  # The ID of the computer tool call that produced the output.
@@ -52,7 +52,7 @@ module OpenAI
52
52
  def created_by=: (String) -> String
53
53
 
54
54
  # @param id
55
- # The unique ID of the computer call tool output.
55
+ # The ID of the computer tool call output.
56
56
  # @param call_id
57
57
  # The ID of the computer tool call that produced the output.
58
58
  # @param output
@@ -94,6 +94,7 @@ module OpenAI
94
94
  {
95
95
  ?detailed_explanation: String,
96
96
  ?error_type: OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type,
97
+ ?review_target: String?,
97
98
  ?steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer
98
99
  }
99
100
 
@@ -112,6 +113,10 @@ module OpenAI
112
113
  OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type
113
114
  ) -> OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type
114
115
 
116
+ # An opaque target for explicitly continuing this review, or null when
117
+ # unavailable.
118
+ attr_accessor review_target: String?
119
+
115
120
  # An optional public continuation instruction.
116
121
  attr_reader steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer?
117
122
 
@@ -124,17 +129,22 @@ module OpenAI
124
129
  # The public explanation for this block.
125
130
  # @param error_type
126
131
  # An optional classification; clients must accept additional values.
132
+ # @param review_target
133
+ # An opaque target for explicitly continuing this review, or null when
134
+ # unavailable.
127
135
  # @param steer
128
136
  # An optional public continuation instruction.
129
137
  def initialize: (
130
138
  ?detailed_explanation: String,
131
139
  ?error_type: OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type,
140
+ ?review_target: String?,
132
141
  ?steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer
133
142
  ) -> void
134
143
 
135
144
  def to_hash: -> {
136
145
  ?detailed_explanation: String,
137
146
  ?error_type: OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type,
147
+ ?review_target: String?,
138
148
  ?steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer
139
149
  }
140
150
 
@@ -3376,6 +3376,7 @@ module OpenAI
3376
3376
  {
3377
3377
  ?detailed_explanation: String,
3378
3378
  ?error_type: OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::error_type,
3379
+ ?review_target: String?,
3379
3380
  ?steer: OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer
3380
3381
  }
3381
3382
 
@@ -3394,6 +3395,10 @@ module OpenAI
3394
3395
  OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::error_type
3395
3396
  ) -> OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::error_type
3396
3397
 
3398
+ # An opaque target for explicitly continuing this review, or null when
3399
+ # unavailable.
3400
+ attr_accessor review_target: String?
3401
+
3397
3402
  # An optional public continuation instruction.
3398
3403
  attr_reader steer: OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer?
3399
3404
 
@@ -3406,17 +3411,22 @@ module OpenAI
3406
3411
  # The public explanation for this block.
3407
3412
  # @param error_type
3408
3413
  # An optional classification; clients must accept additional values.
3414
+ # @param review_target
3415
+ # An opaque target for explicitly continuing this review, or null when
3416
+ # unavailable.
3409
3417
  # @param steer
3410
3418
  # An optional public continuation instruction.
3411
3419
  def initialize: (
3412
3420
  ?detailed_explanation: String,
3413
3421
  ?error_type: OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::error_type,
3422
+ ?review_target: String?,
3414
3423
  ?steer: OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer
3415
3424
  ) -> void
3416
3425
 
3417
3426
  def to_hash: -> {
3418
3427
  ?detailed_explanation: String,
3419
3428
  ?error_type: OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::error_type,
3429
+ ?review_target: String?,
3420
3430
  ?steer: OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer
3421
3431
  }
3422
3432
 
@@ -643,9 +643,10 @@ module OpenAI
643
643
  OpenAI::Models::Beta::BetaTool::ImageGeneration::background
644
644
  ) -> OpenAI::Models::Beta::BetaTool::ImageGeneration::background
645
645
 
646
- # Controls fidelity to the original input image(s). This parameter is supported
647
- # for GPT image models that support input fidelity. `gpt-image-2` and
648
- # `gpt-image-2-2026-04-21` ignore this parameter.
646
+ # Control how much effort the model will exert to match the style and features,
647
+ # especially facial features, of input images. Supports `high` and `low` on
648
+ # `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
649
+ # `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
649
650
  attr_accessor input_fidelity: OpenAI::Models::Beta::BetaTool::ImageGeneration::input_fidelity?
650
651
 
651
652
  # Optional mask for inpainting. Contains `image_url` (string, optional) and
@@ -729,9 +730,7 @@ module OpenAI
729
730
  # the maximum supported resolution is `3840x2160`. The requested size must also
730
731
  # satisfy the model's current pixel and edge limits. The standard sizes
731
732
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
732
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
733
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
734
- # `1024x1024`, `1792x1024`, or `1024x1792`.
733
+ # `auto` is supported for models that allow automatic sizing.
735
734
  attr_reader size: OpenAI::Models::Beta::BetaTool::ImageGeneration::size?
736
735
 
737
736
  # The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
@@ -743,9 +742,7 @@ module OpenAI
743
742
  # the maximum supported resolution is `3840x2160`. The requested size must also
744
743
  # satisfy the model's current pixel and edge limits. The standard sizes
745
744
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
746
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
747
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
748
- # `1024x1024`, `1792x1024`, or `1024x1792`.
745
+ # `auto` is supported for models that allow automatic sizing.
749
746
  def size=: (
750
747
  OpenAI::Models::Beta::BetaTool::ImageGeneration::size
751
748
  ) -> OpenAI::Models::Beta::BetaTool::ImageGeneration::size
@@ -763,9 +760,10 @@ module OpenAI
763
760
  # `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
764
761
  # set the output format to `png` or `webp`.
765
762
  # @param input_fidelity
766
- # Controls fidelity to the original input image(s). This parameter is supported
767
- # for GPT image models that support input fidelity. `gpt-image-2` and
768
- # `gpt-image-2-2026-04-21` ignore this parameter.
763
+ # Control how much effort the model will exert to match the style and features,
764
+ # especially facial features, of input images. Supports `high` and `low` on
765
+ # `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
766
+ # `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
769
767
  # @param input_image_mask
770
768
  # Optional mask for inpainting. Contains `image_url` (string, optional) and
771
769
  # `file_id` (string, optional).
@@ -800,9 +798,7 @@ module OpenAI
800
798
  # the maximum supported resolution is `3840x2160`. The requested size must also
801
799
  # satisfy the model's current pixel and edge limits. The standard sizes
802
800
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
803
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
804
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
805
- # `1024x1024`, `1792x1024`, or `1024x1792`.
801
+ # `auto` is supported for models that allow automatic sizing.
806
802
  # @param type
807
803
  # The type of the image generation tool. Always `image_generation`.
808
804
  def initialize: (
@@ -72,8 +72,8 @@ module OpenAI
72
72
  # Files available before the agent starts. Defaults to an empty list.
73
73
  attr_accessor files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?
74
74
 
75
- # Network access policy for the environment. Defaults to disabled for GA requests
76
- # and enabled for beta requests.
75
+ # Network access policy for the environment. If omitted, the API version
76
+ # determines whether network access is enabled or disabled.
77
77
  attr_accessor network: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network?
78
78
 
79
79
  # Packages to install in the environment. Defaults to empty package lists.
@@ -105,8 +105,8 @@ module OpenAI
105
105
  # @param files
106
106
  # Files available before the agent starts. Defaults to an empty list.
107
107
  # @param network
108
- # Network access policy for the environment. Defaults to disabled for GA requests
109
- # and enabled for beta requests.
108
+ # Network access policy for the environment. If omitted, the API version
109
+ # determines whether network access is enabled or disabled.
110
110
  # @param packages
111
111
  # Packages to install in the environment. Defaults to empty package lists.
112
112
  # @param plugins
@@ -29,6 +29,9 @@ module OpenAI
29
29
  :context_length_exceeded
30
30
  | :session_budget_exceeded
31
31
  | :usage_limit_exceeded
32
+ | :project_spend_limit_exceeded
33
+ | :organization_spend_limit_exceeded
34
+ | :organization_usage_limit_exceeded
32
35
  | :credit_balance_exhausted
33
36
  | :rate_limit_exceeded
34
37
  | :flex_unavailable
@@ -58,6 +61,15 @@ module OpenAI
58
61
  # The organization has reached a usage, plan, or billing limit.
59
62
  USAGE_LIMIT_EXCEEDED: :usage_limit_exceeded
60
63
 
64
+ # The project has reached its enforced spend limit.
65
+ PROJECT_SPEND_LIMIT_EXCEEDED: :project_spend_limit_exceeded
66
+
67
+ # The organization has reached its enforced spend limit.
68
+ ORGANIZATION_SPEND_LIMIT_EXCEEDED: :organization_spend_limit_exceeded
69
+
70
+ # The organization has reached its OpenAI-assigned usage limit.
71
+ ORGANIZATION_USAGE_LIMIT_EXCEEDED: :organization_usage_limit_exceeded
72
+
61
73
  # The organization has no API credits remaining.
62
74
  CREDIT_BALANCE_EXHAUSTED: :credit_balance_exhausted
63
75
 
@@ -17,7 +17,8 @@ module OpenAI
17
17
  # The voice the model uses to respond. Supported built-in voices are `alloy`,
18
18
  # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
19
19
  # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
20
- # for example `{ "id": "voice_1234" }`.
20
+ # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
21
+ # samples. Voices created from text prompts are supported only in Live.
21
22
  attr_accessor voice: OpenAI::Models::Chat::ChatCompletionAudioParam::voice
22
23
 
23
24
  # @param format_
@@ -27,7 +28,8 @@ module OpenAI
27
28
  # The voice the model uses to respond. Supported built-in voices are `alloy`,
28
29
  # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
29
30
  # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
30
- # for example `{ "id": "voice_1234" }`.
31
+ # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
32
+ # samples. Voices created from text prompts are supported only in Live.
31
33
  def initialize: (
32
34
  format_: OpenAI::Models::Chat::ChatCompletionAudioParam::format_,
33
35
  voice: OpenAI::Models::Chat::ChatCompletionAudioParam::voice
@@ -177,58 +177,65 @@ module OpenAI
177
177
  type choice =
178
178
  {
179
179
  delta: OpenAI::Chat::ChatCompletionChunk::Choice::Delta,
180
- finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?,
181
180
  index: Integer,
181
+ ?finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?,
182
182
  ?logprobs: OpenAI::Chat::ChatCompletionChunk::Choice::Logprobs?
183
183
  }
184
184
 
185
185
  class Choice < OpenAI::Internal::Type::BaseModel
186
- # A chat completion delta generated by streamed model responses.
186
+ # A chat completion delta generated by streamed model responses. Streamed audio
187
+ # can arrive in partial updates with an ID, base64 data, or transcript text. The
188
+ # final audio update contains only its expiry timestamp.
187
189
  attr_accessor delta: OpenAI::Chat::ChatCompletionChunk::Choice::Delta
188
190
 
191
+ # The index of the choice in the list of choices.
192
+ attr_accessor index: Integer
193
+
189
194
  # The reason the model stopped generating tokens. This will be `stop` if the model
190
195
  # hit a natural stop point or a provided stop sequence, `length` if the maximum
191
196
  # number of tokens specified in the request was reached, `content_filter` if
192
197
  # content was omitted due to a flag from our content filters, `tool_calls` if the
193
198
  # model called a tool, or `function_call` (deprecated) if the model called a
194
- # function.
199
+ # function. Omitted from the final audio update containing only
200
+ # `delta.audio.expires_at`.
195
201
  attr_accessor finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?
196
202
 
197
- # The index of the choice in the list of choices.
198
- attr_accessor index: Integer
199
-
200
203
  # Log probability information for the choice.
201
204
  attr_accessor logprobs: OpenAI::Chat::ChatCompletionChunk::Choice::Logprobs?
202
205
 
203
206
  # @param delta
204
- # A chat completion delta generated by streamed model responses.
207
+ # A chat completion delta generated by streamed model responses. Streamed audio
208
+ # can arrive in partial updates with an ID, base64 data, or transcript text. The
209
+ # final audio update contains only its expiry timestamp.
210
+ # @param index
211
+ # The index of the choice in the list of choices.
205
212
  # @param finish_reason
206
213
  # The reason the model stopped generating tokens. This will be `stop` if the model
207
214
  # hit a natural stop point or a provided stop sequence, `length` if the maximum
208
215
  # number of tokens specified in the request was reached, `content_filter` if
209
216
  # content was omitted due to a flag from our content filters, `tool_calls` if the
210
217
  # model called a tool, or `function_call` (deprecated) if the model called a
211
- # function.
212
- # @param index
213
- # The index of the choice in the list of choices.
218
+ # function. Omitted from the final audio update containing only
219
+ # `delta.audio.expires_at`.
214
220
  # @param logprobs
215
221
  # Log probability information for the choice.
216
222
  def initialize: (
217
223
  delta: OpenAI::Chat::ChatCompletionChunk::Choice::Delta,
218
- finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?,
219
224
  index: Integer,
225
+ ?finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?,
220
226
  ?logprobs: OpenAI::Chat::ChatCompletionChunk::Choice::Logprobs?
221
227
  ) -> void
222
228
 
223
229
  def to_hash: -> {
224
230
  delta: OpenAI::Chat::ChatCompletionChunk::Choice::Delta,
225
- finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?,
226
231
  index: Integer,
232
+ ?finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?,
227
233
  ?logprobs: OpenAI::Chat::ChatCompletionChunk::Choice::Logprobs?
228
234
  }
229
235
 
230
236
  type delta =
231
237
  {
238
+ ?audio: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio,
232
239
  ?content: String?,
233
240
  ?function_call: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::FunctionCall,
234
241
  ?refusal: String?,
@@ -237,6 +244,16 @@ module OpenAI
237
244
  }
238
245
 
239
246
  class Delta < OpenAI::Internal::Type::BaseModel
247
+ # A partial audio response. Audio chunks may carry an ID, base64 data, or
248
+ # transcript text; the final audio update contains only its expiry timestamp.
249
+ attr_reader audio: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio?
250
+
251
+ # A partial audio response. Audio chunks may carry an ID, base64 data, or
252
+ # transcript text; the final audio update contains only its expiry timestamp.
253
+ def audio=: (
254
+ OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio
255
+ ) -> OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio
256
+
240
257
  # The contents of the chunk message.
241
258
  attr_accessor content: String?
242
259
 
@@ -267,6 +284,9 @@ module OpenAI
267
284
  ::Array[OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall]
268
285
  ) -> ::Array[OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall]
269
286
 
287
+ # @param audio
288
+ # A partial audio response. Audio chunks may carry an ID, base64 data, or
289
+ # transcript text; the final audio update contains only its expiry timestamp.
270
290
  # @param content
271
291
  # The contents of the chunk message.
272
292
  # @param function_call
@@ -277,6 +297,7 @@ module OpenAI
277
297
  # @param role
278
298
  # The role of the author of this message.
279
299
  def initialize: (
300
+ ?audio: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio,
280
301
  ?content: String?,
281
302
  ?function_call: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::FunctionCall,
282
303
  ?refusal: String?,
@@ -285,6 +306,7 @@ module OpenAI
285
306
  ) -> void
286
307
 
287
308
  def to_hash: -> {
309
+ ?audio: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio,
288
310
  ?content: String?,
289
311
  ?function_call: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::FunctionCall,
290
312
  ?refusal: String?,
@@ -292,6 +314,68 @@ module OpenAI
292
314
  ?tool_calls: ::Array[OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall]
293
315
  }
294
316
 
317
+ type audio =
318
+ {
319
+ ?id: String,
320
+ ?data: String,
321
+ ?expires_at: Integer,
322
+ ?transcript: String
323
+ }
324
+
325
+ class Audio < OpenAI::Internal::Type::BaseModel
326
+ # Unique identifier for this audio response.
327
+ attr_reader id: String?
328
+
329
+ # Unique identifier for this audio response.
330
+ def id=: (String) -> String
331
+
332
+ # Base64 encoded audio bytes generated by the model, in the format specified in
333
+ # the request.
334
+ attr_reader data: String?
335
+
336
+ # Base64 encoded audio bytes generated by the model, in the format specified in
337
+ # the request.
338
+ def data=: (String) -> String
339
+
340
+ # The Unix timestamp (in seconds) for when this audio response will no longer be
341
+ # accessible on the server for use in multi-turn conversations.
342
+ attr_reader expires_at: Integer?
343
+
344
+ # The Unix timestamp (in seconds) for when this audio response will no longer be
345
+ # accessible on the server for use in multi-turn conversations.
346
+ def expires_at=: (Integer) -> Integer
347
+
348
+ # Transcript text from this audio chunk.
349
+ attr_reader transcript: String?
350
+
351
+ # Transcript text from this audio chunk.
352
+ def transcript=: (String) -> String
353
+
354
+ # @param id
355
+ # Unique identifier for this audio response.
356
+ # @param data
357
+ # Base64 encoded audio bytes generated by the model, in the format specified in
358
+ # the request.
359
+ # @param expires_at
360
+ # The Unix timestamp (in seconds) for when this audio response will no longer be
361
+ # accessible on the server for use in multi-turn conversations.
362
+ # @param transcript
363
+ # Transcript text from this audio chunk.
364
+ def initialize: (
365
+ ?id: String,
366
+ ?data: String,
367
+ ?expires_at: Integer,
368
+ ?transcript: String
369
+ ) -> void
370
+
371
+ def to_hash: -> {
372
+ ?id: String,
373
+ ?data: String,
374
+ ?expires_at: Integer,
375
+ ?transcript: String
376
+ }
377
+ end
378
+
295
379
  type function_call = { ?arguments: String, ?name: String }
296
380
 
297
381
  class FunctionCall < OpenAI::Internal::Type::BaseModel
@@ -44,6 +44,7 @@ module OpenAI
44
44
  {
45
45
  ?detailed_explanation: String,
46
46
  ?error_type: OpenAI::Models::ErrorObject::Misalignment::error_type,
47
+ ?review_target: String?,
47
48
  ?steer: OpenAI::ErrorObject::Misalignment::Steer
48
49
  }
49
50
 
@@ -62,6 +63,10 @@ module OpenAI
62
63
  OpenAI::Models::ErrorObject::Misalignment::error_type
63
64
  ) -> OpenAI::Models::ErrorObject::Misalignment::error_type
64
65
 
66
+ # An opaque target for explicitly continuing this review, or null when
67
+ # unavailable.
68
+ attr_accessor review_target: String?
69
+
65
70
  # An optional public continuation instruction.
66
71
  attr_reader steer: OpenAI::ErrorObject::Misalignment::Steer?
67
72
 
@@ -74,17 +79,22 @@ module OpenAI
74
79
  # The public explanation for this block.
75
80
  # @param error_type
76
81
  # An optional classification; clients must accept additional values.
82
+ # @param review_target
83
+ # An opaque target for explicitly continuing this review, or null when
84
+ # unavailable.
77
85
  # @param steer
78
86
  # An optional public continuation instruction.
79
87
  def initialize: (
80
88
  ?detailed_explanation: String,
81
89
  ?error_type: OpenAI::Models::ErrorObject::Misalignment::error_type,
90
+ ?review_target: String?,
82
91
  ?steer: OpenAI::ErrorObject::Misalignment::Steer
83
92
  ) -> void
84
93
 
85
94
  def to_hash: -> {
86
95
  ?detailed_explanation: String,
87
96
  ?error_type: OpenAI::Models::ErrorObject::Misalignment::error_type,
97
+ ?review_target: String?,
88
98
  ?steer: OpenAI::ErrorObject::Misalignment::Steer
89
99
  }
90
100
 
@@ -528,7 +528,7 @@ module OpenAI
528
528
  # @param name
529
529
  # The name of the grader.
530
530
  # @param range
531
- # The range of the score. Defaults to `[0, 1]`.
531
+ # The service requires two numbers for the score range. Defaults to `[0, 1]`.
532
532
  # @param sampling_params
533
533
  # The sampling parameters for the model.
534
534
  # @param pass_threshold
@@ -264,7 +264,7 @@ module OpenAI
264
264
  # @param name
265
265
  # The name of the grader.
266
266
  # @param range
267
- # The range of the score. Defaults to `[0, 1]`.
267
+ # The service requires two numbers for the score range. Defaults to `[0, 1]`.
268
268
  # @param sampling_params
269
269
  # The sampling parameters for the model.
270
270
  # @param pass_threshold
@@ -264,7 +264,7 @@ module OpenAI
264
264
  # @param name
265
265
  # The name of the grader.
266
266
  # @param range
267
- # The range of the score. Defaults to `[0, 1]`.
267
+ # The service requires two numbers for the score range. Defaults to `[0, 1]`.
268
268
  # @param sampling_params
269
269
  # The sampling parameters for the model.
270
270
  # @param pass_threshold
@@ -264,7 +264,7 @@ module OpenAI
264
264
  # @param name
265
265
  # The name of the grader.
266
266
  # @param range
267
- # The range of the score. Defaults to `[0, 1]`.
267
+ # The service requires two numbers for the score range. Defaults to `[0, 1]`.
268
268
  # @param sampling_params
269
269
  # The sampling parameters for the model.
270
270
  # @param pass_threshold
@@ -264,7 +264,7 @@ module OpenAI
264
264
  # @param name
265
265
  # The name of the grader.
266
266
  # @param range
267
- # The range of the score. Defaults to `[0, 1]`.
267
+ # The service requires two numbers for the score range. Defaults to `[0, 1]`.
268
268
  # @param sampling_params
269
269
  # The sampling parameters for the model.
270
270
  # @param pass_threshold
@@ -25,8 +25,13 @@ module OpenAI
25
25
  # Number of fine-tuning jobs to retrieve.
26
26
  def limit=: (Integer) -> Integer
27
27
 
28
- # Optional metadata filter. To filter, use the syntax `metadata[k]=v`.
29
- # Alternatively, set `metadata=null` to indicate no metadata.
28
+ # Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Omitting
29
+ # the parameter or passing an empty object applies no metadata filter. An empty
30
+ # value, such as `metadata[k]=`, filters for that key with an empty string value.
31
+ # To select jobs with null metadata, send the literal query string
32
+ # `metadata=null`. Nullable caller types do not specify how a client serializes
33
+ # null for a deep-object parameter. Use a raw query parameter if the client omits
34
+ # null. Do not combine the two query forms.
30
35
  attr_accessor metadata: ::Hash[Symbol, String]?
31
36
 
32
37
  # @param after
@@ -34,8 +39,13 @@ module OpenAI
34
39
  # @param limit
35
40
  # Number of fine-tuning jobs to retrieve.
36
41
  # @param metadata
37
- # Optional metadata filter. To filter, use the syntax `metadata[k]=v`.
38
- # Alternatively, set `metadata=null` to indicate no metadata.
42
+ # Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Omitting
43
+ # the parameter or passing an empty object applies no metadata filter. An empty
44
+ # value, such as `metadata[k]=`, filters for that key with an empty string value.
45
+ # To select jobs with null metadata, send the literal query string
46
+ # `metadata=null`. Nullable caller types do not specify how a client serializes
47
+ # null for a deep-object parameter. Use a raw query parameter if the client omits
48
+ # null. Do not combine the two query forms.
39
49
  def initialize: (
40
50
  ?after: String,
41
51
  ?limit: Integer,