openai 0.92.0 → 0.93.0

data/sig/openai/models/responses/tool_choice_apply_patch.rbs

@@ -4,8 +4,11 @@ module OpenAI
       type tool_choice_apply_patch = { ?type: :apply_patch }
 
       class ToolChoiceApplyPatch < OpenAI::Internal::Type::BaseModel
+        # The tool to call. Always `apply_patch`.
         attr_accessor type: :apply_patch
 
+        # @param type
+        #   The tool to call. Always `apply_patch`.
         def initialize: (?type: :apply_patch) -> void
 
         def to_hash: -> { ?type: :apply_patch }

data/sig/openai/models/responses/tool_choice_custom.rbs

@@ -4,10 +4,16 @@ module OpenAI
       type tool_choice_custom = { name: String, ?type: :custom }
 
       class ToolChoiceCustom < OpenAI::Internal::Type::BaseModel
+        # The name of the custom tool to call.
         attr_accessor name: String
 
+        # For custom tool calling, the type is always `custom`.
         attr_accessor type: :custom
 
+        # @param name
+        #   The name of the custom tool to call.
+        # @param type
+        #   For custom tool calling, the type is always `custom`.
         def initialize: (name: String, ?type: :custom) -> void
 
         def to_hash: -> { name: String, ?type: :custom }

data/sig/openai/models/responses/tool_choice_function.rbs

@@ -4,10 +4,16 @@ module OpenAI
       type tool_choice_function = { name: String, ?type: :function }
 
       class ToolChoiceFunction < OpenAI::Internal::Type::BaseModel
+        # The name of the function to call.
         attr_accessor name: String
 
+        # For function calling, the type is always `function`.
         attr_accessor type: :function
 
+        # @param name
+        #   The name of the function to call.
+        # @param type
+        #   For function calling, the type is always `function`.
         def initialize: (name: String, ?type: :function) -> void
 
         def to_hash: -> { name: String, ?type: :function }

data/sig/openai/models/responses/tool_choice_mcp.rbs

@@ -5,12 +5,21 @@ module OpenAI
         { server_label: String, ?type: :mcp, ?name: String? }
 
       class ToolChoiceMcp < OpenAI::Internal::Type::BaseModel
+        # The label of the MCP server to use.
         attr_accessor server_label: String
 
+        # For MCP tools, the type is always `mcp`.
         attr_accessor type: :mcp
 
+        # The name of the tool to call on the server.
         attr_accessor name: String?
 
+        # @param server_label
+        #   The label of the MCP server to use.
+        # @param name
+        #   The name of the tool to call on the server.
+        # @param type
+        #   For MCP tools, the type is always `mcp`.
         def initialize: (
           server_label: String,
           ?name: String?,

data/sig/openai/models/responses/tool_choice_shell.rbs

@@ -4,8 +4,11 @@ module OpenAI
       type tool_choice_shell = { ?type: :shell }
 
       class ToolChoiceShell < OpenAI::Internal::Type::BaseModel
+        # The tool to call. Always `shell`.
         attr_accessor type: :shell
 
+        # @param type
+        #   The tool to call. Always `shell`.
         def initialize: (?type: :shell) -> void
 
         def to_hash: -> { ?type: :shell }

data/sig/openai/models/responses/tool_choice_types.rbs

@@ -5,8 +5,33 @@ module OpenAI
         { type: OpenAI::Models::Responses::ToolChoiceTypes::type_ }
 
       class ToolChoiceTypes < OpenAI::Internal::Type::BaseModel
+        # The type of hosted tool the model should to use. Learn more about
+        # [built-in tools](https://developers.openai.com/api/docs/guides/tools).
+        #
+        # Allowed values are:
+        #
+        # - `file_search`
+        # - `web_search_preview`
+        # - `computer`
+        # - `computer_use_preview`
+        # - `computer_use`
+        # - `code_interpreter`
+        # - `image_generation`
         attr_accessor type: OpenAI::Models::Responses::ToolChoiceTypes::type_
 
+        # @param type
+        #   The type of hosted tool the model should to use. Learn more about
+        #   [built-in tools](https://developers.openai.com/api/docs/guides/tools).
+        #
+        #   Allowed values are:
+        #
+        #   - `file_search`
+        #   - `web_search_preview`
+        #   - `computer`
+        #   - `computer_use_preview`
+        #   - `computer_use`
+        #   - `code_interpreter`
+        #   - `image_generation`
         def initialize: (
           type: OpenAI::Models::Responses::ToolChoiceTypes::type_
         ) -> void

data/sig/openai/models/responses/tool_search_tool.rbs

@@ -10,18 +10,31 @@ module OpenAI
         }
 
       class ToolSearchTool < OpenAI::Internal::Type::BaseModel
