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
@@ -371,19 +371,20 @@ module OpenAI
371
371
  optional :stream_id, String
372
372
 
373
373
  # @!method initialize(delta:, sequence_number:, stream_id: nil, type: :"response.audio.delta")
374
- # Some parameter documentations has been truncated, see
375
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDelta} for more
376
- # details.
377
- #
378
374
  # Emitted when there is a partial audio response.
379
375
  #
380
- # @param delta [String] A chunk of Base64 encoded response audio bytes.
376
+ # @param delta [String]
377
+ # A chunk of Base64 encoded response audio bytes.
381
378
  #
382
- # @param sequence_number [Integer] A sequence number for this chunk of the stream response.
379
+ # @param sequence_number [Integer]
380
+ # A sequence number for this chunk of the stream response.
383
381
  #
384
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
382
+ # @param stream_id [String]
383
+ # The WebSocket lane that emitted this event. This field is present when the
384
+ # originating `response.create` event supplied a `stream_id`.
385
385
  #
386
- # @param type [Symbol, :"response.audio.delta"] The type of the event. Always `response.audio.delta`.
386
+ # @param type [Symbol, :"response.audio.delta"]
387
+ # The type of the event. Always `response.audio.delta`.
387
388
  end
388
389
 
389
390
  class ResponseAudioWsDone < OpenAI::Models::Responses::ResponseAudioDoneEvent
@@ -395,17 +396,17 @@ module OpenAI
395
396
  optional :stream_id, String
396
397
 
397
398
  # @!method initialize(sequence_number:, stream_id: nil, type: :"response.audio.done")
398
- # Some parameter documentations has been truncated, see
399
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDone} for more
400
- # details.
401
- #
402
399
  # Emitted when the audio response is complete.
403
400
  #
404
- # @param sequence_number [Integer] The sequence number of the delta.
401
+ # @param sequence_number [Integer]
402
+ # The sequence number of the delta.
405
403
  #
406
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
404
+ # @param stream_id [String]
405
+ # The WebSocket lane that emitted this event. This field is present when the
406
+ # originating `response.create` event supplied a `stream_id`.
407
407
  #
408
- # @param type [Symbol, :"response.audio.done"] The type of the event. Always `response.audio.done`.
408
+ # @param type [Symbol, :"response.audio.done"]
409
+ # The type of the event. Always `response.audio.done`.
409
410
  end
410
411
 
411
412
  class ResponseAudioTranscriptWsDelta < OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent
@@ -417,19 +418,20 @@ module OpenAI
417
418
  optional :stream_id, String
418
419
 
419
420
  # @!method initialize(delta:, sequence_number:, stream_id: nil, type: :"response.audio.transcript.delta")
420
- # Some parameter documentations has been truncated, see
421
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDelta}
422
- # for more details.
423
- #
424
421
  # Emitted when there is a partial transcript of audio.
425
422
  #
426
- # @param delta [String] The partial transcript of the audio response.
423
+ # @param delta [String]
424
+ # The partial transcript of the audio response.
427
425
  #
428
- # @param sequence_number [Integer] The sequence number of this event.
426
+ # @param sequence_number [Integer]
427
+ # The sequence number of this event.
429
428
  #
430
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
429
+ # @param stream_id [String]
430
+ # The WebSocket lane that emitted this event. This field is present when the
431
+ # originating `response.create` event supplied a `stream_id`.
431
432
  #
432
- # @param type [Symbol, :"response.audio.transcript.delta"] The type of the event. Always `response.audio.transcript.delta`.
433
+ # @param type [Symbol, :"response.audio.transcript.delta"]
434
+ # The type of the event. Always `response.audio.transcript.delta`.
433
435
  end
434
436
 
435
437
  class ResponseAudioTranscriptWsDone < OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent
@@ -441,17 +443,17 @@ module OpenAI
441
443
  optional :stream_id, String
442
444
 
443
445
  # @!method initialize(sequence_number:, stream_id: nil, type: :"response.audio.transcript.done")
444
- # Some parameter documentations has been truncated, see
445
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDone}
446
- # for more details.
447
- #
448
446
  # Emitted when the full audio transcript is completed.
449
447
  #
450
- # @param sequence_number [Integer] The sequence number of this event.
448
+ # @param sequence_number [Integer]
449
+ # The sequence number of this event.
451
450
  #
452
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
451
+ # @param stream_id [String]
452
+ # The WebSocket lane that emitted this event. This field is present when the
453
+ # originating `response.create` event supplied a `stream_id`.
453
454
  #
454
- # @param type [Symbol, :"response.audio.transcript.done"] The type of the event. Always `response.audio.transcript.done`.
455
+ # @param type [Symbol, :"response.audio.transcript.done"]
456
+ # The type of the event. Always `response.audio.transcript.done`.
455
457
  end
456
458
 
457
459
  class ResponseCodeInterpreterCallCodeWsDelta < OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent
@@ -463,23 +465,27 @@ module OpenAI
463
465
  optional :stream_id, String
464
466
 
465
467
  # @!method initialize(delta:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.code_interpreter_call_code.delta")
466
- # Some parameter documentations has been truncated, see
467
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDelta}
468
- # for more details.
469
- #
470
468
  # Emitted when a partial code snippet is streamed by the code interpreter.
471
469
  #
472
- # @param delta [String] The partial code snippet being streamed by the code interpreter.
470
+ # @param delta [String]
471
+ # The partial code snippet being streamed by the code interpreter.
473
472
  #
474
- # @param item_id [String] The unique identifier of the code interpreter tool call item.
473
+ # @param item_id [String]
474
+ # The unique identifier of the code interpreter tool call item.
475
475
  #
476
- # @param output_index [Integer] The index of the output item in the response for which the code is being streame
476
+ # @param output_index [Integer]
477
+ # The index of the output item in the response for which the code is being
478
+ # streamed.
477
479
  #
478
- # @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
480
+ # @param sequence_number [Integer]
481
+ # The sequence number of this event, used to order streaming events.
479
482
  #
480
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
483
+ # @param stream_id [String]
484
+ # The WebSocket lane that emitted this event. This field is present when the
485
+ # originating `response.create` event supplied a `stream_id`.
481
486
  #
482
- # @param type [Symbol, :"response.code_interpreter_call_code.delta"] The type of the event. Always `response.code_interpreter_call_code.delta`.
487
+ # @param type [Symbol, :"response.code_interpreter_call_code.delta"]
488
+ # The type of the event. Always `response.code_interpreter_call_code.delta`.
483
489
  end
484
490
 
485
491
  class ResponseCodeInterpreterCallCodeWsDone < OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent
@@ -491,23 +497,26 @@ module OpenAI
491
497
  optional :stream_id, String
492
498
 
493
499
  # @!method initialize(code:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.code_interpreter_call_code.done")
494
- # Some parameter documentations has been truncated, see
495
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDone}
496
- # for more details.
497
- #
498
500
  # Emitted when the code snippet is finalized by the code interpreter.
499
501
  #
500
- # @param code [String] The final code snippet output by the code interpreter.
502
+ # @param code [String]
503
+ # The final code snippet output by the code interpreter.
501
504
  #
502
- # @param item_id [String] The unique identifier of the code interpreter tool call item.
505
+ # @param item_id [String]
506
+ # The unique identifier of the code interpreter tool call item.
503
507
  #
504
- # @param output_index [Integer] The index of the output item in the response for which the code is finalized.
508
+ # @param output_index [Integer]
509
+ # The index of the output item in the response for which the code is finalized.
505
510
  #
506
- # @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
511
+ # @param sequence_number [Integer]
512
+ # The sequence number of this event, used to order streaming events.
507
513
  #
508
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
514
+ # @param stream_id [String]
515
+ # The WebSocket lane that emitted this event. This field is present when the
516
+ # originating `response.create` event supplied a `stream_id`.
509
517
  #
510
- # @param type [Symbol, :"response.code_interpreter_call_code.done"] The type of the event. Always `response.code_interpreter_call_code.done`.
518
+ # @param type [Symbol, :"response.code_interpreter_call_code.done"]
519
+ # The type of the event. Always `response.code_interpreter_call_code.done`.
511
520
  end
512
521
 
513
522
  class ResponseCodeInterpreterCallWsCompleted < OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent
@@ -519,21 +528,24 @@ module OpenAI
519
528
  optional :stream_id, String
520
529
 
521
530
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.code_interpreter_call.completed")
522
- # Some parameter documentations has been truncated, see
523
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsCompleted}
524
- # for more details.
525
- #
526
531
  # Emitted when the code interpreter call is completed.
527
532
  #
528
- # @param item_id [String] The unique identifier of the code interpreter tool call item.
533
+ # @param item_id [String]
534
+ # The unique identifier of the code interpreter tool call item.
529
535
  #
530
- # @param output_index [Integer] The index of the output item in the response for which the code interpreter call
536
+ # @param output_index [Integer]
537
+ # The index of the output item in the response for which the code interpreter call
538
+ # is completed.
531
539
  #
532
- # @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
540
+ # @param sequence_number [Integer]
541
+ # The sequence number of this event, used to order streaming events.
533
542
  #
534
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
543
+ # @param stream_id [String]
544
+ # The WebSocket lane that emitted this event. This field is present when the
545
+ # originating `response.create` event supplied a `stream_id`.
535
546
  #
536
- # @param type [Symbol, :"response.code_interpreter_call.completed"] The type of the event. Always `response.code_interpreter_call.completed`.
547
+ # @param type [Symbol, :"response.code_interpreter_call.completed"]
548
+ # The type of the event. Always `response.code_interpreter_call.completed`.
537
549
  end
538
550
 
539
551
  class ResponseCodeInterpreterCallInWsProgress < OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent
@@ -545,21 +557,24 @@ module OpenAI
545
557
  optional :stream_id, String
546
558
 
547
559
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.code_interpreter_call.in_progress")
548
- # Some parameter documentations has been truncated, see
549
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallInWsProgress}
550
- # for more details.
551
- #
552
560
  # Emitted when a code interpreter call is in progress.
553
561
  #
554
- # @param item_id [String] The unique identifier of the code interpreter tool call item.
562
+ # @param item_id [String]
563
+ # The unique identifier of the code interpreter tool call item.
555
564
  #
556
- # @param output_index [Integer] The index of the output item in the response for which the code interpreter call
565
+ # @param output_index [Integer]
566
+ # The index of the output item in the response for which the code interpreter call
567
+ # is in progress.
557
568
  #
558
- # @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
569
+ # @param sequence_number [Integer]
570
+ # The sequence number of this event, used to order streaming events.
559
571
  #
560
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
572
+ # @param stream_id [String]
573
+ # The WebSocket lane that emitted this event. This field is present when the
574
+ # originating `response.create` event supplied a `stream_id`.
561
575
  #
562
- # @param type [Symbol, :"response.code_interpreter_call.in_progress"] The type of the event. Always `response.code_interpreter_call.in_progress`.
576
+ # @param type [Symbol, :"response.code_interpreter_call.in_progress"]
577
+ # The type of the event. Always `response.code_interpreter_call.in_progress`.
563
578
  end
564
579
 
565
580
  class ResponseCodeInterpreterCallWsInterpreting < OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent
@@ -571,21 +586,24 @@ module OpenAI
571
586
  optional :stream_id, String
572
587
 
573
588
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.code_interpreter_call.interpreting")
574
- # Some parameter documentations has been truncated, see
575
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsInterpreting}
576
- # for more details.
577
- #
578
589
  # Emitted when the code interpreter is actively interpreting the code snippet.
579
590
  #
580
- # @param item_id [String] The unique identifier of the code interpreter tool call item.
591
+ # @param item_id [String]
592
+ # The unique identifier of the code interpreter tool call item.
581
593
  #
582
- # @param output_index [Integer] The index of the output item in the response for which the code interpreter is i
594
+ # @param output_index [Integer]
595
+ # The index of the output item in the response for which the code interpreter is
596
+ # interpreting code.
583
597
  #
584
- # @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
598
+ # @param sequence_number [Integer]
599
+ # The sequence number of this event, used to order streaming events.
585
600
  #
586
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
601
+ # @param stream_id [String]
602
+ # The WebSocket lane that emitted this event. This field is present when the
603
+ # originating `response.create` event supplied a `stream_id`.
587
604
  #
588
- # @param type [Symbol, :"response.code_interpreter_call.interpreting"] The type of the event. Always `response.code_interpreter_call.interpreting`.
605
+ # @param type [Symbol, :"response.code_interpreter_call.interpreting"]
606
+ # The type of the event. Always `response.code_interpreter_call.interpreting`.
589
607
  end
