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

openai 0.92.0 → 0.94.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_mcp_tool_call.rbs CHANGED Viewed

@@ -14,22 +14,46 @@ module OpenAI
         }
       class RealtimeMcpToolCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the tool call.
         attr_accessor id: String
+        # A JSON string of the arguments passed to the tool.
         attr_accessor arguments: String
+        # The name of the tool that was run.
         attr_accessor name: String
+        # The label of the MCP server running the tool.
         attr_accessor server_label: String
+        # The type of the item. Always `mcp_call`.
         attr_accessor type: :mcp_call
+        # The ID of an associated approval request, if any.
         attr_accessor approval_request_id: String?
+        # The error from the tool call, if any.
         attr_accessor error: OpenAI::Models::Realtime::RealtimeMcpToolCall::error?
+        # The output from the tool call.
         attr_accessor output: String?
+        # @param id
+        #   The unique ID of the tool call.
+        # @param arguments
+        #   A JSON string of the arguments passed to the tool.
+        # @param name
+        #   The name of the tool that was run.
+        # @param server_label
+        #   The label of the MCP server running the tool.
+        # @param approval_request_id
+        #   The ID of an associated approval request, if any.
+        # @param error
+        #   The error from the tool call, if any.
+        # @param output
+        #   The output from the tool call.
+        # @param type
+        #   The type of the item. Always `mcp_call`.
         def initialize: (
           id: String,
           arguments: String,

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

@@ -5,12 +5,19 @@ module OpenAI
         { ?effort: OpenAI::Models::Realtime::realtime_reasoning_effort }
       class RealtimeReasoning < OpenAI::Internal::Type::BaseModel
+        # Constrains effort on reasoning for reasoning-capable Realtime models such as
+        # `gpt-realtime-2`.
         attr_reader effort: OpenAI::Models::Realtime::realtime_reasoning_effort?
+        # Constrains effort on reasoning for reasoning-capable Realtime models such as
+        # `gpt-realtime-2`.
         def effort=: (
           OpenAI::Models::Realtime::realtime_reasoning_effort
         ) -> OpenAI::Models::Realtime::realtime_reasoning_effort
+        # @param effort
+        #   Constrains effort on reasoning for reasoning-capable Realtime models such as
+        #   `gpt-realtime-2`.
         def initialize: (
           ?effort: OpenAI::Models::Realtime::realtime_reasoning_effort
         ) -> void

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

@@ -17,64 +17,156 @@ module OpenAI
         }
       class RealtimeResponse < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the response, will look like `resp_1234`.
         attr_reader id: String?
+        # The unique ID of the response, will look like `resp_1234`.
         def id=: (String) -> String
+        # Configuration for audio output.
         attr_reader audio: OpenAI::Realtime::RealtimeResponse::Audio?
+        # Configuration for audio output.
         def audio=: (
           OpenAI::Realtime::RealtimeResponse::Audio
         ) -> OpenAI::Realtime::RealtimeResponse::Audio
+        # Which conversation the response is added to, determined by the `conversation`
+        # field in the `response.create` event. If `auto`, the response will be added to
+        # the default conversation and the value of `conversation_id` will be an id like
+        # `conv_1234`. If `none`, the response will not be added to any conversation and
+        # the value of `conversation_id` will be `null`. If responses are being triggered
+        # automatically by VAD the response will be added to the default conversation
         attr_reader conversation_id: String?
+        # Which conversation the response is added to, determined by the `conversation`
+        # field in the `response.create` event. If `auto`, the response will be added to
+        # the default conversation and the value of `conversation_id` will be an id like
+        # `conv_1234`. If `none`, the response will not be added to any conversation and
+        # the value of `conversation_id` will be `null`. If responses are being triggered
+        # automatically by VAD the response will be added to the default conversation
         def conversation_id=: (String) -> String
+        # Maximum number of output tokens for a single assistant response, inclusive of
+        # tool calls, that was used in this response.
         attr_reader max_output_tokens: OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens?