+        # The type of the tool. Always `tool_search`.
         attr_accessor type: :tool_search
 
+        # Description shown to the model for a client-executed tool search tool.
         attr_accessor description: String?
 
+        # Whether tool search is executed by the server or by the client.
         attr_reader execution: OpenAI::Models::Responses::ToolSearchTool::execution?
 
+        # Whether tool search is executed by the server or by the client.
         def execution=: (
           OpenAI::Models::Responses::ToolSearchTool::execution
         ) -> OpenAI::Models::Responses::ToolSearchTool::execution
 
+        # Parameter schema for a client-executed tool search tool.
         attr_accessor parameters: top?
 
+        # @param description
+        #   Description shown to the model for a client-executed tool search tool.
+        # @param execution
+        #   Whether tool search is executed by the server or by the client.
+        # @param parameters
+        #   Parameter schema for a client-executed tool search tool.
+        # @param type
+        #   The type of the tool. Always `tool_search`.
         def initialize: (
           ?description: String?,
           ?execution: OpenAI::Models::Responses::ToolSearchTool::execution,

data/sig/openai/models/responses/web_search_preview_tool.rbs

@@ -10,6 +10,8 @@ module OpenAI
         }
 
       class WebSearchPreviewTool < OpenAI::Internal::Type::BaseModel
+        # The type of the web search tool. One of `web_search_preview` or
+        # `web_search_preview_2025_03_11`.
         attr_accessor type: OpenAI::Models::Responses::WebSearchPreviewTool::type_
 
         attr_reader search_content_types: ::Array[OpenAI::Models::Responses::WebSearchPreviewTool::search_content_type]?
@@ -18,14 +20,27 @@ module OpenAI
           ::Array[OpenAI::Models::Responses::WebSearchPreviewTool::search_content_type]
         ) -> ::Array[OpenAI::Models::Responses::WebSearchPreviewTool::search_content_type]
 
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
         attr_reader search_context_size: OpenAI::Models::Responses::WebSearchPreviewTool::search_context_size?
 
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
         def search_context_size=: (
           OpenAI::Models::Responses::WebSearchPreviewTool::search_context_size
         ) -> OpenAI::Models::Responses::WebSearchPreviewTool::search_context_size
 
+        # The user's location.
         attr_accessor user_location: OpenAI::Responses::WebSearchPreviewTool::UserLocation?
 
+        # @param type
+        #   The type of the web search tool. One of `web_search_preview` or
+        #   `web_search_preview_2025_03_11`.
+        # @param search_context_size
+        #   High level guidance for the amount of context window space to use for the
+        #   search. One of `low`, `medium`, or `high`. `medium` is the default.
+        # @param user_location
+        #   The user's location.
         def initialize: (
           type: OpenAI::Models::Responses::WebSearchPreviewTool::type_,
           ?search_content_types: ::Array[OpenAI::Models::Responses::WebSearchPreviewTool::search_content_type],
@@ -84,16 +99,35 @@ module OpenAI
           }
 
         class UserLocation < OpenAI::Internal::Type::BaseModel
+          # The type of location approximation. Always `approximate`.
           attr_accessor type: :approximate
 
+          # Free text input for the city of the user, e.g. `San Francisco`.
           attr_accessor city: String?
 
+          # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          # the user, e.g. `US`.
           attr_accessor country: String?
 
+          # Free text input for the region of the user, e.g. `California`.
           attr_accessor region: String?
 
+          # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          # user, e.g. `America/Los_Angeles`.
           attr_accessor timezone: String?
 
