openai 0.80.0 → 0.81.0

data/rbi/openai/models/chat/chat_completion_allowed_tool_choice.rbi

@@ -2,27 +2,25 @@
 
 module OpenAI
   module Models
+
     ChatCompletionAllowedToolChoice = Chat::ChatCompletionAllowedToolChoice
 
     module Chat
+
       class ChatCompletionAllowedToolChoice < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::Chat::ChatCompletionAllowedToolChoice,
-              OpenAI::Internal::AnyHash
-            )
-          end
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Chat::ChatCompletionAllowedToolChoice,
+            OpenAI::Internal::AnyHash
+          )
+        end
 
         # Constrains the tools available to the model to a pre-defined set.
         sig { returns(OpenAI::Chat::ChatCompletionAllowedTools) }
         attr_reader :allowed_tools
 
-        sig do
-          params(
-            allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools::OrHash
-          ).void
-        end
+        sig { params(allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools::OrHash).void }
         attr_writer :allowed_tools
 
         # Allowed tool configuration type. Always `allowed_tools`.
@@ -32,29 +30,35 @@ module OpenAI
         # Constrains the tools available to the model to a pre-defined set.
         sig do
           params(
+
             allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools::OrHash,
+
             type: Symbol
-          ).returns(T.attached_class)
+          )
+            .returns(T.attached_class)
         end
         def self.new(
+
           # Constrains the tools available to the model to a pre-defined set.
           allowed_tools:,
+
           # Allowed tool configuration type. Always `allowed_tools`.
+
           type: :allowed_tools
         )
         end
 
         sig do
           override.returns(
-            {
-              allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools,
-              type: Symbol
-            }
+            {allowed_tools: OpenAI::Chat::ChatCompletionAllowedTools, type: Symbol}
           )
         end
         def to_hash
         end
+
       end
+
     end
+
   end
 end

data/rbi/openai/models/chat/chat_completion_allowed_tools.rbi

@@ -2,15 +2,17 @@
 
 module OpenAI
   module Models
+
     module Chat
+
       class ChatCompletionAllowedTools < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::Chat::ChatCompletionAllowedTools,
-              OpenAI::Internal::AnyHash
-            )
-          end
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Chat::ChatCompletionAllowedTools,
+            OpenAI::Internal::AnyHash
+          )
+        end
 
         # Constrains the tools available to the model to a pre-defined set.
         #
@@ -18,9 +20,7 @@ module OpenAI
         # message.
         #
         # `required` requires the model to call one or more of the allowed tools.
-        sig do
-          returns(OpenAI::Chat::ChatCompletionAllowedTools::Mode::OrSymbol)
-        end
+        sig { returns(OpenAI::Chat::ChatCompletionAllowedTools::Mode::OrSymbol) }
         attr_accessor :mode
 
         # A list of tool definitions that the model should be allowed to call.
@@ -39,11 +39,15 @@ module OpenAI
         # Constrains the tools available to the model to a pre-defined set.
         sig do
           params(
+
             mode: OpenAI::Chat::ChatCompletionAllowedTools::Mode::OrSymbol,
+
             tools: T::Array[T::Hash[Symbol, T.anything]]
-          ).returns(T.attached_class)
+          )
+            .returns(T.attached_class)
         end
         def self.new(
+
           # Constrains the tools available to the model to a pre-defined set.
           #
           # `auto` allows the model to pick from among the allowed tools and generate a
@@ -51,6 +55,7 @@ module OpenAI
           #
           # `required` requires the model to call one or more of the allowed tools.
           mode:,
+
           # A list of tool definitions that the model should be allowed to call.
           #
           # For the Chat Completions API, the list of tool definitions might look like:
@@ -61,6 +66,7 @@ module OpenAI
           #   { "type": "function", "function": { "name": "get_time" } }
           # ]
           # ```
+
           tools:
         )
         end
