openai 0.104.0 → 0.106.0

data/lib/openai/models/image_gen_completed_event.rb

@@ -52,7 +52,15 @@ module OpenAI
       #   @return [OpenAI::Models::ImageGenCompletedEvent::Usage]
       required :usage, -> { OpenAI::ImageGenCompletedEvent::Usage }
 
-      # @!method initialize(b64_json:, background:, created_at:, output_format:, quality:, size:, usage:, type: :"image_generation.completed")
+      # @!attribute safety_identifier
+      #   The effective safety identifier used for safety monitoring and abuse detection.
+      #   This is the non-empty `safety_identifier` from the request, or the deprecated
+      #   `user` value when `safety_identifier` is omitted, null, or empty.
+      #
+      #   @return [String, nil]
+      optional :safety_identifier, String, nil?: true
+
+      # @!method initialize(b64_json:, background:, created_at:, output_format:, quality:, size:, usage:, safety_identifier: nil, type: :"image_generation.completed")
       #   Emitted when image generation has completed and the final image is available.
       #
       #   @param b64_json [String]
@@ -77,6 +85,11 @@ module OpenAI
       #     For the GPT image models only, the token usage information for the image
       #     generation.
       #
+      #   @param safety_identifier [String, nil]
+      #     The effective safety identifier used for safety monitoring and abuse detection.
+      #     This is the non-empty `safety_identifier` from the request, or the deprecated
+      #     `user` value when `safety_identifier` is omitted, null, or empty.
+      #
       #   @param type [Symbol, :"image_generation.completed"]
       #     The type of the event. Always `image_generation.completed`.
 

data/lib/openai/models/image_generate_params.rb

@@ -101,6 +101,17 @@ module OpenAI
       #   @return [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil]
       optional :response_format, enum: -> { OpenAI::ImageGenerateParams::ResponseFormat }, nil?: true
 
+      # @!attribute safety_identifier
+      #   A stable identifier for an end user in your organization, used for safety
+      #   monitoring and abuse detection. Hash a username or email address to avoid
+      #   sending identifying information. A non-empty value takes precedence over the
+      #   deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+      #   when available.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+      #
+      #   @return [String, nil]
+      optional :safety_identifier, String, nil?: true
+
       # @!attribute size
       #   The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
       #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
@@ -126,14 +137,17 @@ module OpenAI
       optional :style, enum: -> { OpenAI::ImageGenerateParams::Style }, nil?: true
 
       # @!attribute user
-      #   A unique identifier representing your end-user, which can help OpenAI to monitor
-      #   and detect abuse.
+      #   @deprecated
+      #
+      #   Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+      #   backward compatibility and is used when `safety_identifier` is omitted, null, or
+      #   empty.
       #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @return [String, nil]
       optional :user, String
 
-      # @!method initialize(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
+      # @!method initialize(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, style: nil, user: nil, request_options: {})
       #   @param prompt [String]
       #     A text description of the desired image(s). The maximum length is 32000
       #     characters.
@@ -194,6 +208,14 @@ module OpenAI
       #     Legacy response format parameter for retired image models. Unsupported for GPT
       #     image models, which always return base64-encoded images.
       #
+      #   @param safety_identifier [String, nil]
+      #     A stable identifier for an end user in your organization, used for safety
+      #     monitoring and abuse detection. Hash a username or email address to avoid
+      #     sending identifying information. A non-empty value takes precedence over the
+      #     deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+      #     when available.
+      #     [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+      #
       #   @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
       #     The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
       #     `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
@@ -211,8 +233,9 @@ module OpenAI
       #     models; describe the desired style in the prompt instead.
       #
       #   @param user [String]
-      #     A unique identifier representing your end-user, which can help OpenAI to monitor
-      #     and detect abuse.
+      #     Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+      #     backward compatibility and is used when `safety_identifier` is omitted, null, or
+      #     empty.
       #     [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]

data/lib/openai/models/images_response.rb

@@ -36,6 +36,14 @@ module OpenAI
       #   @return [Symbol, OpenAI::Models::ImagesResponse::Quality, nil]
       optional :quality, enum: -> { OpenAI::ImagesResponse::Quality }
 