+        # Maximum number of output tokens for a single assistant response, inclusive of
+        # tool calls, that was used in this response.
         def max_output_tokens=: (
           OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens
         ) -> OpenAI::Models::Realtime::RealtimeResponse::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 object type, must be `realtime.response`.
         attr_reader object: OpenAI::Models::Realtime::RealtimeResponse::object?
+        # The object type, must be `realtime.response`.
         def object=: (
           OpenAI::Models::Realtime::RealtimeResponse::object
         ) -> OpenAI::Models::Realtime::RealtimeResponse::object
+        # The list of output items generated by the response.
         attr_reader output: ::Array[OpenAI::Models::Realtime::conversation_item]?
+        # The list of output items generated by the response.
         def output=: (
           ::Array[OpenAI::Models::Realtime::conversation_item]
         ) -> ::Array[OpenAI::Models::Realtime::conversation_item]
+        # 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::RealtimeResponse::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::RealtimeResponse::output_modality]
         ) -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::output_modality]
+        # The final status of the response (`completed`, `cancelled`, `failed`, or
+        # `incomplete`, `in_progress`).
         attr_reader status: OpenAI::Models::Realtime::RealtimeResponse::status?
+        # The final status of the response (`completed`, `cancelled`, `failed`, or
+        # `incomplete`, `in_progress`).
         def status=: (
           OpenAI::Models::Realtime::RealtimeResponse::status
         ) -> OpenAI::Models::Realtime::RealtimeResponse::status
+        # Additional details about the status.
         attr_reader status_details: OpenAI::Realtime::RealtimeResponseStatus?
+        # Additional details about the status.
         def status_details=: (
           OpenAI::Realtime::RealtimeResponseStatus
         ) -> OpenAI::Realtime::RealtimeResponseStatus
+        # Usage statistics for the Response, this will correspond to billing. A Realtime
+        # API session will maintain a conversation context and append new Items to the
+        # Conversation, thus output from previous turns (text and audio tokens) will
+        # become the input for later turns.
         attr_reader usage: OpenAI::Realtime::RealtimeResponseUsage?
+        # Usage statistics for the Response, this will correspond to billing. A Realtime
+        # API session will maintain a conversation context and append new Items to the
+        # Conversation, thus output from previous turns (text and audio tokens) will
+        # become the input for later turns.
         def usage=: (
           OpenAI::Realtime::RealtimeResponseUsage
         ) -> OpenAI::Realtime::RealtimeResponseUsage
+        # @param id
+        #   The unique ID of the response, will look like `resp_1234`.
+        # @param audio
+        #   Configuration for audio output.
+        # @param conversation_id
+        #   Which conversation the response is added to, determined by the `conversation`
+        #   field in the `response.create` event. If `auto`, the response will be added to
+        #   the default conversation and the value of `conversation_id` will be an id like
+        #   `conv_1234`. If `none`, the response will not be added to any conversation and
+        #   the value of `conversation_id` will be `null`. If responses are being triggered
+        #   automatically by VAD the response will be added to the default conversation
+        # @param max_output_tokens
+        #   Maximum number of output tokens for a single assistant response, inclusive of
+        #   tool calls, that was used in this response.
+        # @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 object
+        #   The object type, must be `realtime.response`.
+        # @param output
+        #   The list of output items generated by the response.
+        # @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 status
+        #   The final status of the response (`completed`, `cancelled`, `failed`, or
+        #   `incomplete`, `in_progress`).
+        # @param status_details
+        #   Additional details about the status.
+        # @param usage
+        #   Usage statistics for the Response, this will correspond to billing. A Realtime
+        #   API session will maintain a conversation context and append new Items to the
+        #   Conversation, thus output from previous turns (text and audio tokens) will
+        #   become the input for later turns.
         def initialize: (
           ?id: String,
           ?audio: OpenAI::Realtime::RealtimeResponse::Audio,
@@ -128,18 +220,35 @@ module OpenAI
             }
           class Output < OpenAI::Internal::Type::BaseModel
+            # The format of the output audio.
             attr_reader format_: OpenAI::Models::Realtime::realtime_audio_formats?
+            # The format of the output audio.
             def format_=: (
               OpenAI::Models::Realtime::realtime_audio_formats
             ) -> OpenAI::Models::Realtime::realtime_audio_formats
