openai 0.87.0 → 0.89.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 (1418) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +1 -1
  4. data/lib/openai/client.rb +4 -0
  5. data/lib/openai/models/admin/organization/admin_api_key.rb +26 -13
  6. data/lib/openai/models/admin/organization/admin_api_key_create_params.rb +3 -4
  7. data/lib/openai/models/admin/organization/admin_api_key_create_response.rb +16 -8
  8. data/lib/openai/models/admin/organization/admin_api_key_delete_params.rb +2 -1
  9. data/lib/openai/models/admin/organization/admin_api_key_list_params.rb +6 -3
  10. data/lib/openai/models/admin/organization/admin_api_key_retrieve_params.rb +2 -1
  11. data/lib/openai/models/admin/organization/audit_log_list_params.rb +47 -22
  12. data/lib/openai/models/admin/organization/audit_log_list_response.rb +486 -254
  13. data/lib/openai/models/admin/organization/certificate.rb +24 -11
  14. data/lib/openai/models/admin/organization/certificate_activate_response.rb +14 -7
  15. data/lib/openai/models/admin/organization/certificate_create_params.rb +4 -2
  16. data/lib/openai/models/admin/organization/certificate_deactivate_response.rb +14 -7
  17. data/lib/openai/models/admin/organization/certificate_delete_response.rb +4 -2
  18. data/lib/openai/models/admin/organization/certificate_list_params.rb +11 -6
  19. data/lib/openai/models/admin/organization/certificate_list_response.rb +14 -7
  20. data/lib/openai/models/admin/organization/certificate_retrieve_params.rb +3 -5
  21. data/lib/openai/models/admin/organization/certificate_update_params.rb +2 -1
  22. data/lib/openai/models/admin/organization/data_retention_update_params.rb +2 -1
  23. data/lib/openai/models/admin/organization/group.rb +11 -8
  24. data/lib/openai/models/admin/organization/group_create_params.rb +2 -1
  25. data/lib/openai/models/admin/organization/group_delete_response.rb +6 -3
  26. data/lib/openai/models/admin/organization/group_list_params.rb +10 -6
  27. data/lib/openai/models/admin/organization/group_update_params.rb +2 -1
  28. data/lib/openai/models/admin/organization/group_update_response.rb +9 -7
  29. data/lib/openai/models/admin/organization/groups/organization_group_user.rb +6 -3
  30. data/lib/openai/models/admin/organization/groups/role_create_params.rb +2 -1
  31. data/lib/openai/models/admin/organization/groups/role_create_response.rb +16 -8
  32. data/lib/openai/models/admin/organization/groups/role_delete_response.rb +5 -6
  33. data/lib/openai/models/admin/organization/groups/role_list_params.rb +7 -6
  34. data/lib/openai/models/admin/organization/groups/role_list_response.rb +24 -13
  35. data/lib/openai/models/admin/organization/groups/role_retrieve_response.rb +24 -13
  36. data/lib/openai/models/admin/organization/groups/user_create_params.rb +2 -1
  37. data/lib/openai/models/admin/organization/groups/user_create_response.rb +6 -3
  38. data/lib/openai/models/admin/organization/groups/user_delete_response.rb +4 -2
  39. data/lib/openai/models/admin/organization/groups/user_list_params.rb +8 -6
  40. data/lib/openai/models/admin/organization/groups/user_retrieve_response.rb +12 -6
  41. data/lib/openai/models/admin/organization/invite.rb +22 -12
  42. data/lib/openai/models/admin/organization/invite_create_params.rb +13 -8
  43. data/lib/openai/models/admin/organization/invite_delete_response.rb +2 -1
  44. data/lib/openai/models/admin/organization/invite_list_params.rb +8 -5
  45. data/lib/openai/models/admin/organization/organization_data_retention.rb +4 -2
  46. data/lib/openai/models/admin/organization/organization_spend_alert.rb +18 -9
  47. data/lib/openai/models/admin/organization/organization_spend_alert_deleted.rb +6 -3
  48. data/lib/openai/models/admin/organization/organization_spend_limit.rb +13 -9
  49. data/lib/openai/models/admin/organization/organization_spend_limit_deleted.rb +4 -2
  50. data/lib/openai/models/admin/organization/organization_user.rb +32 -16
  51. data/lib/openai/models/admin/organization/project.rb +16 -8
  52. data/lib/openai/models/admin/organization/project_create_params.rb +18 -9
  53. data/lib/openai/models/admin/organization/project_list_params.rb +11 -6
  54. data/lib/openai/models/admin/organization/project_update_params.rb +7 -6
  55. data/lib/openai/models/admin/organization/projects/api_key_list_params.rb +14 -7
  56. data/lib/openai/models/admin/organization/projects/certificate_activate_response.rb +14 -7
  57. data/lib/openai/models/admin/organization/projects/certificate_deactivate_response.rb +14 -7
  58. data/lib/openai/models/admin/organization/projects/certificate_list_params.rb +11 -7
  59. data/lib/openai/models/admin/organization/projects/certificate_list_response.rb +14 -7
  60. data/lib/openai/models/admin/organization/projects/data_retention_update_params.rb +2 -1
  61. data/lib/openai/models/admin/organization/projects/group_create_params.rb +4 -2
  62. data/lib/openai/models/admin/organization/projects/group_delete_response.rb +4 -2
  63. data/lib/openai/models/admin/organization/projects/group_list_params.rb +7 -7
  64. data/lib/openai/models/admin/organization/projects/group_retrieve_params.rb +2 -1
  65. data/lib/openai/models/admin/organization/projects/groups/role_create_params.rb +2 -1
  66. data/lib/openai/models/admin/organization/projects/groups/role_create_response.rb +16 -8
  67. data/lib/openai/models/admin/organization/projects/groups/role_delete_response.rb +5 -6
  68. data/lib/openai/models/admin/organization/projects/groups/role_list_params.rb +7 -7
  69. data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb +24 -13
  70. data/lib/openai/models/admin/organization/projects/groups/role_retrieve_response.rb +24 -13
  71. data/lib/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rb +20 -10
  72. data/lib/openai/models/admin/organization/projects/model_permission_update_params.rb +4 -2
  73. data/lib/openai/models/admin/organization/projects/project_api_key.rb +50 -20
  74. data/lib/openai/models/admin/organization/projects/project_data_retention.rb +4 -2
  75. data/lib/openai/models/admin/organization/projects/project_group.rb +12 -6
  76. data/lib/openai/models/admin/organization/projects/project_hosted_tool_permissions.rb +20 -10
  77. data/lib/openai/models/admin/organization/projects/project_model_permissions.rb +6 -3
  78. data/lib/openai/models/admin/organization/projects/project_model_permissions_deleted.rb +4 -2
  79. data/lib/openai/models/admin/organization/projects/project_rate_limit.rb +18 -9
  80. data/lib/openai/models/admin/organization/projects/project_service_account.rb +10 -5
  81. data/lib/openai/models/admin/organization/projects/project_spend_alert.rb +18 -9
  82. data/lib/openai/models/admin/organization/projects/project_spend_alert_deleted.rb +6 -3
  83. data/lib/openai/models/admin/organization/projects/project_spend_limit.rb +13 -10
  84. data/lib/openai/models/admin/organization/projects/project_spend_limit_deleted.rb +4 -2
  85. data/lib/openai/models/admin/organization/projects/project_user.rb +12 -6
  86. data/lib/openai/models/admin/organization/projects/rate_limit_list_rate_limits_params.rb +12 -7
  87. data/lib/openai/models/admin/organization/projects/rate_limit_update_rate_limit_params.rb +12 -6
  88. data/lib/openai/models/admin/organization/projects/role_create_params.rb +6 -3
  89. data/lib/openai/models/admin/organization/projects/role_delete_response.rb +6 -3
  90. data/lib/openai/models/admin/organization/projects/role_list_params.rb +7 -7
  91. data/lib/openai/models/admin/organization/projects/role_update_params.rb +6 -3
  92. data/lib/openai/models/admin/organization/projects/service_account_create_params.rb +22 -3
  93. data/lib/openai/models/admin/organization/projects/service_account_create_response.rb +17 -7
  94. data/lib/openai/models/admin/organization/projects/service_account_list_params.rb +8 -6
  95. data/lib/openai/models/admin/organization/projects/service_account_update_params.rb +4 -2
  96. data/lib/openai/models/admin/organization/projects/service_accounts/api_key_create_params.rb +10 -5
  97. data/lib/openai/models/admin/organization/projects/service_accounts/api_key_create_response.rb +13 -10
  98. data/lib/openai/models/admin/organization/projects/spend_alert_create_params.rb +14 -7
  99. data/lib/openai/models/admin/organization/projects/spend_alert_list_params.rb +10 -8
  100. data/lib/openai/models/admin/organization/projects/spend_alert_update_params.rb +14 -7
  101. data/lib/openai/models/admin/organization/projects/spend_limit_update_params.rb +7 -7
  102. data/lib/openai/models/admin/organization/projects/user_create_params.rb +6 -3
  103. data/lib/openai/models/admin/organization/projects/user_list_params.rb +8 -6
  104. data/lib/openai/models/admin/organization/projects/user_update_params.rb +2 -1
  105. data/lib/openai/models/admin/organization/projects/users/role_create_params.rb +2 -1
  106. data/lib/openai/models/admin/organization/projects/users/role_create_response.rb +6 -3
  107. data/lib/openai/models/admin/organization/projects/users/role_delete_response.rb +5 -6
  108. data/lib/openai/models/admin/organization/projects/users/role_list_params.rb +7 -7
  109. data/lib/openai/models/admin/organization/projects/users/role_list_response.rb +24 -13
  110. data/lib/openai/models/admin/organization/projects/users/role_retrieve_response.rb +24 -13
  111. data/lib/openai/models/admin/organization/role.rb +15 -10
  112. data/lib/openai/models/admin/organization/role_create_params.rb +6 -3
  113. data/lib/openai/models/admin/organization/role_delete_response.rb +6 -3
  114. data/lib/openai/models/admin/organization/role_list_params.rb +7 -6
  115. data/lib/openai/models/admin/organization/role_update_params.rb +6 -3
  116. data/lib/openai/models/admin/organization/spend_alert_create_params.rb +14 -7
  117. data/lib/openai/models/admin/organization/spend_alert_list_params.rb +10 -7
  118. data/lib/openai/models/admin/organization/spend_alert_update_params.rb +14 -7
  119. data/lib/openai/models/admin/organization/spend_limit_update_params.rb +7 -6
  120. data/lib/openai/models/admin/organization/usage_audio_speeches_params.rb +26 -13
  121. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +205 -121
  122. data/lib/openai/models/admin/organization/usage_audio_transcriptions_params.rb +26 -13
  123. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +205 -121
  124. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_params.rb +20 -10
  125. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +205 -121
  126. data/lib/openai/models/admin/organization/usage_completions_params.rb +30 -13
  127. data/lib/openai/models/admin/organization/usage_completions_response.rb +205 -121
  128. data/lib/openai/models/admin/organization/usage_costs_params.rb +23 -12
  129. data/lib/openai/models/admin/organization/usage_costs_response.rb +205 -121
  130. data/lib/openai/models/admin/organization/usage_embeddings_params.rb +26 -12
  131. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +205 -121
  132. data/lib/openai/models/admin/organization/usage_file_search_calls_params.rb +27 -13
  133. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +205 -121
  134. data/lib/openai/models/admin/organization/usage_images_params.rb +33 -14
  135. data/lib/openai/models/admin/organization/usage_images_response.rb +205 -121
  136. data/lib/openai/models/admin/organization/usage_moderations_params.rb +26 -12
  137. data/lib/openai/models/admin/organization/usage_moderations_response.rb +205 -121
  138. data/lib/openai/models/admin/organization/usage_vector_stores_params.rb +20 -9
  139. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +205 -121
  140. data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +29 -14
  141. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +205 -121
  142. data/lib/openai/models/admin/organization/user_list_params.rb +10 -6
  143. data/lib/openai/models/admin/organization/user_update_params.rb +8 -4
  144. data/lib/openai/models/admin/organization/users/role_create_params.rb +2 -1
  145. data/lib/openai/models/admin/organization/users/role_create_response.rb +6 -3
  146. data/lib/openai/models/admin/organization/users/role_delete_response.rb +5 -6
  147. data/lib/openai/models/admin/organization/users/role_list_params.rb +7 -6
  148. data/lib/openai/models/admin/organization/users/role_list_response.rb +24 -13
  149. data/lib/openai/models/admin/organization/users/role_retrieve_response.rb +24 -13
  150. data/lib/openai/models/audio/speech_create_params.rb +34 -16
  151. data/lib/openai/models/audio/transcription.rb +35 -20
  152. data/lib/openai/models/audio/transcription_create_params.rb +86 -24
  153. data/lib/openai/models/audio/transcription_diarized.rb +28 -14
  154. data/lib/openai/models/audio/transcription_diarized_segment.rb +14 -9
  155. data/lib/openai/models/audio/transcription_language.rb +2 -1
  156. data/lib/openai/models/audio/transcription_segment.rb +23 -13
  157. data/lib/openai/models/audio/transcription_stream_event.rb +4 -4
  158. data/lib/openai/models/audio/transcription_text_delta_event.rb +19 -16
  159. data/lib/openai/models/audio/transcription_text_done_event.rb +36 -24
  160. data/lib/openai/models/audio/transcription_text_segment_event.rb +13 -7
  161. data/lib/openai/models/audio/transcription_verbose.rb +16 -8
  162. data/lib/openai/models/audio/transcription_word.rb +6 -3
  163. data/lib/openai/models/audio/translation_create_params.rb +26 -8
  164. data/lib/openai/models/audio/translation_verbose.rb +8 -4
  165. data/lib/openai/models/auto_file_chunking_strategy_param.rb +2 -1
  166. data/lib/openai/models/batch.rb +55 -26
  167. data/lib/openai/models/batch_create_params.rb +40 -14
  168. data/lib/openai/models/batch_error.rb +8 -4
  169. data/lib/openai/models/batch_list_params.rb +8 -5
  170. data/lib/openai/models/batch_request_counts.rb +6 -3
  171. data/lib/openai/models/batch_usage.rb +16 -11
  172. data/lib/openai/models/beta/assistant.rb +99 -49
  173. data/lib/openai/models/beta/assistant_create_params.rb +127 -61
  174. data/lib/openai/models/beta/assistant_list_params.rb +16 -7
  175. data/lib/openai/models/beta/assistant_response_format_option.rb +5 -5
  176. data/lib/openai/models/beta/assistant_stream_event.rb +137 -185
  177. data/lib/openai/models/beta/assistant_tool_choice.rb +2 -1
  178. data/lib/openai/models/beta/assistant_tool_choice_function.rb +2 -1
  179. data/lib/openai/models/beta/assistant_update_params.rb +94 -41
  180. data/lib/openai/models/beta/beta_apply_patch_tool.rb +4 -3
  181. data/lib/openai/models/beta/beta_compacted_response.rb +12 -8
  182. data/lib/openai/models/beta/beta_computer_action.rb +78 -58
  183. data/lib/openai/models/beta/beta_computer_tool.rb +3 -2
  184. data/lib/openai/models/beta/beta_computer_use_preview_tool.rb +9 -5
  185. data/lib/openai/models/beta/beta_container_auto.rb +10 -5
  186. data/lib/openai/models/beta/beta_container_network_policy_allowlist.rb +6 -3
  187. data/lib/openai/models/beta/beta_container_network_policy_disabled.rb +2 -1
  188. data/lib/openai/models/beta/beta_container_network_policy_domain_secret.rb +6 -3
  189. data/lib/openai/models/beta/beta_container_reference.rb +4 -2
  190. data/lib/openai/models/beta/beta_custom_tool.rb +24 -16
  191. data/lib/openai/models/beta/beta_easy_input_message.rb +13 -7
  192. data/lib/openai/models/beta/beta_file_search_tool.rb +64 -37
  193. data/lib/openai/models/beta/beta_function_shell_tool.rb +4 -3
  194. data/lib/openai/models/beta/beta_function_tool.rb +19 -13
  195. data/lib/openai/models/beta/beta_inline_skill.rb +8 -4
  196. data/lib/openai/models/beta/beta_inline_skill_source.rb +6 -3
  197. data/lib/openai/models/beta/beta_local_environment.rb +4 -2
  198. data/lib/openai/models/beta/beta_local_skill.rb +6 -3
  199. data/lib/openai/models/beta/beta_namespace_tool.rb +23 -13
  200. data/lib/openai/models/beta/beta_response.rb +372 -165
  201. data/lib/openai/models/beta/beta_response_apply_patch_tool_call.rb +38 -21
  202. data/lib/openai/models/beta/beta_response_apply_patch_tool_call_output.rb +21 -13
  203. data/lib/openai/models/beta/beta_response_audio_delta_event.rb +10 -8
  204. data/lib/openai/models/beta/beta_response_audio_done_event.rb +8 -7
  205. data/lib/openai/models/beta/beta_response_audio_transcript_delta_event.rb +10 -8
  206. data/lib/openai/models/beta/beta_response_audio_transcript_done_event.rb +8 -7
  207. data/lib/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rb +15 -11
  208. data/lib/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rb +14 -7
  209. data/lib/openai/models/beta/beta_response_code_interpreter_call_completed_event.rb +13 -10
  210. data/lib/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rb +13 -10
  211. data/lib/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rb +13 -10
  212. data/lib/openai/models/beta/beta_response_code_interpreter_tool_call.rb +26 -15
  213. data/lib/openai/models/beta/beta_response_compaction_item.rb +13 -7
  214. data/lib/openai/models/beta/beta_response_compaction_item_param.rb +11 -6
  215. data/lib/openai/models/beta/beta_response_completed_event.rb +10 -8
  216. data/lib/openai/models/beta/beta_response_computer_tool_call.rb +27 -17
  217. data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +26 -15
  218. data/lib/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rb +7 -7
  219. data/lib/openai/models/beta/beta_response_configuration_update_item.rb +13 -10
  220. data/lib/openai/models/beta/beta_response_configuration_update_item_param.rb +13 -10
  221. data/lib/openai/models/beta/beta_response_container_reference.rb +2 -1
  222. data/lib/openai/models/beta/beta_response_content.rb +5 -3
  223. data/lib/openai/models/beta/beta_response_content_part_added_event.rb +20 -13
  224. data/lib/openai/models/beta/beta_response_content_part_done_event.rb +20 -13
  225. data/lib/openai/models/beta/beta_response_conversation_param.rb +2 -1
  226. data/lib/openai/models/beta/beta_response_created_event.rb +10 -8
  227. data/lib/openai/models/beta/beta_response_custom_tool_call.rb +22 -14
  228. data/lib/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rb +14 -7
  229. data/lib/openai/models/beta/beta_response_custom_tool_call_input_done_event.rb +14 -7
  230. data/lib/openai/models/beta/beta_response_custom_tool_call_item.rb +23 -14
  231. data/lib/openai/models/beta/beta_response_custom_tool_call_output.rb +22 -14
  232. data/lib/openai/models/beta/beta_response_custom_tool_call_output_item.rb +18 -11
  233. data/lib/openai/models/beta/beta_response_error.rb +12 -9
  234. data/lib/openai/models/beta/beta_response_error_event.rb +14 -10
  235. data/lib/openai/models/beta/beta_response_failed_event.rb +10 -8
  236. data/lib/openai/models/beta/beta_response_file_search_call_completed_event.rb +12 -10
  237. data/lib/openai/models/beta/beta_response_file_search_call_in_progress_event.rb +12 -10
  238. data/lib/openai/models/beta/beta_response_file_search_call_searching_event.rb +12 -10
  239. data/lib/openai/models/beta/beta_response_file_search_tool_call.rb +30 -20
  240. data/lib/openai/models/beta/beta_response_format_text_config.rb +6 -4
  241. data/lib/openai/models/beta/beta_response_format_text_json_schema_config.rb +19 -10
  242. data/lib/openai/models/beta/beta_response_function_call_arguments_delta_event.rb +14 -11
  243. data/lib/openai/models/beta/beta_response_function_call_arguments_done_event.rb +12 -6
  244. data/lib/openai/models/beta/beta_response_function_call_output_item.rb +1 -1
  245. data/lib/openai/models/beta/beta_response_function_shell_call_output_content.rb +12 -6
  246. data/lib/openai/models/beta/beta_response_function_shell_tool_call.rb +28 -16
  247. data/lib/openai/models/beta/beta_response_function_shell_tool_call_output.rb +40 -27
  248. data/lib/openai/models/beta/beta_response_function_tool_call.rb +26 -16
  249. data/lib/openai/models/beta/beta_response_function_tool_call_item.rb +24 -15
  250. data/lib/openai/models/beta/beta_response_function_tool_call_output_item.rb +31 -18
  251. data/lib/openai/models/beta/beta_response_function_web_search.rb +37 -39
  252. data/lib/openai/models/beta/beta_response_image_gen_call_completed_event.rb +12 -6
  253. data/lib/openai/models/beta/beta_response_image_gen_call_generating_event.rb +12 -6
  254. data/lib/openai/models/beta/beta_response_image_gen_call_in_progress_event.rb +12 -6
  255. data/lib/openai/models/beta/beta_response_image_gen_call_partial_image_event.rb +25 -16
  256. data/lib/openai/models/beta/beta_response_in_progress_event.rb +10 -8
  257. data/lib/openai/models/beta/beta_response_incomplete_event.rb +10 -8
  258. data/lib/openai/models/beta/beta_response_inject_created_event.rb +9 -7
  259. data/lib/openai/models/beta/beta_response_inject_event.rb +6 -3
  260. data/lib/openai/models/beta/beta_response_inject_failed_event.rb +17 -11
  261. data/lib/openai/models/beta/beta_response_input_audio.rb +6 -9
  262. data/lib/openai/models/beta/beta_response_input_content.rb +1 -1
  263. data/lib/openai/models/beta/beta_response_input_file.rb +22 -11
  264. data/lib/openai/models/beta/beta_response_input_file_content.rb +22 -11
  265. data/lib/openai/models/beta/beta_response_input_image.rb +17 -10
  266. data/lib/openai/models/beta/beta_response_input_image_content.rb +17 -10
  267. data/lib/openai/models/beta/beta_response_input_item.rb +570 -294
  268. data/lib/openai/models/beta/beta_response_input_message_item.rb +16 -10
  269. data/lib/openai/models/beta/beta_response_input_text.rb +10 -7
  270. data/lib/openai/models/beta/beta_response_input_text_content.rb +10 -7
  271. data/lib/openai/models/beta/beta_response_item.rb +340 -153
  272. data/lib/openai/models/beta/beta_response_local_environment.rb +2 -1
  273. data/lib/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rb +15 -10
  274. data/lib/openai/models/beta/beta_response_mcp_call_arguments_done_event.rb +14 -10
  275. data/lib/openai/models/beta/beta_response_mcp_call_completed_event.rb +12 -6
  276. data/lib/openai/models/beta/beta_response_mcp_call_failed_event.rb +12 -6
  277. data/lib/openai/models/beta/beta_response_mcp_call_in_progress_event.rb +12 -6
  278. data/lib/openai/models/beta/beta_response_mcp_list_tools_completed_event.rb +12 -6
  279. data/lib/openai/models/beta/beta_response_mcp_list_tools_failed_event.rb +12 -6
  280. data/lib/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rb +12 -6
  281. data/lib/openai/models/beta/beta_response_output_audio.rb +6 -6
  282. data/lib/openai/models/beta/beta_response_output_item.rb +338 -158
  283. data/lib/openai/models/beta/beta_response_output_item_added_event.rb +15 -9
  284. data/lib/openai/models/beta/beta_response_output_item_done_event.rb +12 -9
  285. data/lib/openai/models/beta/beta_response_output_message.rb +20 -11
  286. data/lib/openai/models/beta/beta_response_output_refusal.rb +4 -2
  287. data/lib/openai/models/beta/beta_response_output_text.rb +42 -25
  288. data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb +54 -31
  289. data/lib/openai/models/beta/beta_response_prompt.rb +10 -8
  290. data/lib/openai/models/beta/beta_response_queued_event.rb +10 -5
  291. data/lib/openai/models/beta/beta_response_reasoning_item.rb +33 -17
  292. data/lib/openai/models/beta/beta_response_reasoning_summary_part_added_event.rb +20 -14
  293. data/lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb +23 -15
  294. data/lib/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rb +16 -12
  295. data/lib/openai/models/beta/beta_response_reasoning_summary_text_done_event.rb +16 -12
  296. data/lib/openai/models/beta/beta_response_reasoning_text_delta_event.rb +16 -11
  297. data/lib/openai/models/beta/beta_response_reasoning_text_done_event.rb +16 -11
  298. data/lib/openai/models/beta/beta_response_refusal_delta_event.rb +16 -11
  299. data/lib/openai/models/beta/beta_response_refusal_done_event.rb +16 -11
  300. data/lib/openai/models/beta/beta_response_shell_call_command_added_event.rb +14 -7
  301. data/lib/openai/models/beta/beta_response_shell_call_command_delta_event.rb +16 -8
  302. data/lib/openai/models/beta/beta_response_shell_call_command_done_event.rb +14 -7
  303. data/lib/openai/models/beta/beta_response_shell_call_output_content_delta_event.rb +20 -10
  304. data/lib/openai/models/beta/beta_response_shell_call_output_content_done_event.rb +31 -20
  305. data/lib/openai/models/beta/beta_response_steer_accepted_event.rb +13 -9
  306. data/lib/openai/models/beta/beta_response_steer_event.rb +14 -6
  307. data/lib/openai/models/beta/beta_response_steer_failed_event.rb +45 -22
  308. data/lib/openai/models/beta/beta_response_steer_input.rb +42 -24
  309. data/lib/openai/models/beta/beta_response_steer_input_content.rb +1 -1
  310. data/lib/openai/models/beta/beta_response_steer_pending_event.rb +24 -11
  311. data/lib/openai/models/beta/beta_response_text_config.rb +22 -8
  312. data/lib/openai/models/beta/beta_response_text_delta_event.rb +28 -22
  313. data/lib/openai/models/beta/beta_response_text_done_event.rb +28 -22
  314. data/lib/openai/models/beta/beta_response_tool_search_call.rb +18 -9
  315. data/lib/openai/models/beta/beta_response_tool_search_output_item.rb +18 -9
  316. data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +16 -8
  317. data/lib/openai/models/beta/beta_response_usage.rb +18 -12
  318. data/lib/openai/models/beta/beta_response_web_search_call_completed_event.rb +12 -10
  319. data/lib/openai/models/beta/beta_response_web_search_call_in_progress_event.rb +12 -10
  320. data/lib/openai/models/beta/beta_response_web_search_call_searching_event.rb +12 -10
  321. data/lib/openai/models/beta/beta_responses_client_event.rb +399 -163
  322. data/lib/openai/models/beta/beta_responses_server_event.rb +862 -629
  323. data/lib/openai/models/beta/beta_skill_reference.rb +6 -3
  324. data/lib/openai/models/beta/beta_tool.rb +170 -95
  325. data/lib/openai/models/beta/beta_tool_choice_allowed.rb +21 -6
  326. data/lib/openai/models/beta/beta_tool_choice_apply_patch.rb +2 -1
  327. data/lib/openai/models/beta/beta_tool_choice_custom.rb +4 -2
  328. data/lib/openai/models/beta/beta_tool_choice_function.rb +4 -2
  329. data/lib/openai/models/beta/beta_tool_choice_mcp.rb +6 -6
  330. data/lib/openai/models/beta/beta_tool_choice_shell.rb +2 -1
  331. data/lib/openai/models/beta/beta_tool_choice_types.rb +16 -7
  332. data/lib/openai/models/beta/beta_tool_search_tool.rb +8 -4
  333. data/lib/openai/models/beta/beta_web_search_preview_tool.rb +21 -15
  334. data/lib/openai/models/beta/beta_web_search_tool.rb +31 -21
  335. data/lib/openai/models/beta/chatkit/chat_session.rb +20 -10
  336. data/lib/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rb +2 -1
  337. data/lib/openai/models/beta/chatkit/chat_session_chatkit_configuration.rb +6 -3
  338. data/lib/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rb +23 -21
  339. data/lib/openai/models/beta/chatkit/chat_session_expires_after_param.rb +4 -2
  340. data/lib/openai/models/beta/chatkit/chat_session_file_upload.rb +6 -3
  341. data/lib/openai/models/beta/chatkit/chat_session_history.rb +5 -5
  342. data/lib/openai/models/beta/chatkit/chat_session_rate_limits.rb +2 -1
  343. data/lib/openai/models/beta/chatkit/chat_session_rate_limits_param.rb +2 -1
  344. data/lib/openai/models/beta/chatkit/chat_session_workflow_param.rb +12 -9
  345. data/lib/openai/models/beta/chatkit/chatkit_attachment.rb +10 -5
  346. data/lib/openai/models/beta/chatkit/chatkit_response_output_text.rb +22 -11
  347. data/lib/openai/models/beta/chatkit/chatkit_thread.rb +23 -14
  348. data/lib/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rb +12 -6
  349. data/lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb +65 -41
  350. data/lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb +29 -18
  351. data/lib/openai/models/beta/chatkit/chatkit_widget_item.rb +12 -6
  352. data/lib/openai/models/beta/chatkit/session_create_params.rb +12 -8
  353. data/lib/openai/models/beta/chatkit/thread_delete_response.rb +6 -3
  354. data/lib/openai/models/beta/chatkit/thread_list_items_params.rb +10 -7
  355. data/lib/openai/models/beta/chatkit/thread_list_params.rb +13 -8
  356. data/lib/openai/models/beta/chatkit_workflow.rb +12 -9
  357. data/lib/openai/models/beta/code_interpreter_tool.rb +2 -1
  358. data/lib/openai/models/beta/file_search_tool.rb +29 -16
  359. data/lib/openai/models/beta/function_tool.rb +2 -1
  360. data/lib/openai/models/beta/message_stream_event.rb +32 -41
  361. data/lib/openai/models/beta/response_compact_params.rb +89 -46
  362. data/lib/openai/models/beta/response_create_params.rb +380 -150
  363. data/lib/openai/models/beta/response_retrieve_params.rb +12 -6
  364. data/lib/openai/models/beta/responses/beta_response_item_list.rb +10 -5
  365. data/lib/openai/models/beta/responses/input_item_list_params.rb +13 -7
  366. data/lib/openai/models/beta/responses/input_token_count_params.rb +113 -42
  367. data/lib/openai/models/beta/run_step_stream_event.rb +36 -57
  368. data/lib/openai/models/beta/run_stream_event.rb +61 -72
  369. data/lib/openai/models/beta/thread.rb +32 -21
  370. data/lib/openai/models/beta/thread_create_and_run_params.rb +232 -123
  371. data/lib/openai/models/beta/thread_create_params.rb +89 -52
  372. data/lib/openai/models/beta/thread_stream_event.rb +7 -7
  373. data/lib/openai/models/beta/thread_update_params.rb +25 -19
  374. data/lib/openai/models/beta/threads/file_citation_annotation.rb +6 -3
  375. data/lib/openai/models/beta/threads/file_citation_delta_annotation.rb +10 -5
  376. data/lib/openai/models/beta/threads/file_path_annotation.rb +6 -3
  377. data/lib/openai/models/beta/threads/file_path_delta_annotation.rb +8 -4
  378. data/lib/openai/models/beta/threads/image_file.rb +10 -8
  379. data/lib/openai/models/beta/threads/image_file_content_block.rb +5 -3
  380. data/lib/openai/models/beta/threads/image_file_delta.rb +10 -8
  381. data/lib/openai/models/beta/threads/image_file_delta_block.rb +7 -4
  382. data/lib/openai/models/beta/threads/image_url.rb +6 -5
  383. data/lib/openai/models/beta/threads/image_url_content_block.rb +2 -1
  384. data/lib/openai/models/beta/threads/image_url_delta.rb +6 -5
  385. data/lib/openai/models/beta/threads/image_url_delta_block.rb +4 -2
  386. data/lib/openai/models/beta/threads/message.rb +52 -28
  387. data/lib/openai/models/beta/threads/message_content.rb +4 -3
  388. data/lib/openai/models/beta/threads/message_content_delta.rb +4 -3
  389. data/lib/openai/models/beta/threads/message_content_part_param.rb +4 -3
  390. data/lib/openai/models/beta/threads/message_create_params.rb +25 -12
  391. data/lib/openai/models/beta/threads/message_delta.rb +4 -2
  392. data/lib/openai/models/beta/threads/message_delta_event.rb +6 -3
  393. data/lib/openai/models/beta/threads/message_list_params.rb +18 -8
  394. data/lib/openai/models/beta/threads/message_update_params.rb +7 -4
  395. data/lib/openai/models/beta/threads/refusal_content_block.rb +2 -1
  396. data/lib/openai/models/beta/threads/refusal_delta_block.rb +4 -2
  397. data/lib/openai/models/beta/threads/required_action_function_tool_call.rb +15 -10
  398. data/lib/openai/models/beta/threads/run.rb +174 -89
  399. data/lib/openai/models/beta/threads/run_create_params.rb +173 -74
  400. data/lib/openai/models/beta/threads/run_list_params.rb +16 -7
  401. data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +7 -7
  402. data/lib/openai/models/beta/threads/run_update_params.rb +7 -4
  403. data/lib/openai/models/beta/threads/runs/code_interpreter_logs.rb +6 -3
  404. data/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb +9 -9
  405. data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +24 -22
  406. data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +15 -14
  407. data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +31 -25
  408. data/lib/openai/models/beta/threads/runs/file_search_tool_call_delta.rb +9 -7
  409. data/lib/openai/models/beta/threads/runs/function_tool_call.rb +15 -15
  410. data/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb +17 -16
  411. data/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +4 -2
  412. data/lib/openai/models/beta/threads/runs/run_step.rb +62 -29
  413. data/lib/openai/models/beta/threads/runs/run_step_delta.rb +2 -1
  414. data/lib/openai/models/beta/threads/runs/run_step_delta_event.rb +6 -3
  415. data/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +4 -2
  416. data/lib/openai/models/beta/threads/runs/step_list_params.rb +29 -13
  417. data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +9 -5
  418. data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb +6 -5
  419. data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb +6 -5
  420. data/lib/openai/models/beta/threads/text.rb +2 -1
  421. data/lib/openai/models/beta/threads/text_content_block.rb +2 -1
  422. data/lib/openai/models/beta/threads/text_content_block_param.rb +4 -2
  423. data/lib/openai/models/beta/threads/text_delta.rb +2 -1
  424. data/lib/openai/models/beta/threads/text_delta_block.rb +4 -2
  425. data/lib/openai/models/chat/chat_completion.rb +143 -75
  426. data/lib/openai/models/chat/chat_completion_allowed_tool_choice.rb +4 -5
  427. data/lib/openai/models/chat/chat_completion_allowed_tools.rb +18 -5
  428. data/lib/openai/models/chat/chat_completion_assistant_message_param.rb +31 -26
  429. data/lib/openai/models/chat/chat_completion_audio.rb +11 -8
  430. data/lib/openai/models/chat/chat_completion_audio_param.rb +11 -7
  431. data/lib/openai/models/chat/chat_completion_chunk.rb +174 -97
  432. data/lib/openai/models/chat/chat_completion_content_part.rb +22 -20
  433. data/lib/openai/models/chat/chat_completion_content_part_image.rb +17 -15
  434. data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +13 -13
  435. data/lib/openai/models/chat/chat_completion_content_part_refusal.rb +4 -2
  436. data/lib/openai/models/chat/chat_completion_content_part_text.rb +11 -9
  437. data/lib/openai/models/chat/chat_completion_custom_tool.rb +20 -16
  438. data/lib/openai/models/chat/chat_completion_deleted.rb +6 -3
  439. data/lib/openai/models/chat/chat_completion_developer_message_param.rb +7 -6
  440. data/lib/openai/models/chat/chat_completion_function_call_option.rb +2 -1
  441. data/lib/openai/models/chat/chat_completion_function_message_param.rb +6 -3
  442. data/lib/openai/models/chat/chat_completion_function_tool.rb +2 -1
  443. data/lib/openai/models/chat/chat_completion_message.rb +39 -24
  444. data/lib/openai/models/chat/chat_completion_message_custom_tool_call.rb +10 -5
  445. data/lib/openai/models/chat/chat_completion_message_function_tool_call.rb +13 -9
  446. data/lib/openai/models/chat/chat_completion_named_tool_choice.rb +4 -2
  447. data/lib/openai/models/chat/chat_completion_named_tool_choice_custom.rb +4 -2
  448. data/lib/openai/models/chat/chat_completion_prediction_content.rb +8 -6
  449. data/lib/openai/models/chat/chat_completion_store_message.rb +26 -16
  450. data/lib/openai/models/chat/chat_completion_stream_options.rb +15 -5
  451. data/lib/openai/models/chat/chat_completion_system_message_param.rb +7 -6
  452. data/lib/openai/models/chat/chat_completion_token_logprob.rb +25 -14
  453. data/lib/openai/models/chat/chat_completion_tool_message_param.rb +6 -3
  454. data/lib/openai/models/chat/chat_completion_user_message_param.rb +8 -7
  455. data/lib/openai/models/chat/completion_create_params.rb +388 -161
  456. data/lib/openai/models/chat/completion_list_params.rb +12 -7
  457. data/lib/openai/models/chat/completion_update_params.rb +7 -4
  458. data/lib/openai/models/chat/completions/message_list_params.rb +7 -6
  459. data/lib/openai/models/comparison_filter.rb +17 -6
  460. data/lib/openai/models/completion.rb +17 -10
  461. data/lib/openai/models/completion_choice.rb +5 -4
  462. data/lib/openai/models/completion_create_params.rb +124 -37
  463. data/lib/openai/models/completion_usage.rb +34 -18
  464. data/lib/openai/models/compound_filter.rb +5 -5
  465. data/lib/openai/models/container_create_params.rb +15 -10
  466. data/lib/openai/models/container_create_response.rb +28 -16
  467. data/lib/openai/models/container_list_params.rb +13 -7
  468. data/lib/openai/models/container_list_response.rb +28 -16
  469. data/lib/openai/models/container_retrieve_response.rb +28 -16
  470. data/lib/openai/models/containers/file_create_params.rb +8 -5
  471. data/lib/openai/models/containers/file_create_response.rb +14 -7
  472. data/lib/openai/models/containers/file_list_params.rb +11 -6
  473. data/lib/openai/models/containers/file_list_response.rb +14 -7
  474. data/lib/openai/models/containers/file_retrieve_response.rb +14 -7
  475. data/lib/openai/models/content_provenance_check.rb +44 -25
  476. data/lib/openai/models/content_provenance_check_create_params.rb +6 -1
  477. data/lib/openai/models/conversations/computer_screenshot_content.rb +16 -9
  478. data/lib/openai/models/conversations/conversation.rb +16 -10
  479. data/lib/openai/models/conversations/conversation_create_params.rb +9 -4
  480. data/lib/openai/models/conversations/conversation_item.rb +228 -103
  481. data/lib/openai/models/conversations/conversation_item_list.rb +10 -5
  482. data/lib/openai/models/conversations/conversation_update_params.rb +7 -4
  483. data/lib/openai/models/conversations/item_create_params.rb +7 -6
  484. data/lib/openai/models/conversations/item_list_params.rb +29 -7
  485. data/lib/openai/models/conversations/item_retrieve_params.rb +5 -5
  486. data/lib/openai/models/conversations/message.rb +22 -12
  487. data/lib/openai/models/conversations/summary_text_content.rb +4 -2
  488. data/lib/openai/models/create_embedding_response.rb +12 -6
  489. data/lib/openai/models/custom_tool_input_format.rb +8 -4
  490. data/lib/openai/models/embedding.rb +9 -7
  491. data/lib/openai/models/embedding_create_params.rb +36 -18
  492. data/lib/openai/models/error_object.rb +8 -4
  493. data/lib/openai/models/eval_create_params.rb +105 -74
  494. data/lib/openai/models/eval_create_response.rb +69 -42
  495. data/lib/openai/models/eval_custom_data_source_config.rb +5 -5
  496. data/lib/openai/models/eval_list_params.rb +10 -7
  497. data/lib/openai/models/eval_list_response.rb +69 -42
  498. data/lib/openai/models/eval_retrieve_response.rb +69 -42
  499. data/lib/openai/models/eval_stored_completions_data_source_config.rb +12 -6
  500. data/lib/openai/models/eval_update_params.rb +9 -5
  501. data/lib/openai/models/eval_update_response.rb +69 -42
  502. data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +97 -64
  503. data/lib/openai/models/evals/create_eval_jsonl_run_data_source.rb +12 -7
  504. data/lib/openai/models/evals/eval_api_error.rb +4 -2
  505. data/lib/openai/models/evals/run_cancel_response.rb +204 -114
  506. data/lib/openai/models/evals/run_create_params.rb +156 -90
  507. data/lib/openai/models/evals/run_create_response.rb +204 -114
  508. data/lib/openai/models/evals/run_list_params.rb +10 -7
  509. data/lib/openai/models/evals/run_list_response.rb +204 -114
  510. data/lib/openai/models/evals/run_retrieve_response.rb +204 -114
  511. data/lib/openai/models/evals/runs/output_item_list_params.rb +10 -7
  512. data/lib/openai/models/evals/runs/output_item_list_response.rb +66 -38
  513. data/lib/openai/models/evals/runs/output_item_retrieve_response.rb +66 -39
  514. data/lib/openai/models/file_create_params.rb +23 -10
  515. data/lib/openai/models/file_list_params.rb +13 -7
  516. data/lib/openai/models/file_object.rb +22 -12
  517. data/lib/openai/models/fine_tuning/alpha/grader_run_params.rb +18 -10
  518. data/lib/openai/models/fine_tuning/alpha/grader_validate_params.rb +2 -1
  519. data/lib/openai/models/fine_tuning/alpha/grader_validate_response.rb +2 -1
  520. data/lib/openai/models/fine_tuning/checkpoints/permission_create_params.rb +2 -1
  521. data/lib/openai/models/fine_tuning/checkpoints/permission_create_response.rb +8 -4
  522. data/lib/openai/models/fine_tuning/checkpoints/permission_delete_response.rb +6 -3
  523. data/lib/openai/models/fine_tuning/checkpoints/permission_list_params.rb +8 -4
  524. data/lib/openai/models/fine_tuning/checkpoints/permission_list_response.rb +8 -4
  525. data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb +8 -4
  526. data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb +8 -4
  527. data/lib/openai/models/fine_tuning/dpo_hyperparameters.rb +12 -7
  528. data/lib/openai/models/fine_tuning/dpo_method.rb +2 -1
  529. data/lib/openai/models/fine_tuning/fine_tuning_job.rb +82 -41
  530. data/lib/openai/models/fine_tuning/fine_tuning_job_event.rb +14 -7
  531. data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rb +13 -7
  532. data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rb +7 -6
  533. data/lib/openai/models/fine_tuning/job_create_params.rb +107 -42
  534. data/lib/openai/models/fine_tuning/job_list_events_params.rb +4 -2
  535. data/lib/openai/models/fine_tuning/job_list_params.rb +7 -6
  536. data/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb +4 -2
  537. data/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb +14 -7
  538. data/lib/openai/models/fine_tuning/reinforcement_hyperparameters.rb +17 -10
  539. data/lib/openai/models/fine_tuning/reinforcement_method.rb +4 -2
  540. data/lib/openai/models/fine_tuning/supervised_hyperparameters.rb +9 -6
  541. data/lib/openai/models/fine_tuning/supervised_method.rb +2 -1
  542. data/lib/openai/models/function_definition.rb +22 -9
  543. data/lib/openai/models/graders/grader_input_item.rb +11 -11
  544. data/lib/openai/models/graders/label_model_grader.rb +29 -25
  545. data/lib/openai/models/graders/multi_grader.rb +9 -7
  546. data/lib/openai/models/graders/python_grader.rb +8 -4
  547. data/lib/openai/models/graders/score_model_grader.rb +48 -38
  548. data/lib/openai/models/graders/string_check_grader.rb +10 -5
  549. data/lib/openai/models/graders/text_similarity_grader.rb +11 -8
  550. data/lib/openai/models/image.rb +10 -6
  551. data/lib/openai/models/image_create_variation_params.rb +23 -9
  552. data/lib/openai/models/image_edit_completed_event.rb +29 -20
  553. data/lib/openai/models/image_edit_params.rb +108 -31
  554. data/lib/openai/models/image_edit_partial_image_event.rb +16 -11
  555. data/lib/openai/models/image_gen_completed_event.rb +29 -20
  556. data/lib/openai/models/image_gen_partial_image_event.rb +16 -11
  557. data/lib/openai/models/image_generate_params.rb +92 -29
  558. data/lib/openai/models/image_input_reference_param.rb +2 -1
  559. data/lib/openai/models/images_response.rb +34 -19
  560. data/lib/openai/models/live/audio_format.rb +109 -0
  561. data/lib/openai/models/live/built_in_voice.rb +38 -0
  562. data/lib/openai/models/live/client_config.rb +22 -0
  563. data/lib/openai/models/live/client_delegation.rb +22 -0
  564. data/lib/openai/models/live/client_event.rb +54 -0
  565. data/lib/openai/models/live/commentary_append_event.rb +59 -0
  566. data/lib/openai/models/live/commentary_appended_event.rb +65 -0
  567. data/lib/openai/models/live/custom_voice.rb +17 -0
  568. data/lib/openai/models/live/data_channel_config.rb +81 -0
  569. data/lib/openai/models/live/delegation_created_event.rb +140 -0
  570. data/lib/openai/models/live/error.rb +60 -0
  571. data/lib/openai/models/live/error_event.rb +52 -0
  572. data/lib/openai/models/live/fork_client_event.rb +53 -0
  573. data/lib/openai/models/live/fork_server_event.rb +295 -0
  574. data/lib/openai/models/live/fork_session_config.rb +107 -0
  575. data/lib/openai/models/live/fork_session_start_event.rb +48 -0
  576. data/lib/openai/models/live/function_tool.rb +60 -0
  577. data/lib/openai/models/live/info_event.rb +60 -0
  578. data/lib/openai/models/live/initial_item.rb +419 -0
  579. data/lib/openai/models/live/input_audio_append_event.rb +50 -0
  580. data/lib/openai/models/live/input_audio_mute_event.rb +33 -0
  581. data/lib/openai/models/live/input_audio_muted_event.rb +42 -0
  582. data/lib/openai/models/live/input_audio_unmute_event.rb +33 -0
  583. data/lib/openai/models/live/input_audio_unmuted_event.rb +42 -0
  584. data/lib/openai/models/live/input_transcript_delta_event.rb +76 -0
  585. data/lib/openai/models/live/instructions_append_event.rb +57 -0
  586. data/lib/openai/models/live/instructions_appended_event.rb +65 -0
  587. data/lib/openai/models/live/live_create_params.rb +57 -0
  588. data/lib/openai/models/live/live_create_response.rb +77 -0
  589. data/lib/openai/models/live/media_session_config.rb +227 -0
  590. data/lib/openai/models/live/media_session_fork_config.rb +75 -0
  591. data/lib/openai/models/live/output_audio_delta_event.rb +58 -0
  592. data/lib/openai/models/live/output_transcript_delta_event.rb +76 -0
  593. data/lib/openai/models/live/response_create_event.rb +33 -0
  594. data/lib/openai/models/live/response_event.rb +67 -0
  595. data/lib/openai/models/live/response_item_create_event.rb +44 -0
  596. data/lib/openai/models/live/responses_delegation_config.rb +332 -0
  597. data/lib/openai/models/live/responses_delegation_update_config.rb +332 -0
  598. data/lib/openai/models/live/server_event.rb +295 -0
  599. data/lib/openai/models/live/server_event_selector.rb +32 -0
  600. data/lib/openai/models/live/session_accept_params.rb +257 -0
  601. data/lib/openai/models/live/session_close_event.rb +33 -0
  602. data/lib/openai/models/live/session_closed_event.rb +113 -0
  603. data/lib/openai/models/live/session_config.rb +236 -0
  604. data/lib/openai/models/live/session_download_recording_params.rb +27 -0
  605. data/lib/openai/models/live/session_fork_params.rb +66 -0
  606. data/lib/openai/models/live/session_fork_response.rb +77 -0
  607. data/lib/openai/models/live/session_hangup_params.rb +22 -0
  608. data/lib/openai/models/live/session_refer_params.rb +34 -0
  609. data/lib/openai/models/live/session_reject_params.rb +32 -0
  610. data/lib/openai/models/live/session_resource.rb +268 -0
  611. data/lib/openai/models/live/session_start_event.rb +46 -0
  612. data/lib/openai/models/live/session_started_event.rb +51 -0
  613. data/lib/openai/models/live/session_update_config.rb +69 -0
  614. data/lib/openai/models/live/session_update_event.rb +46 -0
  615. data/lib/openai/models/live/session_updated_event.rb +51 -0
  616. data/lib/openai/models/live/session_usage.rb +24 -0
  617. data/lib/openai/models/live/session_usage_updated_event.rb +81 -0
  618. data/lib/openai/models/live/thinking_append_event.rb +59 -0
  619. data/lib/openai/models/live/thinking_appended_event.rb +65 -0
  620. data/lib/openai/models/model.rb +10 -5
  621. data/lib/openai/models/moderation.rb +115 -62
  622. data/lib/openai/models/moderation_create_params.rb +16 -13
  623. data/lib/openai/models/moderation_create_response.rb +6 -3
  624. data/lib/openai/models/moderation_image_url_input.rb +6 -3
  625. data/lib/openai/models/moderation_text_input.rb +4 -2
  626. data/lib/openai/models/other_file_chunking_strategy_object.rb +2 -1
  627. data/lib/openai/models/realtime/audio_transcription.rb +29 -10
  628. data/lib/openai/models/realtime/call_accept_params.rb +85 -30
  629. data/lib/openai/models/realtime/call_create_params.rb +4 -2
  630. data/lib/openai/models/realtime/call_refer_params.rb +3 -4
  631. data/lib/openai/models/realtime/call_reject_params.rb +3 -4
  632. data/lib/openai/models/realtime/client_secret_create_params.rb +16 -11
  633. data/lib/openai/models/realtime/client_secret_create_response.rb +6 -6
  634. data/lib/openai/models/realtime/conversation_created_event.rb +10 -5
  635. data/lib/openai/models/realtime/conversation_item_added.rb +9 -7
  636. data/lib/openai/models/realtime/conversation_item_create_event.rb +16 -7
  637. data/lib/openai/models/realtime/conversation_item_created_event.rb +10 -7
  638. data/lib/openai/models/realtime/conversation_item_delete_event.rb +6 -3
  639. data/lib/openai/models/realtime/conversation_item_deleted_event.rb +6 -3
  640. data/lib/openai/models/realtime/conversation_item_done.rb +9 -7
  641. data/lib/openai/models/realtime/conversation_item_input_audio_transcription_completed_event.rb +36 -21
  642. data/lib/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rb +17 -10
  643. data/lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb +18 -13
  644. data/lib/openai/models/realtime/conversation_item_input_audio_transcription_segment.rb +18 -9
  645. data/lib/openai/models/realtime/conversation_item_retrieve_event.rb +6 -3
  646. data/lib/openai/models/realtime/conversation_item_truncate_event.rb +13 -8
  647. data/lib/openai/models/realtime/conversation_item_truncated_event.rb +10 -8
  648. data/lib/openai/models/realtime/conversation_item_with_reference.rb +47 -24
  649. data/lib/openai/models/realtime/input_audio_buffer_append_event.rb +7 -6
  650. data/lib/openai/models/realtime/input_audio_buffer_clear_event.rb +4 -2
  651. data/lib/openai/models/realtime/input_audio_buffer_cleared_event.rb +4 -2
  652. data/lib/openai/models/realtime/input_audio_buffer_commit_event.rb +4 -2
  653. data/lib/openai/models/realtime/input_audio_buffer_committed_event.rb +9 -7
  654. data/lib/openai/models/realtime/input_audio_buffer_dtmf_event_received_event.rb +6 -7
  655. data/lib/openai/models/realtime/input_audio_buffer_speech_started_event.rb +11 -7
  656. data/lib/openai/models/realtime/input_audio_buffer_speech_stopped_event.rb +10 -7
  657. data/lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb +12 -8
  658. data/lib/openai/models/realtime/log_prob_properties.rb +6 -6
  659. data/lib/openai/models/realtime/mcp_list_tools_completed.rb +6 -3
  660. data/lib/openai/models/realtime/mcp_list_tools_failed.rb +6 -3
  661. data/lib/openai/models/realtime/mcp_list_tools_in_progress.rb +6 -3
  662. data/lib/openai/models/realtime/output_audio_buffer_clear_event.rb +5 -3
  663. data/lib/openai/models/realtime/rate_limits_updated_event.rb +14 -11
  664. data/lib/openai/models/realtime/realtime_audio_config_input.rb +38 -12
  665. data/lib/openai/models/realtime/realtime_audio_config_output.rb +18 -6
  666. data/lib/openai/models/realtime/realtime_audio_formats.rb +8 -4
  667. data/lib/openai/models/realtime/realtime_audio_input_turn_detection.rb +61 -25
  668. data/lib/openai/models/realtime/realtime_client_event.rb +1 -1
  669. data/lib/openai/models/realtime/realtime_conversation_item_assistant_message.rb +26 -19
  670. data/lib/openai/models/realtime/realtime_conversation_item_function_call.rb +18 -11
  671. data/lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb +15 -10
  672. data/lib/openai/models/realtime/realtime_conversation_item_system_message.rb +18 -13
  673. data/lib/openai/models/realtime/realtime_conversation_item_user_message.rb +32 -21
  674. data/lib/openai/models/realtime/realtime_error.rb +10 -8
  675. data/lib/openai/models/realtime/realtime_error_event.rb +6 -3
  676. data/lib/openai/models/realtime/realtime_function_tool.rb +9 -7
  677. data/lib/openai/models/realtime/realtime_mcp_approval_request.rb +10 -5
  678. data/lib/openai/models/realtime/realtime_mcp_approval_response.rb +10 -5
  679. data/lib/openai/models/realtime/realtime_mcp_list_tools.rb +16 -12
  680. data/lib/openai/models/realtime/realtime_mcp_tool_call.rb +16 -8
  681. data/lib/openai/models/realtime/realtime_reasoning.rb +3 -4
  682. data/lib/openai/models/realtime/realtime_response.rb +47 -19
  683. data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +11 -7
  684. data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +71 -43
  685. data/lib/openai/models/realtime/realtime_response_create_params.rb +56 -18
  686. data/lib/openai/models/realtime/realtime_response_status.rb +16 -8
  687. data/lib/openai/models/realtime/realtime_response_usage.rb +16 -8
  688. data/lib/openai/models/realtime/realtime_response_usage_input_token_details.rb +16 -8
  689. data/lib/openai/models/realtime/realtime_response_usage_output_token_details.rb +4 -2
  690. data/lib/openai/models/realtime/realtime_server_event.rb +30 -18
  691. data/lib/openai/models/realtime/realtime_session.rb +191 -82
  692. data/lib/openai/models/realtime/realtime_session_create_request.rb +86 -32
  693. data/lib/openai/models/realtime/realtime_session_create_response.rb +256 -110
  694. data/lib/openai/models/realtime/realtime_tools_config_union.rb +73 -45
  695. data/lib/openai/models/realtime/realtime_tracing_config.rb +9 -7
  696. data/lib/openai/models/realtime/realtime_transcription_session_audio_input.rb +38 -13
  697. data/lib/openai/models/realtime/realtime_transcription_session_audio_input_turn_detection.rb +61 -25
  698. data/lib/openai/models/realtime/realtime_transcription_session_create_request.rb +10 -8
  699. data/lib/openai/models/realtime/realtime_transcription_session_create_response.rb +28 -22
  700. data/lib/openai/models/realtime/realtime_transcription_session_turn_detection.rb +13 -8
  701. data/lib/openai/models/realtime/realtime_translation_client_secret_create_request.rb +16 -12
  702. data/lib/openai/models/realtime/realtime_translation_client_secret_create_response.rb +7 -7
  703. data/lib/openai/models/realtime/realtime_translation_input_audio_buffer_append_event.rb +6 -3
  704. data/lib/openai/models/realtime/realtime_translation_input_transcript_delta_event.rb +11 -8
  705. data/lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb +16 -11
  706. data/lib/openai/models/realtime/realtime_translation_output_transcript_delta_event.rb +11 -8
  707. data/lib/openai/models/realtime/realtime_translation_session.rb +25 -25
  708. data/lib/openai/models/realtime/realtime_translation_session_close_event.rb +4 -2
  709. data/lib/openai/models/realtime/realtime_translation_session_closed_event.rb +4 -2
  710. data/lib/openai/models/realtime/realtime_translation_session_create_request.rb +18 -23
  711. data/lib/openai/models/realtime/realtime_translation_session_created_event.rb +6 -3
  712. data/lib/openai/models/realtime/realtime_translation_session_update_event.rb +7 -7
  713. data/lib/openai/models/realtime/realtime_translation_session_update_request.rb +16 -22
  714. data/lib/openai/models/realtime/realtime_translation_session_updated_event.rb +6 -3
  715. data/lib/openai/models/realtime/realtime_truncation_retention_ratio.rb +16 -11
  716. data/lib/openai/models/realtime/response_audio_delta_event.rb +14 -7
  717. data/lib/openai/models/realtime/response_audio_done_event.rb +12 -6
  718. data/lib/openai/models/realtime/response_audio_transcript_delta_event.rb +14 -7
  719. data/lib/openai/models/realtime/response_audio_transcript_done_event.rb +14 -7
  720. data/lib/openai/models/realtime/response_cancel_event.rb +7 -6
  721. data/lib/openai/models/realtime/response_content_part_added_event.rb +22 -11
  722. data/lib/openai/models/realtime/response_content_part_done_event.rb +22 -11
  723. data/lib/openai/models/realtime/response_create_event.rb +6 -3
  724. data/lib/openai/models/realtime/response_created_event.rb +6 -3
  725. data/lib/openai/models/realtime/response_done_event.rb +6 -3
  726. data/lib/openai/models/realtime/response_function_call_arguments_delta_event.rb +14 -11
  727. data/lib/openai/models/realtime/response_function_call_arguments_done_event.rb +16 -12
  728. data/lib/openai/models/realtime/response_mcp_call_arguments_delta.rb +14 -7
  729. data/lib/openai/models/realtime/response_mcp_call_arguments_done.rb +12 -6
  730. data/lib/openai/models/realtime/response_mcp_call_completed.rb +8 -4
  731. data/lib/openai/models/realtime/response_mcp_call_failed.rb +8 -4
  732. data/lib/openai/models/realtime/response_mcp_call_in_progress.rb +8 -4
  733. data/lib/openai/models/realtime/response_output_item_added_event.rb +10 -5
  734. data/lib/openai/models/realtime/response_output_item_done_event.rb +10 -5
  735. data/lib/openai/models/realtime/response_text_delta_event.rb +14 -7
  736. data/lib/openai/models/realtime/response_text_done_event.rb +14 -7
  737. data/lib/openai/models/realtime/session_created_event.rb +6 -3
  738. data/lib/openai/models/realtime/session_update_event.rb +10 -6
  739. data/lib/openai/models/realtime/session_updated_event.rb +6 -3
  740. data/lib/openai/models/realtime/transcription_session_update.rb +45 -26
  741. data/lib/openai/models/realtime/transcription_session_updated_event.rb +42 -28
  742. data/lib/openai/models/reasoning.rb +33 -10
  743. data/lib/openai/models/reasoning_effort.rb +1 -1
  744. data/lib/openai/models/response_format_json_object.rb +2 -1
  745. data/lib/openai/models/response_format_json_schema.rb +21 -14
  746. data/lib/openai/models/response_format_text.rb +2 -1
  747. data/lib/openai/models/response_format_text_grammar.rb +5 -3
  748. data/lib/openai/models/response_format_text_python.rb +3 -2
  749. data/lib/openai/models/responses/apply_patch_tool.rb +4 -3
  750. data/lib/openai/models/responses/compacted_response.rb +12 -8
  751. data/lib/openai/models/responses/computer_action.rb +78 -58
  752. data/lib/openai/models/responses/computer_tool.rb +3 -2
  753. data/lib/openai/models/responses/computer_use_preview_tool.rb +9 -5
  754. data/lib/openai/models/responses/container_auto.rb +10 -5
  755. data/lib/openai/models/responses/container_network_policy_allowlist.rb +6 -3
  756. data/lib/openai/models/responses/container_network_policy_disabled.rb +2 -1
  757. data/lib/openai/models/responses/container_network_policy_domain_secret.rb +6 -3
  758. data/lib/openai/models/responses/container_reference.rb +4 -2
  759. data/lib/openai/models/responses/custom_tool.rb +16 -12
  760. data/lib/openai/models/responses/easy_input_message.rb +13 -7
  761. data/lib/openai/models/responses/file_search_tool.rb +25 -17
  762. data/lib/openai/models/responses/function_shell_tool.rb +4 -3
  763. data/lib/openai/models/responses/function_tool.rb +19 -13
  764. data/lib/openai/models/responses/inline_skill.rb +8 -4
  765. data/lib/openai/models/responses/inline_skill_source.rb +6 -3
  766. data/lib/openai/models/responses/input_item_list_params.rb +13 -7
  767. data/lib/openai/models/responses/input_token_count_params.rb +79 -30
  768. data/lib/openai/models/responses/local_environment.rb +4 -2
  769. data/lib/openai/models/responses/local_skill.rb +6 -3
  770. data/lib/openai/models/responses/namespace_tool.rb +23 -13
  771. data/lib/openai/models/responses/response.rb +336 -152
  772. data/lib/openai/models/responses/response_apply_patch_tool_call.rb +34 -19
  773. data/lib/openai/models/responses/response_apply_patch_tool_call_output.rb +17 -11
  774. data/lib/openai/models/responses/response_audio_delta_event.rb +6 -6
  775. data/lib/openai/models/responses/response_audio_done_event.rb +4 -5
  776. data/lib/openai/models/responses/response_audio_transcript_delta_event.rb +6 -6
  777. data/lib/openai/models/responses/response_audio_transcript_done_event.rb +4 -5
  778. data/lib/openai/models/responses/response_code_interpreter_call_code_delta_event.rb +11 -9
  779. data/lib/openai/models/responses/response_code_interpreter_call_code_done_event.rb +10 -5
  780. data/lib/openai/models/responses/response_code_interpreter_call_completed_event.rb +9 -8
  781. data/lib/openai/models/responses/response_code_interpreter_call_in_progress_event.rb +9 -8
  782. data/lib/openai/models/responses/response_code_interpreter_call_interpreting_event.rb +9 -8
  783. data/lib/openai/models/responses/response_code_interpreter_tool_call.rb +22 -13
  784. data/lib/openai/models/responses/response_compact_params.rb +89 -46
  785. data/lib/openai/models/responses/response_compaction_item.rb +9 -5
  786. data/lib/openai/models/responses/response_compaction_item_param.rb +7 -4
  787. data/lib/openai/models/responses/response_completed_event.rb +6 -6
  788. data/lib/openai/models/responses/response_computer_tool_call.rb +101 -82
  789. data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +22 -14
  790. data/lib/openai/models/responses/response_computer_tool_call_output_screenshot.rb +7 -7
  791. data/lib/openai/models/responses/response_configuration_update_item.rb +9 -8
  792. data/lib/openai/models/responses/response_configuration_update_item_param.rb +9 -8
  793. data/lib/openai/models/responses/response_container_reference.rb +2 -1
  794. data/lib/openai/models/responses/response_content.rb +5 -3
  795. data/lib/openai/models/responses/response_content_part_added_event.rb +16 -11
  796. data/lib/openai/models/responses/response_content_part_done_event.rb +16 -11
  797. data/lib/openai/models/responses/response_conversation_param.rb +2 -1
  798. data/lib/openai/models/responses/response_create_params.rb +332 -131
  799. data/lib/openai/models/responses/response_created_event.rb +6 -6
  800. data/lib/openai/models/responses/response_custom_tool_call.rb +18 -12
  801. data/lib/openai/models/responses/response_custom_tool_call_input_delta_event.rb +10 -5
  802. data/lib/openai/models/responses/response_custom_tool_call_input_done_event.rb +10 -5
  803. data/lib/openai/models/responses/response_custom_tool_call_item.rb +21 -13
  804. data/lib/openai/models/responses/response_custom_tool_call_output.rb +18 -12
  805. data/lib/openai/models/responses/response_custom_tool_call_output_item.rb +16 -10
  806. data/lib/openai/models/responses/response_error.rb +12 -9
  807. data/lib/openai/models/responses/response_error_event.rb +10 -8
  808. data/lib/openai/models/responses/response_failed_event.rb +6 -6
  809. data/lib/openai/models/responses/response_file_search_call_completed_event.rb +8 -8
  810. data/lib/openai/models/responses/response_file_search_call_in_progress_event.rb +8 -8
  811. data/lib/openai/models/responses/response_file_search_call_searching_event.rb +8 -8
  812. data/lib/openai/models/responses/response_file_search_tool_call.rb +26 -19
  813. data/lib/openai/models/responses/response_format_text_config.rb +2 -2
  814. data/lib/openai/models/responses/response_format_text_json_schema_config.rb +19 -11
  815. data/lib/openai/models/responses/response_function_call_arguments_delta_event.rb +10 -9
  816. data/lib/openai/models/responses/response_function_call_arguments_done_event.rb +8 -4
  817. data/lib/openai/models/responses/response_function_call_output_item.rb +1 -1
  818. data/lib/openai/models/responses/response_function_shell_call_output_content.rb +12 -6
  819. data/lib/openai/models/responses/response_function_shell_tool_call.rb +24 -14
  820. data/lib/openai/models/responses/response_function_shell_tool_call_output.rb +36 -25
  821. data/lib/openai/models/responses/response_function_tool_call.rb +22 -14
  822. data/lib/openai/models/responses/response_function_tool_call_item.rb +22 -14
  823. data/lib/openai/models/responses/response_function_tool_call_output_item.rb +27 -17
  824. data/lib/openai/models/responses/response_function_web_search.rb +33 -37
  825. data/lib/openai/models/responses/response_image_gen_call_completed_event.rb +8 -4
  826. data/lib/openai/models/responses/response_image_gen_call_generating_event.rb +8 -4
  827. data/lib/openai/models/responses/response_image_gen_call_in_progress_event.rb +8 -4
  828. data/lib/openai/models/responses/response_image_gen_call_partial_image_event.rb +21 -14
  829. data/lib/openai/models/responses/response_in_progress_event.rb +6 -6
  830. data/lib/openai/models/responses/response_incomplete_event.rb +6 -6
  831. data/lib/openai/models/responses/response_input_audio.rb +6 -9
  832. data/lib/openai/models/responses/response_input_content.rb +1 -1
  833. data/lib/openai/models/responses/response_input_file.rb +22 -11
  834. data/lib/openai/models/responses/response_input_file_content.rb +22 -11
  835. data/lib/openai/models/responses/response_input_image.rb +17 -10
  836. data/lib/openai/models/responses/response_input_image_content.rb +17 -10
  837. data/lib/openai/models/responses/response_input_item.rb +407 -212
  838. data/lib/openai/models/responses/response_input_message_item.rb +12 -8
  839. data/lib/openai/models/responses/response_input_text.rb +10 -7
  840. data/lib/openai/models/responses/response_input_text_content.rb +10 -7
  841. data/lib/openai/models/responses/response_item.rb +229 -96
  842. data/lib/openai/models/responses/response_item_list.rb +10 -5
  843. data/lib/openai/models/responses/response_local_environment.rb +2 -1
  844. data/lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb +11 -9
  845. data/lib/openai/models/responses/response_mcp_call_arguments_done_event.rb +10 -8
  846. data/lib/openai/models/responses/response_mcp_call_completed_event.rb +8 -4
  847. data/lib/openai/models/responses/response_mcp_call_failed_event.rb +8 -4
  848. data/lib/openai/models/responses/response_mcp_call_in_progress_event.rb +8 -4
  849. data/lib/openai/models/responses/response_mcp_list_tools_completed_event.rb +8 -4
  850. data/lib/openai/models/responses/response_mcp_list_tools_failed_event.rb +8 -4
  851. data/lib/openai/models/responses/response_mcp_list_tools_in_progress_event.rb +8 -4
  852. data/lib/openai/models/responses/response_output_audio.rb +6 -6
  853. data/lib/openai/models/responses/response_output_item.rb +227 -101
  854. data/lib/openai/models/responses/response_output_item_added_event.rb +11 -7
  855. data/lib/openai/models/responses/response_output_item_done_event.rb +8 -7
  856. data/lib/openai/models/responses/response_output_message.rb +16 -9
  857. data/lib/openai/models/responses/response_output_refusal.rb +4 -2
  858. data/lib/openai/models/responses/response_output_text.rb +42 -25
  859. data/lib/openai/models/responses/response_output_text_annotation_added_event.rb +50 -29
  860. data/lib/openai/models/responses/response_prompt.rb +10 -8
  861. data/lib/openai/models/responses/response_queued_event.rb +6 -3
  862. data/lib/openai/models/responses/response_reasoning_item.rb +29 -15
  863. data/lib/openai/models/responses/response_reasoning_summary_part_added_event.rb +16 -12
  864. data/lib/openai/models/responses/response_reasoning_summary_part_done_event.rb +19 -13
  865. data/lib/openai/models/responses/response_reasoning_summary_text_delta_event.rb +12 -10
  866. data/lib/openai/models/responses/response_reasoning_summary_text_done_event.rb +12 -10
  867. data/lib/openai/models/responses/response_reasoning_text_delta_event.rb +12 -9
  868. data/lib/openai/models/responses/response_reasoning_text_done_event.rb +12 -9
  869. data/lib/openai/models/responses/response_refusal_delta_event.rb +12 -9
  870. data/lib/openai/models/responses/response_refusal_done_event.rb +12 -9
  871. data/lib/openai/models/responses/response_retrieve_params.rb +12 -6
  872. data/lib/openai/models/responses/response_shell_call_command_added_event.rb +10 -5
  873. data/lib/openai/models/responses/response_shell_call_command_delta_event.rb +12 -6
  874. data/lib/openai/models/responses/response_shell_call_command_done_event.rb +10 -5
  875. data/lib/openai/models/responses/response_shell_call_output_content_delta_event.rb +16 -8
  876. data/lib/openai/models/responses/response_shell_call_output_content_done_event.rb +27 -18
  877. data/lib/openai/models/responses/response_steer_accepted_event.rb +13 -9
  878. data/lib/openai/models/responses/response_steer_event.rb +14 -6
  879. data/lib/openai/models/responses/response_steer_failed_event.rb +45 -22
  880. data/lib/openai/models/responses/response_steer_input.rb +34 -20
  881. data/lib/openai/models/responses/response_steer_input_content.rb +1 -1
  882. data/lib/openai/models/responses/response_steer_pending_event.rb +24 -11
  883. data/lib/openai/models/responses/response_text_config.rb +22 -8
  884. data/lib/openai/models/responses/response_text_delta_event.rb +24 -20
  885. data/lib/openai/models/responses/response_text_done_event.rb +24 -20
  886. data/lib/openai/models/responses/response_tool_search_call.rb +14 -7
  887. data/lib/openai/models/responses/response_tool_search_output_item.rb +14 -7
  888. data/lib/openai/models/responses/response_tool_search_output_item_param.rb +12 -6
  889. data/lib/openai/models/responses/response_usage.rb +18 -12
  890. data/lib/openai/models/responses/response_web_search_call_completed_event.rb +8 -8
  891. data/lib/openai/models/responses/response_web_search_call_in_progress_event.rb +8 -8
  892. data/lib/openai/models/responses/response_web_search_call_searching_event.rb +8 -8
  893. data/lib/openai/models/responses/responses_client_event.rb +351 -141
  894. data/lib/openai/models/responses/responses_server_event.rb +744 -570
  895. data/lib/openai/models/responses/skill_reference.rb +6 -3
  896. data/lib/openai/models/responses/tool.rb +170 -95
  897. data/lib/openai/models/responses/tool_choice_allowed.rb +21 -6
  898. data/lib/openai/models/responses/tool_choice_apply_patch.rb +2 -1
  899. data/lib/openai/models/responses/tool_choice_custom.rb +4 -2
  900. data/lib/openai/models/responses/tool_choice_function.rb +4 -2
  901. data/lib/openai/models/responses/tool_choice_mcp.rb +6 -6
  902. data/lib/openai/models/responses/tool_choice_shell.rb +2 -1
  903. data/lib/openai/models/responses/tool_choice_types.rb +16 -7
  904. data/lib/openai/models/responses/tool_search_tool.rb +8 -4
  905. data/lib/openai/models/responses/web_search_preview_tool.rb +21 -16
  906. data/lib/openai/models/responses/web_search_tool.rb +31 -21
  907. data/lib/openai/models/safety/alert_retrieve_params.rb +2 -1
  908. data/lib/openai/models/safety/safety_alert.rb +6 -5
  909. data/lib/openai/models/skill.rb +14 -7
  910. data/lib/openai/models/skill_create_params.rb +6 -1
  911. data/lib/openai/models/skill_list.rb +10 -5
  912. data/lib/openai/models/skill_list_params.rb +7 -6
  913. data/lib/openai/models/skill_update_params.rb +2 -1
  914. data/lib/openai/models/skills/deleted_skill_version.rb +2 -1
  915. data/lib/openai/models/skills/skill_version.rb +14 -7
  916. data/lib/openai/models/skills/skill_version_list.rb +10 -5
  917. data/lib/openai/models/skills/version_create_params.rb +8 -2
  918. data/lib/openai/models/skills/version_delete_params.rb +2 -1
  919. data/lib/openai/models/skills/version_list_params.rb +6 -3
  920. data/lib/openai/models/skills/version_retrieve_params.rb +2 -1
  921. data/lib/openai/models/skills/versions/content_retrieve_params.rb +2 -1
  922. data/lib/openai/models/static_file_chunking_strategy.rb +6 -4
  923. data/lib/openai/models/static_file_chunking_strategy_object.rb +2 -1
  924. data/lib/openai/models/static_file_chunking_strategy_object_param.rb +2 -1
  925. data/lib/openai/models/upload.rb +21 -13
  926. data/lib/openai/models/upload_complete_params.rb +5 -5
  927. data/lib/openai/models/upload_create_params.rb +23 -13
  928. data/lib/openai/models/uploads/part_create_params.rb +6 -4
  929. data/lib/openai/models/uploads/upload_part.rb +8 -4
  930. data/lib/openai/models/vector_store.rb +42 -23
  931. data/lib/openai/models/vector_store_create_params.rb +28 -16
  932. data/lib/openai/models/vector_store_list_params.rb +16 -7
  933. data/lib/openai/models/vector_store_search_params.rb +13 -9
  934. data/lib/openai/models/vector_store_search_response.rb +18 -11
  935. data/lib/openai/models/vector_store_update_params.rb +16 -11
  936. data/lib/openai/models/vector_stores/file_batch_create_params.rb +47 -23
  937. data/lib/openai/models/vector_stores/file_batch_list_files_params.rb +18 -8
  938. data/lib/openai/models/vector_stores/file_content_response.rb +4 -2
  939. data/lib/openai/models/vector_stores/file_create_params.rb +18 -9
  940. data/lib/openai/models/vector_stores/file_list_params.rb +18 -8
  941. data/lib/openai/models/vector_stores/file_update_params.rb +6 -4
  942. data/lib/openai/models/vector_stores/vector_store_file.rb +35 -16
  943. data/lib/openai/models/vector_stores/vector_store_file_batch.rb +27 -15
  944. data/lib/openai/models/video.rb +27 -16
  945. data/lib/openai/models/video_create_character_params.rb +8 -2
  946. data/lib/openai/models/video_create_character_response.rb +6 -3
  947. data/lib/openai/models/video_create_error.rb +12 -6
  948. data/lib/openai/models/video_create_params.rb +15 -7
  949. data/lib/openai/models/video_delete_response.rb +6 -3
  950. data/lib/openai/models/video_download_content_params.rb +2 -1
  951. data/lib/openai/models/video_edit_params.rb +10 -3
  952. data/lib/openai/models/video_extend_params.rb +12 -6
  953. data/lib/openai/models/video_get_character_response.rb +6 -3
  954. data/lib/openai/models/video_list_params.rb +7 -6
  955. data/lib/openai/models/video_remix_params.rb +2 -1
  956. data/lib/openai/models/webhooks/batch_cancelled_webhook_event.rb +12 -12
  957. data/lib/openai/models/webhooks/batch_completed_webhook_event.rb +12 -12
  958. data/lib/openai/models/webhooks/batch_expired_webhook_event.rb +12 -12
  959. data/lib/openai/models/webhooks/batch_failed_webhook_event.rb +12 -12
  960. data/lib/openai/models/webhooks/eval_run_canceled_webhook_event.rb +12 -12
  961. data/lib/openai/models/webhooks/eval_run_failed_webhook_event.rb +12 -12
  962. data/lib/openai/models/webhooks/eval_run_succeeded_webhook_event.rb +12 -12
  963. data/lib/openai/models/webhooks/fine_tuning_job_cancelled_webhook_event.rb +12 -13
  964. data/lib/openai/models/webhooks/fine_tuning_job_failed_webhook_event.rb +12 -13
  965. data/lib/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rb +12 -13
  966. data/lib/openai/models/webhooks/live_call_incoming_webhook_event.rb +34 -26
  967. data/lib/openai/models/webhooks/live_transport_incoming_webhook_event.rb +137 -0
  968. data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +29 -25
  969. data/lib/openai/models/webhooks/response_cancelled_webhook_event.rb +12 -13
  970. data/lib/openai/models/webhooks/response_completed_webhook_event.rb +12 -13
  971. data/lib/openai/models/webhooks/response_failed_webhook_event.rb +12 -12
  972. data/lib/openai/models/webhooks/response_incomplete_webhook_event.rb +12 -13
  973. data/lib/openai/models/webhooks/safety_alert_created_webhook_event.rb +10 -5
  974. data/lib/openai/models/webhooks/safety_org_alert_created_webhook_event.rb +10 -5
  975. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +9 -2
  976. data/lib/openai/models.rb +2 -0
  977. data/lib/openai/resources/admin/organization/admin_api_keys.rb +13 -9
  978. data/lib/openai/resources/admin/organization/audit_logs.rb +44 -22
  979. data/lib/openai/resources/admin/organization/certificates.rb +26 -17
  980. data/lib/openai/resources/admin/organization/data_retention.rb +2 -1
  981. data/lib/openai/resources/admin/organization/groups/roles.rb +21 -13
  982. data/lib/openai/resources/admin/organization/groups/users.rb +22 -13
  983. data/lib/openai/resources/admin/organization/groups.rb +20 -11
  984. data/lib/openai/resources/admin/organization/invites.rb +21 -13
  985. data/lib/openai/resources/admin/organization/projects/api_keys.rb +24 -12
  986. data/lib/openai/resources/admin/organization/projects/certificates.rb +17 -10
  987. data/lib/openai/resources/admin/organization/projects/data_retention.rb +6 -3
  988. data/lib/openai/resources/admin/organization/projects/groups/roles.rb +29 -18
  989. data/lib/openai/resources/admin/organization/projects/groups.rb +25 -16
  990. data/lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb +14 -7
  991. data/lib/openai/resources/admin/organization/projects/model_permissions.rb +10 -5
  992. data/lib/openai/resources/admin/organization/projects/rate_limits.rb +32 -20
  993. data/lib/openai/resources/admin/organization/projects/roles.rb +35 -21
  994. data/lib/openai/resources/admin/organization/projects/service_accounts/api_keys.rb +10 -5
  995. data/lib/openai/resources/admin/organization/projects/service_accounts.rb +40 -19
  996. data/lib/openai/resources/admin/organization/projects/spend_alerts.rb +42 -24
  997. data/lib/openai/resources/admin/organization/projects/spend_limit.rb +13 -10
  998. data/lib/openai/resources/admin/organization/projects/users/roles.rb +29 -18
  999. data/lib/openai/resources/admin/organization/projects/users.rb +32 -18
  1000. data/lib/openai/resources/admin/organization/projects.rb +40 -22
  1001. data/lib/openai/resources/admin/organization/roles.rb +25 -15
  1002. data/lib/openai/resources/admin/organization/spend_alerts.rb +32 -18
  1003. data/lib/openai/resources/admin/organization/spend_limit.rb +7 -6
  1004. data/lib/openai/resources/admin/organization/usage.rb +296 -145
  1005. data/lib/openai/resources/admin/organization/users/roles.rb +21 -13
  1006. data/lib/openai/resources/admin/organization/users.rb +24 -13
  1007. data/lib/openai/resources/audio/speech.rb +25 -10
  1008. data/lib/openai/resources/audio/transcriptions.rb +172 -56
  1009. data/lib/openai/resources/audio/translations.rb +26 -8
  1010. data/lib/openai/resources/batches.rb +43 -15
  1011. data/lib/openai/resources/beta/assistants.rb +177 -59
  1012. data/lib/openai/resources/beta/chatkit/sessions.rb +14 -9
  1013. data/lib/openai/resources/beta/chatkit/threads.rb +29 -18
  1014. data/lib/openai/resources/beta/responses/input_items.rb +17 -9
  1015. data/lib/openai/resources/beta/responses/input_tokens.rb +65 -28
  1016. data/lib/openai/resources/beta/responses.rb +640 -195
  1017. data/lib/openai/resources/beta/threads/messages.rb +65 -30
  1018. data/lib/openai/resources/beta/threads/runs/steps.rb +50 -23
  1019. data/lib/openai/resources/beta/threads/runs.rb +309 -109
  1020. data/lib/openai/resources/beta/threads.rb +240 -78
  1021. data/lib/openai/resources/chat/completions/messages.rb +9 -7
  1022. data/lib/openai/resources/chat/completions.rb +594 -169
  1023. data/lib/openai/resources/completions.rb +212 -40
  1024. data/lib/openai/resources/containers/files.rb +19 -11
  1025. data/lib/openai/resources/containers.rb +27 -14
  1026. data/lib/openai/resources/content_provenance_checks.rb +7 -2
  1027. data/lib/openai/resources/conversations/items.rb +58 -26
  1028. data/lib/openai/resources/conversations.rb +23 -12
  1029. data/lib/openai/resources/embeddings.rb +26 -8
  1030. data/lib/openai/resources/evals/runs/output_items.rb +21 -12
  1031. data/lib/openai/resources/evals/runs.rb +37 -21
  1032. data/lib/openai/resources/evals.rb +43 -23
  1033. data/lib/openai/resources/files.rb +42 -21
  1034. data/lib/openai/resources/fine_tuning/alpha/graders.rb +15 -7
  1035. data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb +36 -34
  1036. data/lib/openai/resources/fine_tuning/jobs/checkpoints.rb +6 -6
  1037. data/lib/openai/resources/fine_tuning/jobs.rb +84 -42
  1038. data/lib/openai/resources/images.rb +421 -127
  1039. data/lib/openai/resources/live/forks.rb +16 -0
  1040. data/lib/openai/resources/live/sessions.rb +180 -0
  1041. data/lib/openai/resources/live/sideband.rb +16 -0
  1042. data/lib/openai/resources/live.rb +54 -0
  1043. data/lib/openai/resources/models.rb +4 -2
  1044. data/lib/openai/resources/moderations.rb +10 -6
  1045. data/lib/openai/resources/realtime/calls.rb +114 -48
  1046. data/lib/openai/resources/realtime/client_secrets.rb +9 -6
  1047. data/lib/openai/resources/responses/input_items.rb +15 -8
  1048. data/lib/openai/resources/responses/input_tokens.rb +60 -26
  1049. data/lib/openai/resources/responses.rb +601 -262
  1050. data/lib/openai/resources/safety/alerts.rb +2 -1
  1051. data/lib/openai/resources/skills/content.rb +2 -1
  1052. data/lib/openai/resources/skills/versions/content.rb +4 -2
  1053. data/lib/openai/resources/skills/versions.rb +26 -11
  1054. data/lib/openai/resources/skills.rb +21 -11
  1055. data/lib/openai/resources/uploads/parts.rb +13 -9
  1056. data/lib/openai/resources/uploads.rb +35 -27
  1057. data/lib/openai/resources/vector_stores/file_batches.rb +60 -26
  1058. data/lib/openai/resources/vector_stores/files.rb +62 -31
  1059. data/lib/openai/resources/vector_stores.rb +67 -34
  1060. data/lib/openai/resources/videos.rb +64 -31
  1061. data/lib/openai/resources/webhooks.rb +1 -1
  1062. data/lib/openai/version.rb +1 -1
  1063. data/lib/openai.rb +65 -0
  1064. data/rbi/openai/client.rbi +3 -0
  1065. data/rbi/openai/models/admin/organization/audit_log_list_params.rbi +2 -2
  1066. data/rbi/openai/models/admin/organization/project_create_params.rbi +4 -4
  1067. data/rbi/openai/models/admin/organization/projects/project_api_key.rbi +13 -1
  1068. data/rbi/openai/models/admin/organization/projects/service_account_create_params.rbi +18 -0
  1069. data/rbi/openai/models/admin/organization/projects/service_account_create_response.rbi +19 -1
  1070. data/rbi/openai/models/audio/speech_create_params.rbi +9 -6
  1071. data/rbi/openai/models/audio/transcription_create_params.rbi +2 -2
  1072. data/rbi/openai/models/audio/transcription_stream_event.rbi +1 -1
  1073. data/rbi/openai/models/audio/transcription_text_delta_event.rbi +3 -3
  1074. data/rbi/openai/models/audio/transcription_text_done_event.rbi +3 -3
  1075. data/rbi/openai/models/audio/transcription_text_segment_event.rbi +1 -1
  1076. data/rbi/openai/models/audio/translation_create_params.rbi +2 -2
  1077. data/rbi/openai/models/batch.rbi +4 -4
  1078. data/rbi/openai/models/batch_create_params.rbi +6 -4
  1079. data/rbi/openai/models/batch_usage.rbi +2 -2
  1080. data/rbi/openai/models/beta/assistant.rbi +24 -24
  1081. data/rbi/openai/models/beta/assistant_create_params.rbi +40 -40
  1082. data/rbi/openai/models/beta/assistant_response_format_option.rbi +4 -4
  1083. data/rbi/openai/models/beta/assistant_stream_event.rbi +63 -65
  1084. data/rbi/openai/models/beta/assistant_update_params.rbi +30 -30
  1085. data/rbi/openai/models/beta/beta_computer_tool.rbi +1 -1
  1086. data/rbi/openai/models/beta/beta_computer_use_preview_tool.rbi +1 -1
  1087. data/rbi/openai/models/beta/beta_custom_tool.rbi +1 -1
  1088. data/rbi/openai/models/beta/beta_file_search_tool.rbi +1 -1
  1089. data/rbi/openai/models/beta/beta_function_tool.rbi +1 -1
  1090. data/rbi/openai/models/beta/beta_response.rbi +72 -64
  1091. data/rbi/openai/models/beta/beta_response_compaction_item.rbi +1 -1
  1092. data/rbi/openai/models/beta/beta_response_compaction_item_param.rbi +1 -1
  1093. data/rbi/openai/models/beta/beta_response_computer_tool_call.rbi +1 -1
  1094. data/rbi/openai/models/beta/beta_response_file_search_tool_call.rbi +1 -1
  1095. data/rbi/openai/models/beta/beta_response_format_text_config.rbi +1 -1
  1096. data/rbi/openai/models/beta/beta_response_format_text_json_schema_config.rbi +3 -3
  1097. data/rbi/openai/models/beta/beta_response_function_tool_call.rbi +1 -1
  1098. data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi +1 -1
  1099. data/rbi/openai/models/beta/beta_response_function_web_search.rbi +2 -2
  1100. data/rbi/openai/models/beta/beta_response_input_image.rbi +1 -1
  1101. data/rbi/openai/models/beta/beta_response_input_image_content.rbi +1 -1
  1102. data/rbi/openai/models/beta/beta_response_input_item.rbi +109 -0
  1103. data/rbi/openai/models/beta/beta_response_item.rbi +105 -0
  1104. data/rbi/openai/models/beta/beta_response_output_item.rbi +119 -0
  1105. data/rbi/openai/models/beta/beta_response_prompt.rbi +1 -1
  1106. data/rbi/openai/models/beta/beta_response_reasoning_item.rbi +1 -1
  1107. data/rbi/openai/models/beta/beta_response_text_config.rbi +4 -4
  1108. data/rbi/openai/models/beta/beta_response_usage.rbi +2 -2
  1109. data/rbi/openai/models/beta/beta_responses_client_event.rbi +94 -86
  1110. data/rbi/openai/models/beta/beta_tool.rbi +4 -4
  1111. data/rbi/openai/models/beta/beta_tool_choice_types.rbi +4 -4
  1112. data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +1 -1
  1113. data/rbi/openai/models/beta/beta_web_search_tool.rbi +1 -1
  1114. data/rbi/openai/models/beta/file_search_tool.rbi +5 -5
  1115. data/rbi/openai/models/beta/message_stream_event.rbi +16 -16
  1116. data/rbi/openai/models/beta/response_compact_params.rbi +44 -44
  1117. data/rbi/openai/models/beta/response_create_params.rbi +92 -84
  1118. data/rbi/openai/models/beta/responses/input_token_count_params.rbi +20 -20
  1119. data/rbi/openai/models/beta/run_step_stream_event.rbi +14 -16
  1120. data/rbi/openai/models/beta/run_stream_event.rbi +31 -31
  1121. data/rbi/openai/models/beta/thread.rbi +9 -9
  1122. data/rbi/openai/models/beta/thread_create_and_run_params.rbi +61 -56
  1123. data/rbi/openai/models/beta/thread_create_params.rbi +24 -22
  1124. data/rbi/openai/models/beta/thread_stream_event.rbi +3 -3
  1125. data/rbi/openai/models/beta/thread_update_params.rbi +8 -8
  1126. data/rbi/openai/models/beta/threads/image_file.rbi +6 -6
  1127. data/rbi/openai/models/beta/threads/image_file_content_block.rbi +3 -2
  1128. data/rbi/openai/models/beta/threads/image_file_delta.rbi +6 -6
  1129. data/rbi/openai/models/beta/threads/image_file_delta_block.rbi +3 -2
  1130. data/rbi/openai/models/beta/threads/message.rbi +9 -9
  1131. data/rbi/openai/models/beta/threads/message_content.rbi +3 -2
  1132. data/rbi/openai/models/beta/threads/message_content_delta.rbi +3 -2
  1133. data/rbi/openai/models/beta/threads/message_content_part_param.rbi +3 -2
  1134. data/rbi/openai/models/beta/threads/required_action_function_tool_call.rbi +2 -2
  1135. data/rbi/openai/models/beta/threads/run.rbi +33 -31
  1136. data/rbi/openai/models/beta/threads/run_create_params.rbi +37 -34
  1137. data/rbi/openai/models/beta/threads/runs/code_interpreter_output_image.rbi +4 -4
  1138. data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call.rbi +4 -4
  1139. data/rbi/openai/models/beta/threads/runs/function_tool_call.rbi +2 -4
  1140. data/rbi/openai/models/beta/threads/runs/function_tool_call_delta.rbi +2 -4
  1141. data/rbi/openai/models/beta/threads/runs/run_step.rbi +12 -10
  1142. data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +2 -2
  1143. data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +2 -2
  1144. data/rbi/openai/models/chat/chat_completion.rbi +27 -21
  1145. data/rbi/openai/models/chat/chat_completion_assistant_message_param.rbi +4 -5
  1146. data/rbi/openai/models/chat/chat_completion_audio.rbi +1 -1
  1147. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +1 -1
  1148. data/rbi/openai/models/chat/chat_completion_chunk.rbi +28 -22
  1149. data/rbi/openai/models/chat/chat_completion_content_part.rbi +3 -4
  1150. data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +5 -4
  1151. data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +1 -1
  1152. data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +1 -2
  1153. data/rbi/openai/models/chat/chat_completion_message.rbi +4 -4
  1154. data/rbi/openai/models/chat/chat_completion_store_message.rbi +3 -4
  1155. data/rbi/openai/models/chat/completion_create_params.rbi +95 -85
  1156. data/rbi/openai/models/completion_create_params.rbi +34 -32
  1157. data/rbi/openai/models/conversations/conversation_item.rbi +134 -1
  1158. data/rbi/openai/models/conversations/item_create_params.rbi +2 -2
  1159. data/rbi/openai/models/conversations/item_retrieve_params.rbi +2 -2
  1160. data/rbi/openai/models/embedding.rbi +2 -2
  1161. data/rbi/openai/models/embedding_create_params.rbi +14 -14
  1162. data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +5 -5
  1163. data/rbi/openai/models/evals/run_cancel_response.rbi +22 -20
  1164. data/rbi/openai/models/evals/run_create_params.rbi +22 -20
  1165. data/rbi/openai/models/evals/run_create_response.rbi +22 -20
  1166. data/rbi/openai/models/evals/run_list_response.rbi +22 -20
  1167. data/rbi/openai/models/evals/run_retrieve_response.rbi +22 -20
  1168. data/rbi/openai/models/fine_tuning/alpha/grader_run_params.rbi +10 -8
  1169. data/rbi/openai/models/fine_tuning/fine_tuning_job.rbi +6 -6
  1170. data/rbi/openai/models/fine_tuning/job_create_params.rbi +17 -15
  1171. data/rbi/openai/models/function_definition.rbi +6 -6
  1172. data/rbi/openai/models/graders/score_model_grader.rbi +2 -2
  1173. data/rbi/openai/models/image_create_variation_params.rbi +2 -2
  1174. data/rbi/openai/models/image_edit_params.rbi +2 -2
  1175. data/rbi/openai/models/image_generate_params.rbi +2 -2
  1176. data/rbi/openai/models/live/audio_format.rbi +185 -0
  1177. data/rbi/openai/models/live/built_in_voice.rbi +46 -0
  1178. data/rbi/openai/models/live/client_config.rbi +54 -0
  1179. data/rbi/openai/models/live/client_delegation.rbi +51 -0
  1180. data/rbi/openai/models/live/client_event.rbi +41 -0
  1181. data/rbi/openai/models/live/commentary_append_event.rbi +88 -0
  1182. data/rbi/openai/models/live/commentary_appended_event.rbi +97 -0
  1183. data/rbi/openai/models/live/custom_voice.rbi +46 -0
  1184. data/rbi/openai/models/live/data_channel_config.rbi +119 -0
  1185. data/rbi/openai/models/live/delegation_created_event.rbi +207 -0
  1186. data/rbi/openai/models/live/error.rbi +95 -0
  1187. data/rbi/openai/models/live/error_event.rbi +87 -0
  1188. data/rbi/openai/models/live/fork_client_event.rbi +40 -0
  1189. data/rbi/openai/models/live/fork_server_event.rbi +436 -0
  1190. data/rbi/openai/models/live/fork_session_config.rbi +234 -0
  1191. data/rbi/openai/models/live/fork_session_start_event.rbi +80 -0
  1192. data/rbi/openai/models/live/function_tool.rbi +95 -0
  1193. data/rbi/openai/models/live/info_event.rbi +92 -0
  1194. data/rbi/openai/models/live/initial_item.rbi +661 -0
  1195. data/rbi/openai/models/live/input_audio_append_event.rbi +79 -0
  1196. data/rbi/openai/models/live/input_audio_mute_event.rbi +62 -0
  1197. data/rbi/openai/models/live/input_audio_muted_event.rbi +74 -0
  1198. data/rbi/openai/models/live/input_audio_unmute_event.rbi +62 -0
  1199. data/rbi/openai/models/live/input_audio_unmuted_event.rbi +74 -0
  1200. data/rbi/openai/models/live/input_transcript_delta_event.rbi +115 -0
  1201. data/rbi/openai/models/live/instructions_append_event.rbi +86 -0
  1202. data/rbi/openai/models/live/instructions_appended_event.rbi +97 -0
  1203. data/rbi/openai/models/live/live_create_params.rbi +121 -0
  1204. data/rbi/openai/models/live/live_create_response.rbi +160 -0
  1205. data/rbi/openai/models/live/media_session_config.rbi +390 -0
  1206. data/rbi/openai/models/live/media_session_fork_config.rbi +143 -0
  1207. data/rbi/openai/models/live/output_audio_delta_event.rbi +93 -0
  1208. data/rbi/openai/models/live/output_transcript_delta_event.rbi +115 -0
  1209. data/rbi/openai/models/live/response_create_event.rbi +62 -0
  1210. data/rbi/openai/models/live/response_event.rbi +105 -0
  1211. data/rbi/openai/models/live/response_item_create_event.rbi +183 -0
  1212. data/rbi/openai/models/live/responses_delegation_config.rbi +562 -0
  1213. data/rbi/openai/models/live/responses_delegation_update_config.rbi +585 -0
  1214. data/rbi/openai/models/live/server_event.rbi +436 -0
  1215. data/rbi/openai/models/live/server_event_selector.rbi +64 -0
  1216. data/rbi/openai/models/live/session_accept_params.rbi +451 -0
  1217. data/rbi/openai/models/live/session_close_event.rbi +62 -0
  1218. data/rbi/openai/models/live/session_closed_event.rbi +148 -0
  1219. data/rbi/openai/models/live/session_config.rbi +427 -0
  1220. data/rbi/openai/models/live/session_download_recording_params.rbi +57 -0
  1221. data/rbi/openai/models/live/session_fork_params.rbi +131 -0
  1222. data/rbi/openai/models/live/session_fork_response.rbi +160 -0
  1223. data/rbi/openai/models/live/session_hangup_params.rbi +53 -0
  1224. data/rbi/openai/models/live/session_refer_params.rbi +64 -0
  1225. data/rbi/openai/models/live/session_reject_params.rbi +62 -0
  1226. data/rbi/openai/models/live/session_resource.rbi +461 -0
  1227. data/rbi/openai/models/live/session_start_event.rbi +78 -0
  1228. data/rbi/openai/models/live/session_started_event.rbi +86 -0
  1229. data/rbi/openai/models/live/session_update_config.rbi +134 -0
  1230. data/rbi/openai/models/live/session_update_event.rbi +78 -0
  1231. data/rbi/openai/models/live/session_updated_event.rbi +86 -0
  1232. data/rbi/openai/models/live/session_usage.rbi +53 -0
  1233. data/rbi/openai/models/live/session_usage_updated_event.rbi +148 -0
  1234. data/rbi/openai/models/live/thinking_append_event.rbi +88 -0
  1235. data/rbi/openai/models/live/thinking_appended_event.rbi +97 -0
  1236. data/rbi/openai/models/moderation_create_params.rbi +9 -9
  1237. data/rbi/openai/models/realtime/audio_transcription.rbi +2 -2
  1238. data/rbi/openai/models/realtime/call_accept_params.rbi +1 -1
  1239. data/rbi/openai/models/realtime/output_audio_buffer_clear_event.rbi +1 -1
  1240. data/rbi/openai/models/realtime/realtime_audio_config_input.rbi +2 -2
  1241. data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +4 -4
  1242. data/rbi/openai/models/realtime/realtime_response_create_params.rbi +3 -3
  1243. data/rbi/openai/models/realtime/realtime_server_event.rbi +3 -3
  1244. data/rbi/openai/models/realtime/realtime_session.rbi +4 -4
  1245. data/rbi/openai/models/realtime/realtime_session_create_request.rbi +2 -2
  1246. data/rbi/openai/models/realtime/realtime_session_create_response.rbi +7 -7
  1247. data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +5 -5
  1248. data/rbi/openai/models/realtime/realtime_transcription_session_audio_input.rbi +2 -2
  1249. data/rbi/openai/models/reasoning.rbi +3 -3
  1250. data/rbi/openai/models/reasoning_effort.rbi +1 -1
  1251. data/rbi/openai/models/response_format_json_schema.rbi +3 -3
  1252. data/rbi/openai/models/response_format_text_grammar.rbi +1 -1
  1253. data/rbi/openai/models/response_format_text_python.rbi +1 -1
  1254. data/rbi/openai/models/responses/computer_tool.rbi +1 -1
  1255. data/rbi/openai/models/responses/computer_use_preview_tool.rbi +1 -1
  1256. data/rbi/openai/models/responses/custom_tool.rbi +1 -1
  1257. data/rbi/openai/models/responses/file_search_tool.rbi +1 -1
  1258. data/rbi/openai/models/responses/function_tool.rbi +1 -1
  1259. data/rbi/openai/models/responses/input_token_count_params.rbi +16 -16
  1260. data/rbi/openai/models/responses/response.rbi +66 -58
  1261. data/rbi/openai/models/responses/response_compact_params.rbi +44 -44
  1262. data/rbi/openai/models/responses/response_compaction_item.rbi +1 -1
  1263. data/rbi/openai/models/responses/response_compaction_item_param.rbi +1 -1
  1264. data/rbi/openai/models/responses/response_computer_tool_call.rbi +1 -1
  1265. data/rbi/openai/models/responses/response_create_params.rbi +86 -78
  1266. data/rbi/openai/models/responses/response_file_search_tool_call.rbi +1 -1
  1267. data/rbi/openai/models/responses/response_format_text_config.rbi +1 -1
  1268. data/rbi/openai/models/responses/response_format_text_json_schema_config.rbi +3 -3
  1269. data/rbi/openai/models/responses/response_function_tool_call.rbi +1 -1
  1270. data/rbi/openai/models/responses/response_function_tool_call_item.rbi +1 -1
  1271. data/rbi/openai/models/responses/response_function_web_search.rbi +2 -2
  1272. data/rbi/openai/models/responses/response_input_image.rbi +1 -1
  1273. data/rbi/openai/models/responses/response_input_image_content.rbi +1 -1
  1274. data/rbi/openai/models/responses/response_input_item.rbi +113 -0
  1275. data/rbi/openai/models/responses/response_item.rbi +105 -0
  1276. data/rbi/openai/models/responses/response_output_item.rbi +125 -0
  1277. data/rbi/openai/models/responses/response_prompt.rbi +1 -1
  1278. data/rbi/openai/models/responses/response_reasoning_item.rbi +1 -1
  1279. data/rbi/openai/models/responses/response_text_config.rbi +4 -4
  1280. data/rbi/openai/models/responses/response_usage.rbi +2 -2
  1281. data/rbi/openai/models/responses/responses_client_event.rbi +88 -80
  1282. data/rbi/openai/models/responses/tool.rbi +4 -4
  1283. data/rbi/openai/models/responses/tool_choice_types.rbi +4 -4
  1284. data/rbi/openai/models/responses/web_search_preview_tool.rbi +1 -1
  1285. data/rbi/openai/models/responses/web_search_tool.rbi +1 -1
  1286. data/rbi/openai/models/upload.rbi +2 -2
  1287. data/rbi/openai/models/upload_create_params.rbi +2 -2
  1288. data/rbi/openai/models/vector_store_create_params.rbi +6 -6
  1289. data/rbi/openai/models/vector_stores/file_batch_create_params.rbi +18 -18
  1290. data/rbi/openai/models/vector_stores/file_create_params.rbi +6 -6
  1291. data/rbi/openai/models/vector_stores/vector_store_file.rbi +4 -4
  1292. data/rbi/openai/models/vector_stores/vector_store_file_batch.rbi +4 -4
  1293. data/rbi/openai/models/webhooks/live_call_incoming_webhook_event.rbi +17 -9
  1294. data/rbi/openai/models/webhooks/live_transport_incoming_webhook_event.rbi +226 -0
  1295. data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +10 -6
  1296. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +1 -0
  1297. data/rbi/openai/models.rbi +2 -0
  1298. data/rbi/openai/resources/admin/organization/audit_logs.rbi +1 -1
  1299. data/rbi/openai/resources/admin/organization/projects/service_accounts.rbi +7 -0
  1300. data/rbi/openai/resources/admin/organization/projects.rbi +2 -2
  1301. data/rbi/openai/resources/audio/speech.rbi +3 -2
  1302. data/rbi/openai/resources/audio/transcriptions.rbi +2 -2
  1303. data/rbi/openai/resources/audio/translations.rbi +1 -1
  1304. data/rbi/openai/resources/batches.rbi +3 -2
  1305. data/rbi/openai/resources/beta/assistants.rbi +18 -18
  1306. data/rbi/openai/resources/beta/responses/input_tokens.rbi +6 -6
  1307. data/rbi/openai/resources/beta/responses.rbi +108 -102
  1308. data/rbi/openai/resources/beta/threads/messages.rbi +9 -6
  1309. data/rbi/openai/resources/beta/threads/runs/steps.rbi +2 -2
  1310. data/rbi/openai/resources/beta/threads/runs.rbi +37 -33
  1311. data/rbi/openai/resources/beta/threads.rbi +27 -24
  1312. data/rbi/openai/resources/chat/completions.rbi +90 -82
  1313. data/rbi/openai/resources/completions.rbi +30 -28
  1314. data/rbi/openai/resources/content_provenance_checks.rbi +1 -1
  1315. data/rbi/openai/resources/conversations/items.rbi +2 -2
  1316. data/rbi/openai/resources/embeddings.rbi +5 -5
  1317. data/rbi/openai/resources/evals.rbi +1 -1
  1318. data/rbi/openai/resources/files.rbi +5 -5
  1319. data/rbi/openai/resources/fine_tuning/alpha/graders.rbi +5 -4
  1320. data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi +8 -4
  1321. data/rbi/openai/resources/fine_tuning/jobs.rbi +10 -9
  1322. data/rbi/openai/resources/images.rbi +7 -7
  1323. data/rbi/openai/resources/live/forks.rbi +19 -0
  1324. data/rbi/openai/resources/live/sessions.rbi +110 -0
  1325. data/rbi/openai/resources/live/sideband.rbi +19 -0
  1326. data/rbi/openai/resources/live.rbi +43 -0
  1327. data/rbi/openai/resources/moderations.rbi +5 -4
  1328. data/rbi/openai/resources/realtime/calls.rbi +6 -6
  1329. data/rbi/openai/resources/realtime/client_secrets.rbi +1 -1
  1330. data/rbi/openai/resources/responses/input_tokens.rbi +6 -6
  1331. data/rbi/openai/resources/responses.rbi +183 -140
  1332. data/rbi/openai/resources/uploads/parts.rbi +5 -4
  1333. data/rbi/openai/resources/uploads.rbi +10 -10
  1334. data/rbi/openai/resources/vector_stores/file_batches.rbi +6 -6
  1335. data/rbi/openai/resources/vector_stores/files.rbi +6 -6
  1336. data/rbi/openai/resources/vector_stores.rbi +3 -3
  1337. data/rbi/openai/resources/webhooks.rbi +1 -0
  1338. data/sig/openai/client.rbs +2 -0
  1339. data/sig/openai/models/admin/organization/projects/project_api_key.rbs +7 -2
  1340. data/sig/openai/models/admin/organization/projects/service_account_create_params.rbs +5 -0
  1341. data/sig/openai/models/admin/organization/projects/service_account_create_response.rbs +7 -2
  1342. data/sig/openai/models/beta/beta_response_input_item.rbs +56 -0
  1343. data/sig/openai/models/beta/beta_response_item.rbs +56 -0
  1344. data/sig/openai/models/beta/beta_response_output_item.rbs +56 -0
  1345. data/sig/openai/models/conversations/conversation_item.rbs +56 -0
  1346. data/sig/openai/models/live/audio_format.rbs +73 -0
  1347. data/sig/openai/models/live/built_in_voice.rbs +58 -0
  1348. data/sig/openai/models/live/client_config.rbs +15 -0
  1349. data/sig/openai/models/live/client_delegation.rbs +15 -0
  1350. data/sig/openai/models/live/client_event.rbs +24 -0
  1351. data/sig/openai/models/live/commentary_append_event.rbs +37 -0
  1352. data/sig/openai/models/live/commentary_appended_event.rbs +44 -0
  1353. data/sig/openai/models/live/custom_voice.rbs +15 -0
  1354. data/sig/openai/models/live/data_channel_config.rbs +56 -0
  1355. data/sig/openai/models/live/delegation_created_event.rbs +89 -0
  1356. data/sig/openai/models/live/error.rbs +46 -0
  1357. data/sig/openai/models/live/error_event.rbs +39 -0
  1358. data/sig/openai/models/live/fork_client_event.rbs +24 -0
  1359. data/sig/openai/models/live/fork_server_event.rbs +212 -0
  1360. data/sig/openai/models/live/fork_session_config.rbs +89 -0
  1361. data/sig/openai/models/live/fork_session_start_event.rbs +32 -0
  1362. data/sig/openai/models/live/function_tool.rbs +42 -0
  1363. data/sig/openai/models/live/info_event.rbs +44 -0
  1364. data/sig/openai/models/live/initial_item.rbs +332 -0
  1365. data/sig/openai/models/live/input_audio_append_event.rbs +32 -0
  1366. data/sig/openai/models/live/input_audio_mute_event.rbs +24 -0
  1367. data/sig/openai/models/live/input_audio_muted_event.rbs +34 -0
  1368. data/sig/openai/models/live/input_audio_unmute_event.rbs +24 -0
  1369. data/sig/openai/models/live/input_audio_unmuted_event.rbs +34 -0
  1370. data/sig/openai/models/live/input_transcript_delta_event.rbs +49 -0
  1371. data/sig/openai/models/live/instructions_append_event.rbs +37 -0
  1372. data/sig/openai/models/live/instructions_appended_event.rbs +44 -0
  1373. data/sig/openai/models/live/live_create_params.rbs +45 -0
  1374. data/sig/openai/models/live/live_create_response.rbs +49 -0
  1375. data/sig/openai/models/live/media_session_config.rbs +157 -0
  1376. data/sig/openai/models/live/media_session_fork_config.rbs +66 -0
  1377. data/sig/openai/models/live/output_audio_delta_event.rbs +41 -0
  1378. data/sig/openai/models/live/output_transcript_delta_event.rbs +49 -0
  1379. data/sig/openai/models/live/response_create_event.rbs +18 -0
  1380. data/sig/openai/models/live/response_event.rbs +44 -0
  1381. data/sig/openai/models/live/response_item_create_event.rbs +32 -0
  1382. data/sig/openai/models/live/responses_delegation_config.rbs +244 -0
  1383. data/sig/openai/models/live/responses_delegation_update_config.rbs +246 -0
  1384. data/sig/openai/models/live/server_event.rbs +212 -0
  1385. data/sig/openai/models/live/server_event_selector.rbs +19 -0
  1386. data/sig/openai/models/live/session_accept_params.rbs +185 -0
  1387. data/sig/openai/models/live/session_close_event.rbs +17 -0
  1388. data/sig/openai/models/live/session_closed_event.rbs +68 -0
  1389. data/sig/openai/models/live/session_config.rbs +168 -0
  1390. data/sig/openai/models/live/session_download_recording_params.rbs +25 -0
  1391. data/sig/openai/models/live/session_fork_params.rbs +54 -0
  1392. data/sig/openai/models/live/session_fork_response.rbs +49 -0
  1393. data/sig/openai/models/live/session_hangup_params.rbs +25 -0
  1394. data/sig/openai/models/live/session_refer_params.rbs +33 -0
  1395. data/sig/openai/models/live/session_reject_params.rbs +33 -0
  1396. data/sig/openai/models/live/session_resource.rbs +183 -0
  1397. data/sig/openai/models/live/session_start_event.rbs +32 -0
  1398. data/sig/openai/models/live/session_started_event.rbs +39 -0
  1399. data/sig/openai/models/live/session_update_config.rbs +56 -0
  1400. data/sig/openai/models/live/session_update_event.rbs +32 -0
  1401. data/sig/openai/models/live/session_updated_event.rbs +39 -0
  1402. data/sig/openai/models/live/session_usage.rbs +15 -0
  1403. data/sig/openai/models/live/session_usage_updated_event.rbs +58 -0
  1404. data/sig/openai/models/live/thinking_append_event.rbs +37 -0
  1405. data/sig/openai/models/live/thinking_appended_event.rbs +44 -0
  1406. data/sig/openai/models/responses/response_input_item.rbs +56 -0
  1407. data/sig/openai/models/responses/response_item.rbs +56 -0
  1408. data/sig/openai/models/responses/response_output_item.rbs +56 -0
  1409. data/sig/openai/models/webhooks/live_transport_incoming_webhook_event.rbs +95 -0
  1410. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
  1411. data/sig/openai/models.rbs +2 -0
  1412. data/sig/openai/resources/admin/organization/projects/service_accounts.rbs +1 -0
  1413. data/sig/openai/resources/live/forks.rbs +9 -0
  1414. data/sig/openai/resources/live/sessions.rbs +44 -0
  1415. data/sig/openai/resources/live/sideband.rbs +9 -0
  1416. data/sig/openai/resources/live.rbs +19 -0
  1417. data/sig/openai/resources/webhooks.rbs +1 -0
  1418. metadata +196 -1
