openai 0.60.0 → 0.62.0

data/rbi/openai/models/realtime/realtime_translation_session_update_request.rbi

@@ -0,0 +1,313 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeTranslationSessionUpdateRequest < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Configuration for translation input and output audio.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio
+            )
+          )
+        end
+        attr_reader :audio
+
+        sig do
+          params(
+            audio:
+              OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::OrHash
+          ).void
+        end
+        attr_writer :audio
+
+        # Realtime translation session fields that can be updated with `session.update`.
+        sig do
+          params(
+            audio:
+              OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Configuration for translation input and output audio.
+          audio: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              audio:
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Audio < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input
+              )
+            )
+          end
+          attr_reader :input
+
+          sig do
+            params(
+              input:
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::OrHash
+            ).void
+          end
+          attr_writer :input
+
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Output
+              )
+            )
+          end
+          attr_reader :output
+
+          sig do
+            params(
+              output:
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Output::OrHash
+            ).void
+          end
+          attr_writer :output
+
+          # Configuration for translation input and output audio.
+          sig do
+            params(
+              input:
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::OrHash,
+              output:
+                OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Output::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(input: nil, output: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                input:
+                  OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input,
+                output:
+                  OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Output
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Input < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Optional input noise reduction. Set to `null` to disable it.
+            sig do
+              returns(
+                T.nilable(
+                  OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction
+                )
+              )
+            end
+            attr_reader :noise_reduction
+
+            sig do
+              params(
+                noise_reduction:
+                  T.nilable(
+                    OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction::OrHash
+                  )
+              ).void
+            end
+            attr_writer :noise_reduction
+
+            # Optional source-language transcription. When configured, the server emits
+            # `session.input_transcript.delta` events. Translation itself still runs from the
+            # input audio stream.
+            sig do
+              returns(
+                T.nilable(
+                  OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription
+                )
+              )
+            end
+            attr_reader :transcription
+
+            sig do
+              params(
+                transcription:
+                  T.nilable(
+                    OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription::OrHash
+                  )
+              ).void
+            end
+            attr_writer :transcription
+
+            sig do
+              params(
+                noise_reduction:
+                  T.nilable(
+                    OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction::OrHash
+                  ),
+                transcription:
+                  T.nilable(
+                    OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription::OrHash
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Optional input noise reduction. Set to `null` to disable it.
+              noise_reduction: nil,
+              # Optional source-language transcription. When configured, the server emits
+              # `session.input_transcript.delta` events. Translation itself still runs from the
+              # input audio stream.
+              transcription: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  noise_reduction:
+                    T.nilable(
+                      OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction
+                    ),
+                  transcription:
+                    T.nilable(
+                      OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription
+                    )
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class NoiseReduction < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Type of noise reduction. `near_field` is for close-talking microphones such as
+              # headphones, `far_field` is for far-field microphones such as laptop or
+              # conference room microphones.
+              sig { returns(OpenAI::Realtime::NoiseReductionType::OrSymbol) }
+              attr_accessor :type
+
+              # Optional input noise reduction. Set to `null` to disable it.
+              sig do
+                params(
+                  type: OpenAI::Realtime::NoiseReductionType::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Type of noise reduction. `near_field` is for close-talking microphones such as
+                # headphones, `far_field` is for far-field microphones such as laptop or
+                # conference room microphones.
+                type:
+              )
+              end
+
+              sig do
+                override.returns(
+                  { type: OpenAI::Realtime::NoiseReductionType::OrSymbol }
+                )
+              end
+              def to_hash
+              end
+            end
+
+            class Transcription < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # The transcription model to use for source transcript deltas.
+              sig { returns(String) }
+              attr_accessor :model
+
+              # Optional source-language transcription. When configured, the server emits
+              # `session.input_transcript.delta` events. Translation itself still runs from the
+              # input audio stream.
+              sig { params(model: String).returns(T.attached_class) }
+              def self.new(
+                # The transcription model to use for source transcript deltas.
+                model:
+              )
+              end
+
+              sig { override.returns({ model: String }) }
+              def to_hash
+              end
+            end
+          end
+
+          class Output < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Output,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Target language for translated output audio and transcript deltas.
+            sig { returns(T.nilable(String)) }
+            attr_reader :language
+
+            sig { params(language: String).void }
+            attr_writer :language
+
+            sig { params(language: String).returns(T.attached_class) }
+            def self.new(
+              # Target language for translated output audio and transcript deltas.
+              language: nil
+            )
+            end
+
+            sig { override.returns({ language: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_translation_session_updated_event.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeTranslationSessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeTranslationSessionUpdatedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The translation session configuration.
+        sig { returns(OpenAI::Realtime::RealtimeTranslationSession) }
+        attr_reader :session
+
+        sig do
+          params(
+            session: OpenAI::Realtime::RealtimeTranslationSession::OrHash
+          ).void
+        end
+        attr_writer :session
+
+        # The event type, must be `session.updated`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when a translation session is updated with a `session.update` event,
+        # unless there is an error.
+        sig do
+          params(
+            event_id: String,
+            session: OpenAI::Realtime::RealtimeTranslationSession::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the server event.
+          event_id:,
+          # The translation session configuration.
+          session:,
+          # The event type, must be `session.updated`.
+          type: :"session.updated"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              session: OpenAI::Realtime::RealtimeTranslationSession,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/transcription_session_updated_event.rbi

@@ -108,7 +108,6 @@ module OpenAI
           sig { params(input_audio_format: String).void }
           attr_writer :input_audio_format
 
-          # Configuration of the transcription model.
           sig { returns(T.nilable(OpenAI::Realtime::AudioTranscription)) }
           attr_reader :input_audio_transcription
 
@@ -189,7 +188,6 @@ module OpenAI
             client_secret:,
             # The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
             input_audio_format: nil,
-            # Configuration of the transcription model.
             input_audio_transcription: nil,
             # The set of modalities the model can respond with. To disable audio, set this to
             # ["text"].

data/rbi/openai/models/responses/response.rbi

@@ -277,8 +277,9 @@ module OpenAI
         sig { params(text: OpenAI::Responses::ResponseTextConfig::OrHash).void }
         attr_writer :text
 
-        # An integer between 0 and 20 specifying the number of most likely tokens to
-        # return at each token position, each with an associated log probability.
+        # An integer between 0 and 20 specifying the maximum number of most likely tokens
+        # to return at each token position, each with an associated log probability. In
+        # some cases, the number of returned tokens may be fewer than requested.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :top_logprobs
 
@@ -568,8 +569,9 @@ module OpenAI
           # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
           # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
           text: nil,
-          # An integer between 0 and 20 specifying the number of most likely tokens to
-          # return at each token position, each with an associated log probability.
+          # An integer between 0 and 20 specifying the maximum number of most likely tokens
+          # to return at each token position, each with an associated log probability. In
+          # some cases, the number of returned tokens may be fewer than requested.
           top_logprobs: nil,
           # The truncation strategy to use for the model response.
           #

data/rbi/openai/models/responses/response_create_params.rbi

@@ -403,8 +403,9 @@ module OpenAI
         end
         attr_writer :tools
 
-        # An integer between 0 and 20 specifying the number of most likely tokens to
-        # return at each token position, each with an associated log probability.
+        # An integer between 0 and 20 specifying the maximum number of most likely tokens
+        # to return at each token position, each with an associated log probability. In
+        # some cases, the number of returned tokens may be fewer than requested.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :top_logprobs
 
@@ -691,8 +692,9 @@ module OpenAI
           #   [function calling](https://platform.openai.com/docs/guides/function-calling).
           #   You can also use custom tools to call your own code.
           tools: nil,
-          # An integer between 0 and 20 specifying the number of most likely tokens to
-          # return at each token position, each with an associated log probability.
+          # An integer between 0 and 20 specifying the maximum number of most likely tokens
+          # to return at each token position, each with an associated log probability. In
+          # some cases, the number of returned tokens may be fewer than requested.
           top_logprobs: nil,
           # An alternative to sampling with temperature, called nucleus sampling, where the
           # model considers the results of the tokens with top_p probability mass. So 0.1

data/rbi/openai/models/responses/response_includable.rbi

@@ -6,6 +6,8 @@ module OpenAI
       # Specify additional output data to include in the model response. Currently
       # supported values are:
       #
+      # - `web_search_call.results`: Include the search results of the web search tool
+      #   call.
       # - `web_search_call.action.sources`: Include the sources of the web search tool
       #   call.
       # - `code_interpreter_call.outputs`: Includes the outputs of python code execution

data/rbi/openai/models/responses/response_text_delta_event.rbi

@@ -109,7 +109,7 @@ module OpenAI
           sig { returns(Float) }
           attr_accessor :logprob
 
-          # The log probability of the top 20 most likely tokens.
+          # The log probabilities of up to 20 of the most likely tokens.
           sig do
             returns(
               T.nilable(
@@ -149,7 +149,7 @@ module OpenAI
             token:,
             # The log probability of this token.
             logprob:,
-            # The log probability of the top 20 most likely tokens.
+            # The log probabilities of up to 20 of the most likely tokens.
             top_logprobs: nil
           )
           end

data/rbi/openai/models/responses/response_text_done_event.rbi

@@ -109,7 +109,7 @@ module OpenAI
           sig { returns(Float) }
           attr_accessor :logprob
 
-          # The log probability of the top 20 most likely tokens.
+          # The log probabilities of up to 20 of the most likely tokens.
           sig do
             returns(
               T.nilable(
@@ -149,7 +149,7 @@ module OpenAI
             token:,
             # The log probability of this token.
             logprob:,
-            # The log probability of the top 20 most likely tokens.
+            # The log probabilities of up to 20 of the most likely tokens.
             top_logprobs: nil
           )
           end

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -405,8 +405,9 @@ module OpenAI
         end
         attr_writer :tools
 
-        # An integer between 0 and 20 specifying the number of most likely tokens to
-        # return at each token position, each with an associated log probability.
+        # An integer between 0 and 20 specifying the maximum number of most likely tokens
+        # to return at each token position, each with an associated log probability. In
+        # some cases, the number of returned tokens may be fewer than requested.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :top_logprobs
 
@@ -701,8 +702,9 @@ module OpenAI
           #   [function calling](https://platform.openai.com/docs/guides/function-calling).
           #   You can also use custom tools to call your own code.
           tools: nil,
-          # An integer between 0 and 20 specifying the number of most likely tokens to
-          # return at each token position, each with an associated log probability.
+          # An integer between 0 and 20 specifying the maximum number of most likely tokens
+          # to return at each token position, each with an associated log probability. In
+          # some cases, the number of returned tokens may be fewer than requested.
           top_logprobs: nil,
           # An alternative to sampling with temperature, called nucleus sampling, where the
           # model considers the results of the tokens with top_p probability mass. So 0.1