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

openai 0.92.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 (1311) hide show

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

@@ -18,66 +18,193 @@ module OpenAI
         }
       class RealtimeResponseCreateParams < OpenAI::Internal::Type::BaseModel
+        # Configuration for audio input and output.
         attr_reader audio: OpenAI::Realtime::RealtimeResponseCreateAudioOutput?
+        # Configuration for audio input and output.
         def audio=: (
           OpenAI::Realtime::RealtimeResponseCreateAudioOutput
         ) -> OpenAI::Realtime::RealtimeResponseCreateAudioOutput
+        # Controls which conversation the response is added to. Currently supports `auto`
+        # and `none`, with `auto` as the default value. The `auto` value means that the
+        # contents of the response will be added to the default conversation. Set this to
+        # `none` to create an out-of-band response which will not add items to default
+        # conversation.
         attr_reader conversation: OpenAI::Models::Realtime::RealtimeResponseCreateParams::conversation?
+        # Controls which conversation the response is added to. Currently supports `auto`
+        # and `none`, with `auto` as the default value. The `auto` value means that the
+        # contents of the response will be added to the default conversation. Set this to
+        # `none` to create an out-of-band response which will not add items to default
+        # conversation.
         def conversation=: (
           OpenAI::Models::Realtime::RealtimeResponseCreateParams::conversation
         ) -> OpenAI::Models::Realtime::RealtimeResponseCreateParams::conversation
+        # Input items to include in the prompt for the model. Using this field creates a
+        # new context for this Response instead of using the default conversation. An
+        # empty array `[]` will clear the context for this Response. Note that this can
+        # include references to items that previously appeared in the session using their
+        # id.
         attr_reader input: ::Array[OpenAI::Models::Realtime::conversation_item]?
+        # Input items to include in the prompt for the model. Using this field creates a
+        # new context for this Response instead of using the default conversation. An
+        # empty array `[]` will clear the context for this Response. Note that this can
+        # include references to items that previously appeared in the session using their
+        # id.
         def input=: (
           ::Array[OpenAI::Models::Realtime::conversation_item]
         ) -> ::Array[OpenAI::Models::Realtime::conversation_item]
+        # The default system instructions (i.e. system message) prepended to model calls.
+        # This field allows the client to guide the model on desired responses. The model
+        # can be instructed on response content and format, (e.g. "be extremely succinct",
+        # "act friendly", "here are examples of good responses") and on audio behavior
+        # (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+        # instructions are not guaranteed to be followed by the model, but they provide
+        # guidance to the model on the desired behavior. Note that the server sets default
+        # instructions which will be used if this field is not set and are visible in the
+        # `session.created` event at the start of the session.
         attr_reader instructions: String?
+        # The default system instructions (i.e. system message) prepended to model calls.
+        # This field allows the client to guide the model on desired responses. The model
+        # can be instructed on response content and format, (e.g. "be extremely succinct",
+        # "act friendly", "here are examples of good responses") and on audio behavior
+        # (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+        # instructions are not guaranteed to be followed by the model, but they provide
+        # guidance to the model on the desired behavior. Note that the server sets default
+        # instructions which will be used if this field is not set and are visible in the
+        # `session.created` event at the start of the session.
         def instructions=: (String) -> String
+        # Maximum number of output tokens for a single assistant response, inclusive of
+        # tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+        # `inf` for the maximum available tokens for a given model. Defaults to `inf`.
         attr_reader max_output_tokens: OpenAI::Models::Realtime::RealtimeResponseCreateParams::max_output_tokens?
+        # Maximum number of output tokens for a single assistant response, inclusive of
+        # tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+        # `inf` for the maximum available tokens for a given model. Defaults to `inf`.
         def max_output_tokens=: (
           OpenAI::Models::Realtime::RealtimeResponseCreateParams::max_output_tokens
         ) -> OpenAI::Models::Realtime::RealtimeResponseCreateParams::max_output_tokens
+        # Set of 16 key-value pairs that can be attached to an object. This can be useful
+        # for storing additional information about the object in a structured format, and
+        # querying for objects via API or the dashboard.
+        #
+        # Keys are strings with a maximum length of 64 characters. Values are strings with
+        # a maximum length of 512 characters.
         attr_accessor metadata: OpenAI::Models::metadata?
