openai 0.87.0 → 0.89.0

data/lib/openai/models/beta/beta_response_file_search_tool_call.rb

@@ -46,24 +46,28 @@ module OpenAI
         )
 
         # @!method initialize(id:, queries:, status:, agent: nil, results: nil, type: :file_search_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseFileSearchToolCall} for more details.
-        #
         #   The results of a file search tool call. See the
-        #   [file search guide](https://platform.openai.com/docs/guides/tools-file-search)
+        #   [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
         #   for more information.
         #
-        #   @param id [String] The unique ID of the file search tool call.
+        #   @param id [String]
+        #     The unique ID of the file search tool call.
         #
-        #   @param queries [Array<String>] The queries used to search for files.
+        #   @param queries [Array<String>]
+        #     The queries used to search for files.
         #
-        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Status] The status of the file search tool call. One of `in_progress`,
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Status]
+        #     The status of the file search tool call. One of `in_progress`, `searching`,
+        #     `incomplete` or `failed`,
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Agent, nil] The agent that produced this item.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Agent, nil]
+        #     The agent that produced this item.
         #
-        #   @param results [Array<OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Result>, nil] The results of the file search tool call.
+        #   @param results [Array<OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Result>, nil]
+        #     The results of the file search tool call.
         #
-        #   @param type [Symbol, :file_search_call] The type of the file search tool call. Always `file_search_call`.
+        #   @param type [Symbol, :file_search_call]
+        #     The type of the file search tool call. Always `file_search_call`.
 
         # The status of the file search tool call. One of `in_progress`, `searching`,
         # `incomplete` or `failed`,
@@ -93,7 +97,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that produced this item.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
 
         class Result < OpenAI::Internal::Type::BaseModel
@@ -138,19 +143,24 @@ module OpenAI
           optional :text, String
 
           # @!method initialize(attributes: nil, file_id: nil, filename: nil, score: nil, text: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Result} for more details.
-          #
-          #   @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+          #   @param attributes [Hash{Symbol=>String, Float, Boolean}, nil]
+          #     Set of 16 key-value pairs that can be attached to an object. This can be useful
+          #     for storing additional information about the object in a structured format, and
+          #     querying for objects via API or the dashboard. Keys are strings with a maximum
+          #     length of 64 characters. Values are strings with a maximum length of 512
+          #     characters, booleans, or numbers.
           #
-          #   @param file_id [String] The unique ID of the file.
+          #   @param file_id [String]
+          #     The unique ID of the file.
           #
-          #   @param filename [String] The name of the file.
+          #   @param filename [String]
+          #     The name of the file.
           #
-          #   @param score [Float] The relevance score of the file - a value between 0 and 1.
+          #   @param score [Float]
+          #     The relevance score of the file - a value between 0 and 1.
           #
-          #   @param text [String] The text that was retrieved from the file.
-
+          #   @param text [String]
+          #     The text that was retrieved from the file.
           module Attribute
             extend OpenAI::Internal::Type::Union
 

data/lib/openai/models/beta/beta_response_format_text_config.rb

@@ -7,7 +7,7 @@ module OpenAI
       #
       # 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://platform.openai.com/docs/guides/structured-outputs).
+      # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
       #
       # The default format is `{ "type": "text" }` with no additional options.
       #
@@ -25,7 +25,7 @@ module OpenAI
         variant :text, -> { OpenAI::Beta::BetaResponseFormatTextConfig::Text }
 
         # JSON Schema response format. Used to generate structured JSON responses.
-        # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+        # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
         variant :json_schema, -> { OpenAI::Beta::BetaResponseFormatTextJSONSchemaConfig }
 
         # JSON object response format. An older method of generating JSON responses.
@@ -44,7 +44,8 @@ module OpenAI
           # @!method initialize(type: :text)
           #   Default response format. Used to generate text responses.
           #
-          #   @param type [Symbol, :text] The type of response format being defined. Always `text`.
+          #   @param type [Symbol, :text]
+          #     The type of response format being defined. Always `text`.
         end
 
         class JSONObject < OpenAI::Internal::Type::BaseModel
