openai 0.84.0 → 0.86.0

data/lib/openai/response_carrier.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OpenAI
+  # Shared response metadata interface for SDK values that are not model
+  # objects, such as binary StringIO responses.
+  module ResponseCarrier
+    # The ID of the API request, returned via the x-request-id response
+    # header. This is only populated on top-level response objects returned
+    # by the client.
+    #
+    # @api public
+    #
+    # @return [String, nil]
+    def _request_id = last_response&.request_id
+
+    # Metadata from the HTTP response that produced this value.
+    #
+    # @api public
+    #
+    # @return [OpenAI::ResponseMetadata, nil]
+    attr_reader :last_response
+
+    # @api private
+    #
+    # @param response [OpenAI::ResponseMetadata]
+    # @return [self]
+    def _set_last_response(response)
+      @last_response = response
+      self
+    end
+
+    # Keep transport metadata outside Psych's object serialization path.
+    #
+    # @api private
+    #
+    # @param _coder [Psych::Coder]
+    # @return [void]
+    def encode_with(_coder)
+      nil
+    end
+  end
+end

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.84.0"
+  VERSION = "0.86.0"
 end

data/lib/openai.rb

@@ -54,6 +54,7 @@ require_relative "openai/internal/type/base_stream"
 require_relative "openai/internal/type/request_parameters"
 require_relative "openai/internal"
 require_relative "openai/request_options"
+require_relative "openai/response_carrier"
 require_relative "openai/file_part"
 require_relative "openai/errors"
 require_relative "openai/http_client"
@@ -68,6 +69,7 @@ require_relative "openai/provider"
 require_relative "openai/internal/provider"
 require_relative "openai/providers/azure"
 require_relative "openai/providers/bedrock"
+require_relative "openai/internal/transport/request_body_merge"
 require_relative "openai/internal/transport/base_client"
 require_relative "openai/helpers/client_options"
 require_relative "openai/client"
@@ -492,6 +494,8 @@ require_relative "openai/models/beta/beta_response_compaction_item_param"
 require_relative "openai/models/beta/beta_response_computer_tool_call"
 require_relative "openai/models/beta/beta_response_computer_tool_call_output_item"
 require_relative "openai/models/beta/beta_response_computer_tool_call_output_screenshot"
+require_relative "openai/models/beta/beta_response_configuration_update_item"
+require_relative "openai/models/beta/beta_response_configuration_update_item_param"
 require_relative "openai/models/beta/beta_response_container_reference"
 require_relative "openai/models/beta/beta_response_content"
 require_relative "openai/models/beta/beta_response_conversation_param"
@@ -538,6 +542,15 @@ require_relative "openai/models/beta/beta_response_reasoning_item"
 require_relative "openai/models/beta/beta_responses_client_event"
 require_relative "openai/models/beta/beta_responses_server_event"
 require_relative "openai/models/beta/beta_response_status"
+require_relative "openai/models/beta/beta_response_steer_accepted_event"
+require_relative "openai/models/beta/beta_response_steer_error_code"
+require_relative "openai/models/beta/beta_response_steer_event"
+require_relative "openai/models/beta/beta_response_steer_failed_event"
+require_relative "openai/models/beta/beta_response_steer_input"
+require_relative "openai/models/beta/beta_response_steer_input_content"
+require_relative "openai/models/beta/beta_response_steer_pending_event"
+require_relative "openai/models/beta/beta_response_steer_pending_reason"
+require_relative "openai/models/beta/beta_response_steer_required_input"
 require_relative "openai/models/beta/beta_response_stream_event"
 require_relative "openai/models/beta/beta_response_text_config"
 require_relative "openai/models/beta/beta_response_tool_search_call"
@@ -1040,6 +1053,8 @@ require_relative "openai/models/responses/response_compact_params"
 require_relative "openai/models/responses/response_computer_tool_call"
 require_relative "openai/models/responses/response_computer_tool_call_output_item"
 require_relative "openai/models/responses/response_computer_tool_call_output_screenshot"