@@ -85,34 +91,20 @@ module OpenAI
         module Mode
           extend OpenAI::Internal::Type::Enum
 
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, OpenAI::Chat::ChatCompletionAllowedTools::Mode)
-            end
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Chat::ChatCompletionAllowedTools::Mode) }
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          AUTO =
-            T.let(
-              :auto,
-              OpenAI::Chat::ChatCompletionAllowedTools::Mode::TaggedSymbol
-            )
-          REQUIRED =
-            T.let(
-              :required,
-              OpenAI::Chat::ChatCompletionAllowedTools::Mode::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::Chat::ChatCompletionAllowedTools::Mode::TaggedSymbol
-              ]
-            )
-          end
+          AUTO = T.let(:auto, OpenAI::Chat::ChatCompletionAllowedTools::Mode::TaggedSymbol)
+          REQUIRED = T.let(:required, OpenAI::Chat::ChatCompletionAllowedTools::Mode::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Chat::ChatCompletionAllowedTools::Mode::TaggedSymbol]) }
           def self.values
           end
         end
+
       end
+
     end
+
   end
 end

data/rbi/openai/models/chat/chat_completion_assistant_message_param.rbi

@@ -2,18 +2,19 @@
 
 module OpenAI
   module Models
-    ChatCompletionAssistantMessageParam =
-      Chat::ChatCompletionAssistantMessageParam
+
+    ChatCompletionAssistantMessageParam = Chat::ChatCompletionAssistantMessageParam
 
     module Chat
+
       class ChatCompletionAssistantMessageParam < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::Chat::ChatCompletionAssistantMessageParam,
-              OpenAI::Internal::AnyHash
-            )
-          end
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Chat::ChatCompletionAssistantMessageParam,
+            OpenAI::Internal::AnyHash
+          )
+        end
 
         # The role of the messages author, in this case `assistant`.
         sig { returns(Symbol) }
@@ -21,53 +22,25 @@ module OpenAI
 
         # Data about a previous audio response from the model.
         # [Learn more](https://platform.openai.com/docs/guides/audio).
-        sig do
-          returns(
-            T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio)
-          )
-        end
+        sig { returns(T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio)) }
         attr_reader :audio
 
-        sig do
-          params(
-            audio:
-              T.nilable(
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio::OrHash
-              )
-          ).void
-        end
+        sig { params(audio: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio::OrHash)).void }
         attr_writer :audio
 
         # The contents of the assistant message. Required unless `tool_calls` or
         # `function_call` is specified.
-        sig do
-          returns(
-            T.nilable(
-              OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
-            )
-          )
-        end
+        sig { returns(T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants)) }
         attr_accessor :content
 
         # Deprecated and replaced by `tool_calls`. The name and arguments of a function
         # that should be called, as generated by the model.
-        sig do
-          returns(
-            T.nilable(
-              OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall
-            )
-          )
-        end
+        sig { returns(T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall)) }
         attr_reader :function_call
 
-        sig do
-          params(
-            function_call:
-              T.nilable(
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall::OrHash
-              )
-          ).void
-        end
+        sig {
+          params(function_call: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall::OrHash)).void
+        }
         attr_writer :function_call
 
         # An optional name for the participant. Provides the model information to
@@ -83,7 +56,7 @@ module OpenAI
         attr_accessor :refusal
 
         # The tool calls generated by the model, such as function calls.
-        sig do
+        sig {
           returns(
             T.nilable(
               T::Array[
@@ -94,67 +67,73 @@ module OpenAI
               ]
             )
           )
-        end
+        }
         attr_reader :tool_calls
 
-        sig do
+        sig {
           params(
-            tool_calls:
-              T::Array[
-                T.any(
-                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
-                  OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
-                )
-              ]
-          ).void
-        end
+            tool_calls: T::Array[
+              T.any(
+                OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
+                OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
+              )
+            ]
+          )
+            .void
+        }
         attr_writer :tool_calls
 
         # Messages sent by the model in response to user messages.
         sig do
           params(
-            audio:
-              T.nilable(
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio::OrHash
-              ),
-            content:
-              T.nilable(
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
-              ),
-            function_call:
-              T.nilable(
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall::OrHash
-              ),
+
+            audio: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio::OrHash),
+
+            content: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants),
+
+            function_call: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall::OrHash),
+
             name: String,
