openai 0.114.0 → 0.115.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 +36 -0
- data/README.md +17 -2
- data/docs/architecture/security-model.md +11 -16
- data/examples/responses/websocket_workflows.rb +78 -3
- data/lib/openai/helpers/chat/tool_runner.rb +1 -1
- data/lib/openai/helpers/live/websocket.rb +31 -0
- data/lib/openai/helpers/realtime/connection.rb +33 -0
- data/lib/openai/helpers/realtime/connection_manager.rb +1 -0
- data/lib/openai/helpers/realtime/conversation_item_variant_resolver.rb +5 -0
- data/lib/openai/helpers/realtime/recovery.rb +5 -1
- data/lib/openai/helpers/realtime/translation.rb +5 -0
- data/lib/openai/helpers/realtime/transports/async_websocket.rb +19 -0
- data/lib/openai/helpers/responses_websocket/connection.rb +53 -15
- data/lib/openai/helpers/responses_websocket/connection_manager.rb +1 -0
- data/lib/openai/helpers/responses_websocket/connection_resources.rb +1 -1
- data/lib/openai/helpers/structured_output/response_parser.rb +1 -0
- data/lib/openai/helpers/structured_output.rb +58 -0
- data/lib/openai/helpers/websocket/connection_manager.rb +11 -0
- data/lib/openai/helpers/websocket/resource.rb +1 -0
- data/lib/openai/helpers/websocket/typed_connection.rb +1 -0
- data/lib/openai/internal/type/array_of.rb +1 -1
- data/lib/openai/internal/type/hash_of.rb +1 -1
- data/lib/openai/internal/type/request_parameters.rb +2 -1
- data/lib/openai/internal/type/union.rb +18 -6
- data/lib/openai/models/admin/organization/external_key.rb +169 -0
- data/lib/openai/models/admin/organization/external_key_create_params.rb +311 -0
- data/lib/openai/models/admin/organization/external_key_delete_params.rb +24 -0
- data/lib/openai/models/admin/organization/external_key_list_params.rb +69 -0
- data/lib/openai/models/admin/organization/external_key_retrieve_params.rb +24 -0
- data/lib/openai/models/admin/organization/external_key_validate_params.rb +24 -0
- data/lib/openai/models/admin/organization/external_key_validate_response.rb +20 -0
- data/lib/openai/models/audio/speech_model.rb +12 -0
- data/lib/openai/models/audio_model.rb +15 -0
- data/lib/openai/models/beta/agent.rb +49 -1
- data/lib/openai/models/beta/agent_create_params.rb +51 -1
- data/lib/openai/models/beta/agent_session.rb +75 -2
- data/lib/openai/models/beta/agent_update_params.rb +62 -1
- data/lib/openai/models/beta/agents/session_create_params.rb +94 -2
- data/lib/openai/models/beta/agents/session_list_params.rb +16 -1
- data/lib/openai/models/beta/agents/session_update_params.rb +50 -5
- data/lib/openai/models/beta/assistant_update_params.rb +18 -0
- data/lib/openai/models/beta/beta_response.rb +224 -1
- data/lib/openai/models/beta/beta_response_configuration_update_item.rb +64 -3
- data/lib/openai/models/beta/beta_response_configuration_update_item_param.rb +64 -4
- data/lib/openai/models/beta/beta_response_input_item.rb +2 -3
- data/lib/openai/models/beta/beta_response_item.rb +2 -2
- data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +6 -6
- data/lib/openai/models/beta/beta_responses_client_event.rb +20 -1
- data/lib/openai/models/beta/beta_tool.rb +6 -6
- data/lib/openai/models/beta/response_compact_params.rb +6 -0
- data/lib/openai/models/beta/response_create_params.rb +6 -0
- data/lib/openai/models/chat_model.rb +6 -0
- data/lib/openai/models/conversations/conversation_item.rb +2 -2
- data/lib/openai/models/image_edit_params.rb +46 -25
- data/lib/openai/models/live/fork_server_event.rb +43 -3
- data/lib/openai/models/live/server_event.rb +43 -3
- data/lib/openai/models/live/sideband_client_event.rb +40 -1
- data/lib/openai/models/live/sideband_server_event.rb +43 -3
- data/lib/openai/models/realtime/audio_transcription.rb +15 -0
- data/lib/openai/models/realtime/conversation_item_added.rb +2 -2
- data/lib/openai/models/realtime/conversation_item_create_event.rb +2 -2
- data/lib/openai/models/realtime/conversation_item_created_event.rb +2 -2
- data/lib/openai/models/realtime/conversation_item_done.rb +2 -2
- data/lib/openai/models/realtime/realtime_response.rb +2 -2
- data/lib/openai/models/realtime/realtime_response_create_params.rb +2 -2
- data/lib/openai/models/realtime/realtime_server_event.rb +2 -2
- data/lib/openai/models/realtime/realtime_session.rb +18 -0
- data/lib/openai/models/realtime/realtime_session_create_request.rb +18 -0
- data/lib/openai/models/realtime/realtime_session_create_response.rb +18 -0
- data/lib/openai/models/realtime/response_output_item_added_event.rb +2 -2
- data/lib/openai/models/realtime/response_output_item_done_event.rb +2 -2
- data/lib/openai/models/responses/response.rb +221 -1
- data/lib/openai/models/responses/response_compact_params.rb +6 -0
- data/lib/openai/models/responses/response_configuration_update_item.rb +50 -3
- data/lib/openai/models/responses/response_configuration_update_item_param.rb +50 -4
- data/lib/openai/models/responses/response_input_item.rb +2 -3
- data/lib/openai/models/responses/response_item.rb +2 -2
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +6 -6
- data/lib/openai/models/responses/responses_client_event.rb +14 -1
- data/lib/openai/models/responses/tool.rb +6 -6
- data/lib/openai/net_http_client.rb +6 -0
- data/lib/openai/providers/vertex.rb +0 -10
- data/lib/openai/resources/admin/organization/external_keys.rb +132 -0
- data/lib/openai/resources/admin/organization.rb +4 -0
- data/lib/openai/resources/audio/speech.rb +8 -0
- data/lib/openai/resources/audio/translations.rb +8 -0
- data/lib/openai/resources/beta/agents/sessions.rb +22 -6
- data/lib/openai/resources/beta/agents.rb +17 -2
- data/lib/openai/resources/images.rb +36 -18
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +8 -0
- data/rbi/openai/helpers/live/websocket.rbi +1 -12
- data/rbi/openai/helpers/realtime/connection.rbi +5 -0
- data/rbi/openai/helpers/realtime/transports/async_websocket.rbi +5 -0
- data/rbi/openai/helpers/responses_websocket/connection.rbi +7 -2
- data/rbi/openai/helpers/structured_output.rbi +10 -0
- data/rbi/openai/internal/type/array_of.rbi +1 -1
- data/rbi/openai/internal/type/hash_of.rbi +1 -1
- data/rbi/openai/internal/type/union.rbi +5 -0
- data/rbi/openai/models/admin/organization/external_key.rbi +301 -0
- data/rbi/openai/models/admin/organization/external_key_create_params.rbi +532 -0
- data/rbi/openai/models/admin/organization/external_key_delete_params.rbi +57 -0
- data/rbi/openai/models/admin/organization/external_key_list_params.rbi +129 -0
- data/rbi/openai/models/admin/organization/external_key_retrieve_params.rbi +57 -0
- data/rbi/openai/models/admin/organization/external_key_validate_params.rbi +57 -0
- data/rbi/openai/models/admin/organization/external_key_validate_response.rbi +50 -0
- data/rbi/openai/models/beta/agent.rbi +103 -1
- data/rbi/openai/models/beta/agent_create_params.rbi +109 -0
- data/rbi/openai/models/beta/agent_session.rbi +136 -3
- data/rbi/openai/models/beta/agent_update_params.rbi +120 -0
- data/rbi/openai/models/beta/agents/session_create_params.rbi +153 -0
- data/rbi/openai/models/beta/agents/session_list_params.rbi +19 -0
- data/rbi/openai/models/beta/agents/session_update_params.rbi +94 -6
- data/rbi/openai/models/beta/beta_response.rbi +394 -0
- data/rbi/openai/models/beta/beta_response_configuration_update_item.rbi +113 -3
- data/rbi/openai/models/beta/beta_response_configuration_update_item_param.rbi +125 -4
- data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +6 -6
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +17 -0
- data/rbi/openai/models/beta/beta_tool.rbi +6 -6
- data/rbi/openai/models/decision_create_params.rbi +4 -1
- data/rbi/openai/models/image_edit_params.rbi +49 -24
- data/rbi/openai/models/live/fork_server_event.rbi +65 -1
- data/rbi/openai/models/live/server_event.rbi +65 -1
- data/rbi/openai/models/live/sideband_client_event.rbi +60 -0
- data/rbi/openai/models/live/sideband_server_event.rbi +65 -1
- data/rbi/openai/models/realtime/conversation_item_added.rbi +6 -3
- data/rbi/openai/models/realtime/conversation_item_create_event.rbi +6 -3
- data/rbi/openai/models/realtime/conversation_item_created_event.rbi +6 -3
- data/rbi/openai/models/realtime/conversation_item_done.rbi +6 -3
- data/rbi/openai/models/realtime/realtime_response.rbi +8 -4
- data/rbi/openai/models/realtime/realtime_response_create_params.rbi +8 -4
- data/rbi/openai/models/realtime/realtime_server_event.rbi +6 -3
- data/rbi/openai/models/realtime/response_output_item_added_event.rbi +6 -3
- data/rbi/openai/models/realtime/response_output_item_done_event.rbi +6 -3
- data/rbi/openai/models/responses/response.rbi +394 -0
- data/rbi/openai/models/responses/response_configuration_update_item.rbi +76 -3
- data/rbi/openai/models/responses/response_configuration_update_item_param.rbi +74 -4
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +6 -6
- data/rbi/openai/models/responses/responses_client_event.rbi +17 -0
- data/rbi/openai/models/responses/tool.rbi +6 -6
- data/rbi/openai/net_http_client.rbi +5 -0
- data/rbi/openai/resources/admin/organization/external_keys.rbi +86 -0
- data/rbi/openai/resources/admin/organization.rbi +3 -0
- data/rbi/openai/resources/audio/speech.rbi +8 -0
- data/rbi/openai/resources/audio/translations.rbi +6 -0
- data/rbi/openai/resources/beta/agents/sessions.rbi +18 -2
- data/rbi/openai/resources/beta/agents.rbi +15 -0
- data/rbi/openai/resources/images.rbi +34 -16
- data/rbi/openai/resources/responses.rbi +2 -0
- data/realtime.md +6 -0
- data/responses-websocket.md +53 -0
- data/sig/openai/helpers/live/websocket.rbs +1 -9
- data/sig/openai/helpers/realtime/connection.rbs +3 -0
- data/sig/openai/helpers/realtime/transports/async_websocket.rbs +3 -0
- data/sig/openai/helpers/responses_websocket/connection.rbs +7 -1
- data/sig/openai/helpers/structured_output.rbs +9 -0
- data/sig/openai/internal/type/union.rbs +4 -0
- data/sig/openai/models/admin/organization/external_key.rbs +186 -0
- data/sig/openai/models/admin/organization/external_key_create_params.rbs +423 -0
- data/sig/openai/models/admin/organization/external_key_delete_params.rbs +27 -0
- data/sig/openai/models/admin/organization/external_key_list_params.rbs +81 -0
- data/sig/openai/models/admin/organization/external_key_retrieve_params.rbs +27 -0
- data/sig/openai/models/admin/organization/external_key_validate_params.rbs +27 -0
- data/sig/openai/models/admin/organization/external_key_validate_response.rbs +17 -0
- data/sig/openai/models/admin/organization/external_storage_create_params.rbs +72 -2
- data/sig/openai/models/audio/speech_create_params.rbs +15 -2
- data/sig/openai/models/audio/transcription_create_params.rbs +30 -2
- data/sig/openai/models/audio/voice_create_params.rbs +47 -2
- data/sig/openai/models/beta/agent.rbs +54 -2
- data/sig/openai/models/beta/agent_create_params.rbs +54 -0
- data/sig/openai/models/beta/agent_session.rbs +82 -3
- data/sig/openai/models/beta/agent_update_params.rbs +64 -0
- data/sig/openai/models/beta/agents/session_create_params.rbs +91 -0
- data/sig/openai/models/beta/agents/session_list_params.rbs +20 -0
- data/sig/openai/models/beta/agents/session_update_params.rbs +48 -6
- data/sig/openai/models/beta/assistant_create_params.rbs +5 -2
- data/sig/openai/models/beta/beta_response.rbs +223 -0
- data/sig/openai/models/beta/beta_response_configuration_update_item.rbs +58 -2
- data/sig/openai/models/beta/beta_response_configuration_update_item_param.rbs +58 -2
- data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +4 -4
- data/sig/openai/models/beta/beta_responses_client_event.rbs +17 -0
- data/sig/openai/models/beta/beta_tool.rbs +4 -4
- data/sig/openai/models/beta/response_create_params.rbs +5 -2
- data/sig/openai/models/beta/responses/input_token_count_params.rbs +10 -2
- data/sig/openai/models/beta/thread_create_and_run_params.rbs +11 -5
- data/sig/openai/models/beta/thread_create_params.rbs +11 -5
- data/sig/openai/models/beta/threads/message_create_params.rbs +6 -3
- data/sig/openai/models/beta/threads/run_create_params.rbs +6 -3
- data/sig/openai/models/decision_create_params.rbs +27 -2
- data/sig/openai/models/eval_create_params.rbs +25 -4
- data/sig/openai/models/evals/run_create_params.rbs +52 -8
- data/sig/openai/models/image_edit_params.rbs +47 -16
- data/sig/openai/models/live/fork_server_event.rbs +39 -0
- data/sig/openai/models/live/server_event.rbs +39 -0
- data/sig/openai/models/live/session_accept_params.rbs +39 -2
- data/sig/openai/models/live/sideband_client_event.rbs +32 -0
- data/sig/openai/models/live/sideband_server_event.rbs +39 -0
- data/sig/openai/models/realtime/conversation_item.rbs +1 -0
- data/sig/openai/models/responses/input_token_count_params.rbs +10 -2
- data/sig/openai/models/responses/response.rbs +223 -0
- data/sig/openai/models/responses/response_configuration_update_item.rbs +45 -2
- data/sig/openai/models/responses/response_configuration_update_item_param.rbs +45 -2
- data/sig/openai/models/responses/response_create_params.rbs +5 -2
- data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +4 -4
- data/sig/openai/models/responses/responses_client_event.rbs +17 -0
- data/sig/openai/models/responses/tool.rbs +4 -4
- data/sig/openai/models/video_edit_params.rbs +11 -2
- data/sig/openai/models/video_extend_params.rbs +11 -2
- data/sig/openai/net_http_client.rbs +3 -0
- data/sig/openai/resources/admin/organization/external_keys.rbs +70 -0
- data/sig/openai/resources/admin/organization/external_storage.rbs +23 -1
- data/sig/openai/resources/admin/organization.rbs +2 -0
- data/sig/openai/resources/audio/speech.rbs +2 -1
- data/sig/openai/resources/audio/transcriptions.rbs +14 -2
- data/sig/openai/resources/audio/voices.rbs +14 -1
- data/sig/openai/resources/beta/agents/sessions.rbs +4 -0
- data/sig/openai/resources/beta/agents.rbs +4 -0
- data/sig/openai/resources/beta/responses/input_tokens.rbs +2 -1
- data/sig/openai/resources/beta/responses.rbs +4 -2
- data/sig/openai/resources/decisions.rbs +7 -1
- data/sig/openai/resources/images.rbs +2 -0
- data/sig/openai/resources/responses/input_tokens.rbs +2 -1
- data/sig/openai/resources/responses.rbs +5 -2
- data/sig/openai/resources/videos.rbs +2 -2
- metadata +25 -1
|
@@ -28,10 +28,15 @@ module OpenAI
|
|
|
28
28
|
# @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning, nil]
|
|
29
29
|
optional :reasoning, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning }
|
|
30
30
|
|
|
31
|
-
# @!
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
#
|
|
31
|
+
# @!attribute text
|
|
32
|
+
# The text output configuration for subsequent responses.
|
|
33
|
+
#
|
|
34
|
+
# @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text, nil]
|
|
35
|
+
optional :text, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Text }
|
|
36
|
+
|
|
37
|
+
# @!method initialize(id: nil, agent: nil, reasoning: nil, text: nil, type: :configuration_update)
|
|
38
|
+
# An update to the conversation's response configuration. Supply reasoning, text,
|
|
39
|
+
# or both. Each setting stays in effect until a later update replaces it.
|
|
35
40
|
#
|
|
36
41
|
# @param id [String, nil]
|
|
37
42
|
# The unique ID of the configuration update item.
|
|
@@ -42,6 +47,9 @@ module OpenAI
|
|
|
42
47
|
# @param reasoning [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning]
|
|
43
48
|
# Updates to reasoning configuration. Only effort is supported.
|
|
44
49
|
#
|
|
50
|
+
# @param text [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text]
|
|
51
|
+
# The text output configuration for subsequent responses.
|
|
52
|
+
#
|
|
45
53
|
# @param type [Symbol, :configuration_update]
|
|
46
54
|
# The item type. Always `configuration_update`.
|
|
47
55
|
|
|
@@ -99,6 +107,58 @@ module OpenAI
|
|
|
99
107
|
# @return [Array<Symbol>]
|
|
100
108
|
end
|
|
101
109
|
end
|
|
110
|
+
|
|
111
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam#text
|
|
112
|
+
class Text < OpenAI::Internal::Type::BaseModel
|
|
113
|
+
# @!attribute format_
|
|
114
|
+
# Use a JSON schema for structured output or text to return to plain text.
|
|
115
|
+
#
|
|
116
|
+
# @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig]
|
|
117
|
+
required(
|
|
118
|
+
:format_,
|
|
119
|
+
union: -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format },
|
|
120
|
+
api_name: :format
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
# @!method initialize(format_:)
|
|
124
|
+
# The text output configuration for subsequent responses.
|
|
125
|
+
#
|
|
126
|
+
# @param format_ [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig]
|
|
127
|
+
# Use a JSON schema for structured output or text to return to plain text.
|
|
128
|
+
|
|
129
|
+
# Use a JSON schema for structured output or text to return to plain text.
|
|
130
|
+
#
|
|
131
|
+
# @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text#format_
|
|
132
|
+
module Format
|
|
133
|
+
extend OpenAI::Internal::Type::Union
|
|
134
|
+
|
|
135
|
+
discriminator :type
|
|
136
|
+
|
|
137
|
+
# Default response format. Used to generate text responses.
|
|
138
|
+
variant :text, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text }
|
|
139
|
+
|
|
140
|
+
# JSON Schema response format. Used to generate structured JSON responses.
|
|
141
|
+
# Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
142
|
+
variant :json_schema, -> { OpenAI::Beta::BetaResponseFormatTextJSONSchemaConfig }
|
|
143
|
+
|
|
144
|
+
class Text < OpenAI::Internal::Type::BaseModel
|
|
145
|
+
# @!attribute type
|
|
146
|
+
# The type of response format being defined. Always `text`.
|
|
147
|
+
#
|
|
148
|
+
# @return [Symbol, :text]
|
|
149
|
+
required :type, const: :text
|
|
150
|
+
|
|
151
|
+
# @!method initialize(type: :text)
|
|
152
|
+
# Default response format. Used to generate text responses.
|
|
153
|
+
#
|
|
154
|
+
# @param type [Symbol, :text]
|
|
155
|
+
# The type of response format being defined. Always `text`.
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# @!method self.variants
|
|
159
|
+
# @return [Array(OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig)]
|
|
160
|
+
end
|
|
161
|
+
end
|
|
102
162
|
end
|
|
103
163
|
end
|
|
104
164
|
|
|
@@ -63,9 +63,8 @@ module OpenAI
|
|
|
63
63
|
|
|
64
64
|
variant :additional_tools, -> { OpenAI::Beta::BetaResponseInputItem::AdditionalTools }
|
|
65
65
|
|
|
66
|
-
# An update to the conversation's response configuration.
|
|
67
|
-
#
|
|
68
|
-
# configuration update.
|
|
66
|
+
# An update to the conversation's response configuration. Supply reasoning,
|
|
67
|
+
# text, or both. Each setting stays in effect until a later update replaces it.
|
|
69
68
|
variant :configuration_update, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam }
|
|
70
69
|
|
|
71
70
|
# A description of the chain of thought used by a reasoning model while generating
|
|
@@ -46,8 +46,8 @@ module OpenAI
|
|
|
46
46
|
|
|
47
47
|
variant :additional_tools, -> { OpenAI::Beta::BetaResponseItem::AdditionalTools }
|
|
48
48
|
|
|
49
|
-
# A configuration update
|
|
50
|
-
#
|
|
49
|
+
# A configuration update for subsequent responses. Each setting stays in effect
|
|
50
|
+
# until a later update replaces that setting.
|
|
51
51
|
variant :configuration_update, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem }
|
|
52
52
|
|
|
53
53
|
# A description of the chain of thought used by a reasoning model while generating
|
|
@@ -758,8 +758,8 @@ module OpenAI
|
|
|
758
758
|
# @!attribute input_fidelity
|
|
759
759
|
# Control how much effort the model will exert to match the style and features,
|
|
760
760
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
761
|
-
# `gpt-image-1
|
|
762
|
-
#
|
|
761
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
762
|
+
# this parameter. Defaults to `low` on supported models.
|
|
763
763
|
#
|
|
764
764
|
# @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration::InputFidelity, nil]
|
|
765
765
|
optional(
|
|
@@ -878,8 +878,8 @@ module OpenAI
|
|
|
878
878
|
# @param input_fidelity [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration::InputFidelity, nil]
|
|
879
879
|
# Control how much effort the model will exert to match the style and features,
|
|
880
880
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
881
|
-
# `gpt-image-1
|
|
882
|
-
#
|
|
881
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
882
|
+
# this parameter. Defaults to `low` on supported models.
|
|
883
883
|
#
|
|
884
884
|
# @param input_image_mask [OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration::InputImageMask]
|
|
885
885
|
# Optional mask for inpainting. Contains `image_url` (string, optional) and
|
|
@@ -968,8 +968,8 @@ module OpenAI
|
|
|
968
968
|
|
|
969
969
|
# Control how much effort the model will exert to match the style and features,
|
|
970
970
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
971
|
-
# `gpt-image-1
|
|
972
|
-
#
|
|
971
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
972
|
+
# this parameter. Defaults to `low` on supported models.
|
|
973
973
|
#
|
|
974
974
|
# @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration#input_fidelity
|
|
975
975
|
module InputFidelity
|
|
@@ -99,6 +99,14 @@ module OpenAI
|
|
|
99
99
|
nil?: true
|
|
100
100
|
)
|
|
101
101
|
|
|
102
|
+
# @!attribute generate
|
|
103
|
+
# Whether to generate output for this response. Defaults to true when omitted. Set
|
|
104
|
+
# to false to prepare request state without model output; the response ID can be
|
|
105
|
+
# used as previous_response_id on a later turn.
|
|
106
|
+
#
|
|
107
|
+
# @return [Boolean, nil]
|
|
108
|
+
optional :generate, OpenAI::Internal::Type::Boolean
|
|
109
|
+
|
|
102
110
|
# @!attribute include
|
|
103
111
|
# Specify additional output data to include in the model response. Currently
|
|
104
112
|
# supported values are:
|
|
@@ -482,7 +490,7 @@ module OpenAI
|
|
|
482
490
|
# @return [String, nil]
|
|
483
491
|
optional :user, String
|
|
484
492
|
|
|
485
|
-
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
493
|
+
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, generate: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
486
494
|
# Client event for creating a response over a persistent WebSocket connection.
|
|
487
495
|
# This payload uses the same top-level fields as `POST /v1/responses`, plus
|
|
488
496
|
# WebSocket-only envelope metadata.
|
|
@@ -509,6 +517,11 @@ module OpenAI
|
|
|
509
517
|
# items from this response are automatically added to this conversation after this
|
|
510
518
|
# response completes.
|
|
511
519
|
#
|
|
520
|
+
# @param generate [Boolean]
|
|
521
|
+
# Whether to generate output for this response. Defaults to true when omitted. Set
|
|
522
|
+
# to false to prepare request state without model output; the response ID can be
|
|
523
|
+
# used as previous_response_id on a later turn.
|
|
524
|
+
#
|
|
512
525
|
# @param include [Array<Symbol, OpenAI::Models::Beta::BetaResponseIncludable>, nil]
|
|
513
526
|
# Specify additional output data to include in the model response. Currently
|
|
514
527
|
# supported values are:
|
|
@@ -1329,6 +1342,9 @@ module OpenAI
|
|
|
1329
1342
|
# replacements.
|
|
1330
1343
|
GPT_5_4_NANO = :"gpt-5.4-nano"
|
|
1331
1344
|
GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
|
|
1345
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
1346
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1347
|
+
# replacements.
|
|
1332
1348
|
GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
|
|
1333
1349
|
# @deprecated Announced shutdown date: 2026-08-10. See
|
|
1334
1350
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -1346,6 +1362,9 @@ module OpenAI
|
|
|
1346
1362
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1347
1363
|
# replacements.
|
|
1348
1364
|
GPT_5_1 = :"gpt-5.1"
|
|
1365
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
1366
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1367
|
+
# replacements.
|
|
1349
1368
|
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
1350
1369
|
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
1351
1370
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -634,8 +634,8 @@ module OpenAI
|
|
|
634
634
|
# @!attribute input_fidelity
|
|
635
635
|
# Control how much effort the model will exert to match the style and features,
|
|
636
636
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
637
|
-
# `gpt-image-1
|
|
638
|
-
#
|
|
637
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
638
|
+
# this parameter. Defaults to `low` on supported models.
|
|
639
639
|
#
|
|
640
640
|
# @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil]
|
|
641
641
|
optional(
|
|
@@ -736,8 +736,8 @@ module OpenAI
|
|
|
736
736
|
# @param input_fidelity [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil]
|
|
737
737
|
# Control how much effort the model will exert to match the style and features,
|
|
738
738
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
739
|
-
# `gpt-image-1
|
|
740
|
-
#
|
|
739
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
740
|
+
# this parameter. Defaults to `low` on supported models.
|
|
741
741
|
#
|
|
742
742
|
# @param input_image_mask [OpenAI::Models::Beta::BetaTool::ImageGeneration::InputImageMask]
|
|
743
743
|
# Optional mask for inpainting. Contains `image_url` (string, optional) and
|
|
@@ -826,8 +826,8 @@ module OpenAI
|
|
|
826
826
|
|
|
827
827
|
# Control how much effort the model will exert to match the style and features,
|
|
828
828
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
829
|
-
# `gpt-image-1
|
|
830
|
-
#
|
|
829
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
830
|
+
# this parameter. Defaults to `low` on supported models.
|
|
831
831
|
#
|
|
832
832
|
# @see OpenAI::Models::Beta::BetaTool::ImageGeneration#input_fidelity
|
|
833
833
|
module InputFidelity
|
|
@@ -428,6 +428,9 @@ module OpenAI
|
|
|
428
428
|
# replacements.
|
|
429
429
|
GPT_5_4_NANO = :"gpt-5.4-nano"
|
|
430
430
|
GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
|
|
431
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
432
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
433
|
+
# replacements.
|
|
431
434
|
GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
|
|
432
435
|
# @deprecated Announced shutdown date: 2026-08-10. See
|
|
433
436
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -445,6 +448,9 @@ module OpenAI
|
|
|
445
448
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
446
449
|
# replacements.
|
|
447
450
|
GPT_5_1 = :"gpt-5.1"
|
|
451
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
452
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
453
|
+
# replacements.
|
|
448
454
|
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
449
455
|
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
450
456
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -1013,6 +1013,9 @@ module OpenAI
|
|
|
1013
1013
|
# replacements.
|
|
1014
1014
|
GPT_5_4_NANO = :"gpt-5.4-nano"
|
|
1015
1015
|
GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
|
|
1016
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
1017
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1018
|
+
# replacements.
|
|
1016
1019
|
GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
|
|
1017
1020
|
# @deprecated Announced shutdown date: 2026-08-10. See
|
|
1018
1021
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -1030,6 +1033,9 @@ module OpenAI
|
|
|
1030
1033
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1031
1034
|
# replacements.
|
|
1032
1035
|
GPT_5_1 = :"gpt-5.1"
|
|
1036
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
1037
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1038
|
+
# replacements.
|
|
1033
1039
|
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
1034
1040
|
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
1035
1041
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -22,6 +22,9 @@ module OpenAI
|
|
|
22
22
|
# replacements.
|
|
23
23
|
GPT_5_4_NANO = :"gpt-5.4-nano"
|
|
24
24
|
GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
|
|
25
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
26
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
27
|
+
# replacements.
|
|
25
28
|
GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
|
|
26
29
|
# @deprecated Announced shutdown date: 2026-08-10. See
|
|
27
30
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -39,6 +42,9 @@ module OpenAI
|
|
|
39
42
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
40
43
|
# replacements.
|
|
41
44
|
GPT_5_1 = :"gpt-5.1"
|
|
45
|
+
# @deprecated Announced shutdown date: 2027-04-01. See
|
|
46
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
47
|
+
# replacements.
|
|
42
48
|
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
43
49
|
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
44
50
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
@@ -45,8 +45,8 @@ module OpenAI
|
|
|
45
45
|
|
|
46
46
|
variant :additional_tools, -> { OpenAI::Conversations::ConversationItem::AdditionalTools }
|
|
47
47
|
|
|
48
|
-
# A configuration update
|
|
49
|
-
#
|
|
48
|
+
# A configuration update for subsequent responses. Each setting stays in effect
|
|
49
|
+
# until a later update replaces that setting.
|
|
50
50
|
variant :configuration_update, -> { OpenAI::Responses::ResponseConfigurationUpdateItem }
|
|
51
51
|
|
|
52
52
|
# A description of the chain of thought used by a reasoning model while generating
|
|
@@ -12,12 +12,12 @@ module OpenAI
|
|
|
12
12
|
# @!attribute image
|
|
13
13
|
# The image(s) to edit. Must be a supported image file or an array of images.
|
|
14
14
|
#
|
|
15
|
-
# For the GPT image models (`gpt-image-1`, `gpt-image-1
|
|
16
|
-
# `gpt-image-2
|
|
17
|
-
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
18
|
-
# `gpt-image-2.5-flare-2026-09-08
|
|
19
|
-
#
|
|
20
|
-
#
|
|
15
|
+
# For the GPT image models (`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
|
|
16
|
+
# `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
17
|
+
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
|
|
18
|
+
# `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
|
|
19
|
+
# `jpg` file less than 50MB. You can provide up to 16 images.
|
|
20
|
+
# `chatgpt-image-latest` follows the same input constraints as GPT image models.
|
|
21
21
|
#
|
|
22
22
|
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
23
23
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
@@ -50,12 +50,24 @@ module OpenAI
|
|
|
50
50
|
# @!attribute input_fidelity
|
|
51
51
|
# Control how much effort the model will exert to match the style and features,
|
|
52
52
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
53
|
-
# `gpt-image-1
|
|
54
|
-
#
|
|
53
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
54
|
+
# this parameter. Defaults to `low` on supported models.
|
|
55
55
|
#
|
|
56
56
|
# @return [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
|
|
57
57
|
optional :input_fidelity, enum: -> { OpenAI::ImageEditParams::InputFidelity }, nil?: true
|
|
58
58
|
|
|
59
|
+
# @!attribute markup
|
|
60
|
+
# A transparent PNG overlaid on the first image to guide the edit. Must match that
|
|
61
|
+
# image's dimensions after orientation and contain transparent pixels. Supports
|
|
62
|
+
# GPT Image 2.5 and 2.6. Cannot be combined with mask.
|
|
63
|
+
#
|
|
64
|
+
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
65
|
+
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
66
|
+
# content type.
|
|
67
|
+
#
|
|
68
|
+
# @return [Pathname, StringIO, IO, String, OpenAI::FilePart, nil]
|
|
69
|
+
optional :markup, OpenAI::Internal::Type::FileInput
|
|
70
|
+
|
|
59
71
|
# @!attribute mask
|
|
60
72
|
# An additional image whose fully transparent areas (e.g. where alpha is zero)
|
|
61
73
|
# indicate where `image` should be edited. If there are multiple images provided,
|
|
@@ -171,16 +183,16 @@ module OpenAI
|
|
|
171
183
|
# @return [String, nil]
|
|
172
184
|
optional :user, String
|
|
173
185
|
|
|
174
|
-
# @!method initialize(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
|
|
186
|
+
# @!method initialize(image:, prompt:, background: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
|
|
175
187
|
# @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
|
|
176
188
|
# The image(s) to edit. Must be a supported image file or an array of images.
|
|
177
189
|
#
|
|
178
|
-
# For the GPT image models (`gpt-image-1`, `gpt-image-1
|
|
179
|
-
# `gpt-image-2
|
|
180
|
-
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
181
|
-
# `gpt-image-2.5-flare-2026-09-08
|
|
182
|
-
#
|
|
183
|
-
#
|
|
190
|
+
# For the GPT image models (`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
|
|
191
|
+
# `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
192
|
+
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
|
|
193
|
+
# `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
|
|
194
|
+
# `jpg` file less than 50MB. You can provide up to 16 images.
|
|
195
|
+
# `chatgpt-image-latest` follows the same input constraints as GPT image models.
|
|
184
196
|
#
|
|
185
197
|
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
186
198
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
@@ -204,8 +216,17 @@ module OpenAI
|
|
|
204
216
|
# @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
|
|
205
217
|
# Control how much effort the model will exert to match the style and features,
|
|
206
218
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
207
|
-
# `gpt-image-1
|
|
208
|
-
#
|
|
219
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
220
|
+
# this parameter. Defaults to `low` on supported models.
|
|
221
|
+
#
|
|
222
|
+
# @param markup [Pathname, StringIO, IO, String, OpenAI::FilePart]
|
|
223
|
+
# A transparent PNG overlaid on the first image to guide the edit. Must match that
|
|
224
|
+
# image's dimensions after orientation and contain transparent pixels. Supports
|
|
225
|
+
# GPT Image 2.5 and 2.6. Cannot be combined with mask.
|
|
226
|
+
#
|
|
227
|
+
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
228
|
+
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
229
|
+
# content type.
|
|
209
230
|
#
|
|
210
231
|
# @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart]
|
|
211
232
|
# An additional image whose fully transparent areas (e.g. where alpha is zero)
|
|
@@ -289,12 +310,12 @@ module OpenAI
|
|
|
289
310
|
|
|
290
311
|
# The image(s) to edit. Must be a supported image file or an array of images.
|
|
291
312
|
#
|
|
292
|
-
# For the GPT image models (`gpt-image-1`, `gpt-image-1
|
|
293
|
-
# `gpt-image-2
|
|
294
|
-
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
295
|
-
# `gpt-image-2.5-flare-2026-09-08
|
|
296
|
-
#
|
|
297
|
-
#
|
|
313
|
+
# For the GPT image models (`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
|
|
314
|
+
# `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
315
|
+
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
|
|
316
|
+
# `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
|
|
317
|
+
# `jpg` file less than 50MB. You can provide up to 16 images.
|
|
318
|
+
# `chatgpt-image-latest` follows the same input constraints as GPT image models.
|
|
298
319
|
module Image
|
|
299
320
|
extend OpenAI::Internal::Type::Union
|
|
300
321
|
|
|
@@ -331,8 +352,8 @@ module OpenAI
|
|
|
331
352
|
|
|
332
353
|
# Control how much effort the model will exert to match the style and features,
|
|
333
354
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
334
|
-
# `gpt-image-1
|
|
335
|
-
#
|
|
355
|
+
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
356
|
+
# this parameter. Defaults to `low` on supported models.
|
|
336
357
|
module InputFidelity
|
|
337
358
|
extend OpenAI::Internal::Type::Enum
|
|
338
359
|
|
|
@@ -82,9 +82,12 @@ module OpenAI
|
|
|
82
82
|
# A SIP DTMF keypress received from the caller. Delivered only to sideband observers.
|
|
83
83
|
variant :"transport.dtmf.received", -> { OpenAI::Live::ForkServerEvent::TransportDtmfReceived }
|
|
84
84
|
|
|
85
|
-
#
|
|
85
|
+
# Legacy SIP DTMF delivery notification retained for SDK compatibility and saved events. Current servers confirm delivery with transport.dtmf.sent; transport.dtmf.send is now the client command.
|
|
86
86
|
variant :"transport.dtmf.send", -> { OpenAI::Live::ForkServerEvent::TransportDtmfSend }
|
|
87
87
|
|
|
88
|
+
# A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.
|
|
89
|
+
variant :"transport.dtmf.sent", -> { OpenAI::Live::ForkServerEvent::TransportDtmfSent }
|
|
90
|
+
|
|
88
91
|
# The outbound SIP provider leg is ringing or providing early media. Delivered only to sideband observers.
|
|
89
92
|
variant :"transport.ringing", -> { OpenAI::Live::ForkServerEvent::TransportRinging }
|
|
90
93
|
|
|
@@ -170,6 +173,43 @@ module OpenAI
|
|
|
170
173
|
optional :client_event_id, String
|
|
171
174
|
|
|
172
175
|
# @!method initialize(event:, event_id:, client_event_id: nil, type: :"transport.dtmf.send")
|
|
176
|
+
# Legacy SIP DTMF delivery notification retained for SDK compatibility and saved
|
|
177
|
+
# events. Current servers confirm delivery with transport.dtmf.sent;
|
|
178
|
+
# transport.dtmf.send is now the client command.
|
|
179
|
+
#
|
|
180
|
+
# @param event [String]
|
|
181
|
+
#
|
|
182
|
+
# @param event_id [String]
|
|
183
|
+
#
|
|
184
|
+
# @param client_event_id [String]
|
|
185
|
+
# The event_id of the client command, when supplied.
|
|
186
|
+
#
|
|
187
|
+
# @param type [Symbol, :"transport.dtmf.send"]
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
class TransportDtmfSent < OpenAI::Internal::Type::BaseModel
|
|
191
|
+
# @!attribute event
|
|
192
|
+
#
|
|
193
|
+
# @return [String]
|
|
194
|
+
required :event, String
|
|
195
|
+
|
|
196
|
+
# @!attribute event_id
|
|
197
|
+
#
|
|
198
|
+
# @return [String]
|
|
199
|
+
required :event_id, String
|
|
200
|
+
|
|
201
|
+
# @!attribute type
|
|
202
|
+
#
|
|
203
|
+
# @return [Symbol, :"transport.dtmf.sent"]
|
|
204
|
+
required :type, const: :"transport.dtmf.sent"
|
|
205
|
+
|
|
206
|
+
# @!attribute client_event_id
|
|
207
|
+
# The event_id of the client command, when supplied.
|
|
208
|
+
#
|
|
209
|
+
# @return [String, nil]
|
|
210
|
+
optional :client_event_id, String
|
|
211
|
+
|
|
212
|
+
# @!method initialize(event:, event_id:, client_event_id: nil, type: :"transport.dtmf.sent")
|
|
173
213
|
# A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
|
|
174
214
|
# sideband observers; this is not a client command.
|
|
175
215
|
#
|
|
@@ -180,7 +220,7 @@ module OpenAI
|
|
|
180
220
|
# @param client_event_id [String]
|
|
181
221
|
# The event_id of the client command, when supplied.
|
|
182
222
|
#
|
|
183
|
-
# @param type [Symbol, :"transport.dtmf.
|
|
223
|
+
# @param type [Symbol, :"transport.dtmf.sent"]
|
|
184
224
|
end
|
|
185
225
|
|
|
186
226
|
class TransportRinging < OpenAI::Internal::Type::BaseModel
|
|
@@ -314,7 +354,7 @@ module OpenAI
|
|
|
314
354
|
end
|
|
315
355
|
|
|
316
356
|
# @!method self.variants
|
|
317
|
-
# @return [Array(OpenAI::Models::Live::SessionStartedEvent, OpenAI::Models::Live::SessionUpdatedEvent, OpenAI::Models::Live::InputAudioMutedEvent, OpenAI::Models::Live::InputAudioUnmutedEvent, OpenAI::Models::Live::OutputAudioFixturePlayingEvent, OpenAI::Models::Live::OutputAudioFixturePlayedEvent, OpenAI::Models::Live::InstructionsAppendedEvent, OpenAI::Models::Live::ThinkingAppendedEvent, OpenAI::Models::Live::CommentaryAppendedEvent, OpenAI::Models::Live::ForkServerEvent::SessionInputAudioAppend, OpenAI::Models::Live::OutputAudioDeltaEvent, OpenAI::Models::Live::InputTranscriptDeltaEvent, OpenAI::Models::Live::OutputTranscriptDeltaEvent, OpenAI::Models::Live::DelegationCreatedEvent, OpenAI::Models::Live::DecisionEvent, OpenAI::Models::Live::DecisionItemCreatedEvent, OpenAI::Models::Live::DecisionItemDeletedEvent, OpenAI::Models::Live::ResponseEvent, OpenAI::Models::Live::SessionUsageUpdatedEvent, OpenAI::Models::Live::SessionClosedEvent, OpenAI::Models::Live::ErrorEvent, OpenAI::Models::Live::InfoEvent, OpenAI::Models::Live::ForkServerEvent::TransportDtmfReceived, OpenAI::Models::Live::ForkServerEvent::TransportDtmfSend, OpenAI::Models::Live::ForkServerEvent::TransportRinging, OpenAI::Models::Live::ForkServerEvent::TransportAnswered, OpenAI::Models::Live::ForkServerEvent::TransportFailed)]
|
|
357
|
+
# @return [Array(OpenAI::Models::Live::SessionStartedEvent, OpenAI::Models::Live::SessionUpdatedEvent, OpenAI::Models::Live::InputAudioMutedEvent, OpenAI::Models::Live::InputAudioUnmutedEvent, OpenAI::Models::Live::OutputAudioFixturePlayingEvent, OpenAI::Models::Live::OutputAudioFixturePlayedEvent, OpenAI::Models::Live::InstructionsAppendedEvent, OpenAI::Models::Live::ThinkingAppendedEvent, OpenAI::Models::Live::CommentaryAppendedEvent, OpenAI::Models::Live::ForkServerEvent::SessionInputAudioAppend, OpenAI::Models::Live::OutputAudioDeltaEvent, OpenAI::Models::Live::InputTranscriptDeltaEvent, OpenAI::Models::Live::OutputTranscriptDeltaEvent, OpenAI::Models::Live::DelegationCreatedEvent, OpenAI::Models::Live::DecisionEvent, OpenAI::Models::Live::DecisionItemCreatedEvent, OpenAI::Models::Live::DecisionItemDeletedEvent, OpenAI::Models::Live::ResponseEvent, OpenAI::Models::Live::SessionUsageUpdatedEvent, OpenAI::Models::Live::SessionClosedEvent, OpenAI::Models::Live::ErrorEvent, OpenAI::Models::Live::InfoEvent, OpenAI::Models::Live::ForkServerEvent::TransportDtmfReceived, OpenAI::Models::Live::ForkServerEvent::TransportDtmfSend, OpenAI::Models::Live::ForkServerEvent::TransportDtmfSent, OpenAI::Models::Live::ForkServerEvent::TransportRinging, OpenAI::Models::Live::ForkServerEvent::TransportAnswered, OpenAI::Models::Live::ForkServerEvent::TransportFailed)]
|
|
318
358
|
end
|
|
319
359
|
end
|
|
320
360
|
end
|
|
@@ -82,9 +82,12 @@ module OpenAI
|
|
|
82
82
|
# A SIP DTMF keypress received from the caller. Delivered only to sideband observers.
|
|
83
83
|
variant :"transport.dtmf.received", -> { OpenAI::Live::ServerEvent::TransportDtmfReceived }
|
|
84
84
|
|
|
85
|
-
#
|
|
85
|
+
# Legacy SIP DTMF delivery notification retained for SDK compatibility and saved events. Current servers confirm delivery with transport.dtmf.sent; transport.dtmf.send is now the client command.
|
|
86
86
|
variant :"transport.dtmf.send", -> { OpenAI::Live::ServerEvent::TransportDtmfSend }
|
|
87
87
|
|
|
88
|
+
# A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.
|
|
89
|
+
variant :"transport.dtmf.sent", -> { OpenAI::Live::ServerEvent::TransportDtmfSent }
|
|
90
|
+
|
|
88
91
|
# The outbound SIP provider leg is ringing or providing early media. Delivered only to sideband observers.
|
|
89
92
|
variant :"transport.ringing", -> { OpenAI::Live::ServerEvent::TransportRinging }
|
|
90
93
|
|
|
@@ -170,6 +173,43 @@ module OpenAI
|
|
|
170
173
|
optional :client_event_id, String
|
|
171
174
|
|
|
172
175
|
# @!method initialize(event:, event_id:, client_event_id: nil, type: :"transport.dtmf.send")
|
|
176
|
+
# Legacy SIP DTMF delivery notification retained for SDK compatibility and saved
|
|
177
|
+
# events. Current servers confirm delivery with transport.dtmf.sent;
|
|
178
|
+
# transport.dtmf.send is now the client command.
|
|
179
|
+
#
|
|
180
|
+
# @param event [String]
|
|
181
|
+
#
|
|
182
|
+
# @param event_id [String]
|
|
183
|
+
#
|
|
184
|
+
# @param client_event_id [String]
|
|
185
|
+
# The event_id of the client command, when supplied.
|
|
186
|
+
#
|
|
187
|
+
# @param type [Symbol, :"transport.dtmf.send"]
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
class TransportDtmfSent < OpenAI::Internal::Type::BaseModel
|
|
191
|
+
# @!attribute event
|
|
192
|
+
#
|
|
193
|
+
# @return [String]
|
|
194
|
+
required :event, String
|
|
195
|
+
|
|
196
|
+
# @!attribute event_id
|
|
197
|
+
#
|
|
198
|
+
# @return [String]
|
|
199
|
+
required :event_id, String
|
|
200
|
+
|
|
201
|
+
# @!attribute type
|
|
202
|
+
#
|
|
203
|
+
# @return [Symbol, :"transport.dtmf.sent"]
|
|
204
|
+
required :type, const: :"transport.dtmf.sent"
|
|
205
|
+
|
|
206
|
+
# @!attribute client_event_id
|
|
207
|
+
# The event_id of the client command, when supplied.
|
|
208
|
+
#
|
|
209
|
+
# @return [String, nil]
|
|
210
|
+
optional :client_event_id, String
|
|
211
|
+
|
|
212
|
+
# @!method initialize(event:, event_id:, client_event_id: nil, type: :"transport.dtmf.sent")
|
|
173
213
|
# A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
|
|
174
214
|
# sideband observers; this is not a client command.
|
|
175
215
|
#
|
|
@@ -180,7 +220,7 @@ module OpenAI
|
|
|
180
220
|
# @param client_event_id [String]
|
|
181
221
|
# The event_id of the client command, when supplied.
|
|
182
222
|
#
|
|
183
|
-
# @param type [Symbol, :"transport.dtmf.
|
|
223
|
+
# @param type [Symbol, :"transport.dtmf.sent"]
|
|
184
224
|
end
|
|
185
225
|
|
|
186
226
|
class TransportRinging < OpenAI::Internal::Type::BaseModel
|
|
@@ -314,7 +354,7 @@ module OpenAI
|
|
|
314
354
|
end
|
|
315
355
|
|
|
316
356
|
# @!method self.variants
|
|
317
|
-
# @return [Array(OpenAI::Models::Live::SessionStartedEvent, OpenAI::Models::Live::SessionUpdatedEvent, OpenAI::Models::Live::InputAudioMutedEvent, OpenAI::Models::Live::InputAudioUnmutedEvent, OpenAI::Models::Live::OutputAudioFixturePlayingEvent, OpenAI::Models::Live::OutputAudioFixturePlayedEvent, OpenAI::Models::Live::InstructionsAppendedEvent, OpenAI::Models::Live::ThinkingAppendedEvent, OpenAI::Models::Live::CommentaryAppendedEvent, OpenAI::Models::Live::ServerEvent::SessionInputAudioAppend, OpenAI::Models::Live::OutputAudioDeltaEvent, OpenAI::Models::Live::InputTranscriptDeltaEvent, OpenAI::Models::Live::OutputTranscriptDeltaEvent, OpenAI::Models::Live::DelegationCreatedEvent, OpenAI::Models::Live::DecisionEvent, OpenAI::Models::Live::DecisionItemCreatedEvent, OpenAI::Models::Live::DecisionItemDeletedEvent, OpenAI::Models::Live::ResponseEvent, OpenAI::Models::Live::SessionUsageUpdatedEvent, OpenAI::Models::Live::SessionClosedEvent, OpenAI::Models::Live::ErrorEvent, OpenAI::Models::Live::InfoEvent, OpenAI::Models::Live::ServerEvent::TransportDtmfReceived, OpenAI::Models::Live::ServerEvent::TransportDtmfSend, OpenAI::Models::Live::ServerEvent::TransportRinging, OpenAI::Models::Live::ServerEvent::TransportAnswered, OpenAI::Models::Live::ServerEvent::TransportFailed)]
|
|
357
|
+
# @return [Array(OpenAI::Models::Live::SessionStartedEvent, OpenAI::Models::Live::SessionUpdatedEvent, OpenAI::Models::Live::InputAudioMutedEvent, OpenAI::Models::Live::InputAudioUnmutedEvent, OpenAI::Models::Live::OutputAudioFixturePlayingEvent, OpenAI::Models::Live::OutputAudioFixturePlayedEvent, OpenAI::Models::Live::InstructionsAppendedEvent, OpenAI::Models::Live::ThinkingAppendedEvent, OpenAI::Models::Live::CommentaryAppendedEvent, OpenAI::Models::Live::ServerEvent::SessionInputAudioAppend, OpenAI::Models::Live::OutputAudioDeltaEvent, OpenAI::Models::Live::InputTranscriptDeltaEvent, OpenAI::Models::Live::OutputTranscriptDeltaEvent, OpenAI::Models::Live::DelegationCreatedEvent, OpenAI::Models::Live::DecisionEvent, OpenAI::Models::Live::DecisionItemCreatedEvent, OpenAI::Models::Live::DecisionItemDeletedEvent, OpenAI::Models::Live::ResponseEvent, OpenAI::Models::Live::SessionUsageUpdatedEvent, OpenAI::Models::Live::SessionClosedEvent, OpenAI::Models::Live::ErrorEvent, OpenAI::Models::Live::InfoEvent, OpenAI::Models::Live::ServerEvent::TransportDtmfReceived, OpenAI::Models::Live::ServerEvent::TransportDtmfSend, OpenAI::Models::Live::ServerEvent::TransportDtmfSent, OpenAI::Models::Live::ServerEvent::TransportRinging, OpenAI::Models::Live::ServerEvent::TransportAnswered, OpenAI::Models::Live::ServerEvent::TransportFailed)]
|
|
318
358
|
end
|
|
319
359
|
end
|
|
320
360
|
end
|