openai 0.110.0 → 0.112.0

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

@@ -10,10 +10,29 @@ module OpenAI
         #   @return [Symbol, :client]
         required :type, const: :client
 
-        # @!method initialize(type: :client)
+        # @!attribute acknowledgement_delay_ms
+        #   Milliseconds to wait before requesting an automatic spoken acknowledgement for a
+        #   delegation. The model may still speak before this delay. Any commentary or
+        #   thinking appended to the session cancels all pending acknowledgements, including
+        #   those for other delegations. Defaults to 400 for Decisions sessions and 0
+        #   (request immediately) for other sessions. Omission in a session update preserves
+        #   the current value. Updates apply to subsequent delegations.
+        #
+        #   @return [Integer, nil]
+        optional :acknowledgement_delay_ms, Integer
+
+        # @!method initialize(acknowledgement_delay_ms: nil, type: :client)
         #   Delegate tasks to your application. The Live session emits delegation events
         #   that your backend handles.
         #
+        #   @param acknowledgement_delay_ms [Integer]
+        #     Milliseconds to wait before requesting an automatic spoken acknowledgement for a
+        #     delegation. The model may still speak before this delay. Any commentary or
+        #     thinking appended to the session cancels all pending acknowledgements, including
+        #     those for other delegations. Defaults to 400 for Decisions sessions and 0
+        #     (request immediately) for other sessions. Omission in a session update preserves
+        #     the current value. Updates apply to subsequent delegations.
+        #
         #   @param type [Symbol, :client]
         #     The delegation owner. Always `client` for tasks handled by your application.
       end

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

@@ -25,19 +25,19 @@ module OpenAI
         # Mute audio input to the Live model without closing the session. The server acknowledges with `session.input_audio.muted`.
         variant :"session.input_audio.mute", -> { OpenAI::Live::InputAudioMuteEvent }
 
-        # Resume audio input to a Live model after muting it. The server acknowledges with `session.input_audio.unmuted`.
+        # Resume audio input to a Live model after muting it. The server acknowledges with `session.input_audio.unmuted`. An active audio fixture still pauses inference until playback finishes.
         variant :"session.input_audio.unmute", -> { OpenAI::Live::InputAudioUnmuteEvent }
 
         # Play one complete audio fixture through the session output. Send this event over the primary WebSocket or a server sideband. Audio must be raw mono PCM16 little-endian at 24 kHz, regardless of the session audio format, and at most 30 seconds. The entire payload is validated before model speech is interrupted and input is muted. Only one fixture can be active. fixture.playing acknowledges acceptance and fixture.played reports server mixer drain. These notifications are not exact transport-media boundaries. Input arriving during playback is dropped and not replayed.
         variant :"session.output_audio.fixture.play", -> { OpenAI::Live::OutputAudioFixturePlayEvent }
 
-        # Append instructions to the Live conversation while it is running, optionally associating them with an existing client delegation.
+        # Append developer instructions to the Live conversation while it is running, optionally associating them with an existing client delegation. Rejected while an audio fixture is active. These instructions remain in conversation history through compaction and are included in future backend delegations. For external audio, describe content already delivered so the assistant does not repeat it.
         variant :"session.instructions.append", -> { OpenAI::Live::InstructionsAppendEvent }
 
-        # Provide silent reasoning or progress context to the Live model, optionally for an existing client delegation.
+        # Provide silent reasoning or progress context to the Live model, optionally for an existing client delegation. Rejected while an audio fixture is active.
         variant :"session.thinking.append", -> { OpenAI::Live::ThinkingAppendEvent }
 
-        # Provide context the Live model can communicate to the user, optionally for an existing client delegation.
+        # Provide context the Live model can communicate to the user, optionally for an existing client delegation. Rejected while an audio fixture is active.
         variant :"session.commentary.append", -> { OpenAI::Live::CommentaryAppendEvent }
 
         # Evaluate the configured questions using the current conversation and Decision inputs. Reusing an event_id is rejected for the lifetime of the session.

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

@@ -35,7 +35,7 @@ module OpenAI
 
         # @!method initialize(content:, delegation_id:, event_id: nil, type: :"session.commentary.append")
         #   Provide context the Live model can communicate to the user, optionally for an
