openai 0.103.0 → 0.104.0

data/rbi/openai/models/chat/completion_create_params.rbi

@@ -23,7 +23,7 @@ module OpenAI
         # [text](https://developers.openai.com/api/docs/guides/text),
         # [images](https://developers.openai.com/api/docs/guides/images-vision), and
         # [audio](https://developers.openai.com/api/docs/guides/audio).
-        sig do
+        sig {
           returns(
             T::Array[
               T.any(
@@ -36,8 +36,7 @@ module OpenAI
               )
             ]
           )
-        end
-
+        }
         attr_accessor :messages
 
         # Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI
@@ -77,7 +76,7 @@ module OpenAI
         #
         # `none` is the default when no functions are present. `auto` is the default if
         # functions are present.
-        sig do
+        sig {
           returns(
             T.nilable(
               T.any(
@@ -86,11 +85,10 @@ module OpenAI
               )
             )
           )
-        end
-
+        }
         attr_reader :function_call
 
-        sig do
+        sig {
           params(
             function_call: T.any(
               OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::OrSymbol,
@@ -98,8 +96,7 @@ module OpenAI
             )
           )
             .void
-        end
-
+        }
         attr_writer :function_call
 
         # Deprecated in favor of `tools`.
@@ -265,38 +262,36 @@ module OpenAI
         # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
         # ensures the message the model generates is valid JSON. Using `json_schema` is
         # preferred for models that support it.
