openai 0.85.0 → 0.87.0

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

@@ -342,6 +342,15 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # 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 image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::Variants)) }
+          attr_accessor :size
+
           # An image generation request made by the model.
           sig do
             params(
@@ -352,6 +361,10 @@ module OpenAI
 
               status: OpenAI::Responses::ResponseItem::ImageGenerationCall::Status::OrSymbol,
 
+              quality: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::OrSymbol),
+
+              size: T.nilable(T.any(String, OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::OrSymbol)),
+
               type: Symbol
             )
               .returns(T.attached_class)
@@ -367,6 +380,13 @@ module OpenAI
             # The status of the image generation call.
             status:,
 
+            # The quality of the image generated by the image generation tool call. One of
+            # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+            quality: nil,
+
+            # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+            size: nil,
+
             # The type of the image generation call. Always `image_generation_call`.
 
             type: :image_generation_call
@@ -379,7 +399,9 @@ module OpenAI
                 id: String,
                 result: T.nilable(String),
                 status: OpenAI::Responses::ResponseItem::ImageGenerationCall::Status::TaggedSymbol,
-                type: Symbol
+                type: Symbol,
+                quality: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol),
+                size: T.nilable(OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::Variants)
               }
             )
           end
@@ -407,6 +429,63 @@ module OpenAI
             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
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LOW = T.let(:low, OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol)
+            HIGH = T.let(:high, OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol)
+            XHIGH = T.let(:xhigh, OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol)
+            MAX = T.let(:max, OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol)
+
+            sig {
+              override.returns(T::Array[OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality::TaggedSymbol])
+            }
+            def self.values
+            end
+          end
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            Variants = T.type_alias {
+              T.any(String, OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::TaggedSymbol)
+            }
+
+            sig { override.returns(T::Array[OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::Variants]) }
+            def self.variants
+            end
+
+            TaggedSymbol = T.type_alias do
+              T.all(Symbol, OpenAI::Responses::ResponseItem::ImageGenerationCall::Size)
+            end
+
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SIZE_1024X1024 = T.let(
+              :"1024x1024",
+              OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+            SIZE_1024X1536 = T.let(
+              :"1024x1536",
+              OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+            SIZE_1536X1024 = T.let(
+              :"1536x1024",
+              OpenAI::Responses::ResponseItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

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

@@ -347,6 +347,15 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # 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 image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants)) }
+          attr_accessor :size
+
           # An image generation request made by the model.
           sig do
             params(
@@ -357,6 +366,10 @@ module OpenAI
 
               status: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Status::OrSymbol,
 
+              quality: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::OrSymbol),
+
+              size: T.nilable(T.any(String, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::OrSymbol)),
+
               type: Symbol
             )
               .returns(T.attached_class)
@@ -372,6 +385,13 @@ module OpenAI
             # The status of the image generation call.
             status:,
 
+            # The quality of the image generated by the image generation tool call. One of
+            # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+            quality: nil,
+
+            # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+            size: nil,
+
             # The type of the image generation call. Always `image_generation_call`.
 
             type: :image_generation_call
@@ -384,7 +404,9 @@ module OpenAI
                 id: String,
                 result: T.nilable(String),
                 status: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Status::TaggedSymbol,
-                type: Symbol
+                type: Symbol,
+                quality: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol),
+                size: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants)
               }
             )
           end