590
608
 
591
609
  class ResponseWsCompleted < OpenAI::Models::Responses::ResponseCompletedEvent
@@ -597,19 +615,20 @@ module OpenAI
597
615
  optional :stream_id, String
598
616
 
599
617
  # @!method initialize(response:, sequence_number:, stream_id: nil, type: :"response.completed")
600
- # Some parameter documentations has been truncated, see
601
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCompleted} for more
602
- # details.
603
- #
604
618
  # Emitted when the model response is complete.
605
619
  #
606
- # @param response [OpenAI::Models::Responses::Response] Properties of the completed response.
620
+ # @param response [OpenAI::Models::Responses::Response]
621
+ # Properties of the completed response.
607
622
  #
608
- # @param sequence_number [Integer] The sequence number for this event.
623
+ # @param sequence_number [Integer]
624
+ # The sequence number for this event.
609
625
  #
610
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
626
+ # @param stream_id [String]
627
+ # The WebSocket lane that emitted this event. This field is present when the
628
+ # originating `response.create` event supplied a `stream_id`.
611
629
  #
612
- # @param type [Symbol, :"response.completed"] The type of the event. Always `response.completed`.
630
+ # @param type [Symbol, :"response.completed"]
631
+ # The type of the event. Always `response.completed`.
613
632
  end
614
633
 
615
634
  class ResponseContentPartWsAdded < OpenAI::Models::Responses::ResponseContentPartAddedEvent
@@ -621,25 +640,29 @@ module OpenAI
621
640
  optional :stream_id, String
622
641
 
623
642
  # @!method initialize(content_index:, item_id:, output_index:, part:, sequence_number:, stream_id: nil, type: :"response.content_part.added")
624
- # Some parameter documentations has been truncated, see
625
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsAdded}
626
- # for more details.
627
- #
628
643
  # Emitted when a new content part is added.
629
644
  #
630
- # @param content_index [Integer] The index of the content part that was added.
645
+ # @param content_index [Integer]
646
+ # The index of the content part that was added.
631
647
  #
632
- # @param item_id [String] The ID of the output item that the content part was added to.
648
+ # @param item_id [String]
649
+ # The ID of the output item that the content part was added to.
633
650
  #
634
- # @param output_index [Integer] The index of the output item that the content part was added to.
651
+ # @param output_index [Integer]
652
+ # The index of the output item that the content part was added to.
635
653
  #
636
- # @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartAddedEvent::Part::ReasoningText] The content part that was added.
654
+ # @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartAddedEvent::Part::ReasoningText]
655
+ # The content part that was added.
637
656
  #
638
- # @param sequence_number [Integer] The sequence number of this event.
657
+ # @param sequence_number [Integer]
658
+ # The sequence number of this event.
639
659
  #
640
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
660
+ # @param stream_id [String]
661
+ # The WebSocket lane that emitted this event. This field is present when the
662
+ # originating `response.create` event supplied a `stream_id`.
641
663
  #
642
- # @param type [Symbol, :"response.content_part.added"] The type of the event. Always `response.content_part.added`.
664
+ # @param type [Symbol, :"response.content_part.added"]
665
+ # The type of the event. Always `response.content_part.added`.
643
666
  end
644
667
 
645
668
  class ResponseContentPartWsDone < OpenAI::Models::Responses::ResponseContentPartDoneEvent
@@ -651,25 +674,29 @@ module OpenAI
651
674
  optional :stream_id, String
652
675
 
653
676
  # @!method initialize(content_index:, item_id:, output_index:, part:, sequence_number:, stream_id: nil, type: :"response.content_part.done")
654
- # Some parameter documentations has been truncated, see
655
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsDone} for
656
- # more details.
657
- #
658
677
  # Emitted when a content part is done.
659
678
  #
660
- # @param content_index [Integer] The index of the content part that is done.
679
+ # @param content_index [Integer]
680
+ # The index of the content part that is done.
661
681
  #
662
- # @param item_id [String] The ID of the output item that the content part was added to.
682
+ # @param item_id [String]
683
+ # The ID of the output item that the content part was added to.
663
684
  #
664
- # @param output_index [Integer] The index of the output item that the content part was added to.
685
+ # @param output_index [Integer]
686
+ # The index of the output item that the content part was added to.
665
687
  #
666
- # @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartDoneEvent::Part::ReasoningText] The content part that is done.
688
+ # @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartDoneEvent::Part::ReasoningText]
689
+ # The content part that is done.
667
690
  #
668
- # @param sequence_number [Integer] The sequence number of this event.
691
+ # @param sequence_number [Integer]
692
+ # The sequence number of this event.
669
693
  #
670
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
694
+ # @param stream_id [String]
695
+ # The WebSocket lane that emitted this event. This field is present when the
696
+ # originating `response.create` event supplied a `stream_id`.
671
697
  #
672
- # @param type [Symbol, :"response.content_part.done"] The type of the event. Always `response.content_part.done`.
698
+ # @param type [Symbol, :"response.content_part.done"]
699
+ # The type of the event. Always `response.content_part.done`.
673
700
  end
674
701
 
675
702
  class ResponseWsCreated < OpenAI::Models::Responses::ResponseCreatedEvent
@@ -681,19 +708,20 @@ module OpenAI
681
708
  optional :stream_id, String
682
709
 
683
710
  # @!method initialize(response:, sequence_number:, stream_id: nil, type: :"response.created")
684
- # Some parameter documentations has been truncated, see
685
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCreated} for more
686
- # details.
687
- #
688
711
  # An event that is emitted when a response is created.
689
712
  #
690
- # @param response [OpenAI::Models::Responses::Response] The response that was created.
713
+ # @param response [OpenAI::Models::Responses::Response]
714
+ # The response that was created.
691
715
  #
692
- # @param sequence_number [Integer] The sequence number for this event.
716
+ # @param sequence_number [Integer]
717
+ # The sequence number for this event.
693
718
  #
694
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
719
+ # @param stream_id [String]
720
+ # The WebSocket lane that emitted this event. This field is present when the
721
+ # originating `response.create` event supplied a `stream_id`.
695
722
  #
696
- # @param type [Symbol, :"response.created"] The type of the event. Always `response.created`.
723
+ # @param type [Symbol, :"response.created"]
724
+ # The type of the event. Always `response.created`.
697
725
  end
698
726
 
699
727
  class ResponseFileSearchCallWsCompleted < OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent
@@ -705,21 +733,23 @@ module OpenAI
705
733
  optional :stream_id, String
706
734
 
707
735
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.file_search_call.completed")
708
- # Some parameter documentations has been truncated, see
709
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsCompleted}
710
- # for more details.
711
- #
712
736
  # Emitted when a file search call is completed (results found).
713
737
  #
714
- # @param item_id [String] The ID of the output item that the file search call is initiated.
738
+ # @param item_id [String]
739
+ # The ID of the output item that the file search call is initiated.
715
740
  #
716
- # @param output_index [Integer] The index of the output item that the file search call is initiated.
741
+ # @param output_index [Integer]
742
+ # The index of the output item that the file search call is initiated.
717
743
  #
718
- # @param sequence_number [Integer] The sequence number of this event.
744
+ # @param sequence_number [Integer]
745
+ # The sequence number of this event.
719
746
  #
720
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
747
+ # @param stream_id [String]
748
+ # The WebSocket lane that emitted this event. This field is present when the
749
+ # originating `response.create` event supplied a `stream_id`.
721
750
  #
722
- # @param type [Symbol, :"response.file_search_call.completed"] The type of the event. Always `response.file_search_call.completed`.
751
+ # @param type [Symbol, :"response.file_search_call.completed"]
752
+ # The type of the event. Always `response.file_search_call.completed`.
723
753
  end
724
754
 
725
755
  class ResponseFileSearchCallInWsProgress < OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent
@@ -731,21 +761,23 @@ module OpenAI
731
761
  optional :stream_id, String
732
762
 
733
763
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.file_search_call.in_progress")
734
- # Some parameter documentations has been truncated, see
735
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallInWsProgress}
736
- # for more details.
737
- #
738
764
  # Emitted when a file search call is initiated.
739
765
  #
740
- # @param item_id [String] The ID of the output item that the file search call is initiated.
766
+ # @param item_id [String]
767
+ # The ID of the output item that the file search call is initiated.
741
768
  #
742
- # @param output_index [Integer] The index of the output item that the file search call is initiated.
769
+ # @param output_index [Integer]
770
+ # The index of the output item that the file search call is initiated.
743
771
  #
744
- # @param sequence_number [Integer] The sequence number of this event.
772
+ # @param sequence_number [Integer]
773
+ # The sequence number of this event.
745
774
  #
746
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
775
+ # @param stream_id [String]
776
+ # The WebSocket lane that emitted this event. This field is present when the
777
+ # originating `response.create` event supplied a `stream_id`.
747
778
  #
748
- # @param type [Symbol, :"response.file_search_call.in_progress"] The type of the event. Always `response.file_search_call.in_progress`.
779
+ # @param type [Symbol, :"response.file_search_call.in_progress"]
780
+ # The type of the event. Always `response.file_search_call.in_progress`.
749
781
  end
750
782
 
751
783
  class ResponseFileSearchCallWsSearching < OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent
@@ -757,21 +789,23 @@ module OpenAI
757
789
  optional :stream_id, String
758
790
 
759
791
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.file_search_call.searching")
760
- # Some parameter documentations has been truncated, see
761
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsSearching}
762
- # for more details.
763
- #
764
792
  # Emitted when a file search is currently searching.
765
793
  #
766
- # @param item_id [String] The ID of the output item that the file search call is initiated.
794
+ # @param item_id [String]
795
+ # The ID of the output item that the file search call is initiated.
767
796
  #
768
- # @param output_index [Integer] The index of the output item that the file search call is searching.
797
+ # @param output_index [Integer]
798
+ # The index of the output item that the file search call is searching.
769
799
  #
770
- # @param sequence_number [Integer] The sequence number of this event.
800
+ # @param sequence_number [Integer]
801
+ # The sequence number of this event.
771
802
  #
772
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
803
+ # @param stream_id [String]
804
+ # The WebSocket lane that emitted this event. This field is present when the
805
+ # originating `response.create` event supplied a `stream_id`.
773
806
  #
774
- # @param type [Symbol, :"response.file_search_call.searching"] The type of the event. Always `response.file_search_call.searching`.
807
+ # @param type [Symbol, :"response.file_search_call.searching"]
808
+ # The type of the event. Always `response.file_search_call.searching`.
775
809
  end
776
810
 
777
811
  class ResponseFunctionCallArgumentsWsDelta < OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent
@@ -783,23 +817,26 @@ module OpenAI
783
817
  optional :stream_id, String
784
818
 
785
819
  # @!method initialize(delta:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.function_call_arguments.delta")
786
- # Some parameter documentations has been truncated, see
787
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDelta}
788
- # for more details.
789
- #
790
820
  # Emitted when there is a partial function-call arguments delta.
791
821
  #
792
- # @param delta [String] The function-call arguments delta that is added.
822
+ # @param delta [String]
823
+ # The function-call arguments delta that is added.
793
824
  #
794
- # @param item_id [String] The ID of the output item that the function-call arguments delta is added to.
825
+ # @param item_id [String]
826
+ # The ID of the output item that the function-call arguments delta is added to.
795
827
  #
796
- # @param output_index [Integer] The index of the output item that the function-call arguments delta is added to.
828
+ # @param output_index [Integer]
829
+ # The index of the output item that the function-call arguments delta is added to.
797
830
  #
798
- # @param sequence_number [Integer] The sequence number of this event.
831
+ # @param sequence_number [Integer]
832
+ # The sequence number of this event.
799
833
  #
800
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
834
+ # @param stream_id [String]
835
+ # The WebSocket lane that emitted this event. This field is present when the
836
+ # originating `response.create` event supplied a `stream_id`.
801
837
  #
802
- # @param type [Symbol, :"response.function_call_arguments.delta"] The type of the event. Always `response.function_call_arguments.delta`.
838
+ # @param type [Symbol, :"response.function_call_arguments.delta"]
839
+ # The type of the event. Always `response.function_call_arguments.delta`.
803
840
  end
804
841
 
805
842
  class ResponseFunctionCallArgumentsWsDone < OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent
@@ -811,21 +848,23 @@ module OpenAI
811
848
  optional :stream_id, String
812
849
 
