openai 0.88.0 → 0.89.0

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class SessionUpdateEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute session
+        #   Sparse delegation updates. Omitted settings retain their values. The delegation
+        #   type cannot change, including resetting Responses delegation to null or client.
+        #   Model, frontend instructions, audio, and startup input are immutable.
+        #
+        #   @return [OpenAI::Models::Live::SessionUpdateConfig]
+        required :session, -> { OpenAI::Live::SessionUpdateConfig }
+
+        # @!attribute type
+        #   The Live client event type. Always `session.update`.
+        #
+        #   @return [Symbol, :"session.update"]
+        required :type, const: :"session.update"
+
+        # @!attribute event_id
+        #   Optional client identifier for correlating this command with a server event's
+        #   client_event_id or error.client_event_id.
+        #
+        #   @return [String, nil]
+        optional :event_id, String, nil?: true
+
+        # @!method initialize(session:, event_id: nil, type: :"session.update")
+        #   Update the delegation settings of an active Live session. The server
+        #   acknowledges accepted changes with `session.updated`.
+        #
+        #   @param session [OpenAI::Models::Live::SessionUpdateConfig]
+        #     Sparse delegation updates. Omitted settings retain their values. The delegation
+        #     type cannot change, including resetting Responses delegation to null or client.
+        #     Model, frontend instructions, audio, and startup input are immutable.
+        #
+        #   @param event_id [String, nil]
+        #     Optional client identifier for correlating this command with a server event's
+        #     client_event_id or error.client_event_id.
+        #
+        #   @param type [Symbol, :"session.update"]
+        #     The Live client event type. Always `session.update`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class SessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the Live server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session
+        #   The resolved Live session configuration and server-assigned session metadata.
+        #
+        #   @return [OpenAI::Models::Live::SessionResource]
+        required :session, -> { OpenAI::Live::SessionResource }
+
+        # @!attribute type
+        #   The event type, always `session.updated`.
+        #
+        #   @return [Symbol, :"session.updated"]
+        required :type, const: :"session.updated"
+
+        # @!attribute client_event_id
+        #   The event_id of the client command associated with this server event, when
+        #   supplied.
+        #
+        #   @return [String, nil]
+        optional :client_event_id, String
+
+        # @!method initialize(event_id:, session:, client_event_id: nil, type: :"session.updated")
+        #   Returned when a Live session update is accepted. Contains the resolved session
+        #   configuration after the update.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the Live server event.
+        #
+        #   @param session [OpenAI::Models::Live::SessionResource]
+        #     The resolved Live session configuration and server-assigned session metadata.
+        #
+        #   @param client_event_id [String]
+        #     The event_id of the client command associated with this server event, when
+        #     supplied.
+        #
+        #   @param type [Symbol, :"session.updated"]
+        #     The event type, always `session.updated`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class SessionUsage < OpenAI::Internal::Type::BaseModel
+        # @!attribute seconds
+        #   The cumulative Live audio duration in seconds. Do not sum this value across
+        #   usage events.
+        #
+        #   @return [Float]
+        required :seconds, Float
+
+        # @!method initialize(seconds:)
+        #   Cumulative audio duration for a Live session. Values are totals for the session,
+        #   not increments to sum across usage events.
+        #
+        #   @param seconds [Float]
+        #     The cumulative Live audio duration in seconds. Do not sum this value across
+        #     usage events.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class SessionUsageUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the Live server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute type
+        #   The event type, always `session.usage.updated`.
+        #
+        #   @return [Symbol, :"session.usage.updated"]
+        required :type, const: :"session.usage.updated"
+
+        # @!attribute usage
+        #   The cumulative Live audio usage so far.
+        #
+        #   @return [OpenAI::Models::Live::SessionUsage]
+        required :usage, -> { OpenAI::Live::SessionUsage }
+
+        # @!attribute client_event_id
+        #   The event_id of the client command associated with this server event, when
+        #   supplied.
+        #
+        #   @return [String, nil]
+        optional :client_event_id, String
+
+        # @!attribute context_window
+        #   The latest measured Live context-window usage. Omitted when the context limit is
+        #   unknown.
+        #
+        #   @return [OpenAI::Models::Live::SessionUsageUpdatedEvent::ContextWindow, nil]
+        optional :context_window, -> { OpenAI::Live::SessionUsageUpdatedEvent::ContextWindow }
+
+        # @!method initialize(event_id:, usage:, client_event_id: nil, context_window: nil, type: :"session.usage.updated")
+        #   Reports cumulative Live audio usage and, when available, the most recent
+        #   context-window usage. Delegated Responses token usage is reported separately in
+        #   response.event events.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the Live server event.
+        #
+        #   @param usage [OpenAI::Models::Live::SessionUsage]
+        #     The cumulative Live audio usage so far.
+        #
+        #   @param client_event_id [String]
+        #     The event_id of the client command associated with this server event, when
+        #     supplied.
+        #
+        #   @param context_window [OpenAI::Models::Live::SessionUsageUpdatedEvent::ContextWindow]
+        #     The latest measured Live context-window usage. Omitted when the context limit is
+        #     unknown.
+        #
+        #   @param type [Symbol, :"session.usage.updated"]
+        #     The event type, always `session.usage.updated`.
+
+        # @see OpenAI::Models::Live::SessionUsageUpdatedEvent#context_window
+        class ContextWindow < OpenAI::Internal::Type::BaseModel
+          # @!attribute usage_ratio
+          #   The latest active context token count divided by the Live model context limit.
+          #   Can decrease after compaction and may lag between measured audio frames.
+          #
+          #   @return [Float]
+          required :usage_ratio, Float
+
+          # @!method initialize(usage_ratio:)
+          #   The latest measured Live context-window usage. Omitted when the context limit is
+          #   unknown.
+          #
+          #   @param usage_ratio [Float]
+          #     The latest active context token count divided by the Live model context limit.
+          #     Can decrease after compaction and may lag between measured audio frames.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class ThinkingAppendEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   Silent reasoning or progress context, limited to 500 tokens. It does not
+        #   directly request speech, but can influence later speech and is not a secrecy
+        #   boundary.
+        #
+        #   @return [String]
+        required :content, String
+
+        # @!attribute delegation_id
+        #   Required, nullable. Set null for general session context, or use the ID from
+        #   session.delegation.created for an existing client delegation. Non-null IDs are
+        #   not accepted with Responses delegation.
+        #
+        #   @return [String, nil]
+        required :delegation_id, String, nil?: true
+
+        # @!attribute type
+        #   The Live client event type. Always `session.thinking.append`.
+        #
+        #   @return [Symbol, :"session.thinking.append"]
+        required :type, const: :"session.thinking.append"
+
+        # @!attribute event_id
+        #   Optional client identifier for correlating this command with a server event's
+        #   client_event_id or error.client_event_id.
+        #
+        #   @return [String, nil]
+        optional :event_id, String, nil?: true
+
+        # @!method initialize(content:, delegation_id:, event_id: nil, type: :"session.thinking.append")
+        #   Provide silent reasoning or progress context to the Live model, optionally for
+        #   an existing client delegation.
+        #
+        #   @param content [String]
+        #     Silent reasoning or progress context, limited to 500 tokens. It does not
+        #     directly request speech, but can influence later speech and is not a secrecy
+        #     boundary.
+        #
+        #   @param delegation_id [String, nil]
+        #     Required, nullable. Set null for general session context, or use the ID from
+        #     session.delegation.created for an existing client delegation. Non-null IDs are
+        #     not accepted with Responses delegation.
+        #
+        #   @param event_id [String, nil]
+        #     Optional client identifier for correlating this command with a server event's
+        #     client_event_id or error.client_event_id.
+        #
+        #   @param type [Symbol, :"session.thinking.append"]
+        #     The Live client event type. Always `session.thinking.append`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class ThinkingAppendedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute end_ms
+        #   The end of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session. For appended context, this can equal start_ms.
+        #
+        #   @return [Integer]
+        required :end_ms, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the Live server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute start_ms
+        #   The start of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session.
+        #
+        #   @return [Integer]
+        required :start_ms, Integer
+
+        # @!attribute type
+        #   The event type, always `session.thinking.appended`.
+        #
+        #   @return [Symbol, :"session.thinking.appended"]
+        required :type, const: :"session.thinking.appended"
+
+        # @!attribute client_event_id
+        #   The event_id of the client command associated with this server event, when
+        #   supplied.
+        #
+        #   @return [String, nil]
+        optional :client_event_id, String
+
+        # @!method initialize(end_ms:, event_id:, start_ms:, client_event_id: nil, type: :"session.thinking.appended")
+        #   Returned when a session.thinking.append command is accepted into the Live
+        #   session timeline. Acknowledges the added reasoning context without guaranteeing
+        #   any spoken output.
+        #
+        #   @param end_ms [Integer]
+        #     The end of this event on the Live session timeline, in milliseconds from the
+        #     beginning of the session. For appended context, this can equal start_ms.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the Live server event.
+        #
+        #   @param start_ms [Integer]
+        #     The start of this event on the Live session timeline, in milliseconds from the
+        #     beginning of the session.
+        #
+        #   @param client_event_id [String]
+        #     The event_id of the client command associated with this server event, when
+        #     supplied.
+        #
+        #   @param type [Symbol, :"session.thinking.appended"]
+        #     The event type, always `session.thinking.appended`.
+      end
+    end
+  end
+end

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

