openai 0.103.0 → 0.104.0

data/lib/openai/resources/beta/responses.rb

@@ -173,7 +173,7 @@ module OpenAI
         # @param safety_identifier [String, nil]
         #   Body param: A stable identifier used to help detect users of your application
         #   that may be violating OpenAI's usage policies. The IDs should be a string that
-        #   uniquely identifies each user, with a maximum length of 64 characters. We
+        #   uniquely identifies each user, with a maximum length of 128 characters. We
         #   recommend hashing their username or email address, in order to avoid sending us
         #   any identifying information.
         #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -474,7 +474,7 @@ module OpenAI
         # @param safety_identifier [String, nil]
         #   Body param: A stable identifier used to help detect users of your application
         #   that may be violating OpenAI's usage policies. The IDs should be a string that
-        #   uniquely identifies each user, with a maximum length of 64 characters. We
+        #   uniquely identifies each user, with a maximum length of 128 characters. We
         #   recommend hashing their username or email address, in order to avoid sending us
         #   any identifying information.
         #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).

data/lib/openai/resources/chat/completions.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../../helpers/streaming/chat_completion_resource"
 require_relative "../../helpers/structured_output/chat_completion_parser"
 
 module OpenAI
@@ -216,7 +217,7 @@ module OpenAI
         # @param safety_identifier [String, nil]
         #   A stable identifier used to help detect users of your application that may be
         #   violating OpenAI's usage policies. The IDs should be a string that uniquely
-        #   identifies each user, with a maximum length of 64 characters. We recommend
+        #   identifies each user, with a maximum length of 128 characters. We recommend
         #   hashing their username or email address, in order to avoid sending us any
         #   identifying information.
         #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -350,41 +351,6 @@ module OpenAI
           )
         end
 
-        def get_structured_output_models(parsed)
-          OpenAI::Helpers::StructuredOutput::ChatCompletionParser.get_models(parsed)
-        end
-
-        def build_tools_with_models(tools, tool_models)
-          OpenAI::Helpers::StructuredOutput::ChatCompletionParser.build_tools(tools, tool_models)
-        end
-
-        def stream(params)
-          parsed, options = OpenAI::Chat::CompletionCreateParams.dump_request(params)
-
-          parsed.store(:stream, true)
-
-          response_format, tool_models = get_structured_output_models(parsed)
-
-          input_tools = build_tools_with_models(parsed[:tools], tool_models)
-
-          raw_stream = @client.request(
-            method: :post,
-            path: "chat/completions",
-            headers: {"accept" => "text/event-stream"},
-            body: parsed,
-            stream: OpenAI::Internal::Stream,
-            model: OpenAI::Chat::ChatCompletionChunk,
-            security: {bearer_auth: true},
-            options: options
-          )
-
-          OpenAI::Helpers::Streaming::ChatCompletionStream.new(
-            raw_stream: raw_stream,
-            response_format: response_format,
-            input_tools: input_tools
-          )
-        end
-
         # See {OpenAI::Resources::Chat::Completions#create} for non-streaming counterpart.
         #
         # **Starting a new project?** We recommend trying
@@ -588,7 +554,7 @@ module OpenAI
         # @param safety_identifier [String, nil]
         #   A stable identifier used to help detect users of your application that may be
         #   violating OpenAI's usage policies. The IDs should be a string that uniquely
-        #   identifies each user, with a maximum length of 64 characters. We recommend
+        #   identifies each user, with a maximum length of 128 characters. We recommend
         #   hashing their username or email address, in order to avoid sending us any
         #   identifying information.
         #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -842,6 +808,14 @@ module OpenAI
           )
         end
 
+        def get_structured_output_models(parsed)
+          OpenAI::Helpers::StructuredOutput::ChatCompletionParser.get_models(parsed)
+        end
+
+        def build_tools_with_models(tools, tool_models)
+          OpenAI::Helpers::StructuredOutput::ChatCompletionParser.build_tools(tools, tool_models)
+        end
+
         # @api private
         #
         # @param client [OpenAI::Client]

