openai 0.92.0 → 0.94.0

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

@@ -15,28 +15,57 @@ module OpenAI
         }
 
       class FunctionTool < OpenAI::Internal::Type::BaseModel
+        # The name of the function to call.
         attr_accessor name: String
 
+        # A JSON schema object describing the parameters of the function.
         attr_accessor parameters: ::Hash[Symbol, top]?
 
+        # Whether strict parameter validation is enforced for this function tool.
         attr_accessor strict: bool?
 
+        # The type of the function tool. Always `function`.
         attr_accessor type: :function
 
+        # The tool invocation context(s).
         attr_accessor allowed_callers: ::Array[OpenAI::Models::Responses::FunctionTool::allowed_caller]?
 
         attr_reader async: bool?
 
         def async=: (bool) -> bool
 
+        # Whether this function is deferred and loaded via tool search.
         attr_reader defer_loading: bool?
 
+        # Whether this function is deferred and loaded via tool search.
         def defer_loading=: (bool) -> bool
 
+        # A description of the function. Used by the model to determine whether or not to
+        # call the function.
         attr_accessor description: String?
 
+        # A JSON schema object describing the JSON value encoded in string outputs for
+        # this function.
         attr_accessor output_schema: ::Hash[Symbol, top]?
 
+        # @param name
+        #   The name of the function to call.
+        # @param parameters
+        #   A JSON schema object describing the parameters of the function.
+        # @param strict
+        #   Whether strict parameter validation is enforced for this function tool.
+        # @param allowed_callers
+        #   The tool invocation context(s).
+        # @param defer_loading
+        #   Whether this function is deferred and loaded via tool search.
+        # @param description
+        #   A description of the function. Used by the model to determine whether or not to
+        #   call the function.
+        # @param output_schema
+        #   A JSON schema object describing the JSON value encoded in string outputs for
+        #   this function.
+        # @param type
+        #   The type of the function tool. Always `function`.
         def initialize: (
           name: String,
           parameters: ::Hash[Symbol, top]?,

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

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class InlineSkill < OpenAI::Internal::Type::BaseModel
+        # The description of the skill.
         attr_accessor description: String
 
+        # The name of the skill.
         attr_accessor name: String
 
+        # Inline skill payload
         attr_accessor source: OpenAI::Responses::InlineSkillSource
 
+        # Defines an inline skill for this request.
         attr_accessor type: :inline
 
+        # @param description
+        #   The description of the skill.
+        # @param name
+        #   The name of the skill.
+        # @param source
+        #   Inline skill payload
+        # @param type
+        #   Defines an inline skill for this request.
         def initialize: (
           description: String,
           name: String,

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

@@ -5,12 +5,21 @@ module OpenAI
         { data: String, ?media_type: :"application/zip", ?type: :base64 }
 
       class InlineSkillSource < OpenAI::Internal::Type::BaseModel
+        # Base64-encoded skill zip bundle.
         attr_accessor data: String
 
+        # The media type of the inline skill payload. Must be `application/zip`.
         attr_accessor media_type: :"application/zip"
 
+        # The type of the inline skill source. Must be `base64`.
         attr_accessor type: :base64
 
+        # @param data
+        #   Base64-encoded skill zip bundle.
+        # @param media_type
+        #   The media type of the inline skill payload. Must be `application/zip`.
+        # @param type
+        #   The type of the inline skill source. Must be `base64`.
         def initialize: (
           data: String,
           ?media_type: :"application/zip",

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

@@ -17,26 +17,57 @@ module OpenAI
 
         attr_accessor response_id: String
 
+        # An item ID to list items after, used in pagination.
         attr_reader after: String?
 
+        # An item ID to list items after, used in pagination.
         def after=: (String) -> String
 
+        # Additional fields to include in the response. See the `include` parameter for
+        # Response creation above for more information.
         attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
 
+        # Additional fields to include in the response. See the `include` parameter for
+        # Response creation above for more information.
         def include=: (
           ::Array[OpenAI::Models::Responses::response_includable]
         ) -> ::Array[OpenAI::Models::Responses::response_includable]
 
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
         attr_reader limit: Integer?
 
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
         def limit=: (Integer) -> Integer
 
+        # The order to return the input items in. Default is `desc`.
+        #
+        # - `asc`: Return the input items in ascending order.
+        # - `desc`: Return the input items in descending order.
         attr_reader order: OpenAI::Models::Responses::InputItemListParams::order?
 
+        # The order to return the input items in. Default is `desc`.
+        #
+        # - `asc`: Return the input items in ascending order.
+        # - `desc`: Return the input items in descending order.
         def order=: (
           OpenAI::Models::Responses::InputItemListParams::order
         ) -> OpenAI::Models::Responses::InputItemListParams::order
 
+        # @param after
+        #   An item ID to list items after, used in pagination.
+        # @param include
+        #   Additional fields to include in the response. See the `include` parameter for
+        #   Response creation above for more information.
+        # @param limit
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
+        # @param order
+        #   The order to return the input items in. Default is `desc`.
+        #
+        #   - `asc`: Return the input items in ascending order.
+        #   - `desc`: Return the input items in descending order.
         def initialize: (
           response_id: String,
           ?after: String,

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

@@ -22,38 +22,132 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        # The conversation that this response belongs to. Items from this conversation are
+        # prepended to `input_items` for this response request. Input items and output
+        # items from this response are automatically added to this conversation after this
+        # response completes.
         attr_accessor conversation: OpenAI::Models::Responses::InputTokenCountParams::conversation?
 
+        # Text, image, or file inputs to the model, used to generate a response
         attr_accessor input: OpenAI::Models::Responses::InputTokenCountParams::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?
 
+        # Model ID used to generate the response, like `gpt-4o` or `o3`. 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: String?
 
+        # Whether to allow the model to run tool calls in parallel.
         attr_accessor parallel_tool_calls: bool?
 
+        # A model-owned style preset to apply to this request. Omit this parameter to use
+        # the model's default style. Supported values may expand over time. Values must be
+        # at most 64 characters.
         attr_reader personality: OpenAI::Models::Responses::InputTokenCountParams::personality?
 
+        # A model-owned style preset to apply to this request. Omit this parameter to use
+        # the model's default style. Supported values may expand over time. Values must be
+        # at most 64 characters.
         def personality=: (
           OpenAI::Models::Responses::InputTokenCountParams::personality
         ) -> OpenAI::Models::Responses::InputTokenCountParams::personality
 
+        # 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?
 
+        # **gpt-5 and o-series models only** Configuration options for
+        # [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
         attr_accessor reasoning: OpenAI::Reasoning?
 
+        # Configuration options for a text response from the model. Can be plain text or
+        # structured JSON data. Learn more:
+        #
+        # - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        # - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
         attr_accessor text: OpenAI::Responses::InputTokenCountParams::Text?
 
+        # Controls which tool the model should use, if any.
         attr_accessor tool_choice: OpenAI::Models::Responses::InputTokenCountParams::tool_choice?
 
+        # An array of tools the model may call while generating a response. You can
+        # specify which tool to use by setting the `tool_choice` parameter.
         attr_accessor tools: ::Array[OpenAI::Models::Responses::tool]?
 
+        # The truncation strategy to use for the model response. - `auto`: If the input to
+        # this Response exceeds the model's context window size, the model will truncate
+        # the response to fit the context window by dropping items from the beginning of
+        # the conversation. - `disabled` (default): If the input size will exceed the
+        # context window size for a model, the request will fail with a 400 error.
         attr_reader truncation: OpenAI::Models::Responses::InputTokenCountParams::truncation?
 
+        # The truncation strategy to use for the model response. - `auto`: If the input to
+        # this Response exceeds the model's context window size, the model will truncate
+        # the response to fit the context window by dropping items from the beginning of
+        # the conversation. - `disabled` (default): If the input size will exceed the
+        # context window size for a model, the request will fail with a 400 error.
         def truncation=: (
           OpenAI::Models::Responses::InputTokenCountParams::truncation
         ) -> OpenAI::Models::Responses::InputTokenCountParams::truncation
 
+        # @param conversation
+        #   The conversation that this response belongs to. Items from this conversation are
+        #   prepended to `input_items` for this response request. Input items and output
+        #   items from this response are automatically added to this conversation after this
+        #   response completes.
+        # @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 model
+        #   Model ID used to generate the response, like `gpt-4o` or `o3`. 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 parallel_tool_calls
+        #   Whether to allow the model to run tool calls in parallel.
+        # @param personality
+        #   A model-owned style preset to apply to this request. Omit this parameter to use
+        #   the model's default style. Supported values may expand over time. Values must be
+        #   at most 64 characters.
+        # @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 reasoning
+        #   **gpt-5 and o-series models only** Configuration options for
+        #   [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
+        # @param text
+        #   Configuration options for a text response from the model. Can be plain text or
+        #   structured JSON data. Learn more:
+        #
+        #   - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        #   - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
+        # @param tool_choice
+        #   Controls which tool the model should use, if any.
+        # @param tools
+        #   An array of tools the model may call while generating a response. You can
+        #   specify which tool to use by setting the `tool_choice` parameter.
+        # @param truncation
+        #   The truncation strategy to use for the model response. - `auto`: If the input to
+        #   this Response exceeds the model's context window size, the model will truncate
+        #   the response to fit the context window by dropping items from the beginning of
+        #   the conversation. - `disabled` (default): If the input size will exceed the
+        #   context window size for a model, the request will fail with a 400 error.
         def initialize: (
           ?conversation: OpenAI::Models::Responses::InputTokenCountParams::conversation?,
           ?input: OpenAI::Models::Responses::InputTokenCountParams::input?,
@@ -124,14 +218,63 @@ module OpenAI
           }
 
         class Text < OpenAI::Internal::Type::BaseModel
+          # An object specifying the format that the model must output.
+          #
+          # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+          # ensures the model will match your supplied JSON schema. Learn more in the
+          # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+          #
+          # The default format is `{ "type": "text" }` with no additional options.
+          #
+          # **Not recommended for gpt-4o and newer models:**
+          #
+          # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+          # ensures the message the model generates is valid JSON. Using `json_schema` is
+          # preferred for models that support it.
           attr_reader format_: OpenAI::Models::Responses::response_format_text_config?
 
+          # An object specifying the format that the model must output.
+          #
+          # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+          # ensures the model will match your supplied JSON schema. Learn more in the
+          # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+          #
+          # The default format is `{ "type": "text" }` with no additional options.
+          #
+          # **Not recommended for gpt-4o and newer models:**
+          #
+          # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+          # ensures the message the model generates is valid JSON. Using `json_schema` is
+          # preferred for models that support it.
           def format_=: (
             OpenAI::Models::Responses::response_format_text_config
           ) -> OpenAI::Models::Responses::response_format_text_config
 
+          # Constrains the verbosity of the model's response. Lower values will result in
+          # more concise responses, while higher values will result in more verbose
+          # responses. Currently supported values are `low`, `medium`, and `high`. The
+          # default is `medium`.
           attr_accessor verbosity: OpenAI::Models::Responses::InputTokenCountParams::Text::verbosity?
 
+          # @param format_
+          #   An object specifying the format that the model must output.
+          #
+          #   Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+          #   ensures the model will match your supplied JSON schema. Learn more in the
+          #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+          #
+          #   The default format is `{ "type": "text" }` with no additional options.
+          #
+          #   **Not recommended for gpt-4o and newer models:**
+          #
+          #   Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+          #   ensures the message the model generates is valid JSON. Using `json_schema` is
+          #   preferred for models that support it.
+          # @param verbosity
+          #   Constrains the verbosity of the model's response. Lower values will result in
+          #   more concise responses, while higher values will result in more verbose
+          #   responses. Currently supported values are `low`, `medium`, and `high`. The
+          #   default is `medium`.
           def initialize: (
             ?format_: OpenAI::Models::Responses::response_format_text_config,
             ?verbosity: OpenAI::Models::Responses::InputTokenCountParams::Text::verbosity?
@@ -173,8 +316,11 @@ module OpenAI
             { ?type: :programmatic_tool_calling }
 
           class SpecificProgrammaticToolCallingParam < OpenAI::Internal::Type::BaseModel
+            # The tool to call. Always `programmatic_tool_calling`.
             attr_accessor type: :programmatic_tool_calling
 
+            # @param type
+            #   The tool to call. Always `programmatic_tool_calling`.
             def initialize: (?type: :programmatic_tool_calling) -> void
 
             def to_hash: -> { ?type: :programmatic_tool_calling }

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

@@ -5,14 +5,21 @@ module OpenAI
         { ?type: :local, ?skills: ::Array[OpenAI::Responses::LocalSkill] }
 
       class LocalEnvironment < OpenAI::Internal::Type::BaseModel
+        # Use a local computer environment.
         attr_accessor type: :local
 
+        # An optional list of skills.
         attr_reader skills: ::Array[OpenAI::Responses::LocalSkill]?
 
+        # An optional list of skills.
         def skills=: (
           ::Array[OpenAI::Responses::LocalSkill]
         ) -> ::Array[OpenAI::Responses::LocalSkill]
 
+        # @param skills
+        #   An optional list of skills.
+        # @param type
+        #   Use a local computer environment.
         def initialize: (
           ?skills: ::Array[OpenAI::Responses::LocalSkill],
           ?type: :local

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

@@ -4,12 +4,21 @@ module OpenAI
       type local_skill = { description: String, name: String, path: String }
 
       class LocalSkill < OpenAI::Internal::Type::BaseModel
+        # The description of the skill.
         attr_accessor description: String
 
+        # The name of the skill.
         attr_accessor name: String
 
+        # The path to the directory containing the skill.
         attr_accessor path: String
 
+        # @param description
+        #   The description of the skill.
+        # @param name
+        #   The name of the skill.
+        # @param path
+        #   The path to the directory containing the skill.
         def initialize: (
           description: String,
           name: String,

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

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class NamespaceTool < OpenAI::Internal::Type::BaseModel
+        # A description of the namespace shown to the model.
         attr_accessor description: String
 
+        # The namespace name used in tool calls (for example, `crm`).
         attr_accessor name: String
 
+        # The function/custom tools available inside this namespace.
         attr_accessor tools: ::Array[OpenAI::Models::Responses::NamespaceTool::tool]
 
+        # The type of the tool. Always `namespace`.
         attr_accessor type: :namespace
 
+        # @param description
+        #   A description of the namespace shown to the model.
+        # @param name
+        #   The namespace name used in tool calls (for example, `crm`).
+        # @param tools
+        #   The function/custom tools available inside this namespace.
+        # @param type
+        #   The type of the tool. Always `namespace`.
         def initialize: (
           description: String,
           name: String,
@@ -57,24 +69,50 @@ module OpenAI
 
             attr_accessor type: :function
 
+            # The tool invocation context(s).
             attr_accessor allowed_callers: ::Array[OpenAI::Models::Responses::NamespaceTool::Tool::Function::allowed_caller]?
 
+            # Whether the tool response can be returned asynchronously versus immediately
+            # returned on next response creation.
             attr_reader async: bool?
 
+            # Whether the tool response can be returned asynchronously versus immediately
+            # returned on next response creation.
             def async=: (bool) -> bool
 
+            # Whether this function should be deferred and discovered via tool search.
             attr_reader defer_loading: bool?
 
+            # Whether this function should be deferred and discovered via tool search.
             def defer_loading=: (bool) -> bool
 
             attr_accessor description: String?
 
+            # A JSON Schema describing the JSON value encoded in string outputs for this
+            # function tool. This does not describe content-array outputs.
             attr_accessor output_schema: ::Hash[Symbol, top]?
 
             attr_accessor parameters: top?
 
+            # Whether to enforce strict parameter validation. If omitted, Responses attempts
+            # to use strict validation when the schema is compatible, and falls back to
+            # non-strict validation otherwise.
             attr_accessor strict: bool?
 
+            # @param allowed_callers
+            #   The tool invocation context(s).
+            # @param async
+            #   Whether the tool response can be returned asynchronously versus immediately
+            #   returned on next response creation.
+            # @param defer_loading
+            #   Whether this function should be deferred and discovered via tool search.
+            # @param output_schema
+            #   A JSON Schema describing the JSON value encoded in string outputs for this
+            #   function tool. This does not describe content-array outputs.
+            # @param strict
+            #   Whether to enforce strict parameter validation. If omitted, Responses attempts
+            #   to use strict validation when the schema is compatible, and falls back to
+            #   non-strict validation otherwise.
             def initialize: (
               name: String,
               ?allowed_callers: ::Array[OpenAI::Models::Responses::NamespaceTool::Tool::Function::allowed_caller]?,