openai 0.91.0 → 0.93.0

data/sig/openai/models/beta/response_retrieve_params.rbs

@@ -17,18 +17,36 @@ module OpenAI
 
         attr_accessor response_id: 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::Beta::beta_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::Beta::beta_response_includable]
         ) -> ::Array[OpenAI::Models::Beta::beta_response_includable]
 
+        # When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        # characters to an `obfuscation` field on streaming delta events to normalize
+        # payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        # fields are included by default, but add a small amount of overhead to the data
+        # stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        # you trust the network links between your application and the OpenAI API.
         attr_reader include_obfuscation: bool?
 
+        # When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        # characters to an `obfuscation` field on streaming delta events to normalize
+        # payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        # fields are included by default, but add a small amount of overhead to the data
+        # stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        # you trust the network links between your application and the OpenAI API.
         def include_obfuscation=: (bool) -> bool
 
+        # The sequence number of the event after which to start streaming.
         attr_reader starting_after: Integer?
 
+        # The sequence number of the event after which to start streaming.
         def starting_after=: (Integer) -> Integer
 
         attr_reader betas: ::Array[OpenAI::Models::Beta::ResponseRetrieveParams::beta]?
@@ -37,6 +55,18 @@ module OpenAI
           ::Array[OpenAI::Models::Beta::ResponseRetrieveParams::beta]
         ) -> ::Array[OpenAI::Models::Beta::ResponseRetrieveParams::beta]
 
+        # @param include
+        #   Additional fields to include in the response. See the `include` parameter for
+        #   Response creation above for more information.
+        # @param include_obfuscation
+        #   When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        #   characters to an `obfuscation` field on streaming delta events to normalize
+        #   payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        #   fields are included by default, but add a small amount of overhead to the data
+        #   stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        #   you trust the network links between your application and the OpenAI API.
+        # @param starting_after
+        #   The sequence number of the event after which to start streaming.
         def initialize: (
           response_id: String,
           ?include: ::Array[OpenAI::Models::Beta::beta_response_includable],

data/sig/openai/models/beta/responses/beta_response_item_list.rbs

@@ -12,16 +12,31 @@ module OpenAI
           }
 
         class BetaResponseItemList < OpenAI::Internal::Type::BaseModel
+          # A list of items used to generate this response.
           attr_accessor data: ::Array[OpenAI::Models::Beta::beta_response_item]
 
+          # 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 used to generate this response.
+          # @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::Models::Beta::beta_response_item],
             first_id: String,

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

@@ -19,22 +19,40 @@ 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::Beta::beta_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::Beta::beta_response_includable]
           ) -> ::Array[OpenAI::Models::Beta::beta_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::Beta::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::Beta::Responses::InputItemListParams::order
           ) -> OpenAI::Models::Beta::Responses::InputItemListParams::order
@@ -45,6 +63,19 @@ module OpenAI
             ::Array[OpenAI::Models::Beta::Responses::InputItemListParams::beta]
           ) -> ::Array[OpenAI::Models::Beta::Responses::InputItemListParams::beta]
 
+          # @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/beta/responses/input_token_count_params.rbs

@@ -24,34 +24,79 @@ 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::Beta::Responses::InputTokenCountParams::conversation?
 
+          # Text, image, or file inputs to the model, used to generate a response
           attr_accessor input: OpenAI::Models::Beta::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::Beta::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::Beta::Responses::InputTokenCountParams::personality
           ) -> OpenAI::Models::Beta::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::Beta::Responses::InputTokenCountParams::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::Beta::Responses::InputTokenCountParams::Text?
 
+          # Controls which tool the model should use, if any.
           attr_accessor tool_choice: OpenAI::Models::Beta::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::Beta::beta_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::Beta::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::Beta::Responses::InputTokenCountParams::truncation
           ) -> OpenAI::Models::Beta::Responses::InputTokenCountParams::truncation