@@ -422,6 +444,67 @@ module OpenAI
             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
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LOW = T.let(:low, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            HIGH = T.let(:high, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            XHIGH = T.let(:xhigh, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            MAX = T.let(:max, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            Variants = T.type_alias {
+              T.any(String, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol)
+            }
+
+            sig {
+              override.returns(T::Array[OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants])
+            }
+            def self.variants
+            end
+
+            TaggedSymbol = T.type_alias do
+              T.all(Symbol, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size)
+            end
+
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SIZE_1024X1024 = T.let(
+              :"1024x1024",
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+            SIZE_1024X1536 = T.let(
+              :"1024x1536",
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+            SIZE_1536X1024 = T.let(
+              :"1536x1024",
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models/responses/response_steer_accepted_event.rbi

@@ -84,7 +84,7 @@ module OpenAI
               sequence_number: Integer,
               steer: OpenAI::Responses::ResponseSteerAcceptedEvent::Steer,
               type: Symbol,
-              stream_id: String
+              stream_id: T.nilable(String)
             }
           )
         end

data/rbi/openai/models/responses/response_steer_failed_event.rbi

@@ -95,7 +95,7 @@ module OpenAI
               sequence_number: Integer,
               steer: OpenAI::Responses::ResponseSteerFailedEvent::Steer,
               type: Symbol,
-              stream_id: String
+              stream_id: T.nilable(String)
             }
           )
         end
@@ -252,7 +252,11 @@ module OpenAI
 
           sig do
             override.returns(
-              {input: OpenAI::Responses::ResponseSteerInput::Variants, previous_response_id: String, id: String}
+              {
+                input: OpenAI::Responses::ResponseSteerInput::Variants,
+                previous_response_id: String,
+                id: T.nilable(String)
+              }
             )
           end
           def to_hash

data/rbi/openai/models/responses/response_steer_pending_event.rbi

@@ -158,7 +158,7 @@ module OpenAI
               sequence_number: Integer,
               steer: OpenAI::Responses::ResponseSteerPendingEvent::Steer,
               type: Symbol,
-              stream_id: String
+              stream_id: T.nilable(String)
             }
           )
         end

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -256,6 +256,9 @@ module OpenAI
           attr_accessor :service_tier
 
           # Whether to store the generated model response for later retrieval via API.
+          # Defaults to true when omitted. If set to true, response data will be stored for
+          # at least 30 days, subject to the
+          # [data retention exceptions](/api/docs/guides/your-data#v1responses).
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :store
 
@@ -740,6 +743,9 @@ module OpenAI
             service_tier: nil,
 
             # Whether to store the generated model response for later retrieval via API.
+            # Defaults to true when omitted. If set to true, response data will be stored for
+            # at least 30 days, subject to the
+            # [data retention exceptions](/api/docs/guides/your-data#v1responses).
             store: nil,
 
             # If set to true, the model response data will be streamed to the client as it is
@@ -843,18 +849,22 @@ module OpenAI
                 ),
                 conversation: T.nilable(T.any(String, OpenAI::Responses::ResponseConversationParam)),
                 include: T.nilable(T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]),
-                input: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Input::Variants,
+                input: T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Input::Variants),
                 instructions: T.nilable(String),
                 max_output_tokens: T.nilable(Integer),
                 max_tool_calls: T.nilable(Integer),
                 metadata: T.nilable(T::Hash[Symbol, String]),
-                model: T.any(String, OpenAI::ChatModel::OrSymbol, OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol),
+                model: T.nilable(
+                  T.any(String, OpenAI::ChatModel::OrSymbol, OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol)
+                ),
                 moderation: T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Moderation),
                 parallel_tool_calls: T.nilable(T::Boolean),
                 previous_response_id: T.nilable(String),
                 prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
                 prompt_cache_key: T.nilable(String),
-                prompt_cache_options: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions,
+                prompt_cache_options: T.nilable(
+                  OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions
+                ),
                 prompt_cache_retention: T.nilable(
                   OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheRetention::OrSymbol
                 ),
@@ -863,45 +873,49 @@ module OpenAI
                 service_tier: T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ServiceTier::OrSymbol),
                 store: T.nilable(T::Boolean),
                 stream: T.nilable(T::Boolean),
-                stream_id: String,
+                stream_id: T.nilable(String),
                 stream_options: T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::StreamOptions),
                 temperature: T.nilable(Float),