+require_relative "openai/models/responses/response_configuration_update_item"
+require_relative "openai/models/responses/response_configuration_update_item_param"
 require_relative "openai/models/responses/response_container_reference"
 require_relative "openai/models/responses/response_content"
 require_relative "openai/models/responses/response_conversation_param"
@@ -1082,6 +1097,15 @@ require_relative "openai/models/responses/response_retrieve_params"
 require_relative "openai/models/responses/responses_client_event"
 require_relative "openai/models/responses/responses_server_event"
 require_relative "openai/models/responses/response_status"
+require_relative "openai/models/responses/response_steer_accepted_event"
+require_relative "openai/models/responses/response_steer_error_code"
+require_relative "openai/models/responses/response_steer_event"
+require_relative "openai/models/responses/response_steer_failed_event"
+require_relative "openai/models/responses/response_steer_input"
+require_relative "openai/models/responses/response_steer_input_content"
+require_relative "openai/models/responses/response_steer_pending_event"
+require_relative "openai/models/responses/response_steer_pending_reason"
+require_relative "openai/models/responses/response_steer_required_input"
 require_relative "openai/models/responses/response_stream_event"
 require_relative "openai/models/responses/response_text_config"
 require_relative "openai/models/responses/response_tool_search_call"
@@ -1102,6 +1126,8 @@ require_relative "openai/models/responses/tool_search_tool"
 require_relative "openai/models/responses/web_search_preview_tool"
 require_relative "openai/models/responses/web_search_tool"
 require_relative "openai/models/responses_model"
+require_relative "openai/models/safety/alert_retrieve_params"
+require_relative "openai/models/safety/safety_alert"
 require_relative "openai/models/skill"
 require_relative "openai/models/skill_create_params"
 require_relative "openai/models/skill_delete_params"
@@ -1184,6 +1210,8 @@ require_relative "openai/models/webhooks/response_cancelled_webhook_event"
 require_relative "openai/models/webhooks/response_completed_webhook_event"
 require_relative "openai/models/webhooks/response_failed_webhook_event"
 require_relative "openai/models/webhooks/response_incomplete_webhook_event"
+require_relative "openai/models/webhooks/safety_alert_created_webhook_event"
+require_relative "openai/models/webhooks/safety_org_alert_created_webhook_event"
 require_relative "openai/models/webhooks/unwrap_webhook_event"
 require_relative "openai/models/webhooks/webhook_unwrap_params"
 require_relative "openai/models"
@@ -1270,6 +1298,8 @@ require_relative "openai/resources/realtime/client_secrets"
 require_relative "openai/resources/responses"
 require_relative "openai/resources/responses/input_items"
 require_relative "openai/resources/responses/input_tokens"
+require_relative "openai/resources/safety"
+require_relative "openai/resources/safety/alerts"
 require_relative "openai/resources/skills"
 require_relative "openai/resources/skills/content"
 require_relative "openai/resources/skills/versions"
@@ -1287,4 +1317,6 @@ require_relative "openai/helpers/streaming/exceptions"
 require_relative "openai/helpers/streaming/chat_events"
 require_relative "openai/helpers/streaming/chat_completion_stream"
 require_relative "openai/streaming"
+require_relative "openai/helpers/websocket"
 require_relative "openai/helpers/realtime"
+require_relative "openai/helpers/responses_websocket"