@@ -29,22 +29,22 @@ module OpenAI
29
29
  variant :message, -> { OpenAI::Beta::BetaResponseOutputMessage }
30
30
 
31
31
  # The results of a file search tool call. See the
32
- # [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information.
32
+ # [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.
33
33
  variant :file_search_call, -> { OpenAI::Beta::BetaResponseFileSearchToolCall }
34
34
 
35
35
  # A tool call to a computer use tool. See the
36
- # [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information.
36
+ # [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.
37
37
  variant :computer_call, -> { OpenAI::Beta::BetaResponseComputerToolCall }
38
38
 
39
39
  # The output of a computer tool call.
40
40
  variant :computer_call_output, -> { OpenAI::Beta::BetaResponseInputItem::ComputerCallOutput }
41
41
 
42
42
  # The results of a web search tool call. See the
43
- # [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information.
43
+ # [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.
44
44
  variant :web_search_call, -> { OpenAI::Beta::BetaResponseFunctionWebSearch }
45
45
 
46
46
  # A tool call to run a function. See the
47
- # [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information.
47
+ # [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.
48
48
  variant :function_call, -> { OpenAI::Beta::BetaResponseFunctionToolCall }
49
49
 
50
50
  # The output of a function tool call.
@@ -71,10 +71,10 @@ module OpenAI
71
71
  # A description of the chain of thought used by a reasoning model while generating