+      # @!attribute safety_identifier
+      #   The effective safety identifier used for safety monitoring and abuse detection.
+      #   This is the non-empty `safety_identifier` from the request, or the deprecated
+      #   `user` value when `safety_identifier` is omitted, null, or empty.
+      #
+      #   @return [String, nil]
+      optional :safety_identifier, String, nil?: true
+
       # @!attribute size
       #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       #
@@ -48,7 +56,7 @@ module OpenAI
       #   @return [OpenAI::Models::ImagesResponse::Usage, nil]
       optional :usage, -> { OpenAI::ImagesResponse::Usage }
 
-      # @!method initialize(created:, background: nil, data: nil, output_format: nil, quality: nil, size: nil, usage: nil)
+      # @!method initialize(created:, background: nil, data: nil, output_format: nil, quality: nil, safety_identifier: nil, size: nil, usage: nil)
       #   The response from the image generation endpoint.
       #
       #   @param created [Integer]
@@ -68,6 +76,11 @@ module OpenAI
       #     The quality of the image generated. One of `low`, `medium`, `high`, `xhigh`, or
       #     `max`.
       #
+      #   @param safety_identifier [String, nil]
+      #     The effective safety identifier used for safety monitoring and abuse detection.
+      #     This is the non-empty `safety_identifier` from the request, or the deprecated
+      #     `user` value when `safety_identifier` is omitted, null, or empty.
+      #
       #   @param size [String, Symbol, OpenAI::Models::ImagesResponse::Size]
       #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       #

data/lib/openai/models/live/sideband_server_event.rb

@@ -3,8 +3,8 @@
 module OpenAI
   module Models
     module Live
-      # Server events received by an attached Live sideband WebSocket. Audio deltas are
-      # delivered over the primary connection.
+      # Server events received by an attached Live sideband WebSocket, including
+      # reflected input and output audio and transport notifications.
       module SidebandServerEvent
         extend OpenAI::Internal::Type::Union
 
@@ -70,8 +70,248 @@ module OpenAI
         # An informational notice about the Live session, such as the event permissions applied to a frontend data channel.
         variant :info, -> { OpenAI::Live::InfoEvent }
 