@@ -655,6 +655,36 @@ module OpenAI
           #   @return [Symbol, :image_generation_call]
           required :type, const: :image_generation_call
 
+          # @!attribute action
+          #   The action used for image generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Action, nil]
+          optional(
+            :action,
+            enum: -> { OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Action },
+            nil?: true
+          )
+
+          # @!attribute background
+          #   The background setting used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Background, nil]
+          optional(
+            :background,
+            enum: -> { OpenAI::Responses::ResponseInputItem::ImageGenerationCall::Background },
+            nil?: true
+          )
+
+          # @!attribute output_format
+          #   The output format used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat, nil]
+          optional(
+            :output_format,
+            enum: -> { OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat },
+            nil?: true
+          )
+
           # @!attribute quality
           #   The quality of the image generated by the image generation tool call. One of
           #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
@@ -666,6 +696,12 @@ module OpenAI
             nil?: true
           )
 
+          # @!attribute revised_prompt
+          #   The prompt that was used after any model prompt rewriting.
+          #
+          #   @return [String, nil]
+          optional :revised_prompt, String, nil?: true
+
           # @!attribute size
           #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -678,7 +714,7 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, quality: nil, size: nil, type: :image_generation_call)
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
           #   @param id [String]
@@ -690,10 +726,22 @@ module OpenAI
           #   @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Status]
           #     The status of the image generation call.
           #