@@ -62,6 +107,55 @@ module OpenAI
             ::Array[OpenAI::Models::Beta::Responses::InputTokenCountParams::beta]
           ) -> ::Array[OpenAI::Models::Beta::Responses::InputTokenCountParams::beta]
 
+          # @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::Beta::Responses::InputTokenCountParams::conversation?,
             ?input: OpenAI::Models::Beta::Responses::InputTokenCountParams::input?,
@@ -137,20 +231,80 @@ module OpenAI
             }
 
           class Reasoning < OpenAI::Internal::Type::BaseModel
+            # Controls which reasoning items are rendered back to the model on later turns. If
+            # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+            # model family defaults to `all_turns`; earlier models default to `current_turn`.
+            #
+            # When returned on a response, this is the effective reasoning context mode used
+            # for the response.
             attr_accessor context: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::context?
 
+            # Constrains effort on reasoning for reasoning models. Currently supported values
+            # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+            # reasoning effort can result in faster responses and fewer tokens used on
+            # reasoning in a response. Not all reasoning models support every value. See the
+            # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
+            # model-specific support.
             attr_accessor effort: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::effort?
 
+            # **Deprecated:** use `summary` instead.
+            #
+            # A summary of the reasoning performed by the model. This can be useful for
+            # debugging and understanding the model's reasoning process. One of `auto`,
+            # `concise`, or `detailed`.
             attr_accessor generate_summary: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::generate_summary?
 
+            # Controls the reasoning execution mode for the request.
+            #
+            # When returned on a response, this is the effective execution mode.
             attr_reader mode: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::mode?
 
+            # Controls the reasoning execution mode for the request.
+            #
+            # When returned on a response, this is the effective execution mode.
             def mode=: (
               OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::mode
             ) -> OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::mode
 
+            # A summary of the reasoning performed by the model. This can be useful for
+            # debugging and understanding the model's reasoning process. One of `auto`,
+            # `concise`, or `detailed`.
+            #
+            # `concise` is supported for `computer-use-preview` models and all reasoning
+            # models after `gpt-5`.
             attr_accessor summary: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::summary?
 
+            # @param context
+            #   Controls which reasoning items are rendered back to the model on later turns. If
+            #   omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+            #   model family defaults to `all_turns`; earlier models default to `current_turn`.
+            #
+            #   When returned on a response, this is the effective reasoning context mode used
+            #   for the response.
+            # @param effort
+            #   Constrains effort on reasoning for reasoning models. Currently supported values
+            #   are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+            #   reasoning effort can result in faster responses and fewer tokens used on
+            #   reasoning in a response. Not all reasoning models support every value. See the
+            #   [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
+            #   model-specific support.
+            # @param generate_summary
+            #   **Deprecated:** use `summary` instead.
+            #
+            #   A summary of the reasoning performed by the model. This can be useful for
+            #   debugging and understanding the model's reasoning process. One of `auto`,
+            #   `concise`, or `detailed`.
+            # @param mode
+            #   Controls the reasoning execution mode for the request.
+            #
+            #   When returned on a response, this is the effective execution mode.
+            # @param summary
+            #   A summary of the reasoning performed by the model. This can be useful for
+            #   debugging and understanding the model's reasoning process. One of `auto`,
+            #   `concise`, or `detailed`.
+            #
+            #   `concise` is supported for `computer-use-preview` models and all reasoning
+            #   models after `gpt-5`.
             def initialize: (
               ?context: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::context?,
               ?effort: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::effort?,
@@ -239,14 +393,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::Beta::beta_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::Beta::beta_response_format_text_config
             ) -> OpenAI::Models::Beta::beta_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::Beta::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::Beta::beta_response_format_text_config,
               ?verbosity: OpenAI::Models::Beta::Responses::InputTokenCountParams::Text::verbosity?
@@ -288,8 +491,11 @@ module OpenAI
               { ?type: :programmatic_tool_calling }
 
             class BetaSpecificProgrammaticToolCallingParam < 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/beta/run_step_stream_event.rbs