+            # The voice the model uses to respond. Voice cannot be changed during the session
+            # once the model has responded with audio at least once. Current voice options are
+            # `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
+            # and `cedar`. We recommend `marin` and `cedar` for best quality.
             attr_reader voice: OpenAI::Models::Realtime::RealtimeResponse::Audio::Output::voice?
+            # The voice the model uses to respond. Voice cannot be changed during the session
+            # once the model has responded with audio at least once. Current voice options are
+            # `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
+            # and `cedar`. We recommend `marin` and `cedar` for best quality.
             def voice=: (
               OpenAI::Models::Realtime::RealtimeResponse::Audio::Output::voice
             ) -> OpenAI::Models::Realtime::RealtimeResponse::Audio::Output::voice
+            # @param format_
+            #   The format of the output audio.
+            # @param voice
+            #   The voice the model uses to respond. Voice cannot be changed during the session
+            #   once the model has responded with audio at least once. Current voice options are
+            #   `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
+            #   and `cedar`. We recommend `marin` and `cedar` for best quality.
             def initialize: (
               ?format_: OpenAI::Models::Realtime::realtime_audio_formats,
               ?voice: OpenAI::Models::Realtime::RealtimeResponse::Audio::Output::voice

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

@@ -26,18 +26,41 @@ module OpenAI
           }
         class Output < OpenAI::Internal::Type::BaseModel
+          # The format of the output audio.
           attr_reader format_: OpenAI::Models::Realtime::realtime_audio_formats?
+          # The format of the output audio.
           def format_=: (
             OpenAI::Models::Realtime::realtime_audio_formats
           ) -> OpenAI::Models::Realtime::realtime_audio_formats
+          # The voice the model uses to respond. Supported built-in voices are `alloy`,
+          # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+          # `cedar`. You may also provide a custom voice object with an `id`, for example
+          # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          # model has responded with audio at least once. We recommend `marin` and `cedar`
+          # for best quality.
           attr_reader voice: OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::voice?
+          # The voice the model uses to respond. Supported built-in voices are `alloy`,
+          # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+          # `cedar`. You may also provide a custom voice object with an `id`, for example
+          # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          # model has responded with audio at least once. We recommend `marin` and `cedar`
+          # for best quality.
           def voice=: (
             OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::voice
           ) -> OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::voice
+          # @param format_
+          #   The format of the output audio.
+          # @param voice
+          #   The voice the model uses to respond. Supported built-in voices are `alloy`,
+          #   `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+          #   `cedar`. You may also provide a custom voice object with an `id`, for example
+          #   `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          #   model has responded with audio at least once. We recommend `marin` and `cedar`
+          #   for best quality.
           def initialize: (
             ?format_: OpenAI::Models::Realtime::realtime_audio_formats,
             ?voice: OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::voice
@@ -68,8 +91,11 @@ module OpenAI
             type id = { id: String }
             class ID < OpenAI::Internal::Type::BaseModel
+              # The custom voice ID, e.g. `voice_1234`.
               attr_accessor id: String
+              # @param id
+              #   The custom voice ID, e.g. `voice_1234`.
               def initialize: (id: String) -> void
               def to_hash: -> { id: String }

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

@@ -18,44 +18,154 @@ module OpenAI
         }
       class RealtimeResponseCreateMcpTool < OpenAI::Internal::Type::BaseModel
+        # A label for this MCP server, used to identify it in tool calls.
         attr_accessor server_label: String
+        # The type of the MCP tool. Always `mcp`.
         attr_accessor type: :mcp
+        # The tool invocation context(s).
         attr_accessor allowed_callers: ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::allowed_caller]?
+        # List of allowed tool names or a filter object.
         attr_accessor allowed_tools: OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::allowed_tools?
+        # An OAuth access token that can be used with a remote MCP server, either with a
+        # custom MCP server URL or a service connector. Your application must handle the
+        # OAuth authorization flow and provide the token here.
         attr_reader authorization: String?
