openai 0.16.0 → 0.17.0

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

data/rbi/openai/models/chat/chat_completion_message_custom_tool_call.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionMessageCustomToolCall =
+      Chat::ChatCompletionMessageCustomToolCall
+
+    module Chat
+      class ChatCompletionMessageCustomToolCall < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionMessageCustomToolCall,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the tool call.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The custom tool that the model called.
+        sig do
+          returns(OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom)
+        end
+        attr_reader :custom
+
+        sig do
+          params(
+            custom:
+              OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom::OrHash
+          ).void
+        end
+        attr_writer :custom
+
+        # The type of the tool. Always `custom`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A call to a custom tool created by the model.
+        sig do
+          params(
+            id: String,
+            custom:
+              OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the tool call.
+          id:,
+          # The custom tool that the model called.
+          custom:,
+          # The type of the tool. Always `custom`.
+          type: :custom
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              custom: OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Custom < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The input for the custom tool call generated by the model.
+          sig { returns(String) }
+          attr_accessor :input
+
+          # The name of the custom tool to call.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # The custom tool that the model called.
+          sig { params(input: String, name: String).returns(T.attached_class) }
+          def self.new(
+            # The input for the custom tool call generated by the model.
+            input:,
+            # The name of the custom tool to call.
+            name:
+          )
+          end
+
+          sig { override.returns({ input: String, name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionMessageFunctionToolCall =
+      Chat::ChatCompletionMessageFunctionToolCall
+
+    module Chat
+      class ChatCompletionMessageFunctionToolCall < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionMessageFunctionToolCall,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the tool call.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The function that the model called.
+        sig do
+          returns(OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function)
+        end
+        attr_reader :function
+
+        sig do
+          params(
+            function:
+              OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function::OrHash
+          ).void
+        end
+        attr_writer :function
+
+        # The type of the tool. Currently, only `function` is supported.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A call to a function tool created by the model.
+        sig do
+          params(
+            id: String,
+            function:
+              OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the tool call.
+          id:,
+          # The function that the model called.
+          function:,
+          # The type of the tool. Currently, only `function` is supported.
+          type: :function
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              function:
+                OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Function < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function,
+                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
+          # hallucinate parameters not defined by your function schema. Validate the
+          # arguments in your code before calling your function.
+          sig { returns(String) }
+          attr_accessor :arguments
+
+          # The parsed contents of the arguments.
+          sig { returns(T.anything) }
+          attr_accessor :parsed
+
+          # The name of the function to call.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # The function that the model called.
+          sig do
+            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 }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/chat/chat_completion_message_tool_call.rbi

@@ -5,107 +5,24 @@ module OpenAI
     ChatCompletionMessageToolCall = Chat::ChatCompletionMessageToolCall
 
     module Chat
-      class ChatCompletionMessageToolCall < OpenAI::Internal::Type::BaseModel
-        OrHash =
+      # A call to a function tool created by the model.
+      module ChatCompletionMessageToolCall
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
           T.type_alias do
             T.any(
-              OpenAI::Chat::ChatCompletionMessageToolCall,
-              OpenAI::Internal::AnyHash
+              OpenAI::Chat::ChatCompletionMessageFunctionToolCall,
+              OpenAI::Chat::ChatCompletionMessageCustomToolCall
             )
           end
 
-        # The ID of the tool call.
-        sig { returns(String) }
-        attr_accessor :id
-
-        # The function that the model called.
-        sig { returns(OpenAI::Chat::ChatCompletionMessageToolCall::Function) }
-        attr_reader :function
-
-        sig do
-          params(
-            function:
-              OpenAI::Chat::ChatCompletionMessageToolCall::Function::OrHash
-          ).void
-        end
-        attr_writer :function
-
-        # The type of the tool. Currently, only `function` is supported.
-        sig { returns(Symbol) }
-        attr_accessor :type
-
-        sig do
-          params(
-            id: String,
-            function:
-              OpenAI::Chat::ChatCompletionMessageToolCall::Function::OrHash,
-            type: Symbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The ID of the tool call.
-          id:,
-          # The function that the model called.
-          function:,
-          # The type of the tool. Currently, only `function` is supported.
-          type: :function
-        )
-        end
-
         sig do
           override.returns(
-            {
-              id: String,
-              function: OpenAI::Chat::ChatCompletionMessageToolCall::Function,
-              type: Symbol
-            }
+            T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::Variants]
           )
         end
-        def to_hash
-        end
-
-        class Function < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Chat::ChatCompletionMessageToolCall::Function,
-                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
-          # hallucinate parameters not defined by your function schema. Validate the
-          # arguments in your code before calling your function.
-          sig { returns(String) }
-          attr_accessor :arguments
-
-          # The parsed contents of the arguments.
-          sig { returns(T.anything) }
-          attr_accessor :parsed
-
-          # The name of the function to call.
-          sig { returns(String) }
-          attr_accessor :name
-
-          # The function that the model called.
-          sig do
-            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 }) }
-          def to_hash
-          end
+        def self.variants
         end
       end
     end