72
72
  # a response. Be sure to include these items in your `input` to the Responses API
73
73
  # for subsequent turns of a conversation if you are manually
74
- # [managing context](https://platform.openai.com/docs/guides/conversation-state).
74
+ # [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
75
75
  variant :reasoning, -> { OpenAI::Beta::BetaResponseReasoningItem }
76
76
 
77
- # A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
77
+ # A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
78
78
  variant :compaction, -> { OpenAI::Beta::BetaResponseCompactionItemParam }
79
79
 
80
80
  # An image generation request made by the model.
@@ -163,22 +163,26 @@ module OpenAI
163
163
  optional :type, enum: -> { OpenAI::Beta::BetaResponseInputItem::Message::Type }
164
164
 
165
165
  # @!method initialize(content:, role:, agent: nil, status: nil, type: nil)
166
- # Some parameter documentations has been truncated, see
167
- # {OpenAI::Models::Beta::BetaResponseInputItem::Message} for more details.
168
- #
169
166
  # A message input to the model with a role indicating instruction following
170
167
  # hierarchy. Instructions given with the `developer` or `system` role take
171
168
  # precedence over instructions given with the `user` role.
172
169
  #
173
- # @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>] A list of one or many input items to the model, containing different content
170
+ # @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>]
171
+ # A list of one or many input items to the model, containing different content
172
+ # types.
174
173
  #