813
850
  # @!method initialize(arguments:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.function_call_arguments.done")
814
- # Some parameter documentations has been truncated, see
815
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDone}
816
- # for more details.
817
- #
818
851
  # Emitted when function-call arguments are finalized.
819
852
  #
820
- # @param arguments [String] The function-call arguments.
853
+ # @param arguments [String]
854
+ # The function-call arguments.
821
855
  #
822
- # @param item_id [String] The ID of the item.
856
+ # @param item_id [String]
857
+ # The ID of the item.
823
858
  #
824
- # @param output_index [Integer] The index of the output item.
859
+ # @param output_index [Integer]
860
+ # The index of the output item.
825
861
  #
826
- # @param sequence_number [Integer] The sequence number of this event.
862
+ # @param sequence_number [Integer]
863
+ # The sequence number of this event.
827
864
  #
828
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
865
+ # @param stream_id [String]
866
+ # The WebSocket lane that emitted this event. This field is present when the
867
+ # originating `response.create` event supplied a `stream_id`.
829
868
  #
830
869
  # @param type [Symbol, :"response.function_call_arguments.done"]
831
870
  end
@@ -839,23 +878,26 @@ module OpenAI
839
878
  optional :stream_id, String
840
879
 
841
880
  # @!method initialize(command:, command_index:, output_index:, sequence_number:, stream_id: nil, type: :"response.shell_call_command.added")
842
- # Some parameter documentations has been truncated, see
843
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsAdded}
844
- # for more details.
845
- #
846
881
  # A streaming event that indicated a shell command was added to a tool call.
847
882
  #
848
- # @param command [String] The shell command that was added.
883
+ # @param command [String]
884
+ # The shell command that was added.
849
885
  #
850
- # @param command_index [Integer] The index of the shell command that was added.
886
+ # @param command_index [Integer]
887
+ # The index of the shell command that was added.
851
888
  #
852
- # @param output_index [Integer] The index of the output item that was updated.
889
+ # @param output_index [Integer]
890
+ # The index of the output item that was updated.
853
891
  #
854
- # @param sequence_number [Integer] The sequence number of the event that was emitted.
892
+ # @param sequence_number [Integer]
893
+ # The sequence number of the event that was emitted.
855
894
  #
856
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
895
+ # @param stream_id [String]
896
+ # The WebSocket lane that emitted this event. This field is present when the
897
+ # originating `response.create` event supplied a `stream_id`.
857
898
  #
858
- # @param type [Symbol, :"response.shell_call_command.added"] The type of the event, always `response.shell_call_command.added`.
899
+ # @param type [Symbol, :"response.shell_call_command.added"]
900
+ # The type of the event, always `response.shell_call_command.added`.
859
901
  end
860
902
 
861
903
  class ResponseShellCallCommandWsDelta < OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent
@@ -867,25 +909,29 @@ module OpenAI
867
909
  optional :stream_id, String
868
910
 
869
911
  # @!method initialize(command_index:, delta:, output_index:, sequence_number:, obfuscation: nil, stream_id: nil, type: :"response.shell_call_command.delta")
870
- # Some parameter documentations has been truncated, see
871
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsDelta}
872
- # for more details.
873
- #
874
912
  # A streaming event that indicated a shell command was incrementally updated.
875
913
  #
876
- # @param command_index [Integer] The index of the shell command that was updated.
914
+ # @param command_index [Integer]
915
+ # The index of the shell command that was updated.
877
916
  #
878
- # @param delta [String] The shell command delta that was appended.
917
+ # @param delta [String]
918
+ # The shell command delta that was appended.
879
919
  #
880
- # @param output_index [Integer] The index of the output item that was updated.
920
+ # @param output_index [Integer]
921
+ # The index of the output item that was updated.
881
922
  #
882
- # @param sequence_number [Integer] The sequence number of the event that was emitted.
923
+ # @param sequence_number [Integer]
924
+ # The sequence number of the event that was emitted.
883
925
  #
884
- # @param obfuscation [String] An obfuscation string that was added to pad the event payload.
926
+ # @param obfuscation [String]
927
+ # An obfuscation string that was added to pad the event payload.
885
928
  #
886
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
929
+ # @param stream_id [String]
930
+ # The WebSocket lane that emitted this event. This field is present when the
931
+ # originating `response.create` event supplied a `stream_id`.
887
932
  #
888
- # @param type [Symbol, :"response.shell_call_command.delta"] The type of the event, always `response.shell_call_command.delta`.
933
+ # @param type [Symbol, :"response.shell_call_command.delta"]
934
+ # The type of the event, always `response.shell_call_command.delta`.
889
935
  end
890
936
 
891
937
  class ResponseShellCallCommandWsDone < OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent
@@ -897,23 +943,26 @@ module OpenAI
897
943
  optional :stream_id, String
898
944
 
899
945
  # @!method initialize(command:, command_index:, output_index:, sequence_number:, stream_id: nil, type: :"response.shell_call_command.done")
900
- # Some parameter documentations has been truncated, see
901
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallCommandWsDone}
902
- # for more details.
903
- #
904
946
  # A streaming event that indicated a shell command was completed.
905
947
  #
906
- # @param command [String] The final shell command that was emitted.
948
+ # @param command [String]
949
+ # The final shell command that was emitted.
907
950
  #
908
- # @param command_index [Integer] The index of the shell command that was completed.
951
+ # @param command_index [Integer]
952
+ # The index of the shell command that was completed.
909
953
  #
910
- # @param output_index [Integer] The index of the output item that was updated.
954
+ # @param output_index [Integer]
955
+ # The index of the output item that was updated.
911
956
  #
912
- # @param sequence_number [Integer] The sequence number of the event that was emitted.
957
+ # @param sequence_number [Integer]
958
+ # The sequence number of the event that was emitted.
913
959
  #
914
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
960
+ # @param stream_id [String]
961
+ # The WebSocket lane that emitted this event. This field is present when the
962
+ # originating `response.create` event supplied a `stream_id`.
915
963
  #
916
- # @param type [Symbol, :"response.shell_call_command.done"] The type of the event, always `response.shell_call_command.done`.
964
+ # @param type [Symbol, :"response.shell_call_command.done"]
965
+ # The type of the event, always `response.shell_call_command.done`.
917
966
  end
918
967
 
919
968
  class ResponseShellCallOutputContentWsDelta < OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent
@@ -925,25 +974,29 @@ module OpenAI
925
974
  optional :stream_id, String
926
975
 
927
976
  # @!method initialize(command_index:, delta:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.shell_call_output_content.delta")
928
- # Some parameter documentations has been truncated, see
929
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallOutputContentWsDelta}
930
- # for more details.
931
- #
932
977
  # A streaming event that indicated shell call output was incrementally added.
933
978
  #
934
- # @param command_index [Integer] The index of the shell command that produced output.
979
+ # @param command_index [Integer]
980
+ # The index of the shell command that produced output.
935
981
  #
936
- # @param delta [OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent::Delta] The stdout/stderr delta that was emitted.
982
+ # @param delta [OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent::Delta]
983
+ # The stdout/stderr delta that was emitted.
937
984
  #
938
- # @param item_id [String] The ID of the output item that was updated.
985
+ # @param item_id [String]
986
+ # The ID of the output item that was updated.
939
987
  #
940
- # @param output_index [Integer] The index of the output item that was updated.
988
+ # @param output_index [Integer]
989
+ # The index of the output item that was updated.
941
990
  #
942
- # @param sequence_number [Integer] The sequence number of the event that was emitted.
991
+ # @param sequence_number [Integer]
992
+ # The sequence number of the event that was emitted.
943
993
  #
944
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
994
+ # @param stream_id [String]
995
+ # The WebSocket lane that emitted this event. This field is present when the
996
+ # originating `response.create` event supplied a `stream_id`.
945
997
  #
946
- # @param type [Symbol, :"response.shell_call_output_content.delta"] The type of the event, always `response.shell_call_output_content.delta`.
998
+ # @param type [Symbol, :"response.shell_call_output_content.delta"]
999
+ # The type of the event, always `response.shell_call_output_content.delta`.
947
1000
  end
948
1001
 
949
1002
  class ResponseShellCallOutputContentWsDone < OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent
@@ -955,25 +1008,29 @@ module OpenAI
955
1008
  optional :stream_id, String
956
1009
 
957
1010
  # @!method initialize(command_index:, item_id:, output:, output_index:, sequence_number:, stream_id: nil, type: :"response.shell_call_output_content.done")
958
- # Some parameter documentations has been truncated, see
959
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseShellCallOutputContentWsDone}
960
- # for more details.
961
- #
962
1011
  # A streaming event that indicated shell call output was completed.
963
1012
  #
964
- # @param command_index [Integer] The index of the shell command that produced output.
1013
+ # @param command_index [Integer]
1014
+ # The index of the shell command that produced output.
965
1015
  #
966
- # @param item_id [String] The ID of the output item that was updated.
1016
+ # @param item_id [String]
1017
+ # The ID of the output item that was updated.
967
1018
  #
968
- # @param output [Array<OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent::Output>] The output contents emitted for the shell command.
1019
+ # @param output [Array<OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent::Output>]
1020
+ # The output contents emitted for the shell command.
969
1021
  #
970
- # @param output_index [Integer] The index of the output item that was updated.
1022
+ # @param output_index [Integer]
1023
+ # The index of the output item that was updated.
971
1024
  #
972
- # @param sequence_number [Integer] The sequence number of the event that was emitted.
1025
+ # @param sequence_number [Integer]
1026
+ # The sequence number of the event that was emitted.
973
1027
  #
974
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1028
+ # @param stream_id [String]
1029
+ # The WebSocket lane that emitted this event. This field is present when the
1030
+ # originating `response.create` event supplied a `stream_id`.
975
1031
  #
976
- # @param type [Symbol, :"response.shell_call_output_content.done"] The type of the event, always `response.shell_call_output_content.done`.
1032
+ # @param type [Symbol, :"response.shell_call_output_content.done"]
1033
+ # The type of the event, always `response.shell_call_output_content.done`.
977
1034
  end
978
1035
 
979
1036
  class ResponseInWsProgress < OpenAI::Models::Responses::ResponseInProgressEvent
@@ -985,19 +1042,20 @@ module OpenAI
985
1042
  optional :stream_id, String
986
1043
 
987
1044
  # @!method initialize(response:, sequence_number:, stream_id: nil, type: :"response.in_progress")
988
- # Some parameter documentations has been truncated, see
989
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseInWsProgress} for more
990
- # details.
991
- #
992
1045
  # Emitted when the response is in progress.
993
1046
  #
994
- # @param response [OpenAI::Models::Responses::Response] The response that is in progress.
1047
+ # @param response [OpenAI::Models::Responses::Response]
1048
+ # The response that is in progress.
995
1049
  #
996
- # @param sequence_number [Integer] The sequence number of this event.
1050
+ # @param sequence_number [Integer]
1051
+ # The sequence number of this event.
997
1052
  #
998
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1053
+ # @param stream_id [String]
1054
+ # The WebSocket lane that emitted this event. This field is present when the
1055
+ # originating `response.create` event supplied a `stream_id`.
999
1056
  #
1000
- # @param type [Symbol, :"response.in_progress"] The type of the event. Always `response.in_progress`.
1057
+ # @param type [Symbol, :"response.in_progress"]
1058
+ # The type of the event. Always `response.in_progress`.
1001
1059
  end
1002
1060
 
1003
1061
  class ResponseWsFailed < OpenAI::Models::Responses::ResponseFailedEvent
@@ -1009,19 +1067,20 @@ module OpenAI
1009
1067
  optional :stream_id, String
1010
1068
 
1011
1069
  # @!method initialize(response:, sequence_number:, stream_id: nil, type: :"response.failed")
1012
- # Some parameter documentations has been truncated, see
1013
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsFailed} for more
1014
- # details.
1015
- #
1016
1070
  # An event that is emitted when a response fails.
1017
1071
  #
1018
- # @param response [OpenAI::Models::Responses::Response] The response that failed.
1072
+ # @param response [OpenAI::Models::Responses::Response]
1073
+ # The response that failed.
1019
1074
  #
1020
- # @param sequence_number [Integer] The sequence number of this event.
1075
+ # @param sequence_number [Integer]
1076
+ # The sequence number of this event.
1021
1077
  #
1022
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1078
+ # @param stream_id [String]
1079
+ # The WebSocket lane that emitted this event. This field is present when the
1080
+ # originating `response.create` event supplied a `stream_id`.
1023
1081
  #
