openai 0.103.0 → 0.104.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +81 -0
- data/README.md +23 -1
- data/lib/openai/client.rb +3 -386
- data/lib/openai/helpers/admin/organization/projects/api_keys.rb +42 -0
- data/lib/openai/helpers/agents/session_stream_resource.rb +60 -0
- data/lib/openai/helpers/beta/agents/artifacts.rb +18 -0
- data/lib/openai/helpers/beta/agents/files.rb +41 -0
- data/lib/openai/helpers/client_runtime.rb +391 -0
- data/lib/openai/helpers/files.rb +47 -0
- data/lib/openai/helpers/live/websocket.rb +8 -57
- data/lib/openai/helpers/models/chat/parsed.rb +32 -0
- data/lib/openai/helpers/models/responses/parsed.rb +30 -0
- data/lib/openai/helpers/models/responses/response.rb +32 -0
- data/lib/openai/helpers/models/webhooks/webhook_endpoint_with_secret.rb +20 -0
- data/lib/openai/helpers/realtime/client_extension.rb +1 -2
- data/lib/openai/helpers/realtime/connection_manager.rb +1 -1
- data/lib/openai/helpers/realtime/translation.rb +7 -50
- data/lib/openai/helpers/responses_websocket/client_extension.rb +1 -2
- data/lib/openai/helpers/streaming/chat_completion_resource.rb +36 -0
- data/lib/openai/helpers/streaming/response_stream.rb +1 -16
- data/lib/openai/helpers/streaming/response_stream_resource.rb +78 -0
- data/lib/openai/helpers/vector_stores/file_batches.rb +188 -0
- data/lib/openai/helpers/vector_stores/files.rb +198 -0
- data/lib/openai/helpers/websocket/client_request.rb +31 -6
- data/lib/openai/helpers/websocket/connection.rb +58 -0
- data/lib/openai/helpers/websocket/connection_manager.rb +4 -2
- data/lib/openai/helpers/websocket/protocol.rb +2 -1
- data/lib/openai/helpers/websocket/resource.rb +54 -0
- data/lib/openai/helpers/websocket/typed_connection.rb +95 -0
- data/lib/openai/helpers/websocket.rb +4 -0
- data/lib/openai/models/admin/organization/audit_log_list_response.rb +5 -3
- data/lib/openai/models/admin/organization/external_storage_configuration.rb +5 -3
- data/lib/openai/models/admin/organization/external_storage_create_params.rb +33 -3
- data/lib/openai/models/admin/organization/oci_external_storage_provider.rb +37 -0
- data/lib/openai/models/admin/organization/project_residency.rb +3 -0
- data/lib/openai/models/admin/organization/projects/api_key_update_params.rb +64 -0
- data/lib/openai/models/admin/organization/projects/api_key_update_scopes_params.rb +34 -0
- data/lib/openai/models/admin/organization/usage_decisions_params.rb +177 -0
- data/lib/openai/models/admin/organization/usage_decisions_response.rb +351 -0
- data/lib/openai/models/audio/speech_create_params.rb +6 -3
- data/lib/openai/models/audio/translation_create_response.rb +0 -1
- data/lib/openai/models/audio/voice.rb +17 -2
- data/lib/openai/models/audio/voice_create_params.rb +100 -3
- data/lib/openai/models/beta/agent_create_params.rb +4 -2
- data/lib/openai/models/beta/agent_list_params.rb +4 -4
- data/lib/openai/models/beta/agent_session.rb +37 -1
- data/lib/openai/models/beta/agent_update_params.rb +4 -2
- data/lib/openai/models/beta/agents/environment_list_params.rb +7 -7
- data/lib/openai/models/beta/agents/session_create_params.rb +39 -3
- data/lib/openai/models/beta/agents/session_list_params.rb +7 -10
- data/lib/openai/models/beta/agents/session_update_params.rb +33 -1
- data/lib/openai/models/beta/agents/sessions/artifact_list_params.rb +11 -11
- data/lib/openai/models/beta/agents/vault_list_params.rb +23 -13
- data/lib/openai/models/beta/agents/vault_status_filter.rb +1 -3
- data/lib/openai/models/beta/agents/vault_update_params.rb +47 -0
- data/lib/openai/models/beta/agents/vaults/credential_list_params.rb +23 -13
- data/lib/openai/models/beta/beta_response.rb +23 -2
- data/lib/openai/models/beta/beta_response_error.rb +19 -1
- data/lib/openai/models/beta/beta_response_input_item.rb +107 -1
- data/lib/openai/models/beta/beta_response_item.rb +107 -1
- data/lib/openai/models/beta/beta_response_output_item.rb +107 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +23 -2
- data/lib/openai/models/beta/response_compact_params.rb +21 -0
- data/lib/openai/models/beta/response_create_params.rb +23 -2
- data/lib/openai/models/beta/session_turn_error.rb +3 -0
- data/lib/openai/models/chat/chat_completion_audio_param.rb +3 -3
- data/lib/openai/models/chat/chat_completion_message.rb +0 -8
- data/lib/openai/models/chat/chat_completion_message_function_tool_call.rb +0 -8
- data/lib/openai/models/chat/completion_create_params.rb +5 -12
- data/lib/openai/models/chat_model.rb +21 -0
- data/lib/openai/models/conversations/conversation_item.rb +107 -1
- data/lib/openai/models/decision.rb +17 -2
- data/lib/openai/models/decision_create_params.rb +29 -12
- data/lib/openai/models/decision_input_image.rb +4 -3
- data/lib/openai/models/decision_input_message.rb +4 -4
- data/lib/openai/models/decision_input_part.rb +3 -2
- data/lib/openai/models/image_edit_completed_event.rb +1 -2
- data/lib/openai/models/image_edit_partial_image_event.rb +1 -2
- data/lib/openai/models/image_gen_completed_event.rb +1 -2
- data/lib/openai/models/image_gen_partial_image_event.rb +1 -2
- data/lib/openai/models/images_response.rb +1 -2
- data/lib/openai/models/live/built_in_voice.rb +1 -0
- data/lib/openai/models/live/client_event.rb +14 -2
- data/lib/openai/models/live/decision_create_event.rb +26 -0
- data/lib/openai/models/live/decision_event.rb +117 -0
- data/lib/openai/models/live/decision_item_create_event.rb +194 -0
- data/lib/openai/models/live/decision_item_created_event.rb +202 -0
- data/lib/openai/models/live/decision_item_delete_event.rb +38 -0
- data/lib/openai/models/live/decision_item_deleted_event.rb +46 -0
- data/lib/openai/models/live/decision_trigger.rb +244 -0
- data/lib/openai/models/live/decisions_delegation_config.rb +201 -0
- data/lib/openai/models/live/decisions_delegation_update_config.rb +208 -0
- data/lib/openai/models/live/delegation_created_event.rb +10 -10
- data/lib/openai/models/live/fork_client_event.rb +14 -2
- data/lib/openai/models/live/fork_server_event.rb +17 -2
- data/lib/openai/models/live/media_session_config.rb +47 -11
- data/lib/openai/models/live/output_audio_fixture_play_event.rb +48 -0
- data/lib/openai/models/live/output_audio_fixture_played_event.rb +42 -0
- data/lib/openai/models/live/output_audio_fixture_playing_event.rb +41 -0
- data/lib/openai/models/live/server_event.rb +17 -2
- data/lib/openai/models/live/session_accept_params.rb +47 -11
- data/lib/openai/models/live/session_config.rb +47 -11
- data/lib/openai/models/live/session_resource.rb +47 -11
- data/lib/openai/models/live/session_update_config.rb +38 -6
- data/lib/openai/models/live/session_update_event.rb +8 -8
- data/lib/openai/models/live/sideband_client_event.rb +57 -0
- data/lib/openai/models/live/sideband_server_event.rb +78 -0
- data/lib/openai/models/realtime/realtime_audio_config_output.rb +6 -3
- data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +6 -3
- data/lib/openai/models/realtime/realtime_response_status.rb +10 -1
- data/lib/openai/models/response_format_json_schema.rb +1 -1
- data/lib/openai/models/responses/function_tool.rb +8 -6
- data/lib/openai/models/responses/response.rb +2 -23
- data/lib/openai/models/responses/response_compact_params.rb +21 -0
- data/lib/openai/models/responses/response_create_params.rb +3 -6
- data/lib/openai/models/responses/response_error.rb +19 -1
- data/lib/openai/models/responses/response_format_text_config.rb +0 -4
- data/lib/openai/models/responses/response_function_tool_call.rb +0 -8
- data/lib/openai/models/responses/response_input_item.rb +107 -1
- data/lib/openai/models/responses/response_item.rb +107 -1
- data/lib/openai/models/responses/response_output_item.rb +107 -1
- data/lib/openai/models/responses/response_output_text.rb +0 -8
- data/lib/openai/models/responses/responses_client_event.rb +2 -2
- data/lib/openai/models/safety/safety_alert.rb +12 -1
- data/lib/openai/models/video_create_error.rb +19 -1
- data/lib/openai/models/webhooks/unwrap_webhook_event.rb +4 -4
- data/lib/openai/models/webhooks/webhook_endpoint_with_secret.rb +0 -9
- data/lib/openai/resources/admin/organization/external_storage.rb +1 -1
- data/lib/openai/resources/admin/organization/projects/api_keys.rb +61 -0
- data/lib/openai/resources/admin/organization/usage.rb +67 -0
- data/lib/openai/resources/audio/speech.rb +2 -1
- data/lib/openai/resources/audio/voices.rb +10 -10
- data/lib/openai/resources/beta/agents/environments/files.rb +3 -31
- data/lib/openai/resources/beta/agents/environments.rb +3 -3
- data/lib/openai/resources/beta/agents/sessions/artifacts.rb +5 -11
- data/lib/openai/resources/beta/agents/sessions.rb +20 -56
- data/lib/openai/resources/beta/agents/vaults/credentials.rb +10 -6
- data/lib/openai/resources/beta/agents/vaults.rb +45 -6
- data/lib/openai/resources/beta/agents.rb +6 -4
- data/lib/openai/resources/beta/responses.rb +2 -2
- data/lib/openai/resources/chat/completions.rb +11 -37
- data/lib/openai/resources/decisions.rb +9 -15
- data/lib/openai/resources/files.rb +0 -39
- data/lib/openai/resources/live/forks.rb +19 -0
- data/lib/openai/resources/live/sideband.rb +19 -0
- data/lib/openai/resources/live.rb +19 -0
- data/lib/openai/resources/realtime/translations.rb +19 -0
- data/lib/openai/resources/realtime.rb +19 -0
- data/lib/openai/resources/responses.rb +44 -95
- data/lib/openai/resources/vector_stores/file_batches.rb +0 -178
- data/lib/openai/resources/vector_stores/files.rb +0 -188
- data/lib/openai/resources/webhooks.rb +13 -29
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +31 -0
- data/rbi/openai/client.rbi +0 -103
- data/rbi/openai/helpers/admin/organization/projects/api_keys.rbi +25 -0
- data/rbi/openai/helpers/beta/agents/artifacts.rbi +25 -0
- data/rbi/openai/helpers/beta/agents/files.rbi +48 -0
- data/rbi/openai/helpers/client_runtime.rbi +108 -0
- data/rbi/openai/helpers/files.rbi +25 -0
- data/rbi/openai/helpers/models/chat/parsed.rbi +21 -0
- data/rbi/openai/helpers/models/responses/parsed.rbi +19 -0
- data/rbi/openai/helpers/models/responses/response.rbi +15 -0
- data/rbi/openai/helpers/streaming/response_stream.rbi +301 -0
- data/rbi/openai/helpers/vector_stores/file_batches.rbi +102 -0
- data/rbi/openai/helpers/vector_stores/files.rbi +122 -0
- data/rbi/openai/helpers/websocket.rbi +82 -0
- data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +6 -3
- data/rbi/openai/models/admin/organization/external_storage_configuration.rbi +4 -2
- data/rbi/openai/models/admin/organization/external_storage_create_params.rbi +63 -4
- data/rbi/openai/models/admin/organization/oci_external_storage_provider.rbi +71 -0
- data/rbi/openai/models/admin/organization/project_residency.rbi +12 -0
- data/rbi/openai/models/admin/organization/projects/api_key_update_params.rbi +110 -0
- data/rbi/openai/models/admin/organization/projects/api_key_update_scopes_params.rbi +72 -0
- data/rbi/openai/models/admin/organization/usage_decisions_params.rbi +229 -0
- data/rbi/openai/models/admin/organization/usage_decisions_response.rbi +479 -0
- data/rbi/openai/models/audio/speech_create_params.rbi +6 -3
- data/rbi/openai/models/audio/voice.rbi +21 -2
- data/rbi/openai/models/audio/voice_create_params.rbi +149 -4
- data/rbi/openai/models/beta/agent_create_params.rbi +4 -2
- data/rbi/openai/models/beta/agent_list_params.rbi +8 -5
- data/rbi/openai/models/beta/agent_session.rbi +64 -1
- data/rbi/openai/models/beta/agent_update_params.rbi +4 -2
- data/rbi/openai/models/beta/agents/environment_list_params.rbi +7 -7
- data/rbi/openai/models/beta/agents/session_create_params.rbi +62 -2
- data/rbi/openai/models/beta/agents/session_list_params.rbi +11 -11
- data/rbi/openai/models/beta/agents/session_update_params.rbi +56 -0
- data/rbi/openai/models/beta/agents/sessions/artifact_list_params.rbi +19 -13
- data/rbi/openai/models/beta/agents/vault_list_params.rbi +30 -13
- data/rbi/openai/models/beta/agents/vault_status_filter.rbi +1 -3
- data/rbi/openai/models/beta/agents/vault_update_params.rbi +87 -0
- data/rbi/openai/models/beta/agents/vaults/credential_list_params.rbi +30 -13
- data/rbi/openai/models/beta/beta_response.rbi +2 -2
- data/rbi/openai/models/beta/beta_response_error.rbi +24 -3
- data/rbi/openai/models/beta/beta_response_input_item.rbi +191 -0
- data/rbi/openai/models/beta/beta_response_item.rbi +189 -0
- data/rbi/openai/models/beta/beta_response_output_item.rbi +191 -0
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +2 -2
- data/rbi/openai/models/beta/response_create_params.rbi +2 -2
- data/rbi/openai/models/beta/session_turn_error.rbi +3 -0
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +3 -3
- data/rbi/openai/models/chat/chat_completion_message.rbi +0 -4
- data/rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi +0 -4
- data/rbi/openai/models/chat/completion_create_params.rbi +63 -78
- data/rbi/openai/models/conversations/conversation_item.rbi +191 -0
- data/rbi/openai/models/decision.rbi +14 -1
- data/rbi/openai/models/decision_create_params.rbi +23 -12
- data/rbi/openai/models/decision_input_image.rbi +4 -3
- data/rbi/openai/models/decision_input_message.rbi +4 -4
- data/rbi/openai/models/decision_input_part.rbi +2 -1
- data/rbi/openai/models/image_edit_completed_event.rbi +1 -0
- data/rbi/openai/models/image_edit_partial_image_event.rbi +1 -0
- data/rbi/openai/models/image_gen_completed_event.rbi +1 -0
- data/rbi/openai/models/image_gen_partial_image_event.rbi +1 -0
- data/rbi/openai/models/images_response.rbi +1 -0
- data/rbi/openai/models/live/built_in_voice.rbi +1 -0
- data/rbi/openai/models/live/client_event.rbi +4 -0
- data/rbi/openai/models/live/decision_create_event.rbi +55 -0
- data/rbi/openai/models/live/decision_event.rbi +185 -0
- data/rbi/openai/models/live/decision_item_create_event.rbi +338 -0
- data/rbi/openai/models/live/decision_item_created_event.rbi +354 -0
- data/rbi/openai/models/live/decision_item_delete_event.rbi +66 -0
- data/rbi/openai/models/live/decision_item_deleted_event.rbi +77 -0
- data/rbi/openai/models/live/decision_trigger.rbi +465 -0
- data/rbi/openai/models/live/decisions_delegation_config.rbi +393 -0
- data/rbi/openai/models/live/decisions_delegation_update_config.rbi +412 -0
- data/rbi/openai/models/live/delegation_created_event.rbi +8 -10
- data/rbi/openai/models/live/fork_client_event.rbi +4 -0
- data/rbi/openai/models/live/fork_server_event.rbi +5 -0
- data/rbi/openai/models/live/media_session_config.rbi +95 -14
- data/rbi/openai/models/live/output_audio_fixture_play_event.rbi +76 -0
- data/rbi/openai/models/live/output_audio_fixture_played_event.rbi +73 -0
- data/rbi/openai/models/live/output_audio_fixture_playing_event.rbi +72 -0
- data/rbi/openai/models/live/server_event.rbi +5 -0
- data/rbi/openai/models/live/session_accept_params.rbi +88 -12
- data/rbi/openai/models/live/session_config.rbi +100 -14
- data/rbi/openai/models/live/session_resource.rbi +81 -10
- data/rbi/openai/models/live/session_update_config.rbi +86 -9
- data/rbi/openai/models/live/session_update_event.rbi +8 -8
- data/rbi/openai/models/live/sideband_client_event.rbi +40 -0
- data/rbi/openai/models/live/sideband_server_event.rbi +47 -0
- data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +6 -3
- data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +6 -3
- data/rbi/openai/models/realtime/realtime_response_status.rbi +13 -1
- data/rbi/openai/models/realtime/realtime_translation_input_audio_buffer_append_event.rbi +1 -1
- data/rbi/openai/models/realtime/realtime_translation_output_audio_delta_event.rbi +3 -3
- data/rbi/openai/models/realtime/realtime_translation_session_close_event.rbi +1 -1
- data/rbi/openai/models/realtime/realtime_translation_session_update_event.rbi +5 -1
- data/rbi/openai/models/responses/response.rbi +2 -7
- data/rbi/openai/models/responses/response_create_params.rbi +5 -9
- data/rbi/openai/models/responses/response_error.rbi +24 -3
- data/rbi/openai/models/responses/response_function_tool_call.rbi +0 -4
- data/rbi/openai/models/responses/response_function_web_search.rbi +21 -17
- data/rbi/openai/models/responses/response_input_item.rbi +191 -0
- data/rbi/openai/models/responses/response_item.rbi +189 -0
- data/rbi/openai/models/responses/response_output_item.rbi +191 -0
- data/rbi/openai/models/responses/response_output_text.rbi +0 -4
- data/rbi/openai/models/responses/responses_client_event.rbi +2 -2
- data/rbi/openai/models/safety/safety_alert.rbi +13 -1
- data/rbi/openai/models/video_create_error.rbi +24 -3
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +1 -1
- data/rbi/openai/resources/admin/organization/external_storage.rbi +2 -1
- data/rbi/openai/resources/admin/organization/projects/api_keys.rbi +48 -0
- data/rbi/openai/resources/admin/organization/usage.rbi +56 -0
- data/rbi/openai/resources/audio/speech.rbi +2 -1
- data/rbi/openai/resources/audio/voices.rbi +13 -10
- data/rbi/openai/resources/beta/agents/environments/files.rbi +3 -33
- data/rbi/openai/resources/beta/agents/environments.rbi +3 -3
- data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi +5 -13
- data/rbi/openai/resources/beta/agents/sessions.rbi +15 -4
- data/rbi/openai/resources/beta/agents/vaults/credentials.rbi +9 -5
- data/rbi/openai/resources/beta/agents/vaults.rbi +34 -5
- data/rbi/openai/resources/beta/agents.rbi +6 -4
- data/rbi/openai/resources/beta/responses.rbi +2 -2
- data/rbi/openai/resources/chat/completions.rbi +26 -29
- data/rbi/openai/resources/decisions.rbi +9 -15
- data/rbi/openai/resources/files.rbi +0 -18
- data/rbi/openai/resources/live/forks.rbi +17 -0
- data/rbi/openai/resources/live/sideband.rbi +17 -0
- data/rbi/openai/resources/live.rbi +17 -0
- data/rbi/openai/resources/realtime/translations.rbi +17 -0
- data/rbi/openai/resources/realtime.rbi +17 -0
- data/rbi/openai/resources/responses.rbi +41 -333
- data/rbi/openai/resources/vector_stores/file_batches.rbi +0 -93
- data/rbi/openai/resources/vector_stores/files.rbi +0 -113
- data/rbi/openai/resources/webhooks.rbi +1 -1
- data/sig/openai/client.rbs +0 -50
- data/sig/openai/helpers/admin/organization/projects/api_keys.rbs +18 -0
- data/sig/openai/helpers/beta/agents/artifacts.rbs +17 -0
- data/sig/openai/helpers/beta/agents/files.rbs +30 -0
- data/sig/openai/helpers/client_runtime.rbs +53 -0
- data/sig/openai/helpers/files.rbs +12 -0
- data/sig/openai/helpers/models/responses/response.rbs +9 -0
- data/sig/openai/helpers/streaming/response_stream.rbs +37 -0
- data/sig/openai/helpers/vector_stores/file_batches.rbs +38 -0
- data/sig/openai/helpers/vector_stores/files.rbs +43 -0
- data/sig/openai/helpers/websocket.rbs +40 -0
- data/sig/openai/models/admin/organization/audit_log_list_response.rbs +1 -0
- data/sig/openai/models/admin/organization/external_storage_configuration.rbs +1 -0
- data/sig/openai/models/admin/organization/external_storage_create_params.rbs +33 -0
- data/sig/openai/models/admin/organization/oci_external_storage_provider.rbs +34 -0
- data/sig/openai/models/admin/organization/project_residency.rbs +6 -0
- data/sig/openai/models/admin/organization/projects/api_key_update_params.rbs +77 -0
- data/sig/openai/models/admin/organization/projects/api_key_update_scopes_params.rbs +38 -0
- data/sig/openai/models/admin/organization/usage_decisions_params.rbs +170 -0
- data/sig/openai/models/admin/organization/usage_decisions_response.rbs +319 -0
- data/sig/openai/models/audio/speech_create_params.rbs +4 -2
- data/sig/openai/models/audio/voice.rbs +21 -3
- data/sig/openai/models/audio/voice_create_params.rbs +90 -1
- data/sig/openai/models/beta/agent_create_params.rbs +4 -2
- data/sig/openai/models/beta/agent_list_params.rbs +9 -6
- data/sig/openai/models/beta/agent_session.rbs +36 -2
- data/sig/openai/models/beta/agent_update_params.rbs +4 -2
- data/sig/openai/models/beta/agents/environment_list_params.rbs +9 -9
- data/sig/openai/models/beta/agents/session_create_params.rbs +29 -2
- data/sig/openai/models/beta/agents/session_list_params.rbs +12 -12
- data/sig/openai/models/beta/agents/session_update_params.rbs +23 -0
- data/sig/openai/models/beta/agents/sessions/artifact_list_params.rbs +21 -15
- data/sig/openai/models/beta/agents/vault_list_params.rbs +32 -14
- data/sig/openai/models/beta/agents/vault_update_params.rbs +54 -0
- data/sig/openai/models/beta/agents/vaults/credential_list_params.rbs +32 -14
- data/sig/openai/models/beta/beta_response.rbs +2 -2
- data/sig/openai/models/beta/beta_response_error.rbs +19 -3
- data/sig/openai/models/beta/beta_response_input_item.rbs +110 -0
- data/sig/openai/models/beta/beta_response_item.rbs +110 -0
- data/sig/openai/models/beta/beta_response_output_item.rbs +110 -0
- data/sig/openai/models/beta/beta_responses_client_event.rbs +2 -2
- data/sig/openai/models/beta/response_create_params.rbs +2 -2
- data/sig/openai/models/beta/session_turn_error.rbs +4 -0
- data/sig/openai/models/chat/chat_completion_audio_param.rbs +2 -2
- data/sig/openai/models/chat/completion_create_params.rbs +2 -2
- data/sig/openai/models/conversations/conversation_item.rbs +110 -0
- data/sig/openai/models/decision.rbs +13 -0
- data/sig/openai/models/decision_create_params.rbs +19 -8
- data/sig/openai/models/decision_input_image.rbs +2 -2
- data/sig/openai/models/decision_input_message.rbs +2 -2
- data/sig/openai/models/live/built_in_voice.rbs +2 -0
- data/sig/openai/models/live/client_event.rbs +4 -0
- data/sig/openai/models/live/decision_create_event.rbs +18 -0
- data/sig/openai/models/live/decision_event.rbs +102 -0
- data/sig/openai/models/live/decision_item_create_event.rbs +183 -0
- data/sig/openai/models/live/decision_item_created_event.rbs +195 -0
- data/sig/openai/models/live/decision_item_delete_event.rbs +33 -0
- data/sig/openai/models/live/decision_item_deleted_event.rbs +49 -0
- data/sig/openai/models/live/decision_trigger.rbs +234 -0
- data/sig/openai/models/live/decisions_delegation_config.rbs +195 -0
- data/sig/openai/models/live/decisions_delegation_update_config.rbs +202 -0
- data/sig/openai/models/live/delegation_created_event.rbs +6 -7
- data/sig/openai/models/live/fork_client_event.rbs +4 -0
- data/sig/openai/models/live/fork_server_event.rbs +5 -0
- data/sig/openai/models/live/media_session_config.rbs +58 -11
- data/sig/openai/models/live/output_audio_fixture_play_event.rbs +42 -0
- data/sig/openai/models/live/output_audio_fixture_played_event.rbs +44 -0
- data/sig/openai/models/live/output_audio_fixture_playing_event.rbs +44 -0
- data/sig/openai/models/live/server_event.rbs +5 -0
- data/sig/openai/models/live/session_accept_params.rbs +57 -10
- data/sig/openai/models/live/session_config.rbs +58 -11
- data/sig/openai/models/live/session_resource.rbs +57 -10
- data/sig/openai/models/live/session_update_config.rbs +54 -3
- data/sig/openai/models/live/session_update_event.rbs +6 -6
- data/sig/openai/models/live/sideband_client_event.rbs +26 -0
- data/sig/openai/models/live/sideband_server_event.rbs +33 -0
- data/sig/openai/models/realtime/realtime_audio_config_output.rbs +6 -3
- data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +6 -3
- data/sig/openai/models/realtime/realtime_response_status.rbs +15 -3
- data/sig/openai/models/responses/response.rbs +2 -4
- data/sig/openai/models/responses/response_create_params.rbs +2 -2
- data/sig/openai/models/responses/response_error.rbs +19 -3
- data/sig/openai/models/responses/response_input_item.rbs +110 -0
- data/sig/openai/models/responses/response_item.rbs +110 -0
- data/sig/openai/models/responses/response_output_item.rbs +110 -0
- data/sig/openai/models/responses/responses_client_event.rbs +2 -2
- data/sig/openai/models/safety/safety_alert.rbs +12 -2
- data/sig/openai/models/video_create_error.rbs +19 -3
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -1
- data/sig/openai/resources/admin/organization/projects/api_keys.rbs +8 -0
- data/sig/openai/resources/admin/organization/usage.rbs +15 -0
- data/sig/openai/resources/beta/agents/environments/files.rbs +0 -17
- data/sig/openai/resources/beta/agents/sessions/artifacts.rbs +2 -6
- data/sig/openai/resources/beta/agents/sessions.rbs +4 -1
- data/sig/openai/resources/beta/agents/vaults/credentials.rbs +2 -1
- data/sig/openai/resources/beta/agents/vaults.rbs +9 -1
- data/sig/openai/resources/beta/agents.rbs +1 -1
- data/sig/openai/resources/files.rbs +0 -7
- data/sig/openai/resources/live/forks.rbs +8 -0
- data/sig/openai/resources/live/sideband.rbs +8 -0
- data/sig/openai/resources/live.rbs +7 -0
- data/sig/openai/resources/realtime/translations.rbs +7 -0
- data/sig/openai/resources/realtime.rbs +7 -0
- data/sig/openai/resources/responses.rbs +7 -31
- data/sig/openai/resources/vector_stores/file_batches.rbs +0 -31
- data/sig/openai/resources/vector_stores/files.rbs +0 -36
- data/sig/openai/resources/webhooks.rbs +1 -1
- metadata +89 -1
|
@@ -16,15 +16,22 @@ module OpenAI
|
|
|
16
16
|
optional :after, String
|
|
17
17
|
|
|
18
18
|
# @!attribute limit
|
|
19
|
-
# The maximum number of resources to return. Defaults to 20.
|
|
20
|
-
# between 1 and 100.
|
|
19
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
21
20
|
#
|
|
22
21
|
# @return [Integer, nil]
|
|
23
|
-
optional :limit, Integer
|
|
22
|
+
optional :limit, Integer
|
|
23
|
+
|
|
24
|
+
# @!attribute metadata
|
|
25
|
+
# Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
|
|
26
|
+
# match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
|
|
27
|
+
# characters. Filtering is eventually consistent; metadata changes may take time
|
|
28
|
+
# to appear.
|
|
29
|
+
#
|
|
30
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
31
|
+
optional :metadata, OpenAI::Internal::Type::HashOf[String]
|
|
24
32
|
|
|
25
33
|
# @!attribute order
|
|
26
|
-
#
|
|
27
|
-
# `desc` for descending order. Defaults to `desc`.
|
|
34
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
28
35
|
#
|
|
29
36
|
# @return [Symbol, OpenAI::Models::Beta::Agents::VaultListParams::Order, nil]
|
|
30
37
|
optional :order, enum: -> { OpenAI::Beta::Agents::VaultListParams::Order }
|
|
@@ -36,17 +43,21 @@ module OpenAI
|
|
|
36
43
|
# @return [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>, nil]
|
|
37
44
|
optional :status, union: -> { OpenAI::Beta::Agents::VaultStatusFilter }
|
|
38
45
|
|
|
39
|
-
# @!method initialize(after: nil, limit: nil, order: nil, status: nil, request_options: {})
|
|
46
|
+
# @!method initialize(after: nil, limit: nil, metadata: nil, order: nil, status: nil, request_options: {})
|
|
40
47
|
# @param after [String]
|
|
41
48
|
# Return resources after this resource ID in the selected order.
|
|
42
49
|
#
|
|
43
|
-
# @param limit [Integer
|
|
44
|
-
# The maximum number of resources to return. Defaults to 20.
|
|
45
|
-
#
|
|
50
|
+
# @param limit [Integer]
|
|
51
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
52
|
+
#
|
|
53
|
+
# @param metadata [Hash{Symbol=>String}]
|
|
54
|
+
# Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
|
|
55
|
+
# match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
|
|
56
|
+
# characters. Filtering is eventually consistent; metadata changes may take time
|
|
57
|
+
# to appear.
|
|
46
58
|
#
|
|
47
59
|
# @param order [Symbol, OpenAI::Models::Beta::Agents::VaultListParams::Order]
|
|
48
|
-
#
|
|
49
|
-
# `desc` for descending order. Defaults to `desc`.
|
|
60
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
50
61
|
#
|
|
51
62
|
# @param status [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>]
|
|
52
63
|
# Filter by one status or a list, such as `status=active` or
|
|
@@ -54,8 +65,7 @@ module OpenAI
|
|
|
54
65
|
#
|
|
55
66
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
56
67
|
|
|
57
|
-
#
|
|
58
|
-
# `desc` for descending order. Defaults to `desc`.
|
|
68
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
59
69
|
module Order
|
|
60
70
|
extend OpenAI::Internal::Type::Enum
|
|
61
71
|
|
|
@@ -17,9 +17,7 @@ module OpenAI
|
|
|
17
17
|
# @return [Array(Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>)]
|
|
18
18
|
|
|
19
19
|
# @type [OpenAI::Internal::Type::Converter]
|
|
20
|
-
VaultStatusArray = OpenAI::Internal::Type::ArrayOf[
|
|
21
|
-
enum: -> { OpenAI::Models::Beta::Agents::VaultStatus }
|
|
22
|
-
]
|
|
20
|
+
VaultStatusArray = OpenAI::Internal::Type::ArrayOf[enum: -> { OpenAI::Models::Beta::Agents::VaultStatus }]
|
|
23
21
|
end
|
|
24
22
|
end
|
|
25
23
|
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Beta
|
|
6
|
+
module Agents
|
|
7
|
+
# @see OpenAI::Resources::Beta::Agents::Vaults#update
|
|
8
|
+
class VaultUpdateParams < OpenAI::Internal::Type::BaseModel
|
|
9
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute vault_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :vault_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute metadata
|
|
18
|
+
# Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16
|
|
19
|
+
# string key-value pairs, with keys up to 64 and values up to 512 characters.
|
|
20
|
+
#
|
|
21
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
22
|
+
optional :metadata, OpenAI::Internal::Type::HashOf[String]
|
|
23
|
+
|
|
24
|
+
# @!attribute name
|
|
25
|
+
# A replacement name. Omit to leave unchanged, or pass null to clear it. The name
|
|
26
|
+
# is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :name, String, nil?: true
|
|
30
|
+
|
|
31
|
+
# @!method initialize(vault_id:, metadata: nil, name: nil, request_options: {})
|
|
32
|
+
# @param vault_id [String]
|
|
33
|
+
#
|
|
34
|
+
# @param metadata [Hash{Symbol=>String}]
|
|
35
|
+
# Replaces all metadata. Omit to leave unchanged, or pass {} to clear it. Up to 16
|
|
36
|
+
# string key-value pairs, with keys up to 64 and values up to 512 characters.
|
|
37
|
+
#
|
|
38
|
+
# @param name [String, nil]
|
|
39
|
+
# A replacement name. Omit to leave unchanged, or pass null to clear it. The name
|
|
40
|
+
# is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.
|
|
41
|
+
#
|
|
42
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -22,15 +22,22 @@ module OpenAI
|
|
|
22
22
|
optional :after, String
|
|
23
23
|
|
|
24
24
|
# @!attribute limit
|
|
25
|
-
# The maximum number of resources to return. Defaults to 20.
|
|
26
|
-
# between 1 and 100.
|
|
25
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
27
26
|
#
|
|
28
27
|
# @return [Integer, nil]
|
|
29
|
-
optional :limit, Integer
|
|
28
|
+
optional :limit, Integer
|
|
29
|
+
|
|
30
|
+
# @!attribute metadata
|
|
31
|
+
# Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
|
|
32
|
+
# match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
|
|
33
|
+
# characters. Filtering is eventually consistent; metadata changes may take time
|
|
34
|
+
# to appear.
|
|
35
|
+
#
|
|
36
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
37
|
+
optional :metadata, OpenAI::Internal::Type::HashOf[String]
|
|
30
38
|
|
|
31
39
|
# @!attribute order
|
|
32
|
-
#
|
|
33
|
-
# `desc` for descending order. Defaults to `desc`.
|
|
40
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
34
41
|
#
|
|
35
42
|
# @return [Symbol, OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::Order, nil]
|
|
36
43
|
optional :order, enum: -> { OpenAI::Beta::Agents::Vaults::CredentialListParams::Order }
|
|
@@ -42,19 +49,23 @@ module OpenAI
|
|
|
42
49
|
# @return [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>, nil]
|
|
43
50
|
optional :status, union: -> { OpenAI::Beta::Agents::VaultStatusFilter }
|
|
44
51
|
|
|
45
|
-
# @!method initialize(vault_id:, after: nil, limit: nil, order: nil, status: nil, request_options: {})
|
|
52
|
+
# @!method initialize(vault_id:, after: nil, limit: nil, metadata: nil, order: nil, status: nil, request_options: {})
|
|
46
53
|
# @param vault_id [String]
|
|
47
54
|
#
|
|
48
55
|
# @param after [String]
|
|
49
56
|
# Return resources after this resource ID in the selected order.
|
|
50
57
|
#
|
|
51
|
-
# @param limit [Integer
|
|
52
|
-
# The maximum number of resources to return. Defaults to 20.
|
|
53
|
-
#
|
|
58
|
+
# @param limit [Integer]
|
|
59
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
60
|
+
#
|
|
61
|
+
# @param metadata [Hash{Symbol=>String}]
|
|
62
|
+
# Exact string matches supplied as `metadata[key]=value`. All supplied pairs must
|
|
63
|
+
# match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512
|
|
64
|
+
# characters. Filtering is eventually consistent; metadata changes may take time
|
|
65
|
+
# to appear.
|
|
54
66
|
#
|
|
55
67
|
# @param order [Symbol, OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::Order]
|
|
56
|
-
#
|
|
57
|
-
# `desc` for descending order. Defaults to `desc`.
|
|
68
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
58
69
|
#
|
|
59
70
|
# @param status [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>]
|
|
60
71
|
# Filter by one status or a list, such as `status=active` or
|
|
@@ -62,8 +73,7 @@ module OpenAI
|
|
|
62
73
|
#
|
|
63
74
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
64
75
|
|
|
65
|
-
#
|
|
66
|
-
# `desc` for descending order. Defaults to `desc`.
|
|
76
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
67
77
|
module Order
|
|
68
78
|
extend OpenAI::Internal::Type::Enum
|
|
69
79
|
|
|
@@ -263,7 +263,7 @@ module OpenAI
|
|
|
263
263
|
# @!attribute safety_identifier
|
|
264
264
|
# A stable identifier used to help detect users of your application that may be
|
|
265
265
|
# violating OpenAI's usage policies. The IDs should be a string that uniquely
|
|
266
|
-
# identifies each user, with a maximum length of
|
|
266
|
+
# identifies each user, with a maximum length of 128 characters. We recommend
|
|
267
267
|
# hashing their username or email address, in order to avoid sending us any
|
|
268
268
|
# identifying information.
|
|
269
269
|
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
@@ -522,7 +522,7 @@ module OpenAI
|
|
|
522
522
|
# @param safety_identifier [String, nil]
|
|
523
523
|
# A stable identifier used to help detect users of your application that may be
|
|
524
524
|
# violating OpenAI's usage policies. The IDs should be a string that uniquely
|
|
525
|
-
# identifies each user, with a maximum length of
|
|
525
|
+
# identifies each user, with a maximum length of 128 characters. We recommend
|
|
526
526
|
# hashing their username or email address, in order to avoid sending us any
|
|
527
527
|
# identifying information.
|
|
528
528
|
# [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
@@ -934,6 +934,9 @@ module OpenAI
|
|
|
934
934
|
GPT_5_5_2026_04_23 = :"gpt-5.5-2026-04-23"
|
|
935
935
|
GPT_5_4 = :"gpt-5.4"
|
|
936
936
|
GPT_5_4_MINI = :"gpt-5.4-mini"
|
|
937
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
938
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
939
|
+
# replacements.
|
|
937
940
|
GPT_5_4_NANO = :"gpt-5.4-nano"
|
|
938
941
|
GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
|
|
939
942
|
GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
|
|
@@ -949,6 +952,9 @@ module OpenAI
|
|
|
949
952
|
GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
|
|
950
953
|
GPT_5_2_PRO = :"gpt-5.2-pro"
|
|
951
954
|
GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
|
|
955
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
956
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
957
|
+
# replacements.
|
|
952
958
|
GPT_5_1 = :"gpt-5.1"
|
|
953
959
|
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
954
960
|
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
@@ -995,7 +1001,13 @@ module OpenAI
|
|
|
995
1001
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
996
1002
|
# replacements.
|
|
997
1003
|
GPT_4_1_NANO = :"gpt-4.1-nano"
|
|
1004
|
+
# @deprecated Announced shutdown date: 2027-01-14. See
|
|
1005
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1006
|
+
# replacements.
|
|
998
1007
|
GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
|
|
1008
|
+
# @deprecated Announced shutdown date: 2027-01-14. See
|
|
1009
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1010
|
+
# replacements.
|
|
999
1011
|
GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
|
|
1000
1012
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1001
1013
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -1050,7 +1062,13 @@ module OpenAI
|
|
|
1050
1062
|
# replacements.
|
|
1051
1063
|
O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
|
|
1052
1064
|
GPT_4O = :"gpt-4o"
|
|
1065
|
+
# @deprecated Announced shutdown date: 2027-01-14. See
|
|
1066
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1067
|
+
# replacements.
|
|
1053
1068
|
GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
|
|
1069
|
+
# @deprecated Announced shutdown date: 2027-01-14. See
|
|
1070
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1071
|
+
# replacements.
|
|
1054
1072
|
GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
|
|
1055
1073
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1056
1074
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -1113,6 +1131,9 @@ module OpenAI
|
|
|
1113
1131
|
# replacements.
|
|
1114
1132
|
CODEX_MINI_LATEST = :"codex-mini-latest"
|
|
1115
1133
|
GPT_4O_MINI = :"gpt-4o-mini"
|
|
1134
|
+
# @deprecated Announced shutdown date: 2027-01-14. See
|
|
1135
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1136
|
+
# replacements.
|
|
1116
1137
|
GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
|
|
1117
1138
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1118
1139
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -21,7 +21,19 @@ module OpenAI
|
|
|
21
21
|
# @return [OpenAI::Models::Beta::BetaResponseError::Misalignment, nil]
|
|
22
22
|
optional :misalignment, -> { OpenAI::Beta::BetaResponseError::Misalignment }
|
|
23
23
|
|
|
24
|
-
# @!
|
|
24
|
+
# @!attribute param
|
|
25
|
+
# The request parameter associated with the error, or null if none was recorded.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :param, String, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute type
|
|
31
|
+
# The original error type, or null if it was not recorded.
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :type, String, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!method initialize(code:, message:, misalignment: nil, param: nil, type: nil)
|
|
25
37
|
# An error object returned when the model fails to generate a Response.
|
|
26
38
|
#
|
|
27
39
|
# @param code [Symbol, OpenAI::Models::Beta::BetaResponseError::Code]
|
|
@@ -31,6 +43,12 @@ module OpenAI
|
|
|
31
43
|
# A human-readable description of the error.
|
|
32
44
|
#
|
|
33
45
|
# @param misalignment [OpenAI::Models::Beta::BetaResponseError::Misalignment]
|
|
46
|
+
#
|
|
47
|
+
# @param param [String, nil]
|
|
48
|
+
# The request parameter associated with the error, or null if none was recorded.
|
|
49
|
+
#
|
|
50
|
+
# @param type [String, nil]
|
|
51
|
+
# The original error type, or null if it was not recorded.
|
|
34
52
|
|
|
35
53
|
# The error code for the response.
|
|
36
54
|
#
|
|
@@ -1322,6 +1322,12 @@ module OpenAI
|
|
|
1322
1322
|
nil?: true
|
|
1323
1323
|
)
|
|
1324
1324
|
|
|
1325
|
+
# @!attribute error
|
|
1326
|
+
# Details of a moderation failure, when available.
|
|
1327
|
+
#
|
|
1328
|
+
# @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error, nil]
|
|
1329
|
+
optional :error, -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error }
|
|
1330
|
+
|
|
1325
1331
|
# @!attribute output_format
|
|
1326
1332
|
# The output format used for generation.
|
|
1327
1333
|
#
|
|
@@ -1361,7 +1367,7 @@ module OpenAI
|
|
|
1361
1367
|
nil?: true
|
|
1362
1368
|
)
|
|
1363
1369
|
|
|
1364
|
-
# @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
1370
|
+
# @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
1365
1371
|
# An image generation request made by the model.
|
|
1366
1372
|
#
|
|
1367
1373
|
# @param id [String]
|
|
@@ -1382,6 +1388,9 @@ module OpenAI
|
|
|
1382
1388
|
# @param background [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Background, nil]
|
|
1383
1389
|
# The background setting used for generation.
|
|
1384
1390
|
#
|
|
1391
|
+
# @param error [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error]
|
|
1392
|
+
# Details of a moderation failure, when available.
|
|
1393
|
+
#
|
|
1385
1394
|
# @param output_format [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat, nil]
|
|
1386
1395
|
# The output format used for generation.
|
|
1387
1396
|
#
|
|
@@ -1456,6 +1465,103 @@ module OpenAI
|
|
|
1456
1465
|
# @return [Array<Symbol>]
|
|
1457
1466
|
end
|
|
1458
1467
|
|
|
1468
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#error
|
|
1469
|
+
class Error < OpenAI::Internal::Type::BaseModel
|
|
1470
|
+
# @!attribute code
|
|
1471
|
+
# The error code.
|
|
1472
|
+
#
|
|
1473
|
+
# @return [String, nil]
|
|
1474
|
+
required :code, String, nil?: true
|
|
1475
|
+
|
|
1476
|
+
# @!attribute message
|
|
1477
|
+
# A description of the error.
|
|
1478
|
+
#
|
|
1479
|
+
# @return [String]
|
|
1480
|
+
required :message, String
|
|
1481
|
+
|
|
1482
|
+
# @!attribute param
|
|
1483
|
+
# The related request parameter.
|
|
1484
|
+
#
|
|
1485
|
+
# @return [String, nil]
|
|
1486
|
+
required :param, String, nil?: true
|
|
1487
|
+
|
|
1488
|
+
# @!attribute type
|
|
1489
|
+
# The error type.
|
|
1490
|
+
#
|
|
1491
|
+
# @return [String]
|
|
1492
|
+
required :type, String
|
|
1493
|
+
|
|
1494
|
+
# @!attribute moderation_details
|
|
1495
|
+
# Public details for a `moderation_blocked` error, when available.
|
|
1496
|
+
#
|
|
1497
|
+
# @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails, nil]
|
|
1498
|
+
optional(
|
|
1499
|
+
:moderation_details,
|
|
1500
|
+
-> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails }
|
|
1501
|
+
)
|
|
1502
|
+
|
|
1503
|
+
# @!method initialize(code:, message:, param:, type:, moderation_details: nil)
|
|
1504
|
+
# Details of a moderation failure, when available.
|
|
1505
|
+
#
|
|
1506
|
+
# @param code [String, nil]
|
|
1507
|
+
# The error code.
|
|
1508
|
+
#
|
|
1509
|
+
# @param message [String]
|
|
1510
|
+
# A description of the error.
|
|
1511
|
+
#
|
|
1512
|
+
# @param param [String, nil]
|
|
1513
|
+
# The related request parameter.
|
|
1514
|
+
#
|
|
1515
|
+
# @param type [String]
|
|
1516
|
+
# The error type.
|
|
1517
|
+
#
|
|
1518
|
+
# @param moderation_details [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails]
|
|
1519
|
+
# Public details for a `moderation_blocked` error, when available.
|
|
1520
|
+
|
|
1521
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error#moderation_details
|
|
1522
|
+
class ModerationDetails < OpenAI::Internal::Type::BaseModel
|
|
1523
|
+
# @!attribute categories
|
|
1524
|
+
# Public moderation categories. New category values may be added over time.
|
|
1525
|
+
#
|
|
1526
|
+
# @return [Array<String>]
|
|
1527
|
+
required :categories, OpenAI::Internal::Type::ArrayOf[String]
|
|
1528
|
+
|
|
1529
|
+
# @!attribute moderation_stage
|
|
1530
|
+
# The stage where moderation blocked the image generation call.
|
|
1531
|
+
#
|
|
1532
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage]
|
|
1533
|
+
required(
|
|
1534
|
+
:moderation_stage,
|
|
1535
|
+
enum: -> {
|
|
1536
|
+
OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage
|
|
1537
|
+
}
|
|
1538
|
+
)
|
|
1539
|
+
|
|
1540
|
+
# @!method initialize(categories:, moderation_stage:)
|
|
1541
|
+
# Public details for a `moderation_blocked` error, when available.
|
|
1542
|
+
#
|
|
1543
|
+
# @param categories [Array<String>]
|
|
1544
|
+
# Public moderation categories. New category values may be added over time.
|
|
1545
|
+
#
|
|
1546
|
+
# @param moderation_stage [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage]
|
|
1547
|
+
# The stage where moderation blocked the image generation call.
|
|
1548
|
+
|
|
1549
|
+
# The stage where moderation blocked the image generation call.
|
|
1550
|
+
#
|
|
1551
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Error::ModerationDetails#moderation_stage
|
|
1552
|
+
module ModerationStage
|
|
1553
|
+
extend OpenAI::Internal::Type::Enum
|
|
1554
|
+
|
|
1555
|
+
INPUT = :input
|
|
1556
|
+
OUTPUT = :output
|
|
1557
|
+
UNKNOWN = :unknown
|
|
1558
|
+
|
|
1559
|
+
# @!method self.values
|
|
1560
|
+
# @return [Array<Symbol>]
|
|
1561
|
+
end
|
|
1562
|
+
end
|
|
1563
|
+
end
|
|
1564
|
+
|
|
1459
1565
|
# The output format used for generation.
|
|
1460
1566
|
#
|
|
1461
1567
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#output_format
|
|
@@ -878,6 +878,12 @@ module OpenAI
|
|
|
878
878
|
nil?: true
|
|
879
879
|
)
|
|
880
880
|
|
|
881
|
+
# @!attribute error
|
|
882
|
+
# Details of a moderation failure, when available.
|
|
883
|
+
#
|
|
884
|
+
# @return [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error, nil]
|
|
885
|
+
optional :error, -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Error }
|
|
886
|
+
|
|
881
887
|
# @!attribute output_format
|
|
882
888
|
# The output format used for generation.
|
|
883
889
|
#
|
|
@@ -913,7 +919,7 @@ module OpenAI
|
|
|
913
919
|
# @return [String, Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size, nil]
|
|
914
920
|
optional :size, union: -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Size }, nil?: true
|
|
915
921
|
|
|
916
|
-
# @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
922
|
+
# @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
917
923
|
# An image generation request made by the model.
|
|
918
924
|
#
|
|
919
925
|
# @param id [String]
|
|
@@ -934,6 +940,9 @@ module OpenAI
|
|
|
934
940
|
# @param background [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Background, nil]
|
|
935
941
|
# The background setting used for generation.
|
|
936
942
|
#
|
|
943
|
+
# @param error [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error]
|
|
944
|
+
# Details of a moderation failure, when available.
|
|
945
|
+
#
|
|
937
946
|
# @param output_format [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::OutputFormat, nil]
|
|
938
947
|
# The output format used for generation.
|
|
939
948
|
#
|
|
@@ -1008,6 +1017,103 @@ module OpenAI
|
|
|
1008
1017
|
# @return [Array<Symbol>]
|
|
1009
1018
|
end
|
|
1010
1019
|
|
|
1020
|
+
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#error
|
|
1021
|
+
class Error < OpenAI::Internal::Type::BaseModel
|
|
1022
|
+
# @!attribute code
|
|
1023
|
+
# The error code.
|
|
1024
|
+
#
|
|
1025
|
+
# @return [String, nil]
|
|
1026
|
+
required :code, String, nil?: true
|
|
1027
|
+
|
|
1028
|
+
# @!attribute message
|
|
1029
|
+
# A description of the error.
|
|
1030
|
+
#
|
|
1031
|
+
# @return [String]
|
|
1032
|
+
required :message, String
|
|
1033
|
+
|
|
1034
|
+
# @!attribute param
|
|
1035
|
+
# The related request parameter.
|
|
1036
|
+
#
|
|
1037
|
+
# @return [String, nil]
|
|
1038
|
+
required :param, String, nil?: true
|
|
1039
|
+
|
|
1040
|
+
# @!attribute type
|
|
1041
|
+
# The error type.
|
|
1042
|
+
#
|
|
1043
|
+
# @return [String]
|
|
1044
|
+
required :type, String
|
|
1045
|
+
|
|
1046
|
+
# @!attribute moderation_details
|
|
1047
|
+
# Public details for a `moderation_blocked` error, when available.
|
|
1048
|
+
#
|
|
1049
|
+
# @return [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error::ModerationDetails, nil]
|
|
1050
|
+
optional(
|
|
1051
|
+
:moderation_details,
|
|
1052
|
+
-> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Error::ModerationDetails }
|
|
1053
|
+
)
|
|
1054
|
+
|
|
1055
|
+
# @!method initialize(code:, message:, param:, type:, moderation_details: nil)
|
|
1056
|
+
# Details of a moderation failure, when available.
|
|
1057
|
+
#
|
|
1058
|
+
# @param code [String, nil]
|
|
1059
|
+
# The error code.
|
|
1060
|
+
#
|
|
1061
|
+
# @param message [String]
|
|
1062
|
+
# A description of the error.
|
|
1063
|
+
#
|
|
1064
|
+
# @param param [String, nil]
|
|
1065
|
+
# The related request parameter.
|
|
1066
|
+
#
|
|
1067
|
+
# @param type [String]
|
|
1068
|
+
# The error type.
|
|
1069
|
+
#
|
|
1070
|
+
# @param moderation_details [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error::ModerationDetails]
|
|
1071
|
+
# Public details for a `moderation_blocked` error, when available.
|
|
1072
|
+
|
|
1073
|
+
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error#moderation_details
|
|
1074
|
+
class ModerationDetails < OpenAI::Internal::Type::BaseModel
|
|
1075
|
+
# @!attribute categories
|
|
1076
|
+
# Public moderation categories. New category values may be added over time.
|
|
1077
|
+
#
|
|
1078
|
+
# @return [Array<String>]
|
|
1079
|
+
required :categories, OpenAI::Internal::Type::ArrayOf[String]
|
|
1080
|
+
|
|
1081
|
+
# @!attribute moderation_stage
|
|
1082
|
+
# The stage where moderation blocked the image generation call.
|
|
1083
|
+
#
|
|
1084
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage]
|
|
1085
|
+
required(
|
|
1086
|
+
:moderation_stage,
|
|
1087
|
+
enum: -> {
|
|
1088
|
+
OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage
|
|
1089
|
+
}
|
|
1090
|
+
)
|
|
1091
|
+
|
|
1092
|
+
# @!method initialize(categories:, moderation_stage:)
|
|
1093
|
+
# Public details for a `moderation_blocked` error, when available.
|
|
1094
|
+
#
|
|
1095
|
+
# @param categories [Array<String>]
|
|
1096
|
+
# Public moderation categories. New category values may be added over time.
|
|
1097
|
+
#
|
|
1098
|
+
# @param moderation_stage [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage]
|
|
1099
|
+
# The stage where moderation blocked the image generation call.
|
|
1100
|
+
|
|
1101
|
+
# The stage where moderation blocked the image generation call.
|
|
1102
|
+
#
|
|
1103
|
+
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Error::ModerationDetails#moderation_stage
|
|
1104
|
+
module ModerationStage
|
|
1105
|
+
extend OpenAI::Internal::Type::Enum
|
|
1106
|
+
|
|
1107
|
+
INPUT = :input
|
|
1108
|
+
OUTPUT = :output
|
|
1109
|
+
UNKNOWN = :unknown
|
|
1110
|
+
|
|
1111
|
+
# @!method self.values
|
|
1112
|
+
# @return [Array<Symbol>]
|
|
1113
|
+
end
|
|
1114
|
+
end
|
|
1115
|
+
end
|
|
1116
|
+
|
|
1011
1117
|
# The output format used for generation.
|
|
1012
1118
|
#
|
|
1013
1119
|
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#output_format
|