+        # The set of modalities the model used to respond, currently the only possible
+        # values are `[\"audio\"]`, `[\"text\"]`. Audio output always include a text
+        # transcript. Setting the output to mode `text` will disable audio output from the
+        # model.
         attr_reader output_modalities: ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateParams::output_modality]?
+        # The set of modalities the model used to respond, currently the only possible
+        # values are `[\"audio\"]`, `[\"text\"]`. Audio output always include a text
+        # transcript. Setting the output to mode `text` will disable audio output from the
+        # model.
         def output_modalities=: (
           ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateParams::output_modality]
         ) -> ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateParams::output_modality]
+        # Whether the model may call multiple tools in parallel. Only supported by
+        # reasoning Realtime models such as `gpt-realtime-2`.
         attr_reader parallel_tool_calls: bool?
+        # Whether the model may call multiple tools in parallel. Only supported by
+        # reasoning Realtime models such as `gpt-realtime-2`.
         def parallel_tool_calls=: (bool) -> bool
+        # Reference to a prompt template and its variables.
+        # [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         attr_accessor prompt: OpenAI::Responses::ResponsePrompt?
+        # Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
         attr_reader reasoning: OpenAI::Realtime::RealtimeReasoning?
+        # Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
         def reasoning=: (
           OpenAI::Realtime::RealtimeReasoning
         ) -> OpenAI::Realtime::RealtimeReasoning
+        # How the model chooses tools. Provide one of the string modes or force a specific
+        # function/MCP tool.
         attr_reader tool_choice: OpenAI::Models::Realtime::RealtimeResponseCreateParams::tool_choice?
+        # How the model chooses tools. Provide one of the string modes or force a specific
+        # function/MCP tool.
         def tool_choice=: (
           OpenAI::Models::Realtime::RealtimeResponseCreateParams::tool_choice
         ) -> OpenAI::Models::Realtime::RealtimeResponseCreateParams::tool_choice
+        # Tools available to the model.
         attr_reader tools: ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateParams::tool]?
+        # Tools available to the model.
         def tools=: (
           ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateParams::tool]
         ) -> ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateParams::tool]
+        # @param audio
+        #   Configuration for audio input and output.
+        # @param conversation
+        #   Controls which conversation the response is added to. Currently supports `auto`
+        #   and `none`, with `auto` as the default value. The `auto` value means that the
+        #   contents of the response will be added to the default conversation. Set this to
+        #   `none` to create an out-of-band response which will not add items to default
+        #   conversation.
+        # @param input
+        #   Input items to include in the prompt for the model. Using this field creates a
+        #   new context for this Response instead of using the default conversation. An
+        #   empty array `[]` will clear the context for this Response. Note that this can
+        #   include references to items that previously appeared in the session using their
+        #   id.
+        # @param instructions
+        #   The default system instructions (i.e. system message) prepended to model calls.
+        #   This field allows the client to guide the model on desired responses. The model
+        #   can be instructed on response content and format, (e.g. "be extremely succinct",
+        #   "act friendly", "here are examples of good responses") and on audio behavior
+        #   (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+        #   instructions are not guaranteed to be followed by the model, but they provide
+        #   guidance to the model on the desired behavior. Note that the server sets default
+        #   instructions which will be used if this field is not set and are visible in the
+        #   `session.created` event at the start of the session.
+        # @param max_output_tokens
+        #   Maximum number of output tokens for a single assistant response, inclusive of
+        #   tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+        #   `inf` for the maximum available tokens for a given model. Defaults to `inf`.
+        # @param metadata
+        #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #   for storing additional information about the object in a structured format, and
+        #   querying for objects via API or the dashboard.
+        #
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        # @param output_modalities
+        #   The set of modalities the model used to respond, currently the only possible
+        #   values are `[\"audio\"]`, `[\"text\"]`. Audio output always include a text
+        #   transcript. Setting the output to mode `text` will disable audio output from the
+        #   model.
+        # @param parallel_tool_calls
+        #   Whether the model may call multiple tools in parallel. Only supported by
+        #   reasoning Realtime models such as `gpt-realtime-2`.
+        # @param prompt
+        #   Reference to a prompt template and its variables.
+        #   [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
+        # @param reasoning
+        #   Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
+        # @param tool_choice
+        #   How the model chooses tools. Provide one of the string modes or force a specific
+        #   function/MCP tool.
+        # @param tools
+        #   Tools available to the model.
         def initialize: (
           ?audio: OpenAI::Realtime::RealtimeResponseCreateAudioOutput,
           ?conversation: OpenAI::Models::Realtime::RealtimeResponseCreateParams::conversation,

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

@@ -9,24 +9,54 @@ module OpenAI
         }
       class RealtimeResponseStatus < OpenAI::Internal::Type::BaseModel