+
             refusal: T.nilable(String),
-            tool_calls:
-              T::Array[
-                T.any(
-                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
-                  OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
-                )
-              ],
+
+            tool_calls: T::Array[
+              T.any(
+                OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
+                OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
+              )
+            ],
+
             role: Symbol
-          ).returns(T.attached_class)
+          )
+            .returns(T.attached_class)
         end
         def self.new(
+
           # Data about a previous audio response from the model.
           # [Learn more](https://platform.openai.com/docs/guides/audio).
           audio: nil,
+
           # The contents of the assistant message. Required unless `tool_calls` or
           # `function_call` is specified.
           content: nil,
+
           # Deprecated and replaced by `tool_calls`. The name and arguments of a function
           # that should be called, as generated by the model.
           function_call: nil,
+
           # An optional name for the participant. Provides the model information to
           # differentiate between participants of the same role.
           name: nil,
+
           # The refusal message by the assistant.
           refusal: nil,
+
           # The tool calls generated by the model, such as function calls.
           tool_calls: nil,
+
           # The role of the messages author, in this case `assistant`.
+
           role: :assistant
         )
         end
@@ -163,27 +142,17 @@ module OpenAI
           override.returns(
             {
               role: Symbol,
-              audio:
-                T.nilable(
-                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio
-                ),
-              content:
-                T.nilable(
-                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
-                ),
-              function_call:
-                T.nilable(
-                  OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall
-                ),
+              audio: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio),
+              content: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants),
+              function_call: T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall),
               name: String,
               refusal: T.nilable(String),
-              tool_calls:
-                T::Array[
-                  T.any(
-                    OpenAI::Chat::ChatCompletionMessageFunctionToolCall,
-                    OpenAI::Chat::ChatCompletionMessageCustomToolCall
-                  )
-                ]
+              tool_calls: T::Array[
+                T.any(
+                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall,
+                  OpenAI::Chat::ChatCompletionMessageCustomToolCall
+                )
+              ]
             }
           )
         end
@@ -191,13 +160,12 @@ module OpenAI
         end
 
         class Audio < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio,
-                OpenAI::Internal::AnyHash
-              )
-            end
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio,
+              OpenAI::Internal::AnyHash
+            )
+          end
 
           # Unique identifier for a previous audio response from the model.
           sig { returns(String) }
@@ -205,16 +173,29 @@ module OpenAI
 
           # Data about a previous audio response from the model.
           # [Learn more](https://platform.openai.com/docs/guides/audio).
-          sig { params(id: String).returns(T.attached_class) }
+          sig do
+            params(
+
+              id: String
+            )
+              .returns(T.attached_class)
+          end
           def self.new(
+
             # Unique identifier for a previous audio response from the model.
+
             id:
           )
           end
 
-          sig { override.returns({ id: String }) }
+          sig do
+            override.returns(
+              {id: String}
+            )
+          end
           def to_hash
           end
+
         end
 
         # The contents of the assistant message. Required unless `tool_calls` or
@@ -222,68 +203,52 @@ module OpenAI
         module Content
           extend OpenAI::Internal::Type::Union
 
-          Variants =
-            T.type_alias do
-              T.any(
-                String,
-                T::Array[
-                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart::Variants
-                ]
-              )
-            end
+          Variants = T.type_alias {
+            T.any(
+              String,
+              T::Array[OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart::Variants]
+            )
+          }
 
           # Learn about
           # [text inputs](https://platform.openai.com/docs/guides/text-generation).
           module ArrayOfContentPart
             extend OpenAI::Internal::Type::Union
 