-        #   existing client delegation.
+        #   existing client delegation. Rejected while an audio fixture is active.
         #
         #   @param content [String]
         #     Speakable context for the Live model, limited to 500 tokens. Use this for a

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

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class DecisionAssistantMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The text input to the model.
+        #
+        #   @return [String, Array<OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::OutputText, OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::Refusal>]
+        required :content, union: -> { OpenAI::Live::DecisionAssistantMessage::Content }
+
+        # @!attribute role
+        #
+        #   @return [Symbol, :assistant]
+        required :role, const: :assistant
+
+        # @!attribute id
+        #   The unique ID of this message item.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute phase
+        #   Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        #   final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        #   sending follow-up requests, preserve and resend phase on all assistant messages
+        #   — dropping it can degrade performance. Not used for user messages.
+        #
+        #   @return [Symbol, OpenAI::Models::Live::DecisionAssistantMessage::Phase, nil]
+        optional :phase, enum: -> { OpenAI::Live::DecisionAssistantMessage::Phase }, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [Symbol, OpenAI::Models::Live::DecisionAssistantMessage::Type, nil]
+        optional :type, enum: -> { OpenAI::Live::DecisionAssistantMessage::Type }
+
+        # @!method initialize(content:, id: nil, phase: nil, type: nil, role: :assistant)
+        #   @param content [String, Array<OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::OutputText, OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::Refusal>]
+        #     The text input to the model.
+        #
+        #   @param id [String, nil]
+        #     The unique ID of this message item.
+        #
+        #   @param phase [Symbol, OpenAI::Models::Live::DecisionAssistantMessage::Phase, nil]
+        #     Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        #     final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        #     sending follow-up requests, preserve and resend phase on all assistant messages
+        #     — dropping it can degrade performance. Not used for user messages.
+        #
+        #   @param type [Symbol, OpenAI::Models::Live::DecisionAssistantMessage::Type]
+        #
+        #   @param role [Symbol, :assistant]
+
+        # The text input to the model.
+        #
+        # @see OpenAI::Models::Live::DecisionAssistantMessage#content
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          # The text input to the model.
+          variant String
+
+          variant -> { OpenAI::Models::Live::DecisionAssistantMessage::Content::PartsArray }
+
+          module Part
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            variant :output_text, -> { OpenAI::Live::DecisionAssistantMessage::Content::Part::OutputText }
+
+            variant :refusal, -> { OpenAI::Live::DecisionAssistantMessage::Content::Part::Refusal }
+
+            class OutputText < OpenAI::Internal::Type::BaseModel
+              # @!attribute text
+              #   The text content.
+              #
+              #   @return [String]
+              required :text, String
+
+              # @!attribute type
+              #
+              #   @return [Symbol, :output_text]
+              required :type, const: :output_text
+
+              # @!method initialize(text:, type: :output_text)
+              #   @param text [String]
+              #     The text content.
+              #
+              #   @param type [Symbol, :output_text]
+            end
+
+            class Refusal < OpenAI::Internal::Type::BaseModel
+              # @!attribute refusal
+              #   The refusal text.
+              #
+              #   @return [String]
+              required :refusal, String
+
+              # @!attribute type
+              #
+              #   @return [Symbol, :refusal]
+              required :type, const: :refusal
+
+              # @!method initialize(refusal:, type: :refusal)
+              #   @param refusal [String]
+              #     The refusal text.
+              #
+              #   @param type [Symbol, :refusal]
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::OutputText, OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::Refusal)]
+          end
+
+          # @!method self.variants
+          #   @return [Array(String, Array<OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::OutputText, OpenAI::Models::Live::DecisionAssistantMessage::Content::Part::Refusal>)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          PartsArray = OpenAI::Internal::Type::ArrayOf[
+            union: -> { OpenAI::Live::DecisionAssistantMessage::Content::Part }
+          ]
+        end
+
+        # Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        # final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        #
+        # @see OpenAI::Models::Live::DecisionAssistantMessage#phase
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          COMMENTARY = :commentary
+          FINAL_ANSWER = :final_answer
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Live::DecisionAssistantMessage#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          MESSAGE = :message
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class DecisionChoiceOption < OpenAI::Internal::Type::BaseModel
+        # @!attribute value
+        #
+        #   @return [String, Boolean]
+        required :value, union: -> { OpenAI::Live::DecisionChoiceOption::Value }
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!method initialize(value:, description: nil)
+        #   @param value [String, Boolean]
+        #   @param description [String]
+
+        # @see OpenAI::Models::Live::DecisionChoiceOption#value
+        module Value
+          extend OpenAI::Internal::Type::Union
+
+          variant String
+
+          variant OpenAI::Internal::Type::Boolean
+
+          # @!method self.variants
+          #   @return [Array(String, Boolean)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class DecisionDeveloperMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The text input to the model.
+        #
+        #   @return [String, Array<OpenAI::Models::Live::DecisionInputText>]
+        required :content, union: -> { OpenAI::Live::DecisionDeveloperMessage::Content }
+
+        # @!attribute role
+        #
+        #   @return [Symbol, :developer]
+        required :role, const: :developer
+
+        # @!attribute id
+        #   The unique ID of this message item.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [Symbol, OpenAI::Models::Live::DecisionDeveloperMessage::Type, nil]
+        optional :type, enum: -> { OpenAI::Live::DecisionDeveloperMessage::Type }
+
+        # @!method initialize(content:, id: nil, type: nil, role: :developer)
+        #   @param content [String, Array<OpenAI::Models::Live::DecisionInputText>]
+        #     The text input to the model.
+        #
+        #   @param id [String, nil]
+        #     The unique ID of this message item.
+        #
+        #   @param type [Symbol, OpenAI::Models::Live::DecisionDeveloperMessage::Type]
+        #
+        #   @param role [Symbol, :developer]
+
+        # The text input to the model.
+        #
+        # @see OpenAI::Models::Live::DecisionDeveloperMessage#content
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          # The text input to the model.
+          variant String
+
+          variant -> { OpenAI::Models::Live::DecisionDeveloperMessage::Content::DecisionInputTextArray }
+
+          # @!method self.variants
+          #   @return [Array(String, Array<OpenAI::Models::Live::DecisionInputText>)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          DecisionInputTextArray = OpenAI::Internal::Type::ArrayOf[-> { OpenAI::Live::DecisionInputText }]
+        end
+
+        # @see OpenAI::Models::Live::DecisionDeveloperMessage#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          MESSAGE = :message
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class DecisionInputText < OpenAI::Internal::Type::BaseModel
+        # @!attribute text
+        #   The text input to the model.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :input_text]
+        required :type, const: :input_text
+
+        # @!method initialize(text:, type: :input_text)
+        #   @param text [String]
+        #     The text input to the model.
+        #
+        #   @param type [Symbol, :input_text]
+      end
+    end
+  end
+end