+        # An OAuth access token that can be used with a remote MCP server, either with a
+        # custom MCP server URL or a service connector. Your application must handle the
+        # OAuth authorization flow and provide the token here.
         def authorization=: (String) -> String
+        # Identifier for service connectors, like those available in ChatGPT. One of
+        # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
+        # service connectors
+        # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
+        #
+        # This field is deprecated for models released after September 1, 2026. Use
+        # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+        # through a Secure MCP Tunnel.
+        #
+        # Currently supported `connector_id` values are:
+        #
+        # - Dropbox: `connector_dropbox`
+        # - Gmail: `connector_gmail`
+        # - Google Calendar: `connector_googlecalendar`
+        # - Google Drive: `connector_googledrive`
+        # - Microsoft Teams: `connector_microsoftteams`
+        # - Outlook Calendar: `connector_outlookcalendar`
+        # - Outlook Email: `connector_outlookemail`
+        # - SharePoint: `connector_sharepoint`
         attr_reader connector_id: OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::connector_id?
+        # Identifier for service connectors, like those available in ChatGPT. One of
+        # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
+        # service connectors
+        # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
+        #
+        # This field is deprecated for models released after September 1, 2026. Use
+        # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+        # through a Secure MCP Tunnel.
+        #
+        # Currently supported `connector_id` values are:
+        #
+        # - Dropbox: `connector_dropbox`
+        # - Gmail: `connector_gmail`
+        # - Google Calendar: `connector_googlecalendar`
+        # - Google Drive: `connector_googledrive`
+        # - Microsoft Teams: `connector_microsoftteams`
+        # - Outlook Calendar: `connector_outlookcalendar`
+        # - Outlook Email: `connector_outlookemail`
+        # - SharePoint: `connector_sharepoint`
         def connector_id=: (
           OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::connector_id
         ) -> OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::connector_id
+        # Whether this MCP tool is deferred and discovered via tool search.
         attr_reader defer_loading: bool?
+        # Whether this MCP tool is deferred and discovered via tool search.
         def defer_loading=: (bool) -> bool
+        # Optional HTTP headers to send to the MCP server. Use for authentication or other
+        # purposes.
         attr_accessor headers: ::Hash[Symbol, String]?
+        # Specify which of the MCP server's tools require approval.
         attr_accessor require_approval: OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::require_approval?
+        # Optional description of the MCP server, used to provide more context.
         attr_reader server_description: String?
+        # Optional description of the MCP server, used to provide more context.
         def server_description=: (String) -> String
+        # The URL for the MCP server. One of `server_url`, `connector_id`, or `tunnel_id`
+        # must be provided.
         attr_reader server_url: String?
+        # The URL for the MCP server. One of `server_url`, `connector_id`, or `tunnel_id`
+        # must be provided.
         def server_url=: (String) -> String
+        # The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+        # `server_url`, `connector_id`, or `tunnel_id` must be provided.
         attr_reader tunnel_id: String?
+        # The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+        # `server_url`, `connector_id`, or `tunnel_id` must be provided.
         def tunnel_id=: (String) -> String
+        # @param server_label
+        #   A label for this MCP server, used to identify it in tool calls.
+        # @param allowed_callers
+        #   The tool invocation context(s).
+        # @param allowed_tools
+        #   List of allowed tool names or a filter object.
+        # @param authorization
+        #   An OAuth access token that can be used with a remote MCP server, either with a
+        #   custom MCP server URL or a service connector. Your application must handle the
+        #   OAuth authorization flow and provide the token here.
+        # @param connector_id
+        #   Identifier for service connectors, like those available in ChatGPT. One of
+        #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
+        #   service connectors
+        #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
+        #
+        #   This field is deprecated for models released after September 1, 2026. Use
+        #   `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+        #   through a Secure MCP Tunnel.
+        #
+        #   Currently supported `connector_id` values are:
+        #
+        #   - Dropbox: `connector_dropbox`
+        #   - Gmail: `connector_gmail`
+        #   - Google Calendar: `connector_googlecalendar`
+        #   - Google Drive: `connector_googledrive`
+        #   - Microsoft Teams: `connector_microsoftteams`
+        #   - Outlook Calendar: `connector_outlookcalendar`
+        #   - Outlook Email: `connector_outlookemail`
+        #   - SharePoint: `connector_sharepoint`
+        # @param defer_loading
+        #   Whether this MCP tool is deferred and discovered via tool search.
+        # @param headers
+        #   Optional HTTP headers to send to the MCP server. Use for authentication or other
+        #   purposes.
+        # @param require_approval
+        #   Specify which of the MCP server's tools require approval.
+        # @param server_description
+        #   Optional description of the MCP server, used to provide more context.
+        # @param server_url
+        #   The URL for the MCP server. One of `server_url`, `connector_id`, or `tunnel_id`
+        #   must be provided.
+        # @param tunnel_id
+        #   The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+        #   `server_url`, `connector_id`, or `tunnel_id` must be provided.
+        # @param type
+        #   The type of the MCP tool. Always `mcp`.
         def initialize: (
           server_label: String,
           ?allowed_callers: ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::allowed_caller]?,