@@ -59,7 +60,8 @@ module OpenAI
           #   `json_schema` is recommended for models that support it. Note that the model
           #   will not generate JSON without a system or user message instructing it to do so.
           #
-          #   @param type [Symbol, :json_object] The type of response format being defined. Always `json_object`.
+          #   @param type [Symbol, :json_object]
+          #     The type of response format being defined. Always `json_object`.
         end
 
         # @!method self.variants

data/lib/openai/models/beta/beta_response_format_text_json_schema_config.rb

@@ -36,28 +36,37 @@ module OpenAI
         #   true, the model will always follow the exact schema defined in the `schema`
         #   field. Only a subset of JSON Schema is supported when `strict` is `true`. To
         #   learn more, read the
-        #   [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         #   @return [Boolean, nil]
         optional :strict, OpenAI::Internal::Type::Boolean, nil?: true
 
         # @!method initialize(name:, schema:, description: nil, strict: nil, type: :json_schema)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig} for more details.
-        #
         #   JSON Schema response format. Used to generate structured JSON responses. Learn
         #   more about
-        #   [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+        #   [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
-        #   @param name [String] The name of the response format. Must be a-z, A-Z, 0-9, or contain
+        #   @param name [String]
+        #     The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
+        #     and dashes, with a maximum length of 64.
         #
-        #   @param schema [Hash{Symbol=>Object}] The schema for the response format, described as a JSON Schema object.
+        #   @param schema [Hash{Symbol=>Object}]
+        #     The schema for the response format, described as a JSON Schema object. Learn how
+        #     to build JSON schemas [here](https://json-schema.org/).
         #
-        #   @param description [String] A description of what the response format is for, used by the model to
+        #   @param description [String]
+        #     A description of what the response format is for, used by the model to determine
+        #     how to respond in the format.
         #
-        #   @param strict [Boolean, nil] Whether to enable strict schema adherence when generating the output.
+        #   @param strict [Boolean, nil]
+        #     Whether to enable strict schema adherence when generating the output. If set to
+        #     true, the model will always follow the exact schema defined in the `schema`
+        #     field. Only a subset of JSON Schema is supported when `strict` is `true`. To
+        #     learn more, read the
+        #     [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
-        #   @param type [Symbol, :json_schema] The type of response format being defined. Always `json_schema`.
+        #   @param type [Symbol, :json_schema]
+        #     The type of response format being defined. Always `json_schema`.
       end
     end
 

data/lib/openai/models/beta/beta_response_function_call_arguments_delta_event.rb

@@ -41,23 +41,25 @@ module OpenAI
         optional :agent, -> { OpenAI::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent }, nil?: true
 
         # @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.function_call_arguments.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent} for more
-        #   details.
-        #
         #   Emitted when there is a partial function-call arguments delta.
         #
-        #   @param delta [String] The function-call arguments delta that is added.
+        #   @param delta [String]
+        #     The function-call arguments delta that is added.
         #
-        #   @param item_id [String] The ID of the output item that the function-call arguments delta is added to.
+        #   @param item_id [String]
+        #     The ID of the output item that the function-call arguments delta is added to.
         #
-        #   @param output_index [Integer] The index of the output item that the function-call arguments delta is added to.
+        #   @param output_index [Integer]
+        #     The index of the output item that the function-call arguments delta is added to.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.function_call_arguments.delta"] The type of the event. Always `response.function_call_arguments.delta`.
+        #   @param type [Symbol, :"response.function_call_arguments.delta"]
+        #     The type of the event. Always `response.function_call_arguments.delta`.
 
         # @see OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -70,7 +72,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_function_call_arguments_done_event.rb

@@ -42,15 +42,20 @@ module OpenAI
         # @!method initialize(arguments:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.function_call_arguments.done")
         #   Emitted when function-call arguments are finalized.
         #
-        #   @param arguments [String] The function-call arguments.
+        #   @param arguments [String]
+        #     The function-call arguments.
         #
-        #   @param item_id [String] The ID of the item.
+        #   @param item_id [String]
+        #     The ID of the item.
         #