@@ -20,10 +20,13 @@ module OpenAI
           }
 
         class ThreadRunStepCreated < OpenAI::Internal::Type::BaseModel
+          # Represents a step in execution of a run.
           attr_accessor data: OpenAI::Beta::Threads::Runs::RunStep
 
           attr_accessor event: :"thread.run.step.created"
 
+          # @param data
+          #   Represents a step in execution of a run.
           def initialize: (
             data: OpenAI::Beta::Threads::Runs::RunStep,
             ?event: :"thread.run.step.created"
@@ -42,10 +45,13 @@ module OpenAI
           }
 
         class ThreadRunStepInProgress < OpenAI::Internal::Type::BaseModel
+          # Represents a step in execution of a run.
           attr_accessor data: OpenAI::Beta::Threads::Runs::RunStep
 
           attr_accessor event: :"thread.run.step.in_progress"
 
+          # @param data
+          #   Represents a step in execution of a run.
           def initialize: (
             data: OpenAI::Beta::Threads::Runs::RunStep,
             ?event: :"thread.run.step.in_progress"
@@ -64,10 +70,15 @@ module OpenAI
           }
 
         class ThreadRunStepDelta < OpenAI::Internal::Type::BaseModel
+          # Represents a run step delta i.e. any changed fields on a run step during
+          # streaming.
           attr_accessor data: OpenAI::Beta::Threads::Runs::RunStepDeltaEvent
 
           attr_accessor event: :"thread.run.step.delta"
 
+          # @param data
+          #   Represents a run step delta i.e. any changed fields on a run step during
+          #   streaming.
           def initialize: (
             data: OpenAI::Beta::Threads::Runs::RunStepDeltaEvent,
             ?event: :"thread.run.step.delta"
@@ -86,10 +97,13 @@ module OpenAI
           }
 
         class ThreadRunStepCompleted < OpenAI::Internal::Type::BaseModel
+          # Represents a step in execution of a run.
           attr_accessor data: OpenAI::Beta::Threads::Runs::RunStep
 
           attr_accessor event: :"thread.run.step.completed"
 
+          # @param data
+          #   Represents a step in execution of a run.
           def initialize: (
             data: OpenAI::Beta::Threads::Runs::RunStep,
             ?event: :"thread.run.step.completed"
@@ -108,10 +122,13 @@ module OpenAI
           }
 
         class ThreadRunStepFailed < OpenAI::Internal::Type::BaseModel
+          # Represents a step in execution of a run.
           attr_accessor data: OpenAI::Beta::Threads::Runs::RunStep
 
           attr_accessor event: :"thread.run.step.failed"
 
+          # @param data
+          #   Represents a step in execution of a run.
           def initialize: (
             data: OpenAI::Beta::Threads::Runs::RunStep,
             ?event: :"thread.run.step.failed"
@@ -130,10 +147,13 @@ module OpenAI
           }
 
         class ThreadRunStepCancelled < OpenAI::Internal::Type::BaseModel
+          # Represents a step in execution of a run.
           attr_accessor data: OpenAI::Beta::Threads::Runs::RunStep
 
           attr_accessor event: :"thread.run.step.cancelled"
 
+          # @param data
+          #   Represents a step in execution of a run.
           def initialize: (
             data: OpenAI::Beta::Threads::Runs::RunStep,
             ?event: :"thread.run.step.cancelled"
@@ -152,10 +172,13 @@ module OpenAI
           }
 
         class ThreadRunStepExpired < OpenAI::Internal::Type::BaseModel
+          # Represents a step in execution of a run.
           attr_accessor data: OpenAI::Beta::Threads::Runs::RunStep
 
           attr_accessor event: :"thread.run.step.expired"
 
+          # @param data
+          #   Represents a step in execution of a run.
           def initialize: (
             data: OpenAI::Beta::Threads::Runs::RunStep,
             ?event: :"thread.run.step.expired"