1024
- # @param type [Symbol, :"response.failed"] The type of the event. Always `response.failed`.
1082
+ # @param type [Symbol, :"response.failed"]
1083
+ # The type of the event. Always `response.failed`.
1025
1084
  end
1026
1085
 
1027
1086
  class ResponseWsIncomplete < OpenAI::Models::Responses::ResponseIncompleteEvent
@@ -1033,23 +1092,24 @@ module OpenAI
1033
1092
  optional :stream_id, String
1034
1093
 
1035
1094
  # @!method initialize(response:, sequence_number:, stream_id: nil, type: :"response.incomplete")
1036
- # Some parameter documentations has been truncated, see
1037
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsIncomplete} for more
1038
- # details.
1039
- #
1040
1095
  # An event that is emitted when a response finishes as incomplete.
1041
1096
  #
1042
1097
  # Over WebSocket, steering can finish a response with
1043
1098
  # `response.incomplete_details.reason` set to `steered`, followed automatically by
1044
1099
  # a successor `response.created` that commits the queued steering input.
1045
1100
  #
1046
- # @param response [OpenAI::Models::Responses::Response] The response that was incomplete.
1101
+ # @param response [OpenAI::Models::Responses::Response]
1102
+ # The response that was incomplete.
1047
1103
  #
1048
- # @param sequence_number [Integer] The sequence number of this event.
1104
+ # @param sequence_number [Integer]
1105
+ # The sequence number of this event.
1049
1106
  #
1050
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1107
+ # @param stream_id [String]
1108
+ # The WebSocket lane that emitted this event. This field is present when the
1109
+ # originating `response.create` event supplied a `stream_id`.
1051
1110
  #
1052
- # @param type [Symbol, :"response.incomplete"] The type of the event. Always `response.incomplete`.
1111
+ # @param type [Symbol, :"response.incomplete"]
1112
+ # The type of the event. Always `response.incomplete`.
1053
1113
  end
1054
1114
 
1055
1115
  class ResponseOutputItemWsAdded < OpenAI::Models::Responses::ResponseOutputItemAddedEvent
@@ -1061,21 +1121,26 @@ module OpenAI
1061
1121
  optional :stream_id, String
1062
1122
 
1063
1123
  # @!method initialize(item:, output_index:, sequence_number:, stream_id: nil, type: :"response.output_item.added")
1064
- # Some parameter documentations has been truncated, see
1065
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsAdded} for
1066
- # more details.
1067
- #
1068
1124
  # Emitted when a new output item is added.
1069
1125
  #
1070
- # @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem] The output item that was added. For reasoning items, `encrypted_content`
1126
+ # @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem]
1127
+ # The output item that was added. For reasoning items, `encrypted_content` may be
1128
+ # incomplete while the item is in progress. Use the reasoning item from the
1129
+ # corresponding `response.output_item.done` event when passing it as input to a
1130
+ # subsequent request.
1071
1131
  #
1072
- # @param output_index [Integer] The index of the output item that was added.
1132
+ # @param output_index [Integer]
1133
+ # The index of the output item that was added.
1073
1134
  #
1074
- # @param sequence_number [Integer] The sequence number of this event.
1135
+ # @param sequence_number [Integer]
1136
+ # The sequence number of this event.
1075
1137
  #
1076
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1138
+ # @param stream_id [String]
1139
+ # The WebSocket lane that emitted this event. This field is present when the
1140
+ # originating `response.create` event supplied a `stream_id`.
1077
1141
  #
1078
- # @param type [Symbol, :"response.output_item.added"] The type of the event. Always `response.output_item.added`.
1142
+ # @param type [Symbol, :"response.output_item.added"]
1143
+ # The type of the event. Always `response.output_item.added`.
1079
1144
  end
1080
1145
 
1081
1146
  class ResponseOutputItemWsDone < OpenAI::Models::Responses::ResponseOutputItemDoneEvent
@@ -1087,21 +1152,23 @@ module OpenAI
1087
1152
  optional :stream_id, String
1088
1153
 
1089
1154
  # @!method initialize(item:, output_index:, sequence_number:, stream_id: nil, type: :"response.output_item.done")
1090
- # Some parameter documentations has been truncated, see
1091
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsDone} for
1092
- # more details.
1093
- #
1094
1155
  # Emitted when an output item is marked done.
1095
1156
  #
1096
- # @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem] The output item that was marked done.
1157
+ # @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem]
1158
+ # The output item that was marked done.
1097
1159
  #
1098
- # @param output_index [Integer] The index of the output item that was marked done.
1160
+ # @param output_index [Integer]
1161
+ # The index of the output item that was marked done.
1099
1162
  #
1100
- # @param sequence_number [Integer] The sequence number of this event.
1163
+ # @param sequence_number [Integer]
1164
+ # The sequence number of this event.
1101
1165
  #
1102
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1166
+ # @param stream_id [String]
1167
+ # The WebSocket lane that emitted this event. This field is present when the
1168
+ # originating `response.create` event supplied a `stream_id`.
1103
1169
  #
1104
- # @param type [Symbol, :"response.output_item.done"] The type of the event. Always `response.output_item.done`.
1170
+ # @param type [Symbol, :"response.output_item.done"]
1171
+ # The type of the event. Always `response.output_item.done`.
1105
1172
  end
1106
1173
 
1107
1174
  class ResponseReasoningSummaryPartWsAdded < OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent
@@ -1113,25 +1180,29 @@ module OpenAI
1113
1180
  optional :stream_id, String
1114
1181
 
1115
1182
  # @!method initialize(item_id:, output_index:, part:, sequence_number:, summary_index:, stream_id: nil, type: :"response.reasoning_summary_part.added")
1116
- # Some parameter documentations has been truncated, see
1117
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsAdded}
1118
- # for more details.
1119
- #
1120
1183
  # Emitted when a new reasoning summary part is added.
1121
1184
  #
1122
- # @param item_id [String] The ID of the item this summary part is associated with.
1185
+ # @param item_id [String]
1186
+ # The ID of the item this summary part is associated with.
1123
1187
  #
1124
- # @param output_index [Integer] The index of the output item this summary part is associated with.
1188
+ # @param output_index [Integer]
1189
+ # The index of the output item this summary part is associated with.
1125
1190
  #
1126
- # @param part [OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent::Part] The summary part that was added.
1191
+ # @param part [OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent::Part]
1192
+ # The summary part that was added.
1127
1193
  #
1128
- # @param sequence_number [Integer] The sequence number of this event.
1194
+ # @param sequence_number [Integer]
1195
+ # The sequence number of this event.
1129
1196
  #
1130
- # @param summary_index [Integer] The index of the summary part within the reasoning summary.
1197
+ # @param summary_index [Integer]
1198
+ # The index of the summary part within the reasoning summary.
1131
1199
  #
1132
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1200
+ # @param stream_id [String]
1201
+ # The WebSocket lane that emitted this event. This field is present when the
1202
+ # originating `response.create` event supplied a `stream_id`.
1133
1203
  #
1134
- # @param type [Symbol, :"response.reasoning_summary_part.added"] The type of the event. Always `response.reasoning_summary_part.added`.
1204
+ # @param type [Symbol, :"response.reasoning_summary_part.added"]
1205
+ # The type of the event. Always `response.reasoning_summary_part.added`.
1135
1206
  end
1136
1207
 
1137
1208
  class ResponseReasoningSummaryPartWsDone < OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent
@@ -1143,27 +1214,33 @@ module OpenAI
1143
1214
  optional :stream_id, String
1144
1215
 
1145
1216
  # @!method initialize(item_id:, output_index:, part:, sequence_number:, summary_index:, status: nil, stream_id: nil, type: :"response.reasoning_summary_part.done")
1146
- # Some parameter documentations has been truncated, see
1147
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsDone}
1148
- # for more details.
1149
- #
1150
1217
  # Emitted when a reasoning summary part is completed.
1151
1218
  #
1152
- # @param item_id [String] The ID of the item this summary part is associated with.
1219
+ # @param item_id [String]
1220
+ # The ID of the item this summary part is associated with.
1153
1221
  #
1154
- # @param output_index [Integer] The index of the output item this summary part is associated with.
1222
+ # @param output_index [Integer]
1223
+ # The index of the output item this summary part is associated with.
1155
1224
  #
1156
- # @param part [OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent::Part] The completed summary part.
1225
+ # @param part [OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent::Part]
1226
+ # The completed summary part.
1157
1227
  #
1158
- # @param sequence_number [Integer] The sequence number of this event.
1228
+ # @param sequence_number [Integer]
1229
+ # The sequence number of this event.
1159
1230
  #
1160
- # @param summary_index [Integer] The index of the summary part within the reasoning summary.
1231
+ # @param summary_index [Integer]
1232
+ # The index of the summary part within the reasoning summary.
1161
1233
  #
1162
- # @param status [Symbol, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent::Status] The completion status of the summary part. Omitted when the part completed
1234
+ # @param status [Symbol, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent::Status]
1235
+ # The completion status of the summary part. Omitted when the part completed
1236
+ # normally and set to `incomplete` when generation was interrupted.
1163
1237
  #
1164
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1238
+ # @param stream_id [String]
1239
+ # The WebSocket lane that emitted this event. This field is present when the
1240
+ # originating `response.create` event supplied a `stream_id`.
1165
1241
  #
1166
- # @param type [Symbol, :"response.reasoning_summary_part.done"] The type of the event. Always `response.reasoning_summary_part.done`.
1242
+ # @param type [Symbol, :"response.reasoning_summary_part.done"]
1243
+ # The type of the event. Always `response.reasoning_summary_part.done`.
1167
1244
  end
1168
1245
 
1169
1246
  class ResponseReasoningSummaryTextWsDelta < OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent
@@ -1175,25 +1252,29 @@ module OpenAI
1175
1252
  optional :stream_id, String
1176
1253
 
1177
1254
  # @!method initialize(delta:, item_id:, output_index:, sequence_number:, summary_index:, stream_id: nil, type: :"response.reasoning_summary_text.delta")
1178
- # Some parameter documentations has been truncated, see
1179
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDelta}
1180
- # for more details.
1181
- #
1182
1255
  # Emitted when a delta is added to a reasoning summary text.
1183
1256
  #
1184
- # @param delta [String] The text delta that was added to the summary.
1257
+ # @param delta [String]
1258
+ # The text delta that was added to the summary.
1185
1259
  #
1186
- # @param item_id [String] The ID of the item this summary text delta is associated with.
1260
+ # @param item_id [String]
1261
+ # The ID of the item this summary text delta is associated with.
1187
1262
  #
1188
- # @param output_index [Integer] The index of the output item this summary text delta is associated with.
1263
+ # @param output_index [Integer]
1264
+ # The index of the output item this summary text delta is associated with.
1189
1265
  #
1190
- # @param sequence_number [Integer] The sequence number of this event.
1266
+ # @param sequence_number [Integer]
1267
+ # The sequence number of this event.
1191
1268
  #
1192
- # @param summary_index [Integer] The index of the summary part within the reasoning summary.
1269
+ # @param summary_index [Integer]
1270
+ # The index of the summary part within the reasoning summary.
1193
1271
  #
1194
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1272
+ # @param stream_id [String]
1273
+ # The WebSocket lane that emitted this event. This field is present when the
1274
+ # originating `response.create` event supplied a `stream_id`.
1195
1275
  #
1196
- # @param type [Symbol, :"response.reasoning_summary_text.delta"] The type of the event. Always `response.reasoning_summary_text.delta`.
1276
+ # @param type [Symbol, :"response.reasoning_summary_text.delta"]
1277
+ # The type of the event. Always `response.reasoning_summary_text.delta`.
1197
1278
  end
1198
1279
 
1199
1280
  class ResponseReasoningSummaryTextWsDone < OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent
@@ -1205,25 +1286,29 @@ module OpenAI
1205
1286
  optional :stream_id, String
1206
1287
 
1207
1288
  # @!method initialize(item_id:, output_index:, sequence_number:, summary_index:, text:, stream_id: nil, type: :"response.reasoning_summary_text.done")
1208
- # Some parameter documentations has been truncated, see
1209
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDone}
1210
- # for more details.
1211
- #
1212
1289
  # Emitted when a reasoning summary text is completed.
1213
1290
  #
1214
- # @param item_id [String] The ID of the item this summary text is associated with.
1291
+ # @param item_id [String]
1292
+ # The ID of the item this summary text is associated with.
1215
1293
  #