+        # A description of the error that caused the response to fail, populated when the
+        # `status` is `failed`.
         attr_reader error: OpenAI::Realtime::RealtimeResponseStatus::Error?
+        # A description of the error that caused the response to fail, populated when the
+        # `status` is `failed`.
         def error=: (
           OpenAI::Realtime::RealtimeResponseStatus::Error
         ) -> OpenAI::Realtime::RealtimeResponseStatus::Error
+        # The reason the Response did not complete. For a `cancelled` Response, one of
+        # `turn_detected` (the server VAD detected a new start of speech) or
+        # `client_cancelled` (the client sent a cancel event). For an `incomplete`
+        # Response, one of `max_output_tokens` or `content_filter` (the server-side safety
+        # filter activated and cut off the response).
         attr_reader reason: OpenAI::Models::Realtime::RealtimeResponseStatus::reason?
+        # The reason the Response did not complete. For a `cancelled` Response, one of
+        # `turn_detected` (the server VAD detected a new start of speech) or
+        # `client_cancelled` (the client sent a cancel event). For an `incomplete`
+        # Response, one of `max_output_tokens` or `content_filter` (the server-side safety
+        # filter activated and cut off the response).
         def reason=: (
           OpenAI::Models::Realtime::RealtimeResponseStatus::reason
         ) -> OpenAI::Models::Realtime::RealtimeResponseStatus::reason
+        # The type of error that caused the response to fail, corresponding with the
+        # `status` field (`completed`, `cancelled`, `incomplete`, `failed`).
         attr_reader type: OpenAI::Models::Realtime::RealtimeResponseStatus::type_?
+        # The type of error that caused the response to fail, corresponding with the
+        # `status` field (`completed`, `cancelled`, `incomplete`, `failed`).
         def type=: (
           OpenAI::Models::Realtime::RealtimeResponseStatus::type_
         ) -> OpenAI::Models::Realtime::RealtimeResponseStatus::type_
+        # @param error
+        #   A description of the error that caused the response to fail, populated when the
+        #   `status` is `failed`.
+        # @param reason
+        #   The reason the Response did not complete. For a `cancelled` Response, one of
+        #   `turn_detected` (the server VAD detected a new start of speech) or
+        #   `client_cancelled` (the client sent a cancel event). For an `incomplete`
+        #   Response, one of `max_output_tokens` or `content_filter` (the server-side safety
+        #   filter activated and cut off the response).
+        # @param type
+        #   The type of error that caused the response to fail, corresponding with the
+        #   `status` field (`completed`, `cancelled`, `incomplete`, `failed`).
         def initialize: (
           ?error: OpenAI::Realtime::RealtimeResponseStatus::Error,
           ?reason: OpenAI::Models::Realtime::RealtimeResponseStatus::reason,
@@ -42,14 +72,22 @@ module OpenAI
         type error = { ?code: String, ?type: String }
         class Error < OpenAI::Internal::Type::BaseModel
+          # Error code, if any.
           attr_reader code: String?
+          # Error code, if any.
           def code=: (String) -> String
+          # The type of error.
           attr_reader type: String?
+          # The type of error.
           def type=: (String) -> String
+          # @param code
+          #   Error code, if any.
+          # @param type
+          #   The type of error.
           def initialize: (?code: String, ?type: String) -> void
           def to_hash: -> { ?code: String, ?type: String }

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

@@ -11,30 +11,68 @@ module OpenAI
         }
       class RealtimeResponseUsage < OpenAI::Internal::Type::BaseModel
+        # Details about the input tokens used in the Response. Cached tokens are tokens
+        # from previous turns in the conversation that are included as context for the
+        # current response. Cached tokens here are counted as a subset of input tokens,
+        # meaning input tokens will include cached and uncached tokens.
         attr_reader input_token_details: OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails?
