openai 0.91.0 → 0.93.0

data/sig/openai/models/beta/threads/run_create_params.rbs

@@ -31,46 +31,245 @@ module OpenAI
 
           attr_accessor thread_id: String
 
+          # The ID of the
+          # [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
+          # to execute this run.
           attr_accessor assistant_id: String
 
+          # A list of additional fields to include in the response. Currently the only
+          # supported value is `step_details.tool_calls[*].file_search.results[*].content`
+          # to fetch the file search result content.
+          #
+          # See the
+          # [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          # for more information.
           attr_reader include: ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include]?
 
+          # A list of additional fields to include in the response. Currently the only
+          # supported value is `step_details.tool_calls[*].file_search.results[*].content`
+          # to fetch the file search result content.
+          #
+          # See the
+          # [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          # for more information.
           def include=: (
             ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include]
           ) -> ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include]
 
+          # Appends additional instructions at the end of the instructions for the run. This
+          # is useful for modifying the behavior on a per-run basis without overriding other
+          # instructions.
           attr_accessor additional_instructions: String?
 
+          # Adds additional messages to the thread before creating the run.
           attr_accessor additional_messages: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage]?
 
+          # Overrides the
+          # [instructions](https://developers.openai.com/api/docs/assistants/migration) of
+          # the assistant. This is useful for modifying the behavior on a per-run basis.
           attr_accessor instructions: String?
 
+          # The maximum number of completion tokens that may be used over the course of the
+          # run. The run will make a best effort to use only the number of completion tokens
+          # specified, across multiple turns of the run. If the run exceeds the number of
+          # completion tokens specified, the run will end with status `incomplete`. See
+          # `incomplete_details` for more info.
           attr_accessor max_completion_tokens: Integer?
 
+          # The maximum number of prompt tokens that may be used over the course of the run.
+          # The run will make a best effort to use only the number of prompt tokens
+          # specified, across multiple turns of the run. If the run exceeds the number of
+          # prompt tokens specified, the run will end with status `incomplete`. See
+          # `incomplete_details` for more info.
           attr_accessor max_prompt_tokens: Integer?
 
+          # 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.
           attr_accessor metadata: OpenAI::Models::metadata?
 
+          # The ID of the
+          # [Model](https://developers.openai.com/api/reference/resources/models) to be used
+          # to execute this run. If a value is provided here, it will override the model
+          # associated with the assistant. If not, the model associated with the assistant
+          # will be used.
           attr_accessor model: OpenAI::Models::Beta::Threads::RunCreateParams::model?
 
+          # Whether to enable
+          # [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
+          # during tool use.
           attr_reader parallel_tool_calls: bool?
 
+          # Whether to enable
+          # [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
+          # during tool use.
           def parallel_tool_calls=: (bool) -> bool
 
+          # 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 reasoning_effort: OpenAI::Models::reasoning_effort?
 
+          # Specifies the format that the model must output. Compatible with
+          # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+          # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+          # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+          #
+          # Setting to `{ "type": "json_schema", "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).
+          #
+          # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
+          # message the model generates is valid JSON.
+          #
+          # **Important:** when using JSON mode, you **must** also instruct the model to
+          # produce JSON yourself via a system or user message. Without this, the model may
+          # generate an unending stream of whitespace until the generation reaches the token
+          # limit, resulting in a long-running and seemingly "stuck" request. Also note that
+          # the message content may be partially cut off if `finish_reason="length"`, which
+          # indicates the generation exceeded `max_tokens` or the conversation exceeded the
+          # max context length.
           attr_accessor response_format: OpenAI::Models::Beta::assistant_response_format_option?
 
+          # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+          # make the output more random, while lower values like 0.2 will make it more
+          # focused and deterministic.
           attr_accessor temperature: Float?
 
+          # Controls which (if any) tool is called by the model. `none` means the model will
+          # not call any tools and instead generates a message. `auto` is the default value
+          # and means the model can pick between generating a message or calling one or more
+          # tools. `required` means the model must call one or more tools before responding
+          # to the user. Specifying a particular tool like `{"type": "file_search"}` or
+          # `{"type": "function", "function": {"name": "my_function"}}` forces the model to
+          # call that tool.
           attr_accessor tool_choice: OpenAI::Models::Beta::assistant_tool_choice_option?
 