1216
- # @param output_index [Integer] The index of the output item this summary text is associated with.
1294
+ # @param output_index [Integer]
1295
+ # The index of the output item this summary text is associated with.
1217
1296
  #
1218
- # @param sequence_number [Integer] The sequence number of this event.
1297
+ # @param sequence_number [Integer]
1298
+ # The sequence number of this event.
1219
1299
  #
1220
- # @param summary_index [Integer] The index of the summary part within the reasoning summary.
1300
+ # @param summary_index [Integer]
1301
+ # The index of the summary part within the reasoning summary.
1221
1302
  #
1222
- # @param text [String] The full text of the completed reasoning summary.
1303
+ # @param text [String]
1304
+ # The full text of the completed reasoning summary.
1223
1305
  #
1224
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1306
+ # @param stream_id [String]
1307
+ # The WebSocket lane that emitted this event. This field is present when the
1308
+ # originating `response.create` event supplied a `stream_id`.
1225
1309
  #
1226
- # @param type [Symbol, :"response.reasoning_summary_text.done"] The type of the event. Always `response.reasoning_summary_text.done`.
1310
+ # @param type [Symbol, :"response.reasoning_summary_text.done"]
1311
+ # The type of the event. Always `response.reasoning_summary_text.done`.
1227
1312
  end
1228
1313
 
1229
1314
  class ResponseReasoningTextWsDelta < OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent
@@ -1235,25 +1320,29 @@ module OpenAI
1235
1320
  optional :stream_id, String
1236
1321
 
1237
1322
  # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.reasoning_text.delta")
1238
- # Some parameter documentations has been truncated, see
1239
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDelta}
1240
- # for more details.
1241
- #
1242
1323
  # Emitted when a delta is added to a reasoning text.
1243
1324
  #
1244
- # @param content_index [Integer] The index of the reasoning content part this delta is associated with.
1325
+ # @param content_index [Integer]
1326
+ # The index of the reasoning content part this delta is associated with.
1245
1327
  #
1246
- # @param delta [String] The text delta that was added to the reasoning content.
1328
+ # @param delta [String]
1329
+ # The text delta that was added to the reasoning content.
1247
1330
  #
1248
- # @param item_id [String] The ID of the item this reasoning text delta is associated with.
1331
+ # @param item_id [String]
1332
+ # The ID of the item this reasoning text delta is associated with.
1249
1333
  #
1250
- # @param output_index [Integer] The index of the output item this reasoning text delta is associated with.
1334
+ # @param output_index [Integer]
1335
+ # The index of the output item this reasoning text delta is associated with.
1251
1336
  #
1252
- # @param sequence_number [Integer] The sequence number of this event.
1337
+ # @param sequence_number [Integer]
1338
+ # The sequence number of this event.
1253
1339
  #
1254
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1340
+ # @param stream_id [String]
1341
+ # The WebSocket lane that emitted this event. This field is present when the
1342
+ # originating `response.create` event supplied a `stream_id`.
1255
1343
  #
1256
- # @param type [Symbol, :"response.reasoning_text.delta"] The type of the event. Always `response.reasoning_text.delta`.
1344
+ # @param type [Symbol, :"response.reasoning_text.delta"]
1345
+ # The type of the event. Always `response.reasoning_text.delta`.
1257
1346
  end
1258
1347
 
1259
1348
  class ResponseReasoningTextWsDone < OpenAI::Models::Responses::ResponseReasoningTextDoneEvent
@@ -1265,25 +1354,29 @@ module OpenAI
1265
1354
  optional :stream_id, String
1266
1355
 
1267
1356
  # @!method initialize(content_index:, item_id:, output_index:, sequence_number:, text:, stream_id: nil, type: :"response.reasoning_text.done")
1268
- # Some parameter documentations has been truncated, see
1269
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDone}
1270
- # for more details.
1271
- #
1272
1357
  # Emitted when a reasoning text is completed.
1273
1358
  #
1274
- # @param content_index [Integer] The index of the reasoning content part.
1359
+ # @param content_index [Integer]
1360
+ # The index of the reasoning content part.
1275
1361
  #
1276
- # @param item_id [String] The ID of the item this reasoning text is associated with.
1362
+ # @param item_id [String]
1363
+ # The ID of the item this reasoning text is associated with.
1277
1364
  #
1278
- # @param output_index [Integer] The index of the output item this reasoning text is associated with.
1365
+ # @param output_index [Integer]
1366
+ # The index of the output item this reasoning text is associated with.
1279
1367
  #
1280
- # @param sequence_number [Integer] The sequence number of this event.
1368
+ # @param sequence_number [Integer]
1369
+ # The sequence number of this event.
1281
1370
  #
1282
- # @param text [String] The full text of the completed reasoning content.
1371
+ # @param text [String]
1372
+ # The full text of the completed reasoning content.
1283
1373
  #
1284
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1374
+ # @param stream_id [String]
1375
+ # The WebSocket lane that emitted this event. This field is present when the
1376
+ # originating `response.create` event supplied a `stream_id`.
1285
1377
  #
1286
- # @param type [Symbol, :"response.reasoning_text.done"] The type of the event. Always `response.reasoning_text.done`.
1378
+ # @param type [Symbol, :"response.reasoning_text.done"]
1379
+ # The type of the event. Always `response.reasoning_text.done`.
1287
1380
  end
1288
1381
 
1289
1382
  class ResponseRefusalWsDelta < OpenAI::Models::Responses::ResponseRefusalDeltaEvent
@@ -1295,25 +1388,29 @@ module OpenAI
1295
1388
  optional :stream_id, String
1296
1389
 
1297
1390
  # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.refusal.delta")
1298
- # Some parameter documentations has been truncated, see
1299
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDelta} for
1300
- # more details.
1301
- #
1302
1391
  # Emitted when there is a partial refusal text.
1303
1392
  #
1304
- # @param content_index [Integer] The index of the content part that the refusal text is added to.
1393
+ # @param content_index [Integer]
1394
+ # The index of the content part that the refusal text is added to.
1305
1395
  #
1306
- # @param delta [String] The refusal text that is added.
1396
+ # @param delta [String]
1397
+ # The refusal text that is added.
1307
1398
  #
1308
- # @param item_id [String] The ID of the output item that the refusal text is added to.
1399
+ # @param item_id [String]
1400
+ # The ID of the output item that the refusal text is added to.
1309
1401
  #
1310
- # @param output_index [Integer] The index of the output item that the refusal text is added to.
1402
+ # @param output_index [Integer]
1403
+ # The index of the output item that the refusal text is added to.
1311
1404
  #
1312
- # @param sequence_number [Integer] The sequence number of this event.
1405
+ # @param sequence_number [Integer]
1406
+ # The sequence number of this event.
1313
1407
  #
1314
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1408
+ # @param stream_id [String]
1409
+ # The WebSocket lane that emitted this event. This field is present when the
1410
+ # originating `response.create` event supplied a `stream_id`.
1315
1411
  #
1316
- # @param type [Symbol, :"response.refusal.delta"] The type of the event. Always `response.refusal.delta`.
1412
+ # @param type [Symbol, :"response.refusal.delta"]
1413
+ # The type of the event. Always `response.refusal.delta`.
1317
1414
  end
1318
1415
 
1319
1416
  class ResponseRefusalWsDone < OpenAI::Models::Responses::ResponseRefusalDoneEvent
@@ -1325,25 +1422,29 @@ module OpenAI
1325
1422
  optional :stream_id, String
1326
1423
 
1327
1424
  # @!method initialize(content_index:, item_id:, output_index:, refusal:, sequence_number:, stream_id: nil, type: :"response.refusal.done")
1328
- # Some parameter documentations has been truncated, see
1329
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDone} for
1330
- # more details.
1331
- #
1332
1425
  # Emitted when refusal text is finalized.
1333
1426
  #
1334
- # @param content_index [Integer] The index of the content part that the refusal text is finalized.
1427
+ # @param content_index [Integer]
1428
+ # The index of the content part that the refusal text is finalized.
1335
1429
  #
1336
- # @param item_id [String] The ID of the output item that the refusal text is finalized.
1430
+ # @param item_id [String]
1431
+ # The ID of the output item that the refusal text is finalized.
1337
1432
  #
1338
- # @param output_index [Integer] The index of the output item that the refusal text is finalized.
1433
+ # @param output_index [Integer]
1434
+ # The index of the output item that the refusal text is finalized.
1339
1435
  #
1340
- # @param refusal [String] The refusal text that is finalized.
1436
+ # @param refusal [String]
1437
+ # The refusal text that is finalized.
1341
1438
  #
1342
- # @param sequence_number [Integer] The sequence number of this event.
1439
+ # @param sequence_number [Integer]
1440
+ # The sequence number of this event.
1343
1441
  #
1344
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1442
+ # @param stream_id [String]
1443
+ # The WebSocket lane that emitted this event. This field is present when the
1444
+ # originating `response.create` event supplied a `stream_id`.
1345
1445
  #
1346
- # @param type [Symbol, :"response.refusal.done"] The type of the event. Always `response.refusal.done`.
1446
+ # @param type [Symbol, :"response.refusal.done"]
1447
+ # The type of the event. Always `response.refusal.done`.
1347
1448
  end
1348
1449
 
1349
1450
  class ResponseTextWsDelta < OpenAI::Models::Responses::ResponseTextDeltaEvent
@@ -1355,27 +1456,32 @@ module OpenAI
1355
1456
  optional :stream_id, String
1356
1457
 
1357
1458
  # @!method initialize(content_index:, delta:, item_id:, logprobs:, output_index:, sequence_number:, stream_id: nil, type: :"response.output_text.delta")
1358
- # Some parameter documentations has been truncated, see
1359
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDelta} for more
1360
- # details.
1361
- #
1362
1459
  # Emitted when there is an additional text delta.
1363
1460
  #
1364
- # @param content_index [Integer] The index of the content part that the text delta was added to.
1461
+ # @param content_index [Integer]
1462
+ # The index of the content part that the text delta was added to.
1365
1463
  #
1366
- # @param delta [String] The text delta that was added.
1464
+ # @param delta [String]
1465
+ # The text delta that was added.
1367
1466
  #
1368
- # @param item_id [String] The ID of the output item that the text delta was added to.
1467
+ # @param item_id [String]
1468
+ # The ID of the output item that the text delta was added to.
1369
1469
  #
1370
- # @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob>] The log probabilities of the tokens in the delta.
1470
+ # @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob>]
1471
+ # The log probabilities of the tokens in the delta.
1371
1472
  #
1372
- # @param output_index [Integer] The index of the output item that the text delta was added to.
1473
+ # @param output_index [Integer]
1474
+ # The index of the output item that the text delta was added to.
1373
1475
  #
1374
- # @param sequence_number [Integer] The sequence number for this event.
1476
+ # @param sequence_number [Integer]
1477
+ # The sequence number for this event.
1375
1478
  #
1376
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1479
+ # @param stream_id [String]
1480
+ # The WebSocket lane that emitted this event. This field is present when the
1481
+ # originating `response.create` event supplied a `stream_id`.
1377
1482
  #
1378
- # @param type [Symbol, :"response.output_text.delta"] The type of the event. Always `response.output_text.delta`.
1483
+ # @param type [Symbol, :"response.output_text.delta"]
1484
+ # The type of the event. Always `response.output_text.delta`.
1379
1485
  end
1380
1486
 
1381
1487
  class ResponseTextWsDone < OpenAI::Models::Responses::ResponseTextDoneEvent
@@ -1387,27 +1493,32 @@ module OpenAI
1387
1493
  optional :stream_id, String
1388
1494
 
1389
1495
  # @!method initialize(content_index:, item_id:, logprobs:, output_index:, sequence_number:, text:, stream_id: nil, type: :"response.output_text.done")
1390
- # Some parameter documentations has been truncated, see
1391
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDone} for more
1392
- # details.
1393
- #
1394
1496
  # Emitted when text content is finalized.
1395
1497
  #
1396
- # @param content_index [Integer] The index of the content part that the text content is finalized.
1498
+ # @param content_index [Integer]
1499
+ # The index of the content part that the text content is finalized.
1397
1500
  #
1398
- # @param item_id [String] The ID of the output item that the text content is finalized.
1501
+ # @param item_id [String]
1502
+ # The ID of the output item that the text content is finalized.
1399
1503
  #
1400
- # @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>] The log probabilities of the tokens in the delta.
1504
+ # @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>]
1505
+ # The log probabilities of the tokens in the delta.
1401
1506
  #