-            Variants =
-              T.type_alias do
-                T.any(
-                  OpenAI::Chat::ChatCompletionContentPartText,
-                  OpenAI::Chat::ChatCompletionContentPartRefusal
-                )
-              end
+            Variants = T.type_alias {
+              T.any(OpenAI::Chat::ChatCompletionContentPartText, OpenAI::Chat::ChatCompletionContentPartRefusal)
+            }
 
-            sig do
+            sig {
               override.returns(
-                T::Array[
-                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart::Variants
-                ]
+                T::Array[OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart::Variants]
               )
-            end
+            }
             def self.variants
             end
-          end
 
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
-              ]
-            )
           end
+
+          sig { override.returns(T::Array[OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants]) }
           def self.variants
           end
 
-          ArrayOfContentPartArray =
-            T.let(
-              OpenAI::Internal::Type::ArrayOf[
-                union:
-                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart
-              ],
-              OpenAI::Internal::Type::Converter
-            )
+          ArrayOfContentPartArray = T.let(
+            OpenAI::Internal::Type::ArrayOf[
+              union: OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart
+            ],
+            OpenAI::Internal::Type::Converter
+          )
+
         end
 
         class FunctionCall < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall,
-                OpenAI::Internal::AnyHash
-              )
-            end
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall,
+              OpenAI::Internal::AnyHash
+            )
+          end
 
           # The arguments to call the function with, as generated by the model in JSON
           # format. Note that the model does not always generate valid JSON, and may
@@ -299,24 +264,41 @@ module OpenAI
           # Deprecated and replaced by `tool_calls`. The name and arguments of a function
           # that should be called, as generated by the model.
           sig do
-            params(arguments: String, name: String).returns(T.attached_class)
+            params(
+
+              arguments: String,
+
+              name: String
+            )
+              .returns(T.attached_class)
           end
           def self.new(
+
             # The arguments to call the function with, as generated by the model in JSON
             # format. Note that the model does not always generate valid JSON, and may
             # hallucinate parameters not defined by your function schema. Validate the
             # arguments in your code before calling your function.
             arguments:,
+
             # The name of the function to call.
+
             name:
           )
           end
 
-          sig { override.returns({ arguments: String, name: String }) }
+          sig do
+            override.returns(
+              {arguments: String, name: String}
+            )
+          end
           def to_hash
           end
+
         end
+
       end
+
     end
+
   end
 end

data/rbi/openai/models/chat/chat_completion_audio.rbi

@@ -2,14 +2,19 @@
 
 module OpenAI
   module Models
+
     ChatCompletionAudio = Chat::ChatCompletionAudio
 
     module Chat
+
       class ChatCompletionAudio < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(OpenAI::Chat::ChatCompletionAudio, OpenAI::Internal::AnyHash)
-          end
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Chat::ChatCompletionAudio,
+            OpenAI::Internal::AnyHash
+          )
+        end
 
         # Unique identifier for this audio response.
         sig { returns(String) }
@@ -34,39 +39,47 @@ module OpenAI
         # [Learn more](https://platform.openai.com/docs/guides/audio).
         sig do
           params(
+
             id: String,
+
             data: String,
+
             expires_at: Integer,
+
             transcript: String
-          ).returns(T.attached_class)
+          )
+            .returns(T.attached_class)
         end
         def self.new(
+
           # Unique identifier for this audio response.
           id:,
+
           # Base64 encoded audio bytes generated by the model, in the format specified in
           # the request.
           data:,
+
           # The Unix timestamp (in seconds) for when this audio response will no longer be
           # accessible on the server for use in multi-turn conversations.
           expires_at:,
+
           # Transcript of the audio generated by the model.
+
           transcript:
         )
         end
 
         sig do
           override.returns(
-            {
-              id: String,
-              data: String,
-              expires_at: Integer,
-              transcript: String
-            }
+            {id: String, data: String, expires_at: Integer, transcript: String}
           )
         end
         def to_hash
         end
+
       end
+
     end
+
   end
 end