openai 0.105.0 → 0.106.0

data/sig/openai/models/decision_create_params.rbs

@@ -5,6 +5,9 @@ module OpenAI
         input: OpenAI::Models::DecisionCreateParams::input,
         model: String,
         questions: ::Array[OpenAI::Models::DecisionCreateParams::question],
+        ?prompt_cache_key: String?,
+        ?prompt_cache_options: (OpenAI::DecisionCreateParams::PromptCacheOptions
+        | OpenAI::Models::DecisionCreateParams::prompt_cache_options)?,
         ?safety_identifier: String?,
         ?request_options: OpenAI::request_opts
       }
@@ -26,6 +29,21 @@ module OpenAI
       # or score. Answers come back in the same order.
       attr_accessor questions: ::Array[OpenAI::Models::DecisionCreateParams::question]
 
+      # Partition prompt cache reuse by caller-provided key.
+      attr_accessor prompt_cache_key: String?
+
+      # 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.
+      attr_accessor prompt_cache_options: (OpenAI::DecisionCreateParams::PromptCacheOptions
+      | OpenAI::Models::DecisionCreateParams::prompt_cache_options)?
+
       # Opaque caller-provided end-user identifier, scoped by the verified org. Match
       # Responses' limit; this is never the authenticated user identity.
       attr_accessor safety_identifier: String?
@@ -40,6 +58,18 @@ module OpenAI
       # @param questions
       #   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
+      #   Partition prompt cache reuse by caller-provided key.
+      # @param prompt_cache_options
+      #   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
       #   Opaque caller-provided end-user identifier, scoped by the verified org. Match
       #   Responses' limit; this is never the authenticated user identity.
@@ -47,6 +77,9 @@ module OpenAI
         input: OpenAI::Models::DecisionCreateParams::input,
         model: String,
         questions: ::Array[OpenAI::Models::DecisionCreateParams::question],
+        ?prompt_cache_key: String?,
+        ?prompt_cache_options: (OpenAI::DecisionCreateParams::PromptCacheOptions
+        | OpenAI::Models::DecisionCreateParams::prompt_cache_options)?,
         ?safety_identifier: String?,
         ?request_options: OpenAI::request_opts
       ) -> void
@@ -55,6 +88,9 @@ module OpenAI
         input: OpenAI::Models::DecisionCreateParams::input,
         model: String,
         questions: ::Array[OpenAI::Models::DecisionCreateParams::question],
+        ?prompt_cache_key: String?,
+        ?prompt_cache_options: (OpenAI::DecisionCreateParams::PromptCacheOptions
+        | OpenAI::Models::DecisionCreateParams::prompt_cache_options)?,
         ?safety_identifier: String?,
         ?request_options: OpenAI::RequestOptions
       }
@@ -233,6 +269,76 @@ module OpenAI
 
         def self?.variants: -> ::Array[OpenAI::Models::DecisionCreateParams::question]
       end
+
+      type prompt_cache_options =
+        {
+          ?mode: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::mode?,
+          ?ttl: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::ttl
+        }
+
+      class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
+        # Controls whether OpenAI automatically creates an implicit cache breakpoint.
+        # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
+        # and writes up to the latest three explicit breakpoints in the request. With
+        # `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
+        # latest four explicit breakpoints. If there are no explicit breakpoints, the
+        # request does not use prompt caching.
+        attr_accessor mode: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::mode?
+
+        # The minimum lifetime applied to every implicit and explicit cache breakpoint
+        # written by the request. Defaults to `30m`, which is currently the only supported
+        # value. The backend may retain cache entries for longer.
+        attr_reader ttl: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::ttl?
+
+        # The minimum lifetime applied to every implicit and explicit cache breakpoint
+        # written by the request. Defaults to `30m`, which is currently the only supported
+        # value. The backend may retain cache entries for longer.
+        def ttl=: (
+          OpenAI::Models::DecisionCreateParams::PromptCacheOptions::ttl
+        ) -> OpenAI::Models::DecisionCreateParams::PromptCacheOptions::ttl
+
+        # @param mode
+        #   Controls whether OpenAI automatically creates an implicit cache breakpoint.
+        #   Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
+        #   and writes up to the latest three explicit breakpoints in the request. With
+        #   `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
+        #   latest four explicit breakpoints. If there are no explicit breakpoints, the
+        #   request does not use prompt caching.
+        # @param ttl
+        #   The minimum lifetime applied to every implicit and explicit cache breakpoint
+        #   written by the request. Defaults to `30m`, which is currently the only supported
+        #   value. The backend may retain cache entries for longer.
+        def initialize: (
+          ?mode: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::mode?,
+          ?ttl: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::ttl
+        ) -> void
+
+        def to_hash: -> {
+          ?mode: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::mode?,
+          ?ttl: OpenAI::Models::DecisionCreateParams::PromptCacheOptions::ttl
+        }
+
+        type mode = :implicit | :explicit
+
+        module Mode
+          extend OpenAI::Internal::Type::Enum
+
+          IMPLICIT: :implicit
+          EXPLICIT: :explicit
+
+          def self?.values: -> ::Array[OpenAI::Models::DecisionCreateParams::PromptCacheOptions::mode]
+        end
+
+        type ttl = :"30m"
+
+        module Ttl
+          extend OpenAI::Internal::Type::Enum
+
+          TTL_30M: :"30m"
+
+          def self?.values: -> ::Array[OpenAI::Models::DecisionCreateParams::PromptCacheOptions::ttl]
+        end
+      end
     end
   end
 end

