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/beta/persisted_agent_tool.rbs CHANGED Viewed

@@ -21,16 +21,31 @@ module OpenAI
           }
         class Function < OpenAI::Internal::Type::BaseModel
+          # Whether the function is deferred and discovered through tool search.
           attr_accessor defer_loading: bool
+          # A description of what the function does.
           attr_accessor description: String
+          # The name of the function.
           attr_accessor name: String
+          # A JSON Schema object describing the function's arguments.
           attr_accessor parameters: ::Hash[Symbol, top]
+          # The type of the object. Always `function`.
           attr_accessor type: :function
+          # @param defer_loading
+          #   Whether the function is deferred and discovered through tool search.
+          # @param description
+          #   A description of what the function does.
+          # @param name
+          #   The name of the function.
+          # @param parameters
+          #   A JSON Schema object describing the function's arguments.
+          # @param type
+          #   The type of the object. Always `function`.
           def initialize: (
             defer_loading: bool,
             description: String,
@@ -51,8 +66,11 @@ module OpenAI
         type tool_search = { ?type: :tool_search }
         class ToolSearch < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `tool_search`.
           attr_accessor type: :tool_search
+          # @param type
+          #   The type of the object. Always `tool_search`.
           def initialize: (?type: :tool_search) -> void
           def to_hash: -> { ?type: :tool_search }
@@ -62,10 +80,16 @@ module OpenAI
           { enabled: bool, ?type: :programmatic_tool_calling }
         class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          # Whether tools can be called from model-generated code.
           attr_accessor enabled: bool
+          # The type of the object. Always `programmatic_tool_calling`.
           attr_accessor type: :programmatic_tool_calling
+          # @param enabled
+          #   Whether tools can be called from model-generated code.
+          # @param type
+          #   The type of the object. Always `programmatic_tool_calling`.
           def initialize: (
             enabled: bool,
             ?type: :programmatic_tool_calling
@@ -87,22 +111,46 @@ module OpenAI
           }
         class Mcp < OpenAI::Internal::Type::BaseModel
+          # The MCP tools the agent may call, or null when all server tools are allowed.
           attr_accessor allowed_tools: ::Array[String]?
+          # Where outbound MCP HTTP connections originate.
           attr_accessor connection_origin: OpenAI::Models::Beta::PersistedAgentTool::Mcp::connection_origin
+          # The vault credential selected for this MCP server, if any.
           attr_accessor credential_id: String?
+          # Metadata included with requests to this MCP server.
           attr_accessor request_metadata: ::Hash[Symbol, top]
+          # Whether this MCP server must initialize before the first turn.
           attr_accessor required: bool
+          # A label used to identify the MCP server in tool calls.
           attr_accessor server_label: String
+          # The credential-free transport used to connect to the MCP server.
           attr_accessor transport: OpenAI::Models::Beta::persisted_mcp_transport
+          # The type of the object. Always `mcp`.
           attr_accessor type: :mcp
+          # @param allowed_tools
+          #   The MCP tools the agent may call, or null when all server tools are allowed.
+          # @param connection_origin
+          #   Where outbound MCP HTTP connections originate.
+          # @param credential_id
+          #   The vault credential selected for this MCP server, if any.
+          # @param request_metadata
+          #   Metadata included with requests to this MCP server.
+          # @param required
+          #   Whether this MCP server must initialize before the first turn.
+          # @param server_label
+          #   A label used to identify the MCP server in tool calls.
+          # @param transport
+          #   The credential-free transport used to connect to the MCP server.
+          # @param type
+          #   The type of the object. Always `mcp`.
           def initialize: (
             allowed_tools: ::Array[String]?,
             connection_origin: OpenAI::Models::Beta::PersistedAgentTool::Mcp::connection_origin,
@@ -147,16 +195,31 @@ module OpenAI
           }
         class WebSearch < OpenAI::Internal::Type::BaseModel
+          # Allowed search domains, or `null` when the search is unrestricted.
           attr_accessor allowed_domains: ::Array[String]?
+          # The amount of search context made available to the model. Defaults to `medium`.
           attr_accessor context_size: OpenAI::Models::Beta::PersistedAgentTool::WebSearch::context_size
+          # Approximate location used to localize search results, if provided.
           attr_accessor location: OpenAI::Beta::PersistedAgentTool::WebSearch::Location?
+          # The source used for web search results.
           attr_accessor mode: OpenAI::Models::Beta::PersistedAgentTool::WebSearch::mode
+          # The type of the object. Always `web_search`.
           attr_accessor type: :web_search
+          # @param allowed_domains
+          #   Allowed search domains, or `null` when the search is unrestricted.
+          # @param context_size
+          #   The amount of search context made available to the model. Defaults to `medium`.
+          # @param location
+          #   Approximate location used to localize search results, if provided.
+          # @param mode
+          #   The source used for web search results.
+          # @param type
+          #   The type of the object. Always `web_search`.
           def initialize: (
             allowed_domains: ::Array[String]?,
             context_size: OpenAI::Models::Beta::PersistedAgentTool::WebSearch::context_size,
@@ -194,14 +257,26 @@ module OpenAI
             }
           class Location < OpenAI::Internal::Type::BaseModel
+            # The city name.
             attr_accessor city: String?
+            # The two-letter ISO country code, such as `US`.
             attr_accessor country: String?
+            # The region or state name.
             attr_accessor region: String?
+            # The IANA timezone, such as `America/Los_Angeles`.
             attr_accessor timezone: String?
+            # @param city
+            #   The city name.
+            # @param country
+            #   The two-letter ISO country code, such as `US`.
+            # @param region
+            #   The region or state name.
+            # @param timezone
+            #   The IANA timezone, such as `America/Los_Angeles`.
             def initialize: (
               city: String?,
               country: String?,

data/sig/openai/models/beta/persisted_agent_tool_param.rbs CHANGED Viewed

@@ -21,18 +21,37 @@ module OpenAI
           }
         class Function < OpenAI::Internal::Type::BaseModel
+          # A description of what the function does.
           attr_accessor description: String
+          # The name of the function.
           attr_accessor name: String
+          # A JSON Schema object describing the function's arguments.
           attr_accessor parameters: ::Hash[Symbol, top]
+          # The type of the object. Always `function`.
           attr_accessor type: :function
+          # Whether this function is deferred and discovered through tool search. Defaults
+          # to `false`.
           attr_reader defer_loading: bool?
+          # Whether this function is deferred and discovered through tool search. Defaults
+          # to `false`.
           def defer_loading=: (bool) -> bool
+          # @param description
+          #   A description of what the function does.
+          # @param name
+          #   The name of the function.
+          # @param parameters
+          #   A JSON Schema object describing the function's arguments.
+          # @param defer_loading
+          #   Whether this function is deferred and discovered through tool search. Defaults
+          #   to `false`.
+          # @param type
+          #   The type of the object. Always `function`.
           def initialize: (
             description: String,
             name: String,
@@ -53,8 +72,11 @@ module OpenAI
         type tool_search = { ?type: :tool_search }
         class ToolSearch < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `tool_search`.
           attr_accessor type: :tool_search
+          # @param type
+          #   The type of the object. Always `tool_search`.
           def initialize: (?type: :tool_search) -> void
           def to_hash: -> { ?type: :tool_search }
@@ -64,12 +86,19 @@ module OpenAI
           { ?type: :programmatic_tool_calling, ?enabled: bool }
         class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `programmatic_tool_calling`.
           attr_accessor type: :programmatic_tool_calling
+          # Whether tools can be called from model-generated code. Defaults to `true`.
           attr_reader enabled: bool?
+          # Whether tools can be called from model-generated code. Defaults to `true`.
           def enabled=: (bool) -> bool
+          # @param enabled
+          #   Whether tools can be called from model-generated code. Defaults to `true`.
+          # @param type
+          #   The type of the object. Always `programmatic_tool_calling`.
           def initialize: (
             ?enabled: bool,
             ?type: :programmatic_tool_calling
@@ -91,24 +120,54 @@ module OpenAI
           }
         class Mcp < OpenAI::Internal::Type::BaseModel
+          # A label used to identify the MCP server in tool calls.
           attr_accessor server_label: String
+          # The credential-free transport used to connect to the MCP server.
           attr_accessor transport: OpenAI::Models::Beta::persisted_mcp_transport_param
+          # The type of the object. Always `mcp`.
           attr_accessor type: :mcp
+          # The MCP tools the agent may call. All server tools are allowed when omitted.
           attr_accessor allowed_tools: ::Array[String]?
+          # Selects where outbound MCP HTTP connections originate.
           attr_accessor connection_origin: OpenAI::Models::Beta::PersistedAgentToolParam::Mcp::connection_origin?
+          # The vault credential selected for this MCP server. Optional when exactly one
+          # attached credential matches the server URL.
           attr_accessor credential_id: String?
+          # Metadata included with requests to this MCP server.
           attr_accessor request_metadata: ::Hash[Symbol, top]?
+          # Whether this MCP server must initialize before the first turn. Defaults to
+          # `false`.
           attr_reader required: bool?
+          # Whether this MCP server must initialize before the first turn. Defaults to
+          # `false`.
           def required=: (bool) -> bool
+          # @param server_label
+          #   A label used to identify the MCP server in tool calls.
+          # @param transport
+          #   The credential-free transport used to connect to the MCP server.
+          # @param allowed_tools
+          #   The MCP tools the agent may call. All server tools are allowed when omitted.
+          # @param connection_origin
+          #   Selects where outbound MCP HTTP connections originate.
+          # @param credential_id
+          #   The vault credential selected for this MCP server. Optional when exactly one
+          #   attached credential matches the server URL.
+          # @param request_metadata
+          #   Metadata included with requests to this MCP server.
+          # @param required
+          #   Whether this MCP server must initialize before the first turn. Defaults to
+          #   `false`.
+          # @param type
+          #   The type of the object. Always `mcp`.
           def initialize: (
             server_label: String,
             transport: OpenAI::Models::Beta::persisted_mcp_transport_param,
@@ -156,16 +215,31 @@ module OpenAI
           }
         class WebSearch < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `web_search`.
           attr_accessor type: :web_search
+          # Domains the search may include.
           attr_accessor allowed_domains: ::Array[String]?
+          # The amount of search context made available to the model. Defaults to `medium`.
           attr_accessor context_size: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::context_size?
+          # Approximate location used to localize search results.
           attr_accessor location: OpenAI::Beta::PersistedAgentToolParam::WebSearch::Location?
+          # The source used for web search results. Defaults to `live`.
           attr_accessor mode: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::mode?
+          # @param allowed_domains
+          #   Domains the search may include.
+          # @param context_size
+          #   The amount of search context made available to the model. Defaults to `medium`.
+          # @param location
+          #   Approximate location used to localize search results.
+          # @param mode
+          #   The source used for web search results. Defaults to `live`.
+          # @param type
+          #   The type of the object. Always `web_search`.
           def initialize: (
             ?allowed_domains: ::Array[String]?,
             ?context_size: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::context_size?,
@@ -203,14 +277,26 @@ module OpenAI
             }
           class Location < OpenAI::Internal::Type::BaseModel
+            # The city name.
             attr_accessor city: String?
+            # The two-letter ISO country code, such as `US`.
             attr_accessor country: String?
+            # The region or state name.
             attr_accessor region: String?
+            # The IANA timezone, such as `America/Los_Angeles`.
             attr_accessor timezone: String?
+            # @param city
+            #   The city name.
+            # @param country
+            #   The two-letter ISO country code, such as `US`.
+            # @param region
+            #   The region or state name.
+            # @param timezone
+            #   The IANA timezone, such as `America/Los_Angeles`.
             def initialize: (
               ?city: String?,
               ?country: String?,

data/sig/openai/models/beta/persisted_mcp_transport.rbs CHANGED Viewed

@@ -12,12 +12,21 @@ module OpenAI
           { headers: ::Hash[Symbol, String], server_url: String, ?type: :http }
         class HTTP < OpenAI::Internal::Type::BaseModel
+          # Non-secret HTTP headers sent to the MCP server.
           attr_accessor headers: ::Hash[Symbol, String]
+          # The URL of the MCP server.
           attr_accessor server_url: String
+          # The type of the object. Always `http`.
           attr_accessor type: :http
+          # @param headers
+          #   Non-secret HTTP headers sent to the MCP server.
+          # @param server_url
+          #   The URL of the MCP server.
+          # @param type
+          #   The type of the object. Always `http`.
           def initialize: (
             headers: ::Hash[Symbol, String],
             server_url: String,
@@ -41,16 +50,31 @@ module OpenAI
           }
         class Stdio < OpenAI::Internal::Type::BaseModel
+          # Arguments passed to the MCP server command.
           attr_accessor args: ::Array[String]
+          # The command used to start the MCP server.
           attr_accessor command: String
+          # The working directory used to start the MCP server.
           attr_accessor cwd: String
+          # Environment variable names inherited from the execution environment.
           attr_accessor env_vars: ::Array[String]
+          # The type of the object. Always `stdio`.
           attr_accessor type: :stdio
+          # @param args
+          #   Arguments passed to the MCP server command.
+          # @param command
+          #   The command used to start the MCP server.
+          # @param cwd
+          #   The working directory used to start the MCP server.
+          # @param env_vars
+          #   Environment variable names inherited from the execution environment.
+          # @param type
+          #   The type of the object. Always `stdio`.
           def initialize: (
             args: ::Array[String],
             command: String,

data/sig/openai/models/beta/persisted_mcp_transport_param.rbs CHANGED Viewed

@@ -16,12 +16,21 @@ module OpenAI
           }
         class HTTP < OpenAI::Internal::Type::BaseModel
+          # The URL of the MCP server.
           attr_accessor server_url: String
+          # The type of the object. Always `http`.
           attr_accessor type: :http
+          # Non-secret HTTP headers sent to the MCP server.
           attr_accessor headers: ::Hash[Symbol, String]?
+          # @param server_url
+          #   The URL of the MCP server.
+          # @param headers
+          #   Non-secret HTTP headers sent to the MCP server.
+          # @param type
+          #   The type of the object. Always `http`.
           def initialize: (
             server_url: String,
             ?headers: ::Hash[Symbol, String]?,
@@ -45,16 +54,31 @@ module OpenAI
           }
         class Stdio < OpenAI::Internal::Type::BaseModel
+          # The command used to start the MCP server.
           attr_accessor command: String
+          # The working directory used to start the MCP server.
           attr_accessor cwd: String
+          # The type of the object. Always `stdio`.
           attr_accessor type: :stdio
+          # Arguments passed to the MCP server command.
           attr_accessor args: ::Array[String]?
+          # Environment variable names to inherit from the selected execution environment.
           attr_accessor env_vars: ::Array[String]?
+          # @param command
+          #   The command used to start the MCP server.
+          # @param cwd
+          #   The working directory used to start the MCP server.
+          # @param args
+          #   Arguments passed to the MCP server command.
+          # @param env_vars
+          #   Environment variable names to inherit from the selected execution environment.
+          # @param type
+          #   The type of the object. Always `stdio`.
           def initialize: (
             command: String,
             cwd: String,

data/sig/openai/models/beta/response_compact_params.rbs CHANGED Viewed

@@ -19,20 +19,61 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
+        # Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
+        # range of models with different capabilities, performance characteristics, and
+        # price points. Refer to the
+        # [model guide](https://developers.openai.com/api/docs/models) to browse and
+        # compare available models.
         attr_accessor model: OpenAI::Models::Beta::ResponseCompactParams::model?
+        # Text, image, or file inputs to the model, used to generate a response
         attr_accessor input: OpenAI::Models::Beta::ResponseCompactParams::input?
+        # A system (or developer) message inserted into the model's context. When used
+        # along with `previous_response_id`, the instructions from a previous response
+        # will not be carried over to the next response. This makes it simple to swap out
+        # system (or developer) messages in new responses.
         attr_accessor instructions: String?
+        # The unique ID of the previous response to the model. Use this to create
+        # multi-turn conversations. Learn more about
+        # [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
+        # Cannot be used in conjunction with `conversation`.
         attr_accessor previous_response_id: String?
+        # A key to use when reading from or writing to the prompt cache.
         attr_accessor prompt_cache_key: String?
+        # Options for prompt caching. Supported for `gpt-5.6` and later models. By
+        # default, OpenAI automatically chooses one implicit cache breakpoint. You can add
+        # explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
+        # request can write up to four breakpoints. For cache matching, OpenAI considers
+        # up to the latest 80 breakpoints in the conversation, without a content-block
+        # lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
+        # `ttl` defaults to `30m`, which is currently the only supported value. See the
+        # [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
+        # for current details.
         attr_accessor prompt_cache_options: OpenAI::Beta::ResponseCompactParams::PromptCacheOptions?
+        # How long to retain a prompt cache entry created by this request.
         attr_accessor prompt_cache_retention: OpenAI::Models::Beta::ResponseCompactParams::prompt_cache_retention?
+        # Specifies the processing type used for serving the request. - If set to 'auto',
+        # then the request will be processed with the service tier configured in the
+        # Project settings. Unless otherwise configured, the Project will use 'default'. -
+        # If set to 'default', then the request will be processed with the standard
+        # pricing and performance for the selected model. - If set to
+        # '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        # the request will be processed with the Flex Processing service tier. - To opt-in
+        # to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        # request level, include the `service_tier=fast` or `service_tier=priority`
+        # parameter for Responses or Chat Completions. For models with a dedicated Fast
+        # tier, either value resolves to `service_tier=fast`; for other models, either
+        # value resolves to `service_tier=priority`. - When not set, the default behavior
+        # is 'auto'. When the `service_tier` parameter is set, the response body will
+        # include the `service_tier` value based on the processing mode actually used to
+        # serve the request. This response value may be different from the value set in
+        # the parameter.
         attr_accessor service_tier: OpenAI::Models::Beta::ResponseCompactParams::service_tier?
         attr_reader betas: ::Array[OpenAI::Models::Beta::ResponseCompactParams::beta]?
@@ -41,6 +82,55 @@ module OpenAI
           ::Array[OpenAI::Models::Beta::ResponseCompactParams::beta]
         ) -> ::Array[OpenAI::Models::Beta::ResponseCompactParams::beta]
+        # @param model
+        #   Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
+        #   range of models with different capabilities, performance characteristics, and
+        #   price points. Refer to the
+        #   [model guide](https://developers.openai.com/api/docs/models) to browse and
+        #   compare available models.
+        # @param input
+        #   Text, image, or file inputs to the model, used to generate a response
+        # @param instructions
+        #   A system (or developer) message inserted into the model's context. When used
+        #   along with `previous_response_id`, the instructions from a previous response
+        #   will not be carried over to the next response. This makes it simple to swap out
+        #   system (or developer) messages in new responses.
+        # @param previous_response_id
+        #   The unique ID of the previous response to the model. Use this to create
+        #   multi-turn conversations. Learn more about
+        #   [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
+        #   Cannot be used in conjunction with `conversation`.
+        # @param prompt_cache_key
+        #   A key to use when reading from or writing to the prompt cache.
+        # @param prompt_cache_options
+        #   Options for prompt caching. Supported for `gpt-5.6` and later models. By
+        #   default, OpenAI automatically chooses one implicit cache breakpoint. You can add
+        #   explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
+        #   request can write up to four breakpoints. For cache matching, OpenAI considers
+        #   up to the latest 80 breakpoints in the conversation, without a content-block
+        #   lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
+        #   `ttl` defaults to `30m`, which is currently the only supported value. See the
+        #   [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
+        #   for current details.
+        # @param prompt_cache_retention
+        #   How long to retain a prompt cache entry created by this request.
+        # @param service_tier
+        #   Specifies the processing type used for serving the request. - If set to 'auto',
+        #   then the request will be processed with the service tier configured in the
+        #   Project settings. Unless otherwise configured, the Project will use 'default'. -
+        #   If set to 'default', then the request will be processed with the standard
+        #   pricing and performance for the selected model. - If set to
+        #   '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #   the request will be processed with the Flex Processing service tier. - To opt-in
+        #   to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #   request level, include the `service_tier=fast` or `service_tier=priority`
+        #   parameter for Responses or Chat Completions. For models with a dedicated Fast
+        #   tier, either value resolves to `service_tier=fast`; for other models, either
+        #   value resolves to `service_tier=priority`. - When not set, the default behavior
+        #   is 'auto'. When the `service_tier` parameter is set, the response body will
+        #   include the `service_tier` value based on the processing mode actually used to
+        #   serve the request. This response value may be different from the value set in
+        #   the parameter.
         def initialize: (
           model: OpenAI::Models::Beta::ResponseCompactParams::model?,
           ?input: OpenAI::Models::Beta::ResponseCompactParams::input?,
@@ -88,6 +178,7 @@ module OpenAI
           | :"gpt-5.1"
           | :"gpt-5.1-2025-11-13"
           | :"gpt-5.1-codex"
+          | :"gpt-5.1-mini"
           | :"gpt-5.1-chat-latest"
           | :"gpt-5"
           | :"gpt-5-mini"
@@ -153,7 +244,6 @@ module OpenAI
           | :"gpt-3.5-turbo-1106"
           | :"gpt-3.5-turbo-0125"
           | :"gpt-3.5-turbo-16k-0613"
-          | :"gpt-5.1-mini"
           | :"o1-pro"
           | :"o1-pro-2025-03-19"
           | :"o3-pro"
@@ -200,6 +290,7 @@ module OpenAI
           GPT_5_1: :"gpt-5.1"
           GPT_5_1_2025_11_13: :"gpt-5.1-2025-11-13"
           GPT_5_1_CODEX: :"gpt-5.1-codex"
+          GPT_5_1_MINI: :"gpt-5.1-mini"
           GPT_5_1_CHAT_LATEST: :"gpt-5.1-chat-latest"
           GPT_5: :"gpt-5"
           GPT_5_MINI: :"gpt-5-mini"
@@ -265,7 +356,6 @@ module OpenAI
           GPT_3_5_TURBO_1106: :"gpt-3.5-turbo-1106"
           GPT_3_5_TURBO_0125: :"gpt-3.5-turbo-0125"
           GPT_3_5_TURBO_16K_0613: :"gpt-3.5-turbo-16k-0613"
-          GPT_5_1_MINI: :"gpt-5.1-mini"
           O1_PRO: :"o1-pro"
           O1_PRO_2025_03_19: :"o1-pro-2025-03-19"
           O3_PRO: :"o3-pro"
@@ -305,18 +395,47 @@ module OpenAI
           }
         class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
+          # Controls whether OpenAI automatically creates an implicit cache breakpoint.
+          # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
+          # and writes up to the latest three explicit breakpoints in the request. With
+          # `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
+          # latest four explicit breakpoints. If there are no explicit breakpoints, the
+          # request does not use prompt caching.
           attr_reader mode: OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::mode?
+          # Controls whether OpenAI automatically creates an implicit cache breakpoint.
+          # Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
+          # and writes up to the latest three explicit breakpoints in the request. With
+          # `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
+          # latest four explicit breakpoints. If there are no explicit breakpoints, the
+          # request does not use prompt caching.
           def mode=: (
             OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::mode
           ) -> OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::mode
+          # The minimum lifetime applied to every implicit and explicit cache breakpoint
+          # written by the request. Defaults to `30m`, which is currently the only supported
+          # value. The backend may retain cache entries for longer.
           attr_reader ttl: OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::ttl?
+          # The minimum lifetime applied to every implicit and explicit cache breakpoint
+          # written by the request. Defaults to `30m`, which is currently the only supported
+          # value. The backend may retain cache entries for longer.
           def ttl=: (
             OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::ttl
           ) -> OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::ttl
+          # @param mode
+          #   Controls whether OpenAI automatically creates an implicit cache breakpoint.
+          #   Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
+          #   and writes up to the latest three explicit breakpoints in the request. With
+          #   `explicit`, OpenAI does not create an implicit breakpoint and writes up to the
+          #   latest four explicit breakpoints. If there are no explicit breakpoints, the
+          #   request does not use prompt caching.
+          # @param ttl
+          #   The minimum lifetime applied to every implicit and explicit cache breakpoint
+          #   written by the request. Defaults to `30m`, which is currently the only supported
+          #   value. The backend may retain cache entries for longer.
           def initialize: (
             ?mode: OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::mode,
             ?ttl: OpenAI::Models::Beta::ResponseCompactParams::PromptCacheOptions::ttl