openai 0.117.0 → 0.119.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 +23 -0
- data/README.md +1 -1
- data/lib/openai/client.rb +1 -1
- data/lib/openai/helpers/data_residency.rb +4 -1
- data/lib/openai/models/admin/organization/projects/project_optional_service_tier.rb +24 -0
- data/lib/openai/models/admin/organization/projects/project_service_tier_settings.rb +88 -0
- data/lib/openai/models/admin/organization/projects/service_tier_setting_retrieve_params.rb +29 -0
- data/lib/openai/models/admin/organization/projects/service_tier_setting_update_params.rb +92 -0
- data/lib/openai/models/all_models.rb +1 -0
- data/lib/openai/models/beta/beta_compacted_response.rb +34 -1
- data/lib/openai/models/beta/beta_response.rb +35 -1
- data/lib/openai/models/beta/beta_response_input_item.rb +45 -1
- data/lib/openai/models/beta/beta_response_item.rb +45 -1
- data/lib/openai/models/beta/beta_response_output_item.rb +45 -1
- data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +186 -13
- data/lib/openai/models/beta/beta_response_usage.rb +33 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +58 -10
- data/lib/openai/models/beta/beta_tool.rb +164 -13
- data/lib/openai/models/beta/response_compact_params.rb +47 -4
- data/lib/openai/models/beta/response_create_params.rb +54 -10
- data/lib/openai/models/beta/session_turn_error.rb +3 -0
- data/lib/openai/models/chat/completion_create_params.rb +3 -3
- data/lib/openai/models/conversations/conversation_item.rb +45 -1
- data/lib/openai/models/image_edit_params.rb +72 -16
- data/lib/openai/models/image_generate_params.rb +160 -8
- data/lib/openai/models/image_model.rb +2 -0
- data/lib/openai/models/images_response.rb +55 -4
- data/lib/openai/models/realtime/realtime_audio_config_input.rb +14 -1
- data/lib/openai/models/realtime/realtime_session_create_response.rb +14 -1
- data/lib/openai/models/realtime/realtime_transcription_session_audio_input.rb +14 -1
- data/lib/openai/models/realtime/realtime_transcription_session_create_response.rb +14 -1
- data/lib/openai/models/realtime/realtime_translation_session.rb +14 -1
- data/lib/openai/models/realtime/realtime_translation_session_create_request.rb +14 -1
- data/lib/openai/models/realtime/realtime_translation_session_update_request.rb +14 -1
- data/lib/openai/models/responses/compacted_response.rb +37 -1
- data/lib/openai/models/responses/response.rb +35 -1
- data/lib/openai/models/responses/response_compact_params.rb +53 -4
- data/lib/openai/models/responses/response_create_params.rb +57 -10
- data/lib/openai/models/responses/response_input_item.rb +45 -1
- data/lib/openai/models/responses/response_item.rb +45 -1
- data/lib/openai/models/responses/response_output_item.rb +45 -1
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +186 -13
- data/lib/openai/models/responses/response_usage.rb +33 -1
- data/lib/openai/models/responses/responses_client_event.rb +58 -10
- data/lib/openai/models/responses/tool.rb +164 -13
- data/lib/openai/models/responses_model.rb +1 -0
- data/lib/openai/resources/admin/organization/projects/service_tier_settings.rb +77 -0
- data/lib/openai/resources/admin/organization/projects.rb +6 -0
- data/lib/openai/resources/admin/organization.rb +6 -6
- data/lib/openai/resources/beta/responses.rb +18 -9
- data/lib/openai/resources/chat/completions.rb +2 -2
- data/lib/openai/resources/images.rb +102 -18
- data/lib/openai/resources/responses.rb +15 -6
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +5 -0
- data/rbi/openai/models/admin/organization/projects/project_optional_service_tier.rbi +45 -0
- data/rbi/openai/models/admin/organization/projects/project_service_tier_settings.rbi +143 -0
- data/rbi/openai/models/admin/organization/projects/service_tier_setting_retrieve_params.rbi +63 -0
- data/rbi/openai/models/admin/organization/projects/service_tier_setting_update_params.rbi +183 -0
- data/rbi/openai/models/all_models.rbi +1 -0
- data/rbi/openai/models/beta/beta_compacted_response.rbi +67 -1
- data/rbi/openai/models/beta/beta_response.rbi +63 -0
- data/rbi/openai/models/beta/beta_response_input_item.rbi +82 -1
- data/rbi/openai/models/beta/beta_response_item.rbi +82 -1
- data/rbi/openai/models/beta/beta_response_output_item.rbi +82 -1
- data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +338 -13
- data/rbi/openai/models/beta/beta_response_usage.rbi +66 -3
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +118 -9
- data/rbi/openai/models/beta/beta_tool.rbi +245 -13
- data/rbi/openai/models/beta/response_compact_params.rbi +84 -3
- data/rbi/openai/models/beta/response_create_params.rbi +91 -9
- data/rbi/openai/models/beta/session_turn_error.rbi +3 -0
- data/rbi/openai/models/chat/completion_create_params.rbi +3 -3
- data/rbi/openai/models/conversations/conversation_item.rbi +84 -1
- data/rbi/openai/models/image_edit_params.rbi +76 -14
- data/rbi/openai/models/image_generate_params.rbi +218 -6
- data/rbi/openai/models/image_model.rbi +2 -0
- data/rbi/openai/models/images_response.rbi +90 -3
- data/rbi/openai/models/realtime/realtime_audio_config_input.rbi +17 -1
- data/rbi/openai/models/realtime/realtime_session_create_response.rbi +17 -1
- data/rbi/openai/models/realtime/realtime_transcription_session_audio_input.rbi +17 -1
- data/rbi/openai/models/realtime/realtime_transcription_session_create_response.rbi +17 -1
- data/rbi/openai/models/realtime/realtime_translation_session.rbi +19 -3
- data/rbi/openai/models/realtime/realtime_translation_session_create_request.rbi +19 -3
- data/rbi/openai/models/realtime/realtime_translation_session_update_request.rbi +19 -3
- data/rbi/openai/models/responses/compacted_response.rbi +67 -1
- data/rbi/openai/models/responses/response.rbi +63 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +91 -3
- data/rbi/openai/models/responses/response_create_params.rbi +97 -9
- data/rbi/openai/models/responses/response_input_item.rbi +82 -1
- data/rbi/openai/models/responses/response_item.rbi +82 -1
- data/rbi/openai/models/responses/response_output_item.rbi +82 -1
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +340 -13
- data/rbi/openai/models/responses/response_usage.rbi +66 -3
- data/rbi/openai/models/responses/responses_client_event.rbi +118 -9
- data/rbi/openai/models/responses/tool.rbi +248 -13
- data/rbi/openai/models/responses_model.rbi +1 -0
- data/rbi/openai/resources/admin/organization/projects/service_tier_settings.rbi +67 -0
- data/rbi/openai/resources/admin/organization/projects.rbi +3 -0
- data/rbi/openai/resources/admin/organization.rbi +3 -3
- data/rbi/openai/resources/beta/responses.rbi +15 -6
- data/rbi/openai/resources/chat/completions.rbi +2 -2
- data/rbi/openai/resources/images.rbi +98 -14
- data/rbi/openai/resources/responses.rbi +14 -3
- data/sig/openai/models/admin/organization/projects/project_optional_service_tier.rbs +23 -0
- data/sig/openai/models/admin/organization/projects/project_service_tier_settings.rbs +72 -0
- data/sig/openai/models/admin/organization/projects/service_tier_setting_retrieve_params.rbs +32 -0
- data/sig/openai/models/admin/organization/projects/service_tier_setting_update_params.rbs +91 -0
- data/sig/openai/models/all_models.rbs +2 -0
- data/sig/openai/models/beta/beta_compacted_response.rbs +42 -2
- data/sig/openai/models/beta/beta_response.rbs +42 -1
- data/sig/openai/models/beta/beta_response_input_item.rbs +51 -3
- data/sig/openai/models/beta/beta_response_item.rbs +51 -3
- data/sig/openai/models/beta/beta_response_output_item.rbs +51 -3
- data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +188 -15
- data/sig/openai/models/beta/beta_response_usage.rbs +40 -3
- data/sig/openai/models/beta/beta_responses_client_event.rbs +67 -10
- data/sig/openai/models/beta/beta_tool.rbs +188 -15
- data/sig/openai/models/beta/response_compact_params.rbs +58 -2
- data/sig/openai/models/beta/response_create_params.rbs +67 -10
- data/sig/openai/models/beta/session_turn_error.rbs +4 -0
- data/sig/openai/models/chat/completion_create_params.rbs +3 -3
- data/sig/openai/models/conversations/conversation_item.rbs +51 -3
- data/sig/openai/models/image_edit_params.rbs +63 -12
- data/sig/openai/models/image_generate_params.rbs +150 -5
- data/sig/openai/models/image_model.rbs +4 -0
- data/sig/openai/models/images_response.rbs +59 -4
- data/sig/openai/models/realtime/realtime_audio_config_input.rbs +20 -1
- data/sig/openai/models/realtime/realtime_session_create_response.rbs +20 -1
- data/sig/openai/models/realtime/realtime_transcription_session_audio_input.rbs +20 -1
- data/sig/openai/models/realtime/realtime_transcription_session_create_response.rbs +20 -1
- data/sig/openai/models/realtime/realtime_translation_session.rbs +22 -3
- data/sig/openai/models/realtime/realtime_translation_session_create_request.rbs +22 -3
- data/sig/openai/models/realtime/realtime_translation_session_update_request.rbs +22 -3
- data/sig/openai/models/responses/compacted_response.rbs +42 -2
- data/sig/openai/models/responses/response.rbs +42 -1
- data/sig/openai/models/responses/response_compact_params.rbs +60 -2
- data/sig/openai/models/responses/response_create_params.rbs +67 -10
- data/sig/openai/models/responses/response_input_item.rbs +51 -3
- data/sig/openai/models/responses/response_item.rbs +51 -3
- data/sig/openai/models/responses/response_output_item.rbs +51 -3
- data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +188 -15
- data/sig/openai/models/responses/response_usage.rbs +40 -3
- data/sig/openai/models/responses/responses_client_event.rbs +67 -10
- data/sig/openai/models/responses/tool.rbs +188 -15
- data/sig/openai/models/responses_model.rbs +2 -0
- data/sig/openai/resources/admin/organization/projects/service_tier_settings.rbs +25 -0
- data/sig/openai/resources/admin/organization/projects.rbs +2 -0
- data/sig/openai/resources/admin/organization.rbs +2 -2
- data/sig/openai/resources/beta/responses.rbs +3 -0
- data/sig/openai/resources/images.rbs +14 -0
- data/sig/openai/resources/responses.rbs +4 -0
- metadata +16 -1
|
@@ -4,6 +4,7 @@ module OpenAI
|
|
|
4
4
|
type response_compact_params =
|
|
5
5
|
{
|
|
6
6
|
model: OpenAI::Models::Responses::ResponseCompactParams::model?,
|
|
7
|
+
?image: OpenAI::Responses::ResponseCompactParams::Image,
|
|
7
8
|
?input: OpenAI::Models::Responses::ResponseCompactParams::input?,
|
|
8
9
|
?instructions: String?,
|
|
9
10
|
?previous_response_id: String?,
|
|
@@ -25,6 +26,14 @@ module OpenAI
|
|
|
25
26
|
# compare available models.
|
|
26
27
|
attr_accessor model: OpenAI::Models::Responses::ResponseCompactParams::model?
|
|
27
28
|
|
|
29
|
+
# Request level image options.
|
|
30
|
+
attr_reader image: OpenAI::Responses::ResponseCompactParams::Image?
|
|
31
|
+
|
|
32
|
+
# Request level image options.
|
|
33
|
+
def image=: (
|
|
34
|
+
OpenAI::Responses::ResponseCompactParams::Image
|
|
35
|
+
) -> OpenAI::Responses::ResponseCompactParams::Image
|
|
36
|
+
|
|
28
37
|
# Text, image, or file inputs to the model, used to generate a response
|
|
29
38
|
attr_accessor input: OpenAI::Models::Responses::ResponseCompactParams::input?
|
|
30
39
|
|
|
@@ -49,7 +58,7 @@ module OpenAI
|
|
|
49
58
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
50
59
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
51
60
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
52
|
-
# `ttl` defaults to `30m
|
|
61
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
53
62
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
54
63
|
# for current details.
|
|
55
64
|
attr_accessor prompt_cache_options: OpenAI::Responses::ResponseCompactParams::PromptCacheOptions?
|
|
@@ -81,6 +90,8 @@ module OpenAI
|
|
|
81
90
|
# price points. Refer to the
|
|
82
91
|
# [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
83
92
|
# compare available models.
|
|
93
|
+
# @param image
|
|
94
|
+
# Request level image options.
|
|
84
95
|
# @param input
|
|
85
96
|
# Text, image, or file inputs to the model, used to generate a response
|
|
86
97
|
# @param instructions
|
|
@@ -102,7 +113,7 @@ module OpenAI
|
|
|
102
113
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
103
114
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
104
115
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
105
|
-
# `ttl` defaults to `30m
|
|
116
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
106
117
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
107
118
|
# for current details.
|
|
108
119
|
# @param prompt_cache_retention
|
|
@@ -126,6 +137,7 @@ module OpenAI
|
|
|
126
137
|
# the parameter.
|
|
127
138
|
def initialize: (
|
|
128
139
|
model: OpenAI::Models::Responses::ResponseCompactParams::model?,
|
|
140
|
+
?image: OpenAI::Responses::ResponseCompactParams::Image,
|
|
129
141
|
?input: OpenAI::Models::Responses::ResponseCompactParams::input?,
|
|
130
142
|
?instructions: String?,
|
|
131
143
|
?previous_response_id: String?,
|
|
@@ -138,6 +150,7 @@ module OpenAI
|
|
|
138
150
|
|
|
139
151
|
def to_hash: -> {
|
|
140
152
|
model: OpenAI::Models::Responses::ResponseCompactParams::model?,
|
|
153
|
+
?image: OpenAI::Responses::ResponseCompactParams::Image,
|
|
141
154
|
?input: OpenAI::Models::Responses::ResponseCompactParams::input?,
|
|
142
155
|
?instructions: String?,
|
|
143
156
|
?previous_response_id: String?,
|
|
@@ -259,6 +272,7 @@ module OpenAI
|
|
|
259
272
|
| :"gpt-daybreak-red-latest"
|
|
260
273
|
| :"gpt-5.6-cyber"
|
|
261
274
|
| :"gpt-rosalind-research"
|
|
275
|
+
| :"gpt-6-rosalind"
|
|
262
276
|
| String
|
|
263
277
|
|
|
264
278
|
module Model
|
|
@@ -376,6 +390,50 @@ module OpenAI
|
|
|
376
390
|
GPT_DAYBREAK_RED_LATEST: :"gpt-daybreak-red-latest"
|
|
377
391
|
GPT_5_6_CYBER: :"gpt-5.6-cyber"
|
|
378
392
|
GPT_ROSALIND_RESEARCH: :"gpt-rosalind-research"
|
|
393
|
+
GPT_6_ROSALIND: :"gpt-6-rosalind"
|
|
394
|
+
end
|
|
395
|
+
|
|
396
|
+
type image =
|
|
397
|
+
{
|
|
398
|
+
?context_compression: OpenAI::Models::Responses::ResponseCompactParams::Image::context_compression
|
|
399
|
+
}
|
|
400
|
+
|
|
401
|
+
class Image < OpenAI::Internal::Type::BaseModel
|
|
402
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
403
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
404
|
+
# support or `disabled` to turn it off.
|
|
405
|
+
attr_reader context_compression: OpenAI::Models::Responses::ResponseCompactParams::Image::context_compression?
|
|
406
|
+
|
|
407
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
408
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
409
|
+
# support or `disabled` to turn it off.
|
|
410
|
+
def context_compression=: (
|
|
411
|
+
OpenAI::Models::Responses::ResponseCompactParams::Image::context_compression
|
|
412
|
+
) -> OpenAI::Models::Responses::ResponseCompactParams::Image::context_compression
|
|
413
|
+
|
|
414
|
+
# @param context_compression
|
|
415
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
416
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
417
|
+
# support or `disabled` to turn it off.
|
|
418
|
+
def initialize: (
|
|
419
|
+
?context_compression: OpenAI::Models::Responses::ResponseCompactParams::Image::context_compression
|
|
420
|
+
) -> void
|
|
421
|
+
|
|
422
|
+
def to_hash: -> {
|
|
423
|
+
?context_compression: OpenAI::Models::Responses::ResponseCompactParams::Image::context_compression
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
type context_compression = :auto | :enabled | :disabled
|
|
427
|
+
|
|
428
|
+
module ContextCompression
|
|
429
|
+
extend OpenAI::Internal::Type::Enum
|
|
430
|
+
|
|
431
|
+
AUTO: :auto
|
|
432
|
+
ENABLED: :enabled
|
|
433
|
+
DISABLED: :disabled
|
|
434
|
+
|
|
435
|
+
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCompactParams::Image::context_compression]
|
|
436
|
+
end
|
|
379
437
|
end
|
|
380
438
|
|
|
381
439
|
type input =
|
|
@@ -7,6 +7,7 @@ module OpenAI
|
|
|
7
7
|
?background: bool?,
|
|
8
8
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
9
9
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
10
|
+
?image: OpenAI::Responses::ResponseCreateParams::Image,
|
|
10
11
|
?include: ::Array[OpenAI::Models::Responses::response_includable]?,
|
|
11
12
|
?input: OpenAI::Models::Responses::ResponseCreateParams::input,
|
|
12
13
|
?instructions: String?,
|
|
@@ -62,6 +63,14 @@ module OpenAI
|
|
|
62
63
|
# response completes.
|
|
63
64
|
attr_accessor conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?
|
|
64
65
|
|
|
66
|
+
# Request level image options.
|
|
67
|
+
attr_reader image: OpenAI::Responses::ResponseCreateParams::Image?
|
|
68
|
+
|
|
69
|
+
# Request level image options.
|
|
70
|
+
def image=: (
|
|
71
|
+
OpenAI::Responses::ResponseCreateParams::Image
|
|
72
|
+
) -> OpenAI::Responses::ResponseCreateParams::Image
|
|
73
|
+
|
|
65
74
|
# Specify additional output data to include in the model response. Currently
|
|
66
75
|
# supported values are:
|
|
67
76
|
#
|
|
@@ -175,7 +184,7 @@ module OpenAI
|
|
|
175
184
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
176
185
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
177
186
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
178
|
-
# `ttl` defaults to `30m
|
|
187
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
179
188
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
180
189
|
# for current details.
|
|
181
190
|
attr_reader prompt_cache_options: OpenAI::Responses::ResponseCreateParams::PromptCacheOptions?
|
|
@@ -186,7 +195,7 @@ module OpenAI
|
|
|
186
195
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
187
196
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
188
197
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
189
|
-
# `ttl` defaults to `30m
|
|
198
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
190
199
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
191
200
|
# for current details.
|
|
192
201
|
def prompt_cache_options=: (
|
|
@@ -390,6 +399,8 @@ module OpenAI
|
|
|
390
399
|
# prepended to `input_items` for this response request. Input items and output
|
|
391
400
|
# items from this response are automatically added to this conversation after this
|
|
392
401
|
# response completes.
|
|
402
|
+
# @param image
|
|
403
|
+
# Request level image options.
|
|
393
404
|
# @param include
|
|
394
405
|
# Specify additional output data to include in the model response. Currently
|
|
395
406
|
# supported values are:
|
|
@@ -470,7 +481,7 @@ module OpenAI
|
|
|
470
481
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
471
482
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
472
483
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
473
|
-
# `ttl` defaults to `30m
|
|
484
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
474
485
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
475
486
|
# for current details.
|
|
476
487
|
# @param prompt_cache_retention
|
|
@@ -600,6 +611,7 @@ module OpenAI
|
|
|
600
611
|
?background: bool?,
|
|
601
612
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
602
613
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
614
|
+
?image: OpenAI::Responses::ResponseCreateParams::Image,
|
|
603
615
|
?include: ::Array[OpenAI::Models::Responses::response_includable]?,
|
|
604
616
|
?input: OpenAI::Models::Responses::ResponseCreateParams::input,
|
|
605
617
|
?instructions: String?,
|
|
@@ -636,6 +648,7 @@ module OpenAI
|
|
|
636
648
|
?background: bool?,
|
|
637
649
|
?context_management: ::Array[OpenAI::Responses::ResponseCreateParams::ContextManagement]?,
|
|
638
650
|
?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,
|
|
651
|
+
?image: OpenAI::Responses::ResponseCreateParams::Image,
|
|
639
652
|
?include: ::Array[OpenAI::Models::Responses::response_includable]?,
|
|
640
653
|
?input: OpenAI::Models::Responses::ResponseCreateParams::input,
|
|
641
654
|
?instructions: String?,
|
|
@@ -757,6 +770,49 @@ module OpenAI
|
|
|
757
770
|
def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::conversation]
|
|
758
771
|
end
|
|
759
772
|
|
|
773
|
+
type image =
|
|
774
|
+
{
|
|
775
|
+
?context_compression: OpenAI::Models::Responses::ResponseCreateParams::Image::context_compression
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
class Image < OpenAI::Internal::Type::BaseModel
|
|
779
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
780
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
781
|
+
# support or `disabled` to turn it off.
|
|
782
|
+
attr_reader context_compression: OpenAI::Models::Responses::ResponseCreateParams::Image::context_compression?
|
|
783
|
+
|
|
784
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
785
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
786
|
+
# support or `disabled` to turn it off.
|
|
787
|
+
def context_compression=: (
|
|
788
|
+
OpenAI::Models::Responses::ResponseCreateParams::Image::context_compression
|
|
789
|
+
) -> OpenAI::Models::Responses::ResponseCreateParams::Image::context_compression
|
|
790
|
+
|
|
791
|
+
# @param context_compression
|
|
792
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
793
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
794
|
+
# support or `disabled` to turn it off.
|
|
795
|
+
def initialize: (
|
|
796
|
+
?context_compression: OpenAI::Models::Responses::ResponseCreateParams::Image::context_compression
|
|
797
|
+
) -> void
|
|
798
|
+
|
|
799
|
+
def to_hash: -> {
|
|
800
|
+
?context_compression: OpenAI::Models::Responses::ResponseCreateParams::Image::context_compression
|
|
801
|
+
}
|
|
802
|
+
|
|
803
|
+
type context_compression = :auto | :enabled | :disabled
|
|
804
|
+
|
|
805
|
+
module ContextCompression
|
|
806
|
+
extend OpenAI::Internal::Type::Enum
|
|
807
|
+
|
|
808
|
+
AUTO: :auto
|
|
809
|
+
ENABLED: :enabled
|
|
810
|
+
DISABLED: :disabled
|
|
811
|
+
|
|
812
|
+
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::Image::context_compression]
|
|
813
|
+
end
|
|
814
|
+
end
|
|
815
|
+
|
|
760
816
|
type input = String | OpenAI::Models::Responses::response_input
|
|
761
817
|
|
|
762
818
|
module Input
|
|
@@ -919,13 +975,13 @@ module OpenAI
|
|
|
919
975
|
def prewarm=: (bool) -> bool
|
|
920
976
|
|
|
921
977
|
# The minimum lifetime applied to every implicit and explicit cache breakpoint
|
|
922
|
-
# written by the request.
|
|
923
|
-
#
|
|
978
|
+
# written by the request. Supported values are `30m` (the default) and `12h`. The
|
|
979
|
+
# backend may retain cache entries for longer.
|
|
924
980
|
attr_reader ttl: OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::ttl?
|
|
925
981
|
|
|
926
982
|
# The minimum lifetime applied to every implicit and explicit cache breakpoint
|
|
927
|
-
# written by the request.
|
|
928
|
-
#
|
|
983
|
+
# written by the request. Supported values are `30m` (the default) and `12h`. The
|
|
984
|
+
# backend may retain cache entries for longer.
|
|
929
985
|
def ttl=: (
|
|
930
986
|
OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::ttl
|
|
931
987
|
) -> OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::ttl
|
|
@@ -945,8 +1001,8 @@ module OpenAI
|
|
|
945
1001
|
# set to `true`, overrides the `generate` field to `false`.
|
|
946
1002
|
# @param ttl
|
|
947
1003
|
# The minimum lifetime applied to every implicit and explicit cache breakpoint
|
|
948
|
-
# written by the request.
|
|
949
|
-
#
|
|
1004
|
+
# written by the request. Supported values are `30m` (the default) and `12h`. The
|
|
1005
|
+
# backend may retain cache entries for longer.
|
|
950
1006
|
def initialize: (
|
|
951
1007
|
?comparison_response_id: String?,
|
|
952
1008
|
?mode: OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::mode,
|
|
@@ -972,12 +1028,13 @@ module OpenAI
|
|
|
972
1028
|
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::mode]
|
|
973
1029
|
end
|
|
974
1030
|
|
|
975
|
-
type ttl = :"30m"
|
|
1031
|
+
type ttl = :"30m" | :"12h"
|
|
976
1032
|
|
|
977
1033
|
module Ttl
|
|
978
1034
|
extend OpenAI::Internal::Type::Enum
|
|
979
1035
|
|
|
980
1036
|
TTL_30M: :"30m"
|
|
1037
|
+
TTL_12H: :"12h"
|
|
981
1038
|
|
|
982
1039
|
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions::ttl]
|
|
983
1040
|
end
|
|
@@ -523,7 +523,8 @@ module OpenAI
|
|
|
523
523
|
?output_format: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::output_format?,
|
|
524
524
|
?quality: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::quality?,
|
|
525
525
|
?revised_prompt: String?,
|
|
526
|
-
?size: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::size
|
|
526
|
+
?size: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::size?,
|
|
527
|
+
?svg_usage: OpenAI::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage
|
|
527
528
|
}
|
|
528
529
|
|
|
529
530
|
class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
|
|
@@ -566,6 +567,12 @@ module OpenAI
|
|
|
566
567
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
567
568
|
attr_accessor size: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::size?
|
|
568
569
|
|
|
570
|
+
attr_reader svg_usage: OpenAI::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage?
|
|
571
|
+
|
|
572
|
+
def svg_usage=: (
|
|
573
|
+
OpenAI::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage
|
|
574
|
+
) -> OpenAI::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage
|
|
575
|
+
|
|
569
576
|
# @param id
|
|
570
577
|
# The unique ID of the image generation call.
|
|
571
578
|
# @param result
|
|
@@ -600,6 +607,7 @@ module OpenAI
|
|
|
600
607
|
?quality: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::quality?,
|
|
601
608
|
?revised_prompt: String?,
|
|
602
609
|
?size: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::size?,
|
|
610
|
+
?svg_usage: OpenAI::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage,
|
|
603
611
|
?type: :image_generation_call
|
|
604
612
|
) -> void
|
|
605
613
|
|
|
@@ -614,7 +622,8 @@ module OpenAI
|
|
|
614
622
|
?output_format: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::output_format?,
|
|
615
623
|
?quality: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::quality?,
|
|
616
624
|
?revised_prompt: String?,
|
|
617
|
-
?size: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::size
|
|
625
|
+
?size: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::size?,
|
|
626
|
+
?svg_usage: OpenAI::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage
|
|
618
627
|
}
|
|
619
628
|
|
|
620
629
|
type status = :in_progress | :completed | :generating | :failed
|
|
@@ -751,7 +760,7 @@ module OpenAI
|
|
|
751
760
|
end
|
|
752
761
|
end
|
|
753
762
|
|
|
754
|
-
type output_format = :png | :webp | :jpeg
|
|
763
|
+
type output_format = :png | :webp | :jpeg | :gif | :svg
|
|
755
764
|
|
|
756
765
|
module OutputFormat
|
|
757
766
|
extend OpenAI::Internal::Type::Enum
|
|
@@ -759,6 +768,8 @@ module OpenAI
|
|
|
759
768
|
PNG: :png
|
|
760
769
|
WEBP: :webp
|
|
761
770
|
JPEG: :jpeg
|
|
771
|
+
GIF: :gif
|
|
772
|
+
SVG: :svg
|
|
762
773
|
|
|
763
774
|
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::output_format]
|
|
764
775
|
end
|
|
@@ -789,6 +800,43 @@ module OpenAI
|
|
|
789
800
|
SIZE_1024X1536: :"1024x1536"
|
|
790
801
|
SIZE_1536X1024: :"1536x1024"
|
|
791
802
|
end
|
|
803
|
+
|
|
804
|
+
type svg_usage =
|
|
805
|
+
{
|
|
806
|
+
input_tokens: Integer,
|
|
807
|
+
model: String,
|
|
808
|
+
output_tokens: Integer,
|
|
809
|
+
reasoning_tokens: Integer,
|
|
810
|
+
total_tokens: Integer
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
class SvgUsage < OpenAI::Internal::Type::BaseModel
|
|
814
|
+
attr_accessor input_tokens: Integer
|
|
815
|
+
|
|
816
|
+
attr_accessor model: String
|
|
817
|
+
|
|
818
|
+
attr_accessor output_tokens: Integer
|
|
819
|
+
|
|
820
|
+
attr_accessor reasoning_tokens: Integer
|
|
821
|
+
|
|
822
|
+
attr_accessor total_tokens: Integer
|
|
823
|
+
|
|
824
|
+
def initialize: (
|
|
825
|
+
input_tokens: Integer,
|
|
826
|
+
model: String,
|
|
827
|
+
output_tokens: Integer,
|
|
828
|
+
reasoning_tokens: Integer,
|
|
829
|
+
total_tokens: Integer
|
|
830
|
+
) -> void
|
|
831
|
+
|
|
832
|
+
def to_hash: -> {
|
|
833
|
+
input_tokens: Integer,
|
|
834
|
+
model: String,
|
|
835
|
+
output_tokens: Integer,
|
|
836
|
+
reasoning_tokens: Integer,
|
|
837
|
+
total_tokens: Integer
|
|
838
|
+
}
|
|
839
|
+
end
|
|
792
840
|
end
|
|
793
841
|
|
|
794
842
|
type local_shell_call =
|
|
@@ -232,7 +232,8 @@ module OpenAI
|
|
|
232
232
|
?output_format: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::output_format?,
|
|
233
233
|
?quality: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::quality?,
|
|
234
234
|
?revised_prompt: String?,
|
|
235
|
-
?size: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size
|
|
235
|
+
?size: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size?,
|
|
236
|
+
?svg_usage: OpenAI::Responses::ResponseItem::ImageGenerationCall::SvgUsage
|
|
236
237
|
}
|
|
237
238
|
|
|
238
239
|
class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
|
|
@@ -275,6 +276,12 @@ module OpenAI
|
|
|
275
276
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
276
277
|
attr_accessor size: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size?
|
|
277
278
|
|
|
279
|
+
attr_reader svg_usage: OpenAI::Responses::ResponseItem::ImageGenerationCall::SvgUsage?
|
|
280
|
+
|
|
281
|
+
def svg_usage=: (
|
|
282
|
+
OpenAI::Responses::ResponseItem::ImageGenerationCall::SvgUsage
|
|
283
|
+
) -> OpenAI::Responses::ResponseItem::ImageGenerationCall::SvgUsage
|
|
284
|
+
|
|
278
285
|
# @param id
|
|
279
286
|
# The unique ID of the image generation call.
|
|
280
287
|
# @param result
|
|
@@ -309,6 +316,7 @@ module OpenAI
|
|
|
309
316
|
?quality: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::quality?,
|
|
310
317
|
?revised_prompt: String?,
|
|
311
318
|
?size: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size?,
|
|
319
|
+
?svg_usage: OpenAI::Responses::ResponseItem::ImageGenerationCall::SvgUsage,
|
|
312
320
|
?type: :image_generation_call
|
|
313
321
|
) -> void
|
|
314
322
|
|
|
@@ -323,7 +331,8 @@ module OpenAI
|
|
|
323
331
|
?output_format: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::output_format?,
|
|
324
332
|
?quality: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::quality?,
|
|
325
333
|
?revised_prompt: String?,
|
|
326
|
-
?size: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size
|
|
334
|
+
?size: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size?,
|
|
335
|
+
?svg_usage: OpenAI::Responses::ResponseItem::ImageGenerationCall::SvgUsage
|
|
327
336
|
}
|
|
328
337
|
|
|
329
338
|
type status = :in_progress | :completed | :generating | :failed
|
|
@@ -460,7 +469,7 @@ module OpenAI
|
|
|
460
469
|
end
|
|
461
470
|
end
|
|
462
471
|
|
|
463
|
-
type output_format = :png | :webp | :jpeg
|
|
472
|
+
type output_format = :png | :webp | :jpeg | :gif | :svg
|
|
464
473
|
|
|
465
474
|
module OutputFormat
|
|
466
475
|
extend OpenAI::Internal::Type::Enum
|
|
@@ -468,6 +477,8 @@ module OpenAI
|
|
|
468
477
|
PNG: :png
|
|
469
478
|
WEBP: :webp
|
|
470
479
|
JPEG: :jpeg
|
|
480
|
+
GIF: :gif
|
|
481
|
+
SVG: :svg
|
|
471
482
|
|
|
472
483
|
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::output_format]
|
|
473
484
|
end
|
|
@@ -498,6 +509,43 @@ module OpenAI
|
|
|
498
509
|
SIZE_1024X1536: :"1024x1536"
|
|
499
510
|
SIZE_1536X1024: :"1536x1024"
|
|
500
511
|
end
|
|
512
|
+
|
|
513
|
+
type svg_usage =
|
|
514
|
+
{
|
|
515
|
+
input_tokens: Integer,
|
|
516
|
+
model: String,
|
|
517
|
+
output_tokens: Integer,
|
|
518
|
+
reasoning_tokens: Integer,
|
|
519
|
+
total_tokens: Integer
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
class SvgUsage < OpenAI::Internal::Type::BaseModel
|
|
523
|
+
attr_accessor input_tokens: Integer
|
|
524
|
+
|
|
525
|
+
attr_accessor model: String
|
|
526
|
+
|
|
527
|
+
attr_accessor output_tokens: Integer
|
|
528
|
+
|
|
529
|
+
attr_accessor reasoning_tokens: Integer
|
|
530
|
+
|
|
531
|
+
attr_accessor total_tokens: Integer
|
|
532
|
+
|
|
533
|
+
def initialize: (
|
|
534
|
+
input_tokens: Integer,
|
|
535
|
+
model: String,
|
|
536
|
+
output_tokens: Integer,
|
|
537
|
+
reasoning_tokens: Integer,
|
|
538
|
+
total_tokens: Integer
|
|
539
|
+
) -> void
|
|
540
|
+
|
|
541
|
+
def to_hash: -> {
|
|
542
|
+
input_tokens: Integer,
|
|
543
|
+
model: String,
|
|
544
|
+
output_tokens: Integer,
|
|
545
|
+
reasoning_tokens: Integer,
|
|
546
|
+
total_tokens: Integer
|
|
547
|
+
}
|
|
548
|
+
end
|
|
501
549
|
end
|
|
502
550
|
|
|
503
551
|
type local_shell_call =
|
|
@@ -230,7 +230,8 @@ module OpenAI
|
|
|
230
230
|
?output_format: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::output_format?,
|
|
231
231
|
?quality: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::quality?,
|
|
232
232
|
?revised_prompt: String?,
|
|
233
|
-
?size: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::size
|
|
233
|
+
?size: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::size?,
|
|
234
|
+
?svg_usage: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage
|
|
234
235
|
}
|
|
235
236
|
|
|
236
237
|
class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
|
|
@@ -273,6 +274,12 @@ module OpenAI
|
|
|
273
274
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
274
275
|
attr_accessor size: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::size?
|
|
275
276
|
|
|
277
|
+
attr_reader svg_usage: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage?
|
|
278
|
+
|
|
279
|
+
def svg_usage=: (
|
|
280
|
+
OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage
|
|
281
|
+
) -> OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage
|
|
282
|
+
|
|
276
283
|
# @param id
|
|
277
284
|
# The unique ID of the image generation call.
|
|
278
285
|
# @param result
|
|
@@ -307,6 +314,7 @@ module OpenAI
|
|
|
307
314
|
?quality: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::quality?,
|
|
308
315
|
?revised_prompt: String?,
|
|
309
316
|
?size: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::size?,
|
|
317
|
+
?svg_usage: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage,
|
|
310
318
|
?type: :image_generation_call
|
|
311
319
|
) -> void
|
|
312
320
|
|
|
@@ -321,7 +329,8 @@ module OpenAI
|
|
|
321
329
|
?output_format: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::output_format?,
|
|
322
330
|
?quality: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::quality?,
|
|
323
331
|
?revised_prompt: String?,
|
|
324
|
-
?size: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::size
|
|
332
|
+
?size: OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::size?,
|
|
333
|
+
?svg_usage: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage
|
|
325
334
|
}
|
|
326
335
|
|
|
327
336
|
type status = :in_progress | :completed | :generating | :failed
|
|
@@ -458,7 +467,7 @@ module OpenAI
|
|
|
458
467
|
end
|
|
459
468
|
end
|
|
460
469
|
|
|
461
|
-
type output_format = :png | :webp | :jpeg
|
|
470
|
+
type output_format = :png | :webp | :jpeg | :gif | :svg
|
|
462
471
|
|
|
463
472
|
module OutputFormat
|
|
464
473
|
extend OpenAI::Internal::Type::Enum
|
|
@@ -466,6 +475,8 @@ module OpenAI
|
|
|
466
475
|
PNG: :png
|
|
467
476
|
WEBP: :webp
|
|
468
477
|
JPEG: :jpeg
|
|
478
|
+
GIF: :gif
|
|
479
|
+
SVG: :svg
|
|
469
480
|
|
|
470
481
|
def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::output_format]
|
|
471
482
|
end
|
|
@@ -496,6 +507,43 @@ module OpenAI
|
|
|
496
507
|
SIZE_1024X1536: :"1024x1536"
|
|
497
508
|
SIZE_1536X1024: :"1536x1024"
|
|
498
509
|
end
|
|
510
|
+
|
|
511
|
+
type svg_usage =
|
|
512
|
+
{
|
|
513
|
+
input_tokens: Integer,
|
|
514
|
+
model: String,
|
|
515
|
+
output_tokens: Integer,
|
|
516
|
+
reasoning_tokens: Integer,
|
|
517
|
+
total_tokens: Integer
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
class SvgUsage < OpenAI::Internal::Type::BaseModel
|
|
521
|
+
attr_accessor input_tokens: Integer
|
|
522
|
+
|
|
523
|
+
attr_accessor model: String
|
|
524
|
+
|
|
525
|
+
attr_accessor output_tokens: Integer
|
|
526
|
+
|
|
527
|
+
attr_accessor reasoning_tokens: Integer
|
|
528
|
+
|
|
529
|
+
attr_accessor total_tokens: Integer
|
|
530
|
+
|
|
531
|
+
def initialize: (
|
|
532
|
+
input_tokens: Integer,
|
|
533
|
+
model: String,
|
|
534
|
+
output_tokens: Integer,
|
|
535
|
+
reasoning_tokens: Integer,
|
|
536
|
+
total_tokens: Integer
|
|
537
|
+
) -> void
|
|
538
|
+
|
|
539
|
+
def to_hash: -> {
|
|
540
|
+
input_tokens: Integer,
|
|
541
|
+
model: String,
|
|
542
|
+
output_tokens: Integer,
|
|
543
|
+
reasoning_tokens: Integer,
|
|
544
|
+
total_tokens: Integer
|
|
545
|
+
}
|
|
546
|
+
end
|
|
499
547
|
end
|
|
500
548
|
|
|
501
549
|
type local_shell_call =
|