data/lib/openai/resources/decisions.rb

@@ -3,29 +3,23 @@
 module OpenAI
   module Resources
     class Decisions
-      # Evaluate ordered classification and scoring questions against shared input.
-      # Answers are returned in question order.
-      #
-      # Supply input as a string or user messages containing text and inline images.
-      # Only user messages with `input_text` and `input_image` parts are supported;
-      # non-user roles, function calls, files, audio, and item references are not
-      # supported. Images require a data URL, not an external URL or file ID. At most
-      # 128 images are allowed across the request.
-      #
-      # Each question can return a refusal instead of a scored answer. A refusal has
-      # type `refusal` and the corresponding question name, or null if unnamed.
+      # Use this endpoint to quickly answer classification or scoring questions about
+      # some input. You can ask multiple questions in one request.
       #
       # @overload create(input:, model:, questions:, safety_identifier: nil, request_options: {})
       #
       # @param input [String, Array<OpenAI::Models::DecisionInputMessage>]
-      #   Shared evidence, as a string or an array of user messages containing text and
-      #   inline images. Non-user roles, function calls, function-call outputs, files,
-      #   audio, and item references are not supported. At most 128 image parts are
-      #   allowed across all messages in one request.
+      #   The text or images to evaluate for every question. Provide a text string or user
+      #   messages containing text and images. Images can be base64 data URLs or publicly
+      #   accessible HTTP(S) URLs; at most 128 images are allowed across all messages in
+      #   one request. Files, audio, tools, and item references are not supported.
       #
       # @param model [String]
+      #   The model to use. Only `gpt-6-luna` is supported.
       #
       # @param questions [Array<OpenAI::Models::DecisionCreateParams::Question::Predicate, OpenAI::Models::DecisionCreateParams::Question::Choice, OpenAI::Models::DecisionCreateParams::Question::Score>]
+      #   Ask 1–200 questions about the input. Each question can be a predicate, choice,
+      #   or score. Answers come back in the same order.
       #
       # @param safety_identifier [String, nil]
       #   Opaque caller-provided end-user identifier, scoped by the verified org. Match

data/lib/openai/resources/files.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../helpers/resource_polling"
-
 module OpenAI
   module Resources
     # Files are used to upload documents that can be used with features like
@@ -187,43 +185,6 @@ module OpenAI
         )
       end
 
-      # Wait for an uploaded file to finish processing.
-      #
-      # The returned file may have an `error` status; callers should inspect the
-      # status before using it. Polling intervals and the overall timeout are in
-      # seconds. Finite timeouts include authentication and request replay time and
-      # disable transport retries so the deadline remains strict. Set `timeout` to
-      # `nil` to wait indefinitely and retain configured transport retries.
-      #
-      # @overload wait_for_processing(file_id, poll_interval: nil, timeout: 1800.0, request_options: {})
-      #
-      # @param file_id [String] The ID of the file to wait for.
-      #
-      # @param poll_interval [Integer, Float, nil] How often to retrieve the file. When omitted, the SDK honors the server's
-      #   polling hint and otherwise waits 5 seconds.
-      #
-      # @param timeout [Integer, Float, nil] Maximum total time to poll. Defaults to 30 minutes. Set to `nil` to wait
-      #   indefinitely.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @raise [ArgumentError, OpenAI::Errors::PollingError]
-      # @return [OpenAI::Models::FileObject]
-      def wait_for_processing(
-        file_id,
-        poll_interval: nil,
-        timeout: OpenAI::Internal::Poller::DEFAULT_TIMEOUT,
-        request_options: {}
-      )
-        OpenAI::Helpers::ResourcePolling.wait_for_file(
-          self,
-          file_id,
-          poll_interval: poll_interval,
-          timeout: timeout,
-          request_options: request_options
-        )
-      end
-
       # @api private
       #
       # @param client [OpenAI::Client]

data/lib/openai/resources/live/forks.rb

@@ -1,9 +1,28 @@
 # frozen_string_literal: true
 