+        # Details about the input tokens used in the Response. Cached tokens are tokens
+        # from previous turns in the conversation that are included as context for the
+        # current response. Cached tokens here are counted as a subset of input tokens,
+        # meaning input tokens will include cached and uncached tokens.
         def input_token_details=: (
           OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails
         ) -> OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails
+        # The number of input tokens used in the Response, including text and audio
+        # tokens.
         attr_reader input_tokens: Integer?
+        # The number of input tokens used in the Response, including text and audio
+        # tokens.
         def input_tokens=: (Integer) -> Integer
+        # Details about the output tokens used in the Response.
         attr_reader output_token_details: OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails?
+        # Details about the output tokens used in the Response.
         def output_token_details=: (
           OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails
         ) -> OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails
+        # The number of output tokens sent in the Response, including text and audio
+        # tokens.
         attr_reader output_tokens: Integer?
+        # The number of output tokens sent in the Response, including text and audio
+        # tokens.
         def output_tokens=: (Integer) -> Integer
+        # The total number of tokens in the Response including input and output text and
+        # audio tokens.
         attr_reader total_tokens: Integer?
+        # The total number of tokens in the Response including input and output text and
+        # audio tokens.
         def total_tokens=: (Integer) -> Integer
+        # @param input_token_details
+        #   Details about the input tokens used in the Response. Cached tokens are tokens
+        #   from previous turns in the conversation that are included as context for the
+        #   current response. Cached tokens here are counted as a subset of input tokens,
+        #   meaning input tokens will include cached and uncached tokens.
+        # @param input_tokens
+        #   The number of input tokens used in the Response, including text and audio
+        #   tokens.
+        # @param output_token_details
+        #   Details about the output tokens used in the Response.
+        # @param output_tokens
+        #   The number of output tokens sent in the Response, including text and audio
+        #   tokens.
+        # @param total_tokens
+        #   The total number of tokens in the Response including input and output text and
+        #   audio tokens.
         def initialize: (
           ?input_token_details: OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails,
           ?input_tokens: Integer,

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

@@ -11,28 +11,48 @@ module OpenAI
         }
       class RealtimeResponseUsageInputTokenDetails < OpenAI::Internal::Type::BaseModel
+        # The number of audio tokens used as input for the Response.
         attr_reader audio_tokens: Integer?
+        # The number of audio tokens used as input for the Response.
         def audio_tokens=: (Integer) -> Integer
+        # The number of cached tokens used as input for the Response.
         attr_reader cached_tokens: Integer?
+        # The number of cached tokens used as input for the Response.
         def cached_tokens=: (Integer) -> Integer
+        # Details about the cached tokens used as input for the Response.
         attr_reader cached_tokens_details: OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails?
+        # Details about the cached tokens used as input for the Response.
         def cached_tokens_details=: (
           OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails
         ) -> OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails
+        # The number of image tokens used as input for the Response.
         attr_reader image_tokens: Integer?
+        # The number of image tokens used as input for the Response.
         def image_tokens=: (Integer) -> Integer
+        # The number of text tokens used as input for the Response.
         attr_reader text_tokens: Integer?
+        # The number of text tokens used as input for the Response.
         def text_tokens=: (Integer) -> Integer
+        # @param audio_tokens
+        #   The number of audio tokens used as input for the Response.
+        # @param cached_tokens
+        #   The number of cached tokens used as input for the Response.
+        # @param cached_tokens_details
+        #   Details about the cached tokens used as input for the Response.
+        # @param image_tokens
+        #   The number of image tokens used as input for the Response.
+        # @param text_tokens
+        #   The number of text tokens used as input for the Response.
         def initialize: (
           ?audio_tokens: Integer,
           ?cached_tokens: Integer,
@@ -57,18 +77,30 @@ module OpenAI
           }
         class CachedTokensDetails < OpenAI::Internal::Type::BaseModel
+          # The number of cached audio tokens used as input for the Response.
           attr_reader audio_tokens: Integer?
+          # The number of cached audio tokens used as input for the Response.
           def audio_tokens=: (Integer) -> Integer