@@ -108,14 +218,31 @@ module OpenAI
             { ?read_only: bool, ?tool_names: ::Array[String] }
           class McpToolFilter < OpenAI::Internal::Type::BaseModel
+            # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+            # is
+            # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+            # it will match this filter.
             attr_reader read_only: bool?
+            # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+            # is
+            # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+            # it will match this filter.
             def read_only=: (bool) -> bool
+            # List of allowed tool names.
             attr_reader tool_names: ::Array[String]?
+            # List of allowed tool names.
             def tool_names=: (::Array[String]) -> ::Array[String]
+            # @param read_only
+            #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+            #   is
+            #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+            #   it will match this filter.
+            # @param tool_names
+            #   List of allowed tool names.
             def initialize: (
               ?read_only: bool,
               ?tool_names: ::Array[String]
@@ -168,18 +295,26 @@ module OpenAI
             }
           class McpToolApprovalFilter < OpenAI::Internal::Type::BaseModel
+            # A filter object to specify which tools are allowed.
             attr_reader always: OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always?
+            # A filter object to specify which tools are allowed.
             def always=: (
               OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always
             ) -> OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always
+            # A filter object to specify which tools are allowed.
             attr_reader never: OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never?
+            # A filter object to specify which tools are allowed.
             def never=: (
               OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never
             ) -> OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never
+            # @param always
+            #   A filter object to specify which tools are allowed.
+            # @param never
+            #   A filter object to specify which tools are allowed.
             def initialize: (
               ?always: OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always,
               ?never: OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never
@@ -193,14 +328,31 @@ module OpenAI
             type always = { ?read_only: bool, ?tool_names: ::Array[String] }
             class Always < OpenAI::Internal::Type::BaseModel
+              # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              # is
+              # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              # it will match this filter.
               attr_reader read_only: bool?
+              # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              # is
+              # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              # it will match this filter.
               def read_only=: (bool) -> bool
+              # List of allowed tool names.
               attr_reader tool_names: ::Array[String]?
+              # List of allowed tool names.
               def tool_names=: (::Array[String]) -> ::Array[String]
+              # @param read_only
+              #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              #   is
+              #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              #   it will match this filter.
+              # @param tool_names
+              #   List of allowed tool names.
               def initialize: (
                 ?read_only: bool,
                 ?tool_names: ::Array[String]
@@ -212,14 +364,31 @@ module OpenAI
             type never = { ?read_only: bool, ?tool_names: ::Array[String] }
             class Never < OpenAI::Internal::Type::BaseModel
+              # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              # is
+              # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              # it will match this filter.
               attr_reader read_only: bool?
+              # Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              # is
+              # [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              # it will match this filter.
               def read_only=: (bool) -> bool
+              # List of allowed tool names.
               attr_reader tool_names: ::Array[String]?
+              # List of allowed tool names.
               def tool_names=: (::Array[String]) -> ::Array[String]
+              # @param read_only
+              #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              #   is
+              #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              #   it will match this filter.
+              # @param tool_names
+              #   List of allowed tool names.
               def initialize: (
                 ?read_only: bool,
                 ?tool_names: ::Array[String]