+require_relative "../../helpers/websocket/resource"
+
 module OpenAI
   module Resources
     class Live
       class Forks
+        include OpenAI::WebSocket::Resource
+
+        # @api private
+        def __websocket_request(session_id, query: {})
+          {method: :get, path: ["live/sessions/%1$s/fork", session_id], query: query, security: {bearer_auth: true}}
+        end
+
+        # @api private
+        def __websocket_client_event
+          OpenAI::Models::Live::ForkClientEvent
+        end
+
+        # @api private
+        def __websocket_server_event
+          OpenAI::Models::Live::ForkServerEvent
+        end
+
         # @api private
         #
         # @param client [OpenAI::Client]

data/lib/openai/resources/live/sideband.rb

@@ -1,9 +1,28 @@
 # frozen_string_literal: true
 
+require_relative "../../helpers/websocket/resource"
+
 module OpenAI
   module Resources
     class Live
       class Sideband
+        include OpenAI::WebSocket::Resource
+
+        # @api private
+        def __websocket_request(session_id, query: {})
+          {method: :get, path: ["live/sessions/%1$s/attach", session_id], query: query, security: {bearer_auth: true}}
+        end
+
+        # @api private
+        def __websocket_client_event
+          OpenAI::Models::Live::SidebandClientEvent
+        end
+
+        # @api private
+        def __websocket_server_event
+          OpenAI::Models::Live::SidebandServerEvent
+        end
+
         # @api private
         #
         # @param client [OpenAI::Client]

data/lib/openai/resources/live.rb

@@ -1,8 +1,27 @@
 # frozen_string_literal: true
 
+require_relative "../helpers/websocket/resource"
+
 module OpenAI
   module Resources
     class Live
+      include OpenAI::WebSocket::Resource
+
+      # @api private
+      def __websocket_request(query: {})
+        {method: :get, path: "live/sessions", query: query, security: {bearer_auth: true}}
+      end
+
+      # @api private
+      def __websocket_client_event
+        OpenAI::Models::Live::ClientEvent
+      end
+
+      # @api private
+      def __websocket_server_event
+        OpenAI::Models::Live::ServerEvent
+      end
+
       # @return [OpenAI::Resources::Live::Sideband]
       attr_reader :sideband
 

data/lib/openai/resources/realtime/translations.rb

@@ -1,9 +1,28 @@
 # frozen_string_literal: true
 
+require_relative "../../helpers/websocket/resource"
+
 module OpenAI
   module Resources
     class Realtime
       class Translations
+        include OpenAI::WebSocket::Resource
+
+        # @api private
+        def __websocket_request(query: {})
+          {method: :get, path: "realtime/translations", query: query, security: {bearer_auth: true}}
+        end
+
+        # @api private
+        def __websocket_client_event
+          OpenAI::Models::Realtime::RealtimeTranslationClientEvent
+        end
+
+        # @api private
+        def __websocket_server_event
+          OpenAI::Models::Realtime::RealtimeTranslationServerEvent
+        end
+
         # @return [OpenAI::Resources::Realtime::Translations::ClientSecrets]
         attr_reader :client_secrets
 

data/lib/openai/resources/realtime.rb

@@ -1,8 +1,27 @@
 # frozen_string_literal: true
 
+require_relative "../helpers/websocket/resource"
+
 module OpenAI
   module Resources
     class Realtime
+      include OpenAI::WebSocket::Resource
+
+      # @api private
+      def __websocket_request(query: {})
+        {method: :get, path: "realtime", query: query, security: {bearer_auth: true}}
+      end
+
+      # @api private
+      def __websocket_client_event
+        OpenAI::Models::Realtime::RealtimeClientEvent
+      end
+
+      # @api private
+      def __websocket_server_event
+        OpenAI::Models::Realtime::RealtimeServerEvent
+      end
+
       # @return [OpenAI::Resources::Realtime::ClientSecrets]
       attr_reader :client_secrets
 

data/lib/openai/resources/responses.rb