1402
- # @param output_index [Integer] The index of the output item that the text content is finalized.
1507
+ # @param output_index [Integer]
1508
+ # The index of the output item that the text content is finalized.
1403
1509
  #
1404
- # @param sequence_number [Integer] The sequence number for this event.
1510
+ # @param sequence_number [Integer]
1511
+ # The sequence number for this event.
1405
1512
  #
1406
- # @param text [String] The text content that is finalized.
1513
+ # @param text [String]
1514
+ # The text content that is finalized.
1407
1515
  #
1408
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1516
+ # @param stream_id [String]
1517
+ # The WebSocket lane that emitted this event. This field is present when the
1518
+ # originating `response.create` event supplied a `stream_id`.
1409
1519
  #
1410
- # @param type [Symbol, :"response.output_text.done"] The type of the event. Always `response.output_text.done`.
1520
+ # @param type [Symbol, :"response.output_text.done"]
1521
+ # The type of the event. Always `response.output_text.done`.
1411
1522
  end
1412
1523
 
1413
1524
  class ResponseWebSearchCallWsCompleted < OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent
@@ -1419,21 +1530,23 @@ module OpenAI
1419
1530
  optional :stream_id, String
1420
1531
 
1421
1532
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.web_search_call.completed")
1422
- # Some parameter documentations has been truncated, see
1423
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsCompleted}
1424
- # for more details.
1425
- #
1426
1533
  # Emitted when a web search call is completed.
1427
1534
  #
1428
- # @param item_id [String] Unique ID for the output item associated with the web search call.
1535
+ # @param item_id [String]
1536
+ # Unique ID for the output item associated with the web search call.
1429
1537
  #
1430
- # @param output_index [Integer] The index of the output item that the web search call is associated with.
1538
+ # @param output_index [Integer]
1539
+ # The index of the output item that the web search call is associated with.
1431
1540
  #
1432
- # @param sequence_number [Integer] The sequence number of the web search call being processed.
1541
+ # @param sequence_number [Integer]
1542
+ # The sequence number of the web search call being processed.
1433
1543
  #
1434
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1544
+ # @param stream_id [String]
1545
+ # The WebSocket lane that emitted this event. This field is present when the
1546
+ # originating `response.create` event supplied a `stream_id`.
1435
1547
  #
1436
- # @param type [Symbol, :"response.web_search_call.completed"] The type of the event. Always `response.web_search_call.completed`.
1548
+ # @param type [Symbol, :"response.web_search_call.completed"]
1549
+ # The type of the event. Always `response.web_search_call.completed`.
1437
1550
  end
1438
1551
 
1439
1552
  class ResponseWebSearchCallInWsProgress < OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent
@@ -1445,21 +1558,23 @@ module OpenAI
1445
1558
  optional :stream_id, String
1446
1559
 
1447
1560
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.web_search_call.in_progress")
1448
- # Some parameter documentations has been truncated, see
1449
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallInWsProgress}
1450
- # for more details.
1451
- #
1452
1561
  # Emitted when a web search call is initiated.
1453
1562
  #
1454
- # @param item_id [String] Unique ID for the output item associated with the web search call.
1563
+ # @param item_id [String]
1564
+ # Unique ID for the output item associated with the web search call.
1455
1565
  #
1456
- # @param output_index [Integer] The index of the output item that the web search call is associated with.
1566
+ # @param output_index [Integer]
1567
+ # The index of the output item that the web search call is associated with.
1457
1568
  #
1458
- # @param sequence_number [Integer] The sequence number of the web search call being processed.
1569
+ # @param sequence_number [Integer]
1570
+ # The sequence number of the web search call being processed.
1459
1571
  #
1460
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1572
+ # @param stream_id [String]
1573
+ # The WebSocket lane that emitted this event. This field is present when the
1574
+ # originating `response.create` event supplied a `stream_id`.
1461
1575
  #
1462
- # @param type [Symbol, :"response.web_search_call.in_progress"] The type of the event. Always `response.web_search_call.in_progress`.
1576
+ # @param type [Symbol, :"response.web_search_call.in_progress"]
1577
+ # The type of the event. Always `response.web_search_call.in_progress`.
1463
1578
  end
1464
1579
 
1465
1580
  class ResponseWebSearchCallWsSearching < OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent
@@ -1471,21 +1586,23 @@ module OpenAI
1471
1586
  optional :stream_id, String
1472
1587
 
1473
1588
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.web_search_call.searching")
1474
- # Some parameter documentations has been truncated, see
1475
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsSearching}
1476
- # for more details.
1477
- #
1478
1589
  # Emitted when a web search call is executing.
1479
1590
  #
1480
- # @param item_id [String] Unique ID for the output item associated with the web search call.
1591
+ # @param item_id [String]
1592
+ # Unique ID for the output item associated with the web search call.
1481
1593
  #
1482
- # @param output_index [Integer] The index of the output item that the web search call is associated with.
1594
+ # @param output_index [Integer]
1595
+ # The index of the output item that the web search call is associated with.
1483
1596
  #
1484
- # @param sequence_number [Integer] The sequence number of the web search call being processed.
1597
+ # @param sequence_number [Integer]
1598
+ # The sequence number of the web search call being processed.
1485
1599
  #
1486
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1600
+ # @param stream_id [String]
1601
+ # The WebSocket lane that emitted this event. This field is present when the
1602
+ # originating `response.create` event supplied a `stream_id`.
1487
1603
  #
1488
- # @param type [Symbol, :"response.web_search_call.searching"] The type of the event. Always `response.web_search_call.searching`.
1604
+ # @param type [Symbol, :"response.web_search_call.searching"]
1605
+ # The type of the event. Always `response.web_search_call.searching`.
1489
1606
  end
1490
1607
 
1491
1608
  class ResponseImageGenCallWsCompleted < OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent
@@ -1497,22 +1614,24 @@ module OpenAI
1497
1614
  optional :stream_id, String
1498
1615
 
1499
1616
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.image_generation_call.completed")
1500
- # Some parameter documentations has been truncated, see
1501
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsCompleted}
1502
- # for more details.
1503
- #
1504
1617
  # Emitted when an image generation tool call has completed and the final image is
1505
1618
  # available.
1506
1619
  #
1507
- # @param item_id [String] The unique identifier of the image generation item being processed.
1620
+ # @param item_id [String]
1621
+ # The unique identifier of the image generation item being processed.
1508
1622
  #
1509
- # @param output_index [Integer] The index of the output item in the response's output array.
1623
+ # @param output_index [Integer]
1624
+ # The index of the output item in the response's output array.
1510
1625
  #
1511
- # @param sequence_number [Integer] The sequence number of this event.
1626
+ # @param sequence_number [Integer]
1627
+ # The sequence number of this event.
1512
1628
  #
1513
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1629
+ # @param stream_id [String]
1630
+ # The WebSocket lane that emitted this event. This field is present when the
1631
+ # originating `response.create` event supplied a `stream_id`.
1514
1632
  #
1515
- # @param type [Symbol, :"response.image_generation_call.completed"] The type of the event. Always 'response.image_generation_call.completed'.
1633
+ # @param type [Symbol, :"response.image_generation_call.completed"]
1634
+ # The type of the event. Always 'response.image_generation_call.completed'.
1516
1635
  end
1517
1636
 
1518
1637
  class ResponseImageGenCallWsGenerating < OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent
@@ -1524,22 +1643,24 @@ module OpenAI
1524
1643
  optional :stream_id, String
1525
1644
 
1526
1645
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.image_generation_call.generating")
1527
- # Some parameter documentations has been truncated, see
1528
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsGenerating}
1529
- # for more details.
1530
- #
1531
1646
  # Emitted when an image generation tool call is actively generating an image
1532
1647
  # (intermediate state).
1533
1648
  #
1534
- # @param item_id [String] The unique identifier of the image generation item being processed.
1649
+ # @param item_id [String]
1650
+ # The unique identifier of the image generation item being processed.
1535
1651
  #
1536
- # @param output_index [Integer] The index of the output item in the response's output array.
1652
+ # @param output_index [Integer]
1653
+ # The index of the output item in the response's output array.
1537
1654
  #
1538
- # @param sequence_number [Integer] The sequence number of the image generation item being processed.
1655
+ # @param sequence_number [Integer]
1656
+ # The sequence number of the image generation item being processed.
1539
1657
  #
1540
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1658
+ # @param stream_id [String]
1659
+ # The WebSocket lane that emitted this event. This field is present when the
1660
+ # originating `response.create` event supplied a `stream_id`.
1541
1661
  #
1542
- # @param type [Symbol, :"response.image_generation_call.generating"] The type of the event. Always 'response.image_generation_call.generating'.
1662
+ # @param type [Symbol, :"response.image_generation_call.generating"]
1663
+ # The type of the event. Always 'response.image_generation_call.generating'.
1543
1664
  end
1544
1665
 
1545
1666
  class ResponseImageGenCallInWsProgress < OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent
@@ -1551,21 +1672,23 @@ module OpenAI
1551
1672
  optional :stream_id, String
1552
1673
 
1553
1674
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.image_generation_call.in_progress")
1554
- # Some parameter documentations has been truncated, see
1555
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallInWsProgress}
1556
- # for more details.
1557
- #
1558
1675
  # Emitted when an image generation tool call is in progress.
1559
1676
  #
1560
- # @param item_id [String] The unique identifier of the image generation item being processed.
1677
+ # @param item_id [String]
1678
+ # The unique identifier of the image generation item being processed.
1561
1679
  #
1562
- # @param output_index [Integer] The index of the output item in the response's output array.
1680
+ # @param output_index [Integer]
1681
+ # The index of the output item in the response's output array.
1563
1682
  #
1564
- # @param sequence_number [Integer] The sequence number of the image generation item being processed.
1683
+ # @param sequence_number [Integer]
1684
+ # The sequence number of the image generation item being processed.
1565
1685
  #
1566
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1686
+ # @param stream_id [String]
1687
+ # The WebSocket lane that emitted this event. This field is present when the
1688
+ # originating `response.create` event supplied a `stream_id`.
1567
1689
  #
1568
- # @param type [Symbol, :"response.image_generation_call.in_progress"] The type of the event. Always 'response.image_generation_call.in_progress'.
1690
+ # @param type [Symbol, :"response.image_generation_call.in_progress"]
1691
+ # The type of the event. Always 'response.image_generation_call.in_progress'.
1569
1692
  end
1570
1693
 
1571
1694
  class ResponseImageGenCallPartialWsImage < OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent
@@ -1577,33 +1700,42 @@ module OpenAI
1577
1700
  optional :stream_id, String
1578
1701
 
1579
1702
  # @!method initialize(item_id:, output_index:, partial_image_b64:, partial_image_index:, sequence_number:, background: nil, output_format: nil, quality: nil, size: nil, stream_id: nil, type: :"response.image_generation_call.partial_image")
1580
- # Some parameter documentations has been truncated, see
1581
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallPartialWsImage}
1582
- # for more details.
1583
- #
1584
1703
  # Emitted when a partial image is available during image generation streaming.
1585
1704
  #
1586
- # @param item_id [String] The unique identifier of the image generation item being processed.
1705
+ # @param item_id [String]
1706
+ # The unique identifier of the image generation item being processed.
1587
1707
  #
1588
- # @param output_index [Integer] The index of the output item in the response's output array.
1708
+ # @param output_index [Integer]
1709
+ # The index of the output item in the response's output array.
1589
1710
  #
1590
- # @param partial_image_b64 [String] Base64-encoded partial image data, suitable for rendering as an image.
1711
+ # @param partial_image_b64 [String]
1712
+ # Base64-encoded partial image data, suitable for rendering as an image.
1591
1713
  #
1592
- # @param partial_image_index [Integer] 0-based index for the partial image (backend is 1-based, but this is 0-based for
1714
+ # @param partial_image_index [Integer]
1715
+ # 0-based index for the partial image (backend is 1-based, but this is 0-based for
1716
+ # the user).
1593
1717
  #
1594
- # @param sequence_number [Integer] The sequence number of the image generation item being processed.
1718
+ # @param sequence_number [Integer]
1719
+ # The sequence number of the image generation item being processed.
1595
1720
  #
1596
- # @param background [String] The background setting that was used.
1721
+ # @param background [String]
1722
+ # The background setting that was used.
1597
1723
  #
1598
- # @param output_format [String] The output format that was used.
1724
+ # @param output_format [String]
1725
+ # The output format that was used.
1599
1726
  #
1600
- # @param quality [String] The image quality that was used.
1727
+ # @param quality [String]
1728
+ # The image quality that was used.
1601
1729
  #
1602
- # @param size [String] The image size that was used.
1730
+ # @param size [String]
1731
+ # The image size that was used.
1603
1732
  #
1604
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1733
+ # @param stream_id [String]
1734
+ # The WebSocket lane that emitted this event. This field is present when the
1735
+ # originating `response.create` event supplied a `stream_id`.
1605
1736
  #
1606
- # @param type [Symbol, :"response.image_generation_call.partial_image"] The type of the event. Always 'response.image_generation_call.partial_image'.
1737
+ # @param type [Symbol, :"response.image_generation_call.partial_image"]
1738
+ # The type of the event. Always 'response.image_generation_call.partial_image'.
1607
1739
  end
1608
1740
 
1609
1741
  class ResponseMcpCallArgumentsWsDelta < OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent
@@ -1615,24 +1747,28 @@ module OpenAI
1615
1747
  optional :stream_id, String
1616
1748
 
1617
1749
  # @!method initialize(delta:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_call_arguments.delta")
1618
- # Some parameter documentations has been truncated, see
1619
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDelta}
1620
- # for more details.
1621
- #
1622
1750
  # Emitted when there is a delta (partial update) to the arguments of an MCP tool
1623
1751
  # call.
1624
1752
  #
1625
- # @param delta [String] A JSON string containing the partial update to the arguments for the MCP tool ca
1753
+ # @param delta [String]
1754
+ # A JSON string containing the partial update to the arguments for the MCP tool
1755
+ # call.
1626
1756
  #
1627
- # @param item_id [String] The unique identifier of the MCP tool call item being processed.
1757
+ # @param item_id [String]
1758
+ # The unique identifier of the MCP tool call item being processed.
1628
1759
  #
1629
- # @param output_index [Integer] The index of the output item in the response's output array.
1760
+ # @param output_index [Integer]
1761
+ # The index of the output item in the response's output array.
1630
1762
  #
1631
- # @param sequence_number [Integer] The sequence number of this event.
1763
+ # @param sequence_number [Integer]
1764
+ # The sequence number of this event.
1632
1765
  #
1633
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1766
+ # @param stream_id [String]
1767
+ # The WebSocket lane that emitted this event. This field is present when the
1768
+ # originating `response.create` event supplied a `stream_id`.
1634
1769
  #
1635
- # @param type [Symbol, :"response.mcp_call_arguments.delta"] The type of the event. Always 'response.mcp_call_arguments.delta'.
1770
+ # @param type [Symbol, :"response.mcp_call_arguments.delta"]
1771
+ # The type of the event. Always 'response.mcp_call_arguments.delta'.
1636
1772
  end
1637
1773
 
1638
1774
  class ResponseMcpCallArgumentsWsDone < OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent
@@ -1644,23 +1780,26 @@ module OpenAI
1644
1780
  optional :stream_id, String
1645
1781
 
1646
1782
  # @!method initialize(arguments:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_call_arguments.done")
1647
- # Some parameter documentations has been truncated, see
1648
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDone}
1649
- # for more details.
1650
- #
1651
1783
  # Emitted when the arguments for an MCP tool call are finalized.
1652
1784
  #
1653
- # @param arguments [String] A JSON string containing the finalized arguments for the MCP tool call.
1785
+ # @param arguments [String]
1786
+ # A JSON string containing the finalized arguments for the MCP tool call.
1654
1787
  #
1655
- # @param item_id [String] The unique identifier of the MCP tool call item being processed.
1788
+ # @param item_id [String]
1789
+ # The unique identifier of the MCP tool call item being processed.
1656
1790
  #
1657
- # @param output_index [Integer] The index of the output item in the response's output array.
1791
+ # @param output_index [Integer]
1792
+ # The index of the output item in the response's output array.
1658
1793
  #
1659
- # @param sequence_number [Integer] The sequence number of this event.
1794
+ # @param sequence_number [Integer]
1795
+ # The sequence number of this event.
1660
1796
  #
1661
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1797
+ # @param stream_id [String]
1798
+ # The WebSocket lane that emitted this event. This field is present when the
1799
+ # originating `response.create` event supplied a `stream_id`.
1662
1800
  #
1663
- # @param type [Symbol, :"response.mcp_call_arguments.done"] The type of the event. Always 'response.mcp_call_arguments.done'.
1801
+ # @param type [Symbol, :"response.mcp_call_arguments.done"]
1802
+ # The type of the event. Always 'response.mcp_call_arguments.done'.
1664
1803
  end
1665
1804
 
1666
1805
  class ResponseMcpCallWsCompleted < OpenAI::Models::Responses::ResponseMcpCallCompletedEvent
@@ -1672,21 +1811,23 @@ module OpenAI
1672
1811
  optional :stream_id, String
1673
1812
 
1674
1813
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_call.completed")
1675
- # Some parameter documentations has been truncated, see
1676
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsCompleted}
1677
- # for more details.
1678
- #
1679
1814
  # Emitted when an MCP tool call has completed successfully.
1680
1815
  #
1681
- # @param item_id [String] The ID of the MCP tool call item that completed.
1816
+ # @param item_id [String]
1817
+ # The ID of the MCP tool call item that completed.
1682
1818
  #
1683
- # @param output_index [Integer] The index of the output item that completed.
1819
+ # @param output_index [Integer]
1820
+ # The index of the output item that completed.
1684
1821
  #
1685
- # @param sequence_number [Integer] The sequence number of this event.
1822
+ # @param sequence_number [Integer]
1823
+ # The sequence number of this event.
1686
1824
  #
1687
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1825
+ # @param stream_id [String]
1826
+ # The WebSocket lane that emitted this event. This field is present when the
1827
+ # originating `response.create` event supplied a `stream_id`.
1688
1828
  #
1689
- # @param type [Symbol, :"response.mcp_call.completed"] The type of the event. Always 'response.mcp_call.completed'.
1829
+ # @param type [Symbol, :"response.mcp_call.completed"]
1830
+ # The type of the event. Always 'response.mcp_call.completed'.
1690
1831
  end
1691
1832
 
1692
1833
  class ResponseMcpCallWsFailed < OpenAI::Models::Responses::ResponseMcpCallFailedEvent
@@ -1698,21 +1839,23 @@ module OpenAI
1698
1839
  optional :stream_id, String
1699
1840
 
1700
1841
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_call.failed")
1701
- # Some parameter documentations has been truncated, see
1702
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsFailed} for
1703
- # more details.
1704
- #
1705
1842
  # Emitted when an MCP tool call has failed.
1706
1843
  #
1707
- # @param item_id [String] The ID of the MCP tool call item that failed.
1844
+ # @param item_id [String]
1845
+ # The ID of the MCP tool call item that failed.
1708
1846
  #
1709
- # @param output_index [Integer] The index of the output item that failed.
1847
+ # @param output_index [Integer]
1848
+ # The index of the output item that failed.
1710
1849
  #
1711
- # @param sequence_number [Integer] The sequence number of this event.
1850
+ # @param sequence_number [Integer]
1851
+ # The sequence number of this event.
1712
1852
  #
1713
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1853
+ # @param stream_id [String]
1854
+ # The WebSocket lane that emitted this event. This field is present when the
1855
+ # originating `response.create` event supplied a `stream_id`.
1714
1856
  #
1715
- # @param type [Symbol, :"response.mcp_call.failed"] The type of the event. Always 'response.mcp_call.failed'.
1857
+ # @param type [Symbol, :"response.mcp_call.failed"]
1858
+ # The type of the event. Always 'response.mcp_call.failed'.
1716
1859
  end
1717
1860
 
1718
1861
  class ResponseMcpCallInWsProgress < OpenAI::Models::Responses::ResponseMcpCallInProgressEvent
@@ -1724,21 +1867,23 @@ module OpenAI
1724
1867
  optional :stream_id, String
1725
1868
 
1726
1869
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_call.in_progress")
1727
- # Some parameter documentations has been truncated, see
1728
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallInWsProgress}
1729
- # for more details.
1730
- #
1731
1870
  # Emitted when an MCP tool call is in progress.
1732
1871
  #
1733
- # @param item_id [String] The unique identifier of the MCP tool call item being processed.
1872
+ # @param item_id [String]
1873
+ # The unique identifier of the MCP tool call item being processed.
1734
1874
  #
1735
- # @param output_index [Integer] The index of the output item in the response's output array.
1875
+ # @param output_index [Integer]
1876
+ # The index of the output item in the response's output array.
1736
1877
  #
1737
- # @param sequence_number [Integer] The sequence number of this event.
1878
+ # @param sequence_number [Integer]
1879
+ # The sequence number of this event.
1738
1880
  #
1739
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1881
+ # @param stream_id [String]
1882
+ # The WebSocket lane that emitted this event. This field is present when the
1883
+ # originating `response.create` event supplied a `stream_id`.
1740
1884
  #
1741
- # @param type [Symbol, :"response.mcp_call.in_progress"] The type of the event. Always 'response.mcp_call.in_progress'.
1885
+ # @param type [Symbol, :"response.mcp_call.in_progress"]
1886
+ # The type of the event. Always 'response.mcp_call.in_progress'.
1742
1887
  end
1743
1888
 
1744
1889
  class ResponseMcpListToolsWsCompleted < OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent
@@ -1750,21 +1895,23 @@ module OpenAI
1750
1895
  optional :stream_id, String
1751
1896
 
1752
1897
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_list_tools.completed")
1753
- # Some parameter documentations has been truncated, see
1754
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsCompleted}
1755
- # for more details.
1756
- #
1757
1898
  # Emitted when the list of available MCP tools has been successfully retrieved.
1758
1899
  #
1759
- # @param item_id [String] The ID of the MCP tool call item that produced this output.
1900
+ # @param item_id [String]
1901
+ # The ID of the MCP tool call item that produced this output.
1760
1902
  #
1761
- # @param output_index [Integer] The index of the output item that was processed.
1903
+ # @param output_index [Integer]
1904
+ # The index of the output item that was processed.
1762
1905
  #
1763
- # @param sequence_number [Integer] The sequence number of this event.
1906
+ # @param sequence_number [Integer]
1907
+ # The sequence number of this event.
1764
1908
  #
1765
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1909
+ # @param stream_id [String]
1910
+ # The WebSocket lane that emitted this event. This field is present when the
1911
+ # originating `response.create` event supplied a `stream_id`.
1766
1912
  #
1767
- # @param type [Symbol, :"response.mcp_list_tools.completed"] The type of the event. Always 'response.mcp_list_tools.completed'.
1913
+ # @param type [Symbol, :"response.mcp_list_tools.completed"]
1914
+ # The type of the event. Always 'response.mcp_list_tools.completed'.
1768
1915
  end
1769
1916
 
1770
1917
  class ResponseMcpListToolsWsFailed < OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent
@@ -1776,21 +1923,23 @@ module OpenAI
1776
1923
  optional :stream_id, String
1777
1924
 
1778
1925
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_list_tools.failed")
1779
- # Some parameter documentations has been truncated, see
1780
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsFailed}
1781
- # for more details.
1782
- #
1783
1926
  # Emitted when the attempt to list available MCP tools has failed.
1784
1927
  #
1785
- # @param item_id [String] The ID of the MCP tool call item that failed.
1928
+ # @param item_id [String]
1929
+ # The ID of the MCP tool call item that failed.
1786
1930
  #
1787
- # @param output_index [Integer] The index of the output item that failed.
1931
+ # @param output_index [Integer]
1932
+ # The index of the output item that failed.
1788
1933
  #
1789
- # @param sequence_number [Integer] The sequence number of this event.
1934
+ # @param sequence_number [Integer]
1935
+ # The sequence number of this event.
1790
1936
  #
1791
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1937
+ # @param stream_id [String]
1938
+ # The WebSocket lane that emitted this event. This field is present when the
1939
+ # originating `response.create` event supplied a `stream_id`.
1792
1940
  #
1793
- # @param type [Symbol, :"response.mcp_list_tools.failed"] The type of the event. Always 'response.mcp_list_tools.failed'.
1941
+ # @param type [Symbol, :"response.mcp_list_tools.failed"]
1942
+ # The type of the event. Always 'response.mcp_list_tools.failed'.
1794
1943
  end
1795
1944
 
1796
1945
  class ResponseMcpListToolsInWsProgress < OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent
@@ -1802,22 +1951,24 @@ module OpenAI
1802
1951
  optional :stream_id, String
1803
1952
 
1804
1953
  # @!method initialize(item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.mcp_list_tools.in_progress")
