openai 0.20.0 → 0.21.0

data/lib/openai/models/realtime/input_audio_buffer_cleared_event.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class InputAudioBufferClearedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute type
+        #   The event type, must be `input_audio_buffer.cleared`.
+        #
+        #   @return [Symbol, :"input_audio_buffer.cleared"]
+        required :type, const: :"input_audio_buffer.cleared"
+
+        # @!method initialize(event_id:, type: :"input_audio_buffer.cleared")
+        #   Returned when the input audio buffer is cleared by the client with a
+        #   `input_audio_buffer.clear` event.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param type [Symbol, :"input_audio_buffer.cleared"] The event type, must be `input_audio_buffer.cleared`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/input_audio_buffer_commit_event.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class InputAudioBufferCommitEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The event type, must be `input_audio_buffer.commit`.
+        #
+        #   @return [Symbol, :"input_audio_buffer.commit"]
+        required :type, const: :"input_audio_buffer.commit"
+
+        # @!attribute event_id
+        #   Optional client-generated ID used to identify this event.
+        #
+        #   @return [String, nil]
+        optional :event_id, String
+
+        # @!method initialize(event_id: nil, type: :"input_audio_buffer.commit")
+        #   Send this event to commit the user input audio buffer, which will create a new
+        #   user message item in the conversation. This event will produce an error if the
+        #   input audio buffer is empty. When in Server VAD mode, the client does not need
+        #   to send this event, the server will commit the audio buffer automatically.
+        #
+        #   Committing the input audio buffer will trigger input audio transcription (if
+        #   enabled in session configuration), but it will not create a response from the
+        #   model. The server will respond with an `input_audio_buffer.committed` event.
+        #
+        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #
+        #   @param type [Symbol, :"input_audio_buffer.commit"] The event type, must be `input_audio_buffer.commit`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/input_audio_buffer_committed_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class InputAudioBufferCommittedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the user message item that will be created.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `input_audio_buffer.committed`.
+        #
+        #   @return [Symbol, :"input_audio_buffer.committed"]
+        required :type, const: :"input_audio_buffer.committed"
+
+        # @!attribute previous_item_id
+        #   The ID of the preceding item after which the new item will be inserted. Can be
+        #   `null` if the item has no predecessor.
+        #
+        #   @return [String, nil]
+        optional :previous_item_id, String, nil?: true
+
+        # @!method initialize(event_id:, item_id:, previous_item_id: nil, type: :"input_audio_buffer.committed")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::InputAudioBufferCommittedEvent} for more details.
+        #
+        #   Returned when an input audio buffer is committed, either by the client or
+        #   automatically in server VAD mode. The `item_id` property is the ID of the user
+        #   message item that will be created, thus a `conversation.item.created` event will
+        #   also be sent to the client.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the user message item that will be created.
+        #
+        #   @param previous_item_id [String, nil] The ID of the preceding item after which the new item will be inserted.
+        #
+        #   @param type [Symbol, :"input_audio_buffer.committed"] The event type, must be `input_audio_buffer.committed`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/input_audio_buffer_speech_started_event.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class InputAudioBufferSpeechStartedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute audio_start_ms
+        #   Milliseconds from the start of all audio written to the buffer during the
+        #   session when speech was first detected. This will correspond to the beginning of
+        #   audio sent to the model, and thus includes the `prefix_padding_ms` configured in
+        #   the Session.
+        #
+        #   @return [Integer]
+        required :audio_start_ms, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the user message item that will be created when speech stops.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `input_audio_buffer.speech_started`.
+        #
+        #   @return [Symbol, :"input_audio_buffer.speech_started"]
+        required :type, const: :"input_audio_buffer.speech_started"
+
+        # @!method initialize(audio_start_ms:, event_id:, item_id:, type: :"input_audio_buffer.speech_started")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::InputAudioBufferSpeechStartedEvent} for more details.
+        #
+        #   Sent by the server when in `server_vad` mode to indicate that speech has been
+        #   detected in the audio buffer. This can happen any time audio is added to the
+        #   buffer (unless speech is already detected). The client may want to use this
+        #   event to interrupt audio playback or provide visual feedback to the user.
+        #
+        #   The client should expect to receive a `input_audio_buffer.speech_stopped` event
+        #   when speech stops. The `item_id` property is the ID of the user message item
+        #   that will be created when speech stops and will also be included in the
+        #   `input_audio_buffer.speech_stopped` event (unless the client manually commits
+        #   the audio buffer during VAD activation).
+        #
+        #   @param audio_start_ms [Integer] Milliseconds from the start of all audio written to the buffer during the
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the user message item that will be created when speech stops.
+        #
+        #   @param type [Symbol, :"input_audio_buffer.speech_started"] The event type, must be `input_audio_buffer.speech_started`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/input_audio_buffer_speech_stopped_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class InputAudioBufferSpeechStoppedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute audio_end_ms
+        #   Milliseconds since the session started when speech stopped. This will correspond
+        #   to the end of audio sent to the model, and thus includes the
+        #   `min_silence_duration_ms` configured in the Session.
+        #
+        #   @return [Integer]
+        required :audio_end_ms, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the user message item that will be created.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `input_audio_buffer.speech_stopped`.
+        #
+        #   @return [Symbol, :"input_audio_buffer.speech_stopped"]
+        required :type, const: :"input_audio_buffer.speech_stopped"
+
+        # @!method initialize(audio_end_ms:, event_id:, item_id:, type: :"input_audio_buffer.speech_stopped")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::InputAudioBufferSpeechStoppedEvent} for more details.
+        #
+        #   Returned in `server_vad` mode when the server detects the end of speech in the
+        #   audio buffer. The server will also send an `conversation.item.created` event
+        #   with the user message item that is created from the audio buffer.
+        #
+        #   @param audio_end_ms [Integer] Milliseconds since the session started when speech stopped. This will
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the user message item that will be created.
+        #
+        #   @param type [Symbol, :"input_audio_buffer.speech_stopped"] The event type, must be `input_audio_buffer.speech_stopped`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class InputAudioBufferTimeoutTriggered < OpenAI::Internal::Type::BaseModel
+        # @!attribute audio_end_ms
+        #   Millisecond offset where speech ended within the buffered audio.
+        #
+        #   @return [Integer]
+        required :audio_end_ms, Integer
+
+        # @!attribute audio_start_ms
+        #   Millisecond offset where speech started within the buffered audio.
+        #
+        #   @return [Integer]
+        required :audio_start_ms, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the item associated with this segment.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `input_audio_buffer.timeout_triggered`.
+        #
+        #   @return [Symbol, :"input_audio_buffer.timeout_triggered"]
+        required :type, const: :"input_audio_buffer.timeout_triggered"
+
+        # @!method initialize(audio_end_ms:, audio_start_ms:, event_id:, item_id:, type: :"input_audio_buffer.timeout_triggered")
+        #   Returned when the server VAD timeout is triggered for the input audio buffer.
+        #
+        #   @param audio_end_ms [Integer] Millisecond offset where speech ended within the buffered audio.
+        #
+        #   @param audio_start_ms [Integer] Millisecond offset where speech started within the buffered audio.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the item associated with this segment.
+        #
+        #   @param type [Symbol, :"input_audio_buffer.timeout_triggered"] The event type, must be `input_audio_buffer.timeout_triggered`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/log_prob_properties.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class LogProbProperties < OpenAI::Internal::Type::BaseModel
+        # @!attribute token
+        #   The token that was used to generate the log probability.
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute bytes
+        #   The bytes that were used to generate the log probability.
+        #
+        #   @return [Array<Integer>]
+        required :bytes, OpenAI::Internal::Type::ArrayOf[Integer]
+
+        # @!attribute logprob
+        #   The log probability of the token.
+        #
+        #   @return [Float]
+        required :logprob, Float
+
+        # @!method initialize(token:, bytes:, logprob:)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::LogProbProperties} for more details.
+        #
+        #   A log probability object.
+        #
+        #   @param token [String] The token that was used to generate the log probability.
+        #
+        #   @param bytes [Array<Integer>] The bytes that were used to generate the log probability.
+        #
+        #   @param logprob [Float] The log probability of the token.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/mcp_list_tools_completed.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class McpListToolsCompleted < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP list tools item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `mcp_list_tools.completed`.
+        #
+        #   @return [Symbol, :"mcp_list_tools.completed"]
+        required :type, const: :"mcp_list_tools.completed"
+
+        # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.completed")
+        #   Returned when listing MCP tools has completed for an item.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP list tools item.
+        #
+        #   @param type [Symbol, :"mcp_list_tools.completed"] The event type, must be `mcp_list_tools.completed`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/mcp_list_tools_failed.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class McpListToolsFailed < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP list tools item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `mcp_list_tools.failed`.
+        #
+        #   @return [Symbol, :"mcp_list_tools.failed"]
+        required :type, const: :"mcp_list_tools.failed"
+
+        # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.failed")
+        #   Returned when listing MCP tools has failed for an item.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP list tools item.
+        #
+        #   @param type [Symbol, :"mcp_list_tools.failed"] The event type, must be `mcp_list_tools.failed`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/mcp_list_tools_in_progress.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class McpListToolsInProgress < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP list tools item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `mcp_list_tools.in_progress`.
+        #
+        #   @return [Symbol, :"mcp_list_tools.in_progress"]
+        required :type, const: :"mcp_list_tools.in_progress"
+
+        # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.in_progress")
+        #   Returned when listing MCP tools is in progress for an item.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP list tools item.
+        #
+        #   @param type [Symbol, :"mcp_list_tools.in_progress"] The event type, must be `mcp_list_tools.in_progress`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/output_audio_buffer_clear_event.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class OutputAudioBufferClearEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The event type, must be `output_audio_buffer.clear`.
+        #
+        #   @return [Symbol, :"output_audio_buffer.clear"]
+        required :type, const: :"output_audio_buffer.clear"
+
+        # @!attribute event_id
+        #   The unique ID of the client event used for error handling.
+        #
+        #   @return [String, nil]
+        optional :event_id, String
+
+        # @!method initialize(event_id: nil, type: :"output_audio_buffer.clear")
+        #   **WebRTC Only:** Emit to cut off the current audio response. This will trigger
+        #   the server to stop generating audio and emit a `output_audio_buffer.cleared`
+        #   event. This event should be preceded by a `response.cancel` client event to stop
+        #   the generation of the current response.
+        #   [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+        #
+        #   @param event_id [String] The unique ID of the client event used for error handling.
+        #
+        #   @param type [Symbol, :"output_audio_buffer.clear"] The event type, must be `output_audio_buffer.clear`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/rate_limits_updated_event.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RateLimitsUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute rate_limits
+        #   List of rate limit information.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit>]
+        required :rate_limits,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RateLimitsUpdatedEvent::RateLimit] }
+
+        # @!attribute type
+        #   The event type, must be `rate_limits.updated`.
+        #
+        #   @return [Symbol, :"rate_limits.updated"]
+        required :type, const: :"rate_limits.updated"
+
+        # @!method initialize(event_id:, rate_limits:, type: :"rate_limits.updated")
+        #   Emitted at the beginning of a Response to indicate the updated rate limits. When
+        #   a Response is created some tokens will be "reserved" for the output tokens, the
+        #   rate limits shown here reflect that reservation, which is then adjusted
+        #   accordingly once the Response is completed.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param rate_limits [Array<OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit>] List of rate limit information.
+        #
+        #   @param type [Symbol, :"rate_limits.updated"] The event type, must be `rate_limits.updated`.
+
+        class RateLimit < OpenAI::Internal::Type::BaseModel
+          # @!attribute limit
+          #   The maximum allowed value for the rate limit.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute name
+          #   The name of the rate limit (`requests`, `tokens`).
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit::Name, nil]
+          optional :name, enum: -> { OpenAI::Realtime::RateLimitsUpdatedEvent::RateLimit::Name }
+
+          # @!attribute remaining
+          #   The remaining value before the limit is reached.
+          #
+          #   @return [Integer, nil]
+          optional :remaining, Integer
+
+          # @!attribute reset_seconds
+          #   Seconds until the rate limit resets.
+          #
+          #   @return [Float, nil]
+          optional :reset_seconds, Float
+
+          # @!method initialize(limit: nil, name: nil, remaining: nil, reset_seconds: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit} for more details.
+          #
+          #   @param limit [Integer] The maximum allowed value for the rate limit.
+          #
+          #   @param name [Symbol, OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit::Name] The name of the rate limit (`requests`, `tokens`).
+          #
+          #   @param remaining [Integer] The remaining value before the limit is reached.
+          #
+          #   @param reset_seconds [Float] Seconds until the rate limit resets.
+
+          # The name of the rate limit (`requests`, `tokens`).
+          #
+          # @see OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit#name
+          module Name
+            extend OpenAI::Internal::Type::Enum
+
+            REQUESTS = :requests
+            TOKENS = :tokens
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end