openai 0.16.0 → 0.17.1

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

@@ -0,0 +1,118 @@
+# typed: strong
+
+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
+
+        # 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
+        # message.
+        #
+        # `required` requires the model to call one or more of the allowed tools.
+        sig do
+          returns(OpenAI::Chat::ChatCompletionAllowedTools::Mode::OrSymbol)
+        end
+        attr_accessor :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:
+        #
+        # ```json
+        # [
+        #   { "type": "function", "function": { "name": "get_weather" } },
+        #   { "type": "function", "function": { "name": "get_time" } }
+        # ]
+        # ```
+        sig { returns(T::Array[T::Hash[Symbol, T.anything]]) }
+        attr_accessor :tools
+
+        # 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)
+        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
+          # message.
+          #
+          # `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:
+          #
+          # ```json
+          # [
+          #   { "type": "function", "function": { "name": "get_weather" } },
+          #   { "type": "function", "function": { "name": "get_time" } }
+          # ]
+          # ```
+          tools:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              mode: OpenAI::Chat::ChatCompletionAllowedTools::Mode::OrSymbol,
+              tools: T::Array[T::Hash[Symbol, T.anything]]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # 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
+        # message.
+        #
+        # `required` requires the model to call one or more of the allowed tools.
+        module Mode
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Chat::ChatCompletionAllowedTools::Mode)
+            end
+          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
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -85,7 +85,14 @@ module OpenAI
         # The tool calls generated by the model, such as function calls.
         sig do
           returns(
-            T.nilable(T::Array[OpenAI::Chat::ChatCompletionMessageToolCall])
+            T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall,
+                  OpenAI::Chat::ChatCompletionMessageCustomToolCall
+                )
+              ]
+            )
           )
         end
         attr_reader :tool_calls
@@ -93,7 +100,12 @@ module OpenAI
         sig do
           params(
             tool_calls:
-              T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::OrHash]
+              T::Array[
+                T.any(
+                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
+                  OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
+                )
+              ]
           ).void
         end
         attr_writer :tool_calls
@@ -116,7 +128,12 @@ module OpenAI
             name: String,
             refusal: T.nilable(String),
             tool_calls:
-              T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::OrHash],
+              T::Array[
+                T.any(
+                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
+                  OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
+                )
+              ],
             role: Symbol
           ).returns(T.attached_class)
         end
@@ -160,7 +177,13 @@ module OpenAI
                 ),
               name: String,
               refusal: T.nilable(String),
-              tool_calls: T::Array[OpenAI::Chat::ChatCompletionMessageToolCall]
+              tool_calls:
+                T::Array[
+                  T.any(
+                    OpenAI::Chat::ChatCompletionMessageFunctionToolCall,
+                    OpenAI::Chat::ChatCompletionMessageCustomToolCall
+                  )
+                ]
             }
           )
         end

data/rbi/openai/models/chat/chat_completion_custom_tool.rbi