+          #   @param action [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Action, nil]
+          #     The action used for image generation.
+          #
+          #   @param background [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Background, nil]
+          #     The background setting used for generation.
+          #
+          #   @param output_format [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::OutputFormat, nil]
+          #     The output format used for generation.
+          #
           #   @param quality [Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Quality, nil]
           #     The quality of the image generated by the image generation tool call. One of
           #     `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #
+          #   @param revised_prompt [String, nil]
+          #     The prompt that was used after any model prompt rewriting.
+          #
           #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -715,6 +763,48 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
 
+          # The action used for image generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall#action
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            GENERATE = :generate
+            EDIT = :edit
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The background setting used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall#background
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TRANSPARENT = :transparent
+            OPAQUE = :opaque
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The output format used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall#output_format
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            PNG = :png
+            WEBP = :webp
+            JPEG = :jpeg
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #

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

@@ -291,6 +291,38 @@ module OpenAI
           #   @return [Symbol, :image_generation_call]
           required :type, const: :image_generation_call
 
+          # @!attribute action
+          #   The action used for image generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Action, nil]
+          optional(
+            :action,
+            enum: -> {
+              OpenAI::Responses::ResponseItem::ImageGenerationCall::Action
+            },
+            nil?: true
+          )
+
+          # @!attribute background
+          #   The background setting used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Background, nil]
+          optional(
+            :background,
+            enum: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::Background },
+            nil?: true
+          )
+
+          # @!attribute output_format
+          #   The output format used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::OutputFormat, nil]
+          optional(
+            :output_format,
+            enum: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat },
+            nil?: true
+          )
+
           # @!attribute quality
           #   The quality of the image generated by the image generation tool call. One of
           #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
@@ -304,13 +336,19 @@ module OpenAI
             nil?: true
           )
 
+          # @!attribute revised_prompt
+          #   The prompt that was used after any model prompt rewriting.
+          #
+          #   @return [String, nil]
+          optional :revised_prompt, String, nil?: true
+
           # @!attribute size
           #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
           #   @return [String, Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Size, nil]
           optional :size, union: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::Size }, nil?: true
 
-          # @!method initialize(id:, result:, status:, quality: nil, size: nil, type: :image_generation_call)
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
           #   @param id [String]
@@ -322,10 +360,22 @@ module OpenAI
           #   @param status [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Status]
           #     The status of the image generation call.
           #
+          #   @param action [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Action, nil]
+          #     The action used for image generation.
+          #
+          #   @param background [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Background, nil]
+          #     The background setting used for generation.
+          #
+          #   @param output_format [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::OutputFormat, nil]
+          #     The output format used for generation.
+          #
           #   @param quality [Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Quality, nil]
           #     The quality of the image generated by the image generation tool call. One of
           #     `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #
+          #   @param revised_prompt [String, nil]
+          #     The prompt that was used after any model prompt rewriting.
+          #
           #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -347,6 +397,48 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
 
+          # The action used for image generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseItem::ImageGenerationCall#action
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            GENERATE = :generate
+            EDIT = :edit
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The background setting used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseItem::ImageGenerationCall#background
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TRANSPARENT = :transparent
+            OPAQUE = :opaque
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The output format used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseItem::ImageGenerationCall#output_format
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            PNG = :png
+            WEBP = :webp
+            JPEG = :jpeg
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #