openai 0.83.0 → 0.85.0

data/rbi/openai/models/beta/beta_response_configuration_update_item_param.rbi

@@ -0,0 +1,207 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    BetaResponseConfigurationUpdateItemParam = Beta::BetaResponseConfigurationUpdateItemParam
+
+    module Beta
+
+      class BetaResponseConfigurationUpdateItemParam < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::BetaResponseConfigurationUpdateItemParam,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The item type. Always `configuration_update`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The unique ID of the configuration update item.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # The agent that produced this item.
+        sig { returns(T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent)) }
+        attr_reader :agent
+
+        sig { params(agent: T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent::OrHash)).void }
+        attr_writer :agent
+
+        # Updates to reasoning configuration. Only effort is supported.
+        sig { returns(T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning)) }
+        attr_reader :reasoning
+
+        sig { params(reasoning: OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::OrHash).void }
+        attr_writer :reasoning
+
+        # An update to the conversation's response configuration. The configuration
+        # remains in effect for subsequent responses until it is replaced by another
+        # configuration update.
+        sig do
+          params(
+
+            id: T.nilable(String),
+
+            agent: T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent::OrHash),
+
+            reasoning: OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::OrHash,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The unique ID of the configuration update item.
+          id: nil,
+
+          # The agent that produced this item.
+          agent: nil,
+
+          # Updates to reasoning configuration. Only effort is supported.
+          reasoning: nil,
+
+          # The item type. Always `configuration_update`.
+
+          type: :configuration_update
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: Symbol,
+              id: T.nilable(String),
+              agent: T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent),
+              reasoning: OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The canonical name of the agent that produced this item.
+          sig { returns(String) }
+          attr_accessor :agent_name
+
+          # The agent that produced this item.
+          sig do
+            params(
+
+              agent_name: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The canonical name of the agent that produced this item.
+
+            agent_name:
+          )
+          end
+
+          sig do
+            override.returns(
+              {agent_name: String}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+        class Reasoning < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The reasoning effort to use for subsequent responses until another configuration
+          # update replaces it.
+          sig {
+            returns(T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::OrSymbol))
+          }
+          attr_accessor :effort
+
+          # Updates to reasoning configuration. Only effort is supported.
+          sig do
+            params(
+
+              effort: T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::OrSymbol)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The reasoning effort to use for subsequent responses until another configuration
+            # update replaces it.
+
+            effort: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {effort: T.nilable(OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::OrSymbol)}
+            )
+          end
+          def to_hash
+          end
+
+          # The reasoning effort to use for subsequent responses until another configuration
+          # update replaces it.
+          module Effort
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NONE = T.let(:none, OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol)
+            MINIMAL = T.let(
+              :minimal,
+              OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol
+            )
+            LOW = T.let(:low, OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol)
+            MEDIUM = T.let(
+              :medium,
+              OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol
+            )
+            HIGH = T.let(:high, OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol)
+            XHIGH = T.let(
+              :xhigh,
+              OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol
+            )
+            MAX = T.let(:max, OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::Effort::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/beta_response_custom_tool_call.rbi

@@ -46,6 +46,13 @@ module OpenAI
         sig { params(agent: T.nilable(OpenAI::Beta::BetaResponseCustomToolCall::Agent::OrHash)).void }
         attr_writer :agent
 
+        # Whether the custom tool call runs asynchronously.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :async
+
+        sig { params(async: T::Boolean).void }
+        attr_writer :async
+
         # The execution context that produced this tool call.
         sig {
           returns(
@@ -80,6 +87,8 @@ module OpenAI
 
             agent: T.nilable(OpenAI::Beta::BetaResponseCustomToolCall::Agent::OrHash),
 
+            async: T::Boolean,
+
             caller_: T.nilable(
               T.any(
                 OpenAI::Beta::BetaResponseCustomToolCall::Caller::Direct::OrHash,
@@ -110,6 +119,9 @@ module OpenAI
           # The agent that produced this item.
           agent: nil,
 
+          # Whether the custom tool call runs asynchronously.
+          async: nil,
+
           # The execution context that produced this tool call.
           caller_: nil,
 
@@ -131,6 +143,7 @@ module OpenAI
               type: Symbol,
               id: String,
               agent: T.nilable(OpenAI::Beta::BetaResponseCustomToolCall::Agent),
+              async: T::Boolean,
               caller_: T.nilable(
                 T.any(
                   OpenAI::Beta::BetaResponseCustomToolCall::Caller::Direct,

data/rbi/openai/models/beta/beta_response_custom_tool_call_item.rbi

@@ -48,6 +48,8 @@ module OpenAI
 
             agent: T.nilable(OpenAI::Beta::BetaResponseCustomToolCall::Agent::OrHash),
 
+            async: T::Boolean,
+
             caller_: T.nilable(
               T.any(
                 OpenAI::Beta::BetaResponseCustomToolCall::Caller::Direct::OrHash,
@@ -84,6 +86,9 @@ module OpenAI
           # The agent that produced this item.
           agent: nil,
 
+          # Whether the custom tool call runs asynchronously.
+          async: nil,
+
           # The execution context that produced this tool call.
           caller_: nil,
 
@@ -109,6 +114,7 @@ module OpenAI
               status: OpenAI::Beta::BetaResponseCustomToolCallItem::Status::TaggedSymbol,
               type: Symbol,
               agent: T.nilable(OpenAI::Beta::BetaResponseCustomToolCall::Agent),
+              async: T::Boolean,
               caller_: T.nilable(
                 T.any(
                   OpenAI::Beta::BetaResponseCustomToolCall::Caller::Direct,

data/rbi/openai/models/beta/beta_response_error.rbi

@@ -24,13 +24,21 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :message
 
+        sig { returns(T.nilable(OpenAI::Beta::BetaResponseError::Misalignment)) }
+        attr_reader :misalignment
+
+        sig { params(misalignment: OpenAI::Beta::BetaResponseError::Misalignment::OrHash).void }
+        attr_writer :misalignment
+
         # An error object returned when the model fails to generate a Response.
         sig do
           params(
 
             code: OpenAI::Beta::BetaResponseError::Code::OrSymbol,
 
-            message: String
+            message: String,
+
+            misalignment: OpenAI::Beta::BetaResponseError::Misalignment::OrHash
           )
             .returns(T.attached_class)
         end
@@ -40,14 +48,19 @@ module OpenAI
           code:,
 
           # A human-readable description of the error.
+          message:,
 
-          message:
+          misalignment: nil
         )
         end
 
         sig do
           override.returns(
-            {code: OpenAI::Beta::BetaResponseError::Code::TaggedSymbol, message: String}
+            {
+              code: OpenAI::Beta::BetaResponseError::Code::TaggedSymbol,
+              message: String,
+              misalignment: OpenAI::Beta::BetaResponseError::Misalignment
+            }
           )
         end
         def to_hash
@@ -65,6 +78,10 @@ module OpenAI
           INVALID_PROMPT = T.let(:invalid_prompt, OpenAI::Beta::BetaResponseError::Code::TaggedSymbol)
           DATA_RESIDENCY_MISMATCH = T.let(:data_residency_mismatch, OpenAI::Beta::BetaResponseError::Code::TaggedSymbol)
           BIO_POLICY = T.let(:bio_policy, OpenAI::Beta::BetaResponseError::Code::TaggedSymbol)
+          MISALIGNMENT_POLICY_VIOLATION = T.let(
+            :misalignment_policy_violation,
+            OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+          )
           VECTOR_STORE_TIMEOUT = T.let(:vector_store_timeout, OpenAI::Beta::BetaResponseError::Code::TaggedSymbol)
           INVALID_IMAGE = T.let(:invalid_image, OpenAI::Beta::BetaResponseError::Code::TaggedSymbol)
           INVALID_IMAGE_FORMAT = T.let(:invalid_image_format, OpenAI::Beta::BetaResponseError::Code::TaggedSymbol)
@@ -95,6 +112,147 @@ module OpenAI
           end
         end
 
+        class Misalignment < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseError::Misalignment,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The public explanation for this block.
+          sig { returns(T.nilable(String)) }
+          attr_reader :detailed_explanation
+
+          sig { params(detailed_explanation: String).void }
+          attr_writer :detailed_explanation
+
+          # An optional classification; clients must accept additional values.
+          sig { returns(T.nilable(OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::Variants)) }
+          attr_reader :error_type
+
+          sig {
+            params(error_type: T.any(String, OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::OrSymbol)).void
+          }
+          attr_writer :error_type
+
+          # An optional public continuation instruction.
+          sig { returns(T.nilable(OpenAI::Beta::BetaResponseError::Misalignment::Steer)) }
+          attr_reader :steer
+
+          sig { params(steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer::OrHash).void }
+          attr_writer :steer
+
+          sig do
+            params(
+
+              detailed_explanation: String,
+
+              error_type: T.any(String, OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::OrSymbol),
+
+              steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The public explanation for this block.
+            detailed_explanation: nil,
+
+            # An optional classification; clients must accept additional values.
+            error_type: nil,
+
+            # An optional public continuation instruction.
+
+            steer: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                detailed_explanation: String,
+                error_type: OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::Variants,
+                steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # An optional classification; clients must accept additional values.
+          module ErrorType
+            extend OpenAI::Internal::Type::Union
+
+            Variants = T.type_alias {
+              T.any(String, OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::TaggedSymbol)
+            }
+
+            sig { override.returns(T::Array[OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::Variants]) }
+            def self.variants
+            end
+
+            TaggedSymbol = T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaResponseError::Misalignment::ErrorType)
+            end
+
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            POTENTIALLY_UNINTENDED_DATA_TRANSFER = T.let(
+              :potentially_unintended_data_transfer,
+              OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::TaggedSymbol
+            )
+            POTENTIALLY_UNINTENDED_DATA_ACCESS = T.let(
+              :potentially_unintended_data_access,
+              OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::TaggedSymbol
+            )
+            POTENTIALLY_UNINTENDED_DESTRUCTIVE_ACTIVITY = T.let(
+              :potentially_unintended_destructive_activity,
+              OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::TaggedSymbol
+            )
+            OTHER = T.let(:other, OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::TaggedSymbol)
+
+          end
+
+          class Steer < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseError::Misalignment::Steer,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The public continuation instruction.
+            sig { returns(String) }
+            attr_accessor :message
+
+            # An optional public continuation instruction.
+            sig do
+              params(
+
+                message: String
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The public continuation instruction.
+
+              message:
+            )
+            end
+
+            sig do
+              override.returns(
+                {message: String}
+              )
+            end
+            def to_hash
+            end
+
+          end
+        end
+
       end
 
     end

data/rbi/openai/models/beta/beta_response_function_tool_call.rbi

@@ -46,6 +46,13 @@ module OpenAI
         sig { params(agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCall::Agent::OrHash)).void }
         attr_writer :agent
 
+        # Whether the function tool call runs asynchronously.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :async
+
+        sig { params(async: T::Boolean).void }
+        attr_writer :async
+
         # The execution context that produced this tool call.
         sig {
           returns(
@@ -90,6 +97,8 @@ module OpenAI
 
             agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCall::Agent::OrHash),
 
+            async: T::Boolean,
+
             caller_: T.nilable(
               T.any(
                 OpenAI::Beta::BetaResponseFunctionToolCall::Caller::Direct::OrHash,
@@ -122,6 +131,9 @@ module OpenAI
           # The agent that produced this item.
           agent: nil,
 
+          # Whether the function tool call runs asynchronously.
+          async: nil,
+
           # The execution context that produced this tool call.
           caller_: nil,
 
@@ -147,6 +159,7 @@ module OpenAI
               type: Symbol,
               id: String,
               agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCall::Agent),
+              async: T::Boolean,
               caller_: T.nilable(
                 T.any(
                   OpenAI::Beta::BetaResponseFunctionToolCall::Caller::Direct,

data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi

@@ -50,6 +50,8 @@ module OpenAI
 
             agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCall::Agent::OrHash),
 
+            async: T::Boolean,
+
             caller_: T.nilable(
               T.any(
                 OpenAI::Beta::BetaResponseFunctionToolCall::Caller::Direct::OrHash,
@@ -86,6 +88,9 @@ module OpenAI
           # The agent that produced this item.
           agent: nil,
 
+          # Whether the function tool call runs asynchronously.
+          async: nil,
+
           # The execution context that produced this tool call.
           caller_: nil,
 
@@ -111,6 +116,7 @@ module OpenAI
               status: OpenAI::Beta::BetaResponseFunctionToolCallItem::Status::TaggedSymbol,
               type: Symbol,
               agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCall::Agent),
+              async: T::Boolean,
               caller_: T.nilable(
                 T.any(
                   OpenAI::Beta::BetaResponseFunctionToolCall::Caller::Direct,

data/rbi/openai/models/beta/beta_response_incomplete_event.rbi

@@ -39,6 +39,10 @@ module OpenAI
         attr_writer :agent
 
         # An event that is emitted when a response finishes as incomplete.
+        #
+        # Over WebSocket, steering can finish a response with
+        # `response.incomplete_details.reason` set to `steered`, followed automatically by
+        # a successor `response.created` that commits the queued steering input.
         sig do
           params(
 

data/rbi/openai/models/beta/beta_response_inject_event.rbi

@@ -36,6 +36,7 @@ module OpenAI
                 OpenAI::Beta::BetaResponseInputItem::ToolSearchCall,
                 OpenAI::Beta::BetaResponseToolSearchOutputItemParam,
                 OpenAI::Beta::BetaResponseInputItem::AdditionalTools,
+                OpenAI::Beta::BetaResponseConfigurationUpdateItemParam,
                 OpenAI::Beta::BetaResponseReasoningItem,
                 OpenAI::Beta::BetaResponseCompactionItemParam,
                 OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall,
@@ -93,6 +94,7 @@ module OpenAI
                 OpenAI::Beta::BetaResponseInputItem::ToolSearchCall::OrHash,
                 OpenAI::Beta::BetaResponseToolSearchOutputItemParam::OrHash,
                 OpenAI::Beta::BetaResponseInputItem::AdditionalTools::OrHash,
+                OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::OrHash,
                 OpenAI::Beta::BetaResponseReasoningItem::OrHash,
                 OpenAI::Beta::BetaResponseCompactionItemParam::OrHash,
                 OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::OrHash,
@@ -156,6 +158,7 @@ module OpenAI
                   OpenAI::Beta::BetaResponseInputItem::ToolSearchCall,
                   OpenAI::Beta::BetaResponseToolSearchOutputItemParam,
                   OpenAI::Beta::BetaResponseInputItem::AdditionalTools,
+                  OpenAI::Beta::BetaResponseConfigurationUpdateItemParam,
                   OpenAI::Beta::BetaResponseReasoningItem,
                   OpenAI::Beta::BetaResponseCompactionItemParam,
                   OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall,

data/rbi/openai/models/beta/beta_response_inject_failed_event.rbi

@@ -43,6 +43,7 @@ module OpenAI
                 OpenAI::Beta::BetaResponseInputItem::ToolSearchCall,
                 OpenAI::Beta::BetaResponseToolSearchOutputItemParam,
                 OpenAI::Beta::BetaResponseInputItem::AdditionalTools,
+                OpenAI::Beta::BetaResponseConfigurationUpdateItemParam,
                 OpenAI::Beta::BetaResponseReasoningItem,
                 OpenAI::Beta::BetaResponseCompactionItemParam,
                 OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall,
@@ -114,6 +115,7 @@ module OpenAI
                 OpenAI::Beta::BetaResponseInputItem::ToolSearchCall::OrHash,
                 OpenAI::Beta::BetaResponseToolSearchOutputItemParam::OrHash,
                 OpenAI::Beta::BetaResponseInputItem::AdditionalTools::OrHash,
+                OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::OrHash,
                 OpenAI::Beta::BetaResponseReasoningItem::OrHash,
                 OpenAI::Beta::BetaResponseCompactionItemParam::OrHash,
                 OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::OrHash,
@@ -192,6 +194,7 @@ module OpenAI
                   OpenAI::Beta::BetaResponseInputItem::ToolSearchCall,
                   OpenAI::Beta::BetaResponseToolSearchOutputItemParam,
                   OpenAI::Beta::BetaResponseInputItem::AdditionalTools,
+                  OpenAI::Beta::BetaResponseConfigurationUpdateItemParam,
                   OpenAI::Beta::BetaResponseReasoningItem,
                   OpenAI::Beta::BetaResponseCompactionItemParam,
                   OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall,

data/rbi/openai/models/beta/beta_response_input_item.rbi

@@ -32,6 +32,7 @@ module OpenAI
             OpenAI::Beta::BetaResponseInputItem::ToolSearchCall,
             OpenAI::Beta::BetaResponseToolSearchOutputItemParam,
             OpenAI::Beta::BetaResponseInputItem::AdditionalTools,
+            OpenAI::Beta::BetaResponseConfigurationUpdateItemParam,
             OpenAI::Beta::BetaResponseReasoningItem,
             OpenAI::Beta::BetaResponseCompactionItemParam,
             OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall,

data/rbi/openai/models/beta/beta_response_item.rbi

@@ -27,6 +27,7 @@ module OpenAI
             OpenAI::Beta::BetaResponseToolSearchCall,
             OpenAI::Beta::BetaResponseToolSearchOutputItem,
             OpenAI::Beta::BetaResponseItem::AdditionalTools,
+            OpenAI::Beta::BetaResponseConfigurationUpdateItem,
             OpenAI::Beta::BetaResponseReasoningItem,
             OpenAI::Beta::BetaResponseItem::Program,
             OpenAI::Beta::BetaResponseItem::ProgramOutput,