1805
- # Some parameter documentations has been truncated, see
1806
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsInWsProgress}
1807
- # for more details.
1808
- #
1809
1954
  # Emitted when the system is in the process of retrieving the list of available
1810
1955
  # MCP tools.
1811
1956
  #
1812
- # @param item_id [String] The ID of the MCP tool call item that is being processed.
1957
+ # @param item_id [String]
1958
+ # The ID of the MCP tool call item that is being processed.
1813
1959
  #
1814
- # @param output_index [Integer] The index of the output item that is being processed.
1960
+ # @param output_index [Integer]
1961
+ # The index of the output item that is being processed.
1815
1962
  #
1816
- # @param sequence_number [Integer] The sequence number of this event.
1963
+ # @param sequence_number [Integer]
1964
+ # The sequence number of this event.
1817
1965
  #
1818
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
1966
+ # @param stream_id [String]
1967
+ # The WebSocket lane that emitted this event. This field is present when the
1968
+ # originating `response.create` event supplied a `stream_id`.
1819
1969
  #
1820
- # @param type [Symbol, :"response.mcp_list_tools.in_progress"] The type of the event. Always 'response.mcp_list_tools.in_progress'.
1970
+ # @param type [Symbol, :"response.mcp_list_tools.in_progress"]
1971
+ # The type of the event. Always 'response.mcp_list_tools.in_progress'.
1821
1972
  end
1822
1973
 
1823
1974
  class ResponseOutputTextAnnotationWsAdded < OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent
@@ -1829,27 +1980,32 @@ module OpenAI
1829
1980
  optional :stream_id, String
1830
1981
 
1831
1982
  # @!method initialize(annotation:, annotation_index:, content_index:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.output_text.annotation.added")
1832
- # Some parameter documentations has been truncated, see
1833
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputTextAnnotationWsAdded}
1834
- # for more details.
1835
- #
1836
1983
  # Emitted when an annotation is added to output text content.
1837
1984
  #
1838
- # @param annotation [OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil] An annotation that applies to a span of output text.
1985
+ # @param annotation [OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil]
1986
+ # An annotation that applies to a span of output text.
1839
1987
  #
1840
- # @param annotation_index [Integer] The index of the annotation within the content part.
1988
+ # @param annotation_index [Integer]
1989
+ # The index of the annotation within the content part.
1841
1990
  #
1842
- # @param content_index [Integer] The index of the content part within the output item.
1991
+ # @param content_index [Integer]
1992
+ # The index of the content part within the output item.
1843
1993
  #
1844
- # @param item_id [String] The unique identifier of the item to which the annotation is being added.
1994
+ # @param item_id [String]
1995
+ # The unique identifier of the item to which the annotation is being added.
1845
1996
  #
1846
- # @param output_index [Integer] The index of the output item in the response's output array.
1997
+ # @param output_index [Integer]
1998
+ # The index of the output item in the response's output array.
1847
1999
  #
1848
- # @param sequence_number [Integer] The sequence number of this event.
2000
+ # @param sequence_number [Integer]
2001
+ # The sequence number of this event.
1849
2002
  #
1850
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
2003
+ # @param stream_id [String]
2004
+ # The WebSocket lane that emitted this event. This field is present when the
2005
+ # originating `response.create` event supplied a `stream_id`.
1851
2006
  #
1852
- # @param type [Symbol, :"response.output_text.annotation.added"] The type of the event. Always 'response.output_text.annotation.added'.
2007
+ # @param type [Symbol, :"response.output_text.annotation.added"]
2008
+ # The type of the event. Always 'response.output_text.annotation.added'.
1853
2009
  end
1854
2010
 
1855
2011
  class ResponseWsQueued < OpenAI::Models::Responses::ResponseQueuedEvent
@@ -1861,19 +2017,20 @@ module OpenAI
1861
2017
  optional :stream_id, String
1862
2018
 
1863
2019
  # @!method initialize(response:, sequence_number:, stream_id: nil, type: :"response.queued")
1864
- # Some parameter documentations has been truncated, see
1865
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsQueued} for more
1866
- # details.
1867
- #
1868
2020
  # Emitted when a response is queued and waiting to be processed.
1869
2021
  #
1870
- # @param response [OpenAI::Models::Responses::Response] The full response object that is queued.
2022
+ # @param response [OpenAI::Models::Responses::Response]
2023
+ # The full response object that is queued.
1871
2024
  #
1872
- # @param sequence_number [Integer] The sequence number for this event.
2025
+ # @param sequence_number [Integer]
2026
+ # The sequence number for this event.
1873
2027
  #
1874
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
2028
+ # @param stream_id [String]
2029
+ # The WebSocket lane that emitted this event. This field is present when the
2030
+ # originating `response.create` event supplied a `stream_id`.
1875
2031
  #
1876
- # @param type [Symbol, :"response.queued"] The type of the event. Always 'response.queued'.
2032
+ # @param type [Symbol, :"response.queued"]
2033
+ # The type of the event. Always 'response.queued'.
1877
2034
  end
1878
2035
 
1879
2036
  class ResponseCustomToolCallInputWsDelta < OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent
@@ -1885,23 +2042,26 @@ module OpenAI
1885
2042
  optional :stream_id, String
1886
2043
 
1887
2044
  # @!method initialize(delta:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.custom_tool_call_input.delta")
1888
- # Some parameter documentations has been truncated, see
1889
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDelta}
1890
- # for more details.
1891
- #
1892
2045
  # Event representing a delta (partial update) to the input of a custom tool call.
1893
2046
  #
1894
- # @param delta [String] The incremental input data (delta) for the custom tool call.
2047
+ # @param delta [String]
2048
+ # The incremental input data (delta) for the custom tool call.
1895
2049
  #
1896
- # @param item_id [String] Unique identifier for the API item associated with this event.
2050
+ # @param item_id [String]
2051
+ # Unique identifier for the API item associated with this event.
1897
2052
  #
1898
- # @param output_index [Integer] The index of the output this delta applies to.
2053
+ # @param output_index [Integer]
2054
+ # The index of the output this delta applies to.
1899
2055
  #
1900
- # @param sequence_number [Integer] The sequence number of this event.
2056
+ # @param sequence_number [Integer]
2057
+ # The sequence number of this event.
1901
2058
  #
1902
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
2059
+ # @param stream_id [String]
2060
+ # The WebSocket lane that emitted this event. This field is present when the
2061
+ # originating `response.create` event supplied a `stream_id`.
1903
2062
  #
1904
- # @param type [Symbol, :"response.custom_tool_call_input.delta"] The event type identifier.
2063
+ # @param type [Symbol, :"response.custom_tool_call_input.delta"]
2064
+ # The event type identifier.
1905
2065
  end
1906
2066
 
1907
2067
  class ResponseCustomToolCallInputWsDone < OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent
@@ -1913,23 +2073,26 @@ module OpenAI
1913
2073
  optional :stream_id, String
1914
2074
 
1915
2075
  # @!method initialize(input:, item_id:, output_index:, sequence_number:, stream_id: nil, type: :"response.custom_tool_call_input.done")
1916
- # Some parameter documentations has been truncated, see
1917
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDone}
1918
- # for more details.
1919
- #
1920
2076
  # Event indicating that input for a custom tool call is complete.
1921
2077
  #
1922
- # @param input [String] The complete input data for the custom tool call.
2078
+ # @param input [String]
2079
+ # The complete input data for the custom tool call.
1923
2080
  #
1924
- # @param item_id [String] Unique identifier for the API item associated with this event.
2081
+ # @param item_id [String]
2082
+ # Unique identifier for the API item associated with this event.
1925
2083
  #
1926
- # @param output_index [Integer] The index of the output this event applies to.
2084
+ # @param output_index [Integer]
2085
+ # The index of the output this event applies to.
1927
2086
  #
1928
- # @param sequence_number [Integer] The sequence number of this event.
2087
+ # @param sequence_number [Integer]
2088
+ # The sequence number of this event.
1929
2089
  #
1930
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present
2090
+ # @param stream_id [String]
2091
+ # The WebSocket lane that emitted this event. This field is present when the
2092
+ # originating `response.create` event supplied a `stream_id`.
1931
2093
  #
1932
- # @param type [Symbol, :"response.custom_tool_call_input.done"] The event type identifier.
2094
+ # @param type [Symbol, :"response.custom_tool_call_input.done"]
2095
+ # The event type identifier.
1933
2096
  end
1934
2097
 
1935
2098
  class ResponseWsError < OpenAI::Internal::Type::BaseModel
@@ -1965,21 +2128,23 @@ module OpenAI
1965
2128
  optional :stream_id, String
1966
2129
 
1967
2130
  # @!method initialize(error:, sequence_number: nil, status: nil, stream_id: nil, type: :error)
1968
- # Some parameter documentations has been truncated, see
1969
- # {OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError} for more
1970
- # details.
1971
- #
1972
2131
  # Emitted when an error occurs while processing a Responses WebSocket request.
1973
2132
  #
1974
- # @param error [OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error] Details about the error.
2133
+ # @param error [OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error]
2134
+ # Details about the error.
1975
2135
  #
1976
- # @param sequence_number [Integer] The sequence number of an error emitted by the response stream.
2136
+ # @param sequence_number [Integer]
2137
+ # The sequence number of an error emitted by the response stream.
1977
2138
  #
1978
- # @param status [Integer] The HTTP status code associated with a WebSocket protocol error.
2139
+ # @param status [Integer]
2140
+ # The HTTP status code associated with a WebSocket protocol error.
1979
2141
  #
1980
- # @param stream_id [String] The WebSocket lane that emitted this event. This field is present when the
2142
+ # @param stream_id [String]
2143
+ # The WebSocket lane that emitted this event. This field is present when the
2144
+ # originating `response.create` event supplied a `stream_id`.
1981
2145
  #
1982
- # @param type [Symbol, :error] The type of the event. Always `error`.
2146
+ # @param type [Symbol, :error]
2147
+ # The type of the event. Always `error`.
1983
2148
 
1984
2149
  # @see OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError#error
1985
2150
  class Error < OpenAI::Internal::Type::BaseModel
@@ -2024,15 +2189,20 @@ module OpenAI
2024
2189
  # @!method initialize(code:, message:, param:, type:, headers: nil, misalignment: nil)
2025
2190
  # Details about the error.
2026
2191
  #
2027
- # @param code [String, nil] The error code that was emitted, if any.
2192
+ # @param code [String, nil]
2193
+ # The error code that was emitted, if any.
2028
2194
  #
2029
- # @param message [String] The human-readable error message that was emitted.
2195
+ # @param message [String]
2196
+ # The human-readable error message that was emitted.
2030
2197
  #
2031
- # @param param [String, nil] The parameter name that was associated with the error, if any.
2198
+ # @param param [String, nil]
2199
+ # The parameter name that was associated with the error, if any.
2032
2200
  #
2033
- # @param type [String] The error type that was emitted.
2201
+ # @param type [String]
2202
+ # The error type that was emitted.
2034
2203
  #
2035
- # @param headers [Hash{Symbol=>String}] The response headers that were emitted with the error, if any.
2204
+ # @param headers [Hash{Symbol=>String}]
2205
+ # The response headers that were emitted with the error, if any.
2036
2206
  #
2037
2207
  # @param misalignment [OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment]
2038
2208
 
@@ -2063,11 +2233,14 @@ module OpenAI
2063
2233
  )
2064
2234
 
2065
2235
  # @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
2066
- # @param detailed_explanation [String] The public explanation for this block.
2236
+ # @param detailed_explanation [String]
2237
+ # The public explanation for this block.
2067
2238
  #
2068
- # @param error_type [String, Symbol, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::ErrorType] An optional classification; clients must accept additional values.
2239
+ # @param error_type [String, Symbol, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::ErrorType]
2240
+ # An optional classification; clients must accept additional values.
2069
2241
  #
2070
- # @param steer [OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer] An optional public continuation instruction.
2242
+ # @param steer [OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer]
2243
+ # An optional public continuation instruction.
2071
2244
 
2072
2245
  # An optional classification; clients must accept additional values.
2073
2246
  #
@@ -2134,7 +2307,8 @@ module OpenAI
2134
2307
  # @!method initialize(message:)
2135
2308
  # An optional public continuation instruction.
2136
2309
  #
2137
- # @param message [String] The public continuation instruction.
2310
+ # @param message [String]
2311
+ # The public continuation instruction.
2138
2312
  end
2139
2313
  end
2140
2314
  end