data/rbi/openai/auth/subject_token_providers.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module OpenAI
+  module Auth
+    module SubjectTokenProviders
+      class K8sServiceAccountTokenProvider
+        include OpenAI::Auth::SubjectTokenProvider
+
+        sig { params(token_path: String).void }
+        def initialize(token_path: "/var/run/secrets/kubernetes.io/serviceaccount/token")
+        end
+
+        sig { returns(Symbol) }
+        def token_type
+        end
+
+        sig { returns(String) }
+        def get_token
+        end
+      end
+
+      class AzureManagedIdentityTokenProvider
+        include OpenAI::Auth::SubjectTokenProvider
+
+        sig do
+          params(
+            resource: String,
+            object_id: T.nilable(String),
+            client_id: T.nilable(String),
+            msi_res_id: T.nilable(String),
+            api_version: String,
+            timeout: Float
+          )
+            .void
+        end
+        def initialize(
+          resource: "https://management.azure.com/",
+          object_id: nil,
+          client_id: nil,
+          msi_res_id: nil,
+          api_version: "2018-02-01",
+          timeout: 10.0
+        )
+        end
+
+        sig { returns(Symbol) }
+        def token_type
+        end
+
+        sig { returns(String) }
+        def get_token
+        end
+      end
+
+      class GCPIDTokenProvider
+        include OpenAI::Auth::SubjectTokenProvider
+
+        sig { params(audience: String, timeout: Float).void }
+        def initialize(audience: "https://api.openai.com/v1", timeout: 10.0)
+        end
+
+        sig { returns(Symbol) }
+        def token_type
+        end
+
+        sig { returns(String) }
+        def get_token
+        end
+      end
+    end
+  end
+end

data/rbi/openai/client.rbi

@@ -75,6 +75,9 @@ module OpenAI
     sig { returns(OpenAI::Resources::VectorStores) }
     attr_reader :vector_stores
 
+    sig { returns(OpenAI::Resources::Safety) }
+    attr_reader :safety
+
     sig { returns(OpenAI::Resources::Webhooks) }
     attr_reader :webhooks
 

data/rbi/openai/errors.rbi

@@ -7,6 +7,9 @@ module OpenAI
       attr_reader :cause
     end
 
+    class InvalidWebhookSignatureError < OpenAI::Errors::Error
+    end
+
     class PollingError < OpenAI::Errors::Error
     end
 
@@ -120,6 +123,11 @@ module OpenAI
       sig { returns(NilClass) }
       attr_accessor :type
 
+      # @api private
+      sig { returns(T::Boolean) }
+      def request_may_have_been_sent?
+      end
+
       # @api private
       sig do
         params(
@@ -129,7 +137,8 @@ module OpenAI
           body: NilClass,
           request: NilClass,
           response: NilClass,
-          message: T.nilable(String)
+          message: T.nilable(String),
+          request_may_have_been_sent: T::Boolean
         )
           .returns(T.attached_class)
       end
@@ -140,7 +149,8 @@ module OpenAI
         body: nil,
         request: nil,
         response: nil,
-        message: "Connection error."
+        message: "Connection error.",
+        request_may_have_been_sent: true
       )
       end
     end
@@ -155,7 +165,8 @@ module OpenAI
           body: NilClass,
           request: NilClass,
           response: NilClass,
-          message: T.nilable(String)
+          message: T.nilable(String),
+          request_may_have_been_sent: T::Boolean
         )
           .returns(T.attached_class)
       end
@@ -166,7 +177,8 @@ module OpenAI
         body: nil,
         request: nil,
         response: nil,
-        message: "Request timed out."
+        message: "Request timed out.",
+        request_may_have_been_sent: true
       )
       end
     end
@@ -264,5 +276,42 @@ module OpenAI
     class InternalServerError < OpenAI::Errors::APIStatusError
       HTTP_STATUS = T.let((500..), T::Range[Integer])
     end