@@ -1,11 +1,30 @@
 # frozen_string_literal: true
 
+require_relative "../helpers/streaming/response_stream_resource"
+require_relative "../helpers/websocket/resource"
 require_relative "../helpers/structured_output/response_parser"
 
 module OpenAI
   module Resources
     # Create and manage model responses.
     class Responses
+      include OpenAI::WebSocket::Resource
+
+      # @api private
+      def __websocket_request(query: {})
+        {method: :get, path: "responses", query: query, security: {bearer_auth: true}}
+      end
+
+      # @api private
+      def __websocket_client_event
+        OpenAI::Models::Responses::ResponsesClientEvent
+      end
+
+      # @api private
+      def __websocket_server_event
+        OpenAI::Models::Responses::ResponsesServerEvent
+      end
+
       # Create and manage model responses.
       # @return [OpenAI::Resources::Responses::InputItems]
       attr_reader :input_items
@@ -168,7 +187,7 @@ module OpenAI
       # @param safety_identifier [String, nil]
       #   A stable identifier used to help detect users of your application that may be
       #   violating OpenAI's usage policies. The IDs should be a string that uniquely
-      #   identifies each user, with a maximum length of 64 characters. We recommend
+      #   identifies each user, with a maximum length of 128 characters. We recommend
       #   hashing their username or email address, in order to avoid sending us any
       #   identifying information.
       #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -307,61 +326,6 @@ module OpenAI
         )
       end
 
-      # Creates or resumes a streaming response and parses structured outputs.
-      # @overload stream(access_programs: nil, **params)
-      #   @param access_programs [OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms]
-      #     Domain-specific access programs to use for this request.
-      #   @param params [Hash{Symbol=>Object}] Other response creation or retrieval parameters.
-      def stream(params)
-        parsed, options = OpenAI::Responses::ResponseCreateParams.dump_request(params)
-        starting_after, response_id = parsed.values_at(:starting_after, :response_id)
-
-        if starting_after && !response_id
-          raise ArgumentError, "starting_after can only be used with response_id"
-        end
-
-        model, tool_models = get_structured_output_models(parsed)
-
-        unwrap = -> (raw) do
-          if raw[:type] == "response.completed" && raw[:response]
-            parse_structured_outputs!(raw[:response], model, tool_models)
-          end
-
-          raw
-        end
-
-        if response_id
-          retrieve_params = parsed.slice(:include, :starting_after)
-          retrieve_params[:request_options] = options
-
-          raw_stream = retrieve_streaming_internal(
-            response_id,
-            params: retrieve_params,
-            unwrap: unwrap
-          )
-        else
-          parsed[:stream] = true
-
-          raw_stream = @client.request(
-            method: :post,
-            path: "responses",
-            headers: {"accept" => "text/event-stream"},
-            body: parsed,
-            stream: OpenAI::Internal::Stream,
-            model: OpenAI::Models::Responses::ResponseStreamEvent,
-            unwrap: unwrap,
-            security: {bearer_auth: true},
-            options: options
-          )
-        end
-
-        OpenAI::Streaming::ResponseStream.new(
-          raw_stream: raw_stream,
-          text_format: model,
-          starting_after: starting_after
-        )
-      end
-
       # See {OpenAI::Resources::Responses#create} for non-streaming counterpart.
       #
       # Creates a model response. Provide
@@ -376,7 +340,10 @@ module OpenAI
       # [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
       # to use your own data as input for the model's response.
       #
-      # @overload stream(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, response_id: nil, safety_identifier: nil, service_tier: nil, starting_after: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
+      # @overload stream_raw(access_programs: nil, background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
+      #
+      # @param access_programs [OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms]
+      #   Domain-specific access programs to use for this request.
       #
       # @param background [Boolean, nil]
       #   Whether to run the model response in the background.
@@ -513,7 +480,7 @@ module OpenAI
       # @param safety_identifier [String, nil]
       #   A stable identifier used to help detect users of your application that may be
       #   violating OpenAI's usage policies. The IDs should be a string that uniquely
