openai 0.22.1 → 0.23.0

data/rbi/openai/models/realtime/realtime_conversation_item_assistant_message.rbi

@@ -30,14 +30,16 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The unique ID of the item.
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         sig { returns(T.nilable(String)) }
         attr_reader :id
 
         sig { params(id: String).void }
         attr_writer :id
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         sig do
           returns(
             T.nilable(
@@ -92,9 +94,11 @@ module OpenAI
         def self.new(
           # The content of the message.
           content:,
-          # The unique ID of the item.
+          # The unique ID of the item. This may be provided by the client or generated by
+          # the server.
           id: nil,
-          # Identifier for the API object being returned - always `realtime.item`.
+          # Identifier for the API object being returned - always `realtime.item`. Optional
+          # when creating a new item.
           object: nil,
           # The status of the item. Has no effect on the conversation.
           status: nil,
@@ -134,6 +138,15 @@ module OpenAI
               )
             end
 
+          # Base64-encoded audio bytes, these will be parsed as the format specified in the
+          # session output audio type configuration. This defaults to PCM 16-bit 24kHz mono
+          # if not specified.
+          sig { returns(T.nilable(String)) }
+          attr_reader :audio
+
+          sig { params(audio: String).void }
+          attr_writer :audio
+
           # The text content.
           sig { returns(T.nilable(String)) }
           attr_reader :text
@@ -141,7 +154,16 @@ module OpenAI
           sig { params(text: String).void }
           attr_writer :text
 
-          # The content type. Always `text` for assistant messages.
+          # The transcript of the audio content, this will always be present if the output
+          # type is `audio`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :transcript
+
+          sig { params(transcript: String).void }
+          attr_writer :transcript
+
+          # The content type, `output_text` or `output_audio` depending on the session
+          # `output_modalities` configuration.
           sig do
             returns(
               T.nilable(
@@ -161,15 +183,25 @@ module OpenAI
 
           sig do
             params(
+              audio: String,
               text: String,
+              transcript: String,
               type:
                 OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
+            # Base64-encoded audio bytes, these will be parsed as the format specified in the
+            # session output audio type configuration. This defaults to PCM 16-bit 24kHz mono
+            # if not specified.
+            audio: nil,
             # The text content.
             text: nil,
-            # The content type. Always `text` for assistant messages.
+            # The transcript of the audio content, this will always be present if the output
+            # type is `audio`.
+            transcript: nil,
+            # The content type, `output_text` or `output_audio` depending on the session
+            # `output_modalities` configuration.
             type: nil
           )
           end
@@ -177,7 +209,9 @@ module OpenAI
           sig do
             override.returns(
               {
+                audio: String,
                 text: String,
+                transcript: String,
                 type:
                   OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::OrSymbol
               }
@@ -186,7 +220,8 @@ module OpenAI
           def to_hash
           end
 
-          # The content type. Always `text` for assistant messages.
+          # The content type, `output_text` or `output_audio` depending on the session
+          # `output_modalities` configuration.
           module Type
             extend OpenAI::Internal::Type::Enum
 
@@ -199,9 +234,14 @@ module OpenAI
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            TEXT =
+            OUTPUT_TEXT =
+              T.let(
+                :output_text,
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::TaggedSymbol
+              )
+            OUTPUT_AUDIO =
               T.let(
-                :text,
+                :output_audio,
                 OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::TaggedSymbol
               )
 
@@ -217,7 +257,8 @@ module OpenAI
           end
         end
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         module Object
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/realtime/realtime_conversation_item_function_call.rbi

@@ -12,7 +12,9 @@ module OpenAI
             )
           end
 
-        # The arguments of the function call.
+        # The arguments of the function call. This is a JSON-encoded string representing
+        # the arguments passed to the function, for example
+        # `{"arg1": "value1", "arg2": 42}`.
         sig { returns(String) }
         attr_accessor :arguments
 
@@ -24,7 +26,8 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The unique ID of the item.
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         sig { returns(T.nilable(String)) }
         attr_reader :id
 
@@ -38,7 +41,8 @@ module OpenAI
         sig { params(call_id: String).void }
         attr_writer :call_id
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         sig do
           returns(
             T.nilable(
@@ -89,15 +93,19 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The arguments of the function call.
+          # The arguments of the function call. This is a JSON-encoded string representing
+          # the arguments passed to the function, for example
+          # `{"arg1": "value1", "arg2": 42}`.
           arguments:,
           # The name of the function being called.
           name:,
-          # The unique ID of the item.
+          # The unique ID of the item. This may be provided by the client or generated by
+          # the server.
           id: nil,
           # The ID of the function call.
           call_id: nil,
-          # Identifier for the API object being returned - always `realtime.item`.
+          # Identifier for the API object being returned - always `realtime.item`. Optional
+          # when creating a new item.
           object: nil,
           # The status of the item. Has no effect on the conversation.
           status: nil,
@@ -124,7 +132,8 @@ module OpenAI
         def to_hash
         end
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         module Object
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/realtime/realtime_conversation_item_function_call_output.rbi

@@ -16,7 +16,8 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :call_id
 
-        # The output of the function call.
+        # The output of the function call, this is free text and can contain any
+        # information or simply be empty.
         sig { returns(String) }
         attr_accessor :output
 
@@ -24,14 +25,16 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The unique ID of the item.
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         sig { returns(T.nilable(String)) }
         attr_reader :id
 
         sig { params(id: String).void }
         attr_writer :id
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         sig do
           returns(
             T.nilable(
@@ -83,11 +86,14 @@ module OpenAI
         def self.new(
           # The ID of the function call this output is for.
           call_id:,
-          # The output of the function call.
+          # The output of the function call, this is free text and can contain any
+          # information or simply be empty.
           output:,
-          # The unique ID of the item.
+          # The unique ID of the item. This may be provided by the client or generated by
+          # the server.
           id: nil,
-          # Identifier for the API object being returned - always `realtime.item`.
+          # Identifier for the API object being returned - always `realtime.item`. Optional
+          # when creating a new item.
           object: nil,
           # The status of the item. Has no effect on the conversation.
           status: nil,
@@ -113,7 +119,8 @@ module OpenAI
         def to_hash
         end
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         module Object
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/realtime/realtime_conversation_item_system_message.rbi

@@ -30,14 +30,16 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The unique ID of the item.
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         sig { returns(T.nilable(String)) }
         attr_reader :id
 
         sig { params(id: String).void }
         attr_writer :id
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         sig do
           returns(
             T.nilable(
@@ -73,7 +75,12 @@ module OpenAI
         end
         attr_writer :status
 
-        # A system message item in a Realtime conversation.
+        # A system message in a Realtime conversation can be used to provide additional
+        # context or instructions to the model. This is similar but distinct from the
+        # instruction prompt provided at the start of a conversation, as system messages
+        # can be added at any point in the conversation. For major changes to the
+        # conversation's behavior, use instructions, but for smaller updates (e.g. "the
+        # user is now asking about a different topic"), use system messages.
         sig do
           params(
             content:
@@ -92,9 +99,11 @@ module OpenAI
         def self.new(
           # The content of the message.
           content:,
-          # The unique ID of the item.
+          # The unique ID of the item. This may be provided by the client or generated by
+          # the server.
           id: nil,
-          # Identifier for the API object being returned - always `realtime.item`.
+          # Identifier for the API object being returned - always `realtime.item`. Optional
+          # when creating a new item.
           object: nil,
           # The status of the item. Has no effect on the conversation.
           status: nil,
@@ -217,7 +226,8 @@ module OpenAI
           end
         end
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         module Object
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/realtime/realtime_conversation_item_user_message.rbi

@@ -30,14 +30,16 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The unique ID of the item.
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         sig { returns(T.nilable(String)) }
         attr_reader :id
 
         sig { params(id: String).void }
         attr_writer :id
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         sig do
           returns(
             T.nilable(
@@ -92,9 +94,11 @@ module OpenAI
         def self.new(
           # The content of the message.
           content:,
-          # The unique ID of the item.
+          # The unique ID of the item. This may be provided by the client or generated by
+          # the server.
           id: nil,
-          # Identifier for the API object being returned - always `realtime.item`.
+          # Identifier for the API object being returned - always `realtime.item`. Optional
+          # when creating a new item.
           object: nil,
           # The status of the item. Has no effect on the conversation.
           status: nil,
@@ -134,13 +138,43 @@ module OpenAI
               )
             end
 
-          # Base64-encoded audio bytes (for `input_audio`).
+          # Base64-encoded audio bytes (for `input_audio`), these will be parsed as the
+          # format specified in the session input audio type configuration. This defaults to
+          # PCM 16-bit 24kHz mono if not specified.
           sig { returns(T.nilable(String)) }
           attr_reader :audio
 
           sig { params(audio: String).void }
           attr_writer :audio
 
+          # The detail level of the image (for `input_image`). `auto` will default to
+          # `high`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::OrSymbol
+              )
+            )
+          end
+          attr_reader :detail
+
+          sig do
+            params(
+              detail:
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::OrSymbol
+            ).void
+          end
+          attr_writer :detail
+
+          # Base64-encoded image bytes (for `input_image`) as a data URI. For example
+          # `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG
+          # and JPEG.
+          sig { returns(T.nilable(String)) }
+          attr_reader :image_url
+
+          sig { params(image_url: String).void }
+          attr_writer :image_url
+
           # The text content (for `input_text`).
           sig { returns(T.nilable(String)) }
           attr_reader :text
@@ -148,14 +182,15 @@ module OpenAI
           sig { params(text: String).void }
           attr_writer :text
 
-          # Transcript of the audio (for `input_audio`).
+          # Transcript of the audio (for `input_audio`). This is not sent to the model, but
+          # will be attached to the message item for reference.
           sig { returns(T.nilable(String)) }
           attr_reader :transcript
 
           sig { params(transcript: String).void }
           attr_writer :transcript
 
-          # The content type (`input_text` or `input_audio`).
+          # The content type (`input_text`, `input_audio`, or `input_image`).
           sig do
             returns(
               T.nilable(
@@ -176,6 +211,9 @@ module OpenAI
           sig do
             params(
               audio: String,
+              detail:
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::OrSymbol,
+              image_url: String,
               text: String,
               transcript: String,
               type:
@@ -183,13 +221,23 @@ module OpenAI
             ).returns(T.attached_class)
           end
           def self.new(
-            # Base64-encoded audio bytes (for `input_audio`).
+            # Base64-encoded audio bytes (for `input_audio`), these will be parsed as the
+            # format specified in the session input audio type configuration. This defaults to
+            # PCM 16-bit 24kHz mono if not specified.
             audio: nil,
+            # The detail level of the image (for `input_image`). `auto` will default to
+            # `high`.
+            detail: nil,
+            # Base64-encoded image bytes (for `input_image`) as a data URI. For example
+            # `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG
+            # and JPEG.
+            image_url: nil,
             # The text content (for `input_text`).
             text: nil,
-            # Transcript of the audio (for `input_audio`).
+            # Transcript of the audio (for `input_audio`). This is not sent to the model, but
+            # will be attached to the message item for reference.
             transcript: nil,
-            # The content type (`input_text` or `input_audio`).
+            # The content type (`input_text`, `input_audio`, or `input_image`).
             type: nil
           )
           end
@@ -198,6 +246,9 @@ module OpenAI
             override.returns(
               {
                 audio: String,
+                detail:
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::OrSymbol,
+                image_url: String,
                 text: String,
                 transcript: String,
                 type:
@@ -208,7 +259,48 @@ module OpenAI
           def to_hash
           end
 
-          # The content type (`input_text` or `input_audio`).
+          # The detail level of the image (for `input_image`). `auto` will default to
+          # `high`.
+          module Detail
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AUTO =
+              T.let(
+                :auto,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::TaggedSymbol
+              )
+            LOW =
+              T.let(
+                :low,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::TaggedSymbol
+              )
+            HIGH =
+              T.let(
+                :high,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Detail::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The content type (`input_text`, `input_audio`, or `input_image`).
           module Type
             extend OpenAI::Internal::Type::Enum
 
@@ -231,6 +323,11 @@ module OpenAI
                 :input_audio,
                 OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::TaggedSymbol
               )
+            INPUT_IMAGE =
+              T.let(
+                :input_image,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -244,7 +341,8 @@ module OpenAI
           end
         end
 
-        # Identifier for the API object being returned - always `realtime.item`.
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         module Object
           extend OpenAI::Internal::Type::Enum