data/rbi/openai/models/chat/chat_completion_named_tool_choice.rbi

@@ -25,7 +25,7 @@ module OpenAI
         end
         attr_writer :function
 
-        # The type of the tool. Currently, only `function` is supported.
+        # For function calling, the type is always `function`.
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -40,7 +40,7 @@ module OpenAI
         end
         def self.new(
           function:,
-          # The type of the tool. Currently, only `function` is supported.
+          # For function calling, the type is always `function`.
           type: :function
         )
         end

data/rbi/openai/models/chat/chat_completion_named_tool_choice_custom.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionNamedToolChoiceCustom =
+      Chat::ChatCompletionNamedToolChoiceCustom
+
+    module Chat
+      class ChatCompletionNamedToolChoiceCustom < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionNamedToolChoiceCustom,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom)
+        end
+        attr_reader :custom
+
+        sig do
+          params(
+            custom:
+              OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom::OrHash
+          ).void
+        end
+        attr_writer :custom
+
+        # For custom tool calling, the type is always `custom`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Specifies a tool the model should use. Use to force the model to call a specific
+        # custom tool.
+        sig do
+          params(
+            custom:
+              OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          custom:,
+          # For custom tool calling, the type is always `custom`.
+          type: :custom
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              custom: OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Custom < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The name of the custom tool to call.
+          sig { returns(String) }
+          attr_accessor :name
+
+          sig { params(name: String).returns(T.attached_class) }
+          def self.new(
+            # The name of the custom tool to call.
+            name:
+          )
+          end
+
+          sig { override.returns({ name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/chat/chat_completion_stream_options.rbi

@@ -14,6 +14,18 @@ module OpenAI
             )
           end
 
+        # When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        # characters to an `obfuscation` field on streaming delta events to normalize
+        # payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        # fields are included by default, but add a small amount of overhead to the data
+        # stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        # you trust the network links between your application and the OpenAI API.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_obfuscation
+
+        sig { params(include_obfuscation: T::Boolean).void }
+        attr_writer :include_obfuscation
+
         # If set, an additional chunk will be streamed before the `data: [DONE]` message.
         # The `usage` field on this chunk shows the token usage statistics for the entire
         # request, and the `choices` field will always be an empty array.
@@ -28,8 +40,20 @@ module OpenAI
         attr_writer :include_usage
 
         # Options for streaming response. Only set this when you set `stream: true`.
-        sig { params(include_usage: T::Boolean).returns(T.attached_class) }
+        sig do
+          params(
+            include_obfuscation: T::Boolean,
+            include_usage: T::Boolean
+          ).returns(T.attached_class)
+        end
         def self.new(
+          # When true, stream obfuscation will be enabled. Stream obfuscation adds random
+          # characters to an `obfuscation` field on streaming delta events to normalize
+          # payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+          # fields are included by default, but add a small amount of overhead to the data
+          # stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+          # you trust the network links between your application and the OpenAI API.
+          include_obfuscation: nil,
           # If set, an additional chunk will be streamed before the `data: [DONE]` message.
           # The `usage` field on this chunk shows the token usage statistics for the entire
           # request, and the `choices` field will always be an empty array.
@@ -41,7 +65,11 @@ module OpenAI
         )
         end
 
-        sig { override.returns({ include_usage: T::Boolean }) }
+        sig do
+          override.returns(
+            { include_obfuscation: T::Boolean, include_usage: T::Boolean }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/chat/chat_completion_tool.rbi

@@ -5,41 +5,22 @@ module OpenAI
     ChatCompletionTool = Chat::ChatCompletionTool
 
     module Chat
-      class ChatCompletionTool < OpenAI::Internal::Type::BaseModel
-        OrHash =
+      # A function tool that can be used to generate a response.
+      module ChatCompletionTool
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
           T.type_alias do
-            T.any(OpenAI::Chat::ChatCompletionTool, OpenAI::Internal::AnyHash)
+            T.any(
+              OpenAI::Chat::ChatCompletionFunctionTool,
+              OpenAI::Chat::ChatCompletionCustomTool
+            )
           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
-
-        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 }
-          )
+          override.returns(T::Array[OpenAI::Chat::ChatCompletionTool::Variants])
         end
-        def to_hash
+        def self.variants
         end
       end
     end

data/rbi/openai/models/chat/chat_completion_tool_choice_option.rbi

@@ -21,7 +21,9 @@ module OpenAI
           T.type_alias do
             T.any(
               OpenAI::Chat::ChatCompletionToolChoiceOption::Auto::TaggedSymbol,
-              OpenAI::Chat::ChatCompletionNamedToolChoice
+              OpenAI::Chat::ChatCompletionAllowedToolChoice,
+              OpenAI::Chat::ChatCompletionNamedToolChoice,
+              OpenAI::Chat::ChatCompletionNamedToolChoiceCustom
             )
           end