+
+    class OAuthError < OpenAI::Errors::APIStatusError
+      sig { returns(T.nilable(OpenAI::Models::OAuthErrorCode::Variants)) }
+      attr_reader :error_code
+
+      # @api private
+      sig do
+        params(
+          status: Integer,
+          body: T.nilable(Object),
+          headers: T.nilable(T::Hash[String, String])
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(status:, body:, headers:)
+      end
+    end
+
+    class SubjectTokenProviderError < OpenAI::Errors::Error
+      sig { returns(String) }
+      attr_reader :provider
+
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+
+      # @api private
+      sig do
+        params(
+          message: String,
+          provider: String,
+          cause: T.nilable(StandardError)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(message:, provider:, cause: nil)
+      end
+    end
   end
 end

data/rbi/openai/file_part.rbi

@@ -65,5 +65,10 @@ module OpenAI
     end
     def self.new(content, filename: nil, content_type: nil)
     end
+
+    # @api private
+    sig { params(filename: T.any(Pathname, String)).returns(String) }
+    private def strip_directories(filename)
+    end
   end
 end

data/rbi/openai/helpers/realtime/extensions.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module OpenAI
-  class Client
+  class Client < OpenAI::Internal::Transport::BaseClient
     # @api private
     sig do
       params(
@@ -48,7 +48,7 @@ module OpenAI
   end
 
   module Errors
-    class RealtimeConnectionError < OpenAI::Errors::Error
+    class RealtimeConnectionError < OpenAI::Errors::WebSocketConnectionError
       sig { returns(URI::Generic) }
       attr_reader :url
 
@@ -74,7 +74,7 @@ module OpenAI
       end
     end
 
-    class RealtimeProtocolError < OpenAI::Errors::Error
+    class RealtimeProtocolError < OpenAI::Errors::WebSocketProtocolError
       sig { returns(String) }
       attr_reader :data
 

data/rbi/openai/helpers/responses_websocket/connection.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class Connection
+        include Enumerable
+
+        ServerEvent = T.type_alias do
+          T.any(
+            OpenAI::Responses::ResponsesServerEvent::Variants,
+            OpenAI::Responses::UnknownServerEvent
+          )
+        end
+
+        ClientEvent = T.type_alias do
+          T.any(
+            OpenAI::Responses::ResponsesClientEvent::Variants,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        Elem = type_member { {fixed: ServerEvent} }
+
+        sig { returns(URI::Generic) }
+        attr_reader :url
+
+        sig { returns(OpenAI::Responses::ConnectionResources::Response) }
+        attr_reader :response
+
+        # @api private
+        sig { params(socket: T.anything, url: URI::Generic).returns(T.attached_class) }
+        def self.new(socket:, url:)
+        end
+
+        sig do
+          params(block: T.nilable(T.proc.params(event: ServerEvent).void)).returns(
+            T.any(OpenAI::Responses::Connection, T::Enumerator[ServerEvent])
+          )
+        end
+        def each(&block)
+        end
+
+        sig { returns(T.nilable(ServerEvent)) }
+        def receive
+        end
+
+        # @api private
+        sig { returns(T.nilable(String)) }
+        def receive_raw
+        end
+
+        sig { params(event: ClientEvent).void }
+        def send_event(event)
+        end
+
+        # @api private
+        sig { params(data: String).void }
+        def send_raw(data)
+        end
+
+        sig { params(code: Integer, reason: String).void }
+        def close(code: 1000, reason: "")
+        end
+
+        # @api private
+        sig { void }
+        def abort
+        end
+
+        sig { returns(T::Boolean) }
+        def closed?
+        end
+
+        # @api private
+        sig { returns(T::Boolean) }
+        def poisoned?
+        end
+      end
+    end
+  end
+end

data/rbi/openai/helpers/responses_websocket/connection_manager.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ConnectionManager
+        # @api private
+        sig do
+          params(
+            client: OpenAI::Client,
+            websocket_base_url: T.nilable(String),
+            transport: T.anything,
+            request_options: T.nilable(OpenAI::RequestOptions::OrHash),
+            transport_options: T::Hash[Symbol, T.anything]
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          client:,
+          websocket_base_url:,
+          transport:,
+          request_options:,
+          transport_options:
+        )
+        end
+
+        # @api private
+        sig do
+          params(
+            block: T.proc.params(connection: OpenAI::Responses::Connection).returns(T.anything)
+          )
+            .returns(T.anything)
+        end
+        def open(&block)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/helpers/responses_websocket/connection_resources.rbi

@@ -0,0 +1,17 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      module ConnectionResources
+        class Response
+          # @api private
+          sig { params(connection: OpenAI::Responses::Connection).returns(T.attached_class) }
+          def self.new(connection)
+          end
+
+        end
+      end
+    end
+  end
+end

data/rbi/openai/helpers/responses_websocket/extensions.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module OpenAI
+  class Client < OpenAI::Internal::Transport::BaseClient
+    # @api private
+    sig do
+      params(
+        websocket_base_url: T.nilable(String),
+        options: T.nilable(OpenAI::RequestOptions::OrHash),
+        block: T
+          .proc
+          .params(
+            request: OpenAI::Internal::Transport::BaseClient::RequestInput,
+            mark_handshake_completed: T.proc.void
+          )
+          .returns(T.anything)
+      )
+        .returns(T.anything)
+    end
+    def with_responses_websocket_connection_request(
+      websocket_base_url: nil,
+      options: nil,
+      &block
+    )
+    end
+  end
+
+  module Errors
+    class ResponsesConnectionError < OpenAI::Errors::WebSocketConnectionError
+      sig { returns(URI::Generic) }
+      attr_reader :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :http_status
+
+      sig { returns(T.nilable(Exception)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          message: T.nilable(String),
+          http_status: T.nilable(Integer)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, message: nil, http_status: nil)
+      end
+    end
+
+    class ResponsesProtocolError < OpenAI::Errors::WebSocketProtocolError
+      sig { returns(T.nilable(Exception)) }
+      def cause
+      end
+
+      # @api private
+      sig { returns(T.attached_class) }
+      def self.new
+      end
+    end
+
+    class ResponsesClientEventError < OpenAI::Errors::Error
+      sig { returns(T.nilable(Exception)) }
+      def cause
+      end
+
+      # @api private
+      sig { returns(T.attached_class) }
+      def self.new
+      end
+    end
+
+    class ResponsesSendError < ResponsesConnectionError
+      sig { returns(Symbol) }
+      attr_reader :outcome
+
+      # @api private
+      sig { params(url: URI::Generic).returns(T.attached_class) }
+      def self.new(url:)
+      end
+    end
+  end
+
+  module Resources
+    class Responses
+      sig do
+        params(
+          websocket_base_url: T.nilable(String),
+          request_options: T.nilable(OpenAI::RequestOptions::OrHash),
+          transport: T.anything,
+          transport_options: T::Hash[Symbol, T.anything],
+          block: T.proc.params(connection: OpenAI::Responses::Connection).returns(T.anything)
+        )
+          .returns(T.anything)
+      end
+      def connect(
+        websocket_base_url: nil,
+        request_options: nil,
+        transport: nil,
+        transport_options: {},
+        &block
+      )
+      end
+    end
+  end
+end

data/rbi/openai/helpers/responses_websocket/transports/async_websocket.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      module Transports
+        class AsyncWebSocket
+          sig { void }
+          def initialize
+          end
+
+          sig do
+            params(
+              url: URI::Generic,
+              headers: T::Hash[String, String],
+              timeout: T.nilable(Float),
+              options: T.anything,
+              block: T.proc.params(socket: T.anything).returns(T.anything)
+            )
+              .returns(T.anything)
+          end
+          def open(url:, headers:, timeout:, **options, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/helpers/responses_websocket/unknown_server_event.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class UnknownServerEvent
+        # @api private
+        sig do
+          params(data: T::Hash[Symbol, T.anything]).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig { returns(Symbol) }
+        attr_reader :type
+
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_reader :data
+
+        sig { returns(T.anything) }
+        attr_reader :stream_id
+
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        def to_h
+        end
+      end
+    end
+  end
+end