175
- # @param role [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Role] The role of the message input. One of `user`, `system`, or `developer`.
174
+ # @param role [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Role]
175
+ # The role of the message input. One of `user`, `system`, or `developer`.
176
176
  #
177
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Message::Agent, nil] The agent that produced this item.
177
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Message::Agent, nil]
178
+ # The agent that produced this item.
178
179
  #
179
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Status] The status of item. One of `in_progress`, `completed`, or
180
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Status]
181
+ # The status of item. One of `in_progress`, `completed`, or `incomplete`.
182
+ # Populated when items are returned via API.
180
183
  #
181
- # @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Type] The type of the message input. Always set to `message`.
184
+ # @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::Message::Type]
185
+ # The type of the message input. Always set to `message`.
182
186
 
183
187
  # The role of the message input. One of `user`, `system`, or `developer`.
184
188
  #
@@ -205,7 +209,8 @@ module OpenAI
205
209
  # @!method initialize(agent_name:)
206
210
  # The agent that produced this item.
207
211
  #
208
- # @param agent_name [String] The canonical name of the agent that produced this item.
212
+ # @param agent_name [String]
213
+ # The canonical name of the agent that produced this item.
209
214
  end
210
215
 
211
216
  # The status of item. One of `in_progress`, `completed`, or `incomplete`.
