openai 0.118.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 +10 -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/all_models.rb +1 -0
- data/lib/openai/models/beta/beta_compacted_response.rb +34 -1
- data/lib/openai/models/beta/beta_response.rb +34 -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_responses_client_event.rb +48 -1
- data/lib/openai/models/beta/beta_tool.rb +164 -13
- data/lib/openai/models/beta/response_compact_params.rb +44 -1
- data/lib/openai/models/beta/response_create_params.rb +44 -1
- data/lib/openai/models/beta/session_turn_error.rb +3 -0
- 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 +34 -1
- data/lib/openai/models/responses/response_compact_params.rb +50 -1
- data/lib/openai/models/responses/response_create_params.rb +47 -1
- 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/responses_client_event.rb +48 -1
- 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.rb +6 -6
- data/lib/openai/resources/admin/organization.rb +6 -6
- data/lib/openai/resources/beta/responses.rb +12 -3
- data/lib/openai/resources/images.rb +102 -18
- data/lib/openai/resources/responses.rb +12 -3
- data/lib/openai/version.rb +1 -1
- 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 +62 -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_responses_client_event.rbi +105 -0
- data/rbi/openai/models/beta/beta_tool.rbi +245 -13
- data/rbi/openai/models/beta/response_compact_params.rbi +81 -0
- data/rbi/openai/models/beta/response_create_params.rbi +81 -0
- data/rbi/openai/models/beta/session_turn_error.rbi +3 -0
- 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 +62 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +88 -0
- data/rbi/openai/models/responses/response_create_params.rbi +87 -0
- 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/responses_client_event.rbi +105 -0
- 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.rbi +3 -3
- data/rbi/openai/resources/admin/organization.rbi +3 -3
- data/rbi/openai/resources/beta/responses.rbi +9 -0
- data/rbi/openai/resources/images.rbi +98 -14
- data/rbi/openai/resources/responses.rbi +11 -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 +40 -0
- 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_responses_client_event.rbs +56 -0
- data/sig/openai/models/beta/beta_tool.rbs +188 -15
- data/sig/openai/models/beta/response_compact_params.rbs +56 -0
- data/sig/openai/models/beta/response_create_params.rbs +56 -0
- data/sig/openai/models/beta/session_turn_error.rbs +4 -0
- 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 +40 -0
- data/sig/openai/models/responses/response_compact_params.rbs +58 -0
- data/sig/openai/models/responses/response_create_params.rbs +56 -0
- 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/responses_client_event.rbs +56 -0
- 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.rbs +2 -2
- 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 +1 -1
|
@@ -752,6 +752,32 @@ module OpenAI
|
|
|
752
752
|
enum: -> { OpenAI::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Background }
|
|
753
753
|
)
|
|
754
754
|
|
|
755
|
+
# @!attribute complexity
|
|
756
|
+
# Computation spent planning the image, independently of rendering quality.
|
|
757
|
+
# Overrides the outer response's `reasoning.effort` for image generation. When
|
|
758
|
+
# omitted, inherits a supported outer reasoning effort or uses the image model's
|
|
759
|
+
# configured default. For SVG output, controls the reference image, not the SVG
|
|
760
|
+
# author's reasoning.
|
|
761
|
+
#
|
|
762
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Complexity, nil]
|
|
763
|
+
optional(
|
|
764
|
+
:complexity,
|
|
765
|
+
enum: -> { OpenAI::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Complexity }
|
|
766
|
+
)
|
|
767
|
+
|
|
768
|
+
# @!attribute frame_count
|
|
769
|
+
# Number of GIF frames. Requires `output_format` to be `gif`. Default: 9.
|
|
770
|
+
#
|
|
771
|
+
# @return [Integer, nil]
|
|
772
|
+
optional :frame_count, Integer
|
|
773
|
+
|
|
774
|
+
# @!attribute frame_duration_ms
|
|
775
|
+
# Duration of each GIF frame in milliseconds, rounded to 10 ms. Requires
|
|
776
|
+
# `output_format` to be `gif`. Default: 200.
|
|
777
|
+
#
|
|
778
|
+
# @return [Integer, nil]
|
|
779
|
+
optional :frame_duration_ms, Integer
|
|
780
|
+
|
|
755
781
|
# @!attribute input_fidelity
|
|
756
782
|
# Control how much effort the model will exert to match the style and features,
|
|
757
783
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
@@ -781,8 +807,8 @@ module OpenAI
|
|
|
781
807
|
# The image generation model to use. One of `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
782
808
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
783
809
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
784
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
785
|
-
# `gpt-image-2`.
|
|
810
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
811
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
|
|
786
812
|
#
|
|
787
813
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
788
814
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -809,8 +835,12 @@ module OpenAI
|
|
|
809
835
|
optional :output_compression, Integer
|
|
810
836
|
|
|
811
837
|
# @!attribute output_format
|
|
812
|
-
# The output format of the generated image. One of `png`, `webp`,
|
|
813
|
-
# Default: `png`.
|
|
838
|
+
# The output format of the generated image. One of `png`, `webp`, `jpeg`, `gif`,
|
|
839
|
+
# or `svg`. Default: `png`. GIF and SVG output require a model that supports the
|
|
840
|
+
# selected format. GIF output does not support partial image streaming
|
|
841
|
+
# (`partial_images` greater than `0`), `input_image_mask`, or custom
|
|
842
|
+
# `output_compression`. Responses lifecycle events can still be streamed for GIF
|
|
843
|
+
# output.
|
|
814
844
|
#
|
|
815
845
|
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::OutputFormat, nil]
|
|
816
846
|
optional(
|
|
@@ -855,7 +885,16 @@ module OpenAI
|
|
|
855
885
|
union: -> { OpenAI::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Size }
|
|
856
886
|
)
|
|
857
887
|
|
|
858
|
-
# @!
|
|
888
|
+
# @!attribute svg
|
|
889
|
+
# SVG author model settings. Requires `output_format` to be `svg`. When SVG model
|
|
890
|
+
# selection is enabled, omitting this object uses the outer response model.
|
|
891
|
+
# Otherwise, the default SVG author is used and explicit model overrides are
|
|
892
|
+
# unavailable.
|
|
893
|
+
#
|
|
894
|
+
# @return [OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg, nil]
|
|
895
|
+
optional :svg, -> { OpenAI::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg }
|
|
896
|
+
|
|
897
|
+
# @!method initialize(action: nil, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, input_fidelity: nil, input_image_mask: nil, model: nil, moderation: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, size: nil, svg: nil, type: :image_generation)
|
|
859
898
|
# A tool that generates images using the GPT image models.
|
|
860
899
|
#
|
|
861
900
|
# @param action [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Action]
|
|
@@ -872,6 +911,20 @@ module OpenAI
|
|
|
872
911
|
# `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
|
|
873
912
|
# set the output format to `png` or `webp`.
|
|
874
913
|
#
|
|
914
|
+
# @param complexity [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Complexity]
|
|
915
|
+
# Computation spent planning the image, independently of rendering quality.
|
|
916
|
+
# Overrides the outer response's `reasoning.effort` for image generation. When
|
|
917
|
+
# omitted, inherits a supported outer reasoning effort or uses the image model's
|
|
918
|
+
# configured default. For SVG output, controls the reference image, not the SVG
|
|
919
|
+
# author's reasoning.
|
|
920
|
+
#
|
|
921
|
+
# @param frame_count [Integer]
|
|
922
|
+
# Number of GIF frames. Requires `output_format` to be `gif`. Default: 9.
|
|
923
|
+
#
|
|
924
|
+
# @param frame_duration_ms [Integer]
|
|
925
|
+
# Duration of each GIF frame in milliseconds, rounded to 10 ms. Requires
|
|
926
|
+
# `output_format` to be `gif`. Default: 200.
|
|
927
|
+
#
|
|
875
928
|
# @param input_fidelity [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::InputFidelity, nil]
|
|
876
929
|
# Control how much effort the model will exert to match the style and features,
|
|
877
930
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
@@ -886,8 +939,8 @@ module OpenAI
|
|
|
886
939
|
# The image generation model to use. One of `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
887
940
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
888
941
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
889
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
890
|
-
# `gpt-image-2`.
|
|
942
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
943
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
|
|
891
944
|
#
|
|
892
945
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
893
946
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -899,8 +952,12 @@ module OpenAI
|
|
|
899
952
|
# Compression level for the output image. Default: 100.
|
|
900
953
|
#
|
|
901
954
|
# @param output_format [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::OutputFormat]
|
|
902
|
-
# The output format of the generated image. One of `png`, `webp`,
|
|
903
|
-
# Default: `png`.
|
|
955
|
+
# The output format of the generated image. One of `png`, `webp`, `jpeg`, `gif`,
|
|
956
|
+
# or `svg`. Default: `png`. GIF and SVG output require a model that supports the
|
|
957
|
+
# selected format. GIF output does not support partial image streaming
|
|
958
|
+
# (`partial_images` greater than `0`), `input_image_mask`, or custom
|
|
959
|
+
# `output_compression`. Responses lifecycle events can still be streamed for GIF
|
|
960
|
+
# output.
|
|
904
961
|
#
|
|
905
962
|
# @param partial_images [Integer]
|
|
906
963
|
# Number of partial images to generate in streaming mode, from 0 (default value)
|
|
@@ -924,6 +981,12 @@ module OpenAI
|
|
|
924
981
|
# `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
925
982
|
# `auto` is supported for models that allow automatic sizing.
|
|
926
983
|
#
|
|
984
|
+
# @param svg [OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg]
|
|
985
|
+
# SVG author model settings. Requires `output_format` to be `svg`. When SVG model
|
|
986
|
+
# selection is enabled, omitting this object uses the outer response model.
|
|
987
|
+
# Otherwise, the default SVG author is used and explicit model overrides are
|
|
988
|
+
# unavailable.
|
|
989
|
+
#
|
|
927
990
|
# @param type [Symbol, :image_generation]
|
|
928
991
|
# The type of the image generation tool. Always `image_generation`.
|
|
929
992
|
|
|
@@ -963,6 +1026,24 @@ module OpenAI
|
|
|
963
1026
|
# @return [Array<Symbol>]
|
|
964
1027
|
end
|
|
965
1028
|
|
|
1029
|
+
# Computation spent planning the image, independently of rendering quality.
|
|
1030
|
+
# Overrides the outer response's `reasoning.effort` for image generation. When
|
|
1031
|
+
# omitted, inherits a supported outer reasoning effort or uses the image model's
|
|
1032
|
+
# configured default. For SVG output, controls the reference image, not the SVG
|
|
1033
|
+
# author's reasoning.
|
|
1034
|
+
#
|
|
1035
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration#complexity
|
|
1036
|
+
module Complexity
|
|
1037
|
+
extend OpenAI::Internal::Type::Enum
|
|
1038
|
+
|
|
1039
|
+
LOW = :low
|
|
1040
|
+
MEDIUM = :medium
|
|
1041
|
+
HIGH = :high
|
|
1042
|
+
|
|
1043
|
+
# @!method self.values
|
|
1044
|
+
# @return [Array<Symbol>]
|
|
1045
|
+
end
|
|
1046
|
+
|
|
966
1047
|
# Control how much effort the model will exert to match the style and features,
|
|
967
1048
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
968
1049
|
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
@@ -1007,8 +1088,8 @@ module OpenAI
|
|
|
1007
1088
|
# The image generation model to use. One of `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
1008
1089
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1009
1090
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1010
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
1011
|
-
# `gpt-image-2`.
|
|
1091
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1092
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
|
|
1012
1093
|
#
|
|
1013
1094
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1014
1095
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1067,6 +1148,18 @@ module OpenAI
|
|
|
1067
1148
|
}
|
|
1068
1149
|
)
|
|
1069
1150
|
|
|
1151
|
+
variant(
|
|
1152
|
+
const: -> {
|
|
1153
|
+
OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Model::GPT_IMAGE_2_6_SUNBURST
|
|
1154
|
+
}
|
|
1155
|
+
)
|
|
1156
|
+
|
|
1157
|
+
variant(
|
|
1158
|
+
const: -> {
|
|
1159
|
+
OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Model::GPT_IMAGE_2_6_FLARE
|
|
1160
|
+
}
|
|
1161
|
+
)
|
|
1162
|
+
|
|
1070
1163
|
variant(
|
|
1071
1164
|
const: -> {
|
|
1072
1165
|
OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Model::GPT_IMAGE_1_5
|
|
@@ -1103,6 +1196,8 @@ module OpenAI
|
|
|
1103
1196
|
GPT_IMAGE_2_5_SUNBURST_2026_09_08 = :"gpt-image-2.5-sunburst-2026-09-08"
|
|
1104
1197
|
GPT_IMAGE_2_5_FLARE = :"gpt-image-2.5-flare"
|
|
1105
1198
|
GPT_IMAGE_2_5_FLARE_2026_09_08 = :"gpt-image-2.5-flare-2026-09-08"
|
|
1199
|
+
GPT_IMAGE_2_6_SUNBURST = :"gpt-image-2.6-sunburst"
|
|
1200
|
+
GPT_IMAGE_2_6_FLARE = :"gpt-image-2.6-flare"
|
|
1106
1201
|
GPT_IMAGE_1_5 = :"gpt-image-1.5"
|
|
1107
1202
|
CHATGPT_IMAGE_LATEST = :"chatgpt-image-latest"
|
|
1108
1203
|
|
|
@@ -1122,8 +1217,12 @@ module OpenAI
|
|
|
1122
1217
|
# @return [Array<Symbol>]
|
|
1123
1218
|
end
|
|
1124
1219
|
|
|
1125
|
-
# The output format of the generated image. One of `png`, `webp`,
|
|
1126
|
-
# Default: `png`.
|
|
1220
|
+
# The output format of the generated image. One of `png`, `webp`, `jpeg`, `gif`,
|
|
1221
|
+
# or `svg`. Default: `png`. GIF and SVG output require a model that supports the
|
|
1222
|
+
# selected format. GIF output does not support partial image streaming
|
|
1223
|
+
# (`partial_images` greater than `0`), `input_image_mask`, or custom
|
|
1224
|
+
# `output_compression`. Responses lifecycle events can still be streamed for GIF
|
|
1225
|
+
# output.
|
|
1127
1226
|
#
|
|
1128
1227
|
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration#output_format
|
|
1129
1228
|
module OutputFormat
|
|
@@ -1132,6 +1231,8 @@ module OpenAI
|
|
|
1132
1231
|
PNG = :png
|
|
1133
1232
|
WEBP = :webp
|
|
1134
1233
|
JPEG = :jpeg
|
|
1234
|
+
GIF = :gif
|
|
1235
|
+
SVG = :svg
|
|
1135
1236
|
|
|
1136
1237
|
# @!method self.values
|
|
1137
1238
|
# @return [Array<Symbol>]
|
|
@@ -1219,6 +1320,78 @@ module OpenAI
|
|
|
1219
1320
|
|
|
1220
1321
|
# @!endgroup
|
|
1221
1322
|
end
|
|
1323
|
+
|
|
1324
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration#svg
|
|
1325
|
+
class Svg < OpenAI::Internal::Type::BaseModel
|
|
1326
|
+
# @!attribute model
|
|
1327
|
+
#
|
|
1328
|
+
# @return [String, nil]
|
|
1329
|
+
optional :model, String
|
|
1330
|
+
|
|
1331
|
+
# @!attribute reasoning
|
|
1332
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
1333
|
+
# default in both Images and Responses.
|
|
1334
|
+
#
|
|
1335
|
+
# @return [OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg::Reasoning, nil]
|
|
1336
|
+
optional(
|
|
1337
|
+
:reasoning,
|
|
1338
|
+
-> {
|
|
1339
|
+
OpenAI::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg::Reasoning
|
|
1340
|
+
},
|
|
1341
|
+
nil?: true
|
|
1342
|
+
)
|
|
1343
|
+
|
|
1344
|
+
# @!method initialize(model: nil, reasoning: nil)
|
|
1345
|
+
# SVG author model settings. Requires `output_format` to be `svg`. When SVG model
|
|
1346
|
+
# selection is enabled, omitting this object uses the outer response model.
|
|
1347
|
+
# Otherwise, the default SVG author is used and explicit model overrides are
|
|
1348
|
+
# unavailable.
|
|
1349
|
+
#
|
|
1350
|
+
# @param model [String]
|
|
1351
|
+
#
|
|
1352
|
+
# @param reasoning [OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg::Reasoning, nil]
|
|
1353
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
1354
|
+
# default in both Images and Responses.
|
|
1355
|
+
|
|
1356
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg#reasoning
|
|
1357
|
+
class Reasoning < OpenAI::Internal::Type::BaseModel
|
|
1358
|
+
# @!attribute effort
|
|
1359
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
1360
|
+
#
|
|
1361
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg::Reasoning::Effort, nil]
|
|
1362
|
+
optional(
|
|
1363
|
+
:effort,
|
|
1364
|
+
enum: -> {
|
|
1365
|
+
OpenAI::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg::Reasoning::Effort
|
|
1366
|
+
}
|
|
1367
|
+
)
|
|
1368
|
+
|
|
1369
|
+
# @!method initialize(effort: nil)
|
|
1370
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
1371
|
+
# default in both Images and Responses.
|
|
1372
|
+
#
|
|
1373
|
+
# @param effort [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg::Reasoning::Effort]
|
|
1374
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
1375
|
+
|
|
1376
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
1377
|
+
#
|
|
1378
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Tool::ImageGeneration::Svg::Reasoning#effort
|
|
1379
|
+
module Effort
|
|
1380
|
+
extend OpenAI::Internal::Type::Enum
|
|
1381
|
+
|
|
1382
|
+
NONE = :none
|
|
1383
|
+
MINIMAL = :minimal
|
|
1384
|
+
LOW = :low
|
|
1385
|
+
MEDIUM = :medium
|
|
1386
|
+
HIGH = :high
|
|
1387
|
+
XHIGH = :xhigh
|
|
1388
|
+
MAX = :max
|
|
1389
|
+
|
|
1390
|
+
# @!method self.values
|
|
1391
|
+
# @return [Array<Symbol>]
|
|
1392
|
+
end
|
|
1393
|
+
end
|
|
1394
|
+
end
|
|
1222
1395
|
end
|
|
1223
1396
|
|
|
1224
1397
|
class LocalShell < OpenAI::Internal::Type::BaseModel
|
|
@@ -104,6 +104,12 @@ module OpenAI
|
|
|
104
104
|
# @return [Boolean, nil]
|
|
105
105
|
optional :generate, OpenAI::Internal::Type::Boolean
|
|
106
106
|
|
|
107
|
+
# @!attribute image
|
|
108
|
+
# Request level image options.
|
|
109
|
+
#
|
|
110
|
+
# @return [OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::Image, nil]
|
|
111
|
+
optional :image, -> { OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Image }
|
|
112
|
+
|
|
107
113
|
# @!attribute include
|
|
108
114
|
# Specify additional output data to include in the model response. Currently
|
|
109
115
|
# supported values are:
|
|
@@ -471,7 +477,7 @@ module OpenAI
|
|
|
471
477
|
# @return [String, nil]
|
|
472
478
|
optional :user, String
|
|
473
479
|
|
|
474
|
-
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, generate: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
480
|
+
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, generate: 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: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
|
|
475
481
|
# Client event for creating a response over a persistent WebSocket connection.
|
|
476
482
|
# This payload uses the same top-level fields as `POST /v1/responses`, plus
|
|
477
483
|
# WebSocket-only envelope metadata.
|
|
@@ -503,6 +509,9 @@ module OpenAI
|
|
|
503
509
|
# to false to prepare request state without model output; the response ID can be
|
|
504
510
|
# used as previous_response_id on a later turn.
|
|
505
511
|
#
|
|
512
|
+
# @param image [OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::Image]
|
|
513
|
+
# Request level image options.
|
|
514
|
+
#
|
|
506
515
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
|
|
507
516
|
# Specify additional output data to include in the model response. Currently
|
|
508
517
|
# supported values are:
|
|
@@ -852,6 +861,44 @@ module OpenAI
|
|
|
852
861
|
# @return [Array(String, OpenAI::Models::Responses::ResponseConversationParam)]
|
|
853
862
|
end
|
|
854
863
|
|
|
864
|
+
# @see OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate#image
|
|
865
|
+
class Image < OpenAI::Internal::Type::BaseModel
|
|
866
|
+
# @!attribute context_compression
|
|
867
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
868
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
869
|
+
# support or `disabled` to turn it off.
|
|
870
|
+
#
|
|
871
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::Image::ContextCompression, nil]
|
|
872
|
+
optional(
|
|
873
|
+
:context_compression,
|
|
874
|
+
enum: -> { OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Image::ContextCompression }
|
|
875
|
+
)
|
|
876
|
+
|
|
877
|
+
# @!method initialize(context_compression: nil)
|
|
878
|
+
# Request level image options.
|
|
879
|
+
#
|
|
880
|
+
# @param context_compression [Symbol, OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::Image::ContextCompression]
|
|
881
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
882
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
883
|
+
# support or `disabled` to turn it off.
|
|
884
|
+
|
|
885
|
+
# Controls image context optimization. Defaults to `auto`, which uses the model,
|
|
886
|
+
# transport, and input to select a policy. Use `enabled` to require compression
|
|
887
|
+
# support or `disabled` to turn it off.
|
|
888
|
+
#
|
|
889
|
+
# @see OpenAI::Models::Responses::ResponsesClientEvent::ResponseCreate::Image#context_compression
|
|
890
|
+
module ContextCompression
|
|
891
|
+
extend OpenAI::Internal::Type::Enum
|
|
892
|
+
|
|
893
|
+
AUTO = :auto
|
|
894
|
+
ENABLED = :enabled
|
|
895
|
+
DISABLED = :disabled
|
|
896
|
+
|
|
897
|
+
# @!method self.values
|
|
898
|
+
# @return [Array<Symbol>]
|
|
899
|
+
end
|
|
900
|
+
end
|
|
901
|
+
|
|
855
902
|
# Text, image, or file inputs to the model, used to generate a response.
|
|
856
903
|
#
|
|
857
904
|
# Learn more:
|
|
@@ -633,6 +633,29 @@ module OpenAI
|
|
|
633
633
|
# @return [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Background, nil]
|
|
634
634
|
optional :background, enum: -> { OpenAI::Responses::Tool::ImageGeneration::Background }
|
|
635
635
|
|
|
636
|
+
# @!attribute complexity
|
|
637
|
+
# Computation spent planning the image, independently of rendering quality.
|
|
638
|
+
# Overrides the outer response's `reasoning.effort` for image generation. When
|
|
639
|
+
# omitted, inherits a supported outer reasoning effort or uses the image model's
|
|
640
|
+
# configured default. For SVG output, controls the reference image, not the SVG
|
|
641
|
+
# author's reasoning.
|
|
642
|
+
#
|
|
643
|
+
# @return [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Complexity, nil]
|
|
644
|
+
optional :complexity, enum: -> { OpenAI::Responses::Tool::ImageGeneration::Complexity }
|
|
645
|
+
|
|
646
|
+
# @!attribute frame_count
|
|
647
|
+
# Number of GIF frames. Requires `output_format` to be `gif`. Default: 9.
|
|
648
|
+
#
|
|
649
|
+
# @return [Integer, nil]
|
|
650
|
+
optional :frame_count, Integer
|
|
651
|
+
|
|
652
|
+
# @!attribute frame_duration_ms
|
|
653
|
+
# Duration of each GIF frame in milliseconds, rounded to 10 ms. Requires
|
|
654
|
+
# `output_format` to be `gif`. Default: 200.
|
|
655
|
+
#
|
|
656
|
+
# @return [Integer, nil]
|
|
657
|
+
optional :frame_duration_ms, Integer
|
|
658
|
+
|
|
636
659
|
# @!attribute input_fidelity
|
|
637
660
|
# Control how much effort the model will exert to match the style and features,
|
|
638
661
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
@@ -659,8 +682,8 @@ module OpenAI
|
|
|
659
682
|
# The image generation model to use. One of `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
660
683
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
661
684
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
662
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
663
|
-
# `gpt-image-2`.
|
|
685
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
686
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
|
|
664
687
|
#
|
|
665
688
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
666
689
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -681,8 +704,12 @@ module OpenAI
|
|
|
681
704
|
optional :output_compression, Integer
|
|
682
705
|
|
|
683
706
|
# @!attribute output_format
|
|
684
|
-
# The output format of the generated image. One of `png`, `webp`,
|
|
685
|
-
# Default: `png`.
|
|
707
|
+
# The output format of the generated image. One of `png`, `webp`, `jpeg`, `gif`,
|
|
708
|
+
# or `svg`. Default: `png`. GIF and SVG output require a model that supports the
|
|
709
|
+
# selected format. GIF output does not support partial image streaming
|
|
710
|
+
# (`partial_images` greater than `0`), `input_image_mask`, or custom
|
|
711
|
+
# `output_compression`. Responses lifecycle events can still be streamed for GIF
|
|
712
|
+
# output.
|
|
686
713
|
#
|
|
687
714
|
# @return [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::OutputFormat, nil]
|
|
688
715
|
optional :output_format, enum: -> { OpenAI::Responses::Tool::ImageGeneration::OutputFormat }
|
|
@@ -718,7 +745,16 @@ module OpenAI
|
|
|
718
745
|
# @return [String, Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Size, nil]
|
|
719
746
|
optional :size, union: -> { OpenAI::Responses::Tool::ImageGeneration::Size }
|
|
720
747
|
|
|
721
|
-
# @!
|
|
748
|
+
# @!attribute svg
|
|
749
|
+
# SVG author model settings. Requires `output_format` to be `svg`. When SVG model
|
|
750
|
+
# selection is enabled, omitting this object uses the outer response model.
|
|
751
|
+
# Otherwise, the default SVG author is used and explicit model overrides are
|
|
752
|
+
# unavailable.
|
|
753
|
+
#
|
|
754
|
+
# @return [OpenAI::Models::Responses::Tool::ImageGeneration::Svg, nil]
|
|
755
|
+
optional :svg, -> { OpenAI::Responses::Tool::ImageGeneration::Svg }
|
|
756
|
+
|
|
757
|
+
# @!method initialize(action: nil, background: nil, complexity: nil, frame_count: nil, frame_duration_ms: nil, input_fidelity: nil, input_image_mask: nil, model: nil, moderation: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, size: nil, svg: nil, type: :image_generation)
|
|
722
758
|
# A tool that generates images using the GPT image models.
|
|
723
759
|
#
|
|
724
760
|
# @param action [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Action]
|
|
@@ -735,6 +771,20 @@ module OpenAI
|
|
|
735
771
|
# `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
|
|
736
772
|
# set the output format to `png` or `webp`.
|
|
737
773
|
#
|
|
774
|
+
# @param complexity [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Complexity]
|
|
775
|
+
# Computation spent planning the image, independently of rendering quality.
|
|
776
|
+
# Overrides the outer response's `reasoning.effort` for image generation. When
|
|
777
|
+
# omitted, inherits a supported outer reasoning effort or uses the image model's
|
|
778
|
+
# configured default. For SVG output, controls the reference image, not the SVG
|
|
779
|
+
# author's reasoning.
|
|
780
|
+
#
|
|
781
|
+
# @param frame_count [Integer]
|
|
782
|
+
# Number of GIF frames. Requires `output_format` to be `gif`. Default: 9.
|
|
783
|
+
#
|
|
784
|
+
# @param frame_duration_ms [Integer]
|
|
785
|
+
# Duration of each GIF frame in milliseconds, rounded to 10 ms. Requires
|
|
786
|
+
# `output_format` to be `gif`. Default: 200.
|
|
787
|
+
#
|
|
738
788
|
# @param input_fidelity [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil]
|
|
739
789
|
# Control how much effort the model will exert to match the style and features,
|
|
740
790
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
@@ -749,8 +799,8 @@ module OpenAI
|
|
|
749
799
|
# The image generation model to use. One of `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
750
800
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
751
801
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
752
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
753
|
-
# `gpt-image-2`.
|
|
802
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
803
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
|
|
754
804
|
#
|
|
755
805
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
756
806
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -762,8 +812,12 @@ module OpenAI
|
|
|
762
812
|
# Compression level for the output image. Default: 100.
|
|
763
813
|
#
|
|
764
814
|
# @param output_format [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::OutputFormat]
|
|
765
|
-
# The output format of the generated image. One of `png`, `webp`,
|
|
766
|
-
# Default: `png`.
|
|
815
|
+
# The output format of the generated image. One of `png`, `webp`, `jpeg`, `gif`,
|
|
816
|
+
# or `svg`. Default: `png`. GIF and SVG output require a model that supports the
|
|
817
|
+
# selected format. GIF output does not support partial image streaming
|
|
818
|
+
# (`partial_images` greater than `0`), `input_image_mask`, or custom
|
|
819
|
+
# `output_compression`. Responses lifecycle events can still be streamed for GIF
|
|
820
|
+
# output.
|
|
767
821
|
#
|
|
768
822
|
# @param partial_images [Integer]
|
|
769
823
|
# Number of partial images to generate in streaming mode, from 0 (default value)
|
|
@@ -787,6 +841,12 @@ module OpenAI
|
|
|
787
841
|
# `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
788
842
|
# `auto` is supported for models that allow automatic sizing.
|
|
789
843
|
#
|
|
844
|
+
# @param svg [OpenAI::Models::Responses::Tool::ImageGeneration::Svg]
|
|
845
|
+
# SVG author model settings. Requires `output_format` to be `svg`. When SVG model
|
|
846
|
+
# selection is enabled, omitting this object uses the outer response model.
|
|
847
|
+
# Otherwise, the default SVG author is used and explicit model overrides are
|
|
848
|
+
# unavailable.
|
|
849
|
+
#
|
|
790
850
|
# @param type [Symbol, :image_generation]
|
|
791
851
|
# The type of the image generation tool. Always `image_generation`.
|
|
792
852
|
|
|
@@ -826,6 +886,24 @@ module OpenAI
|
|
|
826
886
|
# @return [Array<Symbol>]
|
|
827
887
|
end
|
|
828
888
|
|
|
889
|
+
# Computation spent planning the image, independently of rendering quality.
|
|
890
|
+
# Overrides the outer response's `reasoning.effort` for image generation. When
|
|
891
|
+
# omitted, inherits a supported outer reasoning effort or uses the image model's
|
|
892
|
+
# configured default. For SVG output, controls the reference image, not the SVG
|
|
893
|
+
# author's reasoning.
|
|
894
|
+
#
|
|
895
|
+
# @see OpenAI::Models::Responses::Tool::ImageGeneration#complexity
|
|
896
|
+
module Complexity
|
|
897
|
+
extend OpenAI::Internal::Type::Enum
|
|
898
|
+
|
|
899
|
+
LOW = :low
|
|
900
|
+
MEDIUM = :medium
|
|
901
|
+
HIGH = :high
|
|
902
|
+
|
|
903
|
+
# @!method self.values
|
|
904
|
+
# @return [Array<Symbol>]
|
|
905
|
+
end
|
|
906
|
+
|
|
829
907
|
# Control how much effort the model will exert to match the style and features,
|
|
830
908
|
# especially facial features, of input images. Supports `high` and `low` on
|
|
831
909
|
# `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
|
|
@@ -870,8 +948,8 @@ module OpenAI
|
|
|
870
948
|
# The image generation model to use. One of `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
871
949
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
872
950
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
873
|
-
# `gpt-image-2.5-flare-2026-09-08`,
|
|
874
|
-
# `gpt-image-2`.
|
|
951
|
+
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
952
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default: `gpt-image-2`.
|
|
875
953
|
#
|
|
876
954
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
877
955
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -902,6 +980,10 @@ module OpenAI
|
|
|
902
980
|
const: -> { OpenAI::Models::Responses::Tool::ImageGeneration::Model::GPT_IMAGE_2_5_FLARE_2026_09_08 }
|
|
903
981
|
)
|
|
904
982
|
|
|
983
|
+
variant const: -> { OpenAI::Models::Responses::Tool::ImageGeneration::Model::GPT_IMAGE_2_6_SUNBURST }
|
|
984
|
+
|
|
985
|
+
variant const: -> { OpenAI::Models::Responses::Tool::ImageGeneration::Model::GPT_IMAGE_2_6_FLARE }
|
|
986
|
+
|
|
905
987
|
variant const: -> { OpenAI::Models::Responses::Tool::ImageGeneration::Model::GPT_IMAGE_1_5 }
|
|
906
988
|
|
|
907
989
|
variant const: -> { OpenAI::Models::Responses::Tool::ImageGeneration::Model::CHATGPT_IMAGE_LATEST }
|
|
@@ -925,6 +1007,8 @@ module OpenAI
|
|
|
925
1007
|
GPT_IMAGE_2_5_SUNBURST_2026_09_08 = :"gpt-image-2.5-sunburst-2026-09-08"
|
|
926
1008
|
GPT_IMAGE_2_5_FLARE = :"gpt-image-2.5-flare"
|
|
927
1009
|
GPT_IMAGE_2_5_FLARE_2026_09_08 = :"gpt-image-2.5-flare-2026-09-08"
|
|
1010
|
+
GPT_IMAGE_2_6_SUNBURST = :"gpt-image-2.6-sunburst"
|
|
1011
|
+
GPT_IMAGE_2_6_FLARE = :"gpt-image-2.6-flare"
|
|
928
1012
|
GPT_IMAGE_1_5 = :"gpt-image-1.5"
|
|
929
1013
|
CHATGPT_IMAGE_LATEST = :"chatgpt-image-latest"
|
|
930
1014
|
|
|
@@ -944,8 +1028,12 @@ module OpenAI
|
|
|
944
1028
|
# @return [Array<Symbol>]
|
|
945
1029
|
end
|
|
946
1030
|
|
|
947
|
-
# The output format of the generated image. One of `png`, `webp`,
|
|
948
|
-
# Default: `png`.
|
|
1031
|
+
# The output format of the generated image. One of `png`, `webp`, `jpeg`, `gif`,
|
|
1032
|
+
# or `svg`. Default: `png`. GIF and SVG output require a model that supports the
|
|
1033
|
+
# selected format. GIF output does not support partial image streaming
|
|
1034
|
+
# (`partial_images` greater than `0`), `input_image_mask`, or custom
|
|
1035
|
+
# `output_compression`. Responses lifecycle events can still be streamed for GIF
|
|
1036
|
+
# output.
|
|
949
1037
|
#
|
|
950
1038
|
# @see OpenAI::Models::Responses::Tool::ImageGeneration#output_format
|
|
951
1039
|
module OutputFormat
|
|
@@ -954,6 +1042,8 @@ module OpenAI
|
|
|
954
1042
|
PNG = :png
|
|
955
1043
|
WEBP = :webp
|
|
956
1044
|
JPEG = :jpeg
|
|
1045
|
+
GIF = :gif
|
|
1046
|
+
SVG = :svg
|
|
957
1047
|
|
|
958
1048
|
# @!method self.values
|
|
959
1049
|
# @return [Array<Symbol>]
|
|
@@ -1020,6 +1110,67 @@ module OpenAI
|
|
|
1020
1110
|
|
|
1021
1111
|
# @!endgroup
|
|
1022
1112
|
end
|
|
1113
|
+
|
|
1114
|
+
# @see OpenAI::Models::Responses::Tool::ImageGeneration#svg
|
|
1115
|
+
class Svg < OpenAI::Internal::Type::BaseModel
|
|
1116
|
+
# @!attribute model
|
|
1117
|
+
#
|
|
1118
|
+
# @return [String, nil]
|
|
1119
|
+
optional :model, String
|
|
1120
|
+
|
|
1121
|
+
# @!attribute reasoning
|
|
1122
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
1123
|
+
# default in both Images and Responses.
|
|
1124
|
+
#
|
|
1125
|
+
# @return [OpenAI::Models::Responses::Tool::ImageGeneration::Svg::Reasoning, nil]
|
|
1126
|
+
optional :reasoning, -> { OpenAI::Responses::Tool::ImageGeneration::Svg::Reasoning }, nil?: true
|
|
1127
|
+
|
|
1128
|
+
# @!method initialize(model: nil, reasoning: nil)
|
|
1129
|
+
# SVG author model settings. Requires `output_format` to be `svg`. When SVG model
|
|
1130
|
+
# selection is enabled, omitting this object uses the outer response model.
|
|
1131
|
+
# Otherwise, the default SVG author is used and explicit model overrides are
|
|
1132
|
+
# unavailable.
|
|
1133
|
+
#
|
|
1134
|
+
# @param model [String]
|
|
1135
|
+
#
|
|
1136
|
+
# @param reasoning [OpenAI::Models::Responses::Tool::ImageGeneration::Svg::Reasoning, nil]
|
|
1137
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
1138
|
+
# default in both Images and Responses.
|
|
1139
|
+
|
|
1140
|
+
# @see OpenAI::Models::Responses::Tool::ImageGeneration::Svg#reasoning
|
|
1141
|
+
class Reasoning < OpenAI::Internal::Type::BaseModel
|
|
1142
|
+
# @!attribute effort
|
|
1143
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
1144
|
+
#
|
|
1145
|
+
# @return [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Svg::Reasoning::Effort, nil]
|
|
1146
|
+
optional :effort, enum: -> { OpenAI::Responses::Tool::ImageGeneration::Svg::Reasoning::Effort }
|
|
1147
|
+
|
|
1148
|
+
# @!method initialize(effort: nil)
|
|
1149
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
1150
|
+
# default in both Images and Responses.
|
|
1151
|
+
#
|
|
1152
|
+
# @param effort [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Svg::Reasoning::Effort]
|
|
1153
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
1154
|
+
|
|
1155
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
1156
|
+
#
|
|
1157
|
+
# @see OpenAI::Models::Responses::Tool::ImageGeneration::Svg::Reasoning#effort
|
|
1158
|
+
module Effort
|
|
1159
|
+
extend OpenAI::Internal::Type::Enum
|
|
1160
|
+
|
|
1161
|
+
NONE = :none
|
|
1162
|
+
MINIMAL = :minimal
|
|
1163
|
+
LOW = :low
|
|
1164
|
+
MEDIUM = :medium
|
|
1165
|
+
HIGH = :high
|
|
1166
|
+
XHIGH = :xhigh
|
|
1167
|
+
MAX = :max
|
|
1168
|
+
|
|
1169
|
+
# @!method self.values
|
|
1170
|
+
# @return [Array<Symbol>]
|
|
1171
|
+
end
|
|
1172
|
+
end
|
|
1173
|
+
end
|
|
1023
1174
|
end
|
|
1024
1175
|
|
|
1025
1176
|
class LocalShell < OpenAI::Internal::Type::BaseModel
|