+        # Input audio received from the primary transport and reflected to a Live sideband connection before model-input muting.
+        variant :"session.input_audio.append", -> { OpenAI::Live::SidebandServerEvent::SessionInputAudioAppend }
+
+        # An audio chunk generated by the Live model. Decode and play primary WebSocket chunks in delivery order using the configured session audio format. Sideband connections receive reflected output audio with timestamps.
+        variant :"session.output_audio.delta", -> { OpenAI::Live::OutputAudioDeltaEvent }
+
+        # A SIP DTMF keypress received from the caller. Delivered only to sideband observers.
+        variant :"transport.dtmf.received", -> { OpenAI::Live::SidebandServerEvent::TransportDtmfReceived }
+
+        # A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.
+        variant :"transport.dtmf.send", -> { OpenAI::Live::SidebandServerEvent::TransportDtmfSend }
+
+        # The outbound SIP provider leg is ringing or providing early media. Delivered only to sideband observers.
+        variant :"transport.ringing", -> { OpenAI::Live::SidebandServerEvent::TransportRinging }
+
+        # The outbound SIP provider leg answered and media is established. Delivered only to sideband observers.
+        variant :"transport.answered", -> { OpenAI::Live::SidebandServerEvent::TransportAnswered }
+
+        # An asynchronous outbound SIP setup failure. Delivered only to sideband observers.
+        variant :"transport.failed", -> { OpenAI::Live::SidebandServerEvent::TransportFailed }
+
+        class SessionInputAudioAppend < OpenAI::Internal::Type::BaseModel
+          # @!attribute audio
+          #   Base64-encoded raw mono PCM16LE at 24 kHz received from the primary transport,
+          #   reflected to the sideband before model-input muting. This server event uses the
+          #   same audio key as the client command, but is not an acknowledgment of it.
+          #
+          #   @return [String]
+          required :audio, String
+
+          # @!attribute type
+          #   The event type, always `session.input_audio.append`.
+          #
+          #   @return [Symbol, :"session.input_audio.append"]
+          required :type, const: :"session.input_audio.append"
+
+          # @!method initialize(audio:, type: :"session.input_audio.append")
+          #   Input audio received from the primary transport and reflected to a Live sideband
+          #   connection before model-input muting.
+          #
+          #   @param audio [String]
+          #     Base64-encoded raw mono PCM16LE at 24 kHz received from the primary transport,
+          #     reflected to the sideband before model-input muting. This server event uses the
+          #     same audio key as the client command, but is not an acknowledgment of it.
+          #
+          #   @param type [Symbol, :"session.input_audio.append"]
+          #     The event type, always `session.input_audio.append`.
+        end
+
+        class TransportDtmfReceived < OpenAI::Internal::Type::BaseModel
+          # @!attribute event
+          #
+          #   @return [String]
+          required :event, String
+
+          # @!attribute event_id
+          #
+          #   @return [String]
+          required :event_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :"transport.dtmf.received"]
+          required :type, const: :"transport.dtmf.received"
+
+          # @!method initialize(event:, event_id:, type: :"transport.dtmf.received")
+          #   A SIP DTMF keypress received from the caller. Delivered only to sideband
+          #   observers.
+          #
+          #   @param event [String]
+          #   @param event_id [String]
+          #   @param type [Symbol, :"transport.dtmf.received"]
+        end
+
+        class TransportDtmfSend < OpenAI::Internal::Type::BaseModel
+          # @!attribute event
+          #
+          #   @return [String]
+          required :event, String
+
+          # @!attribute event_id
+          #
+          #   @return [String]
+          required :event_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :"transport.dtmf.send"]
+          required :type, const: :"transport.dtmf.send"
+
+          # @!attribute client_event_id
+          #   The event_id of the client command, when supplied.
+          #
+          #   @return [String, nil]
+          optional :client_event_id, String
+
+          # @!method initialize(event:, event_id:, client_event_id: nil, type: :"transport.dtmf.send")
+          #   A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
+          #   sideband observers; this is not a client command.
+          #
+          #   @param event [String]
+          #
+          #   @param event_id [String]
+          #
+          #   @param client_event_id [String]
+          #     The event_id of the client command, when supplied.
+          #
+          #   @param type [Symbol, :"transport.dtmf.send"]
+        end
+
+        class TransportRinging < OpenAI::Internal::Type::BaseModel
+          # @!attribute event_id
+          #
+          #   @return [String]
+          required :event_id, String
+
+          # @!attribute session_id
+          #   The canonical Live session ID.
+          #
+          #   @return [String]
+          required :session_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :"transport.ringing"]
+          required :type, const: :"transport.ringing"
+
+          # @!method initialize(event_id:, session_id:, type: :"transport.ringing")
+          #   The outbound SIP provider leg is ringing or providing early media. Delivered
+          #   only to sideband observers.
+          #
+          #   @param event_id [String]
+          #
+          #   @param session_id [String]
+          #     The canonical Live session ID.
+          #
+          #   @param type [Symbol, :"transport.ringing"]
+        end
+
+        class TransportAnswered < OpenAI::Internal::Type::BaseModel
+          # @!attribute event_id
+          #
+          #   @return [String]
+          required :event_id, String
+
+          # @!attribute session_id
+          #   The canonical Live session ID.
+          #
+          #   @return [String]
+          required :session_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :"transport.answered"]
+          required :type, const: :"transport.answered"
+
+          # @!method initialize(event_id:, session_id:, type: :"transport.answered")
+          #   The outbound SIP provider leg answered and media is established. Delivered only
+          #   to sideband observers.
+          #
+          #   @param event_id [String]
+          #
+          #   @param session_id [String]
+          #     The canonical Live session ID.
+          #
+          #   @param type [Symbol, :"transport.answered"]
+        end
+
+        class TransportFailed < OpenAI::Internal::Type::BaseModel
+          # @!attribute error
+          #
+          #   @return [OpenAI::Models::Live::SidebandServerEvent::TransportFailed::Error]
+          required :error, -> { OpenAI::Live::SidebandServerEvent::TransportFailed::Error }
+
+          # @!attribute event_id
+          #
+          #   @return [String]
+          required :event_id, String
+
+          # @!attribute session_id
+          #   The canonical Live session ID.
+          #
+          #   @return [String]
+          required :session_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :"transport.failed"]
+          required :type, const: :"transport.failed"
+
+          # @!method initialize(error:, event_id:, session_id:, type: :"transport.failed")
+          #   An asynchronous outbound SIP setup failure. Delivered only to sideband
+          #   observers.
+          #
+          #   @param error [OpenAI::Models::Live::SidebandServerEvent::TransportFailed::Error]
+          #
+          #   @param event_id [String]
+          #
+          #   @param session_id [String]
+          #     The canonical Live session ID.
+          #
+          #   @param type [Symbol, :"transport.failed"]
+
+          # @see OpenAI::Models::Live::SidebandServerEvent::TransportFailed#error
+          class Error < OpenAI::Internal::Type::BaseModel
+            # @!attribute code
+            #   The call setup failure code.
+            #
+            #   @return [String]
+            required :code, String
+
+            # @!attribute message
+            #
+            #   @return [String]
+            required :message, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :call_error]
+            required :type, const: :call_error
+
+            # @!attribute param
+            #   The parameter related to the error, if any. Empty when no parameter applies.
+            #
+            #   @return [String, nil]
+            optional :param, String
+
+            # @!method initialize(code:, message:, param: nil, type: :call_error)
+            #   @param code [String]
+            #     The call setup failure code.
+            #
+            #   @param message [String]
+            #
+            #   @param param [String]
+            #     The parameter related to the error, if any. Empty when no parameter applies.
+            #
+            #   @param type [Symbol, :call_error]
+          end
+        end
+
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Live::SessionStartedEvent, OpenAI::Models::Live::SessionUpdatedEvent, OpenAI::Models::Live::InputAudioMutedEvent, OpenAI::Models::Live::InputAudioUnmutedEvent, OpenAI::Models::Live::OutputAudioFixturePlayingEvent, OpenAI::Models::Live::OutputAudioFixturePlayedEvent, OpenAI::Models::Live::InstructionsAppendedEvent, OpenAI::Models::Live::ThinkingAppendedEvent, OpenAI::Models::Live::CommentaryAppendedEvent, OpenAI::Models::Live::InputTranscriptDeltaEvent, OpenAI::Models::Live::OutputTranscriptDeltaEvent, OpenAI::Models::Live::DelegationCreatedEvent, OpenAI::Models::Live::DecisionEvent, OpenAI::Models::Live::DecisionItemCreatedEvent, OpenAI::Models::Live::DecisionItemDeletedEvent, OpenAI::Models::Live::ResponseEvent, OpenAI::Models::Live::SessionUsageUpdatedEvent, OpenAI::Models::Live::SessionClosedEvent, OpenAI::Models::Live::ErrorEvent, OpenAI::Models::Live::InfoEvent)]
+        #   @return [Array(OpenAI::Models::Live::SessionStartedEvent, OpenAI::Models::Live::SessionUpdatedEvent, OpenAI::Models::Live::InputAudioMutedEvent, OpenAI::Models::Live::InputAudioUnmutedEvent, OpenAI::Models::Live::OutputAudioFixturePlayingEvent, OpenAI::Models::Live::OutputAudioFixturePlayedEvent, OpenAI::Models::Live::InstructionsAppendedEvent, OpenAI::Models::Live::ThinkingAppendedEvent, OpenAI::Models::Live::CommentaryAppendedEvent, OpenAI::Models::Live::InputTranscriptDeltaEvent, OpenAI::Models::Live::OutputTranscriptDeltaEvent, OpenAI::Models::Live::DelegationCreatedEvent, OpenAI::Models::Live::DecisionEvent, OpenAI::Models::Live::DecisionItemCreatedEvent, OpenAI::Models::Live::DecisionItemDeletedEvent, OpenAI::Models::Live::ResponseEvent, OpenAI::Models::Live::SessionUsageUpdatedEvent, OpenAI::Models::Live::SessionClosedEvent, OpenAI::Models::Live::ErrorEvent, OpenAI::Models::Live::InfoEvent, OpenAI::Models::Live::SidebandServerEvent::SessionInputAudioAppend, OpenAI::Models::Live::OutputAudioDeltaEvent, OpenAI::Models::Live::SidebandServerEvent::TransportDtmfReceived, OpenAI::Models::Live::SidebandServerEvent::TransportDtmfSend, OpenAI::Models::Live::SidebandServerEvent::TransportRinging, OpenAI::Models::Live::SidebandServerEvent::TransportAnswered, OpenAI::Models::Live::SidebandServerEvent::TransportFailed)]
       end
     end
   end

