openai 0.98.0 → 0.99.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 +7 -0
- data/README.md +1 -1
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_completions_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_costs_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_images_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +16 -3
- 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/session_create_params.rb +0 -3
- data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
- data/lib/openai/models/beta/beta_response.rb +220 -0
- data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
- data/lib/openai/models/beta/beta_tool.rb +3 -9
- 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/chat/chat_completion_audio_param.rb +6 -3
- data/lib/openai/models/chat_model.rb +178 -0
- 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 +76 -87
- 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_response_create_audio_output.rb +9 -6
- data/lib/openai/models/responses/response_compact_params.rb +220 -0
- data/lib/openai/models/responses/tool.rb +3 -9
- data/lib/openai/models/responses_model.rb +42 -0
- 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/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/images.rb +71 -103
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +8 -0
- data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_completions_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_costs_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_images_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +19 -2
- 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/session_create_params.rbi +0 -3
- data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
- data/rbi/openai/models/beta/beta_tool.rbi +3 -9
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
- 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 +61 -82
- 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/responses/tool.rbi +3 -9
- 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/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/images.rbi +69 -103
- data/rbi/openai/resources/webhooks.rbi +5 -0
- data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_completions_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_costs_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_images_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_moderations_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +20 -3
- 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/session_create_params.rbs +1 -5
- data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
- data/sig/openai/models/beta/beta_tool.rbs +3 -9
- data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
- 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 +46 -60
- 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/tool.rbs +3 -9
- 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/webhooks.rbs +6 -1
- metadata +25 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7888217212b961954d41ed4bb25d807a08d7155598eac1c384819b35723ab529
|
|
4
|
+
data.tar.gz: ff4e8f985ffcd57f1aa276cead8dba172a1c686228afd15dd90f0dfa3f440078
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4d54994a5e2f72c57ffc898b6bf8ed1ba30745296900d4d6c0c41cde5d88c182f55d8295619140eed845e1741283b0d68704bf92fd4684c2b7a070b91d2c3ae8
|
|
7
|
+
data.tar.gz: c277185aabed1723fa217caa826ba9df358d40a3ab5018a8ed7a70ff7f13b9c1855543144a9ba8404c3ed95bbb4bdea095802a898878b8bfab6e49dd682939d7
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.99.0](https://github.com/openai/openai-ruby/compare/v0.98.0...v0.99.0) (2026-10-02)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** add custom voices and agent session webhook events ([#800](https://github.com/openai/openai-ruby/issues/800)) ([baaec48](https://github.com/openai/openai-ruby/commit/baaec487ca85117d6ee149cabdfe0cb8837d883c))
|
|
9
|
+
|
|
3
10
|
## [0.98.0](https://github.com/openai/openai-ruby/compare/v0.97.0...v0.98.0) (2026-10-01)
|
|
4
11
|
|
|
5
12
|
|
data/README.md
CHANGED
|
@@ -213,8 +213,16 @@ module OpenAI
|
|
|
213
213
|
# @return [Integer, nil]
|
|
214
214
|
optional :input_audio_tokens, Integer
|
|
215
215
|
|
|
216
|
+
# @!attribute input_cache_write_12h_tokens
|
|
217
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
218
|
+
# retention period.
|
|
219
|
+
#
|
|
220
|
+
# @return [Integer, nil]
|
|
221
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
222
|
+
|
|
216
223
|
# @!attribute input_cache_write_tokens
|
|
217
|
-
# The aggregated number of input tokens written to the cache
|
|
224
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
225
|
+
# retention period.
|
|
218
226
|
#
|
|
219
227
|
# @return [Integer, nil]
|
|
220
228
|
optional :input_cache_write_tokens, Integer
|
|
@@ -310,7 +318,7 @@ module OpenAI
|
|
|
310
318
|
# @return [String, nil]
|
|
311
319
|
optional :user_id, String, nil?: true
|
|
312
320
|
|
|
313
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
321
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
314
322
|
# The aggregated completions usage details of the specific time bucket.
|
|
315
323
|
#
|
|
316
324
|
# @param input_tokens [Integer]
|
|
@@ -337,8 +345,13 @@ module OpenAI
|
|
|
337
345
|
# @param input_audio_tokens [Integer]
|
|
338
346
|
# The aggregated number of uncached audio input tokens used.
|
|
339
347
|
#
|
|
348
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
349
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
350
|
+
# retention period.
|
|
351
|
+
#
|
|
340
352
|
# @param input_cache_write_tokens [Integer]
|
|
341
|
-
# The aggregated number of input tokens written to the cache
|
|
353
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
354
|
+
# retention period.
|
|
342
355
|
#
|
|
343
356
|
# @param input_cached_audio_tokens [Integer]
|
|
344
357
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -215,8 +215,16 @@ module OpenAI
|
|
|
215
215
|
# @return [Integer, nil]
|
|
216
216
|
optional :input_audio_tokens, Integer
|
|
217
217
|
|
|
218
|
+
# @!attribute input_cache_write_12h_tokens
|
|
219
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
220
|
+
# retention period.
|
|
221
|
+
#
|
|
222
|
+
# @return [Integer, nil]
|
|
223
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
224
|
+
|
|
218
225
|
# @!attribute input_cache_write_tokens
|
|
219
|
-
# The aggregated number of input tokens written to the cache
|
|
226
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
227
|
+
# retention period.
|
|
220
228
|
#
|
|
221
229
|
# @return [Integer, nil]
|
|
222
230
|
optional :input_cache_write_tokens, Integer
|
|
@@ -312,7 +320,7 @@ module OpenAI
|
|
|
312
320
|
# @return [String, nil]
|
|
313
321
|
optional :user_id, String, nil?: true
|
|
314
322
|
|
|
315
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
323
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
316
324
|
# The aggregated completions usage details of the specific time bucket.
|
|
317
325
|
#
|
|
318
326
|
# @param input_tokens [Integer]
|
|
@@ -339,8 +347,13 @@ module OpenAI
|
|
|
339
347
|
# @param input_audio_tokens [Integer]
|
|
340
348
|
# The aggregated number of uncached audio input tokens used.
|
|
341
349
|
#
|
|
350
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
351
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
352
|
+
# retention period.
|
|
353
|
+
#
|
|
342
354
|
# @param input_cache_write_tokens [Integer]
|
|
343
|
-
# The aggregated number of input tokens written to the cache
|
|
355
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
356
|
+
# retention period.
|
|
344
357
|
#
|
|
345
358
|
# @param input_cached_audio_tokens [Integer]
|
|
346
359
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -215,8 +215,16 @@ module OpenAI
|
|
|
215
215
|
# @return [Integer, nil]
|
|
216
216
|
optional :input_audio_tokens, Integer
|
|
217
217
|
|
|
218
|
+
# @!attribute input_cache_write_12h_tokens
|
|
219
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
220
|
+
# retention period.
|
|
221
|
+
#
|
|
222
|
+
# @return [Integer, nil]
|
|
223
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
224
|
+
|
|
218
225
|
# @!attribute input_cache_write_tokens
|
|
219
|
-
# The aggregated number of input tokens written to the cache
|
|
226
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
227
|
+
# retention period.
|
|
220
228
|
#
|
|
221
229
|
# @return [Integer, nil]
|
|
222
230
|
optional :input_cache_write_tokens, Integer
|
|
@@ -312,7 +320,7 @@ module OpenAI
|
|
|
312
320
|
# @return [String, nil]
|
|
313
321
|
optional :user_id, String, nil?: true
|
|
314
322
|
|
|
315
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
323
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
316
324
|
# The aggregated completions usage details of the specific time bucket.
|
|
317
325
|
#
|
|
318
326
|
# @param input_tokens [Integer]
|
|
@@ -339,8 +347,13 @@ module OpenAI
|
|
|
339
347
|
# @param input_audio_tokens [Integer]
|
|
340
348
|
# The aggregated number of uncached audio input tokens used.
|
|
341
349
|
#
|
|
350
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
351
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
352
|
+
# retention period.
|
|
353
|
+
#
|
|
342
354
|
# @param input_cache_write_tokens [Integer]
|
|
343
|
-
# The aggregated number of input tokens written to the cache
|
|
355
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
356
|
+
# retention period.
|
|
344
357
|
#
|
|
345
358
|
# @param input_cached_audio_tokens [Integer]
|
|
346
359
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -211,8 +211,16 @@ module OpenAI
|
|
|
211
211
|
# @return [Integer, nil]
|
|
212
212
|
optional :input_audio_tokens, Integer
|
|
213
213
|
|
|
214
|
+
# @!attribute input_cache_write_12h_tokens
|
|
215
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
216
|
+
# retention period.
|
|
217
|
+
#
|
|
218
|
+
# @return [Integer, nil]
|
|
219
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
220
|
+
|
|
214
221
|
# @!attribute input_cache_write_tokens
|
|
215
|
-
# The aggregated number of input tokens written to the cache
|
|
222
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
223
|
+
# retention period.
|
|
216
224
|
#
|
|
217
225
|
# @return [Integer, nil]
|
|
218
226
|
optional :input_cache_write_tokens, Integer
|
|
@@ -308,7 +316,7 @@ module OpenAI
|
|
|
308
316
|
# @return [String, nil]
|
|
309
317
|
optional :user_id, String, nil?: true
|
|
310
318
|
|
|
311
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
319
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
312
320
|
# The aggregated completions usage details of the specific time bucket.
|
|
313
321
|
#
|
|
314
322
|
# @param input_tokens [Integer]
|
|
@@ -335,8 +343,13 @@ module OpenAI
|
|
|
335
343
|
# @param input_audio_tokens [Integer]
|
|
336
344
|
# The aggregated number of uncached audio input tokens used.
|
|
337
345
|
#
|
|
346
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
347
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
348
|
+
# retention period.
|
|
349
|
+
#
|
|
338
350
|
# @param input_cache_write_tokens [Integer]
|
|
339
|
-
# The aggregated number of input tokens written to the cache
|
|
351
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
352
|
+
# retention period.
|
|
340
353
|
#
|
|
341
354
|
# @param input_cached_audio_tokens [Integer]
|
|
342
355
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -209,8 +209,16 @@ module OpenAI
|
|
|
209
209
|
# @return [Integer, nil]
|
|
210
210
|
optional :input_audio_tokens, Integer
|
|
211
211
|
|
|
212
|
+
# @!attribute input_cache_write_12h_tokens
|
|
213
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
214
|
+
# retention period.
|
|
215
|
+
#
|
|
216
|
+
# @return [Integer, nil]
|
|
217
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
218
|
+
|
|
212
219
|
# @!attribute input_cache_write_tokens
|
|
213
|
-
# The aggregated number of input tokens written to the cache
|
|
220
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
221
|
+
# retention period.
|
|
214
222
|
#
|
|
215
223
|
# @return [Integer, nil]
|
|
216
224
|
optional :input_cache_write_tokens, Integer
|
|
@@ -306,7 +314,7 @@ module OpenAI
|
|
|
306
314
|
# @return [String, nil]
|
|
307
315
|
optional :user_id, String, nil?: true
|
|
308
316
|
|
|
309
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
317
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
310
318
|
# The aggregated completions usage details of the specific time bucket.
|
|
311
319
|
#
|
|
312
320
|
# @param input_tokens [Integer]
|
|
@@ -333,8 +341,13 @@ module OpenAI
|
|
|
333
341
|
# @param input_audio_tokens [Integer]
|
|
334
342
|
# The aggregated number of uncached audio input tokens used.
|
|
335
343
|
#
|
|
344
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
345
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
346
|
+
# retention period.
|
|
347
|
+
#
|
|
336
348
|
# @param input_cache_write_tokens [Integer]
|
|
337
|
-
# The aggregated number of input tokens written to the cache
|
|
349
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
350
|
+
# retention period.
|
|
338
351
|
#
|
|
339
352
|
# @param input_cached_audio_tokens [Integer]
|
|
340
353
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -211,8 +211,16 @@ module OpenAI
|
|
|
211
211
|
# @return [Integer, nil]
|
|
212
212
|
optional :input_audio_tokens, Integer
|
|
213
213
|
|
|
214
|
+
# @!attribute input_cache_write_12h_tokens
|
|
215
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
216
|
+
# retention period.
|
|
217
|
+
#
|
|
218
|
+
# @return [Integer, nil]
|
|
219
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
220
|
+
|
|
214
221
|
# @!attribute input_cache_write_tokens
|
|
215
|
-
# The aggregated number of input tokens written to the cache
|
|
222
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
223
|
+
# retention period.
|
|
216
224
|
#
|
|
217
225
|
# @return [Integer, nil]
|
|
218
226
|
optional :input_cache_write_tokens, Integer
|
|
@@ -308,7 +316,7 @@ module OpenAI
|
|
|
308
316
|
# @return [String, nil]
|
|
309
317
|
optional :user_id, String, nil?: true
|
|
310
318
|
|
|
311
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
319
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
312
320
|
# The aggregated completions usage details of the specific time bucket.
|
|
313
321
|
#
|
|
314
322
|
# @param input_tokens [Integer]
|
|
@@ -335,8 +343,13 @@ module OpenAI
|
|
|
335
343
|
# @param input_audio_tokens [Integer]
|
|
336
344
|
# The aggregated number of uncached audio input tokens used.
|
|
337
345
|
#
|
|
346
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
347
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
348
|
+
# retention period.
|
|
349
|
+
#
|
|
338
350
|
# @param input_cache_write_tokens [Integer]
|
|
339
|
-
# The aggregated number of input tokens written to the cache
|
|
351
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
352
|
+
# retention period.
|
|
340
353
|
#
|
|
341
354
|
# @param input_cached_audio_tokens [Integer]
|
|
342
355
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -213,8 +213,16 @@ module OpenAI
|
|
|
213
213
|
# @return [Integer, nil]
|
|
214
214
|
optional :input_audio_tokens, Integer
|
|
215
215
|
|
|
216
|
+
# @!attribute input_cache_write_12h_tokens
|
|
217
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
218
|
+
# retention period.
|
|
219
|
+
#
|
|
220
|
+
# @return [Integer, nil]
|
|
221
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
222
|
+
|
|
216
223
|
# @!attribute input_cache_write_tokens
|
|
217
|
-
# The aggregated number of input tokens written to the cache
|
|
224
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
225
|
+
# retention period.
|
|
218
226
|
#
|
|
219
227
|
# @return [Integer, nil]
|
|
220
228
|
optional :input_cache_write_tokens, Integer
|
|
@@ -310,7 +318,7 @@ module OpenAI
|
|
|
310
318
|
# @return [String, nil]
|
|
311
319
|
optional :user_id, String, nil?: true
|
|
312
320
|
|
|
313
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
321
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
314
322
|
# The aggregated completions usage details of the specific time bucket.
|
|
315
323
|
#
|
|
316
324
|
# @param input_tokens [Integer]
|
|
@@ -337,8 +345,13 @@ module OpenAI
|
|
|
337
345
|
# @param input_audio_tokens [Integer]
|
|
338
346
|
# The aggregated number of uncached audio input tokens used.
|
|
339
347
|
#
|
|
348
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
349
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
350
|
+
# retention period.
|
|
351
|
+
#
|
|
340
352
|
# @param input_cache_write_tokens [Integer]
|
|
341
|
-
# The aggregated number of input tokens written to the cache
|
|
353
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
354
|
+
# retention period.
|
|
342
355
|
#
|
|
343
356
|
# @param input_cached_audio_tokens [Integer]
|
|
344
357
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -209,8 +209,16 @@ module OpenAI
|
|
|
209
209
|
# @return [Integer, nil]
|
|
210
210
|
optional :input_audio_tokens, Integer
|
|
211
211
|
|
|
212
|
+
# @!attribute input_cache_write_12h_tokens
|
|
213
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
214
|
+
# retention period.
|
|
215
|
+
#
|
|
216
|
+
# @return [Integer, nil]
|
|
217
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
218
|
+
|
|
212
219
|
# @!attribute input_cache_write_tokens
|
|
213
|
-
# The aggregated number of input tokens written to the cache
|
|
220
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
221
|
+
# retention period.
|
|
214
222
|
#
|
|
215
223
|
# @return [Integer, nil]
|
|
216
224
|
optional :input_cache_write_tokens, Integer
|
|
@@ -306,7 +314,7 @@ module OpenAI
|
|
|
306
314
|
# @return [String, nil]
|
|
307
315
|
optional :user_id, String, nil?: true
|
|
308
316
|
|
|
309
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
317
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
310
318
|
# The aggregated completions usage details of the specific time bucket.
|
|
311
319
|
#
|
|
312
320
|
# @param input_tokens [Integer]
|
|
@@ -333,8 +341,13 @@ module OpenAI
|
|
|
333
341
|
# @param input_audio_tokens [Integer]
|
|
334
342
|
# The aggregated number of uncached audio input tokens used.
|
|
335
343
|
#
|
|
344
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
345
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
346
|
+
# retention period.
|
|
347
|
+
#
|
|
336
348
|
# @param input_cache_write_tokens [Integer]
|
|
337
|
-
# The aggregated number of input tokens written to the cache
|
|
349
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
350
|
+
# retention period.
|
|
338
351
|
#
|
|
339
352
|
# @param input_cached_audio_tokens [Integer]
|
|
340
353
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -211,8 +211,16 @@ module OpenAI
|
|
|
211
211
|
# @return [Integer, nil]
|
|
212
212
|
optional :input_audio_tokens, Integer
|
|
213
213
|
|
|
214
|
+
# @!attribute input_cache_write_12h_tokens
|
|
215
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
216
|
+
# retention period.
|
|
217
|
+
#
|
|
218
|
+
# @return [Integer, nil]
|
|
219
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
220
|
+
|
|
214
221
|
# @!attribute input_cache_write_tokens
|
|
215
|
-
# The aggregated number of input tokens written to the cache
|
|
222
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
223
|
+
# retention period.
|
|
216
224
|
#
|
|
217
225
|
# @return [Integer, nil]
|
|
218
226
|
optional :input_cache_write_tokens, Integer
|
|
@@ -308,7 +316,7 @@ module OpenAI
|
|
|
308
316
|
# @return [String, nil]
|
|
309
317
|
optional :user_id, String, nil?: true
|
|
310
318
|
|
|
311
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
319
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
312
320
|
# The aggregated completions usage details of the specific time bucket.
|
|
313
321
|
#
|
|
314
322
|
# @param input_tokens [Integer]
|
|
@@ -335,8 +343,13 @@ module OpenAI
|
|
|
335
343
|
# @param input_audio_tokens [Integer]
|
|
336
344
|
# The aggregated number of uncached audio input tokens used.
|
|
337
345
|
#
|
|
346
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
347
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
348
|
+
# retention period.
|
|
349
|
+
#
|
|
338
350
|
# @param input_cache_write_tokens [Integer]
|
|
339
|
-
# The aggregated number of input tokens written to the cache
|
|
351
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
352
|
+
# retention period.
|
|
340
353
|
#
|
|
341
354
|
# @param input_cached_audio_tokens [Integer]
|
|
342
355
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -213,8 +213,16 @@ module OpenAI
|
|
|
213
213
|
# @return [Integer, nil]
|
|
214
214
|
optional :input_audio_tokens, Integer
|
|
215
215
|
|
|
216
|
+
# @!attribute input_cache_write_12h_tokens
|
|
217
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
218
|
+
# retention period.
|
|
219
|
+
#
|
|
220
|
+
# @return [Integer, nil]
|
|
221
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
222
|
+
|
|
216
223
|
# @!attribute input_cache_write_tokens
|
|
217
|
-
# The aggregated number of input tokens written to the cache
|
|
224
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
225
|
+
# retention period.
|
|
218
226
|
#
|
|
219
227
|
# @return [Integer, nil]
|
|
220
228
|
optional :input_cache_write_tokens, Integer
|
|
@@ -310,7 +318,7 @@ module OpenAI
|
|
|
310
318
|
# @return [String, nil]
|
|
311
319
|
optional :user_id, String, nil?: true
|
|
312
320
|
|
|
313
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
321
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
314
322
|
# The aggregated completions usage details of the specific time bucket.
|
|
315
323
|
#
|
|
316
324
|
# @param input_tokens [Integer]
|
|
@@ -337,8 +345,13 @@ module OpenAI
|
|
|
337
345
|
# @param input_audio_tokens [Integer]
|
|
338
346
|
# The aggregated number of uncached audio input tokens used.
|
|
339
347
|
#
|
|
348
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
349
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
350
|
+
# retention period.
|
|
351
|
+
#
|
|
340
352
|
# @param input_cache_write_tokens [Integer]
|
|
341
|
-
# The aggregated number of input tokens written to the cache
|
|
353
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
354
|
+
# retention period.
|
|
342
355
|
#
|
|
343
356
|
# @param input_cached_audio_tokens [Integer]
|
|
344
357
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -213,8 +213,16 @@ module OpenAI
|
|
|
213
213
|
# @return [Integer, nil]
|
|
214
214
|
optional :input_audio_tokens, Integer
|
|
215
215
|
|
|
216
|
+
# @!attribute input_cache_write_12h_tokens
|
|
217
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
218
|
+
# retention period.
|
|
219
|
+
#
|
|
220
|
+
# @return [Integer, nil]
|
|
221
|
+
optional :input_cache_write_12h_tokens, Integer
|
|
222
|
+
|
|
216
223
|
# @!attribute input_cache_write_tokens
|
|
217
|
-
# The aggregated number of input tokens written to the cache
|
|
224
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
225
|
+
# retention period.
|
|
218
226
|
#
|
|
219
227
|
# @return [Integer, nil]
|
|
220
228
|
optional :input_cache_write_tokens, Integer
|
|
@@ -310,7 +318,7 @@ module OpenAI
|
|
|
310
318
|
# @return [String, nil]
|
|
311
319
|
optional :user_id, String, nil?: true
|
|
312
320
|
|
|
313
|
-
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
321
|
+
# @!method initialize(input_tokens:, num_model_requests:, output_tokens:, api_key_id: nil, batch: nil, input_audio_tokens: nil, input_cache_write_12h_tokens: nil, input_cache_write_tokens: nil, input_cached_audio_tokens: nil, input_cached_image_tokens: nil, input_cached_text_tokens: nil, input_cached_tokens: nil, input_image_tokens: nil, input_text_tokens: nil, input_uncached_tokens: nil, model: nil, output_audio_tokens: nil, output_image_tokens: nil, output_text_tokens: nil, project_id: nil, service_tier: nil, user_id: nil, object: :"organization.usage.completions.result")
|
|
314
322
|
# The aggregated completions usage details of the specific time bucket.
|
|
315
323
|
#
|
|
316
324
|
# @param input_tokens [Integer]
|
|
@@ -337,8 +345,13 @@ module OpenAI
|
|
|
337
345
|
# @param input_audio_tokens [Integer]
|
|
338
346
|
# The aggregated number of uncached audio input tokens used.
|
|
339
347
|
#
|
|
348
|
+
# @param input_cache_write_12h_tokens [Integer]
|
|
349
|
+
# The aggregated number of input tokens written to the cache with a 12-hour
|
|
350
|
+
# retention period.
|
|
351
|
+
#
|
|
340
352
|
# @param input_cache_write_tokens [Integer]
|
|
341
|
-
# The aggregated number of input tokens written to the cache
|
|
353
|
+
# The aggregated number of input tokens written to the cache with a 30-minute
|
|
354
|
+
# retention period.
|
|
342
355
|
#
|
|
343
356
|
# @param input_cached_audio_tokens [Integer]
|
|
344
357
|
# The aggregated number of cached audio input tokens used.
|
|
@@ -14,21 +14,63 @@ module OpenAI
|
|
|
14
14
|
module ResponsesOnlyModel
|
|
15
15
|
extend OpenAI::Internal::Type::Enum
|
|
16
16
|
|
|
17
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
18
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
19
|
+
# replacements.
|
|
17
20
|
O1_PRO = :"o1-pro"
|
|
21
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
22
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
23
|
+
# replacements.
|
|
18
24
|
O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
|
|
25
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
26
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
27
|
+
# replacements.
|
|
19
28
|
O3_PRO = :"o3-pro"
|
|
29
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
30
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
31
|
+
# replacements.
|
|
20
32
|
O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
|
|
33
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
34
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
35
|
+
# replacements.
|
|
21
36
|
O3_DEEP_RESEARCH = :"o3-deep-research"
|
|
37
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
38
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
39
|
+
# replacements.
|
|
22
40
|
O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
|
|
41
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
42
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
43
|
+
# replacements.
|
|
23
44
|
O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
|
|
45
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
46
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
47
|
+
# replacements.
|
|
24
48
|
O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
|
|
49
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
50
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
51
|
+
# replacements.
|
|
25
52
|
COMPUTER_USE_PREVIEW = :"computer-use-preview"
|
|
53
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
54
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
55
|
+
# replacements.
|
|
26
56
|
COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
|
|
27
57
|
GPT_5_5_PRO = :"gpt-5.5-pro"
|
|
28
58
|
GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
|
|
59
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
60
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
61
|
+
# replacements.
|
|
29
62
|
GPT_5_CODEX = :"gpt-5-codex"
|
|
63
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
64
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
65
|
+
# replacements.
|
|
30
66
|
GPT_5_PRO = :"gpt-5-pro"
|
|
67
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
68
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
69
|
+
# replacements.
|
|
31
70
|
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
71
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
72
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
73
|
+
# replacements.
|
|
32
74
|
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
33
75
|
GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
|
|
34
76
|
GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
|
|
@@ -29,6 +29,8 @@ module OpenAI
|
|
|
29
29
|
# object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
|
|
30
30
|
# voices are available in the
|
|
31
31
|
# [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
|
|
32
|
+
# Custom voices must be created from audio samples. Voices created from text
|
|
33
|
+
# prompts are supported only in Live.
|
|
32
34
|
#
|
|
33
35
|
# @return [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID, OpenAI::Models::Audio::SpeechCreateParams::Voice]
|
|
34
36
|
required :voice, union: -> { OpenAI::Audio::SpeechCreateParams::Voice }
|
|
@@ -77,6 +79,8 @@ module OpenAI
|
|
|
77
79
|
# object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
|
|
78
80
|
# voices are available in the
|
|
79
81
|
# [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
|
|
82
|
+
# Custom voices must be created from audio samples. Voices created from text
|
|
83
|
+
# prompts are supported only in Live.
|
|
80
84
|
#
|
|
81
85
|
# @param instructions [String]
|
|
82
86
|
# Control the voice of your generated audio with additional instructions. Does not
|
|
@@ -117,6 +121,8 @@ module OpenAI
|
|
|
117
121
|
# object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
|
|
118
122
|
# voices are available in the
|
|
119
123
|
# [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
|
|
124
|
+
# Custom voices must be created from audio samples. Voices created from text
|
|
125
|
+
# prompts are supported only in Live.
|
|
120
126
|
module Voice
|
|
121
127
|
extend OpenAI::Internal::Type::Union
|
|
122
128
|
|