-        #   @param output_index [Integer] The index of the output item.
+        #   @param output_index [Integer]
+        #     The index of the output item.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
         #   @param type [Symbol, :"response.function_call_arguments.done"]
 
@@ -65,7 +70,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_function_call_output_item.rb

@@ -12,7 +12,7 @@ module OpenAI
         # A text input to the model.
         variant :input_text, -> { OpenAI::Beta::BetaResponseInputTextContent }
 
-        # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision)
+        # An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
         variant :input_image, -> { OpenAI::Beta::BetaResponseInputImageContent }
 
         # A file input to the model.

data/lib/openai/models/beta/beta_response_function_shell_call_output_content.rb

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(outcome:, stderr:, stdout:)
         #   Captured stdout and stderr for a portion of a shell tool call output.
         #
-        #   @param outcome [OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Exit] The exit or timeout outcome associated with this shell call.
+        #   @param outcome [OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::Outcome::Exit]
+        #     The exit or timeout outcome associated with this shell call.
         #
-        #   @param stderr [String] Captured stderr output for the shell call.
+        #   @param stderr [String]
+        #     Captured stderr output for the shell call.
         #
-        #   @param stdout [String] Captured stdout output for the shell call.
+        #   @param stdout [String]
+        #     Captured stdout output for the shell call.
 
         # The exit or timeout outcome associated with this shell call.
         #
@@ -55,7 +58,8 @@ module OpenAI
             # @!method initialize(type: :timeout)
             #   Indicates that the shell call exceeded its configured time limit.
             #
-            #   @param type [Symbol, :timeout] The outcome type. Always `timeout`.
+            #   @param type [Symbol, :timeout]
+            #     The outcome type. Always `timeout`.
           end
 
           class Exit < OpenAI::Internal::Type::BaseModel
@@ -74,9 +78,11 @@ module OpenAI
             # @!method initialize(exit_code:, type: :exit)
             #   Indicates that the shell commands finished and returned an exit code.
             #
-            #   @param exit_code [Integer] The exit code returned by the shell process.
+            #   @param exit_code [Integer]
+            #     The exit code returned by the shell process.
             #
-            #   @param type [Symbol, :exit] The outcome type. Always `exit`.
+            #   @param type [Symbol, :exit]
+            #     The outcome type. Always `exit`.
           end
 
           # @!method self.variants

data/lib/openai/models/beta/beta_response_function_shell_tool_call.rb

@@ -70,28 +70,36 @@ module OpenAI
         optional :created_by, String
 
         # @!method initialize(id:, action:, call_id:, environment:, status:, agent: nil, caller_: nil, created_by: nil, type: :shell_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseFunctionShellToolCall} for more details.
-        #
         #   A tool call that executes one or more shell commands in a managed environment.
         #
-        #   @param id [String] The unique ID of the shell tool call. Populated when this item is returned via A
+        #   @param id [String]
+        #     The unique ID of the shell tool call. Populated when this item is returned via
+        #     API.
         #
-        #   @param action [OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Action] The shell commands and limits that describe how to run the tool call.
+        #   @param action [OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Action]
+        #     The shell commands and limits that describe how to run the tool call.
         #
-        #   @param call_id [String] The unique ID of the shell tool call generated by the model.
+        #   @param call_id [String]
+        #     The unique ID of the shell tool call generated by the model.
         #
-        #   @param environment [OpenAI::Models::Beta::BetaResponseLocalEnvironment, OpenAI::Models::Beta::BetaResponseContainerReference, nil] Represents the use of a local environment to perform shell actions.
+        #   @param environment [OpenAI::Models::Beta::BetaResponseLocalEnvironment, OpenAI::Models::Beta::BetaResponseContainerReference, nil]
+        #     Represents the use of a local environment to perform shell actions.
         #
-        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Status] The status of the shell call. One of `in_progress`, `completed`, or `incomplete`
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Status]
+        #     The status of the shell call. One of `in_progress`, `completed`, or
+        #     `incomplete`.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Agent] The agent that produced this item.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Agent]
+        #     The agent that produced this item.
         #