-        sig do
+        sig {
           returns(
-            T.nilable(
-              T.any(
-                OpenAI::ResponseFormatText,
-                OpenAI::ResponseFormatJSONSchema,
-                OpenAI::StructuredOutput::JsonSchemaConverter,
-                OpenAI::ResponseFormatJSONObject
-              )
+            T.any(
+              T.nilable(
+                T.any(OpenAI::ResponseFormatText, OpenAI::ResponseFormatJSONSchema, OpenAI::ResponseFormatJSONObject)
+              ),
+              OpenAI::StructuredOutput::JsonSchemaConverter
             )
           )
-        end
-
+        }
         attr_reader :response_format
 
-        sig do
+        sig {
           params(
             response_format: T.any(
-              OpenAI::ResponseFormatText::OrHash,
-              OpenAI::ResponseFormatJSONSchema::OrHash,
-              OpenAI::StructuredOutput::JsonSchemaConverter,
-              OpenAI::ResponseFormatJSONObject::OrHash
+              T.any(
+                OpenAI::ResponseFormatText::OrHash,
+                OpenAI::ResponseFormatJSONSchema::OrHash,
+                OpenAI::ResponseFormatJSONObject::OrHash
+              ),
+              OpenAI::StructuredOutput::JsonSchemaConverter
             )
           )
             .void
-        end
-
+        }
         attr_writer :response_format
 
         # A stable identifier used to help detect users of your application that may be
         # violating OpenAI's usage policies. The IDs should be a string that uniquely
-        # identifies each user, with a maximum length of 64 characters. We recommend
+        # identifies each user, with a maximum length of 128 characters. We recommend
         # hashing their username or email address, in order to avoid sending us any
         # identifying information.
         # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -375,7 +370,7 @@ module OpenAI
         #
         # `none` is the default when no tools are present. `auto` is the default if tools
         # are present.
-        sig do
+        sig {
           returns(
             T.nilable(
               T.any(
@@ -386,11 +381,10 @@ module OpenAI
               )
             )
           )
-        end
-
+        }
         attr_reader :tool_choice
 
-        sig do
+        sig {
           params(
             tool_choice: T.any(
               OpenAI::Chat::ChatCompletionToolChoiceOption::Auto::OrSymbol,
@@ -400,35 +394,31 @@ module OpenAI
             )
           )
             .void
-        end
-
+        }
         attr_writer :tool_choice
 
         # A list of tools the model may call. You can provide either
         # [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
         # or
         # [function tools](https://developers.openai.com/api/docs/guides/function-calling).
-        sig do
+        sig {
           returns(
             T.nilable(T::Array[T.any(OpenAI::Chat::ChatCompletionFunctionTool, OpenAI::Chat::ChatCompletionCustomTool)])
           )
-        end
-
+        }
         attr_reader :tools
 
-        sig do
+        sig {
           params(
             tools: T::Array[
               T.any(
-                OpenAI::StructuredOutput::JsonSchemaConverter,
-                OpenAI::Chat::ChatCompletionFunctionTool::OrHash,
-                OpenAI::Chat::ChatCompletionCustomTool::OrHash
+                T.any(OpenAI::Chat::ChatCompletionFunctionTool::OrHash, OpenAI::Chat::ChatCompletionCustomTool::OrHash),
+                OpenAI::StructuredOutput::JsonSchemaConverter
               )
             ]
           )
             .void
-        end
-
+        }
         attr_writer :tools
 
         # An integer between 0 and 20 specifying the maximum number of most likely tokens
@@ -531,10 +521,12 @@ module OpenAI
             reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
 
             response_format: T.any(
-              OpenAI::ResponseFormatText::OrHash,
-              OpenAI::ResponseFormatJSONSchema::OrHash,
-              OpenAI::StructuredOutput::JsonSchemaConverter,
-              OpenAI::ResponseFormatJSONObject::OrHash
+              T.any(
+                OpenAI::ResponseFormatText::OrHash,
+                OpenAI::ResponseFormatJSONSchema::OrHash,
+                OpenAI::ResponseFormatJSONObject::OrHash
+              ),
+              OpenAI::StructuredOutput::JsonSchemaConverter
             ),
 
             safety_identifier: T.nilable(String),
@@ -560,9 +552,8 @@ module OpenAI
 
             tools: T::Array[
               T.any(
-                OpenAI::StructuredOutput::JsonSchemaConverter,
-                OpenAI::Chat::ChatCompletionFunctionTool::OrHash,
-                OpenAI::Chat::ChatCompletionCustomTool::OrHash
+                T.any(OpenAI::Chat::ChatCompletionFunctionTool::OrHash, OpenAI::Chat::ChatCompletionCustomTool::OrHash),
+                OpenAI::StructuredOutput::JsonSchemaConverter
               )
             ],
 
@@ -759,7 +750,7 @@ module OpenAI
 
           # A stable identifier used to help detect users of your application that may be
           # violating OpenAI's usage policies. The IDs should be a string that uniquely
-          # identifies each user, with a maximum length of 64 characters. We recommend
+          # identifies each user, with a maximum length of 128 characters. We recommend
           # hashing their username or email address, in order to avoid sending us any
           # identifying information.
           # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -927,9 +918,8 @@ module OpenAI
               ),
               tools: T::Array[
                 T.any(
-                  OpenAI::StructuredOutput::JsonSchemaConverter,
-                  OpenAI::Chat::ChatCompletionFunctionTool,
-                  OpenAI::Chat::ChatCompletionCustomTool
+                  T.any(OpenAI::Chat::ChatCompletionFunctionTool, OpenAI::Chat::ChatCompletionCustomTool),
+                  OpenAI::StructuredOutput::JsonSchemaConverter
                 )
               ],
               top_logprobs: T.nilable(Integer),
@@ -977,12 +967,12 @@ module OpenAI
         module FunctionCall
           extend OpenAI::Internal::Type::Union
 
-          Variants = T.type_alias do
+          Variants = T.type_alias {
             T.any(
               OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol,
               OpenAI::Chat::ChatCompletionFunctionCallOption
             )
-          end
+          }
 
           # `none` means the model will not call a function and instead generates a message.
           # `auto` means the model can pick between generating a message or calling a
@@ -998,11 +988,11 @@ module OpenAI
             NONE = T.let(:none, OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol)
             AUTO = T.let(:auto, OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol)
 
-            sig do
+            sig {
               override.returns(
                 T::Array[OpenAI::Chat::CompletionCreateParams::FunctionCall::FunctionCallMode::TaggedSymbol]
               )
-            end
+            }
             def self.values
             end
           end
@@ -1262,11 +1252,11 @@ module OpenAI
                   OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::TaggedSymbol
                 )
 
-                sig do
+                sig {
                   override.returns(
                     T::Array[OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Input::Mode::TaggedSymbol]
                   )
-                end
+                }
                 def self.values
                 end
               end