@@ -296,26 +301,30 @@ module OpenAI
296
301
  )
297
302
 
298
303
  # @!method initialize(call_id:, output:, id: nil, acknowledged_safety_checks: nil, agent: nil, status: nil, type: :computer_call_output)
299
- # Some parameter documentations has been truncated, see
300
- # {OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput} for more
301
- # details.
302
- #
303
304
  # The output of a computer tool call.
304
305
  #
305
- # @param call_id [String] The ID of the computer tool call that produced the output.
306
+ # @param call_id [String]
307
+ # The ID of the computer tool call that produced the output.
306
308
  #
307
- # @param output [OpenAI::Models::Beta::BetaResponseComputerToolCallOutputScreenshot] A computer screenshot image used with the computer use tool.
309
+ # @param output [OpenAI::Models::Beta::BetaResponseComputerToolCallOutputScreenshot]
310
+ # A computer screenshot image used with the computer use tool.
308
311
  #
309
- # @param id [String, nil] The ID of the computer tool call output.
312
+ # @param id [String, nil]
313
+ # The ID of the computer tool call output.
310
314
  #
311
- # @param acknowledged_safety_checks [Array<OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::AcknowledgedSafetyCheck>, nil] The safety checks reported by the API that have been acknowledged by the develop
315
+ # @param acknowledged_safety_checks [Array<OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::AcknowledgedSafetyCheck>, nil]
316
+ # The safety checks reported by the API that have been acknowledged by the
317
+ # developer.
312
318
  #
