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
|
@@ -72,7 +72,7 @@ module OpenAI
|
|
|
72
72
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
73
73
|
# content type.
|
|
74
74
|
#
|
|
75
|
-
# @overload edit(image:, prompt:, background: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
|
|
75
|
+
# @overload edit(image:, prompt:, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
|
|
76
76
|
#
|
|
77
77
|
# @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
|
|
78
78
|
# The image(s) to edit. Must be a supported image file or an array of images.
|
|
@@ -103,6 +103,23 @@ module OpenAI
|
|
|
103
103
|
# `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
|
|
104
104
|
# set the output format to `png` or `webp`.
|
|
105
105
|
#
|
|
106
|
+
# @param complexity [Symbol, OpenAI::Models::ImageEditParams::Complexity, nil]
|
|
107
|
+
# Computation spent planning the image, independently of rendering quality. Uses
|
|
108
|
+
# the image model's configured default when omitted. For SVG output, controls the
|
|
109
|
+
# reference image, independently of the SVG author's reasoning.
|
|
110
|
+
#
|
|
111
|
+
# @param frame_count [Integer, nil]
|
|
112
|
+
# Number of frames for GIF output. Accepts integers from 2 through 16. Defaults to
|
|
113
|
+
# 9 when omitted. Only supported with output_format=gif. The requested size must
|
|
114
|
+
# satisfy the selected model's GIF size limits. GIF output does not support
|
|
115
|
+
# streaming, partial images, masks, or custom output compression. Requires access
|
|
116
|
+
# to the GIF preview for the selected model.
|
|
117
|
+
#
|
|
118
|
+
# @param frame_duration_ms [Integer, nil]
|
|
119
|
+
# Requested delay per GIF frame, in milliseconds. Defaults to 200 when omitted.
|
|
120
|
+
# GIF output rounds to the nearest 10 ms and caps the encoded delay at 655,350 ms
|
|
121
|
+
# per frame. Only supported with output_format=gif.
|
|
122
|
+
#
|
|
106
123
|
# @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
|
|
107
124
|
# Control how much effort the model will exert to match the style and features,
|
|
108
125
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
@@ -112,7 +129,7 @@ module OpenAI
|
|
|
112
129
|
# @param markup [Pathname, StringIO, IO, String, OpenAI::FilePart]
|
|
113
130
|
# A transparent PNG overlaid on the first image to guide the edit. Must match that
|
|
114
131
|
# image's dimensions after orientation and contain transparent pixels. Supports
|
|
115
|
-
# GPT Image 2.5
|
|
132
|
+
# GPT Image 2.5. Cannot be combined with mask.
|
|
116
133
|
#
|
|
117
134
|
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
118
135
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
@@ -132,8 +149,8 @@ module OpenAI
|
|
|
132
149
|
# The GPT image model to use for image editing (`gpt-image-1-mini`,
|
|
133
150
|
# `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
|
|
134
151
|
# `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
|
|
135
|
-
# `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`,
|
|
136
|
-
# `chatgpt-image-latest`).
|
|
152
|
+
# `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`,
|
|
153
|
+
# `gpt-image-2.6-sunburst`, `gpt-image-2.6-flare`, or `chatgpt-image-latest`).
|
|
137
154
|
#
|
|
138
155
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
139
156
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -148,8 +165,7 @@ module OpenAI
|
|
|
148
165
|
#
|
|
149
166
|
# @param output_format [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
|
|
150
167
|
# The format in which the generated images are returned. This parameter is only
|
|
151
|
-
# supported for the GPT image models.
|
|
152
|
-
# default value is `png`.
|
|
168
|
+
# supported for the GPT image models. The default value is `png`.
|
|
153
169
|
#
|
|
154
170
|
# @param partial_images [Integer, nil]
|
|
155
171
|
# The number of partial images to generate. This parameter is used for streaming
|
|
@@ -229,7 +245,7 @@ module OpenAI
|
|
|
229
245
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
230
246
|
# content type.
|
|
231
247
|
#
|
|
232
|
-
# @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
|
|
248
|
+
# @overload edit_stream_raw(image:, prompt:, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
|
|
233
249
|
#
|
|
234
250
|
# @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
|
|
235
251
|
# The image(s) to edit. Must be a supported image file or an array of images.
|
|
@@ -260,6 +276,23 @@ module OpenAI
|
|
|
260
276
|
# `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
|
|
261
277
|
# set the output format to `png` or `webp`.
|
|
262
278
|
#
|
|
279
|
+
# @param complexity [Symbol, OpenAI::Models::ImageEditParams::Complexity, nil]
|
|
280
|
+
# Computation spent planning the image, independently of rendering quality. Uses
|
|
281
|
+
# the image model's configured default when omitted. For SVG output, controls the
|
|
282
|
+
# reference image, independently of the SVG author's reasoning.
|
|
283
|
+
#
|
|
284
|
+
# @param frame_count [Integer, nil]
|
|
285
|
+
# Number of frames for GIF output. Accepts integers from 2 through 16. Defaults to
|
|
286
|
+
# 9 when omitted. Only supported with output_format=gif. The requested size must
|
|
287
|
+
# satisfy the selected model's GIF size limits. GIF output does not support
|
|
288
|
+
# streaming, partial images, masks, or custom output compression. Requires access
|
|
289
|
+
# to the GIF preview for the selected model.
|
|
290
|
+
#
|
|
291
|
+
# @param frame_duration_ms [Integer, nil]
|
|
292
|
+
# Requested delay per GIF frame, in milliseconds. Defaults to 200 when omitted.
|
|
293
|
+
# GIF output rounds to the nearest 10 ms and caps the encoded delay at 655,350 ms
|
|
294
|
+
# per frame. Only supported with output_format=gif.
|
|
295
|
+
#
|
|
263
296
|
# @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
|
|
264
297
|
# Control how much effort the model will exert to match the style and features,
|
|
265
298
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
@@ -269,7 +302,7 @@ module OpenAI
|
|
|
269
302
|
# @param markup [Pathname, StringIO, IO, String, OpenAI::FilePart]
|
|
270
303
|
# A transparent PNG overlaid on the first image to guide the edit. Must match that
|
|
271
304
|
# image's dimensions after orientation and contain transparent pixels. Supports
|
|
272
|
-
# GPT Image 2.5
|
|
305
|
+
# GPT Image 2.5. Cannot be combined with mask.
|
|
273
306
|
#
|
|
274
307
|
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
275
308
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
@@ -289,8 +322,8 @@ module OpenAI
|
|
|
289
322
|
# The GPT image model to use for image editing (`gpt-image-1-mini`,
|
|
290
323
|
# `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
|
|
291
324
|
# `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
|
|
292
|
-
# `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`,
|
|
293
|
-
# `chatgpt-image-latest`).
|
|
325
|
+
# `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`,
|
|
326
|
+
# `gpt-image-2.6-sunburst`, `gpt-image-2.6-flare`, or `chatgpt-image-latest`).
|
|
294
327
|
#
|
|
295
328
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
296
329
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -305,8 +338,7 @@ module OpenAI
|
|
|
305
338
|
#
|
|
306
339
|
# @param output_format [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
|
|
307
340
|
# The format in which the generated images are returned. This parameter is only
|
|
308
|
-
# supported for the GPT image models.
|
|
309
|
-
# default value is `png`.
|
|
341
|
+
# supported for the GPT image models. The default value is `png`.
|
|
310
342
|
#
|
|
311
343
|
# @param partial_images [Integer, nil]
|
|
312
344
|
# The number of partial images to generate. This parameter is used for streaming
|
|
@@ -388,7 +420,7 @@ module OpenAI
|
|
|
388
420
|
# Creates an image given a prompt using a GPT Image model.
|
|
389
421
|
# [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
|
|
390
422
|
#
|
|
391
|
-
# @overload generate(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, style: nil, user: nil, request_options: {})
|
|
423
|
+
# @overload generate(prompt:, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, style: nil, svg: nil, user: nil, request_options: {})
|
|
392
424
|
#
|
|
393
425
|
# @param prompt [String]
|
|
394
426
|
# A text description of the desired image(s). The maximum length is 32000
|
|
@@ -405,12 +437,30 @@ module OpenAI
|
|
|
405
437
|
# `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
|
|
406
438
|
# set the output format to `png` or `webp`.
|
|
407
439
|
#
|
|
440
|
+
# @param complexity [Symbol, OpenAI::Models::ImageGenerateParams::Complexity, nil]
|
|
441
|
+
# Computation spent planning the image, independently of rendering quality. Uses
|
|
442
|
+
# the image model's configured default when omitted. For SVG output, controls the
|
|
443
|
+
# reference image, independently of the SVG author's reasoning.
|
|
444
|
+
#
|
|
445
|
+
# @param frame_count [Integer, nil]
|
|
446
|
+
# Number of frames for GIF output. Accepts integers from 2 through 16. Defaults to
|
|
447
|
+
# 9 when omitted. Only supported with output_format=gif. The requested size must
|
|
448
|
+
# satisfy the selected model's GIF size limits. GIF output does not support
|
|
449
|
+
# streaming, partial images, masks, or custom output compression. Requires access
|
|
450
|
+
# to the GIF preview for the selected model.
|
|
451
|
+
#
|
|
452
|
+
# @param frame_duration_ms [Integer, nil]
|
|
453
|
+
# Requested delay per GIF frame, in milliseconds. Defaults to 200 when omitted.
|
|
454
|
+
# GIF output rounds to the nearest 10 ms and caps the encoded delay at 655,350 ms
|
|
455
|
+
# per frame. Only supported with output_format=gif.
|
|
456
|
+
#
|
|
408
457
|
# @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
|
|
409
458
|
# The GPT image model to use for image generation. Specify a model explicitly.
|
|
410
459
|
# Supported models include `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
|
|
411
460
|
# `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
412
461
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
413
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
462
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
463
|
+
# `gpt-image-2.6-flare`, and `chatgpt-image-latest`.
|
|
414
464
|
#
|
|
415
465
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
416
466
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -430,7 +480,7 @@ module OpenAI
|
|
|
430
480
|
#
|
|
431
481
|
# @param output_format [Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil]
|
|
432
482
|
# The format in which the generated images are returned. This parameter is only
|
|
433
|
-
# supported for the GPT image models.
|
|
483
|
+
# supported for the GPT image models.
|
|
434
484
|
#
|
|
435
485
|
# @param partial_images [Integer, nil]
|
|
436
486
|
# The number of partial images to generate. This parameter is used for streaming
|
|
@@ -477,6 +527,14 @@ module OpenAI
|
|
|
477
527
|
# Legacy style parameter for retired image models. Unsupported for GPT image
|
|
478
528
|
# models; describe the desired style in the prompt instead.
|
|
479
529
|
#
|
|
530
|
+
# @param svg [OpenAI::Models::ImageGenerateParams::Svg, nil]
|
|
531
|
+
# Selects the model and reasoning effort used to author SVG output. Requires
|
|
532
|
+
# output_format=svg and access to SVG model selection. When model selection is
|
|
533
|
+
# enabled, supply svg.model. When model selection is disabled, omit this object.
|
|
534
|
+
# The top-level model selects the image model that creates the reference image.
|
|
535
|
+
# SVG generation requires n=1 and does not support streaming, partial images,
|
|
536
|
+
# prompt_rewriter, or output_compression. SVG edits are not supported.
|
|
537
|
+
#
|
|
480
538
|
# @param user [String]
|
|
481
539
|
# Deprecated: use `safety_identifier` instead. This parameter remains accepted for
|
|
482
540
|
# backward compatibility and is used when `safety_identifier` is omitted, null, or
|
|
@@ -510,7 +568,7 @@ module OpenAI
|
|
|
510
568
|
# Creates an image given a prompt using a GPT Image model.
|
|
511
569
|
# [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
|
|
512
570
|
#
|
|
513
|
-
# @overload generate_stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, style: nil, user: nil, request_options: {})
|
|
571
|
+
# @overload generate_stream_raw(prompt:, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, style: nil, svg: nil, user: nil, request_options: {})
|
|
514
572
|
#
|
|
515
573
|
# @param prompt [String]
|
|
516
574
|
# A text description of the desired image(s). The maximum length is 32000
|
|
@@ -527,12 +585,30 @@ module OpenAI
|
|
|
527
585
|
# `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
|
|
528
586
|
# set the output format to `png` or `webp`.
|
|
529
587
|
#
|
|
588
|
+
# @param complexity [Symbol, OpenAI::Models::ImageGenerateParams::Complexity, nil]
|
|
589
|
+
# Computation spent planning the image, independently of rendering quality. Uses
|
|
590
|
+
# the image model's configured default when omitted. For SVG output, controls the
|
|
591
|
+
# reference image, independently of the SVG author's reasoning.
|
|
592
|
+
#
|
|
593
|
+
# @param frame_count [Integer, nil]
|
|
594
|
+
# Number of frames for GIF output. Accepts integers from 2 through 16. Defaults to
|
|
595
|
+
# 9 when omitted. Only supported with output_format=gif. The requested size must
|
|
596
|
+
# satisfy the selected model's GIF size limits. GIF output does not support
|
|
597
|
+
# streaming, partial images, masks, or custom output compression. Requires access
|
|
598
|
+
# to the GIF preview for the selected model.
|
|
599
|
+
#
|
|
600
|
+
# @param frame_duration_ms [Integer, nil]
|
|
601
|
+
# Requested delay per GIF frame, in milliseconds. Defaults to 200 when omitted.
|
|
602
|
+
# GIF output rounds to the nearest 10 ms and caps the encoded delay at 655,350 ms
|
|
603
|
+
# per frame. Only supported with output_format=gif.
|
|
604
|
+
#
|
|
530
605
|
# @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
|
|
531
606
|
# The GPT image model to use for image generation. Specify a model explicitly.
|
|
532
607
|
# Supported models include `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
|
|
533
608
|
# `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
534
609
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
535
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
610
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
611
|
+
# `gpt-image-2.6-flare`, and `chatgpt-image-latest`.
|
|
536
612
|
#
|
|
537
613
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
538
614
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -552,7 +628,7 @@ module OpenAI
|
|
|
552
628
|
#
|
|
553
629
|
# @param output_format [Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil]
|
|
554
630
|
# The format in which the generated images are returned. This parameter is only
|
|
555
|
-
# supported for the GPT image models.
|
|
631
|
+
# supported for the GPT image models.
|
|
556
632
|
#
|
|
557
633
|
# @param partial_images [Integer, nil]
|
|
558
634
|
# The number of partial images to generate. This parameter is used for streaming
|
|
@@ -599,6 +675,14 @@ module OpenAI
|
|
|
599
675
|
# Legacy style parameter for retired image models. Unsupported for GPT image
|
|
600
676
|
# models; describe the desired style in the prompt instead.
|
|
601
677
|
#
|
|
678
|
+
# @param svg [OpenAI::Models::ImageGenerateParams::Svg, nil]
|
|
679
|
+
# Selects the model and reasoning effort used to author SVG output. Requires
|
|
680
|
+
# output_format=svg and access to SVG model selection. When model selection is
|
|
681
|
+
# enabled, supply svg.model. When model selection is disabled, omit this object.
|
|
682
|
+
# The top-level model selects the image model that creates the reference image.
|
|
683
|
+
# SVG generation requires n=1 and does not support streaming, partial images,
|
|
684
|
+
# prompt_rewriter, or output_compression. SVG edits are not supported.
|
|
685
|
+
#
|
|
602
686
|
# @param user [String]
|
|
603
687
|
# Deprecated: use `safety_identifier` instead. This parameter remains accepted for
|
|
604
688
|
# backward compatibility and is used when `safety_identifier` is omitted, null, or
|
|
@@ -47,7 +47,7 @@ module OpenAI
|
|
|
47
47
|
# [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
48
48
|
# to use your own data as input for the model's response.
|
|
49
49
|
#
|
|
50
|
-
# @overload create(access_programs: nil, background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
50
|
+
# @overload create(access_programs: nil, background: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
51
51
|
#
|
|
52
52
|
# @param access_programs [OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms]
|
|
53
53
|
# Domain-specific access programs to use for this request.
|
|
@@ -65,6 +65,9 @@ module OpenAI
|
|
|
65
65
|
# items from this response are automatically added to this conversation after this
|
|
66
66
|
# response completes.
|
|
67
67
|
#
|
|
68
|
+
# @param image [OpenAI::Models::Responses::ResponseCreateParams::Image]
|
|
69
|
+
# Request level image options.
|
|
70
|
+
#
|
|
68
71
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
|
|
69
72
|
# Specify additional output data to include in the model response. Currently
|
|
70
73
|
# supported values are:
|
|
@@ -157,7 +160,7 @@ module OpenAI
|
|
|
157
160
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
158
161
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
159
162
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
160
|
-
# `ttl` defaults to `30m
|
|
163
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
161
164
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
162
165
|
# for current details.
|
|
163
166
|
#
|
|
@@ -340,7 +343,7 @@ module OpenAI
|
|
|
340
343
|
# [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
341
344
|
# to use your own data as input for the model's response.
|
|
342
345
|
#
|
|
343
|
-
# @overload stream_raw(access_programs: nil, background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
346
|
+
# @overload stream_raw(access_programs: nil, background: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
|
|
344
347
|
#
|
|
345
348
|
# @param access_programs [OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms]
|
|
346
349
|
# Domain-specific access programs to use for this request.
|
|
@@ -358,6 +361,9 @@ module OpenAI
|
|
|
358
361
|
# items from this response are automatically added to this conversation after this
|
|
359
362
|
# response completes.
|
|
360
363
|
#
|
|
364
|
+
# @param image [OpenAI::Models::Responses::ResponseCreateParams::Image]
|
|
365
|
+
# Request level image options.
|
|
366
|
+
#
|
|
361
367
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
|
|
362
368
|
# Specify additional output data to include in the model response. Currently
|
|
363
369
|
# supported values are:
|
|
@@ -450,7 +456,7 @@ module OpenAI
|
|
|
450
456
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
451
457
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
452
458
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
453
|
-
# `ttl` defaults to `30m
|
|
459
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
454
460
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
455
461
|
# for current details.
|
|
456
462
|
#
|
|
@@ -785,7 +791,7 @@ module OpenAI
|
|
|
785
791
|
# For ZDR-compatible compaction details, see
|
|
786
792
|
# [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
787
793
|
#
|
|
788
|
-
# @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, request_options: {})
|
|
794
|
+
# @overload compact(model:, image: nil, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, request_options: {})
|
|
789
795
|
#
|
|
790
796
|
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil]
|
|
791
797
|
# Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
@@ -794,6 +800,9 @@ module OpenAI
|
|
|
794
800
|
# [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
795
801
|
# compare available models.
|
|
796
802
|
#
|
|
803
|
+
# @param image [OpenAI::Models::Responses::ResponseCompactParams::Image]
|
|
804
|
+
# Request level image options.
|
|
805
|
+
#
|
|
797
806
|
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>, nil]
|
|
798
807
|
# Text, image, or file inputs to the model, used to generate a response
|
|
799
808
|
#
|
|
@@ -819,7 +828,7 @@ module OpenAI
|
|
|
819
828
|
# request can write up to four breakpoints. For cache matching, OpenAI considers
|
|
820
829
|
# up to the latest 80 breakpoints in the conversation, without a content-block
|
|
821
830
|
# lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
822
|
-
# `ttl` defaults to `30m
|
|
831
|
+
# `ttl` defaults to `30m`. Supported lifetimes depend on the API. See the
|
|
823
832
|
# [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
824
833
|
# for current details.
|
|
825
834
|
#
|
data/lib/openai/version.rb
CHANGED
data/lib/openai.rb
CHANGED
|
@@ -349,8 +349,10 @@ require_relative "openai/models/admin/organization/projects/project_group"
|
|
|
349
349
|
require_relative "openai/models/admin/organization/projects/project_hosted_tool_permissions"
|
|
350
350
|
require_relative "openai/models/admin/organization/projects/project_model_permissions"
|
|
351
351
|
require_relative "openai/models/admin/organization/projects/project_model_permissions_deleted"
|
|
352
|
+
require_relative "openai/models/admin/organization/projects/project_optional_service_tier"
|
|
352
353
|
require_relative "openai/models/admin/organization/projects/project_rate_limit"
|
|
353
354
|
require_relative "openai/models/admin/organization/projects/project_service_account"
|
|
355
|
+
require_relative "openai/models/admin/organization/projects/project_service_tier_settings"
|
|
354
356
|
require_relative "openai/models/admin/organization/projects/project_spend_alert"
|
|
355
357
|
require_relative "openai/models/admin/organization/projects/project_spend_alert_deleted"
|
|
356
358
|
require_relative "openai/models/admin/organization/projects/project_spend_limit"
|
|
@@ -373,6 +375,8 @@ require_relative "openai/models/admin/organization/projects/service_account_retr
|
|
|
373
375
|
require_relative "openai/models/admin/organization/projects/service_accounts/api_key_create_params"
|
|
374
376
|
require_relative "openai/models/admin/organization/projects/service_accounts/api_key_create_response"
|
|
375
377
|
require_relative "openai/models/admin/organization/projects/service_account_update_params"
|
|
378
|
+
require_relative "openai/models/admin/organization/projects/service_tier_setting_retrieve_params"
|
|
379
|
+
require_relative "openai/models/admin/organization/projects/service_tier_setting_update_params"
|
|
376
380
|
require_relative "openai/models/admin/organization/projects/spend_alert_create_params"
|
|
377
381
|
require_relative "openai/models/admin/organization/projects/spend_alert_delete_params"
|
|
378
382
|
require_relative "openai/models/admin/organization/projects/spend_alert_list_params"
|
|
@@ -1592,6 +1596,7 @@ require_relative "openai/resources/admin/organization/projects/rate_limits"
|
|
|
1592
1596
|
require_relative "openai/resources/admin/organization/projects/roles"
|
|
1593
1597
|
require_relative "openai/resources/admin/organization/projects/service_accounts"
|
|
1594
1598
|
require_relative "openai/resources/admin/organization/projects/service_accounts/api_keys"
|
|
1599
|
+
require_relative "openai/resources/admin/organization/projects/service_tier_settings"
|
|
1595
1600
|
require_relative "openai/resources/admin/organization/projects/spend_alerts"
|
|
1596
1601
|
require_relative "openai/resources/admin/organization/projects/spend_limit"
|
|
1597
1602
|
require_relative "openai/resources/admin/organization/projects/users"
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
|
|
6
|
+
module Admin
|
|
7
|
+
|
|
8
|
+
module Organization
|
|
9
|
+
|
|
10
|
+
ProjectOptionalServiceTier = Projects::ProjectOptionalServiceTier
|
|
11
|
+
|
|
12
|
+
module Projects
|
|
13
|
+
|
|
14
|
+
module ProjectOptionalServiceTier
|
|
15
|
+
extend OpenAI::Internal::Type::Enum
|
|
16
|
+
|
|
17
|
+
TaggedSymbol = T.type_alias {
|
|
18
|
+
T.all(Symbol, OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier)
|
|
19
|
+
}
|
|
20
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
21
|
+
|
|
22
|
+
FLEX = T.let(:flex, OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol)
|
|
23
|
+
FAST = T.let(:fast, OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol)
|
|
24
|
+
ULTRAFAST = T.let(
|
|
25
|
+
:ultrafast,
|
|
26
|
+
OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
sig {
|
|
30
|
+
override.returns(
|
|
31
|
+
T::Array[OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol]
|
|
32
|
+
)
|
|
33
|
+
}
|
|
34
|
+
def self.values
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
|
|
6
|
+
module Admin
|
|
7
|
+
|
|
8
|
+
module Organization
|
|
9
|
+
|
|
10
|
+
ProjectServiceTierSettings = Projects::ProjectServiceTierSettings
|
|
11
|
+
|
|
12
|
+
module Projects
|
|
13
|
+
|
|
14
|
+
class ProjectServiceTierSettings < OpenAI::Internal::Type::BaseModel
|
|
15
|
+
|
|
16
|
+
OrHash = T.type_alias do
|
|
17
|
+
T.any(
|
|
18
|
+
OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings,
|
|
19
|
+
OpenAI::Internal::AnyHash
|
|
20
|
+
)
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Default tier for requests that omit service_tier or use auto.
|
|
24
|
+
sig { returns(OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol) }
|
|
25
|
+
attr_accessor :default
|
|
26
|
+
|
|
27
|
+
# Additional service tiers enabled for this project. "all" includes future tiers.
|
|
28
|
+
# An empty array allows only Standard. Organization policy and eligibility still
|
|
29
|
+
# apply.
|
|
30
|
+
sig { returns(OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::EnabledTiers::Variants) }
|
|
31
|
+
attr_accessor :enabled_tiers
|
|
32
|
+
|
|
33
|
+
sig { returns(Symbol) }
|
|
34
|
+
attr_accessor :object
|
|
35
|
+
|
|
36
|
+
sig do
|
|
37
|
+
params(
|
|
38
|
+
|
|
39
|
+
default: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::OrSymbol,
|
|
40
|
+
|
|
41
|
+
enabled_tiers: T.any(
|
|
42
|
+
Symbol,
|
|
43
|
+
T::Array[OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::OrSymbol]
|
|
44
|
+
),
|
|
45
|
+
|
|
46
|
+
object: Symbol
|
|
47
|
+
)
|
|
48
|
+
.returns(T.attached_class)
|
|
49
|
+
end
|
|
50
|
+
def self.new(
|
|
51
|
+
|
|
52
|
+
# Default tier for requests that omit service_tier or use auto.
|
|
53
|
+
default:,
|
|
54
|
+
|
|
55
|
+
# Additional service tiers enabled for this project. "all" includes future tiers.
|
|
56
|
+
# An empty array allows only Standard. Organization policy and eligibility still
|
|
57
|
+
# apply.
|
|
58
|
+
enabled_tiers:,
|
|
59
|
+
|
|
60
|
+
object: :"project.service_tier_settings"
|
|
61
|
+
)
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
sig do
|
|
65
|
+
override.returns(
|
|
66
|
+
{
|
|
67
|
+
default: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol,
|
|
68
|
+
enabled_tiers: OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::EnabledTiers::Variants,
|
|
69
|
+
object: Symbol
|
|
70
|
+
}
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
def to_hash
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# Default tier for requests that omit service_tier or use auto.
|
|
77
|
+
module Default
|
|
78
|
+
extend OpenAI::Internal::Type::Enum
|
|
79
|
+
|
|
80
|
+
TaggedSymbol = T.type_alias {
|
|
81
|
+
T.all(Symbol, OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default)
|
|
82
|
+
}
|
|
83
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
84
|
+
|
|
85
|
+
STANDARD = T.let(
|
|
86
|
+
:standard,
|
|
87
|
+
OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol
|
|
88
|
+
)
|
|
89
|
+
FAST = T.let(
|
|
90
|
+
:fast,
|
|
91
|
+
OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol
|
|
92
|
+
)
|
|
93
|
+
SCALE = T.let(
|
|
94
|
+
:scale,
|
|
95
|
+
OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
sig {
|
|
99
|
+
override.returns(
|
|
100
|
+
T::Array[OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::Default::TaggedSymbol]
|
|
101
|
+
)
|
|
102
|
+
}
|
|
103
|
+
def self.values
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# Additional service tiers enabled for this project. "all" includes future tiers.
|
|
108
|
+
# An empty array allows only Standard. Organization policy and eligibility still
|
|
109
|
+
# apply.
|
|
110
|
+
module EnabledTiers
|
|
111
|
+
extend OpenAI::Internal::Type::Union
|
|
112
|
+
|
|
113
|
+
Variants = T.type_alias {
|
|
114
|
+
T.any(Symbol, T::Array[OpenAI::Admin::Organization::Projects::ProjectOptionalServiceTier::TaggedSymbol])
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
sig {
|
|
118
|
+
override.returns(
|
|
119
|
+
T::Array[OpenAI::Admin::Organization::Projects::ProjectServiceTierSettings::EnabledTiers::Variants]
|
|
120
|
+
)
|
|
121
|
+
}
|
|
122
|
+
def self.variants
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
ProjectOptionalServiceTierArray = T.let(
|
|
126
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
127
|
+
enum: -> { OpenAI::Models::Admin::Organization::Projects::ProjectOptionalServiceTier }
|
|
128
|
+
],
|
|
129
|
+
OpenAI::Internal::Type::Converter
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
end
|
|
143
|
+
end
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
|
|
6
|
+
module Admin
|
|
7
|
+
|
|
8
|
+
module Organization
|
|
9
|
+
|
|
10
|
+
module Projects
|
|
11
|
+
|
|
12
|
+
class ServiceTierSettingRetrieveParams < OpenAI::Internal::Type::BaseModel
|
|
13
|
+
|
|
14
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
15
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
16
|
+
|
|
17
|
+
OrHash = T.type_alias do
|
|
18
|
+
T.any(
|
|
19
|
+
OpenAI::Admin::Organization::Projects::ServiceTierSettingRetrieveParams,
|
|
20
|
+
OpenAI::Internal::AnyHash
|
|
21
|
+
)
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
# The ID of the project
|
|
25
|
+
sig { returns(String) }
|
|
26
|
+
attr_accessor :project_id
|
|
27
|
+
|
|
28
|
+
sig do
|
|
29
|
+
params(
|
|
30
|
+
|
|
31
|
+
project_id: String,
|
|
32
|
+
|
|
33
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
34
|
+
)
|
|
35
|
+
.returns(T.attached_class)
|
|
36
|
+
end
|
|
37
|
+
def self.new(
|
|
38
|
+
|
|
39
|
+
# The ID of the project
|
|
40
|
+
project_id:,
|
|
41
|
+
|
|
42
|
+
request_options: {}
|
|
43
|
+
)
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
sig do
|
|
47
|
+
override.returns(
|
|
48
|
+
{project_id: String, request_options: OpenAI::RequestOptions}
|
|
49
|
+
)
|
|
50
|
+
end
|
|
51
|
+
def to_hash
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
end
|
|
63
|
+
end
|