RubyGems - openai - Versions diffs - 0.91.0 → 0.93.0 - Mend

openai 0.91.0 → 0.93.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1351) hide show

data/sig/openai/models/realtime/realtime_conversation_item_assistant_message.rbs CHANGED Viewed

@@ -12,28 +12,55 @@ module OpenAI
         }
       class RealtimeConversationItemAssistantMessage < OpenAI::Internal::Type::BaseModel
+        # The content of the message.
         attr_accessor content: ::Array[OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content]
+        # The role of the message sender. Always `assistant`.
         attr_accessor role: :assistant
+        # The type of the item. Always `message`.
         attr_accessor type: :message
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         attr_reader id: String?
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         def id=: (String) -> String
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         attr_reader object: OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::object?
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         def object=: (
           OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::object
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::object
+        # The status of the item. Has no effect on the conversation.
         attr_reader status: OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::status?
+        # The status of the item. Has no effect on the conversation.
         def status=: (
           OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::status
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::status
+        # @param content
+        #   The content of the message.
+        # @param id
+        #   The unique ID of the item. This may be provided by the client or generated by
+        #   the server.
+        # @param object
+        #   Identifier for the API object being returned - always `realtime.item`. Optional
+        #   when creating a new item.
+        # @param status
+        #   The status of the item. Has no effect on the conversation.
+        # @param role
+        #   The role of the message sender. Always `assistant`.
+        # @param type
+        #   The type of the item. Always `message`.
         def initialize: (
           content: ::Array[OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content],
           ?id: String,
@@ -61,24 +88,52 @@ module OpenAI
           }
         class Content < OpenAI::Internal::Type::BaseModel
+          # 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.
           attr_reader audio: String?
+          # 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.
           def audio=: (String) -> String
+          # The text content.
           attr_reader text: String?
+          # The text content.
           def text=: (String) -> String
+          # The transcript of the audio content, this will always be present if the output
+          # type is `audio`.
           attr_reader transcript: String?
+          # The transcript of the audio content, this will always be present if the output
+          # type is `audio`.
           def transcript=: (String) -> String
+          # The content type, `output_text` or `output_audio` depending on the session
+          # `output_modalities` configuration.
           attr_reader type: OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::type_?
+          # The content type, `output_text` or `output_audio` depending on the session
+          # `output_modalities` configuration.
           def type=: (
             OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::type_
           ) -> OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::type_
+          # @param audio
+          #   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.
+          # @param text
+          #   The text content.
+          # @param transcript
+          #   The transcript of the audio content, this will always be present if the output
+          #   type is `audio`.
+          # @param type
+          #   The content type, `output_text` or `output_audio` depending on the session
+          #   `output_modalities` configuration.
           def initialize: (
             ?audio: String,
             ?text: String,

data/sig/openai/models/realtime/realtime_conversation_item_function_call.rbs CHANGED Viewed

@@ -13,32 +13,67 @@ module OpenAI
         }
       class RealtimeConversationItemFunctionCall < OpenAI::Internal::Type::BaseModel
+        # 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}`.
         attr_accessor arguments: String
+        # The name of the function being called.
         attr_accessor name: String
+        # The type of the item. Always `function_call`.
         attr_accessor type: :function_call
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         attr_reader id: String?
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         def id=: (String) -> String
+        # The ID of the function call.
         attr_reader call_id: String?
+        # The ID of the function call.
         def call_id=: (String) -> String
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         attr_reader object: OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::object?
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         def object=: (
           OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::object
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::object
+        # The status of the item. Has no effect on the conversation.
         attr_reader status: OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::status?
+        # The status of the item. Has no effect on the conversation.
         def status=: (
           OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::status
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::status
+        # @param arguments
+        #   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}`.
+        # @param name
+        #   The name of the function being called.
+        # @param id
+        #   The unique ID of the item. This may be provided by the client or generated by
+        #   the server.
+        # @param call_id
+        #   The ID of the function call.
+        # @param object
+        #   Identifier for the API object being returned - always `realtime.item`. Optional
+        #   when creating a new item.
+        # @param status
+        #   The status of the item. Has no effect on the conversation.
+        # @param type
+        #   The type of the item. Always `function_call`.
         def initialize: (
           arguments: String,
           name: String,

data/sig/openai/models/realtime/realtime_conversation_item_function_call_output.rbs CHANGED Viewed

@@ -12,28 +12,57 @@ module OpenAI
         }
       class RealtimeConversationItemFunctionCallOutput < OpenAI::Internal::Type::BaseModel
+        # The ID of the function call this output is for.
         attr_accessor call_id: String
+        # The output of the function call, this is free text and can contain any
+        # information or simply be empty.
         attr_accessor output: String
+        # The type of the item. Always `function_call_output`.
         attr_accessor type: :function_call_output
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         attr_reader id: String?
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         def id=: (String) -> String
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         attr_reader object: OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::object?
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         def object=: (
           OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::object
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::object
+        # The status of the item. Has no effect on the conversation.
         attr_reader status: OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::status?
+        # The status of the item. Has no effect on the conversation.
         def status=: (
           OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::status
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::status
+        # @param call_id
+        #   The ID of the function call this output is for.
+        # @param output
+        #   The output of the function call, this is free text and can contain any
+        #   information or simply be empty.
+        # @param id
+        #   The unique ID of the item. This may be provided by the client or generated by
+        #   the server.
+        # @param object
+        #   Identifier for the API object being returned - always `realtime.item`. Optional
+        #   when creating a new item.
+        # @param status
+        #   The status of the item. Has no effect on the conversation.
+        # @param type
+        #   The type of the item. Always `function_call_output`.
         def initialize: (
           call_id: String,
           output: String,

data/sig/openai/models/realtime/realtime_conversation_item_system_message.rbs CHANGED Viewed

@@ -12,28 +12,55 @@ module OpenAI
         }
       class RealtimeConversationItemSystemMessage < OpenAI::Internal::Type::BaseModel
+        # The content of the message.
         attr_accessor content: ::Array[OpenAI::Realtime::RealtimeConversationItemSystemMessage::Content]
+        # The role of the message sender. Always `system`.
         attr_accessor role: :system
+        # The type of the item. Always `message`.
         attr_accessor type: :message
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         attr_reader id: String?
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         def id=: (String) -> String
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         attr_reader object: OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::object?
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         def object=: (
           OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::object
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::object
+        # The status of the item. Has no effect on the conversation.
         attr_reader status: OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::status?
+        # The status of the item. Has no effect on the conversation.
         def status=: (
           OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::status
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::status
+        # @param content
+        #   The content of the message.
+        # @param id
+        #   The unique ID of the item. This may be provided by the client or generated by
+        #   the server.
+        # @param object
+        #   Identifier for the API object being returned - always `realtime.item`. Optional
+        #   when creating a new item.
+        # @param status
+        #   The status of the item. Has no effect on the conversation.
+        # @param role
+        #   The role of the message sender. Always `system`.
+        # @param type
+        #   The type of the item. Always `message`.
         def initialize: (
           content: ::Array[OpenAI::Realtime::RealtimeConversationItemSystemMessage::Content],
           ?id: String,
@@ -59,16 +86,24 @@ module OpenAI
           }
         class Content < OpenAI::Internal::Type::BaseModel
+          # The text content.
           attr_reader text: String?
+          # The text content.
           def text=: (String) -> String
+          # The content type. Always `input_text` for system messages.
           attr_reader type: OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::type_?
+          # The content type. Always `input_text` for system messages.
           def type=: (
             OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::type_
           ) -> OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::type_
+          # @param text
+          #   The text content.
+          # @param type
+          #   The content type. Always `input_text` for system messages.
           def initialize: (
             ?text: String,
             ?type: OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::type_

data/sig/openai/models/realtime/realtime_conversation_item_user_message.rbs CHANGED Viewed

@@ -12,28 +12,55 @@ module OpenAI
         }
       class RealtimeConversationItemUserMessage < OpenAI::Internal::Type::BaseModel
+        # The content of the message.
         attr_accessor content: ::Array[OpenAI::Realtime::RealtimeConversationItemUserMessage::Content]
+        # The role of the message sender. Always `user`.
         attr_accessor role: :user
+        # The type of the item. Always `message`.
         attr_accessor type: :message
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         attr_reader id: String?
+        # The unique ID of the item. This may be provided by the client or generated by
+        # the server.
         def id=: (String) -> String
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         attr_reader object: OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::object?
+        # Identifier for the API object being returned - always `realtime.item`. Optional
+        # when creating a new item.
         def object=: (
           OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::object
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::object
+        # The status of the item. Has no effect on the conversation.
         attr_reader status: OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::status?
+        # The status of the item. Has no effect on the conversation.
         def status=: (
           OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::status
         ) -> OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::status
+        # @param content
+        #   The content of the message.
+        # @param id
+        #   The unique ID of the item. This may be provided by the client or generated by
+        #   the server.
+        # @param object
+        #   Identifier for the API object being returned - always `realtime.item`. Optional
+        #   when creating a new item.
+        # @param status
+        #   The status of the item. Has no effect on the conversation.
+        # @param role
+        #   The role of the message sender. Always `user`.
+        # @param type
+        #   The type of the item. Always `message`.
         def initialize: (
           content: ::Array[OpenAI::Realtime::RealtimeConversationItemUserMessage::Content],
           ?id: String,
@@ -63,34 +90,76 @@ module OpenAI
           }
         class Content < OpenAI::Internal::Type::BaseModel
+          # 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.
           attr_reader audio: String?
+          # 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.
           def audio=: (String) -> String
+          # The detail level of the image (for `input_image`). `auto` will default to
+          # `high`.
           attr_reader detail: OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::detail?
+          # The detail level of the image (for `input_image`). `auto` will default to
+          # `high`.
           def detail=: (
             OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::detail
           ) -> OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::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.
           attr_reader image_url: String?
+          # Base64-encoded image bytes (for `input_image`) as a data URI. For example
+          # `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG
+          # and JPEG.
           def image_url=: (String) -> String
+          # The text content (for `input_text`).
           attr_reader text: String?
+          # The text content (for `input_text`).
           def text=: (String) -> String
+          # Transcript of the audio (for `input_audio`). This is not sent to the model, but
+          # will be attached to the message item for reference.
           attr_reader transcript: String?
+          # Transcript of the audio (for `input_audio`). This is not sent to the model, but
+          # will be attached to the message item for reference.
           def transcript=: (String) -> String
+          # The content type (`input_text`, `input_audio`, or `input_image`).
           attr_reader type: OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::type_?
+          # The content type (`input_text`, `input_audio`, or `input_image`).
           def type=: (
             OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::type_
           ) -> OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::type_
+          # @param 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.
+          # @param detail
+          #   The detail level of the image (for `input_image`). `auto` will default to
+          #   `high`.
+          # @param image_url
+          #   Base64-encoded image bytes (for `input_image`) as a data URI. For example
+          #   `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG
+          #   and JPEG.
+          # @param text
+          #   The text content (for `input_text`).
+          # @param transcript
+          #   Transcript of the audio (for `input_audio`). This is not sent to the model, but
+          #   will be attached to the message item for reference.
+          # @param type
+          #   The content type (`input_text`, `input_audio`, or `input_image`).
           def initialize: (
             ?audio: String,
             ?detail: OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::detail,

data/sig/openai/models/realtime/realtime_error.rbs CHANGED Viewed

@@ -11,16 +11,31 @@ module OpenAI
         }
       class RealtimeError < OpenAI::Internal::Type::BaseModel
+        # A human-readable error message.
         attr_accessor message: String
+        # The type of error (e.g., "invalid_request_error", "server_error").
         attr_accessor type: String
+        # Error code, if any.
         attr_accessor code: String?
+        # The event_id of the client event that caused the error, if applicable.
         attr_accessor event_id: String?
+        # Parameter related to the error, if any.
         attr_accessor param: String?
+        # @param message
+        #   A human-readable error message.
+        # @param type
+        #   The type of error (e.g., "invalid_request_error", "server_error").
+        # @param code
+        #   Error code, if any.
+        # @param event_id
+        #   The event_id of the client event that caused the error, if applicable.
+        # @param param
+        #   Parameter related to the error, if any.
         def initialize: (
           message: String,
           type: String,

data/sig/openai/models/realtime/realtime_error_event.rbs CHANGED Viewed

@@ -9,12 +9,21 @@ module OpenAI
         }
       class RealtimeErrorEvent < OpenAI::Internal::Type::BaseModel
+        # Details of the error.
         attr_accessor error: OpenAI::Realtime::RealtimeError
+        # The unique ID of the server event.
         attr_accessor event_id: String
+        # The event type, must be `error`.
         attr_accessor type: :error
+        # @param error
+        #   Details of the error.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param type
+        #   The event type, must be `error`.
         def initialize: (
           error: OpenAI::Realtime::RealtimeError,
           event_id: String,

data/sig/openai/models/realtime/realtime_function_tool.rbs CHANGED Viewed

@@ -10,24 +10,43 @@ module OpenAI
         }
       class RealtimeFunctionTool < OpenAI::Internal::Type::BaseModel
+        # The description of the function, including guidance on when and how to call it,
+        # and guidance about what to tell the user when calling (if anything).
         attr_reader description: String?
+        # The description of the function, including guidance on when and how to call it,
+        # and guidance about what to tell the user when calling (if anything).
         def description=: (String) -> String
+        # The name of the function.
         attr_reader name: String?
+        # The name of the function.
         def name=: (String) -> String
+        # Parameters of the function in JSON Schema.
         attr_reader parameters: top?
+        # Parameters of the function in JSON Schema.
         def parameters=: (top) -> top
+        # The type of the tool, i.e. `function`.
         attr_reader type: OpenAI::Models::Realtime::RealtimeFunctionTool::type_?
+        # The type of the tool, i.e. `function`.
         def type=: (
           OpenAI::Models::Realtime::RealtimeFunctionTool::type_
         ) -> OpenAI::Models::Realtime::RealtimeFunctionTool::type_
+        # @param description
+        #   The description of the function, including guidance on when and how to call it,
+        #   and guidance about what to tell the user when calling (if anything).
+        # @param name
+        #   The name of the function.
+        # @param parameters
+        #   Parameters of the function in JSON Schema.
+        # @param type
+        #   The type of the tool, i.e. `function`.
         def initialize: (
           ?description: String,
           ?name: String,

data/sig/openai/models/realtime/realtime_mcp_approval_request.rbs CHANGED Viewed

@@ -11,16 +11,31 @@ module OpenAI
         }
       class RealtimeMcpApprovalRequest < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the approval request.
         attr_accessor id: String
+        # A JSON string of arguments for the tool.
         attr_accessor arguments: String
+        # The name of the tool to run.
         attr_accessor name: String
+        # The label of the MCP server making the request.
         attr_accessor server_label: String
+        # The type of the item. Always `mcp_approval_request`.
         attr_accessor type: :mcp_approval_request
+        # @param id
+        #   The unique ID of the approval request.
+        # @param arguments
+        #   A JSON string of arguments for the tool.
+        # @param name
+        #   The name of the tool to run.
+        # @param server_label
+        #   The label of the MCP server making the request.
+        # @param type
+        #   The type of the item. Always `mcp_approval_request`.
         def initialize: (
           id: String,
           arguments: String,

data/sig/openai/models/realtime/realtime_mcp_approval_response.rbs CHANGED Viewed

@@ -11,16 +11,31 @@ module OpenAI
         }
       class RealtimeMcpApprovalResponse < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the approval response.
         attr_accessor id: String
+        # The ID of the approval request being answered.
         attr_accessor approval_request_id: String
+        # Whether the request was approved.
         attr_accessor approve: bool
+        # The type of the item. Always `mcp_approval_response`.
         attr_accessor type: :mcp_approval_response
+        # Optional reason for the decision.
         attr_accessor reason: String?
+        # @param id
+        #   The unique ID of the approval response.
+        # @param approval_request_id
+        #   The ID of the approval request being answered.
+        # @param approve
+        #   Whether the request was approved.
+        # @param reason
+        #   Optional reason for the decision.
+        # @param type
+        #   The type of the item. Always `mcp_approval_response`.
         def initialize: (
           id: String,
           approval_request_id: String,

data/sig/openai/models/realtime/realtime_mcp_list_tools.rbs CHANGED Viewed

@@ -10,16 +10,29 @@ module OpenAI
         }
       class RealtimeMcpListTools < OpenAI::Internal::Type::BaseModel
+        # The label of the MCP server.
         attr_accessor server_label: String
+        # The tools available on the server.
         attr_accessor tools: ::Array[OpenAI::Realtime::RealtimeMcpListTools::Tool]
+        # The type of the item. Always `mcp_list_tools`.
         attr_accessor type: :mcp_list_tools
+        # The unique ID of the list.
         attr_reader id: String?
+        # The unique ID of the list.
         def id=: (String) -> String
+        # @param server_label
+        #   The label of the MCP server.
+        # @param tools
+        #   The tools available on the server.
+        # @param id
+        #   The unique ID of the list.
+        # @param type
+        #   The type of the item. Always `mcp_list_tools`.
         def initialize: (
           server_label: String,
           tools: ::Array[OpenAI::Realtime::RealtimeMcpListTools::Tool],
@@ -43,14 +56,26 @@ module OpenAI
           }
         class Tool < OpenAI::Internal::Type::BaseModel
+          # The JSON schema describing the tool's input.
           attr_accessor input_schema: top
+          # The name of the tool.
           attr_accessor name: String
+          # Additional annotations about the tool.
           attr_accessor annotations: top?
+          # The description of the tool.
           attr_accessor description: String?
+          # @param input_schema
+          #   The JSON schema describing the tool's input.
+          # @param name
+          #   The name of the tool.
+          # @param annotations
+          #   Additional annotations about the tool.
+          # @param description
+          #   The description of the tool.
           def initialize: (
             input_schema: top,
             name: String,