+          # @param city
+          #   Free text input for the city of the user, e.g. `San Francisco`.
+          # @param country
+          #   The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          #   the user, e.g. `US`.
+          # @param region
+          #   Free text input for the region of the user, e.g. `California`.
+          # @param timezone
+          #   The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          #   user, e.g. `America/Los_Angeles`.
+          # @param type
+          #   The type of location approximation. Always `approximate`.
           def initialize: (
             ?city: String?,
             ?country: String?,

data/sig/openai/models/responses/web_search_tool.rbs

@@ -11,22 +11,48 @@ module OpenAI
         }
 
       class WebSearchTool < OpenAI::Internal::Type::BaseModel
+        # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
         attr_accessor type: OpenAI::Models::Responses::WebSearchTool::type_
 
+        # Allow live internet access for web search. Defaults to true when omitted. When
+        # false, the web search tool runs in offline/cache-only mode and will not fetch
+        # new external content.
         attr_reader external_web_access: bool?
 
+        # Allow live internet access for web search. Defaults to true when omitted. When
+        # false, the web search tool runs in offline/cache-only mode and will not fetch
+        # new external content.
         def external_web_access=: (bool) -> bool
 
+        # Filters for the search.
         attr_accessor filters: OpenAI::Responses::WebSearchTool::Filters?
 
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
         attr_reader search_context_size: OpenAI::Models::Responses::WebSearchTool::search_context_size?
 
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
         def search_context_size=: (
           OpenAI::Models::Responses::WebSearchTool::search_context_size
         ) -> OpenAI::Models::Responses::WebSearchTool::search_context_size
 
+        # The approximate location of the user.
         attr_accessor user_location: OpenAI::Responses::WebSearchTool::UserLocation?
 
+        # @param type
+        #   The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+        # @param external_web_access
+        #   Allow live internet access for web search. Defaults to true when omitted. When
+        #   false, the web search tool runs in offline/cache-only mode and will not fetch
+        #   new external content.
+        # @param filters
+        #   Filters for the search.
+        # @param search_context_size
+        #   High level guidance for the amount of context window space to use for the
+        #   search. One of `low`, `medium`, or `high`. `medium` is the default.
+        # @param user_location
+        #   The approximate location of the user.
         def initialize: (
           type: OpenAI::Models::Responses::WebSearchTool::type_,
           ?external_web_access: bool,
@@ -57,8 +83,17 @@ module OpenAI
         type filters = { ?allowed_domains: ::Array[String]? }
 
         class Filters < OpenAI::Internal::Type::BaseModel
+          # Allowed domains for the search. If not provided, all domains are allowed.
+          # Subdomains of the provided domains are allowed as well.
+          #
+          # Example: `["pubmed.ncbi.nlm.nih.gov"]`
           attr_accessor allowed_domains: ::Array[String]?
 
+          # @param allowed_domains
+          #   Allowed domains for the search. If not provided, all domains are allowed.
+          #   Subdomains of the provided domains are allowed as well.
+          #
+          #   Example: `["pubmed.ncbi.nlm.nih.gov"]`
           def initialize: (?allowed_domains: ::Array[String]?) -> void
 
           def to_hash: -> { ?allowed_domains: ::Array[String]? }
@@ -86,20 +121,40 @@ module OpenAI
           }
 
         class UserLocation < OpenAI::Internal::Type::BaseModel
+          # Free text input for the city of the user, e.g. `San Francisco`.
           attr_accessor city: String?
 
+          # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          # the user, e.g. `US`.
           attr_accessor country: String?
 
+          # Free text input for the region of the user, e.g. `California`.
           attr_accessor region: String?
 
+          # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          # user, e.g. `America/Los_Angeles`.
           attr_accessor timezone: String?
 
+          # The type of location approximation. Always `approximate`.
           attr_reader type: OpenAI::Models::Responses::WebSearchTool::UserLocation::type_?
 
+          # The type of location approximation. Always `approximate`.
           def type=: (
             OpenAI::Models::Responses::WebSearchTool::UserLocation::type_
           ) -> OpenAI::Models::Responses::WebSearchTool::UserLocation::type_
 