+          # The number of cached image tokens used as input for the Response.
           attr_reader image_tokens: Integer?
+          # The number of cached image tokens used as input for the Response.
           def image_tokens=: (Integer) -> Integer
+          # The number of cached text tokens used as input for the Response.
           attr_reader text_tokens: Integer?
+          # The number of cached text tokens used as input for the Response.
           def text_tokens=: (Integer) -> Integer
+          # @param audio_tokens
+          #   The number of cached audio tokens used as input for the Response.
+          # @param image_tokens
+          #   The number of cached image tokens used as input for the Response.
+          # @param text_tokens
+          #   The number of cached text tokens used as input for the Response.
           def initialize: (
             ?audio_tokens: Integer,
             ?image_tokens: Integer,

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

@@ -5,14 +5,22 @@ module OpenAI
         { ?audio_tokens: Integer, ?text_tokens: Integer }
       class RealtimeResponseUsageOutputTokenDetails < OpenAI::Internal::Type::BaseModel
+        # The number of audio tokens used in the Response.
         attr_reader audio_tokens: Integer?
+        # The number of audio tokens used in the Response.
         def audio_tokens=: (Integer) -> Integer
+        # The number of text tokens used in the Response.
         attr_reader text_tokens: Integer?
+        # The number of text tokens used in the Response.
         def text_tokens=: (Integer) -> Integer
+        # @param audio_tokens
+        #   The number of audio tokens used in the Response.
+        # @param text_tokens
+        #   The number of text tokens used in the Response.
         def initialize: (?audio_tokens: Integer, ?text_tokens: Integer) -> void
         def to_hash: -> { ?audio_tokens: Integer, ?text_tokens: Integer }

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

@@ -60,12 +60,21 @@ module OpenAI
           }
         class ConversationItemRetrieved < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the server event.
           attr_accessor event_id: String
+          # A single item within a Realtime conversation.
           attr_accessor item: OpenAI::Models::Realtime::conversation_item
+          # The event type, must be `conversation.item.retrieved`.
           attr_accessor type: :"conversation.item.retrieved"
+          # @param event_id
+          #   The unique ID of the server event.
+          # @param item
+          #   A single item within a Realtime conversation.
+          # @param type
+          #   The event type, must be `conversation.item.retrieved`.
           def initialize: (
             event_id: String,
             item: OpenAI::Models::Realtime::conversation_item,
@@ -87,12 +96,21 @@ module OpenAI
           }
         class OutputAudioBufferStarted < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the server event.
           attr_accessor event_id: String
+          # The unique ID of the response that produced the audio.
           attr_accessor response_id: String
+          # The event type, must be `output_audio_buffer.started`.
           attr_accessor type: :"output_audio_buffer.started"
+          # @param event_id
+          #   The unique ID of the server event.
+          # @param response_id
+          #   The unique ID of the response that produced the audio.
+          # @param type
+          #   The event type, must be `output_audio_buffer.started`.
           def initialize: (
             event_id: String,
             response_id: String,
@@ -114,12 +132,21 @@ module OpenAI
           }
         class OutputAudioBufferStopped < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the server event.
           attr_accessor event_id: String
+          # The unique ID of the response that produced the audio.
           attr_accessor response_id: String
+          # The event type, must be `output_audio_buffer.stopped`.
           attr_accessor type: :"output_audio_buffer.stopped"
+          # @param event_id
+          #   The unique ID of the server event.
+          # @param response_id
+          #   The unique ID of the response that produced the audio.
+          # @param type
+          #   The event type, must be `output_audio_buffer.stopped`.
           def initialize: (
             event_id: String,
             response_id: String,
@@ -141,12 +168,21 @@ module OpenAI
           }
         class OutputAudioBufferCleared < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the server event.
           attr_accessor event_id: String
+          # The unique ID of the response that produced the audio.
           attr_accessor response_id: String
+          # The event type, must be `output_audio_buffer.cleared`.
           attr_accessor type: :"output_audio_buffer.cleared"
+          # @param event_id
+          #   The unique ID of the server event.
+          # @param response_id
+          #   The unique ID of the response that produced the audio.
+          # @param type
+          #   The event type, must be `output_audio_buffer.cleared`.
           def initialize: (
             event_id: String,
             response_id: String,