data/lib/openai/models/responses/response_compact_params.rb

@@ -486,7 +486,13 @@ module OpenAI
           # https://developers.openai.com/api/docs/deprecations for details and recommended
           # replacements.
           GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
+          # @deprecated Announced shutdown date: 2027-01-14. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_4_1 = :"gpt-4.1"
+          # @deprecated Announced shutdown date: 2027-01-14. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_4_1_MINI = :"gpt-4.1-mini"
           # @deprecated Announced shutdown date: 2026-10-23. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -552,6 +558,9 @@ module OpenAI
           # https://developers.openai.com/api/docs/deprecations for details and recommended
           # replacements.
           O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
+          # @deprecated Announced shutdown date: 2027-01-14. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_4O = :"gpt-4o"
           # @deprecated Announced shutdown date: 2027-01-14. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -621,6 +630,9 @@ module OpenAI
           # https://developers.openai.com/api/docs/deprecations for details and recommended
           # replacements.
           CODEX_MINI_LATEST = :"codex-mini-latest"
+          # @deprecated Announced shutdown date: 2027-01-14. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_4O_MINI = :"gpt-4o-mini"
           # @deprecated Announced shutdown date: 2027-01-14. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended

data/lib/openai/models.rb

@@ -125,6 +125,8 @@ module OpenAI
 
   DecisionInputText = OpenAI::Models::DecisionInputText
 