data/sig/openai/models/decision_input_image.rbs

@@ -4,7 +4,9 @@ module OpenAI
       {
         image_url: String,
         ?type: :input_image,
-        ?detail: OpenAI::Models::DecisionInputImage::detail?
+        ?detail: OpenAI::Models::DecisionInputImage::detail?,
+        ?prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+        | OpenAI::Models::decision_prompt_cache_breakpoint)?
       }
 
     class DecisionInputImage < OpenAI::Internal::Type::BaseModel
@@ -17,21 +19,35 @@ module OpenAI
       # auto.
       attr_accessor detail: OpenAI::Models::DecisionInputImage::detail?
 
+      # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+      # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+      # token block.
+      attr_accessor prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+      | OpenAI::Models::decision_prompt_cache_breakpoint)?
+
       # @param image_url
       #   A base64-encoded image in a data URL or a publicly accessible HTTP(S) image URL.
       # @param detail
       #   The image detail level, using the selected model's image profile. Defaults to
       #   auto.
+      # @param prompt_cache_breakpoint
+      #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+      #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+      #   token block.
       def initialize: (
         image_url: String,
         ?detail: OpenAI::Models::DecisionInputImage::detail?,
+        ?prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+        | OpenAI::Models::decision_prompt_cache_breakpoint)?,
         ?type: :input_image
       ) -> void
 
       def to_hash: -> {
         image_url: String,
         ?type: :input_image,
-        ?detail: OpenAI::Models::DecisionInputImage::detail?
+        ?detail: OpenAI::Models::DecisionInputImage::detail?,
+        ?prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+        | OpenAI::Models::decision_prompt_cache_breakpoint)?
       }
 
       type detail = :low | :high | :auto | :original

data/sig/openai/models/decision_input_text.rbs

@@ -1,15 +1,41 @@
 module OpenAI
   module Models
-    type decision_input_text = { text: String, ?type: :input_text }
+    type decision_input_text =
+      {
+        text: String,
+        ?type: :input_text,
+        ?prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+        | OpenAI::Models::decision_prompt_cache_breakpoint)?
+      }
 
     class DecisionInputText < OpenAI::Internal::Type::BaseModel
       attr_accessor text: String
 
       attr_accessor type: :input_text
 
-      def initialize: (text: String, ?type: :input_text) -> void
+      # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+      # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+      # token block.
+      attr_accessor prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+      | OpenAI::Models::decision_prompt_cache_breakpoint)?
 
-      def to_hash: -> { text: String, ?type: :input_text }
+      # @param prompt_cache_breakpoint
+      #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+      #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+      #   token block.
+      def initialize: (
+        text: String,
+        ?prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+        | OpenAI::Models::decision_prompt_cache_breakpoint)?,
+        ?type: :input_text
+      ) -> void
+
+      def to_hash: -> {
+        text: String,
+        ?type: :input_text,
+        ?prompt_cache_breakpoint: (OpenAI::DecisionPromptCacheBreakpoint
+        | OpenAI::Models::decision_prompt_cache_breakpoint)?
+      }
     end
   end
 end

data/sig/openai/models/decision_prompt_cache_breakpoint.rbs

@@ -0,0 +1,16 @@
+module OpenAI
+  module Models
+    type decision_prompt_cache_breakpoint = { ?mode: :explicit }
+
+    class DecisionPromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+      # The breakpoint mode. Always `explicit`.
+      attr_accessor mode: :explicit
+
+      # @param mode
+      #   The breakpoint mode. Always `explicit`.
+      def initialize: (?mode: :explicit) -> void
+
+      def to_hash: -> { ?mode: :explicit }
+    end
+  end
+end

data/sig/openai/models/live/sideband_server_event.rbs