313
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Agent, nil] The agent that produced this item.
319
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Agent, nil]
320
+ # The agent that produced this item.
314
321
  #
315
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Status, nil] The status of the message input. One of `in_progress`, `completed`, or `incomple
322
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput::Status, nil]
323
+ # The status of the message input. One of `in_progress`, `completed`, or
324
+ # `incomplete`. Populated when input items are returned via API.
316
325
  #
317
- # @param type [Symbol, :computer_call_output] The type of the computer tool call output. Always `computer_call_output`.
318
-
326
+ # @param type [Symbol, :computer_call_output]
327
+ # The type of the computer tool call output. Always `computer_call_output`.
319
328
  class AcknowledgedSafetyCheck < OpenAI::Internal::Type::BaseModel
320
329
  # @!attribute id
321
330
  # The ID of the pending safety check.
@@ -338,11 +347,14 @@ module OpenAI
338
347
  # @!method initialize(id:, code: nil, message: nil)
339
348
  # A pending safety check for the computer call.
340
349
  #
341
- # @param id [String] The ID of the pending safety check.
350
+ # @param id [String]
351
+ # The ID of the pending safety check.
342
352
  #
343
- # @param code [String, nil] The type of the pending safety check.
353
+ # @param code [String, nil]
354
+ # The type of the pending safety check.
344
355
  #
345
- # @param message [String, nil] Details about the pending safety check.
356
+ # @param message [String, nil]
357
+ # Details about the pending safety check.
346
358
  end
347
359
 
348
360
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput#agent
@@ -356,7 +368,8 @@ module OpenAI
356
368
  # @!method initialize(agent_name:)
357
369
  # The agent that produced this item.
358
370
  #
359
- # @param agent_name [String] The canonical name of the agent that produced this item.
371
+ # @param agent_name [String]
372
+ # The canonical name of the agent that produced this item.
360
373
  end
361
374
 
362
375
  # The status of the message input. One of `in_progress`, `completed`, or
@@ -444,29 +457,36 @@ module OpenAI
444
457
  )
445
458
 
446
459
  # @!method initialize(output:, id: nil, agent: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
447
- # Some parameter documentations has been truncated, see
448
- # {OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput} for more
449
- # details.
450
- #
451
460
  # The output of a function tool call.
452
461
  #
453
- # @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>] Text, image, or file output of the function tool call.
462
+ # @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>]
463
+ # Text, image, or file output of the function tool call.
454
464
  #
455
- # @param id [String, nil] The unique ID of the function tool call output. Populated when this item is retu
465
+ # @param id [String, nil]
466
+ # The unique ID of the function tool call output. Populated when this item is
467
+ # returned via API.
456
468
  #
457
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Agent, nil] The agent that produced this item.
469
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Agent, nil]
470
+ # The agent that produced this item.
458
471
  #
459
- # @param call_id [String, nil] The unique ID of the function tool call generated by the model.
472
+ # @param call_id [String, nil]
473
+ # The unique ID of the function tool call generated by the model.
460
474
  #
461
- # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Program, nil] The execution context that produced this tool call.
475
+ # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Program, nil]
476
+ # The execution context that produced this tool call.
462
477
  #
463
- # @param name [String, nil] The name of the tool that produced the output.
478
+ # @param name [String, nil]
479
+ # The name of the tool that produced the output.
464
480
  #
465
- # @param namespace [String, nil] The namespace of the tool that produced the output.
481
+ # @param namespace [String, nil]
482
+ # The namespace of the tool that produced the output.
466
483
  #
467
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`. Popu
484
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Status, nil]
485
+ # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
486
+ # Populated when items are returned via API.
468
487
  #
469
- # @param type [Symbol, :function_call_output] The type of the function tool call output. Always `function_call_output`.
488
+ # @param type [Symbol, :function_call_output]
489
+ # The type of the function tool call output. Always `function_call_output`.
470
490
 
471
491
  # Text, image, or file output of the function tool call.
472
492
  #
@@ -495,7 +515,8 @@ module OpenAI
495
515
  # @!method initialize(agent_name:)
496
516
  # The agent that produced this item.
497
517
  #
498
- # @param agent_name [String] The canonical name of the agent that produced this item.
518
+ # @param agent_name [String]
519
+ # The canonical name of the agent that produced this item.
499
520
  end
500
521
 
501
522
  # The execution context that produced this tool call.
@@ -518,7 +539,8 @@ module OpenAI
518
539
  required :type, const: :direct
519
540
 
520
541
  # @!method initialize(type: :direct)
521
- # @param type [Symbol, :direct] The caller type. Always `direct`.
542
+ # @param type [Symbol, :direct]
543
+ # The caller type. Always `direct`.
522
544
  end
523
545
 
524
546
  class Program < OpenAI::Internal::Type::BaseModel
@@ -535,9 +557,11 @@ module OpenAI
535
557
  required :type, const: :program
536
558
 
537
559
  # @!method initialize(caller_id:, type: :program)
538
- # @param caller_id [String] The call ID of the program item that produced this tool call.
560
+ # @param caller_id [String]
561
+ # The call ID of the program item that produced this tool call.
539
562
  #
540
- # @param type [Symbol, :program] The caller type. Always `program`.
563
+ # @param type [Symbol, :program]
564
+ # The caller type. Always `program`.
541
565
  end
542
566
 
543
567
  # @!method self.variants
@@ -603,17 +627,23 @@ module OpenAI
603
627
  # @!method initialize(author:, content:, recipient:, id: nil, agent: nil, type: :agent_message)
604
628
  # A message routed between agents.
605
629
  #
606
- # @param author [String] The sending agent identity.
630
+ # @param author [String]
631
+ # The sending agent identity.
607
632
  #
608
- # @param content [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Content::EncryptedContent>] Plaintext, image, or encrypted content sent between agents.
633
+ # @param content [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Content::EncryptedContent>]
634
+ # Plaintext, image, or encrypted content sent between agents.
609
635
  #
610
- # @param recipient [String] The destination agent identity.
636
+ # @param recipient [String]
637
+ # The destination agent identity.
611
638
  #
612
- # @param id [String, nil] The unique ID of this agent message item.
639
+ # @param id [String, nil]
640
+ # The unique ID of this agent message item.
613
641
  #
614
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Agent, nil] The agent that produced this item.
642
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage::Agent, nil]
643
+ # The agent that produced this item.
615
644
  #
616
- # @param type [Symbol, :agent_message] The item type. Always `agent_message`.
645
+ # @param type [Symbol, :agent_message]
646
+ # The item type. Always `agent_message`.
617
647
 
618
648
  # A plaintext, image, or encrypted agent message content part.
619
649
  module Content
@@ -624,7 +654,7 @@ module OpenAI
624
654
  # A text input to the model.
625
655
  variant :input_text, -> { OpenAI::Beta::BetaResponseInputTextContent }
626
656
 
627
- # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision)
657
+ # An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
628
658
  variant :input_image, -> { OpenAI::Beta::BetaResponseInputImageContent }
629
659
 
630
660
  # Opaque encrypted content that Responses API decrypts inside trusted model execution.
@@ -650,9 +680,11 @@ module OpenAI
650
680
  # Opaque encrypted content that Responses API decrypts inside trusted model
651
681
  # execution.
652
682
  #
653
- # @param encrypted_content [String] Opaque encrypted content.
683
+ # @param encrypted_content [String]
684
+ # Opaque encrypted content.
654
685
  #
655
- # @param type [Symbol, :encrypted_content] The type of the input item. Always `encrypted_content`.
686
+ # @param type [Symbol, :encrypted_content]
687
+ # The type of the input item. Always `encrypted_content`.
656
688
  end
657
689
 
658
690
  # @!method self.variants
@@ -670,7 +702,8 @@ module OpenAI
670
702
  # @!method initialize(agent_name:)
671
703
  # The agent that produced this item.
672
704
  #
673
- # @param agent_name [String] The canonical name of the agent that produced this item.
705
+ # @param agent_name [String]
706
+ # The canonical name of the agent that produced this item.
674
707
  end
675
708
  end
676
709
 
@@ -712,17 +745,23 @@ module OpenAI
712
745
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::MultiAgentCall::Agent }, nil?: true
713
746
 
714
747
  # @!method initialize(action:, arguments:, call_id:, id: nil, agent: nil, type: :multi_agent_call)
715
- # @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Action] The multi-agent action that was executed.
748
+ # @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Action]
749
+ # The multi-agent action that was executed.
716
750
  #
717
- # @param arguments [String] The action arguments as a JSON string.
751
+ # @param arguments [String]
752
+ # The action arguments as a JSON string.
718
753
  #
719
- # @param call_id [String] The unique ID linking this call to its output.
754
+ # @param call_id [String]
755
+ # The unique ID linking this call to its output.
720
756
  #
721
- # @param id [String, nil] The unique ID of this multi-agent call.
757
+ # @param id [String, nil]
758
+ # The unique ID of this multi-agent call.
722
759
  #
723
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Agent, nil] The agent that produced this item.
760
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall::Agent, nil]
761
+ # The agent that produced this item.
724
762
  #
725
- # @param type [Symbol, :multi_agent_call] The item type. Always `multi_agent_call`.
763
+ # @param type [Symbol, :multi_agent_call]
764
+ # The item type. Always `multi_agent_call`.
726
765
 
727
766
  # The multi-agent action that was executed.
728
767
  #
@@ -752,7 +791,8 @@ module OpenAI
752
791
  # @!method initialize(agent_name:)
753
792
  # The agent that produced this item.
754
793
  #
755
- # @param agent_name [String] The canonical name of the agent that produced this item.
794
+ # @param agent_name [String]
795
+ # The canonical name of the agent that produced this item.
756
796
  end
757
797
  end
758
798
 
@@ -797,17 +837,23 @@ module OpenAI
797
837
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::MultiAgentCallOutput::Agent }, nil?: true
798
838
 
799
839
  # @!method initialize(action:, call_id:, output:, id: nil, agent: nil, type: :multi_agent_call_output)
800
- # @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Action] The multi-agent action that produced this result.
840
+ # @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Action]
841
+ # The multi-agent action that produced this result.
801
842
  #
802
- # @param call_id [String] The unique ID of the multi-agent call.
843
+ # @param call_id [String]
844
+ # The unique ID of the multi-agent call.
803
845
  #
804
- # @param output [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output>] Text output returned by the multi-agent action.
846
+ # @param output [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output>]
847
+ # Text output returned by the multi-agent action.
805
848
  #
806
- # @param id [String, nil] The unique ID of this multi-agent call output.
849
+ # @param id [String, nil]
850
+ # The unique ID of this multi-agent call output.
807
851
  #
808
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Agent, nil] The agent that produced this item.
852
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Agent, nil]
853
+ # The agent that produced this item.
809
854
  #
810
- # @param type [Symbol, :multi_agent_call_output] The item type. Always `multi_agent_call_output`.
855
+ # @param type [Symbol, :multi_agent_call_output]
856
+ # The item type. Always `multi_agent_call_output`.
811
857
 
812
858
  # The multi-agent action that produced this result.
813
859
  #
@@ -853,12 +899,14 @@ module OpenAI
853
899
  )
854
900
 
855
901
  # @!method initialize(text:, annotations: nil, type: :output_text)
856
- # @param text [String] The text content.
902
+ # @param text [String]
903
+ # The text content.
857
904
  #
858
- # @param annotations [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::ContainerFileCitation>] Citations associated with the text content.
905
+ # @param annotations [Array<OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput::Output::Annotation::ContainerFileCitation>]
906
+ # Citations associated with the text content.
859
907
  #
860
- # @param type [Symbol, :output_text] The content type. Always `output_text`.
861
-
908
+ # @param type [Symbol, :output_text]
909
+ # The content type. Always `output_text`.
862
910
  module Annotation
863
911
  extend OpenAI::Internal::Type::Union
864
912
 
@@ -907,13 +955,17 @@ module OpenAI
907
955
  required :type, const: :file_citation
908
956
 
909
957
  # @!method initialize(file_id:, filename:, index:, type: :file_citation)
910
- # @param file_id [String] The ID of the file.
958
+ # @param file_id [String]
959
+ # The ID of the file.
911
960
  #
912
- # @param filename [String] The filename of the file cited.
961
+ # @param filename [String]
962
+ # The filename of the file cited.
913
963
  #
914
- # @param index [Integer] The index of the file in the list of files.
964
+ # @param index [Integer]
965
+ # The index of the file in the list of files.
915
966
  #
916
- # @param type [Symbol, :file_citation] The citation type. Always `file_citation`.
967
+ # @param type [Symbol, :file_citation]
968
+ # The citation type. Always `file_citation`.
917
969
  end
918
970
 
919
971
  class URLCitation < OpenAI::Internal::Type::BaseModel
@@ -948,15 +1000,20 @@ module OpenAI
948
1000
  required :url, String
949
1001
 
950
1002
  # @!method initialize(end_index:, start_index:, title:, url:, type: :url_citation)
951
- # @param end_index [Integer] The index of the last character of the citation in the message.
1003
+ # @param end_index [Integer]
1004
+ # The index of the last character of the citation in the message.
952
1005
  #
953
- # @param start_index [Integer] The index of the first character of the citation in the message.
1006
+ # @param start_index [Integer]
1007
+ # The index of the first character of the citation in the message.
954
1008
  #
955
- # @param title [String] The title of the cited resource.
1009
+ # @param title [String]
1010
+ # The title of the cited resource.
956
1011
  #
957
- # @param url [String] The URL of the cited resource.
1012
+ # @param url [String]
1013
+ # The URL of the cited resource.
958
1014
  #
959
- # @param type [Symbol, :url_citation] The citation type. Always `url_citation`.
1015
+ # @param type [Symbol, :url_citation]
1016
+ # The citation type. Always `url_citation`.
960
1017
  end
961
1018
 
962
1019
  class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
@@ -997,17 +1054,23 @@ module OpenAI
997
1054
  required :type, const: :container_file_citation
998
1055
 
999
1056
  # @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
1000
- # @param container_id [String] The ID of the container.
1057
+ # @param container_id [String]
1058
+ # The ID of the container.
1001
1059
  #
1002
- # @param end_index [Integer] The index of the last character of the citation in the message.
1060
+ # @param end_index [Integer]
1061
+ # The index of the last character of the citation in the message.
1003
1062
  #
1004
- # @param file_id [String] The ID of the container file.
1063
+ # @param file_id [String]
1064
+ # The ID of the container file.
1005
1065
  #
1006
- # @param filename [String] The filename of the container file cited.
1066
+ # @param filename [String]
1067
+ # The filename of the container file cited.
1007
1068
  #
1008
- # @param start_index [Integer] The index of the first character of the citation in the message.
1069
+ # @param start_index [Integer]
1070
+ # The index of the first character of the citation in the message.
1009
1071
  #
1010
- # @param type [Symbol, :container_file_citation] The citation type. Always `container_file_citation`.
1072
+ # @param type [Symbol, :container_file_citation]
1073
+ # The citation type. Always `container_file_citation`.
1011
1074
  end
1012
1075
 
1013
1076
  # @!method self.variants
@@ -1026,7 +1089,8 @@ module OpenAI
1026
1089
  # @!method initialize(agent_name:)
1027
1090
  # The agent that produced this item.
1028
1091
  #
1029
- # @param agent_name [String] The canonical name of the agent that produced this item.
1092
+ # @param agent_name [String]
1093
+ # The canonical name of the agent that produced this item.
1030
1094
  end
1031
1095
  end
1032
1096
 
@@ -1080,19 +1144,26 @@ module OpenAI
1080
1144
  )
1081
1145
 
1082
1146
  # @!method initialize(arguments:, id: nil, agent: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_call)
1083
- # @param arguments [Object] The arguments supplied to the tool search call.
1147
+ # @param arguments [Object]
1148
+ # The arguments supplied to the tool search call.
1084
1149
  #
1085
- # @param id [String, nil] The unique ID of this tool search call.
1150
+ # @param id [String, nil]
1151
+ # The unique ID of this tool search call.
1086
1152
  #
1087
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Agent, nil] The agent that produced this item.
1153
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Agent, nil]
1154
+ # The agent that produced this item.
1088
1155
  #
1089
- # @param call_id [String, nil] The unique ID of the tool search call generated by the model.
1156
+ # @param call_id [String, nil]
1157
+ # The unique ID of the tool search call generated by the model.
1090
1158
  #
1091
- # @param execution [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Execution] Whether tool search was executed by the server or by the client.
1159
+ # @param execution [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Execution]
1160
+ # Whether tool search was executed by the server or by the client.
1092
1161
  #
1093
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Status, nil] The status of the tool search call.
1162
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall::Status, nil]
1163
+ # The status of the tool search call.
1094
1164
  #
1095
- # @param type [Symbol, :tool_search_call] The item type. Always `tool_search_call`.
1165
+ # @param type [Symbol, :tool_search_call]
1166
+ # The item type. Always `tool_search_call`.
1096
1167
 
1097
1168
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall#agent
1098
1169
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -1105,7 +1176,8 @@ module OpenAI
1105
1176
  # @!method initialize(agent_name:)
1106
1177
  # The agent that produced this item.
1107
1178
  #
1108
- # @param agent_name [String] The canonical name of the agent that produced this item.
1179
+ # @param agent_name [String]
1180
+ # The canonical name of the agent that produced this item.
1109
1181
  end
1110
1182
 
1111
1183
  # Whether tool search was executed by the server or by the client.
@@ -1168,15 +1240,20 @@ module OpenAI
1168
1240
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::AdditionalTools::Agent }, nil?: true
1169
1241
 
1170
1242
  # @!method initialize(tools:, id: nil, agent: nil, role: :developer, type: :additional_tools)
1171
- # @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>] A list of additional tools made available at this item.
1243
+ # @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
1244
+ # A list of additional tools made available at this item.
1172
1245
  #
1173
- # @param id [String, nil] The unique ID of this additional tools item.
1246
+ # @param id [String, nil]
1247
+ # The unique ID of this additional tools item.
1174
1248
  #
1175
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools::Agent, nil] The agent that produced this item.
1249
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools::Agent, nil]
1250
+ # The agent that produced this item.
1176
1251
  #
1177
- # @param role [Symbol, :developer] The role that provided the additional tools. Only `developer` is supported.
1252
+ # @param role [Symbol, :developer]
1253
+ # The role that provided the additional tools. Only `developer` is supported.
1178
1254
  #
1179
- # @param type [Symbol, :additional_tools] The item type. Always `additional_tools`.
1255
+ # @param type [Symbol, :additional_tools]
1256
+ # The item type. Always `additional_tools`.
1180
1257
 
1181
1258
  # @see OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools#agent
1182
1259
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -1189,7 +1266,8 @@ module OpenAI
1189
1266
  # @!method initialize(agent_name:)
1190
1267
  # The agent that produced this item.
1191
1268
  #
1192
- # @param agent_name [String] The canonical name of the agent that produced this item.
1269
+ # @param agent_name [String]
1270
+ # The canonical name of the agent that produced this item.
1193
1271
  end
1194
1272
  end
1195
1273
 
@@ -1218,12 +1296,42 @@ module OpenAI
1218
1296
  # @return [Symbol, :image_generation_call]
1219
1297
  required :type, const: :image_generation_call
1220
1298
 
1299
+ # @!attribute action
1300
+ # The action used for image generation.
1301
+ #
1302
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Action, nil]
1303
+ optional(
1304
+ :action,
1305
+ enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Action },
1306
+ nil?: true
1307
+ )
1308
+
1221
1309
  # @!attribute agent
1222
1310
  # The agent that produced this item.
1223
1311
  #
1224
1312
  # @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil]
1225
1313
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Agent }, nil?: true
1226
1314
 
1315
+ # @!attribute background
1316
+ # The background setting used for generation.
1317
+ #
1318
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Background, nil]
1319
+ optional(
1320
+ :background,
1321
+ enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Background },
1322
+ nil?: true
1323
+ )
1324
+
1325
+ # @!attribute output_format
1326
+ # The output format used for generation.
1327
+ #
1328
+ # @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat, nil]
1329
+ optional(
1330
+ :output_format,
1331
+ enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat },
1332
+ nil?: true
1333
+ )
1334
+
1227
1335
  # @!attribute quality
1228
1336
  # The quality of the image generated by the image generation tool call. One of
1229
1337
  # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
@@ -1235,6 +1343,12 @@ module OpenAI
1235
1343
  nil?: true
1236
1344
  )
1237
1345
 
1346
+ # @!attribute revised_prompt
1347
+ # The prompt that was used after any model prompt rewriting.
1348
+ #
1349
+ # @return [String, nil]
1350
+ optional :revised_prompt, String, nil?: true
1351
+
1238
1352
  # @!attribute size
1239
1353
  # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
1240
1354
  #
@@ -1247,26 +1361,42 @@ module OpenAI
1247
1361
  nil?: true
1248
1362
  )
1249
1363
 
1250
- # @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
1251
- # Some parameter documentations has been truncated, see
1252
- # {OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall} for more
1253
- # details.
1254
- #
1364
+ # @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
1255
1365
  # An image generation request made by the model.
1256
1366
  #
1257
- # @param id [String] The unique ID of the image generation call.
1367
+ # @param id [String]
1368
+ # The unique ID of the image generation call.
1369
+ #
1370
+ # @param result [String, nil]
1371
+ # The generated image encoded in base64.
1372
+ #
1373
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Status]
1374
+ # The status of the image generation call.
1258
1375
  #
1259
- # @param result [String, nil] The generated image encoded in base64.
1376
+ # @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Action, nil]
1377
+ # The action used for image generation.
1260
1378
  #
1261
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Status] The status of the image generation call.
1379
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil]
1380
+ # The agent that produced this item.
1262
1381
  #
1263
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil] The agent that produced this item.
1382
+ # @param background [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Background, nil]
1383
+ # The background setting used for generation.
1264
1384
  #
1265
- # @param quality [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Quality, nil] The quality of the image generated by the image generation tool call. One of `lo
1385
+ # @param output_format [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat, nil]
1386
+ # The output format used for generation.
1266
1387
  #
1267
- # @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
1388
+ # @param quality [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Quality, nil]
1389
+ # The quality of the image generated by the image generation tool call. One of
1390
+ # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
1268
1391
  #
1269
- # @param type [Symbol, :image_generation_call] The type of the image generation call. Always `image_generation_call`.
1392
+ # @param revised_prompt [String, nil]
1393
+ # The prompt that was used after any model prompt rewriting.
1394
+ #
1395
+ # @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil]
1396
+ # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
1397
+ #
1398
+ # @param type [Symbol, :image_generation_call]
1399
+ # The type of the image generation call. Always `image_generation_call`.
1270
1400
 
1271
1401
  # The status of the image generation call.
1272
1402
  #
@@ -1283,6 +1413,20 @@ module OpenAI
1283
1413
  # @return [Array<Symbol>]
1284
1414
  end
1285
1415
 
1416
+ # The action used for image generation.
1417
+ #
1418
+ # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#action
1419
+ module Action
1420
+ extend OpenAI::Internal::Type::Enum
1421
+
1422
+ GENERATE = :generate
1423
+ EDIT = :edit
1424
+ AUTO = :auto
1425
+
1426
+ # @!method self.values
1427
+ # @return [Array<Symbol>]
1428
+ end
1429
+
1286
1430
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#agent
1287
1431
  class Agent < OpenAI::Internal::Type::BaseModel
1288
1432
  # @!attribute agent_name
@@ -1294,7 +1438,36 @@ module OpenAI
1294
1438
  # @!method initialize(agent_name:)
1295
1439
  # The agent that produced this item.
1296
1440
  #
1297
- # @param agent_name [String] The canonical name of the agent that produced this item.
1441
+ # @param agent_name [String]
1442
+ # The canonical name of the agent that produced this item.
1443
+ end
1444
+
1445
+ # The background setting used for generation.
1446
+ #
1447
+ # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#background
1448
+ module Background
1449
+ extend OpenAI::Internal::Type::Enum
1450
+
1451
+ TRANSPARENT = :transparent
1452
+ OPAQUE = :opaque
1453
+ AUTO = :auto
1454
+
1455
+ # @!method self.values
1456
+ # @return [Array<Symbol>]
1457
+ end
1458
+
1459
+ # The output format used for generation.
1460
+ #
1461
+ # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#output_format
1462
+ module OutputFormat
1463
+ extend OpenAI::Internal::Type::Enum
1464
+
1465
+ PNG = :png
1466
+ WEBP = :webp
1467
+ JPEG = :jpeg
1468
+
1469
+ # @!method self.values
1470
+ # @return [Array<Symbol>]
1298
1471
  end
1299
1472
 
1300
1473
  # The quality of the image generated by the image generation tool call. One of
@@ -1392,22 +1565,25 @@ module OpenAI
1392
1565
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::LocalShellCall::Agent }, nil?: true
1393
1566
 
1394
1567
  # @!method initialize(id:, action:, call_id:, status:, agent: nil, type: :local_shell_call)
1395
- # Some parameter documentations has been truncated, see
1396
- # {OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall} for more details.
1397
- #
1398
1568
  # A tool call to run a command on the local shell.
1399
1569
  #
1400
- # @param id [String] The unique ID of the local shell call.
1570
+ # @param id [String]
1571
+ # The unique ID of the local shell call.
1401
1572
  #
1402
- # @param action [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Action] Execute a shell command on the server.
1573
+ # @param action [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Action]
1574
+ # Execute a shell command on the server.
1403
1575
  #
1404
- # @param call_id [String] The unique ID of the local shell tool call generated by the model.
1576
+ # @param call_id [String]
1577
+ # The unique ID of the local shell tool call generated by the model.
1405
1578
  #
1406
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Status] The status of the local shell call.
1579
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Status]
1580
+ # The status of the local shell call.
1407
1581
  #
1408
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Agent, nil] The agent that produced this item.
1582
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall::Agent, nil]
1583
+ # The agent that produced this item.
1409
1584
  #
1410
- # @param type [Symbol, :local_shell_call] The type of the local shell call. Always `local_shell_call`.
1585
+ # @param type [Symbol, :local_shell_call]
1586
+ # The type of the local shell call. Always `local_shell_call`.
1411
1587
 
1412
1588
  # @see OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall#action
1413
1589
  class Action < OpenAI::Internal::Type::BaseModel
@@ -1450,17 +1626,23 @@ module OpenAI
1450
1626
  # @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
1451
1627
  # Execute a shell command on the server.
1452
1628
  #
1453
- # @param command [Array<String>] The command to run.
1629
+ # @param command [Array<String>]
1630
+ # The command to run.
1454
1631
  #
1455
- # @param env [Hash{Symbol=>String}] Environment variables to set for the command.
1632
+ # @param env [Hash{Symbol=>String}]
1633
+ # Environment variables to set for the command.
1456
1634
  #
1457
- # @param timeout_ms [Integer, nil] Optional timeout in milliseconds for the command.
1635
+ # @param timeout_ms [Integer, nil]
1636
+ # Optional timeout in milliseconds for the command.
1458
1637
  #
1459
- # @param user [String, nil] Optional user to run the command as.
1638
+ # @param user [String, nil]
1639
+ # Optional user to run the command as.
1460
1640
  #
1461
- # @param working_directory [String, nil] Optional working directory to run the command in.
1641
+ # @param working_directory [String, nil]
1642
+ # Optional working directory to run the command in.
1462
1643
  #
1463
- # @param type [Symbol, :exec] The type of the local shell action. Always `exec`.
1644
+ # @param type [Symbol, :exec]
1645
+ # The type of the local shell action. Always `exec`.
1464
1646
  end
1465
1647
 
1466
1648
  # The status of the local shell call.
@@ -1488,7 +1670,8 @@ module OpenAI
1488
1670
  # @!method initialize(agent_name:)
1489
1671
  # The agent that produced this item.
1490
1672
  #
1491
- # @param agent_name [String] The canonical name of the agent that produced this item.
1673
+ # @param agent_name [String]
1674
+ # The canonical name of the agent that produced this item.
1492
1675
  end
1493
1676
  end
1494
1677
 
@@ -1528,21 +1711,22 @@ module OpenAI
1528
1711
  )
1529
1712
 
1530
1713
  # @!method initialize(id:, output:, agent: nil, status: nil, type: :local_shell_call_output)
1531
- # Some parameter documentations has been truncated, see
1532
- # {OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput} for more
1533
- # details.
1534
- #
1535
1714
  # The output of a local shell tool call.
1536
1715
  #
1537
- # @param id [String] The unique ID of the local shell tool call generated by the model.
1716
+ # @param id [String]
1717
+ # The unique ID of the local shell tool call generated by the model.
1538
1718
  #
1539
- # @param output [String] A JSON string of the output of the local shell tool call.
1719
+ # @param output [String]
1720
+ # A JSON string of the output of the local shell tool call.
1540
1721
  #
1541
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Agent, nil] The agent that produced this item.
1722
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Agent, nil]
1723
+ # The agent that produced this item.
1542
1724
  #
1543
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`.
1725
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput::Status, nil]
1726
+ # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
1544
1727
  #
1545
- # @param type [Symbol, :local_shell_call_output] The type of the local shell tool call output. Always `local_shell_call_output`.
1728
+ # @param type [Symbol, :local_shell_call_output]
1729
+ # The type of the local shell tool call output. Always `local_shell_call_output`.
1546
1730
 
1547
1731
  # @see OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput#agent
1548
1732
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -1555,7 +1739,8 @@ module OpenAI
1555
1739
  # @!method initialize(agent_name:)
1556
1740
  # The agent that produced this item.
1557
1741
  #
1558
- # @param agent_name [String] The canonical name of the agent that produced this item.
1742
+ # @param agent_name [String]
1743
+ # The canonical name of the agent that produced this item.
1559
1744
  end
1560
1745
 
1561
1746
  # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
@@ -1634,26 +1819,33 @@ module OpenAI
1634
1819
  optional :status, enum: -> { OpenAI::Beta::BetaResponseInputItem::ShellCall::Status }, nil?: true
1635
1820
 
1636
1821
  # @!method initialize(action:, call_id:, id: nil, agent: nil, caller_: nil, environment: nil, status: nil, type: :shell_call)
1637
- # Some parameter documentations has been truncated, see
1638
- # {OpenAI::Models::Beta::BetaResponseInputItem::ShellCall} for more details.
1639
- #
1640
1822
  # A tool representing a request to execute one or more shell commands.
1641
1823
  #
1642
- # @param action [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Action] The shell commands and limits that describe how to run the tool call.
1824
+ # @param action [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Action]
1825
+ # The shell commands and limits that describe how to run the tool call.
1643
1826
  #
1644
- # @param call_id [String] The unique ID of the shell tool call generated by the model.
1827
+ # @param call_id [String]
1828
+ # The unique ID of the shell tool call generated by the model.
1645
1829
  #
1646
- # @param id [String, nil] The unique ID of the shell tool call. Populated when this item is returned via A
1830
+ # @param id [String, nil]
1831
+ # The unique ID of the shell tool call. Populated when this item is returned via
1832
+ # API.
1647
1833
  #
1648
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Agent, nil] The agent that produced this item.
1834
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Agent, nil]
1835
+ # The agent that produced this item.
1649
1836
  #
1650
- # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Program, nil] The execution context that produced this tool call.
1837
+ # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Program, nil]
1838
+ # The execution context that produced this tool call.
1651
1839
  #
1652
- # @param environment [OpenAI::Models::Beta::BetaLocalEnvironment, OpenAI::Models::Beta::BetaContainerReference, nil] The environment to execute the shell commands in.
1840
+ # @param environment [OpenAI::Models::Beta::BetaLocalEnvironment, OpenAI::Models::Beta::BetaContainerReference, nil]
1841
+ # The environment to execute the shell commands in.
1653
1842
  #
1654
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Status, nil] The status of the shell call. One of `in_progress`, `completed`, or `incomplete`
1843
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Status, nil]
1844
+ # The status of the shell call. One of `in_progress`, `completed`, or
1845
+ # `incomplete`.
1655
1846
  #
1656
- # @param type [Symbol, :shell_call] The type of the item. Always `shell_call`.
1847
+ # @param type [Symbol, :shell_call]
1848
+ # The type of the item. Always `shell_call`.
1657
1849
 
1658
1850
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ShellCall#action
1659
1851
  class Action < OpenAI::Internal::Type::BaseModel
@@ -1677,17 +1869,17 @@ module OpenAI
1677
1869
  optional :timeout_ms, Integer, nil?: true
1678
1870
 
1679
1871
  # @!method initialize(commands:, max_output_length: nil, timeout_ms: nil)
1680
- # Some parameter documentations has been truncated, see
1681
- # {OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Action} for more
1682
- # details.
1683
- #
1684
1872
  # The shell commands and limits that describe how to run the tool call.
1685
1873
  #
1686
- # @param commands [Array<String>] Ordered shell commands for the execution environment to run.
1874
+ # @param commands [Array<String>]
1875
+ # Ordered shell commands for the execution environment to run.
1687
1876
  #
1688
- # @param max_output_length [Integer, nil] Maximum number of UTF-8 characters to capture from combined stdout and stderr ou
1877
+ # @param max_output_length [Integer, nil]
1878
+ # Maximum number of UTF-8 characters to capture from combined stdout and stderr
1879
+ # output.
1689
1880
  #
1690
- # @param timeout_ms [Integer, nil] Maximum wall-clock time in milliseconds to allow the shell commands to run.
1881
+ # @param timeout_ms [Integer, nil]
1882
+ # Maximum wall-clock time in milliseconds to allow the shell commands to run.
1691
1883
  end
1692
1884
 
1693
1885
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ShellCall#agent
@@ -1701,7 +1893,8 @@ module OpenAI
1701
1893
  # @!method initialize(agent_name:)
1702
1894
  # The agent that produced this item.
1703
1895
  #
1704
- # @param agent_name [String] The canonical name of the agent that produced this item.
1896
+ # @param agent_name [String]
1897
+ # The canonical name of the agent that produced this item.
1705
1898
  end
1706
1899
 
1707
1900
  # The execution context that produced this tool call.
@@ -1724,7 +1917,8 @@ module OpenAI
1724
1917
  required :type, const: :direct
1725
1918
 
1726
1919
  # @!method initialize(type: :direct)
1727
- # @param type [Symbol, :direct] The caller type. Always `direct`.
1920
+ # @param type [Symbol, :direct]
1921
+ # The caller type. Always `direct`.
1728
1922
  end
1729
1923
 
1730
1924
  class Program < OpenAI::Internal::Type::BaseModel
@@ -1741,9 +1935,11 @@ module OpenAI
1741
1935
  required :type, const: :program
1742
1936
 
1743
1937
  # @!method initialize(caller_id:, type: :program)
1744
- # @param caller_id [String] The call ID of the program item that produced this tool call.
1938
+ # @param caller_id [String]
1939
+ # The call ID of the program item that produced this tool call.
1745
1940
  #
1746
- # @param type [Symbol, :program] The caller type. Always `program`.
1941
+ # @param type [Symbol, :program]
1942
+ # The caller type. Always `program`.
1747
1943
  end
1748
1944
 
1749
1945
  # @!method self.variants
@@ -1849,26 +2045,34 @@ module OpenAI
1849
2045
  )
1850
2046
 
1851
2047
  # @!method initialize(call_id:, output:, id: nil, agent: nil, caller_: nil, max_output_length: nil, status: nil, type: :shell_call_output)
1852
- # Some parameter documentations has been truncated, see
1853
- # {OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput} for more details.
1854
- #
1855
2048
  # The streamed output items emitted by a shell tool call.
1856
2049
  #
1857
- # @param call_id [String] The unique ID of the shell tool call generated by the model.
2050
+ # @param call_id [String]
2051
+ # The unique ID of the shell tool call generated by the model.
1858
2052
  #
1859
- # @param output [Array<OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent>] Captured chunks of stdout and stderr output, along with their associated outcome
2053
+ # @param output [Array<OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent>]
2054
+ # Captured chunks of stdout and stderr output, along with their associated
2055
+ # outcomes.
1860
2056
  #
1861
- # @param id [String, nil] The unique ID of the shell tool call output. Populated when this item is returne
2057
+ # @param id [String, nil]
2058
+ # The unique ID of the shell tool call output. Populated when this item is
2059
+ # returned via API.
1862
2060
  #
1863
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Agent, nil] The agent that produced this item.
2061
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Agent, nil]
2062
+ # The agent that produced this item.
1864
2063
  #
1865
- # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Program, nil] The execution context that produced this tool call.
2064
+ # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Caller::Program, nil]
2065
+ # The execution context that produced this tool call.
1866
2066
  #
1867
- # @param max_output_length [Integer, nil] The maximum number of UTF-8 characters captured for this shell call's combined o
2067
+ # @param max_output_length [Integer, nil]
2068
+ # The maximum number of UTF-8 characters captured for this shell call's combined
2069
+ # output.
1868
2070
  #
1869
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Status, nil] The status of the shell call output.
2071
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput::Status, nil]
2072
+ # The status of the shell call output.
1870
2073
  #
1871
- # @param type [Symbol, :shell_call_output] The type of the item. Always `shell_call_output`.
2074
+ # @param type [Symbol, :shell_call_output]
2075
+ # The type of the item. Always `shell_call_output`.
1872
2076
 
1873
2077
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput#agent
1874
2078
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -1881,7 +2085,8 @@ module OpenAI
1881
2085
  # @!method initialize(agent_name:)
1882
2086
  # The agent that produced this item.
1883
2087
  #
1884
- # @param agent_name [String] The canonical name of the agent that produced this item.
2088
+ # @param agent_name [String]
2089
+ # The canonical name of the agent that produced this item.
1885
2090
  end
1886
2091
 
1887
2092
  # The execution context that produced this tool call.
@@ -1904,7 +2109,8 @@ module OpenAI
1904
2109
  required :type, const: :direct
1905
2110
 
1906
2111
  # @!method initialize(type: :direct)
1907
- # @param type [Symbol, :direct] The caller type. Always `direct`.
2112
+ # @param type [Symbol, :direct]
2113
+ # The caller type. Always `direct`.
1908
2114
  end
1909
2115
 
1910
2116
  class Program < OpenAI::Internal::Type::BaseModel
@@ -1921,9 +2127,11 @@ module OpenAI
1921
2127
  required :type, const: :program
1922
2128
 
1923
2129
  # @!method initialize(caller_id:, type: :program)
1924
- # @param caller_id [String] The call ID of the program item that produced this tool call.
2130
+ # @param caller_id [String]
2131
+ # The call ID of the program item that produced this tool call.
1925
2132
  #
1926
- # @param type [Symbol, :program] The caller type. Always `program`.
2133
+ # @param type [Symbol, :program]
2134
+ # The caller type. Always `program`.
1927
2135
  end
1928
2136
 
1929
2137
  # @!method self.variants
@@ -1996,25 +2204,31 @@ module OpenAI
1996
2204
  )
1997
2205
 
1998
2206
  # @!method initialize(call_id:, operation:, status:, id: nil, agent: nil, caller_: nil, type: :apply_patch_call)
1999
- # Some parameter documentations has been truncated, see
2000
- # {OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall} for more details.
2001
- #
2002
2207
  # A tool call representing a request to create, delete, or update files using diff
2003
2208
  # patches.
2004
2209
  #
2005
- # @param call_id [String] The unique ID of the apply patch tool call generated by the model.
2210
+ # @param call_id [String]
2211
+ # The unique ID of the apply patch tool call generated by the model.
2006
2212
  #
2007
- # @param operation [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::CreateFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::DeleteFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::UpdateFile] The specific create, delete, or update instruction for the apply_patch tool call
2213
+ # @param operation [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::CreateFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::DeleteFile, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Operation::UpdateFile]
2214
+ # The specific create, delete, or update instruction for the apply_patch tool
2215
+ # call.
2008
2216
  #
2009
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Status] The status of the apply patch tool call. One of `in_progress` or `completed`.
2217
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Status]
2218
+ # The status of the apply patch tool call. One of `in_progress` or `completed`.
2010
2219
  #
2011
- # @param id [String, nil] The unique ID of the apply patch tool call. Populated when this item is returned
2220
+ # @param id [String, nil]
2221
+ # The unique ID of the apply patch tool call. Populated when this item is returned
2222
+ # via API.
2012
2223
  #
2013
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Agent, nil] The agent that produced this item.
2224
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Agent, nil]
2225
+ # The agent that produced this item.
2014
2226
  #
2015
- # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Program, nil] The execution context that produced this tool call.
2227
+ # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall::Caller::Program, nil]
2228
+ # The execution context that produced this tool call.
2016
2229
  #
2017
- # @param type [Symbol, :apply_patch_call] The type of the item. Always `apply_patch_call`.
2230
+ # @param type [Symbol, :apply_patch_call]
2231
+ # The type of the item. Always `apply_patch_call`.
2018
2232
 
2019
2233
  # The specific create, delete, or update instruction for the apply_patch tool
2020
2234
  # call.
@@ -2056,11 +2270,14 @@ module OpenAI
2056
2270
  # @!method initialize(diff:, path:, type: :create_file)
2057
2271
  # Instruction for creating a new file via the apply_patch tool.
2058
2272
  #
2059
- # @param diff [String] Unified diff content to apply when creating the file.
2273
+ # @param diff [String]
2274
+ # Unified diff content to apply when creating the file.
2060
2275
  #
2061
- # @param path [String] Path of the file to create relative to the workspace root.
2276
+ # @param path [String]
2277
+ # Path of the file to create relative to the workspace root.
2062
2278
  #
2063
- # @param type [Symbol, :create_file] The operation type. Always `create_file`.
2279
+ # @param type [Symbol, :create_file]
2280
+ # The operation type. Always `create_file`.
2064
2281
  end
2065
2282
 
2066
2283
  class DeleteFile < OpenAI::Internal::Type::BaseModel
@@ -2079,9 +2296,11 @@ module OpenAI
2079
2296
  # @!method initialize(path:, type: :delete_file)
2080
2297
  # Instruction for deleting an existing file via the apply_patch tool.
2081
2298
  #
2082
- # @param path [String] Path of the file to delete relative to the workspace root.
2299
+ # @param path [String]
2300
+ # Path of the file to delete relative to the workspace root.
2083
2301
  #
2084
- # @param type [Symbol, :delete_file] The operation type. Always `delete_file`.
2302
+ # @param type [Symbol, :delete_file]
2303
+ # The operation type. Always `delete_file`.
2085
2304
  end
2086
2305
 
2087
2306
  class UpdateFile < OpenAI::Internal::Type::BaseModel
@@ -2106,11 +2325,14 @@ module OpenAI
2106
2325
  # @!method initialize(diff:, path:, type: :update_file)
2107
2326
  # Instruction for updating an existing file via the apply_patch tool.
2108
2327
  #
2109
- # @param diff [String] Unified diff content to apply to the existing file.
2328
+ # @param diff [String]
2329
+ # Unified diff content to apply to the existing file.
2110
2330
  #
2111
- # @param path [String] Path of the file to update relative to the workspace root.
2331
+ # @param path [String]
2332
+ # Path of the file to update relative to the workspace root.
2112
2333
  #
2113
- # @param type [Symbol, :update_file] The operation type. Always `update_file`.
2334
+ # @param type [Symbol, :update_file]
2335
+ # The operation type. Always `update_file`.
2114
2336
  end
2115
2337
 
2116
2338
  # @!method self.variants
@@ -2141,7 +2363,8 @@ module OpenAI
2141
2363
  # @!method initialize(agent_name:)
2142
2364
  # The agent that produced this item.
2143
2365
  #
2144
- # @param agent_name [String] The canonical name of the agent that produced this item.
2366
+ # @param agent_name [String]
2367
+ # The canonical name of the agent that produced this item.
2145
2368
  end
2146
2369
 
2147
2370
  # The execution context that produced this tool call.
@@ -2164,7 +2387,8 @@ module OpenAI
2164
2387
  required :type, const: :direct
2165
2388
 
2166
2389
  # @!method initialize(type: :direct)
2167
- # @param type [Symbol, :direct] The caller type. Always `direct`.
2390
+ # @param type [Symbol, :direct]
2391
+ # The caller type. Always `direct`.
2168
2392
  end
2169
2393
 
2170
2394
  class Program < OpenAI::Internal::Type::BaseModel
@@ -2181,9 +2405,11 @@ module OpenAI
2181
2405
  required :type, const: :program
2182
2406
 
2183
2407
  # @!method initialize(caller_id:, type: :program)
2184
- # @param caller_id [String] The call ID of the program item that produced this tool call.
2408
+ # @param caller_id [String]
2409
+ # The call ID of the program item that produced this tool call.
2185
2410
  #
2186
- # @param type [Symbol, :program] The caller type. Always `program`.
2411
+ # @param type [Symbol, :program]
2412
+ # The caller type. Always `program`.
2187
2413
  end
2188
2414
 
2189
2415
  # @!method self.variants
@@ -2242,25 +2468,30 @@ module OpenAI
2242
2468
  optional :output, String, nil?: true
2243
2469
 
2244
2470
  # @!method initialize(call_id:, status:, id: nil, agent: nil, caller_: nil, output: nil, type: :apply_patch_call_output)
2245
- # Some parameter documentations has been truncated, see
2246
- # {OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput} for more
2247
- # details.
2248
- #
2249
2471
  # The streamed output emitted by an apply patch tool call.
2250
2472
  #
2251
- # @param call_id [String] The unique ID of the apply patch tool call generated by the model.
2473
+ # @param call_id [String]
2474
+ # The unique ID of the apply patch tool call generated by the model.
2252
2475
  #
2253
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Status] The status of the apply patch tool call output. One of `completed` or `failed`.
2476
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Status]
2477
+ # The status of the apply patch tool call output. One of `completed` or `failed`.
2254
2478
  #
2255
- # @param id [String, nil] The unique ID of the apply patch tool call output. Populated when this item is r
2479
+ # @param id [String, nil]
2480
+ # The unique ID of the apply patch tool call output. Populated when this item is
2481
+ # returned via API.
2256
2482
  #
2257
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Agent, nil] The agent that produced this item.
2483
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Agent, nil]
2484
+ # The agent that produced this item.
2258
2485
  #
2259
- # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Program, nil] The execution context that produced this tool call.
2486
+ # @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput::Caller::Program, nil]
2487
+ # The execution context that produced this tool call.
2260
2488
  #
2261
- # @param output [String, nil] Optional human-readable log text from the apply patch tool (e.g., patch results
2489
+ # @param output [String, nil]
2490
+ # Optional human-readable log text from the apply patch tool (e.g., patch results
2491
+ # or errors).
2262
2492
  #
2263
- # @param type [Symbol, :apply_patch_call_output] The type of the item. Always `apply_patch_call_output`.
2493
+ # @param type [Symbol, :apply_patch_call_output]
2494
+ # The type of the item. Always `apply_patch_call_output`.
2264
2495
 
2265
2496
  # The status of the apply patch tool call output. One of `completed` or `failed`.
2266
2497
  #
@@ -2286,7 +2517,8 @@ module OpenAI
2286
2517
  # @!method initialize(agent_name:)
2287
2518
  # The agent that produced this item.
2288
2519
  #
2289
- # @param agent_name [String] The canonical name of the agent that produced this item.
2520
+ # @param agent_name [String]
2521
+ # The canonical name of the agent that produced this item.
2290
2522
  end
2291
2523
 
2292
2524
  # The execution context that produced this tool call.
@@ -2309,7 +2541,8 @@ module OpenAI
2309
2541
  required :type, const: :direct
2310
2542
 
2311
2543
  # @!method initialize(type: :direct)
2312
- # @param type [Symbol, :direct] The caller type. Always `direct`.
2544
+ # @param type [Symbol, :direct]
2545
+ # The caller type. Always `direct`.
2313
2546
  end
2314
2547
 
2315
2548
  class Program < OpenAI::Internal::Type::BaseModel
@@ -2326,9 +2559,11 @@ module OpenAI
2326
2559
  required :type, const: :program
2327
2560
 
2328
2561
  # @!method initialize(caller_id:, type: :program)
2329
- # @param caller_id [String] The call ID of the program item that produced this tool call.
2562
+ # @param caller_id [String]
2563
+ # The call ID of the program item that produced this tool call.
2330
2564
  #
2331
- # @param type [Symbol, :program] The caller type. Always `program`.
2565
+ # @param type [Symbol, :program]
2566
+ # The caller type. Always `program`.
2332
2567
  end
2333
2568
 
2334
2569
  # @!method self.variants
@@ -2377,23 +2612,25 @@ module OpenAI
2377
2612
  optional :error, String, nil?: true
2378
2613
 
2379
2614
  # @!method initialize(id:, server_label:, tools:, agent: nil, error: nil, type: :mcp_list_tools)
2380
- # Some parameter documentations has been truncated, see
2381
- # {OpenAI::Models::Beta::BetaResponseInputItem::McpListTools} for more details.
2382
- #
2383
2615
  # A list of tools available on an MCP server.
2384
2616
  #
2385
- # @param id [String] The unique ID of the list.
2617
+ # @param id [String]
2618
+ # The unique ID of the list.
2386
2619
  #
2387
- # @param server_label [String] The label of the MCP server.
2620
+ # @param server_label [String]
2621
+ # The label of the MCP server.
2388
2622
  #
2389
- # @param tools [Array<OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Tool>] The tools available on the server.
2623
+ # @param tools [Array<OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Tool>]
2624
+ # The tools available on the server.
2390
2625
  #
2391
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Agent, nil] The agent that produced this item.
2626
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Agent, nil]
2627
+ # The agent that produced this item.
2392
2628
  #
2393
- # @param error [String, nil] Error message if the server could not list tools.
2629
+ # @param error [String, nil]
2630
+ # Error message if the server could not list tools.
2394
2631
  #
2395
- # @param type [Symbol, :mcp_list_tools] The type of the item. Always `mcp_list_tools`.
2396
-
2632
+ # @param type [Symbol, :mcp_list_tools]
2633
+ # The type of the item. Always `mcp_list_tools`.
2397
2634
  class Tool < OpenAI::Internal::Type::BaseModel
2398
2635
  # @!attribute input_schema
2399
2636
  # The JSON schema describing the tool's input.
@@ -2420,19 +2657,19 @@ module OpenAI
2420
2657
  optional :description, String, nil?: true
2421
2658
 
2422
2659
  # @!method initialize(input_schema:, name:, annotations: nil, description: nil)
2423
- # Some parameter documentations has been truncated, see
2424
- # {OpenAI::Models::Beta::BetaResponseInputItem::McpListTools::Tool} for more
2425
- # details.
2426
- #
2427
2660
  # A tool available on an MCP server.
2428
2661
  #
2429
- # @param input_schema [Object] The JSON schema describing the tool's input.
2662
+ # @param input_schema [Object]
2663
+ # The JSON schema describing the tool's input.
2430
2664
  #
2431
- # @param name [String] The name of the tool.
2665
+ # @param name [String]
2666
+ # The name of the tool.
2432
2667
  #
2433
- # @param annotations [Object, nil] Additional annotations about the tool.
2668
+ # @param annotations [Object, nil]
2669
+ # Additional annotations about the tool.
2434
2670
  #
2435
- # @param description [String, nil] The description of the tool.
2671
+ # @param description [String, nil]
2672
+ # The description of the tool.
2436
2673
  end
2437
2674
 
2438
2675
  # @see OpenAI::Models::Beta::BetaResponseInputItem::McpListTools#agent
@@ -2446,7 +2683,8 @@ module OpenAI
2446
2683
  # @!method initialize(agent_name:)
2447
2684
  # The agent that produced this item.
2448
2685
  #
2449
- # @param agent_name [String] The canonical name of the agent that produced this item.
2686
+ # @param agent_name [String]
2687
+ # The canonical name of the agent that produced this item.
2450
2688
  end
2451
2689
  end
2452
2690
 
@@ -2488,23 +2726,25 @@ module OpenAI
2488
2726
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::McpApprovalRequest::Agent }, nil?: true
2489
2727
 
2490
2728
  # @!method initialize(id:, arguments:, name:, server_label:, agent: nil, type: :mcp_approval_request)
2491
- # Some parameter documentations has been truncated, see
2492
- # {OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest} for more
2493
- # details.
2494
- #
2495
2729
  # A request for human approval of a tool invocation.
2496
2730
  #
2497
- # @param id [String] The unique ID of the approval request.
2731
+ # @param id [String]
2732
+ # The unique ID of the approval request.
2498
2733
  #
2499
- # @param arguments [String] A JSON string of arguments for the tool.
2734
+ # @param arguments [String]
2735
+ # A JSON string of arguments for the tool.
2500
2736
  #
2501
- # @param name [String] The name of the tool to run.
2737
+ # @param name [String]
2738
+ # The name of the tool to run.
2502
2739
  #
2503
- # @param server_label [String] The label of the MCP server making the request.
2740
+ # @param server_label [String]
2741
+ # The label of the MCP server making the request.
2504
2742
  #
2505
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest::Agent, nil] The agent that produced this item.
2743
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest::Agent, nil]
2744
+ # The agent that produced this item.
2506
2745
  #
2507
- # @param type [Symbol, :mcp_approval_request] The type of the item. Always `mcp_approval_request`.
2746
+ # @param type [Symbol, :mcp_approval_request]
2747
+ # The type of the item. Always `mcp_approval_request`.
2508
2748
 
2509
2749
  # @see OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest#agent
2510
2750
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -2517,7 +2757,8 @@ module OpenAI
2517
2757
  # @!method initialize(agent_name:)
2518
2758
  # The agent that produced this item.
2519
2759
  #
2520
- # @param agent_name [String] The canonical name of the agent that produced this item.
2760
+ # @param agent_name [String]
2761
+ # The canonical name of the agent that produced this item.
2521
2762
  end
2522
2763
  end
2523
2764
 
@@ -2559,23 +2800,25 @@ module OpenAI
2559
2800
  optional :reason, String, nil?: true
2560
2801
 
2561
2802
  # @!method initialize(approval_request_id:, approve:, id: nil, agent: nil, reason: nil, type: :mcp_approval_response)
2562
- # Some parameter documentations has been truncated, see
2563
- # {OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse} for more
2564
- # details.
2565
- #
2566
2803
  # A response to an MCP approval request.
2567
2804
  #
2568
- # @param approval_request_id [String] The ID of the approval request being answered.
2805
+ # @param approval_request_id [String]
2806
+ # The ID of the approval request being answered.
2569
2807
  #
2570
- # @param approve [Boolean] Whether the request was approved.
2808
+ # @param approve [Boolean]
2809
+ # Whether the request was approved.
2571
2810
  #
2572
- # @param id [String, nil] The unique ID of the approval response
2811
+ # @param id [String, nil]
2812
+ # The unique ID of the approval response
2573
2813
  #
2574
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse::Agent, nil] The agent that produced this item.
2814
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse::Agent, nil]
2815
+ # The agent that produced this item.
2575
2816
  #
2576
- # @param reason [String, nil] Optional reason for the decision.
2817
+ # @param reason [String, nil]
2818
+ # Optional reason for the decision.
2577
2819
  #
2578
- # @param type [Symbol, :mcp_approval_response] The type of the item. Always `mcp_approval_response`.
2820
+ # @param type [Symbol, :mcp_approval_response]
2821
+ # The type of the item. Always `mcp_approval_response`.
2579
2822
 
2580
2823
  # @see OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse#agent
2581
2824
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -2588,7 +2831,8 @@ module OpenAI
2588
2831
  # @!method initialize(agent_name:)
2589
2832
  # The agent that produced this item.
2590
2833
  #
2591
- # @param agent_name [String] The canonical name of the agent that produced this item.
2834
+ # @param agent_name [String]
2835
+ # The canonical name of the agent that produced this item.
2592
2836
  end
2593
2837
  end
2594
2838
 
@@ -2657,30 +2901,40 @@ module OpenAI
2657
2901
  optional :status, enum: -> { OpenAI::Beta::BetaResponseInputItem::McpCall::Status }
2658
2902
 
2659
2903
  # @!method initialize(id:, arguments:, name:, server_label:, agent: nil, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
2660
- # Some parameter documentations has been truncated, see
2661
- # {OpenAI::Models::Beta::BetaResponseInputItem::McpCall} for more details.
2662
- #
2663
2904
  # An invocation of a tool on an MCP server.
2664
2905
  #
2665
- # @param id [String] The unique ID of the tool call.
2906
+ # @param id [String]
2907
+ # The unique ID of the tool call.
2666
2908
  #
2667
- # @param arguments [String] A JSON string of the arguments passed to the tool.
2909
+ # @param arguments [String]
2910
+ # A JSON string of the arguments passed to the tool.
2668
2911
  #
2669
- # @param name [String] The name of the tool that was run.
2912
+ # @param name [String]
2913
+ # The name of the tool that was run.
2670
2914
  #
2671
- # @param server_label [String] The label of the MCP server running the tool.
2915
+ # @param server_label [String]
2916
+ # The label of the MCP server running the tool.
2672
2917
  #
2673
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Agent, nil] The agent that produced this item.
2918
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Agent, nil]
2919
+ # The agent that produced this item.
2674
2920
  #
2675
- # @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
2921
+ # @param approval_request_id [String, nil]
2922
+ # Unique identifier for the MCP tool call approval request. Include this value in
2923
+ # a subsequent `mcp_approval_response` input to approve or reject the
2924
+ # corresponding tool call.
2676
2925
  #
2677
- # @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil] The error from the tool call, if any.
2926
+ # @param error [OpenAI::Models::Beta::BetaMcpToolCallError::McpProtocolError, OpenAI::Models::Beta::BetaMcpToolCallError::McpToolExecutionError, OpenAI::Models::Beta::BetaMcpToolCallError::HTTPError, nil]
2927
+ # The error from the tool call, if any.
2678
2928
  #
2679
- # @param output [String, nil] The output from the tool call.
2929
+ # @param output [String, nil]
2930
+ # The output from the tool call.
2680
2931
  #
2681
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
2932
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::McpCall::Status]
2933
+ # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
2934
+ # `calling`, or `failed`.
2682
2935
  #
2683
- # @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.
2936
+ # @param type [Symbol, :mcp_call]
2937
+ # The type of the item. Always `mcp_call`.
2684
2938
 
2685
2939
  # @see OpenAI::Models::Beta::BetaResponseInputItem::McpCall#agent
2686
2940
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -2693,7 +2947,8 @@ module OpenAI
2693
2947
  # @!method initialize(agent_name:)
2694
2948
  # The agent that produced this item.
2695
2949
  #
2696
- # @param agent_name [String] The canonical name of the agent that produced this item.
2950
+ # @param agent_name [String]
2951
+ # The canonical name of the agent that produced this item.
2697
2952
  end
2698
2953
 
2699
2954
  # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
@@ -2730,9 +2985,11 @@ module OpenAI
2730
2985
  # @!method initialize(agent: nil, type: :compaction_trigger)
2731
2986
  # Compacts the current context. Must be the final input item.
2732
2987
  #
2733
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger::Agent, nil] The agent that produced this item.
2988
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger::Agent, nil]
2989
+ # The agent that produced this item.
2734
2990
  #
2735
- # @param type [Symbol, :compaction_trigger] The type of the item. Always `compaction_trigger`.
2991
+ # @param type [Symbol, :compaction_trigger]
2992
+ # The type of the item. Always `compaction_trigger`.
2736
2993
 
2737
2994
  # @see OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger#agent
2738
2995
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -2745,7 +3002,8 @@ module OpenAI
2745
3002
  # @!method initialize(agent_name:)
2746
3003
  # The agent that produced this item.
2747
3004
  #
2748
- # @param agent_name [String] The canonical name of the agent that produced this item.
3005
+ # @param agent_name [String]
3006
+ # The canonical name of the agent that produced this item.
2749
3007
  end
2750
3008
  end
2751
3009
 
@@ -2771,11 +3029,14 @@ module OpenAI
2771
3029
  # @!method initialize(id:, agent: nil, type: nil)
2772
3030
  # An internal identifier for an item to reference.
2773
3031
  #
2774
- # @param id [String] The ID of the item to reference.
3032
+ # @param id [String]
3033
+ # The ID of the item to reference.
2775
3034
  #
2776
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Agent, nil] The agent that produced this item.
3035
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Agent, nil]
3036
+ # The agent that produced this item.
2777
3037
  #
2778
- # @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Type, nil] The type of item to reference. Always `item_reference`.
3038
+ # @param type [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference::Type, nil]
3039
+ # The type of item to reference. Always `item_reference`.
2779
3040
 
2780
3041
  # @see OpenAI::Models::Beta::BetaResponseInputItem::ItemReference#agent
2781
3042
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -2788,7 +3049,8 @@ module OpenAI
2788
3049
  # @!method initialize(agent_name:)
2789
3050
  # The agent that produced this item.
2790
3051
  #
2791
- # @param agent_name [String] The canonical name of the agent that produced this item.
3052
+ # @param agent_name [String]
3053
+ # The canonical name of the agent that produced this item.
2792
3054
  end
2793
3055
 
2794
3056
  # The type of item to reference. Always `item_reference`.
@@ -2842,17 +3104,23 @@ module OpenAI
2842
3104
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::Program::Agent }, nil?: true
2843
3105
 
2844
3106
  # @!method initialize(id:, call_id:, code:, fingerprint:, agent: nil, type: :program)
2845
- # @param id [String] The unique ID of this program item.
3107
+ # @param id [String]
3108
+ # The unique ID of this program item.
2846
3109
  #
2847
- # @param call_id [String] The stable call ID of the program item.
3110
+ # @param call_id [String]
3111
+ # The stable call ID of the program item.
2848
3112
  #
2849
- # @param code [String] The JavaScript source executed by programmatic tool calling.
3113
+ # @param code [String]
3114
+ # The JavaScript source executed by programmatic tool calling.
2850
3115
  #
2851
- # @param fingerprint [String] Opaque program replay fingerprint that must be round-tripped.
3116
+ # @param fingerprint [String]
3117
+ # Opaque program replay fingerprint that must be round-tripped.
2852
3118
  #
2853
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Program::Agent, nil] The agent that produced this item.
3119
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::Program::Agent, nil]
3120
+ # The agent that produced this item.
2854
3121
  #
2855
- # @param type [Symbol, :program] The item type. Always `program`.
3122
+ # @param type [Symbol, :program]
3123
+ # The item type. Always `program`.
2856
3124
 
2857
3125
  # @see OpenAI::Models::Beta::BetaResponseInputItem::Program#agent
2858
3126
  class Agent < OpenAI::Internal::Type::BaseModel
@@ -2865,7 +3133,8 @@ module OpenAI
2865
3133
  # @!method initialize(agent_name:)
2866
3134
  # The agent that produced this item.
2867
3135
  #
2868
- # @param agent_name [String] The canonical name of the agent that produced this item.
3136
+ # @param agent_name [String]
3137
+ # The canonical name of the agent that produced this item.
2869
3138
  end
2870
3139
  end
2871
3140
 
@@ -2907,17 +3176,23 @@ module OpenAI
2907
3176
  optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::ProgramOutput::Agent }, nil?: true
2908
3177
 
2909
3178
  # @!method initialize(id:, call_id:, result:, status:, agent: nil, type: :program_output)
2910
- # @param id [String] The unique ID of this program output item.
3179
+ # @param id [String]
3180
+ # The unique ID of this program output item.
2911
3181
  #
2912
- # @param call_id [String] The call ID of the program item.
3182
+ # @param call_id [String]
3183
+ # The call ID of the program item.
2913
3184
  #
2914
- # @param result [String] The result produced by the program item.
3185
+ # @param result [String]
3186
+ # The result produced by the program item.
2915
3187
  #
2916
- # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Status] The terminal status of the program output.
3188
+ # @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Status]
3189
+ # The terminal status of the program output.
2917
3190
  #
2918
- # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Agent, nil] The agent that produced this item.
3191
+ # @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput::Agent, nil]
3192
+ # The agent that produced this item.
2919
3193
  #
2920
- # @param type [Symbol, :program_output] The item type. Always `program_output`.
3194
+ # @param type [Symbol, :program_output]
3195
+ # The item type. Always `program_output`.
2921
3196
 
2922
3197
  # The terminal status of the program output.
2923
3198
  #
@@ -2943,7 +3218,8 @@ module OpenAI
2943
3218
  # @!method initialize(agent_name:)
2944
3219
  # The agent that produced this item.
2945
3220
  #
2946
- # @param agent_name [String] The canonical name of the agent that produced this item.
3221
+ # @param agent_name [String]
3222
+ # The canonical name of the agent that produced this item.
2947
3223
  end
2948
3224
  end
2949
3225