openai 0.87.0 → 0.89.0

data/rbi/openai/models/responses/response_input_item.rbi

@@ -956,11 +956,27 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # The action used for image generation.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action::OrSymbol)) }
+          attr_accessor :action
+
+          # The background setting used for generation.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background::OrSymbol)) }
+          attr_accessor :background
+
+          # The output format used for generation.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat::OrSymbol)) }
+          attr_accessor :output_format
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           sig { returns(T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Quality::OrSymbol)) }
           attr_accessor :quality
 
+          # The prompt that was used after any model prompt rewriting.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :revised_prompt
+
           # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           sig {
             returns(T.nilable(T.any(String, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Size::OrSymbol)))
@@ -977,8 +993,18 @@ module OpenAI
 
               status: OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Status::OrSymbol,
 
+              action: T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action::OrSymbol),
+
+              background: T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background::OrSymbol),
+
+              output_format: T.nilable(
+                OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat::OrSymbol
+              ),
+
               quality: T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Quality::OrSymbol),
 
+              revised_prompt: T.nilable(String),
+
               size: T.nilable(T.any(String, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Size::OrSymbol)),
 
               type: Symbol
@@ -996,10 +1022,22 @@ module OpenAI
             # The status of the image generation call.
             status:,
 
+            # The action used for image generation.
+            action: nil,
+
+            # The background setting used for generation.
+            background: nil,
+
+            # The output format used for generation.
+            output_format: nil,
+
             # The quality of the image generated by the image generation tool call. One of
             # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
             quality: nil,
 
+            # The prompt that was used after any model prompt rewriting.
+            revised_prompt: nil,
+
             # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
             size: nil,
 
@@ -1016,7 +1054,13 @@ module OpenAI
                 result: T.nilable(String),
                 status: OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Status::OrSymbol,
                 type: Symbol,
+                action: T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action::OrSymbol),
+                background: T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background::OrSymbol),
+                output_format: T.nilable(
+                  OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat::OrSymbol
+                ),
                 quality: T.nilable(OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Quality::OrSymbol),
+                revised_prompt: T.nilable(String),
                 size: T.nilable(
                   T.any(String, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Size::OrSymbol)
                 )
@@ -1058,6 +1102,75 @@ module OpenAI
             end
           end
 
+          # The action used for image generation.
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GENERATE = T.let(:generate, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action::TaggedSymbol)
+            EDIT = T.let(:edit, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+          # The background setting used for generation.
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TRANSPARENT = T.let(
+              :transparent,
+              OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background::TaggedSymbol
+            )
+            OPAQUE = T.let(:opaque, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+          # The output format used for generation.
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PNG = T.let(:png, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+            WEBP = T.let(:webp, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+            JPEG = T.let(:jpeg, OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           module Quality

data/rbi/openai/models/responses/response_item.rbi

@@ -342,11 +342,27 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # The action used for image generation.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Action::TaggedSymbol)) }
+          attr_accessor :action
+
+          # The background setting used for generation.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Background::TaggedSymbol)) }
+          attr_accessor :background
+
+          # The output format used for generation.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat::TaggedSymbol)) }
+          attr_accessor :output_format
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           sig { returns(T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol)) }
           attr_accessor :quality
 
+          # The prompt that was used after any model prompt rewriting.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :revised_prompt
+
           # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           sig { returns(T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::Variants)) }
           attr_accessor :size
@@ -361,8 +377,16 @@ module OpenAI
 
               status: OpenAI::Responses::ResponseItem::ImageGenerationCall::Status::OrSymbol,
 
+              action: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Action::OrSymbol),
+
+              background: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Background::OrSymbol),
+
+              output_format: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat::OrSymbol),
+
               quality: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::OrSymbol),
 
+              revised_prompt: T.nilable(String),
+
               size: T.nilable(T.any(String, OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::OrSymbol)),
 
               type: Symbol
@@ -380,10 +404,22 @@ module OpenAI
             # The status of the image generation call.
             status:,
 
+            # The action used for image generation.
+            action: nil,
+
+            # The background setting used for generation.
+            background: nil,
+
+            # The output format used for generation.
+            output_format: nil,
+
             # The quality of the image generated by the image generation tool call. One of
             # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
             quality: nil,
 
+            # The prompt that was used after any model prompt rewriting.
+            revised_prompt: nil,
+
             # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
             size: nil,
 
@@ -400,7 +436,13 @@ module OpenAI
                 result: T.nilable(String),
                 status: OpenAI::Responses::ResponseItem::ImageGenerationCall::Status::TaggedSymbol,
                 type: Symbol,
+                action: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Action::TaggedSymbol),
+                background: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Background::TaggedSymbol),
+                output_format: T.nilable(
+                  OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat::TaggedSymbol
+                ),
                 quality: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol),
+                revised_prompt: T.nilable(String),
                 size: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::Variants)
               }
             )
@@ -430,6 +472,69 @@ module OpenAI
             end
           end
 