@@ -0,0 +1,335 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionCustomTool = Chat::ChatCompletionCustomTool
+
+    module Chat
+      class ChatCompletionCustomTool < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionCustomTool,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Properties of the custom tool.
+        sig { returns(OpenAI::Chat::ChatCompletionCustomTool::Custom) }
+        attr_reader :custom
+
+        sig do
+          params(
+            custom: OpenAI::Chat::ChatCompletionCustomTool::Custom::OrHash
+          ).void
+        end
+        attr_writer :custom
+
+        # The type of the custom tool. Always `custom`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A custom tool that processes input using a specified format.
+        sig do
+          params(
+            custom: OpenAI::Chat::ChatCompletionCustomTool::Custom::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Properties of the custom tool.
+          custom:,
+          # The type of the custom tool. Always `custom`.
+          type: :custom
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              custom: OpenAI::Chat::ChatCompletionCustomTool::Custom,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Custom < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Chat::ChatCompletionCustomTool::Custom,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The name of the custom tool, used to identify it in tool calls.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Optional description of the custom tool, used to provide more context.
+          sig { returns(T.nilable(String)) }
+          attr_reader :description
+
+          sig { params(description: String).void }
+          attr_writer :description
+
+          # The input format for the custom tool. Default is unconstrained text.
+          sig do
+            returns(
+              T.nilable(
+                T.any(
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Text,
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar
+                )
+              )
+            )
+          end
+          attr_reader :format_
+
+          sig do
+            params(
+              format_:
+                T.any(
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Text::OrHash,
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::OrHash
+                )
+            ).void
+          end
+          attr_writer :format_
+
+          # Properties of the custom tool.
+          sig do
+            params(
+              name: String,
+              description: String,
+              format_:
+                T.any(
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Text::OrHash,
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the custom tool, used to identify it in tool calls.
+            name:,
+            # Optional description of the custom tool, used to provide more context.
+            description: nil,
+            # The input format for the custom tool. Default is unconstrained text.
+            format_: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name: String,
+                description: String,
+                format_:
+                  T.any(
+                    OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Text,
+                    OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The input format for the custom tool. Default is unconstrained text.
+          module Format
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Text,
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar
+                )
+              end
+
+            class Text < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Text,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Unconstrained text format. Always `text`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Unconstrained free-form text.
+              sig { params(type: Symbol).returns(T.attached_class) }
+              def self.new(
+                # Unconstrained text format. Always `text`.
+                type: :text
+              )
+              end
+
+              sig { override.returns({ type: Symbol }) }
+              def to_hash
+              end
+            end
+
+            class Grammar < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Your chosen grammar.
+              sig do
+                returns(
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar
+                )
+              end
+              attr_reader :grammar
+
+              sig do
+                params(
+                  grammar:
+                    OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::OrHash
+                ).void
+              end
+              attr_writer :grammar
+
+              # Grammar format. Always `grammar`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # A grammar defined by the user.
+              sig do
+                params(
+                  grammar:
+                    OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::OrHash,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Your chosen grammar.
+                grammar:,
+                # Grammar format. Always `grammar`.
+                type: :grammar
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    grammar:
+                      OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar,
+                    type: Symbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Grammar < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # The grammar definition.
+                sig { returns(String) }
+                attr_accessor :definition
+
+                # The syntax of the grammar definition. One of `lark` or `regex`.
+                sig do
+                  returns(
+                    OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax::OrSymbol
+                  )
+                end
+                attr_accessor :syntax
+
+                # Your chosen grammar.
+                sig do
+                  params(
+                    definition: String,
+                    syntax:
+                      OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax::OrSymbol
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # The grammar definition.
+                  definition:,
+                  # The syntax of the grammar definition. One of `lark` or `regex`.
+                  syntax:
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      definition: String,
+                      syntax:
+                        OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax::OrSymbol
+                    }
+                  )
+                end
+                def to_hash
+                end
+
+                # The syntax of the grammar definition. One of `lark` or `regex`.
+                module Syntax
+                  extend OpenAI::Internal::Type::Enum
+
+                  TaggedSymbol =
+                    T.type_alias do
+                      T.all(
+                        Symbol,
+                        OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax
+                      )
+                    end
+                  OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                  LARK =
+                    T.let(
+                      :lark,
+                      OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax::TaggedSymbol
+                    )
+                  REGEX =
+                    T.let(
+                      :regex,
+                      OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax::TaggedSymbol
+                    )
+
+                  sig do
+                    override.returns(
+                      T::Array[
+                        OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax::TaggedSymbol
+                      ]
+                    )
+                  end
+                  def self.values
+                  end
+                end
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/chat/chat_completion_function_tool.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionFunctionTool = Chat::ChatCompletionFunctionTool
+
+    module Chat
+      class ChatCompletionFunctionTool < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionFunctionTool,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(OpenAI::FunctionDefinition) }
+        attr_reader :function
+
+        sig { params(function: OpenAI::FunctionDefinition::OrHash).void }
+        attr_writer :function
+
+        # The type of the tool. Currently, only `function` is supported.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A function tool that can be used to generate a response.
+        sig do
+          params(
+            function: OpenAI::FunctionDefinition::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          function:,
+          # The type of the tool. Currently, only `function` is supported.
+          type: :function
+        )
+        end
+
+        sig do
+          override.returns(
+            { function: OpenAI::FunctionDefinition, type: Symbol }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/chat/chat_completion_message.rbi

@@ -78,7 +78,9 @@ module OpenAI
         # The tool calls generated by the model, such as function calls.
         sig do
           returns(
-            T.nilable(T::Array[OpenAI::Chat::ChatCompletionMessageToolCall])
+            T.nilable(
+              T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::Variants]
+            )
           )
         end
         attr_reader :tool_calls
@@ -86,7 +88,12 @@ module OpenAI
         sig do
           params(
             tool_calls:
-              T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::OrHash]
+              T::Array[
+                T.any(
+                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
+                  OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
+                )
+              ]
           ).void
         end
         attr_writer :tool_calls
@@ -102,7 +109,12 @@ module OpenAI
             function_call:
               OpenAI::Chat::ChatCompletionMessage::FunctionCall::OrHash,
             tool_calls:
-              T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::OrHash],
+              T::Array[
+                T.any(
+                  OpenAI::Chat::ChatCompletionMessageFunctionToolCall::OrHash,
+                  OpenAI::Chat::ChatCompletionMessageCustomToolCall::OrHash
+                )
+              ],
             role: Symbol
           ).returns(T.attached_class)
         end
@@ -138,7 +150,8 @@ module OpenAI
                 T::Array[OpenAI::Chat::ChatCompletionMessage::Annotation],
               audio: T.nilable(OpenAI::Chat::ChatCompletionAudio),
               function_call: OpenAI::Chat::ChatCompletionMessage::FunctionCall,
-              tool_calls: T::Array[OpenAI::Chat::ChatCompletionMessageToolCall]
+              tool_calls:
+                T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::Variants]
             }
           )
         end