@@ -1322,11 +1312,11 @@ module OpenAI
                   OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::TaggedSymbol
                 )
 
-                sig do
+                sig {
                   override.returns(
                     T::Array[OpenAI::Chat::CompletionCreateParams::Moderation::Policy::Output::Mode::TaggedSymbol]
                   )
-                end
+                }
                 def self.values
                 end
               end
@@ -1502,14 +1492,12 @@ module OpenAI
         module ResponseFormat
           extend OpenAI::Internal::Type::Union
 
-          Variants = T.type_alias do
+          Variants = T.type_alias {
             T.any(
-              OpenAI::ResponseFormatText,
-              OpenAI::ResponseFormatJSONSchema,
-              OpenAI::StructuredOutput::JsonSchemaConverter,
-              OpenAI::ResponseFormatJSONObject
+              T.any(OpenAI::ResponseFormatText, OpenAI::ResponseFormatJSONSchema, OpenAI::ResponseFormatJSONObject),
+              OpenAI::StructuredOutput::JsonSchemaConverter
             )
-          end
+          }
 
           sig { override.returns(T::Array[OpenAI::Chat::CompletionCreateParams::ResponseFormat::Variants]) }
           def self.variants
@@ -1611,26 +1599,24 @@ module OpenAI
           }
           attr_reader :search_context_size
 
-          sig do
+          sig {
             params(
               search_context_size: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::OrSymbol
             )
               .void
-          end
-
+          }
           attr_writer :search_context_size
 
           # Approximate location parameters for the search.
           sig { returns(T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation)) }
           attr_reader :user_location
 
-          sig do
+          sig {
             params(
               user_location: T.nilable(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::OrHash)
             )
               .void
-          end
-
+          }
           attr_writer :user_location
 
           # This tool searches the web for relevant results to use in a response. Learn more
@@ -1685,11 +1671,11 @@ module OpenAI
             )
             HIGH = T.let(:high, OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol)
 
-            sig do
+            sig {
               override.returns(
                 T::Array[OpenAI::Chat::CompletionCreateParams::WebSearchOptions::SearchContextSize::TaggedSymbol]
               )
-            end
+            }
             def self.values
             end
           end
@@ -1706,13 +1692,12 @@ module OpenAI
             sig { returns(OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate) }
             attr_reader :approximate
 
-            sig do
+            sig {
               params(
                 approximate: OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate::OrHash
               )
                 .void
-            end
-
+            }
             attr_writer :approximate
 
             # The type of location approximation. Always `approximate`.

data/rbi/openai/models/conversations/conversation_item.rbi

@@ -83,6 +83,13 @@ module OpenAI
           }
           attr_accessor :background
 