+  DecisionPromptCacheBreakpoint = OpenAI::Models::DecisionPromptCacheBreakpoint
+
   DeletedSkill = OpenAI::Models::DeletedSkill
 
   Embedding = OpenAI::Models::Embedding

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

@@ -1,10 +1,29 @@
 # frozen_string_literal: true
 
+require_relative "../../helpers/websocket/resource"
+
 module OpenAI
   module Resources
     class Beta
       # 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::Beta::BetaResponsesClientEvent
+        end
+
+        # @api private
+        def __websocket_server_event
+          OpenAI::Models::Beta::BetaResponsesServerEvent
+        end
+
         # Create and manage model responses.
         # @return [OpenAI::Resources::Beta::Responses::InputItems]
         attr_reader :input_items

data/lib/openai/resources/decisions.rb

@@ -6,7 +6,7 @@ module OpenAI
       # 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: {})
+      # @overload create(input:, model:, questions:, prompt_cache_key: nil, prompt_cache_options: nil, safety_identifier: nil, request_options: {})
       #
       # @param input [String, Array<OpenAI::Models::DecisionInputMessage>]
       #   The text or images to evaluate for every question. Provide a text string or user
@@ -21,6 +21,20 @@ module OpenAI
       #   Ask 1–200 questions about the input. Each question can be a predicate, choice,
       #   or score. Answers come back in the same order.
       #
+      # @param prompt_cache_key [String, nil]
+      #   Partition prompt cache reuse by caller-provided key.
+      #
+      # @param prompt_cache_options [OpenAI::Models::DecisionCreateParams::PromptCacheOptions, nil]
+      #   Options for prompt caching. Supported for `gpt-5.6` and later models. By
+      #   default, OpenAI automatically chooses one implicit cache breakpoint. You can add
+      #   explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
+      #   request can write up to four breakpoints. For cache matching, OpenAI considers
+      #   up to the latest 80 breakpoints in the conversation, without a content-block
+      #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
+      #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+      #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
+      #   for current details.
+      #
       # @param safety_identifier [String, nil]
       #   Opaque caller-provided end-user identifier, scoped by the verified org. Match
       #   Responses' limit; this is never the authenticated user identity.

data/lib/openai/resources/images.rb

@@ -72,7 +72,7 @@ module OpenAI
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
       # content type.
       #
-      # @overload edit(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
+      # @overload edit(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
       #   The image(s) to edit. Must be a supported image file or an array of images.
@@ -157,6 +157,14 @@ module OpenAI
       #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
