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
|
@@ -87,8 +87,10 @@ module OpenAI
|
|
|
87
87
|
?object: :"organization.usage.completions.result",
|
|
88
88
|
output_tokens: Integer,
|
|
89
89
|
?api_key_id: String?,
|
|
90
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult::api_source?,
|
|
90
91
|
?batch: bool?,
|
|
91
92
|
?input_audio_tokens: Integer,
|
|
93
|
+
?:input_cache_write_12h_tokens => Integer,
|
|
92
94
|
?input_cache_write_tokens: Integer,
|
|
93
95
|
?input_cached_audio_tokens: Integer,
|
|
94
96
|
?input_cached_image_tokens: Integer,
|
|
@@ -126,6 +128,12 @@ module OpenAI
|
|
|
126
128
|
# usage result.
|
|
127
129
|
attr_accessor api_key_id: String?
|
|
128
130
|
|
|
131
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
132
|
+
# activity and `unlabeled` includes all records without published source
|
|
133
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
134
|
+
# direct API usage. Without source grouping, this field is null.
|
|
135
|
+
attr_accessor api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult::api_source?
|
|
136
|
+
|
|
129
137
|
# When `group_by=batch`, this field tells whether the grouped usage result is
|
|
130
138
|
# batch or not.
|
|
131
139
|
attr_accessor batch: bool?
|
|
@@ -136,10 +144,20 @@ module OpenAI
|
|
|
136
144
|
# The aggregated number of uncached audio input tokens used.
|
|
137
145
|
def input_audio_tokens=: (Integer) -> Integer
|
|
138
146
|
|
|
139
|
-
# The aggregated number of input tokens written to the cache
|
|
147
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
148
|
+
# retention period.
|
|
149
|
+
attr_reader input_cache_write_12h_tokens: Integer?
|
|
150
|
+
|
|
151
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
152
|
+
# retention period.
|
|
153
|
+
def input_cache_write_12h_tokens=: (Integer) -> Integer
|
|
154
|
+
|
|
155
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
156
|
+
# retention period.
|
|
140
157
|
attr_reader input_cache_write_tokens: Integer?
|
|
141
158
|
|
|
142
|
-
# The aggregated number of input tokens written to the cache
|
|
159
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
160
|
+
# retention period.
|
|
143
161
|
def input_cache_write_tokens=: (Integer) -> Integer
|
|
144
162
|
|
|
145
163
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -237,13 +255,22 @@ module OpenAI
|
|
|
237
255
|
# @param api_key_id
|
|
238
256
|
# When `group_by=api_key_id`, this field provides the API key ID of the grouped
|
|
239
257
|
# usage result.
|
|
258
|
+
# @param api_source
|
|
259
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
260
|
+
# activity and `unlabeled` includes all records without published source
|
|
261
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
262
|
+
# direct API usage. Without source grouping, this field is null.
|
|
240
263
|
# @param batch
|
|
241
264
|
# When `group_by=batch`, this field tells whether the grouped usage result is
|
|
242
265
|
# batch or not.
|
|
243
266
|
# @param input_audio_tokens
|
|
244
267
|
# The aggregated number of uncached audio input tokens used.
|
|
268
|
+
# @param input_cache_write_12h_tokens
|
|
269
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
270
|
+
# retention period.
|
|
245
271
|
# @param input_cache_write_tokens
|
|
246
|
-
# The aggregated number of input tokens written to the cache
|
|
272
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
273
|
+
# retention period.
|
|
247
274
|
# @param input_cached_audio_tokens
|
|
248
275
|
# The aggregated number of cached audio input tokens used.
|
|
249
276
|
# @param input_cached_image_tokens
|
|
@@ -284,8 +311,10 @@ module OpenAI
|
|
|
284
311
|
num_model_requests: Integer,
|
|
285
312
|
output_tokens: Integer,
|
|
286
313
|
?api_key_id: String?,
|
|
314
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult::api_source?,
|
|
287
315
|
?batch: bool?,
|
|
288
316
|
?input_audio_tokens: Integer,
|
|
317
|
+
?input_cache_write_12h_tokens: Integer,
|
|
289
318
|
?input_cache_write_tokens: Integer,
|
|
290
319
|
?input_cached_audio_tokens: Integer,
|
|
291
320
|
?input_cached_image_tokens: Integer,
|
|
@@ -310,8 +339,10 @@ module OpenAI
|
|
|
310
339
|
?object: :"organization.usage.completions.result",
|
|
311
340
|
output_tokens: Integer,
|
|
312
341
|
?api_key_id: String?,
|
|
342
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult::api_source?,
|
|
313
343
|
?batch: bool?,
|
|
314
344
|
?input_audio_tokens: Integer,
|
|
345
|
+
?:input_cache_write_12h_tokens => Integer,
|
|
315
346
|
?input_cache_write_tokens: Integer,
|
|
316
347
|
?input_cached_audio_tokens: Integer,
|
|
317
348
|
?input_cached_image_tokens: Integer,
|
|
@@ -328,6 +359,17 @@ module OpenAI
|
|
|
328
359
|
?service_tier: String?,
|
|
329
360
|
?user_id: String?
|
|
330
361
|
}
|
|
362
|
+
|
|
363
|
+
type api_source = :agents_api | :unlabeled
|
|
364
|
+
|
|
365
|
+
module APISource
|
|
366
|
+
extend OpenAI::Internal::Type::Enum
|
|
367
|
+
|
|
368
|
+
AGENTS_API: :agents_api
|
|
369
|
+
UNLABELED: :unlabeled
|
|
370
|
+
|
|
371
|
+
def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageCompletionsResult::api_source]
|
|
372
|
+
end
|
|
331
373
|
end
|
|
332
374
|
|
|
333
375
|
type organization_usage_embeddings_result =
|
|
@@ -856,6 +898,7 @@ module OpenAI
|
|
|
856
898
|
num_requests: Integer,
|
|
857
899
|
?object: :"organization.usage.web_searches.result",
|
|
858
900
|
?api_key_id: String?,
|
|
901
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult::api_source?,
|
|
859
902
|
?context_level: String?,
|
|
860
903
|
?model: String?,
|
|
861
904
|
?project_id: String?,
|
|
@@ -875,6 +918,12 @@ module OpenAI
|
|
|
875
918
|
# usage result.
|
|
876
919
|
attr_accessor api_key_id: String?
|
|
877
920
|
|
|
921
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
922
|
+
# activity and `unlabeled` includes all records without published source
|
|
923
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
924
|
+
# direct API usage. Without source grouping, this field is null.
|
|
925
|
+
attr_accessor api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult::api_source?
|
|
926
|
+
|
|
878
927
|
# When `group_by=context_level`, this field provides the search context size of
|
|
879
928
|
# the grouped usage result.
|
|
880
929
|
attr_accessor context_level: String?
|
|
@@ -898,6 +947,11 @@ module OpenAI
|
|
|
898
947
|
# @param api_key_id
|
|
899
948
|
# When `group_by=api_key_id`, this field provides the API key ID of the grouped
|
|
900
949
|
# usage result.
|
|
950
|
+
# @param api_source
|
|
951
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
952
|
+
# activity and `unlabeled` includes all records without published source
|
|
953
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
954
|
+
# direct API usage. Without source grouping, this field is null.
|
|
901
955
|
# @param context_level
|
|
902
956
|
# When `group_by=context_level`, this field provides the search context size of
|
|
903
957
|
# the grouped usage result.
|
|
@@ -914,6 +968,7 @@ module OpenAI
|
|
|
914
968
|
num_model_requests: Integer,
|
|
915
969
|
num_requests: Integer,
|
|
916
970
|
?api_key_id: String?,
|
|
971
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult::api_source?,
|
|
917
972
|
?context_level: String?,
|
|
918
973
|
?model: String?,
|
|
919
974
|
?project_id: String?,
|
|
@@ -926,11 +981,23 @@ module OpenAI
|
|
|
926
981
|
num_requests: Integer,
|
|
927
982
|
?object: :"organization.usage.web_searches.result",
|
|
928
983
|
?api_key_id: String?,
|
|
984
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult::api_source?,
|
|
929
985
|
?context_level: String?,
|
|
930
986
|
?model: String?,
|
|
931
987
|
?project_id: String?,
|
|
932
988
|
?user_id: String?
|
|
933
989
|
}
|
|
990
|
+
|
|
991
|
+
type api_source = :agents_api | :unlabeled
|
|
992
|
+
|
|
993
|
+
module APISource
|
|
994
|
+
extend OpenAI::Internal::Type::Enum
|
|
995
|
+
|
|
996
|
+
AGENTS_API: :agents_api
|
|
997
|
+
UNLABELED: :unlabeled
|
|
998
|
+
|
|
999
|
+
def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationUsageWebSearchesResult::api_source]
|
|
1000
|
+
end
|
|
934
1001
|
end
|
|
935
1002
|
|
|
936
1003
|
type organization_costs_result =
|
|
@@ -938,10 +1005,12 @@ module OpenAI
|
|
|
938
1005
|
?object: :"organization.costs.result",
|
|
939
1006
|
?amount: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::Amount,
|
|
940
1007
|
?api_key_id: String?,
|
|
1008
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::api_source?,
|
|
941
1009
|
?line_item: String?,
|
|
942
1010
|
?project_id: String?,
|
|
943
1011
|
?quantity: Float?,
|
|
944
|
-
?quantity_unit: OpenAI::Models::Admin::Organization::cost_quantity_unit
|
|
1012
|
+
?quantity_unit: OpenAI::Models::Admin::Organization::cost_quantity_unit?,
|
|
1013
|
+
?user_id: String?
|
|
945
1014
|
}
|
|
946
1015
|
|
|
947
1016
|
class OrganizationCostsResult < OpenAI::Internal::Type::BaseModel
|
|
@@ -959,6 +1028,12 @@ module OpenAI
|
|
|
959
1028
|
# costs result.
|
|
960
1029
|
attr_accessor api_key_id: String?
|
|
961
1030
|
|
|
1031
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1032
|
+
# activity and `unlabeled` includes all records without published source
|
|
1033
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1034
|
+
# direct API usage. Without source grouping, this field is null.
|
|
1035
|
+
attr_accessor api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::api_source?
|
|
1036
|
+
|
|
962
1037
|
# When `group_by=line_item`, this field provides the line item of the grouped
|
|
963
1038
|
# costs result.
|
|
964
1039
|
attr_accessor line_item: String?
|
|
@@ -975,11 +1050,20 @@ module OpenAI
|
|
|
975
1050
|
# result, this field is `null`.
|
|
976
1051
|
attr_accessor quantity_unit: OpenAI::Models::Admin::Organization::cost_quantity_unit?
|
|
977
1052
|
|
|
1053
|
+
# When `group_by=user_id`, this field provides the user ID of the grouped costs
|
|
1054
|
+
# result.
|
|
1055
|
+
attr_accessor user_id: String?
|
|
1056
|
+
|
|
978
1057
|
# @param amount
|
|
979
1058
|
# The monetary value in its associated currency.
|
|
980
1059
|
# @param api_key_id
|
|
981
1060
|
# When `group_by=api_key_id`, this field provides the API Key ID of the grouped
|
|
982
1061
|
# costs result.
|
|
1062
|
+
# @param api_source
|
|
1063
|
+
# When grouped by `api_source`, `agents_api` identifies attributed Agents API
|
|
1064
|
+
# activity and `unlabeled` includes all records without published source
|
|
1065
|
+
# attribution, including historical and unknown origins. Unlabeled does not imply
|
|
1066
|
+
# direct API usage. Without source grouping, this field is null.
|
|
983
1067
|
# @param line_item
|
|
984
1068
|
# When `group_by=line_item`, this field provides the line item of the grouped
|
|
985
1069
|
# costs result.
|
|
@@ -992,13 +1076,18 @@ module OpenAI
|
|
|
992
1076
|
# @param quantity_unit
|
|
993
1077
|
# The unit of the `quantity` value. If no single supported unit applies to the
|
|
994
1078
|
# result, this field is `null`.
|
|
1079
|
+
# @param user_id
|
|
1080
|
+
# When `group_by=user_id`, this field provides the user ID of the grouped costs
|
|
1081
|
+
# result.
|
|
995
1082
|
def initialize: (
|
|
996
1083
|
?amount: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::Amount,
|
|
997
1084
|
?api_key_id: String?,
|
|
1085
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::api_source?,
|
|
998
1086
|
?line_item: String?,
|
|
999
1087
|
?project_id: String?,
|
|
1000
1088
|
?quantity: Float?,
|
|
1001
1089
|
?quantity_unit: OpenAI::Models::Admin::Organization::cost_quantity_unit?,
|
|
1090
|
+
?user_id: String?,
|
|
1002
1091
|
?object: :"organization.costs.result"
|
|
1003
1092
|
) -> void
|
|
1004
1093
|
|
|
@@ -1006,10 +1095,12 @@ module OpenAI
|
|
|
1006
1095
|
?object: :"organization.costs.result",
|
|
1007
1096
|
?amount: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::Amount,
|
|
1008
1097
|
?api_key_id: String?,
|
|
1098
|
+
?api_source: OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::api_source?,
|
|
1009
1099
|
?line_item: String?,
|
|
1010
1100
|
?project_id: String?,
|
|
1011
1101
|
?quantity: Float?,
|
|
1012
|
-
?quantity_unit: OpenAI::Models::Admin::Organization::cost_quantity_unit
|
|
1102
|
+
?quantity_unit: OpenAI::Models::Admin::Organization::cost_quantity_unit?,
|
|
1103
|
+
?user_id: String?
|
|
1013
1104
|
}
|
|
1014
1105
|
|
|
1015
1106
|
type amount = { ?currency: String, ?value: Float }
|
|
@@ -1035,6 +1126,17 @@ module OpenAI
|
|
|
1035
1126
|
|
|
1036
1127
|
def to_hash: -> { ?currency: String, ?value: Float }
|
|
1037
1128
|
end
|
|
1129
|
+
|
|
1130
|
+
type api_source = :agents_api | :unlabeled
|
|
1131
|
+
|
|
1132
|
+
module APISource
|
|
1133
|
+
extend OpenAI::Internal::Type::Enum
|
|
1134
|
+
|
|
1135
|
+
AGENTS_API: :agents_api
|
|
1136
|
+
UNLABELED: :unlabeled
|
|
1137
|
+
|
|
1138
|
+
def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::Result::OrganizationCostsResult::api_source]
|
|
1139
|
+
end
|
|
1038
1140
|
end
|
|
1039
1141
|
|
|
1040
1142
|
def self?.variants: -> ::Array[OpenAI::Models::Admin::Organization::UsageWebSearchCallsResponse::Data::result]
|
|
@@ -31,6 +31,8 @@ module OpenAI
|
|
|
31
31
|
# object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
|
|
32
32
|
# voices are available in the
|
|
33
33
|
# [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
|
|
34
|
+
# Custom voices must be created from audio samples. Voices created from text
|
|
35
|
+
# prompts are supported only in Live.
|
|
34
36
|
attr_accessor voice: OpenAI::Models::Audio::SpeechCreateParams::voice
|
|
35
37
|
|
|
36
38
|
# Control the voice of your generated audio with additional instructions. Does not
|
|
@@ -82,6 +84,8 @@ module OpenAI
|
|
|
82
84
|
# object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
|
|
83
85
|
# voices are available in the
|
|
84
86
|
# [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
|
|
87
|
+
# Custom voices must be created from audio samples. Voices created from text
|
|
88
|
+
# prompts are supported only in Live.
|
|
85
89
|
# @param instructions
|
|
86
90
|
# Control the voice of your generated audio with additional instructions. Does not
|
|
87
91
|
# work with `tts-1` or `tts-1-hd`.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
module OpenAI
|
|
2
|
+
module Models
|
|
3
|
+
module Audio
|
|
4
|
+
type voice =
|
|
5
|
+
{
|
|
6
|
+
id: String,
|
|
7
|
+
created_at: Integer,
|
|
8
|
+
name: String,
|
|
9
|
+
?object: :"audio.voice",
|
|
10
|
+
type: OpenAI::Models::Audio::Voice::type_
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
class Voice < OpenAI::Internal::Type::BaseModel
|
|
14
|
+
# The voice identifier, which can be referenced in API endpoints.
|
|
15
|
+
attr_accessor id: String
|
|
16
|
+
|
|
17
|
+
# The Unix timestamp (in seconds) for when the voice was created.
|
|
18
|
+
attr_accessor created_at: Integer
|
|
19
|
+
|
|
20
|
+
# The name of the voice.
|
|
21
|
+
attr_accessor name: String
|
|
22
|
+
|
|
23
|
+
# The object type, which is always `audio.voice`.
|
|
24
|
+
attr_accessor object: :"audio.voice"
|
|
25
|
+
|
|
26
|
+
# How the voice was created. Voices created from text prompts are supported only
|
|
27
|
+
# in Live.
|
|
28
|
+
attr_accessor type: OpenAI::Models::Audio::Voice::type_
|
|
29
|
+
|
|
30
|
+
# @param id
|
|
31
|
+
# The voice identifier, which can be referenced in API endpoints.
|
|
32
|
+
# @param created_at
|
|
33
|
+
# The Unix timestamp (in seconds) for when the voice was created.
|
|
34
|
+
# @param name
|
|
35
|
+
# The name of the voice.
|
|
36
|
+
# @param type
|
|
37
|
+
# How the voice was created. Voices created from text prompts are supported only
|
|
38
|
+
# in Live.
|
|
39
|
+
# @param object
|
|
40
|
+
# The object type, which is always `audio.voice`.
|
|
41
|
+
def initialize: (
|
|
42
|
+
id: String,
|
|
43
|
+
created_at: Integer,
|
|
44
|
+
name: String,
|
|
45
|
+
type: OpenAI::Models::Audio::Voice::type_,
|
|
46
|
+
?object: :"audio.voice"
|
|
47
|
+
) -> void
|
|
48
|
+
|
|
49
|
+
def to_hash: -> {
|
|
50
|
+
id: String,
|
|
51
|
+
created_at: Integer,
|
|
52
|
+
name: String,
|
|
53
|
+
?object: :"audio.voice",
|
|
54
|
+
type: OpenAI::Models::Audio::Voice::type_
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
type type_ = :audio_sample | :prompt
|
|
58
|
+
|
|
59
|
+
module Type
|
|
60
|
+
extend OpenAI::Internal::Type::Enum
|
|
61
|
+
|
|
62
|
+
AUDIO_SAMPLE: :audio_sample
|
|
63
|
+
PROMPT: :prompt
|
|
64
|
+
|
|
65
|
+
def self?.values: -> ::Array[OpenAI::Models::Audio::Voice::type_]
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
end
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
module OpenAI
|
|
2
|
+
module Models
|
|
3
|
+
module Audio
|
|
4
|
+
type voice_create_params =
|
|
5
|
+
{
|
|
6
|
+
body: OpenAI::Models::Audio::VoiceCreateParams::body,
|
|
7
|
+
?request_options: OpenAI::request_opts
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
class VoiceCreateParams < OpenAI::Internal::Type::BaseModel
|
|
11
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
12
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
13
|
+
|
|
14
|
+
# Creates a voice from a consent recording and an audio sample. Requires
|
|
15
|
+
# multipart/form-data.
|
|
16
|
+
attr_accessor body: OpenAI::Models::Audio::VoiceCreateParams::body
|
|
17
|
+
|
|
18
|
+
# @param body
|
|
19
|
+
# Creates a voice from a consent recording and an audio sample. Requires
|
|
20
|
+
# multipart/form-data.
|
|
21
|
+
def initialize: (
|
|
22
|
+
body: OpenAI::Models::Audio::VoiceCreateParams::body,
|
|
23
|
+
?request_options: OpenAI::request_opts
|
|
24
|
+
) -> void
|
|
25
|
+
|
|
26
|
+
def to_hash: -> {
|
|
27
|
+
body: OpenAI::Models::Audio::VoiceCreateParams::body,
|
|
28
|
+
?request_options: OpenAI::RequestOptions
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
type body =
|
|
32
|
+
OpenAI::Audio::VoiceCreateParams::Body::AudioSample
|
|
33
|
+
| OpenAI::Audio::VoiceCreateParams::Body::Prompt
|
|
34
|
+
|
|
35
|
+
module Body
|
|
36
|
+
extend OpenAI::Internal::Type::Union
|
|
37
|
+
|
|
38
|
+
type audio_sample =
|
|
39
|
+
{
|
|
40
|
+
audio_sample: OpenAI::Internal::file_input,
|
|
41
|
+
consent: String,
|
|
42
|
+
name: String,
|
|
43
|
+
?type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
class AudioSample < OpenAI::Internal::Type::BaseModel
|
|
47
|
+
# The sample audio recording file. Maximum size is 10 MiB.
|
|
48
|
+
#
|
|
49
|
+
# Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
|
|
50
|
+
# `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
|
|
51
|
+
#
|
|
52
|
+
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
53
|
+
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
54
|
+
# content type.
|
|
55
|
+
attr_accessor audio_sample: OpenAI::Internal::file_input
|
|
56
|
+
|
|
57
|
+
# The consent recording ID (for example, `cons_1234`).
|
|
58
|
+
attr_accessor consent: String
|
|
59
|
+
|
|
60
|
+
# The name of the new voice.
|
|
61
|
+
attr_accessor name: String
|
|
62
|
+
|
|
63
|
+
# The voice creation method. Defaults to `audio_sample` when omitted.
|
|
64
|
+
attr_reader type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_?
|
|
65
|
+
|
|
66
|
+
# The voice creation method. Defaults to `audio_sample` when omitted.
|
|
67
|
+
def type=: (
|
|
68
|
+
OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
|
|
69
|
+
) -> OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
|
|
70
|
+
|
|
71
|
+
# @param audio_sample
|
|
72
|
+
# The sample audio recording file. Maximum size is 10 MiB.
|
|
73
|
+
#
|
|
74
|
+
# Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
|
|
75
|
+
# `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
|
|
76
|
+
#
|
|
77
|
+
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
78
|
+
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
79
|
+
# content type.
|
|
80
|
+
# @param consent
|
|
81
|
+
# The consent recording ID (for example, `cons_1234`).
|
|
82
|
+
# @param name
|
|
83
|
+
# The name of the new voice.
|
|
84
|
+
# @param type
|
|
85
|
+
# The voice creation method. Defaults to `audio_sample` when omitted.
|
|
86
|
+
def initialize: (
|
|
87
|
+
audio_sample: OpenAI::Internal::file_input,
|
|
88
|
+
consent: String,
|
|
89
|
+
name: String,
|
|
90
|
+
?type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
|
|
91
|
+
) -> void
|
|
92
|
+
|
|
93
|
+
def to_hash: -> {
|
|
94
|
+
audio_sample: OpenAI::Internal::file_input,
|
|
95
|
+
consent: String,
|
|
96
|
+
name: String,
|
|
97
|
+
?type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
type type_ = :audio_sample
|
|
101
|
+
|
|
102
|
+
module Type
|
|
103
|
+
extend OpenAI::Internal::Type::Enum
|
|
104
|
+
|
|
105
|
+
AUDIO_SAMPLE: :audio_sample
|
|
106
|
+
|
|
107
|
+
def self?.values: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_]
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
type prompt =
|
|
112
|
+
{
|
|
113
|
+
name: String,
|
|
114
|
+
prompt: String,
|
|
115
|
+
type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_,
|
|
116
|
+
?model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model,
|
|
117
|
+
?script_hint: String
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
class Prompt < OpenAI::Internal::Type::BaseModel
|
|
121
|
+
# The name of the new voice.
|
|
122
|
+
attr_accessor name: String
|
|
123
|
+
|
|
124
|
+
# A description of the desired voice. Must not contain only whitespace.
|
|
125
|
+
attr_accessor prompt: String
|
|
126
|
+
|
|
127
|
+
# Set to `prompt` to create a voice from a text description.
|
|
128
|
+
attr_accessor type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_
|
|
129
|
+
|
|
130
|
+
# The voice creation model to use. Defaults to `auto`.
|
|
131
|
+
attr_reader model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model?
|
|
132
|
+
|
|
133
|
+
# The voice creation model to use. Defaults to `auto`.
|
|
134
|
+
def model=: (
|
|
135
|
+
OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model
|
|
136
|
+
) -> OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model
|
|
137
|
+
|
|
138
|
+
# Optional text for the voice to speak during creation. If omitted, a script is
|
|
139
|
+
# generated from the prompt. Must not be blank after trimming whitespace; scripts
|
|
140
|
+
# that are too short are rejected.
|
|
141
|
+
attr_reader script_hint: String?
|
|
142
|
+
|
|
143
|
+
# Optional text for the voice to speak during creation. If omitted, a script is
|
|
144
|
+
# generated from the prompt. Must not be blank after trimming whitespace; scripts
|
|
145
|
+
# that are too short are rejected.
|
|
146
|
+
def script_hint=: (String) -> String
|
|
147
|
+
|
|
148
|
+
# @param name
|
|
149
|
+
# The name of the new voice.
|
|
150
|
+
# @param prompt
|
|
151
|
+
# A description of the desired voice. Must not contain only whitespace.
|
|
152
|
+
# @param type
|
|
153
|
+
# Set to `prompt` to create a voice from a text description.
|
|
154
|
+
# @param model
|
|
155
|
+
# The voice creation model to use. Defaults to `auto`.
|
|
156
|
+
# @param script_hint
|
|
157
|
+
# Optional text for the voice to speak during creation. If omitted, a script is
|
|
158
|
+
# generated from the prompt. Must not be blank after trimming whitespace; scripts
|
|
159
|
+
# that are too short are rejected.
|
|
160
|
+
def initialize: (
|
|
161
|
+
name: String,
|
|
162
|
+
prompt: String,
|
|
163
|
+
type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_,
|
|
164
|
+
?model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model,
|
|
165
|
+
?script_hint: String
|
|
166
|
+
) -> void
|
|
167
|
+
|
|
168
|
+
def to_hash: -> {
|
|
169
|
+
name: String,
|
|
170
|
+
prompt: String,
|
|
171
|
+
type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_,
|
|
172
|
+
?model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model,
|
|
173
|
+
?script_hint: String
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
type type_ = :prompt
|
|
177
|
+
|
|
178
|
+
module Type
|
|
179
|
+
extend OpenAI::Internal::Type::Enum
|
|
180
|
+
|
|
181
|
+
PROMPT: :prompt
|
|
182
|
+
|
|
183
|
+
def self?.values: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_]
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
type model = String | :auto | :"2026-10-01"
|
|
187
|
+
|
|
188
|
+
module Model
|
|
189
|
+
extend OpenAI::Internal::Type::Union
|
|
190
|
+
|
|
191
|
+
def self?.variants: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model]
|
|
192
|
+
|
|
193
|
+
AUTO: :auto
|
|
194
|
+
MODEL_2026_10_01: :"2026-10-01"
|
|
195
|
+
end
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
def self?.variants: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::body]
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
end
|
|
202
|
+
end
|
|
203
|
+
end
|
|
@@ -98,8 +98,7 @@ module OpenAI
|
|
|
98
98
|
?request_options: OpenAI::RequestOptions
|
|
99
99
|
}
|
|
100
100
|
|
|
101
|
-
type service_tier =
|
|
102
|
-
:auto | :default | :flex | :priority | :fast | :ultrafast
|
|
101
|
+
type service_tier = :auto | :default | :flex | :priority | :fast
|
|
103
102
|
|
|
104
103
|
module ServiceTier
|
|
105
104
|
extend OpenAI::Internal::Type::Enum
|
|
@@ -119,9 +118,6 @@ module OpenAI
|
|
|
119
118
|
# Uses the fast service tier.
|
|
120
119
|
FAST: :fast
|
|
121
120
|
|
|
122
|
-
# Uses the ultrafast service tier.
|
|
123
|
-
ULTRAFAST: :ultrafast
|
|
124
|
-
|
|
125
121
|
def self?.values: -> ::Array[OpenAI::Models::Beta::AgentCreateParams::service_tier]
|
|
126
122
|
end
|
|
127
123
|
end
|
|
@@ -106,8 +106,7 @@ module OpenAI
|
|
|
106
106
|
?request_options: OpenAI::RequestOptions
|
|
107
107
|
}
|
|
108
108
|
|
|
109
|
-
type service_tier =
|
|
110
|
-
:auto | :default | :flex | :priority | :fast | :ultrafast
|
|
109
|
+
type service_tier = :auto | :default | :flex | :priority | :fast
|
|
111
110
|
|
|
112
111
|
module ServiceTier
|
|
113
112
|
extend OpenAI::Internal::Type::Enum
|
|
@@ -127,9 +126,6 @@ module OpenAI
|
|
|
127
126
|
# Uses the fast service tier.
|
|
128
127
|
FAST: :fast
|
|
129
128
|
|
|
130
|
-
# Uses the ultrafast service tier.
|
|
131
|
-
ULTRAFAST: :ultrafast
|
|
132
|
-
|
|
133
129
|
def self?.values: -> ::Array[OpenAI::Models::Beta::AgentUpdateParams::service_tier]
|
|
134
130
|
end
|
|
135
131
|
end
|
|
@@ -39,8 +39,8 @@ module OpenAI
|
|
|
39
39
|
# An optional human-readable display name for the template.
|
|
40
40
|
attr_accessor name: String?
|
|
41
41
|
|
|
42
|
-
# Network access policy for the environment.
|
|
43
|
-
#
|
|
42
|
+
# Network access policy for the environment. If omitted, the API version
|
|
43
|
+
# determines whether network access is enabled or disabled.
|
|
44
44
|
attr_accessor network: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network?
|
|
45
45
|
|
|
46
46
|
# Packages to install in the environment. Defaults to empty package lists.
|
|
@@ -69,8 +69,8 @@ module OpenAI
|
|
|
69
69
|
# @param name
|
|
70
70
|
# An optional human-readable display name for the template.
|
|
71
71
|
# @param network
|
|
72
|
-
# Network access policy for the environment.
|
|
73
|
-
#
|
|
72
|
+
# Network access policy for the environment. If omitted, the API version
|
|
73
|
+
# determines whether network access is enabled or disabled.
|
|
74
74
|
# @param packages
|
|
75
75
|
# Packages to install in the environment. Defaults to empty package lists.
|
|
76
76
|
# @param plugins
|
|
@@ -41,8 +41,7 @@ module OpenAI
|
|
|
41
41
|
attr_accessor name: String?
|
|
42
42
|
|
|
43
43
|
# Network access available after setup completes. Omit to preserve the current
|
|
44
|
-
# policy, or pass `null` to reset to
|
|
45
|
-
# requests.
|
|
44
|
+
# policy, or pass `null` to reset to the default policy.
|
|
46
45
|
attr_accessor network: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Network?
|
|
47
46
|
|
|
48
47
|
# Packages installed before the runtime network policy applies.
|
|
@@ -69,8 +68,7 @@ module OpenAI
|
|
|
69
68
|
# A replacement human-readable display name, or `null` to clear the name.
|
|
70
69
|
# @param network
|
|
71
70
|
# Network access available after setup completes. Omit to preserve the current
|
|
72
|
-
# policy, or pass `null` to reset to
|
|
73
|
-
# requests.
|
|
71
|
+
# policy, or pass `null` to reset to the default policy.
|
|
74
72
|
# @param packages
|
|
75
73
|
# Packages installed before the runtime network policy applies.
|
|
76
74
|
# @param plugins
|
|
@@ -163,8 +163,7 @@ module OpenAI
|
|
|
163
163
|
?tools: ::Array[OpenAI::Models::Beta::agent_tool_param]?
|
|
164
164
|
}
|
|
165
165
|
|
|
166
|
-
type service_tier =
|
|
167
|
-
:auto | :default | :flex | :priority | :fast | :ultrafast
|
|
166
|
+
type service_tier = :auto | :default | :flex | :priority | :fast
|
|
168
167
|
|
|
169
168
|
module ServiceTier
|
|
170
169
|
extend OpenAI::Internal::Type::Enum
|
|
@@ -184,9 +183,6 @@ module OpenAI
|
|
|
184
183
|
# Uses the fast service tier.
|
|
185
184
|
FAST: :fast
|
|
186
185
|
|
|
187
|
-
# Uses the ultrafast service tier.
|
|
188
|
-
ULTRAFAST: :ultrafast
|
|
189
|
-
|
|
190
186
|
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::service_tier]
|
|
191
187
|
end
|
|
192
188
|
end
|