-        #   @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param created_by [String] The ID of the entity that created this tool call.
+        #   @param created_by [String]
+        #     The ID of the entity that created this tool call.
         #
-        #   @param type [Symbol, :shell_call] The type of the item. Always `shell_call`.
+        #   @param type [Symbol, :shell_call]
+        #     The type of the item. Always `shell_call`.
 
         # @see OpenAI::Models::Beta::BetaResponseFunctionShellToolCall#action
         class Action < OpenAI::Internal::Type::BaseModel
@@ -117,9 +125,11 @@ module OpenAI
           #
           #   @param commands [Array<String>]
           #
-          #   @param max_output_length [Integer, nil] Optional maximum number of characters to return from each command.
+          #   @param max_output_length [Integer, nil]
+          #     Optional maximum number of characters to return from each command.
           #
-          #   @param timeout_ms [Integer, nil] Optional timeout in milliseconds for the commands.
+          #   @param timeout_ms [Integer, nil]
+          #     Optional timeout in milliseconds for the commands.
         end
 
         # Represents the use of a local environment to perform shell actions.
@@ -166,7 +176,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that produced this item.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
 
         # The execution context that produced this tool call.
@@ -204,7 +215,8 @@ module OpenAI
             required :type, const: :program
 
             # @!method initialize(caller_id:, type: :program)
-            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #   @param caller_id [String]
+            #     The call ID of the program item that produced this tool call.
             #
             #   @param type [Symbol, :program]
           end

data/lib/openai/models/beta/beta_response_function_shell_tool_call_output.rb

@@ -70,30 +70,37 @@ module OpenAI
         optional :created_by, String
 
         # @!method initialize(id:, call_id:, max_output_length:, output:, status:, agent: nil, caller_: nil, created_by: nil, type: :shell_call_output)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput} for more
-        #   details.
-        #
         #   The output of a shell tool call that was emitted.
         #
-        #   @param id [String] The unique ID of the shell call output. Populated when this item is returned via
+        #   @param id [String]
+        #     The unique ID of the shell call output. Populated when this item is returned via
+        #     API.
         #
-        #   @param call_id [String] The unique ID of the shell tool call generated by the model.
+        #   @param call_id [String]
+        #     The unique ID of the shell tool call generated by the model.
         #
-        #   @param max_output_length [Integer, nil] The maximum length of the shell command output. This is generated by the model a
+        #   @param max_output_length [Integer, nil]
+        #     The maximum length of the shell command output. This is generated by the model
+        #     and should be passed back with the raw output.
         #
-        #   @param output [Array<OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Output>] An array of shell call output contents
+        #   @param output [Array<OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Output>]
+        #     An array of shell call output contents
         #