@@ -22,10 +22,235 @@ module OpenAI
         | OpenAI::Live::SessionClosedEvent
         | OpenAI::Live::ErrorEvent
         | OpenAI::Live::InfoEvent
+        | OpenAI::Live::SidebandServerEvent::SessionInputAudioAppend
+        | OpenAI::Live::OutputAudioDeltaEvent
+        | OpenAI::Live::SidebandServerEvent::TransportDtmfReceived
+        | OpenAI::Live::SidebandServerEvent::TransportDtmfSend
+        | OpenAI::Live::SidebandServerEvent::TransportRinging
+        | OpenAI::Live::SidebandServerEvent::TransportAnswered
+        | OpenAI::Live::SidebandServerEvent::TransportFailed
 
       module SidebandServerEvent
         extend OpenAI::Internal::Type::Union
 
+        type session_input_audio_append =
+          { audio: String, ?type: :"session.input_audio.append" }
+
+        class SessionInputAudioAppend < OpenAI::Internal::Type::BaseModel
+          # 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.
+          attr_accessor audio: String
+
+          # The event type, always `session.input_audio.append`.
+          attr_accessor type: :"session.input_audio.append"
+
+          # @param 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.
+          # @param type
+          #   The event type, always `session.input_audio.append`.
+          def initialize: (
+            audio: String,
+            ?type: :"session.input_audio.append"
+          ) -> void
+
+          def to_hash: -> {
+            audio: String,
+            ?type: :"session.input_audio.append"
+          }
+        end
+
+        type transport_dtmf_received =
+          { event: String, event_id: String, ?type: :"transport.dtmf.received" }
+
+        class TransportDtmfReceived < OpenAI::Internal::Type::BaseModel
+          attr_accessor event: String
+
+          attr_accessor event_id: String
+
+          attr_accessor type: :"transport.dtmf.received"
+
+          def initialize: (
+            event: String,
+            event_id: String,
+            ?type: :"transport.dtmf.received"
+          ) -> void
+
+          def to_hash: -> {
+            event: String,
+            event_id: String,
+            ?type: :"transport.dtmf.received"
+          }
+        end
+
+        type transport_dtmf_send =
+          {
+            event: String,
+            event_id: String,
+            ?type: :"transport.dtmf.send",
+            ?client_event_id: String
+          }
+
+        class TransportDtmfSend < OpenAI::Internal::Type::BaseModel
+          attr_accessor event: String
+
+          attr_accessor event_id: String
+
+          attr_accessor type: :"transport.dtmf.send"
+
+          # The event_id of the client command, when supplied.
+          attr_reader client_event_id: String?
+
+          # The event_id of the client command, when supplied.
+          def client_event_id=: (String) -> String
+
+          # @param client_event_id
+          #   The event_id of the client command, when supplied.
+          def initialize: (
+            event: String,
+            event_id: String,
+            ?client_event_id: String,
+            ?type: :"transport.dtmf.send"
+          ) -> void
+
+          def to_hash: -> {
+            event: String,
+            event_id: String,
+            ?type: :"transport.dtmf.send",
+            ?client_event_id: String
+          }
+        end
+
+        type transport_ringing =
+          { event_id: String, session_id: String, ?type: :"transport.ringing" }
+
+        class TransportRinging < OpenAI::Internal::Type::BaseModel
+          attr_accessor event_id: String
+
+          # The canonical Live session ID.
+          attr_accessor session_id: String
+
+          attr_accessor type: :"transport.ringing"
+
+          # @param session_id
+          #   The canonical Live session ID.
+          def initialize: (
+            event_id: String,
+            session_id: String,
+            ?type: :"transport.ringing"
+          ) -> void
+
+          def to_hash: -> {
+            event_id: String,
+            session_id: String,
+            ?type: :"transport.ringing"
+          }
+        end
+
+        type transport_answered =
+          { event_id: String, session_id: String, ?type: :"transport.answered" }
+
+        class TransportAnswered < OpenAI::Internal::Type::BaseModel
+          attr_accessor event_id: String
+
+          # The canonical Live session ID.
+          attr_accessor session_id: String
+
+          attr_accessor type: :"transport.answered"
+
+          # @param session_id
+          #   The canonical Live session ID.
+          def initialize: (
+            event_id: String,
+            session_id: String,
+            ?type: :"transport.answered"
+          ) -> void
+
+          def to_hash: -> {
+            event_id: String,
+            session_id: String,
+            ?type: :"transport.answered"
+          }
+        end
+
+        type transport_failed =
+          {
+            error: OpenAI::Live::SidebandServerEvent::TransportFailed::Error,
+            event_id: String,
+            session_id: String,
+            ?type: :"transport.failed"
+          }
+
+        class TransportFailed < OpenAI::Internal::Type::BaseModel
+          attr_accessor error: OpenAI::Live::SidebandServerEvent::TransportFailed::Error
+
+          attr_accessor event_id: String
+
+          # The canonical Live session ID.
+          attr_accessor session_id: String
+
+          attr_accessor type: :"transport.failed"
+
+          # @param session_id
+          #   The canonical Live session ID.
+          def initialize: (
+            error: OpenAI::Live::SidebandServerEvent::TransportFailed::Error,
+            event_id: String,
+            session_id: String,
+            ?type: :"transport.failed"
+          ) -> void
+
+          def to_hash: -> {
+            error: OpenAI::Live::SidebandServerEvent::TransportFailed::Error,
+            event_id: String,
+            session_id: String,
+            ?type: :"transport.failed"
+          }
+
+          type error =
+            {
+              code: String,
+              message: String,
+              ?type: :call_error,
+              ?param: String
+            }
+
+          class Error < OpenAI::Internal::Type::BaseModel
+            # The call setup failure code.
+            attr_accessor code: String
+
+            attr_accessor message: String
+
+            attr_accessor type: :call_error
+
+            # The parameter related to the error, if any. Empty when no parameter applies.
+            attr_reader param: String?
+
+            # The parameter related to the error, if any. Empty when no parameter applies.
+            def param=: (String) -> String
+
+            # @param code
+            #   The call setup failure code.
+            # @param param
+            #   The parameter related to the error, if any. Empty when no parameter applies.
+            def initialize: (
+              code: String,
+              message: String,
+              ?param: String,
+              ?type: :call_error
+            ) -> void
+
+            def to_hash: -> {
+              code: String,
+              message: String,
+              ?type: :call_error,
+              ?param: String
+            }
+          end
+        end
+
         def self?.variants: -> ::Array[OpenAI::Models::Live::sideband_server_event]
       end
     end

