openai 0.98.0 → 0.100.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +1 -1
- data/bedrock.md +17 -1
- data/lib/openai/client.rb +9 -0
- data/lib/openai/helpers/agents/session_stream.rb +11 -36
- data/lib/openai/helpers/agents/tools.rb +34 -4
- data/lib/openai/helpers/beta/agents/creation_stream.rb +26 -0
- data/lib/openai/helpers/beta/agents/function_tool.rb +11 -4
- data/lib/openai/helpers/beta/agents/tool_dispatcher.rb +74 -0
- data/lib/openai/helpers/beta/agents/tool_error.rb +28 -0
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_completions_params.rb +9 -4
- data/lib/openai/models/admin/organization/usage_completions_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_costs_params.rb +16 -4
- data/lib/openai/models/admin/organization/usage_costs_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_images_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +9 -4
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +140 -5
- data/lib/openai/models/all_models.rb +42 -0
- data/lib/openai/models/audio/speech_create_params.rb +6 -0
- data/lib/openai/models/audio/voice.rb +75 -0
- data/lib/openai/models/audio/voice_create_params.rb +217 -0
- data/lib/openai/models/beta/agent_create_params.rb +0 -3
- data/lib/openai/models/beta/agent_update_params.rb +0 -3
- data/lib/openai/models/beta/agents/environments/template_create_params.rb +6 -6
- data/lib/openai/models/beta/agents/environments/template_update_params.rb +3 -6
- data/lib/openai/models/beta/agents/session_create_params.rb +0 -3
- data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
- data/lib/openai/models/beta/agents/sessions/turns/item_list_params.rb +79 -0
- data/lib/openai/models/beta/beta_response.rb +220 -0
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +2 -2
- data/lib/openai/models/beta/beta_response_error.rb +12 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
- data/lib/openai/models/beta/beta_responses_server_event.rb +12 -1
- data/lib/openai/models/beta/beta_tool.rb +15 -18
- data/lib/openai/models/beta/environment_param.rb +6 -6
- data/lib/openai/models/beta/response_compact_params.rb +220 -0
- data/lib/openai/models/beta/response_create_params.rb +220 -0
- data/lib/openai/models/beta/session_turn_error.rb +9 -0
- data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
- data/lib/openai/models/chat/chat_completion_chunk.rb +85 -18
- data/lib/openai/models/chat_model.rb +178 -0
- data/lib/openai/models/error_object.rb +12 -1
- data/lib/openai/models/eval_create_params.rb +1 -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/fine_tuning/job_list_params.rb +14 -4
- data/lib/openai/models/graders/score_model_grader.rb +2 -2
- data/lib/openai/models/image.rb +14 -14
- data/lib/openai/models/image_create_variation_params.rb +7 -7
- data/lib/openai/models/image_edit_params.rb +88 -96
- data/lib/openai/models/image_generate_params.rb +51 -62
- data/lib/openai/models/image_model.rb +5 -3
- data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
- data/lib/openai/models/realtime/realtime_client_event.rb +9 -0
- data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
- data/lib/openai/models/realtime/session_update_event.rb +16 -0
- data/lib/openai/models/responses/response_compact_params.rb +220 -0
- data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +2 -2
- data/lib/openai/models/responses/response_error.rb +12 -1
- data/lib/openai/models/responses/responses_server_event.rb +12 -1
- data/lib/openai/models/responses/tool.rb +15 -18
- data/lib/openai/models/responses_model.rb +42 -0
- data/lib/openai/models/video_create_error.rb +12 -1
- data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +109 -0
- data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb +106 -0
- data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb +86 -0
- data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb +86 -0
- data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb +86 -0
- data/lib/openai/models/webhooks/unwrap_webhook_event.rb +18 -2
- data/lib/openai/models/webhooks/webhook_create_params.rb +5 -0
- data/lib/openai/models/webhooks/webhook_test_params.rb +5 -0
- data/lib/openai/models/webhooks/webhook_update_params.rb +5 -0
- data/lib/openai/providers/bedrock.rb +20 -1
- data/lib/openai/resources/admin/organization/usage.rb +15 -6
- data/lib/openai/resources/audio/speech.rb +2 -0
- data/lib/openai/resources/audio/voices.rb +53 -0
- data/lib/openai/resources/audio.rb +5 -0
- data/lib/openai/resources/beta/agents/environments/templates.rb +3 -4
- data/lib/openai/resources/beta/agents/sessions/turns/items.rb +68 -0
- data/lib/openai/resources/beta/agents/sessions/turns.rb +4 -0
- data/lib/openai/resources/beta/agents/sessions.rb +22 -2
- data/lib/openai/resources/fine_tuning/jobs.rb +7 -2
- data/lib/openai/resources/images.rb +79 -109
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +10 -0
- data/rbi/openai/helpers/agents.rbi +2 -0
- data/rbi/openai/helpers/beta/agents/function_tool.rbi +8 -3
- data/rbi/openai/helpers/beta/agents/tool_error.rbi +19 -0
- data/rbi/openai/helpers/beta/agents.rbi +12 -0
- data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_completions_params.rbi +9 -4
- data/rbi/openai/models/admin/organization/usage_completions_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_costs_params.rbi +16 -4
- data/rbi/openai/models/admin/organization/usage_costs_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_images_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +12 -4
- data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +213 -3
- data/rbi/openai/models/audio/speech_create_params.rbi +6 -0
- data/rbi/openai/models/audio/voice.rbi +111 -0
- data/rbi/openai/models/audio/voice_create_params.rbi +321 -0
- data/rbi/openai/models/beta/agent_create_params.rbi +0 -3
- data/rbi/openai/models/beta/agent_update_params.rbi +0 -3
- data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +6 -6
- data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +3 -6
- data/rbi/openai/models/beta/agents/session_create_params.rbi +0 -3
- data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
- data/rbi/openai/models/beta/agents/sessions/turns/item_list_params.rbi +139 -0
- data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +2 -2
- data/rbi/openai/models/beta/beta_response_error.rbi +12 -0
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +12 -0
- data/rbi/openai/models/beta/beta_tool.rbi +15 -18
- data/rbi/openai/models/beta/environment_param.rbi +6 -6
- data/rbi/openai/models/beta/session_turn_error.rbi +18 -0
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
- data/rbi/openai/models/chat/chat_completion_chunk.rbi +123 -17
- data/rbi/openai/models/error_object.rbi +12 -0
- data/rbi/openai/models/eval_create_params.rbi +1 -1
- 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/fine_tuning/job_list_params.rbi +14 -4
- data/rbi/openai/models/graders/score_model_grader.rbi +2 -2
- data/rbi/openai/models/image.rbi +14 -14
- data/rbi/openai/models/image_create_variation_params.rbi +6 -6
- data/rbi/openai/models/image_edit_params.rbi +73 -91
- data/rbi/openai/models/image_generate_params.rbi +30 -61
- data/rbi/openai/models/image_model.rbi +3 -3
- data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +9 -6
- data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +9 -6
- data/rbi/openai/models/realtime/session_update_event.rbi +16 -0
- data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +2 -2
- data/rbi/openai/models/responses/response_error.rbi +12 -0
- data/rbi/openai/models/responses/responses_server_event.rbi +12 -0
- data/rbi/openai/models/responses/tool.rbi +15 -18
- data/rbi/openai/models/video_create_error.rbi +12 -0
- data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +222 -0
- data/rbi/openai/models/webhooks/agent_session_created_webhook_event.rbi +202 -0
- data/rbi/openai/models/webhooks/agent_session_failed_webhook_event.rbi +151 -0
- data/rbi/openai/models/webhooks/agent_session_idle_webhook_event.rbi +151 -0
- data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi +151 -0
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +7 -1
- data/rbi/openai/models/webhooks/webhook_create_params.rbi +20 -0
- data/rbi/openai/models/webhooks/webhook_test_params.rbi +20 -0
- data/rbi/openai/models/webhooks/webhook_update_params.rbi +20 -0
- data/rbi/openai/resources/admin/organization/usage.rbi +15 -6
- data/rbi/openai/resources/audio/speech.rbi +2 -0
- data/rbi/openai/resources/audio/voices.rbi +49 -0
- data/rbi/openai/resources/audio.rbi +4 -0
- data/rbi/openai/resources/beta/agents/environments/templates.rbi +3 -4
- data/rbi/openai/resources/beta/agents/sessions/turns/items.rbi +62 -0
- data/rbi/openai/resources/beta/agents/sessions/turns.rbi +3 -0
- data/rbi/openai/resources/beta/agents/sessions.rbi +2 -0
- data/rbi/openai/resources/fine_tuning/jobs.rbi +7 -2
- data/rbi/openai/resources/images.rbi +77 -109
- data/rbi/openai/resources/webhooks.rbi +5 -0
- data/sig/openai/helpers/agents.rbs +3 -0
- data/sig/openai/helpers/beta/agents/function_tool.rbs +5 -2
- data/sig/openai/helpers/beta/agents/tool_error.rbs +17 -0
- data/sig/openai/helpers/beta/agents.rbs +5 -0
- data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_completions_params.rbs +14 -6
- data/sig/openai/models/admin/organization/usage_completions_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_costs_params.rbs +25 -7
- data/sig/openai/models/admin/organization/usage_costs_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_images_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_moderations_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_web_search_calls_params.rbs +19 -7
- data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +107 -5
- data/sig/openai/models/audio/speech_create_params.rbs +4 -0
- data/sig/openai/models/audio/voice.rbs +70 -0
- data/sig/openai/models/audio/voice_create_params.rbs +203 -0
- data/sig/openai/models/beta/agent_create_params.rbs +1 -5
- data/sig/openai/models/beta/agent_update_params.rbs +1 -5
- data/sig/openai/models/beta/agents/environments/template_create_params.rbs +4 -4
- data/sig/openai/models/beta/agents/environments/template_update_params.rbs +2 -4
- data/sig/openai/models/beta/agents/session_create_params.rbs +1 -5
- data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
- data/sig/openai/models/beta/agents/sessions/turns/item_list_params.rbs +91 -0
- data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +2 -2
- data/sig/openai/models/beta/beta_response_error.rbs +10 -0
- data/sig/openai/models/beta/beta_responses_server_event.rbs +10 -0
- data/sig/openai/models/beta/beta_tool.rbs +11 -15
- data/sig/openai/models/beta/environment_param.rbs +4 -4
- data/sig/openai/models/beta/session_turn_error.rbs +12 -0
- data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
- data/sig/openai/models/chat/chat_completion_chunk.rbs +96 -12
- data/sig/openai/models/error_object.rbs +10 -0
- data/sig/openai/models/eval_create_params.rbs +1 -1
- data/sig/openai/models/eval_create_response.rbs +1 -1
- data/sig/openai/models/eval_list_response.rbs +1 -1
- data/sig/openai/models/eval_retrieve_response.rbs +1 -1
- data/sig/openai/models/eval_update_response.rbs +1 -1
- data/sig/openai/models/fine_tuning/job_list_params.rbs +14 -4
- data/sig/openai/models/graders/score_model_grader.rbs +3 -3
- data/sig/openai/models/image.rbs +21 -21
- data/sig/openai/models/image_create_variation_params.rbs +4 -4
- data/sig/openai/models/image_edit_params.rbs +54 -66
- data/sig/openai/models/image_generate_params.rbs +23 -45
- data/sig/openai/models/image_model.rbs +6 -6
- data/sig/openai/models/realtime/realtime_audio_config_output.rbs +9 -6
- data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +9 -6
- data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs +2 -2
- data/sig/openai/models/responses/response_error.rbs +10 -0
- data/sig/openai/models/responses/responses_server_event.rbs +10 -0
- data/sig/openai/models/responses/tool.rbs +11 -15
- data/sig/openai/models/video_create_error.rbs +10 -0
- data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +114 -0
- data/sig/openai/models/webhooks/agent_session_created_webhook_event.rbs +115 -0
- data/sig/openai/models/webhooks/agent_session_failed_webhook_event.rbs +89 -0
- data/sig/openai/models/webhooks/agent_session_idle_webhook_event.rbs +89 -0
- data/sig/openai/models/webhooks/agent_session_in_progress_webhook_event.rbs +89 -0
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +6 -1
- data/sig/openai/models/webhooks/webhook_create_params.rbs +10 -0
- data/sig/openai/models/webhooks/webhook_test_params.rbs +10 -0
- data/sig/openai/models/webhooks/webhook_update_params.rbs +10 -0
- data/sig/openai/resources/audio/voices.rbs +14 -0
- data/sig/openai/resources/audio.rbs +2 -0
- data/sig/openai/resources/beta/agents/sessions/turns/items.rbs +24 -0
- data/sig/openai/resources/beta/agents/sessions/turns.rbs +2 -0
- data/sig/openai/resources/beta/agents/sessions.rbs +1 -0
- data/sig/openai/resources/webhooks.rbs +6 -1
- metadata +35 -1
|
@@ -14,21 +14,63 @@ module OpenAI
|
|
|
14
14
|
module ResponsesOnlyModel
|
|
15
15
|
extend OpenAI::Internal::Type::Enum
|
|
16
16
|
|
|
17
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
18
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
19
|
+
# replacements.
|
|
17
20
|
O1_PRO = :"o1-pro"
|
|
21
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
22
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
23
|
+
# replacements.
|
|
18
24
|
O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
|
|
25
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
26
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
27
|
+
# replacements.
|
|
19
28
|
O3_PRO = :"o3-pro"
|
|
29
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
30
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
31
|
+
# replacements.
|
|
20
32
|
O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
|
|
33
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
34
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
35
|
+
# replacements.
|
|
21
36
|
O3_DEEP_RESEARCH = :"o3-deep-research"
|
|
37
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
38
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
39
|
+
# replacements.
|
|
22
40
|
O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
|
|
41
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
42
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
43
|
+
# replacements.
|
|
23
44
|
O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
|
|
45
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
46
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
47
|
+
# replacements.
|
|
24
48
|
O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
|
|
49
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
50
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
51
|
+
# replacements.
|
|
25
52
|
COMPUTER_USE_PREVIEW = :"computer-use-preview"
|
|
53
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
54
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
55
|
+
# replacements.
|
|
26
56
|
COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
|
|
27
57
|
GPT_5_5_PRO = :"gpt-5.5-pro"
|
|
28
58
|
GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
|
|
59
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
60
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
61
|
+
# replacements.
|
|
29
62
|
GPT_5_CODEX = :"gpt-5-codex"
|
|
63
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
64
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
65
|
+
# replacements.
|
|
30
66
|
GPT_5_PRO = :"gpt-5-pro"
|
|
67
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
68
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
69
|
+
# replacements.
|
|
31
70
|
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
71
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
72
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
73
|
+
# replacements.
|
|
32
74
|
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
33
75
|
GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
|
|
34
76
|
GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
|
|
@@ -56,19 +56,30 @@ module OpenAI
|
|
|
56
56
|
# @return [String, Symbol, OpenAI::Models::VideoCreateError::Misalignment::ErrorType, nil]
|
|
57
57
|
optional :error_type, union: -> { OpenAI::VideoCreateError::Misalignment::ErrorType }
|
|
58
58
|
|
|
59
|
+
# @!attribute review_target
|
|
60
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
61
|
+
# unavailable.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :review_target, String, nil?: true
|
|
65
|
+
|
|
59
66
|
# @!attribute steer
|
|
60
67
|
# An optional public continuation instruction.
|
|
61
68
|
#
|
|
62
69
|
# @return [OpenAI::Models::VideoCreateError::Misalignment::Steer, nil]
|
|
63
70
|
optional :steer, -> { OpenAI::VideoCreateError::Misalignment::Steer }
|
|
64
71
|
|
|
65
|
-
# @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
|
|
72
|
+
# @!method initialize(detailed_explanation: nil, error_type: nil, review_target: nil, steer: nil)
|
|
66
73
|
# @param detailed_explanation [String]
|
|
67
74
|
# The public explanation for this block.
|
|
68
75
|
#
|
|
69
76
|
# @param error_type [String, Symbol, OpenAI::Models::VideoCreateError::Misalignment::ErrorType]
|
|
70
77
|
# An optional classification; clients must accept additional values.
|
|
71
78
|
#
|
|
79
|
+
# @param review_target [String, nil]
|
|
80
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
81
|
+
# unavailable.
|
|
82
|
+
#
|
|
72
83
|
# @param steer [OpenAI::Models::VideoCreateError::Misalignment::Steer]
|
|
73
84
|
# An optional public continuation instruction.
|
|
74
85
|
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class AgentSessionActionRequiredWebhookEvent < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the event.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :created_at, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute data
|
|
20
|
+
#
|
|
21
|
+
# @return [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data]
|
|
22
|
+
required :data, -> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data }
|
|
23
|
+
|
|
24
|
+
# @!attribute object
|
|
25
|
+
# The object type. Always `event`.
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, :event]
|
|
28
|
+
required :object, const: :event
|
|
29
|
+
|
|
30
|
+
# @!attribute type
|
|
31
|
+
# The event type. Always `agent.session.action_required`.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, :"agent.session.action_required"]
|
|
34
|
+
required :type, const: :"agent.session.action_required"
|
|
35
|
+
|
|
36
|
+
# @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.action_required")
|
|
37
|
+
# Sent when an agent session requires an action. Retrieve the session for action
|
|
38
|
+
# details.
|
|
39
|
+
#
|
|
40
|
+
# @param id [String]
|
|
41
|
+
# The unique ID of the event.
|
|
42
|
+
#
|
|
43
|
+
# @param created_at [Integer]
|
|
44
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
45
|
+
#
|
|
46
|
+
# @param data [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data]
|
|
47
|
+
#
|
|
48
|
+
# @param object [Symbol, :event]
|
|
49
|
+
# The object type. Always `event`.
|
|
50
|
+
#
|
|
51
|
+
# @param type [Symbol, :"agent.session.action_required"]
|
|
52
|
+
# The event type. Always `agent.session.action_required`.
|
|
53
|
+
|
|
54
|
+
# @see OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent#data
|
|
55
|
+
class Data < OpenAI::Internal::Type::BaseModel
|
|
56
|
+
# @!attribute id
|
|
57
|
+
# The ID of the session.
|
|
58
|
+
#
|
|
59
|
+
# @return [String]
|
|
60
|
+
required :id, String
|
|
61
|
+
|
|
62
|
+
# @!attribute required_action
|
|
63
|
+
# The action type. Retrieve the session for action details.
|
|
64
|
+
#
|
|
65
|
+
# @return [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction]
|
|
66
|
+
required(
|
|
67
|
+
:required_action,
|
|
68
|
+
-> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction }
|
|
69
|
+
)
|
|
70
|
+
|
|
71
|
+
# @!method initialize(id:, required_action:)
|
|
72
|
+
# @param id [String]
|
|
73
|
+
# The ID of the session.
|
|
74
|
+
#
|
|
75
|
+
# @param required_action [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction]
|
|
76
|
+
# The action type. Retrieve the session for action details.
|
|
77
|
+
|
|
78
|
+
# @see OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data#required_action
|
|
79
|
+
class RequiredAction < OpenAI::Internal::Type::BaseModel
|
|
80
|
+
# @!attribute type
|
|
81
|
+
#
|
|
82
|
+
# @return [Symbol, OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type]
|
|
83
|
+
required(
|
|
84
|
+
:type,
|
|
85
|
+
enum: -> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type }
|
|
86
|
+
)
|
|
87
|
+
|
|
88
|
+
# @!method initialize(type:)
|
|
89
|
+
# The action type. Retrieve the session for action details.
|
|
90
|
+
#
|
|
91
|
+
# @param type [Symbol, OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type]
|
|
92
|
+
|
|
93
|
+
# @see OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction#type
|
|
94
|
+
module Type
|
|
95
|
+
extend OpenAI::Internal::Type::Enum
|
|
96
|
+
|
|
97
|
+
COMPUTER_USE_APPROVAL_REQUEST = :computer_use_approval_request
|
|
98
|
+
FUNCTION_CALL = :function_call
|
|
99
|
+
ENVIRONMENT_CONNECTION = :environment_connection
|
|
100
|
+
|
|
101
|
+
# @!method self.values
|
|
102
|
+
# @return [Array<Symbol>]
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
end
|
|
109
|
+
end
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class AgentSessionCreatedWebhookEvent < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the event.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :created_at, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute data
|
|
20
|
+
#
|
|
21
|
+
# @return [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data]
|
|
22
|
+
required :data, -> { OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data }
|
|
23
|
+
|
|
24
|
+
# @!attribute object
|
|
25
|
+
# The object type. Always `event`.
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, :event]
|
|
28
|
+
required :object, const: :event
|
|
29
|
+
|
|
30
|
+
# @!attribute type
|
|
31
|
+
# The event type. Always `agent.session.created`.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, :"agent.session.created"]
|
|
34
|
+
required :type, const: :"agent.session.created"
|
|
35
|
+
|
|
36
|
+
# @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.created")
|
|
37
|
+
# Sent when an agent session is created.
|
|
38
|
+
#
|
|
39
|
+
# @param id [String]
|
|
40
|
+
# The unique ID of the event.
|
|
41
|
+
#
|
|
42
|
+
# @param created_at [Integer]
|
|
43
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
44
|
+
#
|
|
45
|
+
# @param data [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data]
|
|
46
|
+
#
|
|
47
|
+
# @param object [Symbol, :event]
|
|
48
|
+
# The object type. Always `event`.
|
|
49
|
+
#
|
|
50
|
+
# @param type [Symbol, :"agent.session.created"]
|
|
51
|
+
# The event type. Always `agent.session.created`.
|
|
52
|
+
|
|
53
|
+
# @see OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent#data
|
|
54
|
+
class Data < OpenAI::Internal::Type::BaseModel
|
|
55
|
+
# @!attribute id
|
|
56
|
+
# The ID of the session.
|
|
57
|
+
#
|
|
58
|
+
# @return [String]
|
|
59
|
+
required :id, String
|
|
60
|
+
|
|
61
|
+
# @!attribute environment_type
|
|
62
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
63
|
+
#
|
|
64
|
+
# @return [String]
|
|
65
|
+
required :environment_type, String
|
|
66
|
+
|
|
67
|
+
# @!attribute connect
|
|
68
|
+
#
|
|
69
|
+
# @return [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect, nil]
|
|
70
|
+
optional :connect, -> { OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect }
|
|
71
|
+
|
|
72
|
+
# @!attribute environment_id
|
|
73
|
+
# The ID of the environment, when one exists.
|
|
74
|
+
#
|
|
75
|
+
# @return [String, nil]
|
|
76
|
+
optional :environment_id, String
|
|
77
|
+
|
|
78
|
+
# @!method initialize(id:, environment_type:, connect: nil, environment_id: nil)
|
|
79
|
+
# @param id [String]
|
|
80
|
+
# The ID of the session.
|
|
81
|
+
#
|
|
82
|
+
# @param environment_type [String]
|
|
83
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
84
|
+
#
|
|
85
|
+
# @param connect [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect]
|
|
86
|
+
#
|
|
87
|
+
# @param environment_id [String]
|
|
88
|
+
# The ID of the environment, when one exists.
|
|
89
|
+
|
|
90
|
+
# @see OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data#connect
|
|
91
|
+
class Connect < OpenAI::Internal::Type::BaseModel
|
|
92
|
+
# @!attribute remote_url
|
|
93
|
+
# The URL used to connect the self-hosted environment.
|
|
94
|
+
#
|
|
95
|
+
# @return [String]
|
|
96
|
+
required :remote_url, String
|
|
97
|
+
|
|
98
|
+
# @!method initialize(remote_url:)
|
|
99
|
+
# @param remote_url [String]
|
|
100
|
+
# The URL used to connect the self-hosted environment.
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
end
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class AgentSessionFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the event.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :created_at, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute data
|
|
20
|
+
#
|
|
21
|
+
# @return [OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent::Data]
|
|
22
|
+
required :data, -> { OpenAI::Webhooks::AgentSessionFailedWebhookEvent::Data }
|
|
23
|
+
|
|
24
|
+
# @!attribute object
|
|
25
|
+
# The object type. Always `event`.
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, :event]
|
|
28
|
+
required :object, const: :event
|
|
29
|
+
|
|
30
|
+
# @!attribute type
|
|
31
|
+
# The event type. Always `agent.session.failed`.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, :"agent.session.failed"]
|
|
34
|
+
required :type, const: :"agent.session.failed"
|
|
35
|
+
|
|
36
|
+
# @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.failed")
|
|
37
|
+
# Sent when an agent session fails.
|
|
38
|
+
#
|
|
39
|
+
# @param id [String]
|
|
40
|
+
# The unique ID of the event.
|
|
41
|
+
#
|
|
42
|
+
# @param created_at [Integer]
|
|
43
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
44
|
+
#
|
|
45
|
+
# @param data [OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent::Data]
|
|
46
|
+
#
|
|
47
|
+
# @param object [Symbol, :event]
|
|
48
|
+
# The object type. Always `event`.
|
|
49
|
+
#
|
|
50
|
+
# @param type [Symbol, :"agent.session.failed"]
|
|
51
|
+
# The event type. Always `agent.session.failed`.
|
|
52
|
+
|
|
53
|
+
# @see OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent#data
|
|
54
|
+
class Data < OpenAI::Internal::Type::BaseModel
|
|
55
|
+
# @!attribute id
|
|
56
|
+
# The ID of the session.
|
|
57
|
+
#
|
|
58
|
+
# @return [String]
|
|
59
|
+
required :id, String
|
|
60
|
+
|
|
61
|
+
# @!attribute environment_type
|
|
62
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
63
|
+
#
|
|
64
|
+
# @return [String]
|
|
65
|
+
required :environment_type, String
|
|
66
|
+
|
|
67
|
+
# @!attribute environment_id
|
|
68
|
+
# The ID of the environment, when one exists.
|
|
69
|
+
#
|
|
70
|
+
# @return [String, nil]
|
|
71
|
+
optional :environment_id, String
|
|
72
|
+
|
|
73
|
+
# @!method initialize(id:, environment_type:, environment_id: nil)
|
|
74
|
+
# @param id [String]
|
|
75
|
+
# The ID of the session.
|
|
76
|
+
#
|
|
77
|
+
# @param environment_type [String]
|
|
78
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
79
|
+
#
|
|
80
|
+
# @param environment_id [String]
|
|
81
|
+
# The ID of the environment, when one exists.
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class AgentSessionIdleWebhookEvent < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the event.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :created_at, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute data
|
|
20
|
+
#
|
|
21
|
+
# @return [OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent::Data]
|
|
22
|
+
required :data, -> { OpenAI::Webhooks::AgentSessionIdleWebhookEvent::Data }
|
|
23
|
+
|
|
24
|
+
# @!attribute object
|
|
25
|
+
# The object type. Always `event`.
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, :event]
|
|
28
|
+
required :object, const: :event
|
|
29
|
+
|
|
30
|
+
# @!attribute type
|
|
31
|
+
# The event type. Always `agent.session.idle`.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, :"agent.session.idle"]
|
|
34
|
+
required :type, const: :"agent.session.idle"
|
|
35
|
+
|
|
36
|
+
# @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.idle")
|
|
37
|
+
# Sent when an agent session becomes idle.
|
|
38
|
+
#
|
|
39
|
+
# @param id [String]
|
|
40
|
+
# The unique ID of the event.
|
|
41
|
+
#
|
|
42
|
+
# @param created_at [Integer]
|
|
43
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
44
|
+
#
|
|
45
|
+
# @param data [OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent::Data]
|
|
46
|
+
#
|
|
47
|
+
# @param object [Symbol, :event]
|
|
48
|
+
# The object type. Always `event`.
|
|
49
|
+
#
|
|
50
|
+
# @param type [Symbol, :"agent.session.idle"]
|
|
51
|
+
# The event type. Always `agent.session.idle`.
|
|
52
|
+
|
|
53
|
+
# @see OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent#data
|
|
54
|
+
class Data < OpenAI::Internal::Type::BaseModel
|
|
55
|
+
# @!attribute id
|
|
56
|
+
# The ID of the session.
|
|
57
|
+
#
|
|
58
|
+
# @return [String]
|
|
59
|
+
required :id, String
|
|
60
|
+
|
|
61
|
+
# @!attribute environment_type
|
|
62
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
63
|
+
#
|
|
64
|
+
# @return [String]
|
|
65
|
+
required :environment_type, String
|
|
66
|
+
|
|
67
|
+
# @!attribute environment_id
|
|
68
|
+
# The ID of the environment, when one exists.
|
|
69
|
+
#
|
|
70
|
+
# @return [String, nil]
|
|
71
|
+
optional :environment_id, String
|
|
72
|
+
|
|
73
|
+
# @!method initialize(id:, environment_type:, environment_id: nil)
|
|
74
|
+
# @param id [String]
|
|
75
|
+
# The ID of the session.
|
|
76
|
+
#
|
|
77
|
+
# @param environment_type [String]
|
|
78
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
79
|
+
#
|
|
80
|
+
# @param environment_id [String]
|
|
81
|
+
# The ID of the environment, when one exists.
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class AgentSessionInProgressWebhookEvent < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the event.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :created_at, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute data
|
|
20
|
+
#
|
|
21
|
+
# @return [OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent::Data]
|
|
22
|
+
required :data, -> { OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data }
|
|
23
|
+
|
|
24
|
+
# @!attribute object
|
|
25
|
+
# The object type. Always `event`.
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, :event]
|
|
28
|
+
required :object, const: :event
|
|
29
|
+
|
|
30
|
+
# @!attribute type
|
|
31
|
+
# The event type. Always `agent.session.in_progress`.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, :"agent.session.in_progress"]
|
|
34
|
+
required :type, const: :"agent.session.in_progress"
|
|
35
|
+
|
|
36
|
+
# @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.in_progress")
|
|
37
|
+
# Sent when an agent session enters the in-progress state.
|
|
38
|
+
#
|
|
39
|
+
# @param id [String]
|
|
40
|
+
# The unique ID of the event.
|
|
41
|
+
#
|
|
42
|
+
# @param created_at [Integer]
|
|
43
|
+
# The Unix timestamp, in seconds, when the event was created.
|
|
44
|
+
#
|
|
45
|
+
# @param data [OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent::Data]
|
|
46
|
+
#
|
|
47
|
+
# @param object [Symbol, :event]
|
|
48
|
+
# The object type. Always `event`.
|
|
49
|
+
#
|
|
50
|
+
# @param type [Symbol, :"agent.session.in_progress"]
|
|
51
|
+
# The event type. Always `agent.session.in_progress`.
|
|
52
|
+
|
|
53
|
+
# @see OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent#data
|
|
54
|
+
class Data < OpenAI::Internal::Type::BaseModel
|
|
55
|
+
# @!attribute id
|
|
56
|
+
# The ID of the session.
|
|
57
|
+
#
|
|
58
|
+
# @return [String]
|
|
59
|
+
required :id, String
|
|
60
|
+
|
|
61
|
+
# @!attribute environment_type
|
|
62
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
63
|
+
#
|
|
64
|
+
# @return [String]
|
|
65
|
+
required :environment_type, String
|
|
66
|
+
|
|
67
|
+
# @!attribute environment_id
|
|
68
|
+
# The ID of the environment, when one exists.
|
|
69
|
+
#
|
|
70
|
+
# @return [String, nil]
|
|
71
|
+
optional :environment_id, String
|
|
72
|
+
|
|
73
|
+
# @!method initialize(id:, environment_type:, environment_id: nil)
|
|
74
|
+
# @param id [String]
|
|
75
|
+
# The ID of the session.
|
|
76
|
+
#
|
|
77
|
+
# @param environment_type [String]
|
|
78
|
+
# The environment type: `none`, `openai_hosted`, or `self_hosted`.
|
|
79
|
+
#
|
|
80
|
+
# @param environment_id [String]
|
|
81
|
+
# The ID of the environment, when one exists.
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
@@ -3,12 +3,28 @@
|
|
|
3
3
|
module OpenAI
|
|
4
4
|
module Models
|
|
5
5
|
module Webhooks
|
|
6
|
-
# Sent when
|
|
6
|
+
# Sent when an agent session requires an action. Retrieve the session for action
|
|
7
|
+
# details.
|
|
7
8
|
module UnwrapWebhookEvent
|
|
8
9
|
extend OpenAI::Internal::Type::Union
|
|
9
10
|
|
|
10
11
|
discriminator :type
|
|
11
12
|
|
|
13
|
+
# Sent when an agent session requires an action. Retrieve the session for action details.
|
|
14
|
+
variant :"agent.session.action_required", -> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent }
|
|
15
|
+
|
|
16
|
+
# Sent when an agent session is created.
|
|
17
|
+
variant :"agent.session.created", -> { OpenAI::Webhooks::AgentSessionCreatedWebhookEvent }
|
|
18
|
+
|
|
19
|
+
# Sent when an agent session fails.
|
|
20
|
+
variant :"agent.session.failed", -> { OpenAI::Webhooks::AgentSessionFailedWebhookEvent }
|
|
21
|
+
|
|
22
|
+
# Sent when an agent session becomes idle.
|
|
23
|
+
variant :"agent.session.idle", -> { OpenAI::Webhooks::AgentSessionIdleWebhookEvent }
|
|
24
|
+
|
|
25
|
+
# Sent when an agent session enters the in-progress state.
|
|
26
|
+
variant :"agent.session.in_progress", -> { OpenAI::Webhooks::AgentSessionInProgressWebhookEvent }
|
|
27
|
+
|
|
12
28
|
# Sent when a batch API request has been cancelled.
|
|
13
29
|
variant :"batch.cancelled", -> { OpenAI::Webhooks::BatchCancelledWebhookEvent }
|
|
14
30
|
|
|
@@ -81,7 +97,7 @@ module OpenAI
|
|
|
81
97
|
variant :"safety.warning_issued", -> { OpenAI::Webhooks::SafetyWarningIssuedWebhookEvent }
|
|
82
98
|
|
|
83
99
|
# @!method self.variants
|
|
84
|
-
# @return [Array(OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent)]
|
|
100
|
+
# @return [Array(OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent, OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent, OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent)]
|
|
85
101
|
end
|
|
86
102
|
end
|
|
87
103
|
end
|
|
@@ -62,6 +62,11 @@ module OpenAI
|
|
|
62
62
|
REALTIME_CALL_INCOMING = :"realtime.call.incoming"
|
|
63
63
|
VIDEO_COMPLETED = :"video.completed"
|
|
64
64
|
VIDEO_FAILED = :"video.failed"
|
|
65
|
+
AGENT_SESSION_CREATED = :"agent.session.created"
|
|
66
|
+
AGENT_SESSION_ACTION_REQUIRED = :"agent.session.action_required"
|
|
67
|
+
AGENT_SESSION_IN_PROGRESS = :"agent.session.in_progress"
|
|
68
|
+
AGENT_SESSION_IDLE = :"agent.session.idle"
|
|
69
|
+
AGENT_SESSION_FAILED = :"agent.session.failed"
|
|
65
70
|
SAFETY_ALERT_CREATED = :"safety.alert.created"
|
|
66
71
|
|
|
67
72
|
# @!method self.values
|
|
@@ -48,6 +48,11 @@ module OpenAI
|
|
|
48
48
|
REALTIME_CALL_INCOMING = :"realtime.call.incoming"
|
|
49
49
|
VIDEO_COMPLETED = :"video.completed"
|
|
50
50
|
VIDEO_FAILED = :"video.failed"
|
|
51
|
+
AGENT_SESSION_CREATED = :"agent.session.created"
|
|
52
|
+
AGENT_SESSION_ACTION_REQUIRED = :"agent.session.action_required"
|
|
53
|
+
AGENT_SESSION_IN_PROGRESS = :"agent.session.in_progress"
|
|
54
|
+
AGENT_SESSION_IDLE = :"agent.session.idle"
|
|
55
|
+
AGENT_SESSION_FAILED = :"agent.session.failed"
|
|
51
56
|
SAFETY_ALERT_CREATED = :"safety.alert.created"
|
|
52
57
|
|
|
53
58
|
# @!method self.values
|
|
@@ -69,6 +69,11 @@ module OpenAI
|
|
|
69
69
|
REALTIME_CALL_INCOMING = :"realtime.call.incoming"
|
|
70
70
|
VIDEO_COMPLETED = :"video.completed"
|
|
71
71
|
VIDEO_FAILED = :"video.failed"
|
|
72
|
+
AGENT_SESSION_CREATED = :"agent.session.created"
|
|
73
|
+
AGENT_SESSION_ACTION_REQUIRED = :"agent.session.action_required"
|
|
74
|
+
AGENT_SESSION_IN_PROGRESS = :"agent.session.in_progress"
|
|
75
|
+
AGENT_SESSION_IDLE = :"agent.session.idle"
|
|
76
|
+
AGENT_SESSION_FAILED = :"agent.session.failed"
|
|
72
77
|
SAFETY_ALERT_CREATED = :"safety.alert.created"
|
|
73
78
|
|
|
74
79
|
# @!method self.values
|