openai 0.88.0 → 0.89.0

data/rbi/openai/models/live/responses_delegation_config.rbi

@@ -0,0 +1,562 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Live
+
+      class ResponsesDelegationConfig < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Live::ResponsesDelegationConfig,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The model used for server-owned Responses delegations.
+        sig { returns(String) }
+        attr_accessor :model
+
+        # Instructions for the delegated Responses model, separate from Live instructions.
+        # See
+        # [backend prompting](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+        sig { returns(T.nilable(String)) }
+        attr_accessor :instructions
+
+        # Maximum number of output tokens for each delegated response.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :max_output_tokens
+
+        # Whether the delegated Responses model may request multiple tool calls in a
+        # single response.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :parallel_tool_calls
+
+        # Reasoning settings passed to each delegated Responses request.
+        sig { returns(T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning)) }
+        attr_reader :reasoning
+
+        sig { params(reasoning: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::OrHash)).void }
+        attr_writer :reasoning
+
+        # Service tier for delegated Responses requests.
+        sig { returns(T.nilable(OpenAI::Live::ResponsesDelegationConfig::ServiceTier::OrSymbol)) }
+        attr_accessor :service_tier
+
+        # Text generation settings passed to each delegated Responses request.
+        sig { returns(T.nilable(OpenAI::Live::ResponsesDelegationConfig::Text)) }
+        attr_reader :text
+
+        sig { params(text: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Text::OrHash)).void }
+        attr_writer :text
+
+        # Controls which tool the Responses backend uses when handling a task delegated by
+        # the Live model.
+        sig {
+          returns(
+            T.nilable(
+              T.any(
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::OrSymbol,
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveFunctionToolChoiceParam,
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveMCPToolChoiceParam
+              )
+            )
+          )
+        }
+        attr_reader :tool_choice
+
+        sig {
+          params(
+            tool_choice: T.any(
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::OrSymbol,
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveFunctionToolChoiceParam::OrHash,
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveMCPToolChoiceParam::OrHash
+            )
+          )
+            .void
+        }
+        attr_writer :tool_choice
+
+        # Tools available to the Responses backend while it handles tasks delegated by the
+        # Live model.
+        sig {
+          returns(
+            T.nilable(
+              T::Array[T.any(OpenAI::Live::FunctionTool, OpenAI::Live::ResponsesDelegationConfig::Tool::WebSearch)]
+            )
+          )
+        }
+        attr_reader :tools
+
+        sig {
+          params(
+            tools: T::Array[
+              T.any(
+                OpenAI::Live::FunctionTool::OrHash,
+                OpenAI::Live::ResponsesDelegationConfig::Tool::WebSearch::OrHash
+              )
+            ]
+          )
+            .void
+        }
+        attr_writer :tools
+
+        # Model, prompt, and tool settings for tasks delegated by the Live session to a
+        # Responses backend.
+        sig do
+          params(
+
+            model: String,
+
+            instructions: T.nilable(String),
+
+            max_output_tokens: T.nilable(Integer),
+
+            parallel_tool_calls: T.nilable(T::Boolean),
+
+            reasoning: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::OrHash),
+
+            service_tier: T.nilable(OpenAI::Live::ResponsesDelegationConfig::ServiceTier::OrSymbol),
+
+            text: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Text::OrHash),
+
+            tool_choice: T.any(
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::OrSymbol,
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveFunctionToolChoiceParam::OrHash,
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveMCPToolChoiceParam::OrHash
+            ),
+
+            tools: T::Array[
+              T.any(
+                OpenAI::Live::FunctionTool::OrHash,
+                OpenAI::Live::ResponsesDelegationConfig::Tool::WebSearch::OrHash
+              )
+            ]
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The model used for server-owned Responses delegations.
+          model:,
+
+          # Instructions for the delegated Responses model, separate from Live instructions.
+          # See
+          # [backend prompting](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+          instructions: nil,
+
+          # Maximum number of output tokens for each delegated response.
+          max_output_tokens: nil,
+
+          # Whether the delegated Responses model may request multiple tool calls in a
+          # single response.
+          parallel_tool_calls: nil,
+
+          # Reasoning settings passed to each delegated Responses request.
+          reasoning: nil,
+
+          # Service tier for delegated Responses requests.
+          service_tier: nil,
+
+          # Text generation settings passed to each delegated Responses request.
+          text: nil,
+
+          # Controls which tool the Responses backend uses when handling a task delegated by
+          # the Live model.
+          tool_choice: nil,
+
+          # Tools available to the Responses backend while it handles tasks delegated by the
+          # Live model.
+
+          tools: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              model: String,
+              instructions: T.nilable(String),
+              max_output_tokens: T.nilable(Integer),
+              parallel_tool_calls: T.nilable(T::Boolean),
+              reasoning: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning),
+              service_tier: T.nilable(OpenAI::Live::ResponsesDelegationConfig::ServiceTier::OrSymbol),
+              text: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Text),
+              tool_choice: T.any(
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::OrSymbol,
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveFunctionToolChoiceParam,
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveMCPToolChoiceParam
+              ),
+              tools: T::Array[
+                T.any(OpenAI::Live::FunctionTool, OpenAI::Live::ResponsesDelegationConfig::Tool::WebSearch)
+              ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Reasoning < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::ResponsesDelegationConfig::Reasoning,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # How much reasoning effort the delegated Responses model should use. Supported
+          # values depend on the backend model.
+          sig { returns(T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::OrSymbol)) }
+          attr_accessor :effort
+
+          # The reasoning summary to request from the delegated Responses model, when
+          # supported.
+          sig { returns(T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary::OrSymbol)) }
+          attr_accessor :summary
+
+          # Reasoning settings passed to each delegated Responses request.
+          sig do
+            params(
+
+              effort: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::OrSymbol),
+
+              summary: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary::OrSymbol)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # How much reasoning effort the delegated Responses model should use. Supported
+            # values depend on the backend model.
+            effort: nil,
+
+            # The reasoning summary to request from the delegated Responses model, when
+            # supported.
+
+            summary: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                effort: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::OrSymbol),
+                summary: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary::OrSymbol)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # How much reasoning effort the delegated Responses model should use. Supported
+          # values depend on the backend model.
+          module Effort
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NONE = T.let(:none, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::TaggedSymbol)
+            MINIMAL = T.let(:minimal, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::TaggedSymbol)
+            LOW = T.let(:low, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::TaggedSymbol)
+            HIGH = T.let(:high, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::TaggedSymbol)
+            XHIGH = T.let(:xhigh, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::TaggedSymbol)
+
+            sig {
+              override.returns(T::Array[OpenAI::Live::ResponsesDelegationConfig::Reasoning::Effort::TaggedSymbol])
+            }
+            def self.values
+            end
+          end
+
+          # The reasoning summary to request from the delegated Responses model, when
+          # supported.
+          module Summary
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONCISE = T.let(:concise, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary::TaggedSymbol)
+            DETAILED = T.let(:detailed, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary::TaggedSymbol)
+
+            sig {
+              override.returns(T::Array[OpenAI::Live::ResponsesDelegationConfig::Reasoning::Summary::TaggedSymbol])
+            }
+            def self.values
+            end
+          end
+        end
+
+        # Service tier for delegated Responses requests.
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Live::ResponsesDelegationConfig::ServiceTier) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTO = T.let(:auto, OpenAI::Live::ResponsesDelegationConfig::ServiceTier::TaggedSymbol)
+          DEFAULT = T.let(:default, OpenAI::Live::ResponsesDelegationConfig::ServiceTier::TaggedSymbol)
+          FAST_TIER_TEMP_PILOT = T.let(
+            :fast_tier_temp_pilot,
+            OpenAI::Live::ResponsesDelegationConfig::ServiceTier::TaggedSymbol
+          )
+          FLEX = T.let(:flex, OpenAI::Live::ResponsesDelegationConfig::ServiceTier::TaggedSymbol)
+          PRIORITY = T.let(:priority, OpenAI::Live::ResponsesDelegationConfig::ServiceTier::TaggedSymbol)
+          ULTRAFAST = T.let(:ultrafast, OpenAI::Live::ResponsesDelegationConfig::ServiceTier::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Live::ResponsesDelegationConfig::ServiceTier::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::ResponsesDelegationConfig::Text,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The amount of detail in text generated by the Responses backend. This does not
+          # configure the Live model’s spoken delivery.
+          sig { returns(T.nilable(OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity::OrSymbol)) }
+          attr_accessor :verbosity
+
+          # Text generation settings passed to each delegated Responses request.
+          sig do
+            params(
+
+              verbosity: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity::OrSymbol)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The amount of detail in text generated by the Responses backend. This does not
+            # configure the Live model’s spoken delivery.
+
+            verbosity: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {verbosity: T.nilable(OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity::OrSymbol)}
+            )
+          end
+          def to_hash
+          end
+
+          # The amount of detail in text generated by the Responses backend. This does not
+          # configure the Live model’s spoken delivery.
+          module Verbosity
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LOW = T.let(:low, OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity::TaggedSymbol)
+            HIGH = T.let(:high, OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Live::ResponsesDelegationConfig::Text::Verbosity::TaggedSymbol]) }
+            def self.values
+            end
+          end
+        end
+
+        # Controls which tool the Responses backend uses when handling a task delegated by
+        # the Live model.
+        module ToolChoice
+          extend OpenAI::Internal::Type::Union
+
+          Variants = T.type_alias {
+            T.any(
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::TaggedSymbol,
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveFunctionToolChoiceParam,
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveMCPToolChoiceParam
+            )
+          }
+
+          module LiveToolChoiceEnum
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AUTO = T.let(:auto, OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::TaggedSymbol)
+            NONE = T.let(:none, OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::TaggedSymbol)
+            REQUIRED = T.let(
+              :required,
+              OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::TaggedSymbol
+            )
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveToolChoiceEnum::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+          class LiveFunctionToolChoiceParam < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveFunctionToolChoiceParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(String) }
+            attr_accessor :name
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+
+                name: String,
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              name:,
+
+              type: :function
+            )
+            end
+
+            sig do
+              override.returns(
+                {name: String, type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          class LiveMCPToolChoiceParam < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Live::ResponsesDelegationConfig::ToolChoice::LiveMCPToolChoiceParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(String) }
+            attr_accessor :name
+
+            sig { returns(String) }
+            attr_accessor :server_label
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+
+                name: String,
+
+                server_label: String,
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              name:,
+
+              server_label:,
+
+              type: :mcp
+            )
+            end
+
+            sig do
+              override.returns(
+                {name: String, server_label: String, type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          sig { override.returns(T::Array[OpenAI::Live::ResponsesDelegationConfig::ToolChoice::Variants]) }
+          def self.variants
+          end
+
+        end
+
+        # A function tool available to the Responses backend when the Live model delegates
+        # a task.
+        module Tool
+          extend OpenAI::Internal::Type::Union
+
+          Variants = T.type_alias {
+            T.any(OpenAI::Live::FunctionTool, OpenAI::Live::ResponsesDelegationConfig::Tool::WebSearch)
+          }
+
+          class WebSearch < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Live::ResponsesDelegationConfig::Tool::WebSearch,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The tool type. Always `web_search`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # A web search tool available to the Live session’s Responses backend.
+            sig do
+              params(
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The tool type. Always `web_search`.
+
+              type: :web_search
+            )
+            end
+
+            sig do
+              override.returns(
+                {type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          sig { override.returns(T::Array[OpenAI::Live::ResponsesDelegationConfig::Tool::Variants]) }
+          def self.variants
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end