openai 0.67.0 → 0.69.0

data/rbi/openai/models/beta/beta_function_shell_tool.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaFunctionShellTool = Beta::BetaFunctionShellTool
+
+    module Beta
+      class BetaFunctionShellTool < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaFunctionShellTool,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The type of the shell tool. Always `shell`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The tool invocation context(s).
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                OpenAI::Beta::BetaFunctionShellTool::AllowedCaller::OrSymbol
+              ]
+            )
+          )
+        end
+        attr_accessor :allowed_callers
+
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                OpenAI::Beta::BetaContainerAuto,
+                OpenAI::Beta::BetaLocalEnvironment,
+                OpenAI::Beta::BetaContainerReference
+              )
+            )
+          )
+        end
+        attr_accessor :environment
+
+        # A tool that allows the model to execute shell commands.
+        sig do
+          params(
+            allowed_callers:
+              T.nilable(
+                T::Array[
+                  OpenAI::Beta::BetaFunctionShellTool::AllowedCaller::OrSymbol
+                ]
+              ),
+            environment:
+              T.nilable(
+                T.any(
+                  OpenAI::Beta::BetaContainerAuto::OrHash,
+                  OpenAI::Beta::BetaLocalEnvironment::OrHash,
+                  OpenAI::Beta::BetaContainerReference::OrHash
+                )
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The tool invocation context(s).
+          allowed_callers: nil,
+          environment: nil,
+          # The type of the shell tool. Always `shell`.
+          type: :shell
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: Symbol,
+              allowed_callers:
+                T.nilable(
+                  T::Array[
+                    OpenAI::Beta::BetaFunctionShellTool::AllowedCaller::OrSymbol
+                  ]
+                ),
+              environment:
+                T.nilable(
+                  T.any(
+                    OpenAI::Beta::BetaContainerAuto,
+                    OpenAI::Beta::BetaLocalEnvironment,
+                    OpenAI::Beta::BetaContainerReference
+                  )
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module AllowedCaller
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaFunctionShellTool::AllowedCaller)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DIRECT =
+            T.let(
+              :direct,
+              OpenAI::Beta::BetaFunctionShellTool::AllowedCaller::TaggedSymbol
+            )
+          PROGRAMMATIC =
+            T.let(
+              :programmatic,
+              OpenAI::Beta::BetaFunctionShellTool::AllowedCaller::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaFunctionShellTool::AllowedCaller::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Environment
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaContainerAuto,
+                OpenAI::Beta::BetaLocalEnvironment,
+                OpenAI::Beta::BetaContainerReference
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaFunctionShellTool::Environment::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_function_tool.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaFunctionTool = Beta::BetaFunctionTool
+
+    module Beta
+      class BetaFunctionTool < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::BetaFunctionTool, OpenAI::Internal::AnyHash)
+          end
+
+        # The name of the function to call.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # A JSON schema object describing the parameters of the function.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :parameters
+
+        # Whether strict parameter validation is enforced for this function tool.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :strict
+
+        # The type of the function tool. Always `function`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The tool invocation context(s).
+        sig do
+          returns(
+            T.nilable(
+              T::Array[OpenAI::Beta::BetaFunctionTool::AllowedCaller::OrSymbol]
+            )
+          )
+        end
+        attr_accessor :allowed_callers
+
+        # Whether this function is deferred and loaded via tool search.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :defer_loading
+
+        sig { params(defer_loading: T::Boolean).void }
+        attr_writer :defer_loading
+
+        # A description of the function. Used by the model to determine whether or not to
+        # call the function.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # A JSON schema object describing the JSON value encoded in string outputs for
+        # this function.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :output_schema
+
+        # Defines a function in your own code the model can choose to call. Learn more
+        # about
+        # [function calling](https://platform.openai.com/docs/guides/function-calling).
+        sig do
+          params(
+            name: String,
+            parameters: T.nilable(T::Hash[Symbol, T.anything]),
+            strict: T.nilable(T::Boolean),
+            allowed_callers:
+              T.nilable(
+                T::Array[
+                  OpenAI::Beta::BetaFunctionTool::AllowedCaller::OrSymbol
+                ]
+              ),
+            defer_loading: T::Boolean,
+            description: T.nilable(String),
+            output_schema: T.nilable(T::Hash[Symbol, T.anything]),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The name of the function to call.
+          name:,
+          # A JSON schema object describing the parameters of the function.
+          parameters:,
+          # Whether strict parameter validation is enforced for this function tool.
+          strict:,
+          # The tool invocation context(s).
+          allowed_callers: nil,
+          # Whether this function is deferred and loaded via tool search.
+          defer_loading: nil,
+          # A description of the function. Used by the model to determine whether or not to
+          # call the function.
+          description: nil,
+          # A JSON schema object describing the JSON value encoded in string outputs for
+          # this function.
+          output_schema: nil,
+          # The type of the function tool. Always `function`.
+          type: :function
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: String,
+              parameters: T.nilable(T::Hash[Symbol, T.anything]),
+              strict: T.nilable(T::Boolean),
+              type: Symbol,
+              allowed_callers:
+                T.nilable(
+                  T::Array[
+                    OpenAI::Beta::BetaFunctionTool::AllowedCaller::OrSymbol
+                  ]
+                ),
+              defer_loading: T::Boolean,
+              description: T.nilable(String),
+              output_schema: T.nilable(T::Hash[Symbol, T.anything])
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module AllowedCaller
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaFunctionTool::AllowedCaller)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DIRECT =
+            T.let(
+              :direct,
+              OpenAI::Beta::BetaFunctionTool::AllowedCaller::TaggedSymbol
+            )
+          PROGRAMMATIC =
+            T.let(
+              :programmatic,
+              OpenAI::Beta::BetaFunctionTool::AllowedCaller::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaFunctionTool::AllowedCaller::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_inline_skill.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaInlineSkill = Beta::BetaInlineSkill
+
+    module Beta
+      class BetaInlineSkill < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::BetaInlineSkill, OpenAI::Internal::AnyHash)
+          end
+
+        # The description of the skill.
+        sig { returns(String) }
+        attr_accessor :description
+
+        # The name of the skill.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Inline skill payload
+        sig { returns(OpenAI::Beta::BetaInlineSkillSource) }
+        attr_reader :source
+
+        sig { params(source: OpenAI::Beta::BetaInlineSkillSource::OrHash).void }
+        attr_writer :source
+
+        # Defines an inline skill for this request.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            description: String,
+            name: String,
+            source: OpenAI::Beta::BetaInlineSkillSource::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The description of the skill.
+          description:,
+          # The name of the skill.
+          name:,
+          # Inline skill payload
+          source:,
+          # Defines an inline skill for this request.
+          type: :inline
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              description: String,
+              name: String,
+              source: OpenAI::Beta::BetaInlineSkillSource,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_inline_skill_source.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaInlineSkillSource = Beta::BetaInlineSkillSource
+
+    module Beta
+      class BetaInlineSkillSource < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaInlineSkillSource,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Base64-encoded skill zip bundle.
+        sig { returns(String) }
+        attr_accessor :data
+
+        # The media type of the inline skill payload. Must be `application/zip`.
+        sig { returns(Symbol) }
+        attr_accessor :media_type
+
+        # The type of the inline skill source. Must be `base64`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Inline skill payload
+        sig do
+          params(data: String, media_type: Symbol, type: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Base64-encoded skill zip bundle.
+          data:,
+          # The media type of the inline skill payload. Must be `application/zip`.
+          media_type: :"application/zip",
+          # The type of the inline skill source. Must be `base64`.
+          type: :base64
+        )
+        end
+
+        sig do
+          override.returns({ data: String, media_type: Symbol, type: Symbol })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_local_environment.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaLocalEnvironment = Beta::BetaLocalEnvironment
+
+    module Beta
+      class BetaLocalEnvironment < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::BetaLocalEnvironment, OpenAI::Internal::AnyHash)
+          end
+
+        # Use a local computer environment.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # An optional list of skills.
+        sig { returns(T.nilable(T::Array[OpenAI::Beta::BetaLocalSkill])) }
+        attr_reader :skills
+
+        sig do
+          params(skills: T::Array[OpenAI::Beta::BetaLocalSkill::OrHash]).void
+        end
+        attr_writer :skills
+
+        sig do
+          params(
+            skills: T::Array[OpenAI::Beta::BetaLocalSkill::OrHash],
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An optional list of skills.
+          skills: nil,
+          # Use a local computer environment.
+          type: :local
+        )
+        end
+
+        sig do
+          override.returns(
+            { type: Symbol, skills: T::Array[OpenAI::Beta::BetaLocalSkill] }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_local_skill.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaLocalSkill = Beta::BetaLocalSkill
+
+    module Beta
+      class BetaLocalSkill < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::BetaLocalSkill, OpenAI::Internal::AnyHash)
+          end
+
+        # The description of the skill.
+        sig { returns(String) }
+        attr_accessor :description
+
+        # The name of the skill.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The path to the directory containing the skill.
+        sig { returns(String) }
+        attr_accessor :path
+
+        sig do
+          params(description: String, name: String, path: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The description of the skill.
+          description:,
+          # The name of the skill.
+          name:,
+          # The path to the directory containing the skill.
+          path:
+        )
+        end
+
+        sig do
+          override.returns({ description: String, name: String, path: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end