data/sig/openai/models.rbs

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

data/sig/openai/resources/beta/responses.rbs

@@ -2,6 +2,13 @@ module OpenAI
   module Resources
     class Beta
       class Responses
+        include OpenAI::WebSocket::Resource
+        def __websocket_request: (
+          ?query: Hash[untyped, untyped]
+        ) -> Hash[Symbol, untyped]
+        def __websocket_client_event: -> untyped
+        def __websocket_server_event: -> untyped
+
         attr_reader input_items: OpenAI::Resources::Beta::Responses::InputItems
 
         attr_reader input_tokens: OpenAI::Resources::Beta::Responses::InputTokens

data/sig/openai/resources/decisions.rbs

@@ -5,6 +5,9 @@ module OpenAI
         input: OpenAI::Models::DecisionCreateParams::input,
         model: String,
         questions: ::Array[OpenAI::Models::DecisionCreateParams::question],
+        ?prompt_cache_key: String?,
+        ?prompt_cache_options: (OpenAI::DecisionCreateParams::PromptCacheOptions
+        | OpenAI::Models::DecisionCreateParams::prompt_cache_options)?,
         ?safety_identifier: String?,
         ?request_options: OpenAI::request_opts
       ) -> OpenAI::Decision

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.105.0
+  version: 0.106.0
 platform: ruby
 authors:
 - OpenAI
@@ -1014,6 +1014,7 @@ files:
 - lib/openai/models/decision_input_message.rb
 - lib/openai/models/decision_input_part.rb
 - lib/openai/models/decision_input_text.rb
+- lib/openai/models/decision_prompt_cache_breakpoint.rb
 - lib/openai/models/deleted_skill.rb
 - lib/openai/models/embedding.rb
 - lib/openai/models/embedding_create_params.rb
@@ -2668,6 +2669,7 @@ files:
 - rbi/openai/models/decision_input_message.rbi
 - rbi/openai/models/decision_input_part.rbi
 - rbi/openai/models/decision_input_text.rbi
+- rbi/openai/models/decision_prompt_cache_breakpoint.rbi
 - rbi/openai/models/deleted_skill.rbi
 - rbi/openai/models/embedding.rbi
 - rbi/openai/models/embedding_create_params.rbi
@@ -4311,6 +4313,7 @@ files:
 - sig/openai/models/decision_input_message.rbs
 - sig/openai/models/decision_input_part.rbs
 - sig/openai/models/decision_input_text.rbs
+- sig/openai/models/decision_prompt_cache_breakpoint.rbs
 - sig/openai/models/deleted_skill.rbs
 - sig/openai/models/embedding.rbs
 - sig/openai/models/embedding_create_params.rbs