-      #   identifies each user, with a maximum length of 64 characters. We recommend
+      #   identifies each user, with a maximum length of 128 characters. We recommend
       #   hashing their username or email address, in order to avoid sending us any
       #   identifying information.
       #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
@@ -672,13 +639,13 @@ module OpenAI
       # @param starting_after [Integer]
       #   The sequence number of the event after which to start streaming.
       #
-      # @param text [OpenAI::Responses::ResponseTextConfig, OpenAI::StructuredOutput::JsonSchemaConverter, Hash, nil] The structured-output model,
-      #   or the same typed/hash text configuration accepted by creation, used to parse retrieved text output. This is a local parsing hint and is not
-      #   sent to the API.
+      # @param text [OpenAI::Responses::ResponseTextConfig, OpenAI::StructuredOutput::JsonSchemaConverter, Hash, nil]
+      #   The structured-output model used to parse retrieved text output. This is a local
+      #   parsing hint and is not sent to the API.
       #
-      # @param tools [Array<OpenAI::Responses::FunctionTool, OpenAI::StructuredOutput::JsonSchemaConverter, Hash>, nil] Structured-output models, or
-      #   the same typed/hash function-tool definitions accepted by creation, used to parse retrieved function tool calls. These are local parsing hints
-      #   and are not sent to the API.
+      # @param tools [Array<OpenAI::Responses::FunctionTool, OpenAI::StructuredOutput::JsonSchemaConverter, Hash>, nil]
+      #   Structured-output models used to parse retrieved function tool calls. These are
+      #   local parsing hints and are not sent to the API.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -765,22 +732,6 @@ module OpenAI
         )
       end
 
-      private def retrieve_streaming_internal(response_id, params:, unwrap:)
-        parsed, options = OpenAI::Responses::ResponseRetrieveParams.dump_request(params)
-        parsed.store(:stream, true)
-        @client.request(
-          method: :get,
-          path: ["responses/%1$s", response_id],
-          query: parsed,
-          headers: {"accept" => "text/event-stream"},
-          stream: OpenAI::Internal::Stream,
-          model: OpenAI::Responses::ResponseStreamEvent,
-          security: {bearer_auth: true},
-          options: options,
-          unwrap: unwrap
-        )
-      end
-
       # Deletes a model response with the given ID.
       #
       # @overload delete(response_id, request_options: {})
@@ -910,32 +861,30 @@ module OpenAI
         )
       end
 
-      # @api private
-      #
-      # @param client [OpenAI::Client]
-      def initialize(client:)
-        @client = client
-        @input_items = OpenAI::Resources::Responses::InputItems.new(client: client)
-        @input_tokens = OpenAI::Resources::Responses::InputTokens.new(client: client)
-      end
-
-      private
-
-      def parse_structured_outputs!(raw, model, tool_models)
+      private def parse_structured_outputs!(raw, model, tool_models)
         OpenAI::Helpers::StructuredOutput::ResponseParser.parse!(raw, model, tool_models)
       end
 
-      def parse_retrieved_structured_outputs!(raw, model, tool_models)
+      private def parse_retrieved_structured_outputs!(raw, model, tool_models)
         OpenAI::Helpers::StructuredOutput::ResponseParser.parse_retrieved!(raw, model, tool_models)
       end
 
-      def get_structured_output_models(parsed)
+      private def get_structured_output_models(parsed)
         OpenAI::Helpers::StructuredOutput::ResponseParser.get_models(parsed)
       end
 
-      def get_retrieval_structured_output_models(parsed)
+      private def get_retrieval_structured_output_models(parsed)
         OpenAI::Helpers::StructuredOutput::ResponseParser.get_retrieval_models(parsed)
       end
+
+      # @api private
+      #
+      # @param client [OpenAI::Client]
+      def initialize(client:)
+        @client = client
+        @input_items = OpenAI::Resources::Responses::InputItems.new(client: client)
+        @input_tokens = OpenAI::Resources::Responses::InputTokens.new(client: client)
+      end
     end
   end
 end