+      # @param safety_identifier [String, nil]
+      #   A stable identifier for an end user in your organization, used for safety
+      #   monitoring and abuse detection. Hash a username or email address to avoid
+      #   sending identifying information. A non-empty value takes precedence over the
+      #   deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+      #   when available.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+      #
       # @param size [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
       #   The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
       #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
@@ -171,8 +179,9 @@ module OpenAI
       #   models that allow automatic sizing.
       #
       # @param user [String]
-      #   A unique identifier representing your end-user, which can help OpenAI to monitor
-      #   and detect abuse.
+      #   Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+      #   backward compatibility and is used when `safety_identifier` is omitted, null, or
+      #   empty.
       #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -187,6 +196,7 @@ module OpenAI
           raise ArgumentError.new(message)
         end
 
+        parsed.delete(:safety_identifier) if parsed[:safety_identifier].nil?
         @client.request(
           method: :post,
           path: "images/edits",
@@ -207,7 +217,7 @@ module OpenAI
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
       # content type.
       #
-      # @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
+      # @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
       #   The image(s) to edit. Must be a supported image file or an array of images.
@@ -292,6 +302,14 @@ module OpenAI
       #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
+      # @param safety_identifier [String, nil]
+      #   A stable identifier for an end user in your organization, used for safety
+      #   monitoring and abuse detection. Hash a username or email address to avoid
+      #   sending identifying information. A non-empty value takes precedence over the
+      #   deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+      #   when available.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+      #
       # @param size [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
       #   The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
       #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
@@ -306,8 +324,9 @@ module OpenAI
       #   models that allow automatic sizing.
       #
       # @param user [String]
-      #   A unique identifier representing your end-user, which can help OpenAI to monitor
-      #   and detect abuse.
+      #   Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+      #   backward compatibility and is used when `safety_identifier` is omitted, null, or
+      #   empty.
       #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -323,6 +342,7 @@ module OpenAI
         end
 
         parsed.store(:stream, true)
+        parsed.delete(:safety_identifier) if parsed[:safety_identifier].nil?
         @client.request(
           method: :post,
           path: "images/edits",
@@ -344,7 +364,7 @@ module OpenAI
       # Creates an image given a prompt using a GPT Image model.
       # [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
       #
-      # @overload generate(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
+      # @overload generate(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, style: nil, user: nil, request_options: {})
       #
       # @param prompt [String]
       #   A text description of the desired image(s). The maximum length is 32000
@@ -406,6 +426,14 @@ module OpenAI
       #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
+      # @param safety_identifier [String, nil]
+      #   A stable identifier for an end user in your organization, used for safety
+      #   monitoring and abuse detection. Hash a username or email address to avoid
+      #   sending identifying information. A non-empty value takes precedence over the
+      #   deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+      #   when available.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+      #
       # @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
       #   The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
       #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
@@ -423,8 +451,9 @@ module OpenAI
       #   models; describe the desired style in the prompt instead.
       #
       # @param user [String]
-      #   A unique identifier representing your end-user, which can help OpenAI to monitor
-      #   and detect abuse.
+      #   Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+      #   backward compatibility and is used when `safety_identifier` is omitted, null, or
+      #   empty.
       #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -454,7 +483,7 @@ module OpenAI
       # Creates an image given a prompt using a GPT Image model.
       # [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
       #
-      # @overload generate_stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
+      # @overload generate_stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, style: nil, user: nil, request_options: {})
       #
       # @param prompt [String]
       #   A text description of the desired image(s). The maximum length is 32000
@@ -516,6 +545,14 @@ module OpenAI
       #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
+      # @param safety_identifier [String, nil]
+      #   A stable identifier for an end user in your organization, used for safety
+      #   monitoring and abuse detection. Hash a username or email address to avoid
+      #   sending identifying information. A non-empty value takes precedence over the
+      #   deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+      #   when available.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+      #
       # @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
       #   The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
       #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
@@ -533,8 +570,9 @@ module OpenAI
       #   models; describe the desired style in the prompt instead.
       #
       # @param user [String]
-      #   A unique identifier representing your end-user, which can help OpenAI to monitor
-      #   and detect abuse.
+      #   Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+      #   backward compatibility and is used when `safety_identifier` is omitted, null, or
+      #   empty.
       #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/openai/version.rb

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