+          # Override the tools the assistant can use for this run. This is useful for
+          # modifying the behavior on a per-run basis.
           attr_accessor tools: ::Array[OpenAI::Models::Beta::assistant_tool]?
 
+          # An alternative to sampling with temperature, called nucleus sampling, where the
+          # model considers the results of the tokens with top_p probability mass. So 0.1
+          # means only the tokens comprising the top 10% probability mass are considered.
+          #
+          # We generally recommend altering this or temperature but not both.
           attr_accessor top_p: Float?
 
+          # Controls for how a thread will be truncated prior to the run. Use this to
+          # control the initial context window of the run.
           attr_accessor truncation_strategy: OpenAI::Beta::Threads::RunCreateParams::TruncationStrategy?
 
+          # @param assistant_id
+          #   The ID of the
+          #   [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
+          #   to execute this run.
+          # @param include
+          #   A list of additional fields to include in the response. Currently the only
+          #   supported value is `step_details.tool_calls[*].file_search.results[*].content`
+          #   to fetch the file search result content.
+          #
+          #   See the
+          #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          #   for more information.
+          # @param additional_instructions
+          #   Appends additional instructions at the end of the instructions for the run. This
+          #   is useful for modifying the behavior on a per-run basis without overriding other
+          #   instructions.
+          # @param additional_messages
+          #   Adds additional messages to the thread before creating the run.
+          # @param instructions
+          #   Overrides the
+          #   [instructions](https://developers.openai.com/api/docs/assistants/migration) of
+          #   the assistant. This is useful for modifying the behavior on a per-run basis.
+          # @param max_completion_tokens
+          #   The maximum number of completion tokens that may be used over the course of the
+          #   run. The run will make a best effort to use only the number of completion tokens
+          #   specified, across multiple turns of the run. If the run exceeds the number of
+          #   completion tokens specified, the run will end with status `incomplete`. See
+          #   `incomplete_details` for more info.
+          # @param max_prompt_tokens
+          #   The maximum number of prompt tokens that may be used over the course of the run.
+          #   The run will make a best effort to use only the number of prompt tokens
+          #   specified, across multiple turns of the run. If the run exceeds the number of
+          #   prompt tokens specified, the run will end with status `incomplete`. See
+          #   `incomplete_details` for more info.
+          # @param metadata
+          #   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.
+          # @param model
+          #   The ID of the
+          #   [Model](https://developers.openai.com/api/reference/resources/models) to be used
+          #   to execute this run. If a value is provided here, it will override the model
+          #   associated with the assistant. If not, the model associated with the assistant
+          #   will be used.
+          # @param parallel_tool_calls
+          #   Whether to enable
+          #   [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
+          #   during tool use.
+          # @param reasoning_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 response_format
+          #   Specifies the format that the model must output. Compatible with
+          #   [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+          #   [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+          #   all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+          #
+          #   Setting to `{ "type": "json_schema", "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).
+          #
+          #   Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
+          #   message the model generates is valid JSON.
+          #
+          #   **Important:** when using JSON mode, you **must** also instruct the model to
+          #   produce JSON yourself via a system or user message. Without this, the model may
+          #   generate an unending stream of whitespace until the generation reaches the token
+          #   limit, resulting in a long-running and seemingly "stuck" request. Also note that
+          #   the message content may be partially cut off if `finish_reason="length"`, which
+          #   indicates the generation exceeded `max_tokens` or the conversation exceeded the
+          #   max context length.
+          # @param temperature
+          #   What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+          #   make the output more random, while lower values like 0.2 will make it more
+          #   focused and deterministic.
+          # @param tool_choice
+          #   Controls which (if any) tool is called by the model. `none` means the model will
+          #   not call any tools and instead generates a message. `auto` is the default value
+          #   and means the model can pick between generating a message or calling one or more
+          #   tools. `required` means the model must call one or more tools before responding
+          #   to the user. Specifying a particular tool like `{"type": "file_search"}` or
+          #   `{"type": "function", "function": {"name": "my_function"}}` forces the model to
+          #   call that tool.
+          # @param tools
+          #   Override the tools the assistant can use for this run. This is useful for
+          #   modifying the behavior on a per-run basis.
+          # @param top_p
+          #   An alternative to sampling with temperature, called nucleus sampling, where the
+          #   model considers the results of the tokens with top_p probability mass. So 0.1
+          #   means only the tokens comprising the top 10% probability mass are considered.
+          #
+          #   We generally recommend altering this or temperature but not both.
+          # @param truncation_strategy
+          #   Controls for how a thread will be truncated prior to the run. Use this to
+          #   control the initial context window of the run.
           def initialize: (
             thread_id: String,
             assistant_id: String,
@@ -124,14 +323,46 @@ module OpenAI
             }
 
           class AdditionalMessage < OpenAI::Internal::Type::BaseModel
