openai 0.83.0 → 0.85.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 +59 -0
- data/README.md +1 -1
- data/SECURITY.md +10 -0
- data/docs/architecture/security-model.md +267 -0
- data/lib/openai/auth/workload_identity_auth.rb +17 -2
- data/lib/openai/client.rb +24 -6
- data/lib/openai/errors.rb +1 -1
- data/lib/openai/helpers/streaming/chat_completion_stream.rb +18 -10
- data/lib/openai/helpers/streaming/response_events.rb +2 -2
- data/lib/openai/helpers/streaming/response_stream.rb +80 -44
- data/lib/openai/helpers/structured_output/array_of.rb +2 -2
- data/lib/openai/helpers/structured_output/base_model.rb +19 -5
- data/lib/openai/helpers/structured_output/chat_completion_parser.rb +12 -3
- data/lib/openai/helpers/structured_output/json_schema_converter.rb +34 -11
- data/lib/openai/helpers/structured_output/response_parser.rb +1 -1
- data/lib/openai/internal/type/base_model.rb +2 -2
- data/lib/openai/internal/type/converter.rb +1 -1
- data/lib/openai/internal/util.rb +2 -2
- data/lib/openai/internal/vector_store_file_uploader.rb +1 -1
- data/lib/openai/models/admin/organization/usage_costs_params.rb +10 -1
- data/lib/openai/models/batch.rb +4 -4
- data/lib/openai/models/beta/beta_custom_tool.rb +13 -1
- data/lib/openai/models/beta/beta_function_tool.rb +8 -1
- data/lib/openai/models/beta/beta_namespace_tool.rb +10 -1
- data/lib/openai/models/beta/beta_response.rb +26 -18
- data/lib/openai/models/beta/beta_response_configuration_update_item.rb +103 -0
- data/lib/openai/models/beta/beta_response_configuration_update_item_param.rb +104 -0
- data/lib/openai/models/beta/beta_response_custom_tool_call.rb +9 -1
- data/lib/openai/models/beta/beta_response_custom_tool_call_item.rb +3 -1
- data/lib/openai/models/beta/beta_response_error.rb +96 -1
- data/lib/openai/models/beta/beta_response_function_tool_call.rb +9 -1
- data/lib/openai/models/beta/beta_response_function_tool_call_item.rb +3 -1
- data/lib/openai/models/beta/beta_response_incomplete_event.rb +4 -0
- data/lib/openai/models/beta/beta_response_inject_event.rb +2 -2
- data/lib/openai/models/beta/beta_response_inject_failed_event.rb +2 -2
- data/lib/openai/models/beta/beta_response_input_item.rb +6 -1
- data/lib/openai/models/beta/beta_response_item.rb +5 -1
- data/lib/openai/models/beta/beta_response_steer_accepted_event.rb +81 -0
- data/lib/openai/models/beta/beta_response_steer_error_code.rb +61 -0
- data/lib/openai/models/beta/beta_response_steer_event.rb +75 -0
- data/lib/openai/models/beta/beta_response_steer_failed_event.rb +151 -0
- data/lib/openai/models/beta/beta_response_steer_input.rb +360 -0
- data/lib/openai/models/beta/beta_response_steer_input_content.rb +28 -0
- data/lib/openai/models/beta/beta_response_steer_pending_event.rb +113 -0
- data/lib/openai/models/beta/beta_response_steer_pending_reason.rb +26 -0
- data/lib/openai/models/beta/beta_response_steer_required_input.rb +215 -0
- data/lib/openai/models/beta/beta_response_stream_event.rb +4 -0
- data/lib/openai/models/beta/beta_response_usage.rb +1 -12
- data/lib/openai/models/beta/beta_responses_client_event.rb +45 -16
- data/lib/openai/models/beta/beta_responses_server_event.rb +164 -2
- data/lib/openai/models/beta/response_compact_params.rb +13 -10
- data/lib/openai/models/beta/response_create_params.rb +14 -15
- data/lib/openai/models/beta/responses/beta_response_item_list.rb +2 -2
- data/lib/openai/models/beta/responses/input_token_count_params.rb +3 -3
- data/lib/openai/models/chat/completion_create_params.rb +8 -8
- data/lib/openai/models/chat_model.rb +1 -0
- data/lib/openai/models/completion_usage.rb +1 -12
- data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
- data/lib/openai/models/conversations/conversation_item.rb +5 -1
- data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
- data/lib/openai/models/conversations/item_create_params.rb +2 -2
- data/lib/openai/models/error_object.rb +90 -1
- data/lib/openai/models/eval_create_response.rb +1 -1
- data/lib/openai/models/eval_list_response.rb +1 -1
- data/lib/openai/models/eval_retrieve_response.rb +1 -1
- data/lib/openai/models/eval_update_response.rb +1 -1
- data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +2 -2
- data/lib/openai/models/reasoning.rb +0 -2
- data/lib/openai/models/responses/custom_tool.rb +13 -1
- data/lib/openai/models/responses/function_tool.rb +8 -1
- data/lib/openai/models/responses/input_token_count_params.rb +3 -3
- data/lib/openai/models/responses/namespace_tool.rb +10 -1
- data/lib/openai/models/responses/response.rb +20 -13
- data/lib/openai/models/responses/response_compact_params.rb +13 -10
- data/lib/openai/models/responses/response_configuration_update_item.rb +56 -0
- data/lib/openai/models/responses/response_configuration_update_item_param.rb +57 -0
- data/lib/openai/models/responses/response_create_params.rb +8 -10
- data/lib/openai/models/responses/response_custom_tool_call.rb +9 -1
- data/lib/openai/models/responses/response_custom_tool_call_item.rb +3 -1
- data/lib/openai/models/responses/response_error.rb +96 -1
- data/lib/openai/models/responses/response_function_tool_call.rb +9 -1
- data/lib/openai/models/responses/response_function_tool_call_item.rb +3 -1
- data/lib/openai/models/responses/response_incomplete_event.rb +4 -0
- data/lib/openai/models/responses/response_input_item.rb +6 -1
- data/lib/openai/models/responses/response_item.rb +5 -1
- data/lib/openai/models/responses/response_item_list.rb +2 -2
- data/lib/openai/models/responses/response_steer_accepted_event.rb +79 -0
- data/lib/openai/models/responses/response_steer_error_code.rb +59 -0
- data/lib/openai/models/responses/response_steer_event.rb +73 -0
- data/lib/openai/models/responses/response_steer_failed_event.rb +149 -0
- data/lib/openai/models/responses/response_steer_input.rb +304 -0
- data/lib/openai/models/responses/response_steer_input_content.rb +26 -0
- data/lib/openai/models/responses/response_steer_pending_event.rb +111 -0
- data/lib/openai/models/responses/response_steer_pending_reason.rb +24 -0
- data/lib/openai/models/responses/response_steer_required_input.rb +213 -0
- data/lib/openai/models/responses/response_stream_event.rb +4 -0
- data/lib/openai/models/responses/response_usage.rb +1 -12
- data/lib/openai/models/responses/responses_client_event.rb +872 -771
- data/lib/openai/models/responses/responses_server_event.rb +162 -2
- data/lib/openai/models/safety/alert_retrieve_params.rb +24 -0
- data/lib/openai/models/safety/safety_alert.rb +96 -0
- data/lib/openai/models/video_create_error.rb +93 -1
- data/lib/openai/models/webhooks/safety_alert_created_webhook_event.rb +63 -0
- data/lib/openai/models/webhooks/safety_org_alert_created_webhook_event.rb +63 -0
- data/lib/openai/models/webhooks/unwrap_webhook_event.rb +7 -1
- data/lib/openai/models.rb +2 -0
- data/lib/openai/net_http_client.rb +1 -1
- data/lib/openai/providers/bedrock.rb +20 -12
- data/lib/openai/resources/admin/organization/usage.rb +3 -1
- data/lib/openai/resources/beta/responses/input_items.rb +1 -1
- data/lib/openai/resources/beta/responses/input_tokens.rb +1 -1
- data/lib/openai/resources/beta/responses.rb +8 -8
- data/lib/openai/resources/chat/completions.rb +2 -2
- data/lib/openai/resources/conversations/items.rb +3 -3
- data/lib/openai/resources/conversations.rb +1 -1
- data/lib/openai/resources/responses/input_items.rb +1 -1
- data/lib/openai/resources/responses/input_tokens.rb +1 -1
- data/lib/openai/resources/responses.rb +10 -9
- data/lib/openai/resources/safety/alerts.rb +37 -0
- data/lib/openai/resources/safety.rb +18 -0
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +29 -0
- data/rbi/openai/client.rbi +3 -0
- data/rbi/openai/errors.rbi +1 -1
- data/rbi/openai/helpers/streaming/events.rbi +2 -2
- data/rbi/openai/helpers/streaming/response_stream.rbi +3 -3
- data/rbi/openai/models/admin/organization/usage_costs_params.rbi +15 -0
- data/rbi/openai/models/batch.rbi +6 -6
- data/rbi/openai/models/beta/beta_custom_tool.rbi +15 -0
- data/rbi/openai/models/beta/beta_function_tool.rbi +11 -0
- data/rbi/openai/models/beta/beta_namespace_tool.rbi +15 -0
- data/rbi/openai/models/beta/beta_response.rbi +21 -18
- data/rbi/openai/models/beta/beta_response_configuration_update_item.rbi +200 -0
- data/rbi/openai/models/beta/beta_response_configuration_update_item_param.rbi +207 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call.rbi +13 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call_item.rbi +6 -0
- data/rbi/openai/models/beta/beta_response_error.rbi +161 -3
- data/rbi/openai/models/beta/beta_response_function_tool_call.rbi +13 -0
- data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi +6 -0
- data/rbi/openai/models/beta/beta_response_incomplete_event.rbi +4 -0
- data/rbi/openai/models/beta/beta_response_inject_event.rbi +3 -0
- data/rbi/openai/models/beta/beta_response_inject_failed_event.rbi +3 -0
- data/rbi/openai/models/beta/beta_response_input_item.rbi +1 -0
- data/rbi/openai/models/beta/beta_response_item.rbi +1 -0
- data/rbi/openai/models/beta/beta_response_steer_accepted_event.rbi +148 -0
- data/rbi/openai/models/beta/beta_response_steer_error_code.rbi +65 -0
- data/rbi/openai/models/beta/beta_response_steer_event.rbi +118 -0
- data/rbi/openai/models/beta/beta_response_steer_failed_event.rbi +267 -0
- data/rbi/openai/models/beta/beta_response_steer_input.rbi +602 -0
- data/rbi/openai/models/beta/beta_response_steer_input_content.rbi +31 -0
- data/rbi/openai/models/beta/beta_response_steer_pending_event.rbi +222 -0
- data/rbi/openai/models/beta/beta_response_steer_pending_reason.rbi +35 -0
- data/rbi/openai/models/beta/beta_response_steer_required_input.rbi +379 -0
- data/rbi/openai/models/beta/beta_response_usage.rbi +3 -13
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +14 -15
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +206 -3
- data/rbi/openai/models/beta/response_compact_params.rbi +10 -9
- data/rbi/openai/models/beta/response_create_params.rbi +10 -15
- data/rbi/openai/models/beta/responses/beta_response_item_list.rbi +1 -0
- data/rbi/openai/models/chat/completion_create_params.rbi +9 -9
- data/rbi/openai/models/chat_model.rbi +1 -0
- data/rbi/openai/models/completion_usage.rbi +0 -10
- data/rbi/openai/models/conversations/conversation_create_params.rbi +3 -0
- data/rbi/openai/models/conversations/conversation_item.rbi +1 -0
- data/rbi/openai/models/conversations/conversation_item_list.rbi +1 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +3 -0
- data/rbi/openai/models/error_object.rbi +156 -3
- data/rbi/openai/models/eval_create_response.rbi +1 -1
- data/rbi/openai/models/eval_list_response.rbi +1 -1
- data/rbi/openai/models/eval_retrieve_response.rbi +1 -1
- data/rbi/openai/models/eval_update_response.rbi +1 -1
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +2 -2
- data/rbi/openai/models/reasoning.rbi +0 -2
- data/rbi/openai/models/responses/custom_tool.rbi +15 -0
- data/rbi/openai/models/responses/function_tool.rbi +11 -0
- data/rbi/openai/models/responses/namespace_tool.rbi +15 -0
- data/rbi/openai/models/responses/response.rbi +17 -13
- data/rbi/openai/models/responses/response_compact_params.rbi +10 -9
- data/rbi/openai/models/responses/response_configuration_update_item.rbi +112 -0
- data/rbi/openai/models/responses/response_configuration_update_item_param.rbi +117 -0
- data/rbi/openai/models/responses/response_create_params.rbi +6 -10
- data/rbi/openai/models/responses/response_custom_tool_call.rbi +13 -0
- data/rbi/openai/models/responses/response_custom_tool_call_item.rbi +6 -0
- data/rbi/openai/models/responses/response_error.rbi +161 -3
- data/rbi/openai/models/responses/response_function_tool_call.rbi +13 -0
- data/rbi/openai/models/responses/response_function_tool_call_item.rbi +6 -0
- data/rbi/openai/models/responses/response_incomplete_event.rbi +4 -0
- data/rbi/openai/models/responses/response_input_item.rbi +1 -0
- data/rbi/openai/models/responses/response_item.rbi +1 -0
- data/rbi/openai/models/responses/response_item_list.rbi +1 -0
- data/rbi/openai/models/responses/response_steer_accepted_event.rbi +146 -0
- data/rbi/openai/models/responses/response_steer_error_code.rbi +63 -0
- data/rbi/openai/models/responses/response_steer_event.rbi +119 -0
- data/rbi/openai/models/responses/response_steer_failed_event.rbi +268 -0
- data/rbi/openai/models/responses/response_steer_input.rbi +474 -0
- data/rbi/openai/models/responses/response_steer_input_content.rbi +29 -0
- data/rbi/openai/models/responses/response_steer_pending_event.rbi +220 -0
- data/rbi/openai/models/responses/response_steer_pending_reason.rbi +33 -0
- data/rbi/openai/models/responses/response_steer_required_input.rbi +377 -0
- data/rbi/openai/models/responses/response_usage.rbi +3 -13
- data/rbi/openai/models/responses/responses_client_event.rbi +1205 -1041
- data/rbi/openai/models/responses/responses_server_event.rbi +202 -3
- data/rbi/openai/models/safety/alert_retrieve_params.rbi +55 -0
- data/rbi/openai/models/safety/safety_alert.rbi +147 -0
- data/rbi/openai/models/video_create_error.rbi +149 -3
- data/rbi/openai/models/webhooks/safety_alert_created_webhook_event.rbi +130 -0
- data/rbi/openai/models/webhooks/safety_org_alert_created_webhook_event.rbi +130 -0
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +3 -1
- data/rbi/openai/models.rbi +2 -0
- data/rbi/openai/resources/admin/organization/usage.rbi +4 -0
- data/rbi/openai/resources/beta/responses.rbi +7 -11
- data/rbi/openai/resources/chat/completions.rbi +6 -6
- data/rbi/openai/resources/conversations/items.rbi +1 -0
- data/rbi/openai/resources/conversations.rbi +1 -0
- data/rbi/openai/resources/responses.rbi +9 -13
- data/rbi/openai/resources/safety/alerts.rbi +30 -0
- data/rbi/openai/resources/safety.rbi +18 -0
- data/rbi/openai/resources/webhooks.rbi +3 -1
- data/sig/openai/client.rbs +2 -0
- data/sig/openai/errors.rbs +1 -1
- data/sig/openai/internal/transport/base_client.rbs +4 -19
- data/sig/openai/models/admin/organization/usage_costs_params.rbs +7 -0
- data/sig/openai/models/beta/beta_custom_tool.rbs +7 -0
- data/sig/openai/models/beta/beta_function_tool.rbs +7 -0
- data/sig/openai/models/beta/beta_namespace_tool.rbs +7 -0
- data/sig/openai/models/beta/beta_response.rbs +7 -2
- data/sig/openai/models/beta/beta_response_configuration_update_item.rbs +91 -0
- data/sig/openai/models/beta/beta_response_configuration_update_item_param.rbs +87 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call.rbs +7 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call_item.rbs +3 -0
- data/sig/openai/models/beta/beta_response_error.rbs +82 -3
- data/sig/openai/models/beta/beta_response_function_tool_call.rbs +7 -0
- data/sig/openai/models/beta/beta_response_function_tool_call_item.rbs +3 -0
- data/sig/openai/models/beta/beta_response_input_item.rbs +1 -0
- data/sig/openai/models/beta/beta_response_item.rbs +1 -0
- data/sig/openai/models/beta/beta_response_steer_accepted_event.rbs +53 -0
- data/sig/openai/models/beta/beta_response_steer_error_code.rbs +31 -0
- data/sig/openai/models/beta/beta_response_steer_event.rbs +34 -0
- data/sig/openai/models/beta/beta_response_steer_failed_event.rbs +102 -0
- data/sig/openai/models/beta/beta_response_steer_input.rbs +214 -0
- data/sig/openai/models/beta/beta_response_steer_input_content.rbs +18 -0
- data/sig/openai/models/beta/beta_response_steer_pending_event.rbs +63 -0
- data/sig/openai/models/beta/beta_response_steer_pending_reason.rbs +16 -0
- data/sig/openai/models/beta/beta_response_steer_required_input.rbs +161 -0
- data/sig/openai/models/beta/beta_response_usage.rbs +3 -8
- data/sig/openai/models/beta/beta_responses_client_event.rbs +4 -1
- data/sig/openai/models/beta/beta_responses_server_event.rbs +80 -3
- data/sig/openai/models/beta/response_compact_params.rbs +3 -1
- data/sig/openai/models/beta/response_create_params.rbs +3 -1
- data/sig/openai/models/chat_model.rbs +3 -1
- data/sig/openai/models/completion_usage.rbs +0 -5
- data/sig/openai/models/conversations/conversation_item.rbs +1 -0
- data/sig/openai/models/error_object.rbs +82 -3
- data/sig/openai/models/responses/custom_tool.rbs +7 -0
- data/sig/openai/models/responses/function_tool.rbs +7 -0
- data/sig/openai/models/responses/namespace_tool.rbs +7 -0
- data/sig/openai/models/responses/response.rbs +4 -1
- data/sig/openai/models/responses/response_compact_params.rbs +3 -1
- data/sig/openai/models/responses/response_configuration_update_item.rbs +46 -0
- data/sig/openai/models/responses/response_configuration_update_item_param.rbs +46 -0
- data/sig/openai/models/responses/response_custom_tool_call.rbs +7 -0
- data/sig/openai/models/responses/response_custom_tool_call_item.rbs +3 -0
- data/sig/openai/models/responses/response_error.rbs +79 -3
- data/sig/openai/models/responses/response_function_tool_call.rbs +7 -0
- data/sig/openai/models/responses/response_function_tool_call_item.rbs +3 -0
- data/sig/openai/models/responses/response_input_item.rbs +1 -0
- data/sig/openai/models/responses/response_item.rbs +1 -0
- data/sig/openai/models/responses/response_steer_accepted_event.rbs +51 -0
- data/sig/openai/models/responses/response_steer_error_code.rbs +29 -0
- data/sig/openai/models/responses/response_steer_event.rbs +32 -0
- data/sig/openai/models/responses/response_steer_failed_event.rbs +100 -0
- data/sig/openai/models/responses/response_steer_input.rbs +182 -0
- data/sig/openai/models/responses/response_steer_input_content.rbs +16 -0
- data/sig/openai/models/responses/response_steer_pending_event.rbs +61 -0
- data/sig/openai/models/responses/response_steer_pending_reason.rbs +13 -0
- data/sig/openai/models/responses/response_steer_required_input.rbs +159 -0
- data/sig/openai/models/responses/response_usage.rbs +3 -8
- data/sig/openai/models/responses/responses_client_event.rbs +355 -344
- data/sig/openai/models/responses/responses_server_event.rbs +80 -3
- data/sig/openai/models/safety/alert_retrieve_params.rbs +22 -0
- data/sig/openai/models/safety/safety_alert.rbs +81 -0
- data/sig/openai/models/video_create_error.rbs +87 -3
- data/sig/openai/models/webhooks/safety_alert_created_webhook_event.rbs +52 -0
- data/sig/openai/models/webhooks/safety_org_alert_created_webhook_event.rbs +52 -0
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +2 -0
- data/sig/openai/models.rbs +2 -0
- data/sig/openai/resources/admin/organization/usage.rbs +1 -0
- data/sig/openai/resources/safety/alerts.rbs +14 -0
- data/sig/openai/resources/safety.rbs +9 -0
- data/sig/openai/resources/webhooks.rbs +3 -1
- metadata +86 -1
|
@@ -38,7 +38,7 @@ module OpenAI
|
|
|
38
38
|
# response will not be carried over to the next response. This makes it simple to
|
|
39
39
|
# swap out system (or developer) messages in new responses.
|
|
40
40
|
#
|
|
41
|
-
# @return [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil]
|
|
41
|
+
# @return [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil]
|
|
42
42
|
required :instructions, union: -> { OpenAI::Beta::BetaResponse::Instructions }, nil?: true
|
|
43
43
|
|
|
44
44
|
# @!attribute metadata
|
|
@@ -53,9 +53,9 @@ module OpenAI
|
|
|
53
53
|
required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
54
54
|
|
|
55
55
|
# @!attribute model
|
|
56
|
-
# Model ID used to generate the response, like `gpt-
|
|
57
|
-
#
|
|
58
|
-
#
|
|
56
|
+
# Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
57
|
+
# range of models with different capabilities, performance characteristics, and
|
|
58
|
+
# price points. Refer to the
|
|
59
59
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
60
60
|
# available models.
|
|
61
61
|
#
|
|
@@ -242,8 +242,6 @@ module OpenAI
|
|
|
242
242
|
)
|
|
243
243
|
|
|
244
244
|
# @!attribute reasoning
|
|
245
|
-
# **gpt-5 and o-series models only**
|
|
246
|
-
#
|
|
247
245
|
# Configuration options for
|
|
248
246
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
249
247
|
#
|
|
@@ -358,11 +356,11 @@ module OpenAI
|
|
|
358
356
|
#
|
|
359
357
|
# @param incomplete_details [OpenAI::Models::Beta::BetaResponse::IncompleteDetails, nil] Details about why the response is incomplete.
|
|
360
358
|
#
|
|
361
|
-
# @param instructions [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] A system (or developer) message inserted into the model's context.
|
|
359
|
+
# @param instructions [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] A system (or developer) message inserted into the model's context.
|
|
362
360
|
#
|
|
363
361
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
364
362
|
#
|
|
365
|
-
# @param model [Symbol, String, OpenAI::Models::Beta::BetaResponse::Model] Model ID used to generate the response, like `gpt-
|
|
363
|
+
# @param model [Symbol, String, OpenAI::Models::Beta::BetaResponse::Model] Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
366
364
|
#
|
|
367
365
|
# @param output [Array<OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>] An array of content items generated by the model.
|
|
368
366
|
#
|
|
@@ -398,7 +396,7 @@ module OpenAI
|
|
|
398
396
|
#
|
|
399
397
|
# @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::BetaResponse::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
|
|
400
398
|
#
|
|
401
|
-
# @param reasoning [OpenAI::Models::Beta::BetaResponse::Reasoning, nil]
|
|
399
|
+
# @param reasoning [OpenAI::Models::Beta::BetaResponse::Reasoning, nil] Configuration options for
|
|
402
400
|
#
|
|
403
401
|
# @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
|
|
404
402
|
#
|
|
@@ -421,24 +419,33 @@ module OpenAI
|
|
|
421
419
|
# @see OpenAI::Models::Beta::BetaResponse#incomplete_details
|
|
422
420
|
class IncompleteDetails < OpenAI::Internal::Type::BaseModel
|
|
423
421
|
# @!attribute reason
|
|
424
|
-
# The reason why the response is incomplete.
|
|
422
|
+
# The reason why the response is incomplete. `steered` means the response stopped
|
|
423
|
+
# at a safe output boundary after a WebSocket `response.steer` event. The server
|
|
424
|
+
# can then create a successor response automatically with the queued input.
|
|
425
425
|
#
|
|
426
426
|
# @return [Symbol, OpenAI::Models::Beta::BetaResponse::IncompleteDetails::Reason, nil]
|
|
427
427
|
optional :reason, enum: -> { OpenAI::Beta::BetaResponse::IncompleteDetails::Reason }
|
|
428
428
|
|
|
429
429
|
# @!method initialize(reason: nil)
|
|
430
|
+
# Some parameter documentations has been truncated, see
|
|
431
|
+
# {OpenAI::Models::Beta::BetaResponse::IncompleteDetails} for more details.
|
|
432
|
+
#
|
|
430
433
|
# Details about why the response is incomplete.
|
|
431
434
|
#
|
|
432
|
-
# @param reason [Symbol, OpenAI::Models::Beta::BetaResponse::IncompleteDetails::Reason] The reason why the response is incomplete.
|
|
435
|
+
# @param reason [Symbol, OpenAI::Models::Beta::BetaResponse::IncompleteDetails::Reason] The reason why the response is incomplete. `steered` means
|
|
433
436
|
|
|
434
|
-
# The reason why the response is incomplete.
|
|
437
|
+
# The reason why the response is incomplete. `steered` means the response stopped
|
|
438
|
+
# at a safe output boundary after a WebSocket `response.steer` event. The server
|
|
439
|
+
# can then create a successor response automatically with the queued input.
|
|
435
440
|
#
|
|
436
441
|
# @see OpenAI::Models::Beta::BetaResponse::IncompleteDetails#reason
|
|
437
442
|
module Reason
|
|
438
443
|
extend OpenAI::Internal::Type::Enum
|
|
439
444
|
|
|
440
445
|
MAX_OUTPUT_TOKENS = :max_output_tokens
|
|
446
|
+
MAX_MESSAGES = :max_messages
|
|
441
447
|
CONTENT_FILTER = :content_filter
|
|
448
|
+
STEERED = :steered
|
|
442
449
|
|
|
443
450
|
# @!method self.values
|
|
444
451
|
# @return [Array<Symbol>]
|
|
@@ -464,7 +471,7 @@ module OpenAI
|
|
|
464
471
|
variant -> { OpenAI::Models::Beta::BetaResponse::Instructions::BetaResponseInputItemArray }
|
|
465
472
|
|
|
466
473
|
# @!method self.variants
|
|
467
|
-
# @return [Array(String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>)]
|
|
474
|
+
# @return [Array(String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>)]
|
|
468
475
|
|
|
469
476
|
# @type [OpenAI::Internal::Type::Converter]
|
|
470
477
|
BetaResponseInputItemArray = OpenAI::Internal::Type::ArrayOf[
|
|
@@ -472,9 +479,9 @@ module OpenAI
|
|
|
472
479
|
]
|
|
473
480
|
end
|
|
474
481
|
|
|
475
|
-
# Model ID used to generate the response, like `gpt-
|
|
476
|
-
#
|
|
477
|
-
#
|
|
482
|
+
# Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
483
|
+
# range of models with different capabilities, performance characteristics, and
|
|
484
|
+
# price points. Refer to the
|
|
478
485
|
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
479
486
|
# available models.
|
|
480
487
|
#
|
|
@@ -482,6 +489,8 @@ module OpenAI
|
|
|
482
489
|
module Model
|
|
483
490
|
extend OpenAI::Internal::Type::Union
|
|
484
491
|
|
|
492
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_ASTRA }
|
|
493
|
+
|
|
485
494
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_6_SOL }
|
|
486
495
|
|
|
487
496
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_6_TERRA }
|
|
@@ -697,6 +706,7 @@ module OpenAI
|
|
|
697
706
|
|
|
698
707
|
# @!group
|
|
699
708
|
|
|
709
|
+
GPT_6_ASTRA = :"gpt-6-astra"
|
|
700
710
|
GPT_5_6_SOL = :"gpt-5.6-sol"
|
|
701
711
|
GPT_5_6_TERRA = :"gpt-5.6-terra"
|
|
702
712
|
GPT_5_6_LUNA = :"gpt-5.6-luna"
|
|
@@ -1290,8 +1300,6 @@ module OpenAI
|
|
|
1290
1300
|
# Some parameter documentations has been truncated, see
|
|
1291
1301
|
# {OpenAI::Models::Beta::BetaResponse::Reasoning} for more details.
|
|
1292
1302
|
#
|
|
1293
|
-
# **gpt-5 and o-series models only**
|
|
1294
|
-
#
|
|
1295
1303
|
# Configuration options for
|
|
1296
1304
|
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
1297
1305
|
#
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Beta
|
|
6
|
+
class BetaResponseConfigurationUpdateItem < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the configuration update item.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute type
|
|
14
|
+
# The item type. Always `configuration_update`.
|
|
15
|
+
#
|
|
16
|
+
# @return [Symbol, :configuration_update]
|
|
17
|
+
required :type, const: :configuration_update
|
|
18
|
+
|
|
19
|
+
# @!attribute agent
|
|
20
|
+
# The agent that produced this item.
|
|
21
|
+
#
|
|
22
|
+
# @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Agent, nil]
|
|
23
|
+
optional :agent, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem::Agent }
|
|
24
|
+
|
|
25
|
+
# @!attribute reasoning
|
|
26
|
+
# The reasoning configuration applied by this update.
|
|
27
|
+
#
|
|
28
|
+
# @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning, nil]
|
|
29
|
+
optional :reasoning, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem::Reasoning }
|
|
30
|
+
|
|
31
|
+
# @!method initialize(id:, agent: nil, reasoning: nil, type: :configuration_update)
|
|
32
|
+
# A configuration update that applies to subsequent responses until it is replaced
|
|
33
|
+
# by another configuration update.
|
|
34
|
+
#
|
|
35
|
+
# @param id [String] The unique ID of the configuration update item.
|
|
36
|
+
#
|
|
37
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Agent] The agent that produced this item.
|
|
38
|
+
#
|
|
39
|
+
# @param reasoning [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning] The reasoning configuration applied by this update.
|
|
40
|
+
#
|
|
41
|
+
# @param type [Symbol, :configuration_update] The item type. Always `configuration_update`.
|
|
42
|
+
|
|
43
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem#agent
|
|
44
|
+
class Agent < OpenAI::Internal::Type::BaseModel
|
|
45
|
+
# @!attribute agent_name
|
|
46
|
+
# The canonical name of the agent that produced this item.
|
|
47
|
+
#
|
|
48
|
+
# @return [String]
|
|
49
|
+
required :agent_name, String
|
|
50
|
+
|
|
51
|
+
# @!method initialize(agent_name:)
|
|
52
|
+
# The agent that produced this item.
|
|
53
|
+
#
|
|
54
|
+
# @param agent_name [String] The canonical name of the agent that produced this item.
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem#reasoning
|
|
58
|
+
class Reasoning < OpenAI::Internal::Type::BaseModel
|
|
59
|
+
# @!attribute effort
|
|
60
|
+
# The reasoning effort used for subsequent responses until another configuration
|
|
61
|
+
# update replaces it.
|
|
62
|
+
#
|
|
63
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning::Effort, nil]
|
|
64
|
+
optional(
|
|
65
|
+
:effort,
|
|
66
|
+
enum: -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem::Reasoning::Effort },
|
|
67
|
+
nil?: true
|
|
68
|
+
)
|
|
69
|
+
|
|
70
|
+
# @!method initialize(effort: nil)
|
|
71
|
+
# Some parameter documentations has been truncated, see
|
|
72
|
+
# {OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning} for more
|
|
73
|
+
# details.
|
|
74
|
+
#
|
|
75
|
+
# The reasoning configuration applied by this update.
|
|
76
|
+
#
|
|
77
|
+
# @param effort [Symbol, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning::Effort, nil] The reasoning effort used for subsequent responses until another
|
|
78
|
+
|
|
79
|
+
# The reasoning effort used for subsequent responses until another configuration
|
|
80
|
+
# update replaces it.
|
|
81
|
+
#
|
|
82
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning#effort
|
|
83
|
+
module Effort
|
|
84
|
+
extend OpenAI::Internal::Type::Enum
|
|
85
|
+
|
|
86
|
+
NONE = :none
|
|
87
|
+
MINIMAL = :minimal
|
|
88
|
+
LOW = :low
|
|
89
|
+
MEDIUM = :medium
|
|
90
|
+
HIGH = :high
|
|
91
|
+
XHIGH = :xhigh
|
|
92
|
+
MAX = :max
|
|
93
|
+
|
|
94
|
+
# @!method self.values
|
|
95
|
+
# @return [Array<Symbol>]
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
BetaResponseConfigurationUpdateItem = Beta::BetaResponseConfigurationUpdateItem
|
|
102
|
+
end
|
|
103
|
+
end
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Beta
|
|
6
|
+
class BetaResponseConfigurationUpdateItemParam < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute type
|
|
8
|
+
# The item type. Always `configuration_update`.
|
|
9
|
+
#
|
|
10
|
+
# @return [Symbol, :configuration_update]
|
|
11
|
+
required :type, const: :configuration_update
|
|
12
|
+
|
|
13
|
+
# @!attribute id
|
|
14
|
+
# The unique ID of the configuration update item.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :id, String, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute agent
|
|
20
|
+
# The agent that produced this item.
|
|
21
|
+
#
|
|
22
|
+
# @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Agent, nil]
|
|
23
|
+
optional :agent, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent }, nil?: true
|
|
24
|
+
|
|
25
|
+
# @!attribute reasoning
|
|
26
|
+
# Updates to reasoning configuration. Only effort is supported.
|
|
27
|
+
#
|
|
28
|
+
# @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning, nil]
|
|
29
|
+
optional :reasoning, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning }
|
|
30
|
+
|
|
31
|
+
# @!method initialize(id: nil, agent: nil, reasoning: nil, type: :configuration_update)
|
|
32
|
+
# An update to the conversation's response configuration. The configuration
|
|
33
|
+
# remains in effect for subsequent responses until it is replaced by another
|
|
34
|
+
# configuration update.
|
|
35
|
+
#
|
|
36
|
+
# @param id [String, nil] The unique ID of the configuration update item.
|
|
37
|
+
#
|
|
38
|
+
# @param agent [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Agent, nil] The agent that produced this item.
|
|
39
|
+
#
|
|
40
|
+
# @param reasoning [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning] Updates to reasoning configuration. Only effort is supported.
|
|
41
|
+
#
|
|
42
|
+
# @param type [Symbol, :configuration_update] The item type. Always `configuration_update`.
|
|
43
|
+
|
|
44
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam#agent
|
|
45
|
+
class Agent < OpenAI::Internal::Type::BaseModel
|
|
46
|
+
# @!attribute agent_name
|
|
47
|
+
# The canonical name of the agent that produced this item.
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
required :agent_name, String
|
|
51
|
+
|
|
52
|
+
# @!method initialize(agent_name:)
|
|
53
|
+
# The agent that produced this item.
|
|
54
|
+
#
|
|
55
|
+
# @param agent_name [String] The canonical name of the agent that produced this item.
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam#reasoning
|
|
59
|
+
class Reasoning < OpenAI::Internal::Type::BaseModel
|
|
60
|
+
# @!attribute effort
|
|
61
|
+
# The reasoning effort to use for subsequent responses until another configuration
|
|
62
|
+
# update replaces it.
|
|
63
|
+
#
|
|
64
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort, nil]
|
|
65
|
+
optional(
|
|
66
|
+
:effort,
|
|
67
|
+
enum: -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort },
|
|
68
|
+
nil?: true
|
|
69
|
+
)
|
|
70
|
+
|
|
71
|
+
# @!method initialize(effort: nil)
|
|
72
|
+
# Some parameter documentations has been truncated, see
|
|
73
|
+
# {OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning} for
|
|
74
|
+
# more details.
|
|
75
|
+
#
|
|
76
|
+
# Updates to reasoning configuration. Only effort is supported.
|
|
77
|
+
#
|
|
78
|
+
# @param effort [Symbol, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort, nil] The reasoning effort to use for subsequent responses until another
|
|
79
|
+
|
|
80
|
+
# The reasoning effort to use for subsequent responses until another configuration
|
|
81
|
+
# update replaces it.
|
|
82
|
+
#
|
|
83
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning#effort
|
|
84
|
+
module Effort
|
|
85
|
+
extend OpenAI::Internal::Type::Enum
|
|
86
|
+
|
|
87
|
+
NONE = :none
|
|
88
|
+
MINIMAL = :minimal
|
|
89
|
+
LOW = :low
|
|
90
|
+
MEDIUM = :medium
|
|
91
|
+
HIGH = :high
|
|
92
|
+
XHIGH = :xhigh
|
|
93
|
+
MAX = :max
|
|
94
|
+
|
|
95
|
+
# @!method self.values
|
|
96
|
+
# @return [Array<Symbol>]
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
BetaResponseConfigurationUpdateItemParam = Beta::BetaResponseConfigurationUpdateItemParam
|
|
103
|
+
end
|
|
104
|
+
end
|
|
@@ -40,6 +40,12 @@ module OpenAI
|
|
|
40
40
|
# @return [OpenAI::Models::Beta::BetaResponseCustomToolCall::Agent, nil]
|
|
41
41
|
optional :agent, -> { OpenAI::Beta::BetaResponseCustomToolCall::Agent }, nil?: true
|
|
42
42
|
|
|
43
|
+
# @!attribute async
|
|
44
|
+
# Whether the custom tool call runs asynchronously.
|
|
45
|
+
#
|
|
46
|
+
# @return [Boolean, nil]
|
|
47
|
+
optional :async, OpenAI::Internal::Type::Boolean
|
|
48
|
+
|
|
43
49
|
# @!attribute caller_
|
|
44
50
|
# The execution context that produced this tool call.
|
|
45
51
|
#
|
|
@@ -57,7 +63,7 @@ module OpenAI
|
|
|
57
63
|
# @return [String, nil]
|
|
58
64
|
optional :namespace, String
|
|
59
65
|
|
|
60
|
-
# @!method initialize(call_id:, input:, name:, id: nil, agent: nil, caller_: nil, namespace: nil, type: :custom_tool_call)
|
|
66
|
+
# @!method initialize(call_id:, input:, name:, id: nil, agent: nil, async: nil, caller_: nil, namespace: nil, type: :custom_tool_call)
|
|
61
67
|
# Some parameter documentations has been truncated, see
|
|
62
68
|
# {OpenAI::Models::Beta::BetaResponseCustomToolCall} for more details.
|
|
63
69
|
#
|
|
@@ -73,6 +79,8 @@ module OpenAI
|
|
|
73
79
|
#
|
|
74
80
|
# @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCall::Agent, nil] The agent that produced this item.
|
|
75
81
|
#
|
|
82
|
+
# @param async [Boolean] Whether the custom tool call runs asynchronously.
|
|
83
|
+
#
|
|
76
84
|
# @param caller_ [OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Program, nil] The execution context that produced this tool call.
|
|
77
85
|
#
|
|
78
86
|
# @param namespace [String] The namespace of the custom tool being called.
|
|
@@ -23,7 +23,7 @@ module OpenAI
|
|
|
23
23
|
# @return [String, nil]
|
|
24
24
|
optional :created_by, String
|
|
25
25
|
|
|
26
|
-
# @!method initialize(call_id:, input:, name:, id:, status:, agent: nil, caller_: nil, namespace: nil, created_by: nil, type: :custom_tool_call)
|
|
26
|
+
# @!method initialize(call_id:, input:, name:, id:, status:, agent: nil, async: nil, caller_: nil, namespace: nil, created_by: nil, type: :custom_tool_call)
|
|
27
27
|
# Some parameter documentations has been truncated, see
|
|
28
28
|
# {OpenAI::Models::Beta::BetaResponseCustomToolCallItem} for more details.
|
|
29
29
|
#
|
|
@@ -41,6 +41,8 @@ module OpenAI
|
|
|
41
41
|
#
|
|
42
42
|
# @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCall::Agent, nil] The agent that produced this item.
|
|
43
43
|
#
|
|
44
|
+
# @param async [Boolean] Whether the custom tool call runs asynchronously.
|
|
45
|
+
#
|
|
44
46
|
# @param caller_ [OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Program, nil] The execution context that produced this tool call.
|
|
45
47
|
#
|
|
46
48
|
# @param namespace [String] The namespace of the custom tool being called.
|
|
@@ -16,7 +16,12 @@ module OpenAI
|
|
|
16
16
|
# @return [String]
|
|
17
17
|
required :message, String
|
|
18
18
|
|
|
19
|
-
# @!
|
|
19
|
+
# @!attribute misalignment
|
|
20
|
+
#
|
|
21
|
+
# @return [OpenAI::Models::Beta::BetaResponseError::Misalignment, nil]
|
|
22
|
+
optional :misalignment, -> { OpenAI::Beta::BetaResponseError::Misalignment }
|
|
23
|
+
|
|
24
|
+
# @!method initialize(code:, message:, misalignment: nil)
|
|
20
25
|
# Some parameter documentations has been truncated, see
|
|
21
26
|
# {OpenAI::Models::Beta::BetaResponseError} for more details.
|
|
22
27
|
#
|
|
@@ -25,6 +30,8 @@ module OpenAI
|
|
|
25
30
|
# @param code [Symbol, OpenAI::Models::Beta::BetaResponseError::Code] The error code for the response.
|
|
26
31
|
#
|
|
27
32
|
# @param message [String] A human-readable description of the error.
|
|
33
|
+
#
|
|
34
|
+
# @param misalignment [OpenAI::Models::Beta::BetaResponseError::Misalignment]
|
|
28
35
|
|
|
29
36
|
# The error code for the response.
|
|
30
37
|
#
|
|
@@ -37,6 +44,7 @@ module OpenAI
|
|
|
37
44
|
INVALID_PROMPT = :invalid_prompt
|
|
38
45
|
DATA_RESIDENCY_MISMATCH = :data_residency_mismatch
|
|
39
46
|
BIO_POLICY = :bio_policy
|
|
47
|
+
MISALIGNMENT_POLICY_VIOLATION = :misalignment_policy_violation
|
|
40
48
|
VECTOR_STORE_TIMEOUT = :vector_store_timeout
|
|
41
49
|
INVALID_IMAGE = :invalid_image
|
|
42
50
|
INVALID_IMAGE_FORMAT = :invalid_image_format
|
|
@@ -56,6 +64,93 @@ module OpenAI
|
|
|
56
64
|
# @!method self.values
|
|
57
65
|
# @return [Array<Symbol>]
|
|
58
66
|
end
|
|
67
|
+
|
|
68
|
+
# @see OpenAI::Models::Beta::BetaResponseError#misalignment
|
|
69
|
+
class Misalignment < OpenAI::Internal::Type::BaseModel
|
|
70
|
+
# @!attribute detailed_explanation
|
|
71
|
+
# The public explanation for this block.
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :detailed_explanation, String
|
|
75
|
+
|
|
76
|
+
# @!attribute error_type
|
|
77
|
+
# An optional classification; clients must accept additional values.
|
|
78
|
+
#
|
|
79
|
+
# @return [String, Symbol, OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType, nil]
|
|
80
|
+
optional :error_type, union: -> { OpenAI::Beta::BetaResponseError::Misalignment::ErrorType }
|
|
81
|
+
|
|
82
|
+
# @!attribute steer
|
|
83
|
+
# An optional public continuation instruction.
|
|
84
|
+
#
|
|
85
|
+
# @return [OpenAI::Models::Beta::BetaResponseError::Misalignment::Steer, nil]
|
|
86
|
+
optional :steer, -> { OpenAI::Beta::BetaResponseError::Misalignment::Steer }
|
|
87
|
+
|
|
88
|
+
# @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
|
|
89
|
+
# @param detailed_explanation [String] The public explanation for this block.
|
|
90
|
+
#
|
|
91
|
+
# @param error_type [String, Symbol, OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType] An optional classification; clients must accept additional values.
|
|
92
|
+
#
|
|
93
|
+
# @param steer [OpenAI::Models::Beta::BetaResponseError::Misalignment::Steer] An optional public continuation instruction.
|
|
94
|
+
|
|
95
|
+
# An optional classification; clients must accept additional values.
|
|
96
|
+
#
|
|
97
|
+
# @see OpenAI::Models::Beta::BetaResponseError::Misalignment#error_type
|
|
98
|
+
module ErrorType
|
|
99
|
+
extend OpenAI::Internal::Type::Union
|
|
100
|
+
|
|
101
|
+
variant String
|
|
102
|
+
|
|
103
|
+
variant(
|
|
104
|
+
const: -> {
|
|
105
|
+
OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType::POTENTIALLY_UNINTENDED_DATA_TRANSFER
|
|
106
|
+
}
|
|
107
|
+
)
|
|
108
|
+
|
|
109
|
+
variant(
|
|
110
|
+
const: -> {
|
|
111
|
+
OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType::POTENTIALLY_UNINTENDED_DATA_ACCESS
|
|
112
|
+
}
|
|
113
|
+
)
|
|
114
|
+
|
|
115
|
+
variant(
|
|
116
|
+
const: -> {
|
|
117
|
+
OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType::POTENTIALLY_UNINTENDED_DESTRUCTIVE_ACTIVITY
|
|
118
|
+
}
|
|
119
|
+
)
|
|
120
|
+
|
|
121
|
+
variant const: -> { OpenAI::Models::Beta::BetaResponseError::Misalignment::ErrorType::OTHER }
|
|
122
|
+
|
|
123
|
+
# @!method self.variants
|
|
124
|
+
# @return [Array(String, Symbol)]
|
|
125
|
+
|
|
126
|
+
define_sorbet_constant!(:Variants) do
|
|
127
|
+
T.type_alias { T.any(String, OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::TaggedSymbol) }
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
# @!group
|
|
131
|
+
|
|
132
|
+
POTENTIALLY_UNINTENDED_DATA_TRANSFER = :potentially_unintended_data_transfer
|
|
133
|
+
POTENTIALLY_UNINTENDED_DATA_ACCESS = :potentially_unintended_data_access
|
|
134
|
+
POTENTIALLY_UNINTENDED_DESTRUCTIVE_ACTIVITY = :potentially_unintended_destructive_activity
|
|
135
|
+
OTHER = :other
|
|
136
|
+
|
|
137
|
+
# @!endgroup
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# @see OpenAI::Models::Beta::BetaResponseError::Misalignment#steer
|
|
141
|
+
class Steer < OpenAI::Internal::Type::BaseModel
|
|
142
|
+
# @!attribute message
|
|
143
|
+
# The public continuation instruction.
|
|
144
|
+
#
|
|
145
|
+
# @return [String]
|
|
146
|
+
required :message, String
|
|
147
|
+
|
|
148
|
+
# @!method initialize(message:)
|
|
149
|
+
# An optional public continuation instruction.
|
|
150
|
+
#
|
|
151
|
+
# @param message [String] The public continuation instruction.
|
|
152
|
+
end
|
|
153
|
+
end
|
|
59
154
|
end
|
|
60
155
|
end
|
|
61
156
|
|
|
@@ -40,6 +40,12 @@ module OpenAI
|
|
|
40
40
|
# @return [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Agent, nil]
|
|
41
41
|
optional :agent, -> { OpenAI::Beta::BetaResponseFunctionToolCall::Agent }, nil?: true
|
|
42
42
|
|
|
43
|
+
# @!attribute async
|
|
44
|
+
# Whether the function tool call runs asynchronously.
|
|
45
|
+
#
|
|
46
|
+
# @return [Boolean, nil]
|
|
47
|
+
optional :async, OpenAI::Internal::Type::Boolean
|
|
48
|
+
|
|
43
49
|
# @!attribute caller_
|
|
44
50
|
# The execution context that produced this tool call.
|
|
45
51
|
#
|
|
@@ -64,7 +70,7 @@ module OpenAI
|
|
|
64
70
|
# @return [Symbol, OpenAI::Models::Beta::BetaResponseFunctionToolCall::Status, nil]
|
|
65
71
|
optional :status, enum: -> { OpenAI::Beta::BetaResponseFunctionToolCall::Status }
|
|
66
72
|
|
|
67
|
-
# @!method initialize(arguments:, call_id:, name:, id: nil, agent: nil, caller_: nil, namespace: nil, status: nil, type: :function_call)
|
|
73
|
+
# @!method initialize(arguments:, call_id:, name:, id: nil, agent: nil, async: nil, caller_: nil, namespace: nil, status: nil, type: :function_call)
|
|
68
74
|
# Some parameter documentations has been truncated, see
|
|
69
75
|
# {OpenAI::Models::Beta::BetaResponseFunctionToolCall} for more details.
|
|
70
76
|
#
|
|
@@ -82,6 +88,8 @@ module OpenAI
|
|
|
82
88
|
#
|
|
83
89
|
# @param agent [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Agent, nil] The agent that produced this item.
|
|
84
90
|
#
|
|
91
|
+
# @param async [Boolean] Whether the function tool call runs asynchronously.
|
|
92
|
+
#
|
|
85
93
|
# @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Program, nil] The execution context that produced this tool call.
|
|
86
94
|
#
|
|
87
95
|
# @param namespace [String] The namespace of the function to run.
|
|
@@ -23,7 +23,7 @@ module OpenAI
|
|
|
23
23
|
# @return [String, nil]
|
|
24
24
|
optional :created_by, String
|
|
25
25
|
|
|
26
|
-
# @!method initialize(arguments:, call_id:, name:, id:, status:, agent: nil, caller_: nil, namespace: nil, created_by: nil, type: :function_call)
|
|
26
|
+
# @!method initialize(arguments:, call_id:, name:, id:, status:, agent: nil, async: nil, caller_: nil, namespace: nil, created_by: nil, type: :function_call)
|
|
27
27
|
# Some parameter documentations has been truncated, see
|
|
28
28
|
# {OpenAI::Models::Beta::BetaResponseFunctionToolCallItem} for more details.
|
|
29
29
|
#
|
|
@@ -43,6 +43,8 @@ module OpenAI
|
|
|
43
43
|
#
|
|
44
44
|
# @param agent [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Agent, nil] The agent that produced this item.
|
|
45
45
|
#
|
|
46
|
+
# @param async [Boolean] Whether the function tool call runs asynchronously.
|
|
47
|
+
#
|
|
46
48
|
# @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Program, nil] The execution context that produced this tool call.
|
|
47
49
|
#
|
|
48
50
|
# @param namespace [String] The namespace of the function to run.
|
|
@@ -34,6 +34,10 @@ module OpenAI
|
|
|
34
34
|
#
|
|
35
35
|
# An event that is emitted when a response finishes as incomplete.
|
|
36
36
|
#
|
|
37
|
+
# Over WebSocket, steering can finish a response with
|
|
38
|
+
# `response.incomplete_details.reason` set to `steered`, followed automatically by
|
|
39
|
+
# a successor `response.created` that commits the queued steering input.
|
|
40
|
+
#
|
|
37
41
|
# @param response [OpenAI::Models::Beta::BetaResponse] The response that was incomplete.
|
|
38
42
|
#
|
|
39
43
|
# @param sequence_number [Integer] The sequence number of this event.
|
|
@@ -7,7 +7,7 @@ module OpenAI
|
|
|
7
7
|
# @!attribute input
|
|
8
8
|
# Input items to inject into the active response.
|
|
9
9
|
#
|
|
10
|
-
# @return [Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>]
|
|
10
|
+
# @return [Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>]
|
|
11
11
|
required :input, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseInputItem] }
|
|
12
12
|
|
|
13
13
|
# @!attribute response_id
|
|
@@ -27,7 +27,7 @@ module OpenAI
|
|
|
27
27
|
# items are validated and committed atomically. Currently, the server accepts
|
|
28
28
|
# client-owned tool outputs that resume a waiting agent.
|
|
29
29
|
#
|
|
30
|
-
# @param input [Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>] Input items to inject into the active response.
|
|
30
|
+
# @param input [Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>] Input items to inject into the active response.
|
|
31
31
|
#
|
|
32
32
|
# @param response_id [String] The ID of the active response that should receive the input.
|
|
33
33
|
#
|