openai 0.20.0 → 0.21.0

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemAssistantMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The content of the message.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>]
+        required :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content] }
+
+        # @!attribute role
+        #   The role of the message sender. Always `assistant`.
+        #
+        #   @return [Symbol, :assistant]
+        required :role, const: :assistant
+
+        # @!attribute type
+        #   The type of the item. Always `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status }
+
+        # @!method initialize(content:, id: nil, object: nil, status: nil, role: :assistant, type: :message)
+        #   An assistant message item in a Realtime conversation.
+        #
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>] The content of the message.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param role [Symbol, :assistant] The role of the message sender. Always `assistant`.
+        #
+        #   @param type [Symbol, :message] The type of the item. Always `message`.
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text content.
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!attribute type
+          #   The content type. Always `text` for assistant messages.
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type, nil]
+          optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type }
+
+          # @!method initialize(text: nil, type: nil)
+          #   @param text [String] The text content.
+          #
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type] The content type. Always `text` for assistant messages.
+
+          # The content type. Always `text` for assistant messages.
+          #
+          # @see OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TEXT = :text
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemFunctionCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute arguments
+        #   The arguments of the function call.
+        #
+        #   @return [String]
+        required :arguments, String
+
+        # @!attribute name
+        #   The name of the function being called.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The type of the item. Always `function_call`.
+        #
+        #   @return [Symbol, :function_call]
+        required :type, const: :function_call
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute call_id
+        #   The ID of the function call.
+        #
+        #   @return [String, nil]
+        optional :call_id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status }
+
+        # @!method initialize(arguments:, name:, id: nil, call_id: nil, object: nil, status: nil, type: :function_call)
+        #   A function call item in a Realtime conversation.
+        #
+        #   @param arguments [String] The arguments of the function call.
+        #
+        #   @param name [String] The name of the function being called.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param call_id [String] The ID of the function call.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param type [Symbol, :function_call] The type of the item. Always `function_call`.
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemFunctionCallOutput < OpenAI::Internal::Type::BaseModel
+        # @!attribute call_id
+        #   The ID of the function call this output is for.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute output
+        #   The output of the function call.
+        #
+        #   @return [String]
+        required :output, String
+
+        # @!attribute type
+        #   The type of the item. Always `function_call_output`.
+        #
+        #   @return [Symbol, :function_call_output]
+        required :type, const: :function_call_output
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::Status }
+
+        # @!method initialize(call_id:, output:, id: nil, object: nil, status: nil, type: :function_call_output)
+        #   A function call output item in a Realtime conversation.
+        #
+        #   @param call_id [String] The ID of the function call this output is for.
+        #
+        #   @param output [String] The output of the function call.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param type [Symbol, :function_call_output] The type of the item. Always `function_call_output`.
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemSystemMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The content of the message.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content>]
+        required :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeConversationItemSystemMessage::Content] }
+
+        # @!attribute role
+        #   The role of the message sender. Always `system`.
+        #
+        #   @return [Symbol, :system]
+        required :role, const: :system
+
+        # @!attribute type
+        #   The type of the item. Always `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Status }
+
+        # @!method initialize(content:, id: nil, object: nil, status: nil, role: :system, type: :message)
+        #   A system message item in a Realtime conversation.
+        #
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content>] The content of the message.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param role [Symbol, :system] The role of the message sender. Always `system`.
+        #
+        #   @param type [Symbol, :message] The type of the item. Always `message`.
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text content.
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!attribute type
+          #   The content type. Always `input_text` for system messages.
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::Type, nil]
+          optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Content::Type }
+
+          # @!method initialize(text: nil, type: nil)
+          #   @param text [String] The text content.
+          #
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::Type] The content type. Always `input_text` for system messages.
+
+          # The content type. Always `input_text` for system messages.
+          #
+          # @see OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            INPUT_TEXT = :input_text
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemUserMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The content of the message.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content>]
+        required :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeConversationItemUserMessage::Content] }
+
+        # @!attribute role
+        #   The role of the message sender. Always `user`.
+        #
+        #   @return [Symbol, :user]
+        required :role, const: :user
+
+        # @!attribute type
+        #   The type of the item. Always `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Status }
+
+        # @!method initialize(content:, id: nil, object: nil, status: nil, role: :user, type: :message)
+        #   A user message item in a Realtime conversation.
+        #
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content>] The content of the message.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param role [Symbol, :user] The role of the message sender. Always `user`.
+        #
+        #   @param type [Symbol, :message] The type of the item. Always `message`.
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute audio
+          #   Base64-encoded audio bytes (for `input_audio`).
+          #
+          #   @return [String, nil]
+          optional :audio, String
+
+          # @!attribute text
+          #   The text content (for `input_text`).
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!attribute transcript
+          #   Transcript of the audio (for `input_audio`).
+          #
+          #   @return [String, nil]
+          optional :transcript, String
+
+          # @!attribute type
+          #   The content type (`input_text` or `input_audio`).
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type, nil]
+          optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type }
+
+          # @!method initialize(audio: nil, text: nil, transcript: nil, type: nil)
+          #   @param audio [String] Base64-encoded audio bytes (for `input_audio`).
+          #
+          #   @param text [String] The text content (for `input_text`).
+          #
+          #   @param transcript [String] Transcript of the audio (for `input_audio`).
+          #
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type] The content type (`input_text` or `input_audio`).
+
+          # The content type (`input_text` or `input_audio`).
+          #
+          # @see OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            INPUT_TEXT = :input_text
+            INPUT_AUDIO = :input_audio
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemUserMessage#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemUserMessage#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeError < OpenAI::Internal::Type::BaseModel
+        # @!attribute message
+        #   A human-readable error message.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute type
+        #   The type of error (e.g., "invalid_request_error", "server_error").
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!attribute code
+        #   Error code, if any.
+        #
+        #   @return [String, nil]
+        optional :code, String, nil?: true
+
+        # @!attribute event_id
+        #   The event_id of the client event that caused the error, if applicable.
+        #
+        #   @return [String, nil]
+        optional :event_id, String, nil?: true
+
+        # @!attribute param
+        #   Parameter related to the error, if any.
+        #
+        #   @return [String, nil]
+        optional :param, String, nil?: true
+
+        # @!method initialize(message:, type:, code: nil, event_id: nil, param: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::RealtimeError} for more details.
+        #
+        #   Details of the error.
+        #
+        #   @param message [String] A human-readable error message.
+        #
+        #   @param type [String] The type of error (e.g., "invalid_request_error", "server_error").
+        #
+        #   @param code [String, nil] Error code, if any.
+        #
+        #   @param event_id [String, nil] The event_id of the client event that caused the error, if applicable.
+        #
+        #   @param param [String, nil] Parameter related to the error, if any.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeErrorEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute error
+        #   Details of the error.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeError]
+        required :error, -> { OpenAI::Realtime::RealtimeError }
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute type
+        #   The event type, must be `error`.
+        #
+        #   @return [Symbol, :error]
+        required :type, const: :error
+
+        # @!method initialize(error:, event_id:, type: :error)
+        #   Returned when an error occurs, which could be a client problem or a server
+        #   problem. Most errors are recoverable and the session will stay open, we
+        #   recommend to implementors to monitor and log error messages by default.
+        #
+        #   @param error [OpenAI::Models::Realtime::RealtimeError] Details of the error.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param type [Symbol, :error] The event type, must be `error`.
+      end
+    end
+  end
+end