+          # @param city
+          #   Free text input for the city of the user, e.g. `San Francisco`.
+          # @param country
+          #   The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          #   the user, e.g. `US`.
+          # @param region
+          #   Free text input for the region of the user, e.g. `California`.
+          # @param timezone
+          #   The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          #   user, e.g. `America/Los_Angeles`.
+          # @param type
+          #   The type of location approximation. Always `approximate`.
           def initialize: (
             ?city: String?,
             ?country: String?,

data/sig/openai/models/safety/alert_retrieve_params.rbs

@@ -8,8 +8,11 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        # Project safety alert ID
         attr_accessor id: String
 
+        # @param id
+        #   Project safety alert ID
         def initialize: (
           id: String,
           ?request_options: OpenAI::request_opts

data/sig/openai/models/safety/case_retrieve_params.rbs

@@ -0,0 +1,25 @@
+module OpenAI
+  module Models
+    module Safety
+      type case_retrieve_params =
+        { id: String, ?request_options: OpenAI::request_opts }
+
+      class CaseRetrieveParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # Safety case ID
+        attr_accessor id: String
+
+        # @param id
+        #   Safety case ID
+        def initialize: (
+          id: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> { id: String, ?request_options: OpenAI::RequestOptions }
+      end
+    end
+  end
+end

data/sig/openai/models/safety/safety_alert.rbs

@@ -27,14 +27,24 @@ module OpenAI
 
         attr_accessor object: :"safety.alert"
 
+        # A customer-safe description derived from error_type, or null for zero data
+        # retention requests.
         attr_accessor reason: String?
 
         attr_accessor request_id: String
 
+        # Whether block registration succeeded for this request. This does not confirm
+        # that response execution stopped.
         attr_accessor request_paused: bool
 
         attr_accessor response_id: String
 
+        # @param reason
+        #   A customer-safe description derived from error_type, or null for zero data
+        #   retention requests.
+        # @param request_paused
+        #   Whether block registration succeeded for this request. This does not confirm
+        #   that response execution stopped.
         def initialize: (
           id: String,
           created_at: Integer,

data/sig/openai/models/safety/safety_case.rbs

@@ -0,0 +1,75 @@
+module OpenAI
+  module Models
+    class SafetyCase = Safety::SafetyCase
+
+    module Safety
+      type safety_case =
+        {
+          id: String,
+          created_at: Integer,
+          entity_identifier: String,
+          notice: OpenAI::Safety::SafetyCase::Notice,
+          ?object: :"safety.case",
+          reason: String?
+        }
+
+      class SafetyCase < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Integer
+
+        attr_accessor entity_identifier: String
+
+        attr_accessor notice: OpenAI::Safety::SafetyCase::Notice
+
+        attr_accessor object: :"safety.case"
+
+        attr_accessor reason: String?
+
+        def initialize: (
+          id: String,
+          created_at: Integer,
+          entity_identifier: String,
+          notice: OpenAI::Safety::SafetyCase::Notice,
+          reason: String?,
+          ?object: :"safety.case"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Integer,
+          entity_identifier: String,
+          notice: OpenAI::Safety::SafetyCase::Notice,
+          ?object: :"safety.case",
+          reason: String?
+        }
+
+        type notice =
+          { type: OpenAI::Models::Safety::SafetyCase::Notice::type_ }
+
+        class Notice < OpenAI::Internal::Type::BaseModel
+          attr_accessor type: OpenAI::Models::Safety::SafetyCase::Notice::type_
+
+          def initialize: (
+            type: OpenAI::Models::Safety::SafetyCase::Notice::type_
+          ) -> void
+
+          def to_hash: -> {
+            type: OpenAI::Models::Safety::SafetyCase::Notice::type_
+          }
+
+          type type_ = :warning | :deactivation
+
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            WARNING: :warning
+            DEACTIVATION: :deactivation
+
+            def self?.values: -> ::Array[OpenAI::Models::Safety::SafetyCase::Notice::type_]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/skill.rbs

@@ -12,20 +12,41 @@ module OpenAI
       }
 
     class Skill < OpenAI::Internal::Type::BaseModel
+      # Unique identifier for the skill.
       attr_accessor id: String
 
+      # Unix timestamp (seconds) for when the skill was created.
       attr_accessor created_at: Integer
 
+      # Default version for the skill.
       attr_accessor default_version: String
 
+      # Description of the skill.
       attr_accessor description: String
 
+      # Latest version for the skill.
       attr_accessor latest_version: String
 
+      # Name of the skill.
       attr_accessor name: String
 
+      # The object type, which is `skill`.
       attr_accessor object: :skill
 
+      # @param id
+      #   Unique identifier for the skill.
+      # @param created_at
+      #   Unix timestamp (seconds) for when the skill was created.
+      # @param default_version
+      #   Default version for the skill.
+      # @param description
+      #   Description of the skill.
+      # @param latest_version
+      #   Latest version for the skill.
+      # @param name
+      #   Name of the skill.
+      # @param object
+      #   The object type, which is `skill`.
       def initialize: (
         id: String,
         created_at: Integer,

data/sig/openai/models/skill_create_params.rbs

@@ -10,12 +10,28 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # Skill files to upload (directory upload) or a single zip file.
+      #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
       attr_reader files: OpenAI::Models::SkillCreateParams::files?
 
+      # Skill files to upload (directory upload) or a single zip file.
+      #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
       def files=: (
         OpenAI::Models::SkillCreateParams::files
       ) -> OpenAI::Models::SkillCreateParams::files
 
+      # @param files
+      #   Skill files to upload (directory upload) or a single zip file.
+      #
+      #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #   content type.
       def initialize: (
         ?files: OpenAI::Models::SkillCreateParams::files,
         ?request_options: OpenAI::request_opts

data/sig/openai/models/skill_list.rbs

@@ -10,16 +10,31 @@ module OpenAI
       }
 
     class SkillList < OpenAI::Internal::Type::BaseModel
+      # A list of items
       attr_accessor data: ::Array[OpenAI::Skill]
 
+      # The ID of the first item in the list.
       attr_accessor first_id: String?
 
+      # Whether there are more items available.
       attr_accessor has_more: bool
 
+      # The ID of the last item in the list.
       attr_accessor last_id: String?
 
+      # The type of object returned, must be `list`.
       attr_accessor object: :list
 
+      # @param data
+      #   A list of items
+      # @param first_id
+      #   The ID of the first item in the list.
+      # @param has_more
+      #   Whether there are more items available.
+      # @param last_id
+      #   The ID of the last item in the list.
+      # @param object
+      #   The type of object returned, must be `list`.
       def initialize: (
         data: ::Array[OpenAI::Skill],
         first_id: String?,

data/sig/openai/models/skill_list_params.rbs

@@ -12,20 +12,35 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # Identifier for the last item from the previous pagination request
       attr_reader after: String?
 
+      # Identifier for the last item from the previous pagination request
       def after=: (String) -> String
 
+      # Number of items to retrieve
       attr_reader limit: Integer?
 
+      # Number of items to retrieve
       def limit=: (Integer) -> Integer
 
+      # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      # descending order.
       attr_reader order: OpenAI::Models::SkillListParams::order?
 
+      # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      # descending order.
       def order=: (
         OpenAI::Models::SkillListParams::order
       ) -> OpenAI::Models::SkillListParams::order
 
+      # @param after
+      #   Identifier for the last item from the previous pagination request
+      # @param limit
+      #   Number of items to retrieve
+      # @param order
+      #   Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      #   descending order.
       def initialize: (
         ?after: String,
         ?limit: Integer,

data/sig/openai/models/skill_update_params.rbs

@@ -13,8 +13,11 @@ module OpenAI
 
       attr_accessor skill_id: String
 
+      # The skill version number to set as default.
       attr_accessor default_version: String
 
+      # @param default_version
+      #   The skill version number to set as default.
       def initialize: (
         skill_id: String,
         default_version: String,

data/sig/openai/models/skills/deleted_skill_version.rbs

@@ -16,8 +16,11 @@ module OpenAI
 
         attr_accessor object: :"skill.version.deleted"
 
+        # The deleted skill version.
         attr_accessor version: String
 
+        # @param version
+        #   The deleted skill version.
         def initialize: (
           id: String,
           deleted: bool,