+          # Details of a moderation failure, when available.
+          sig { returns(T.nilable(OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error)) }
+          attr_reader :error
+
+          sig { params(error: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::OrHash).void }
+          attr_writer :error
+
           # The output format used for generation.
           sig {
             returns(T.nilable(OpenAI::Conversations::ConversationItem::ImageGenerationCall::OutputFormat::TaggedSymbol))
@@ -118,6 +125,8 @@ module OpenAI
 
               background: T.nilable(OpenAI::Conversations::ConversationItem::ImageGenerationCall::Background::OrSymbol),
 
+              error: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::OrHash,
+
               output_format: T.nilable(
                 OpenAI::Conversations::ConversationItem::ImageGenerationCall::OutputFormat::OrSymbol
               ),
@@ -151,6 +160,9 @@ module OpenAI
             # The background setting used for generation.
             background: nil,
 
+            # Details of a moderation failure, when available.
+            error: nil,
+
             # The output format used for generation.
             output_format: nil,
 
@@ -181,6 +193,7 @@ module OpenAI
                 background: T.nilable(
                   OpenAI::Conversations::ConversationItem::ImageGenerationCall::Background::TaggedSymbol
                 ),
+                error: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error,
                 output_format: T.nilable(
                   OpenAI::Conversations::ConversationItem::ImageGenerationCall::OutputFormat::TaggedSymbol
                 ),
@@ -278,6 +291,184 @@ module OpenAI
             end
           end
 
+          class Error < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The error code.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :code
+
+            # A description of the error.
+            sig { returns(String) }
+            attr_accessor :message
+
+            # The related request parameter.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :param
+
+            # The error type.
+            sig { returns(String) }
+            attr_accessor :type
+
+            # Public details for a `moderation_blocked` error, when available.
+            sig {
+              returns(T.nilable(OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails))
+            }
+            attr_reader :moderation_details
+
+            sig {
+              params(
+                moderation_details: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::OrHash
+              )
+                .void
+            }
+            attr_writer :moderation_details
+
+            # Details of a moderation failure, when available.
+            sig do
+              params(
+
+                code: T.nilable(String),
+
+                message: String,
+
+                param: T.nilable(String),
+
+                type: String,
+
+                moderation_details: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::OrHash
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The error code.
+              code:,
+
+              # A description of the error.
+              message:,
+
+              # The related request parameter.
+              param:,
+
+              # The error type.
+              type:,
+
+              # Public details for a `moderation_blocked` error, when available.
+
+              moderation_details: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  code: T.nilable(String),
+                  message: String,
+                  param: T.nilable(String),
+                  type: String,
+                  moderation_details: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class ModerationDetails < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              # Public moderation categories. New category values may be added over time.
+              sig { returns(T::Array[String]) }
+              attr_accessor :categories
+
+              # The stage where moderation blocked the image generation call.
+              sig {
+                returns(
+                  OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+              }
+              attr_accessor :moderation_stage
+
+              # Public details for a `moderation_blocked` error, when available.
+              sig do
+                params(
+
+                  categories: T::Array[String],
+
+                  moderation_stage: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::OrSymbol
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # Public moderation categories. New category values may be added over time.
+                categories:,
+
+                # The stage where moderation blocked the image generation call.
+
+                moderation_stage:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    categories: T::Array[String],
+                    moderation_stage: OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # The stage where moderation blocked the image generation call.
+              module ModerationStage
+                extend OpenAI::Internal::Type::Enum
+
+                TaggedSymbol = T.type_alias {
+                  T.all(
+                    Symbol,
+                    OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage
+                  )
+                }
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                INPUT = T.let(
+                  :input,
+                  OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+                OUTPUT = T.let(
+                  :output,
+                  OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+                UNKNOWN = T.let(
+                  :unknown,
+                  OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                )
+
+                sig {
+                  override.returns(
+                    T::Array[
+                      OpenAI::Conversations::ConversationItem::ImageGenerationCall::Error::ModerationDetails::ModerationStage::TaggedSymbol
+                    ]
+                  )
+                }
+                def self.values
+                end
+              end
+            end
+          end
+
           # The output format used for generation.
           module OutputFormat
             extend OpenAI::Internal::Type::Enum

data/rbi/openai/models/decision.rbi

@@ -12,12 +12,17 @@ module OpenAI
         )
       end
 
+      # Answers in question order. Any question can return a refusal instead of an
+      # answer; other questions can still receive answers. A refusal has
+      # `type: "refusal"` and the question's `name`, or `null` if it was unnamed.
       sig { returns(T::Array[OpenAI::Decision::Answer::Variants]) }
       attr_accessor :answers
 
+      # The model used.
       sig { returns(String) }
       attr_accessor :model
 
+      # Token usage for the request.
       sig { returns(OpenAI::Decision::Usage) }
       attr_reader :usage
 
@@ -44,10 +49,16 @@ module OpenAI
       end
       def self.new(
 
+        # Answers in question order. Any question can return a refusal instead of an
+        # answer; other questions can still receive answers. A refusal has
+        # `type: "refusal"` and the question's `name`, or `null` if it was unnamed.
         answers:,
 
+        # The model used.
         model:,
 
+        # Token usage for the request.
+
         usage:
       )
       end
@@ -396,7 +407,8 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
-          # The host may decline one question without disclosing its refusal score.
+          # The model declined to answer this question. Other questions in the same request
+          # can still receive answers.
           sig do
             params(
 
@@ -461,6 +473,7 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :total_tokens
 
+        # Token usage for the request.
         sig do
           params(