+            # The text contents of the message.
             attr_accessor content: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::content
 
+            # The role of the entity that is creating the message. Allowed values include:
+            #
+            # - `user`: Indicates the message is sent by an actual user and should be used in
+            #   most cases to represent user-generated messages.
+            # - `assistant`: Indicates the message is generated by the assistant. Use this
+            #   value to insert messages from the assistant into the conversation.
             attr_accessor role: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::role
 
+            # A list of files attached to the message, and the tools they should be added to.
             attr_accessor attachments: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment]?
 
+            # 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.
             attr_accessor metadata: OpenAI::Models::metadata?
 
+            # @param content
+            #   The text contents of the message.
+            # @param role
+            #   The role of the entity that is creating the message. Allowed values include:
+            #
+            #   - `user`: Indicates the message is sent by an actual user and should be used in
+            #     most cases to represent user-generated messages.
+            #   - `assistant`: Indicates the message is generated by the assistant. Use this
+            #     value to insert messages from the assistant into the conversation.
+            # @param attachments
+            #   A list of files attached to the message, and the tools they should be added to.
+            # @param metadata
+            #   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.
             def initialize: (
               content: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::content,
               role: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::role,
@@ -176,16 +407,24 @@ module OpenAI
               }
 
             class Attachment < OpenAI::Internal::Type::BaseModel
+              # The ID of the file to attach to the message.
               attr_reader file_id: String?
 
+              # The ID of the file to attach to the message.
               def file_id=: (String) -> String
 
+              # The tools to add this file to.
               attr_reader tools: ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]?
 
+              # The tools to add this file to.
               def tools=: (
                 ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]
               ) -> ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]
 
+              # @param file_id
+              #   The ID of the file to attach to the message.
+              # @param tools
+              #   The tools to add this file to.
               def initialize: (
                 ?file_id: String,
                 ?tools: ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]
@@ -206,8 +445,11 @@ module OpenAI
                 type file_search = { ?type: :file_search }
 
                 class FileSearch < OpenAI::Internal::Type::BaseModel
+                  # The type of tool being defined: `file_search`
                   attr_accessor type: :file_search
 
+                  # @param type
+                  #   The type of tool being defined: `file_search`
                   def initialize: (?type: :file_search) -> void
 
                   def to_hash: -> { ?type: :file_search }
@@ -233,10 +475,24 @@ module OpenAI
             }
 
           class TruncationStrategy < OpenAI::Internal::Type::BaseModel
+            # The truncation strategy to use for the thread. The default is `auto`. If set to
+            # `last_messages`, the thread will be truncated to the n most recent messages in
+            # the thread. When set to `auto`, messages in the middle of the thread will be
+            # dropped to fit the context length of the model, `max_prompt_tokens`.
             attr_accessor type: OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy::type_
 
+            # The number of most recent messages from the thread when constructing the context
+            # for the run.
             attr_accessor last_messages: Integer?
 