-                text: OpenAI::Responses::ResponseTextConfig,
-                tool_choice: T.any(
-                  OpenAI::Responses::ToolChoiceOptions::OrSymbol,
-                  OpenAI::Responses::ToolChoiceAllowed,
-                  OpenAI::Responses::ToolChoiceTypes,
-                  OpenAI::Responses::ToolChoiceFunction,
-                  OpenAI::Responses::ToolChoiceMcp,
-                  OpenAI::Responses::ToolChoiceCustom,
-                  OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ToolChoice::SpecificProgrammaticToolCallingParam,
-                  OpenAI::Responses::ToolChoiceApplyPatch,
-                  OpenAI::Responses::ToolChoiceShell
-                ),
-                tools: T::Array[
+                text: T.nilable(OpenAI::Responses::ResponseTextConfig),
+                tool_choice: T.nilable(
                   T.any(
-                    OpenAI::Responses::FunctionTool,
-                    OpenAI::Responses::FileSearchTool,
-                    OpenAI::Responses::ComputerTool,
-                    OpenAI::Responses::ComputerUsePreviewTool,
-                    OpenAI::Responses::Tool::Mcp,
-                    OpenAI::Responses::Tool::CodeInterpreter,
-                    OpenAI::Responses::Tool::ProgrammaticToolCalling,
-                    OpenAI::Responses::Tool::ImageGeneration,
-                    OpenAI::Responses::Tool::LocalShell,
-                    OpenAI::Responses::FunctionShellTool,
-                    OpenAI::Responses::CustomTool,
-                    OpenAI::Responses::NamespaceTool,
-                    OpenAI::Responses::ToolSearchTool,
-                    OpenAI::Responses::ApplyPatchTool,
-                    OpenAI::Responses::WebSearchTool,
-                    OpenAI::Responses::WebSearchPreviewTool
+                    OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+                    OpenAI::Responses::ToolChoiceAllowed,
+                    OpenAI::Responses::ToolChoiceTypes,
+                    OpenAI::Responses::ToolChoiceFunction,
+                    OpenAI::Responses::ToolChoiceMcp,
+                    OpenAI::Responses::ToolChoiceCustom,
+                    OpenAI::Responses::ResponsesClientEvent::ResponseCreate::ToolChoice::SpecificProgrammaticToolCallingParam,
+                    OpenAI::Responses::ToolChoiceApplyPatch,
+                    OpenAI::Responses::ToolChoiceShell
                   )
-                ],
+                ),
+                tools: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Responses::FunctionTool,
+                      OpenAI::Responses::FileSearchTool,
+                      OpenAI::Responses::ComputerTool,
+                      OpenAI::Responses::ComputerUsePreviewTool,
+                      OpenAI::Responses::Tool::Mcp,
+                      OpenAI::Responses::Tool::CodeInterpreter,
+                      OpenAI::Responses::Tool::ProgrammaticToolCalling,
+                      OpenAI::Responses::Tool::ImageGeneration,
+                      OpenAI::Responses::Tool::LocalShell,
+                      OpenAI::Responses::FunctionShellTool,
+                      OpenAI::Responses::CustomTool,
+                      OpenAI::Responses::NamespaceTool,
+                      OpenAI::Responses::ToolSearchTool,
+                      OpenAI::Responses::ApplyPatchTool,
+                      OpenAI::Responses::WebSearchTool,
+                      OpenAI::Responses::WebSearchPreviewTool
+                    )
+                  ]
+                ),
                 top_logprobs: T.nilable(Integer),
                 top_p: T.nilable(Float),
                 truncation: T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Truncation::OrSymbol),
-                user: String
+                user: T.nilable(String)
               }
             )
           end
@@ -1283,6 +1297,11 @@ module OpenAI
               )
             end
 
+            # The ID of a response to compare when diagnosing prompt cache reuse. Supplying
+            # this field requests prompt cache diagnostics when the feature is enabled.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :comparison_response_id
+
             # Controls whether OpenAI automatically creates an implicit cache breakpoint.
             # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
             # and writes up to the latest three explicit breakpoints in the request. With
@@ -1330,6 +1349,8 @@ module OpenAI
             sig do
               params(
 
+                comparison_response_id: T.nilable(String),
+
                 mode: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Mode::OrSymbol,
 
                 ttl: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Ttl::OrSymbol
@@ -1338,6 +1359,10 @@ module OpenAI
             end
             def self.new(
 
+              # The ID of a response to compare when diagnosing prompt cache reuse. Supplying
+              # this field requests prompt cache diagnostics when the feature is enabled.
+              comparison_response_id: nil,
+
               # Controls whether OpenAI automatically creates an implicit cache breakpoint.
               # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
               # and writes up to the latest three explicit breakpoints in the request. With
@@ -1357,8 +1382,13 @@ module OpenAI
             sig do
               override.returns(
                 {
-                  mode: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Mode::OrSymbol,
-                  ttl: OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Ttl::OrSymbol
+                  comparison_response_id: T.nilable(String),
+                  mode: T.nilable(
+                    OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Mode::OrSymbol
+                  ),
+                  ttl: T.nilable(
+                    OpenAI::Responses::ResponsesClientEvent::ResponseCreate::PromptCacheOptions::Ttl::OrSymbol
+                  )
                 }
               )
             end
@@ -1571,7 +1601,7 @@ module OpenAI
 
             sig do
               override.returns(
-                {include_obfuscation: T::Boolean}
+                {include_obfuscation: T.nilable(T::Boolean)}
               )
             end
             def to_hash