+          # The action used for image generation.
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Responses::ResponseItem::ImageGenerationCall::Action) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GENERATE = T.let(:generate, OpenAI::Responses::ResponseItem::ImageGenerationCall::Action::TaggedSymbol)
+            EDIT = T.let(:edit, OpenAI::Responses::ResponseItem::ImageGenerationCall::Action::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseItem::ImageGenerationCall::Action::TaggedSymbol)
+
+            sig {
+              override.returns(T::Array[OpenAI::Responses::ResponseItem::ImageGenerationCall::Action::TaggedSymbol])
+            }
+            def self.values
+            end
+          end
+
+          # The background setting used for generation.
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseItem::ImageGenerationCall::Background)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TRANSPARENT = T.let(
+              :transparent,
+              OpenAI::Responses::ResponseItem::ImageGenerationCall::Background::TaggedSymbol
+            )
+            OPAQUE = T.let(:opaque, OpenAI::Responses::ResponseItem::ImageGenerationCall::Background::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseItem::ImageGenerationCall::Background::TaggedSymbol)
+
+            sig {
+              override.returns(T::Array[OpenAI::Responses::ResponseItem::ImageGenerationCall::Background::TaggedSymbol])
+            }
+            def self.values
+            end
+          end
+
+          # The output format used for generation.
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PNG = T.let(:png, OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+            WEBP = T.let(:webp, OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+            JPEG = T.let(:jpeg, OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           module Quality

data/rbi/openai/models/responses/response_output_item.rbi

@@ -347,11 +347,31 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # The action used for image generation.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action::TaggedSymbol)) }
+          attr_accessor :action
+
+          # The background setting used for generation.
+          sig {
+            returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::TaggedSymbol))
+          }
+          attr_accessor :background
+
+          # The output format used for generation.
+          sig {
+            returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol))
+          }
+          attr_accessor :output_format
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           sig { returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)) }
           attr_accessor :quality
 
+          # The prompt that was used after any model prompt rewriting.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :revised_prompt
+
           # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           sig { returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants)) }
           attr_accessor :size
@@ -366,8 +386,18 @@ module OpenAI
 
               status: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Status::OrSymbol,
 
+              action: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action::OrSymbol),
+
+              background: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::OrSymbol),
+
+              output_format: T.nilable(
+                OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::OrSymbol
+              ),
+
               quality: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::OrSymbol),
 
+              revised_prompt: T.nilable(String),
+
               size: T.nilable(T.any(String, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::OrSymbol)),
 
               type: Symbol
@@ -385,10 +415,22 @@ module OpenAI
             # The status of the image generation call.
             status:,
 
+            # The action used for image generation.
+            action: nil,
+
+            # The background setting used for generation.
+            background: nil,
+
+            # The output format used for generation.
+            output_format: nil,
+
             # The quality of the image generated by the image generation tool call. One of
             # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
             quality: nil,
 
+            # The prompt that was used after any model prompt rewriting.
+            revised_prompt: nil,
+
             # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
             size: nil,
 
@@ -405,7 +447,15 @@ module OpenAI
                 result: T.nilable(String),
                 status: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Status::TaggedSymbol,
                 type: Symbol,
+                action: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action::TaggedSymbol),
+                background: T.nilable(
+                  OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::TaggedSymbol
+                ),
+                output_format: T.nilable(
+                  OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol
+                ),
                 quality: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol),
+                revised_prompt: T.nilable(String),
                 size: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants)
               }
             )
@@ -445,6 +495,81 @@ module OpenAI
             end
           end
 
+          # The action used for image generation.
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GENERATE = T.let(
+              :generate,
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action::TaggedSymbol
+            )
+            EDIT = T.let(:edit, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+          # The background setting used for generation.
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TRANSPARENT = T.let(
+              :transparent,
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::TaggedSymbol
+            )
+            OPAQUE = T.let(
+              :opaque,
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::TaggedSymbol
+            )
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+          # The output format used for generation.
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PNG = T.let(:png, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+            WEBP = T.let(:webp, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+            JPEG = T.let(:jpeg, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           module Quality

data/rbi/openai/models/responses/response_prompt.rbi

@@ -43,7 +43,7 @@ module OpenAI
         attr_accessor :version
 
         # Reference to a prompt template and its variables.
-        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        # [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         sig do
           params(
 

data/rbi/openai/models/responses/response_reasoning_item.rbi

@@ -55,7 +55,7 @@ module OpenAI
         # A description of the chain of thought used by a reasoning model while generating
         # a response. Be sure to include these items in your `input` to the Responses API
         # for subsequent turns of a conversation if you are manually
-        # [managing context](https://platform.openai.com/docs/guides/conversation-state).
+        # [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
         sig do
           params(
 

data/rbi/openai/models/responses/response_text_config.rbi

@@ -18,7 +18,7 @@ module OpenAI
         #
         # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
         # ensures the model will match your supplied JSON schema. Learn more in the
-        # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         # The default format is `{ "type": "text" }` with no additional options.
         #
@@ -62,8 +62,8 @@ module OpenAI
         # Configuration options for a text response from the model. Can be plain text or
         # structured JSON data. Learn more:
         #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
         sig do
           params(
 
@@ -83,7 +83,7 @@ module OpenAI
           #
           # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
           # ensures the model will match your supplied JSON schema. Learn more in the
-          # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+          # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
           #
           # The default format is `{ "type": "text" }` with no additional options.
           #

data/rbi/openai/models/responses/response_usage.rbi

@@ -104,7 +104,7 @@ module OpenAI
           attr_accessor :cache_write_tokens
 
           # The number of tokens that were retrieved from the cache.
-          # [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+          # [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
           sig { returns(Integer) }
           attr_accessor :cached_tokens
 
@@ -124,7 +124,7 @@ module OpenAI
             cache_write_tokens:,
 
             # The number of tokens that were retrieved from the cache.
-            # [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+            # [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
 
             cached_tokens:
           )