-        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Status] The status of the shell call output. One of `in_progress`, `completed`, or `inco
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Status]
+        #     The status of the shell call output. One of `in_progress`, `completed`, or
+        #     `incomplete`.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Agent] The agent that produced this item.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Agent]
+        #     The agent that produced this item.
         #
-        #   @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param created_by [String] The identifier of the actor that created the item.
+        #   @param created_by [String]
+        #     The identifier of the actor that created the item.
         #
-        #   @param type [Symbol, :shell_call_output] The type of the shell call output. Always `shell_call_output`.
-
+        #   @param type [Symbol, :shell_call_output]
+        #     The type of the shell call output. Always `shell_call_output`.
         class Output < OpenAI::Internal::Type::BaseModel
           # @!attribute outcome
           #   Represents either an exit outcome (with an exit code) or a timeout outcome for a
@@ -121,19 +128,20 @@ module OpenAI
           optional :created_by, String
 
           # @!method initialize(outcome:, stderr:, stdout:, created_by: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Output} for more
-          #   details.
-          #
           #   The content of a shell tool call output that was emitted.
           #
-          #   @param outcome [OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Output::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Output::Outcome::Exit] Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          #   @param outcome [OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Output::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput::Output::Outcome::Exit]
+          #     Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          #     shell call output chunk.
           #
-          #   @param stderr [String] The standard error output that was captured.
+          #   @param stderr [String]
+          #     The standard error output that was captured.
           #
-          #   @param stdout [String] The standard output that was captured.
+          #   @param stdout [String]
+          #     The standard output that was captured.
           #
-          #   @param created_by [String] The identifier of the actor that created the item.
+          #   @param created_by [String]
+          #     The identifier of the actor that created the item.
 
           # Represents either an exit outcome (with an exit code) or a timeout outcome for a
           # shell call output chunk.
@@ -160,7 +168,8 @@ module OpenAI
               # @!method initialize(type: :timeout)
               #   Indicates that the shell call exceeded its configured time limit.
               #
-              #   @param type [Symbol, :timeout] The outcome type. Always `timeout`.
+              #   @param type [Symbol, :timeout]
+              #     The outcome type. Always `timeout`.
             end
 
             class Exit < OpenAI::Internal::Type::BaseModel
@@ -179,9 +188,11 @@ module OpenAI
               # @!method initialize(exit_code:, type: :exit)
               #   Indicates that the shell commands finished and returned an exit code.
               #
-              #   @param exit_code [Integer] Exit code from the shell process.
+              #   @param exit_code [Integer]
+              #     Exit code from the shell process.
               #
-              #   @param type [Symbol, :exit] The outcome type. Always `exit`.
+              #   @param type [Symbol, :exit]
+              #     The outcome type. Always `exit`.
             end
 
             # @!method self.variants
@@ -215,7 +226,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that produced this item.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
 
         # The execution context that produced this tool call.
@@ -253,7 +265,8 @@ module OpenAI
             required :type, const: :program
 
             # @!method initialize(caller_id:, type: :program)
-            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #   @param caller_id [String]
+            #     The call ID of the program item that produced this tool call.
             #
             #   @param type [Symbol, :program]
           end

data/lib/openai/models/beta/beta_response_function_tool_call.rb

@@ -71,32 +71,40 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Beta::BetaResponseFunctionToolCall::Status }
 
         # @!method initialize(arguments:, call_id:, name:, id: nil, agent: nil, async: nil, caller_: nil, namespace: nil, status: nil, type: :function_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseFunctionToolCall} for more details.
-        #
         #   A tool call to run a function. See the
-        #   [function calling guide](https://platform.openai.com/docs/guides/function-calling)
+        #   [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
         #   for more information.
         #
-        #   @param arguments [String] A JSON string of the arguments to pass to the function.
+        #   @param arguments [String]
+        #     A JSON string of the arguments to pass to the function.
         #
-        #   @param call_id [String] The unique ID of the function tool call generated by the model.
+        #   @param call_id [String]
+        #     The unique ID of the function tool call generated by the model.
         #
-        #   @param name [String] The name of the function to run.
+        #   @param name [String]
+        #     The name of the function to run.
         #
-        #   @param id [String] The unique ID of the function tool call.
+        #   @param id [String]
+        #     The unique ID of the function tool call.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Agent, nil] The agent that produced this item.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Agent, nil]
+        #     The agent that produced this item.
         #
-        #   @param async [Boolean] Whether the function tool call runs asynchronously.
+        #   @param async [Boolean]
+        #     Whether the function tool call runs asynchronously.
         #
-        #   @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionToolCall::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param namespace [String] The namespace of the function to run.
+        #   @param namespace [String]
+        #     The namespace of the function to run.
         #
-        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFunctionToolCall::Status] The status of the item. One of `in_progress`, `completed`, or
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFunctionToolCall::Status]
+        #     The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #     Populated when items are returned via API.
         #
-        #   @param type [Symbol, :function_call] The type of the function tool call. Always `function_call`.
+        #   @param type [Symbol, :function_call]
+        #     The type of the function tool call. Always `function_call`.
 
         # @see OpenAI::Models::Beta::BetaResponseFunctionToolCall#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -109,7 +117,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that produced this item.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
 
         # The execution context that produced this tool call.
@@ -147,7 +156,8 @@ module OpenAI
             required :type, const: :program
 
             # @!method initialize(caller_id:, type: :program)
-            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #   @param caller_id [String]
+            #     The call ID of the program item that produced this tool call.
             #
             #   @param type [Symbol, :program]
           end