+            # @param type
+            #   The truncation strategy to use for the thread. The default is `auto`. If set to
+            #   `last_messages`, the thread will be truncated to the n most recent messages in
+            #   the thread. When set to `auto`, messages in the middle of the thread will be
+            #   dropped to fit the context length of the model, `max_prompt_tokens`.
+            # @param last_messages
+            #   The number of most recent messages from the thread when constructing the context
+            #   for the run.
             def initialize: (
               type: OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy::type_,
               ?last_messages: Integer?

data/sig/openai/models/beta/threads/run_list_params.rbs

@@ -18,24 +18,64 @@ module OpenAI
 
           attr_accessor thread_id: String
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           attr_reader after: String?
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           def after=: (String) -> String
 
+          # A cursor for use in pagination. `before` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # starting with obj_foo, your subsequent call can include before=obj_foo in order
+          # to fetch the previous page of the list.
           attr_reader before: String?
 
+          # A cursor for use in pagination. `before` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # starting with obj_foo, your subsequent call can include before=obj_foo in order
+          # to fetch the previous page of the list.
           def before=: (String) -> String
 
+          # 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
 
+          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          # order and `desc` for descending order.
           attr_reader order: OpenAI::Models::Beta::Threads::RunListParams::order?
 
+          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          # order and `desc` for descending order.
           def order=: (
             OpenAI::Models::Beta::Threads::RunListParams::order
           ) -> OpenAI::Models::Beta::Threads::RunListParams::order
 
+          # @param after
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
+          # @param before
+          #   A cursor for use in pagination. `before` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   starting with obj_foo, your subsequent call can include before=obj_foo in order
+          #   to fetch the previous page of the list.
+          # @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
+          #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          #   order and `desc` for descending order.
           def initialize: (
             thread_id: String,
             ?after: String,

data/sig/openai/models/beta/threads/run_submit_tool_outputs_params.rbs

@@ -18,8 +18,11 @@ module OpenAI
 
           attr_accessor run_id: String
 
+          # A list of tools for which the outputs are being submitted.
           attr_accessor tool_outputs: ::Array[OpenAI::Beta::Threads::RunSubmitToolOutputsParams::ToolOutput]
 
+          # @param tool_outputs
+          #   A list of tools for which the outputs are being submitted.
           def initialize: (
             thread_id: String,
             run_id: String,
@@ -37,14 +40,25 @@ module OpenAI
           type tool_output = { ?output: String, ?tool_call_id: String }
 
           class ToolOutput < OpenAI::Internal::Type::BaseModel
+            # The output of the tool call to be submitted to continue the run.
             attr_reader output: String?
 
+            # The output of the tool call to be submitted to continue the run.
             def output=: (String) -> String
 
+            # The ID of the tool call in the `required_action` object within the run object
+            # the output is being submitted for.
             attr_reader tool_call_id: String?
 
+            # The ID of the tool call in the `required_action` object within the run object
+            # the output is being submitted for.
             def tool_call_id=: (String) -> String
 
+            # @param output
+            #   The output of the tool call to be submitted to continue the run.
+            # @param tool_call_id
+            #   The ID of the tool call in the `required_action` object within the run object
+            #   the output is being submitted for.
             def initialize: (?output: String, ?tool_call_id: String) -> void
 
             def to_hash: -> { ?output: String, ?tool_call_id: String }

data/sig/openai/models/beta/threads/run_update_params.rbs

@@ -18,8 +18,21 @@ module OpenAI
 
           attr_accessor run_id: String
 
+          # 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.
           attr_accessor metadata: OpenAI::Models::metadata?
 
+          # @param metadata
+          #   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.
           def initialize: (
             thread_id: String,
             run_id: String,

data/sig/openai/models/beta/threads/runs/code_interpreter_logs.rbs

@@ -7,14 +7,24 @@ module OpenAI
             { index: Integer, ?type: :logs, ?logs: String }
 
           class CodeInterpreterLogs < OpenAI::Internal::Type::BaseModel
+            # The index of the output in the outputs array.
             attr_accessor index: Integer
 
+            # Always `logs`.
             attr_accessor type: :logs
 
+            # The text output from the Code Interpreter tool call.
             attr_reader logs: String?
 
+            # The text output from the Code Interpreter tool call.
             def logs=: (String) -> String
 
+            # @param index
+            #   The index of the output in the outputs array.
+            # @param logs
+            #   The text output from the Code Interpreter tool call.
+            # @param type
+            #   Always `logs`.
             def initialize: (
               index: Integer,
               ?logs: String,

data/sig/openai/models/beta/threads/runs/code_interpreter_output_image.rbs

@@ -11,8 +11,10 @@ module OpenAI
             }
 
           class CodeInterpreterOutputImage < OpenAI::Internal::Type::BaseModel
+            # The index of the output in the outputs array.
             attr_accessor index: Integer
 
+            # Always `image`.
             attr_accessor type: :image
 
             attr_reader image: OpenAI::Beta::Threads::Runs::CodeInterpreterOutputImage::Image?
@@ -21,6 +23,10 @@ module OpenAI
               OpenAI::Beta::Threads::Runs::CodeInterpreterOutputImage::Image
             ) -> OpenAI::Beta::Threads::Runs::CodeInterpreterOutputImage::Image
 
+            # @param index
+            #   The index of the output in the outputs array.
+            # @param type
+            #   Always `image`.
             def initialize: (
               index: Integer,
               ?image: OpenAI::Beta::Threads::Runs::CodeInterpreterOutputImage::Image,
@@ -36,10 +42,17 @@ module OpenAI
             type image = { ?file_id: String }
 
             class Image < OpenAI::Internal::Type::BaseModel
+              # The [file](https://developers.openai.com/api/reference/resources/files) ID of
+              # the image.
               attr_reader file_id: String?
 
+              # The [file](https://developers.openai.com/api/reference/resources/files) ID of
+              # the image.
               def file_id=: (String) -> String
 
+              # @param file_id
+              #   The [file](https://developers.openai.com/api/reference/resources/files) ID of
+              #   the image.
               def initialize: (?file_id: String) -> void
 
               def to_hash: -> { ?file_id: String }

data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call.rbs

@@ -11,12 +11,23 @@ module OpenAI
             }
 
           class CodeInterpreterToolCall < OpenAI::Internal::Type::BaseModel
+            # The ID of the tool call.
             attr_accessor id: String
 
+            # The Code Interpreter tool call definition.
             attr_accessor code_interpreter: OpenAI::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter
 
+            # The type of tool call. This is always going to be `code_interpreter` for this
+            # type of tool call.
             attr_accessor type: :code_interpreter
 
+            # @param id
+            #   The ID of the tool call.
+            # @param code_interpreter
+            #   The Code Interpreter tool call definition.
+            # @param type
+            #   The type of tool call. This is always going to be `code_interpreter` for this
+            #   type of tool call.
             def initialize: (
               id: String,
               code_interpreter: OpenAI::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter,
@@ -36,10 +47,20 @@ module OpenAI
               }
 
             class CodeInterpreter < OpenAI::Internal::Type::BaseModel
+              # The input to the Code Interpreter tool call.
               attr_accessor input: String
 
+              # The outputs from the Code Interpreter tool call. Code Interpreter can output one
+              # or more items, including text (`logs`) or images (`image`). Each of these are
+              # represented by a different object type.
               attr_accessor outputs: ::Array[OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter::output]
 
+              # @param input
+              #   The input to the Code Interpreter tool call.
+              # @param outputs
+              #   The outputs from the Code Interpreter tool call. Code Interpreter can output one
+              #   or more items, including text (`logs`) or images (`image`). Each of these are
+              #   represented by a different object type.
               def initialize: (
                 input: String,
                 outputs: ::Array[OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter::output]
@@ -60,10 +81,16 @@ module OpenAI
                 type logs = { logs: String, ?type: :logs }
 
                 class Logs < OpenAI::Internal::Type::BaseModel
+                  # The text output from the Code Interpreter tool call.
                   attr_accessor logs: String
 
+                  # Always `logs`.
                   attr_accessor type: :logs
 
+                  # @param logs
+                  #   The text output from the Code Interpreter tool call.
+                  # @param type
+                  #   Always `logs`.
                   def initialize: (logs: String, ?type: :logs) -> void
 
                   def to_hash: -> { logs: String, ?type: :logs }
@@ -78,8 +105,11 @@ module OpenAI
                 class Image < OpenAI::Internal::Type::BaseModel
                   attr_accessor image: OpenAI::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter::Output::Image::Image
 
+                  # Always `image`.
                   attr_accessor type: :image
 
+                  # @param type
+                  #   Always `image`.
                   def initialize: (
                     image: OpenAI::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter::Output::Image::Image,
                     ?type: :image
@@ -93,8 +123,13 @@ module OpenAI
                   type image = { file_id: String }
 
                   class Image < OpenAI::Internal::Type::BaseModel
+                    # The [file](https://developers.openai.com/api/reference/resources/files) ID of
+                    # the image.
                     attr_accessor file_id: String
 
+                    # @param file_id
+                    #   The [file](https://developers.openai.com/api/reference/resources/files) ID of
+                    #   the image.
                     def initialize: (file_id: String) -> void
 
                     def to_hash: -> { file_id: String }