openai 0.91.0 → 0.93.0

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

@@ -38,14 +38,23 @@ module OpenAI
           }
 
         class ThreadCreated < OpenAI::Internal::Type::BaseModel
+          # Represents a thread that contains
+          # [messages](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Thread
 
           attr_accessor event: :"thread.created"
 
+          # Whether to enable input audio transcription.
           attr_reader enabled: bool?
 
+          # Whether to enable input audio transcription.
           def enabled=: (bool) -> bool
 
+          # @param data
+          #   Represents a thread that contains
+          #   [messages](https://developers.openai.com/api/docs/assistants/migration).
+          # @param enabled
+          #   Whether to enable input audio transcription.
           def initialize: (
             data: OpenAI::Beta::Thread,
             ?enabled: bool,
@@ -63,10 +72,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.created" }
 
         class ThreadRunCreated < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.created"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.created"
@@ -82,10 +96,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.queued" }
 
         class ThreadRunQueued < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.queued"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.queued"
@@ -104,10 +123,15 @@ module OpenAI
           }
 
         class ThreadRunInProgress < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.in_progress"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.in_progress"
@@ -126,10 +150,15 @@ module OpenAI
           }
 
         class ThreadRunRequiresAction < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.requires_action"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.requires_action"
@@ -145,10 +174,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.completed" }
 
         class ThreadRunCompleted < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.completed"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.completed"
@@ -164,10 +198,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.incomplete" }
 
         class ThreadRunIncomplete < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.incomplete"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.incomplete"
@@ -183,10 +222,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.failed" }
 
         class ThreadRunFailed < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.failed"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.failed"
@@ -202,10 +246,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.cancelling" }
 
         class ThreadRunCancelling < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.cancelling"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.cancelling"
@@ -221,10 +270,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.cancelled" }
 
         class ThreadRunCancelled < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.cancelled"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.cancelled"
@@ -240,10 +294,15 @@ module OpenAI
           { data: OpenAI::Beta::Threads::Run, ?event: :"thread.run.expired" }
 
         class ThreadRunExpired < OpenAI::Internal::Type::BaseModel
+          # Represents an execution run on a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Run
 
           attr_accessor event: :"thread.run.expired"
 
+          # @param data
+          #   Represents an execution run on a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Run,
             ?event: :"thread.run.expired"
@@ -262,10 +321,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"
@@ -284,10 +346,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"
@@ -306,10 +371,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"
@@ -328,10 +398,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"
@@ -350,10 +423,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"
@@ -372,10 +448,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"
@@ -394,10 +473,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"
@@ -416,10 +498,15 @@ module OpenAI
           }
 
         class ThreadMessageCreated < OpenAI::Internal::Type::BaseModel
+          # Represents a message within a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Message
 
           attr_accessor event: :"thread.message.created"
 
+          # @param data
+          #   Represents a message within a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Message,
             ?event: :"thread.message.created"
@@ -438,10 +525,15 @@ module OpenAI
           }
 
         class ThreadMessageInProgress < OpenAI::Internal::Type::BaseModel
+          # Represents a message within a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Message
 
           attr_accessor event: :"thread.message.in_progress"
 
+          # @param data
+          #   Represents a message within a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Message,
             ?event: :"thread.message.in_progress"
@@ -460,10 +552,15 @@ module OpenAI
           }
 
         class ThreadMessageDelta < OpenAI::Internal::Type::BaseModel
+          # Represents a message delta i.e. any changed fields on a message during
+          # streaming.
           attr_accessor data: OpenAI::Beta::Threads::MessageDeltaEvent
 
           attr_accessor event: :"thread.message.delta"
 
+          # @param data
+          #   Represents a message delta i.e. any changed fields on a message during
+          #   streaming.
           def initialize: (
             data: OpenAI::Beta::Threads::MessageDeltaEvent,
             ?event: :"thread.message.delta"
@@ -482,10 +579,15 @@ module OpenAI
           }
 
         class ThreadMessageCompleted < OpenAI::Internal::Type::BaseModel
+          # Represents a message within a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Message
 
           attr_accessor event: :"thread.message.completed"
 
+          # @param data
+          #   Represents a message within a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Message,
             ?event: :"thread.message.completed"
@@ -504,10 +606,15 @@ module OpenAI
           }
 
         class ThreadMessageIncomplete < OpenAI::Internal::Type::BaseModel
+          # Represents a message within a
+          # [thread](https://developers.openai.com/api/docs/assistants/migration).
           attr_accessor data: OpenAI::Beta::Threads::Message
 
           attr_accessor event: :"thread.message.incomplete"
 
+          # @param data
+          #   Represents a message within a
+          #   [thread](https://developers.openai.com/api/docs/assistants/migration).
           def initialize: (
             data: OpenAI::Beta::Threads::Message,
             ?event: :"thread.message.incomplete"

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

@@ -8,6 +8,7 @@ module OpenAI
         }
 
       class AssistantToolChoice < OpenAI::Internal::Type::BaseModel
+        # The type of the tool. If type is `function`, the function name must be set
         attr_accessor type: OpenAI::Models::Beta::AssistantToolChoice::type_
 
         attr_reader function: OpenAI::Beta::AssistantToolChoiceFunction?
@@ -16,6 +17,8 @@ module OpenAI
           OpenAI::Beta::AssistantToolChoiceFunction
         ) -> OpenAI::Beta::AssistantToolChoiceFunction
 
+        # @param type
+        #   The type of the tool. If type is `function`, the function name must be set
         def initialize: (
           type: OpenAI::Models::Beta::AssistantToolChoice::type_,
           ?function: OpenAI::Beta::AssistantToolChoiceFunction

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

@@ -4,8 +4,11 @@ module OpenAI
       type assistant_tool_choice_function = { name: String }
 
       class AssistantToolChoiceFunction < OpenAI::Internal::Type::BaseModel
+        # The name of the function to call.
         attr_accessor name: String
 
+        # @param name
+        #   The name of the function to call.
         def initialize: (name: String) -> void
 
         def to_hash: -> { name: String }

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

@@ -24,36 +24,167 @@ module OpenAI
 
         attr_accessor assistant_id: String
 
+        # The description of the assistant. The maximum length is 512 characters.
         attr_accessor description: String?
 
+        # The system instructions that the assistant uses. The maximum length is 256,000
+        # characters.
         attr_accessor instructions: 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?
 
+        # ID of the model to use. You can use the
+        # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        # API to see all of your available models, or see our
+        # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        # of them.
         attr_reader model: OpenAI::Models::Beta::AssistantUpdateParams::model?
 
+        # ID of the model to use. You can use the
+        # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        # API to see all of your available models, or see our
+        # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        # of them.
         def model=: (
           OpenAI::Models::Beta::AssistantUpdateParams::model
         ) -> OpenAI::Models::Beta::AssistantUpdateParams::model
 
+        # The name of the assistant. The maximum length is 256 characters.
         attr_accessor name: String?
 
+        # 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?
 
+        # A set of resources that are used by the assistant's tools. The resources are
+        # specific to the type of tool. For example, the `code_interpreter` tool requires
+        # a list of file IDs, while the `file_search` tool requires a list of vector store
+        # IDs.
         attr_accessor tool_resources: OpenAI::Beta::AssistantUpdateParams::ToolResources?
 
+        # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
+        # assistant. Tools can be of types `code_interpreter`, `file_search`, or
+        # `function`.
         attr_reader tools: ::Array[OpenAI::Models::Beta::assistant_tool]?
 
+        # A list of tool enabled on the assistant. There can be a maximum of 128 tools per
+        # assistant. Tools can be of types `code_interpreter`, `file_search`, or
+        # `function`.
         def tools=: (
           ::Array[OpenAI::Models::Beta::assistant_tool]
         ) -> ::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?
 
+        # @param description
+        #   The description of the assistant. The maximum length is 512 characters.
+        # @param instructions
+        #   The system instructions that the assistant uses. The maximum length is 256,000
+        #   characters.
+        # @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
+        #   ID of the model to use. You can use the
+        #   [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        #   API to see all of your available models, or see our
+        #   [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        #   of them.
+        # @param name
+        #   The name of the assistant. The maximum length is 256 characters.
+        # @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_resources
+        #   A set of resources that are used by the assistant's tools. The resources are
+        #   specific to the type of tool. For example, the `code_interpreter` tool requires
+        #   a list of file IDs, while the `file_search` tool requires a list of vector store
+        #   IDs.
+        # @param tools
+        #   A list of tool enabled on the assistant. There can be a maximum of 128 tools per
+        #   assistant. Tools can be of types `code_interpreter`, `file_search`, or
+        #   `function`.
+        # @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.
         def initialize: (
           assistant_id: String,
           ?description: String?,
@@ -212,10 +343,23 @@ module OpenAI
           type code_interpreter = { ?file_ids: ::Array[String] }
 
           class CodeInterpreter < OpenAI::Internal::Type::BaseModel
+            # Overrides the list of
+            # [file](https://developers.openai.com/api/reference/resources/files) IDs made
+            # available to the `code_interpreter` tool. There can be a maximum of 20 files
+            # associated with the tool.
             attr_reader file_ids: ::Array[String]?
 
+            # Overrides the list of
+            # [file](https://developers.openai.com/api/reference/resources/files) IDs made
+            # available to the `code_interpreter` tool. There can be a maximum of 20 files
+            # associated with the tool.
             def file_ids=: (::Array[String]) -> ::Array[String]
 
+            # @param file_ids
+            #   Overrides the list of
+            #   [file](https://developers.openai.com/api/reference/resources/files) IDs made
+            #   available to the `code_interpreter` tool. There can be a maximum of 20 files
+            #   associated with the tool.
             def initialize: (?file_ids: ::Array[String]) -> void
 
             def to_hash: -> { ?file_ids: ::Array[String] }
@@ -224,10 +368,23 @@ module OpenAI
           type file_search = { ?vector_store_ids: ::Array[String] }
 
           class FileSearch < OpenAI::Internal::Type::BaseModel
+            # Overrides the
+            # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+            # attached to this assistant. There can be a maximum of 1 vector store attached to
+            # the assistant.
             attr_reader vector_store_ids: ::Array[String]?
 
+            # Overrides the
+            # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+            # attached to this assistant. There can be a maximum of 1 vector store attached to
+            # the assistant.
             def vector_store_ids=: (::Array[String]) -> ::Array[String]
 
+            # @param vector_store_ids
+            #   Overrides the
+            #   [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+            #   attached to this assistant. There can be a maximum of 1 vector store attached to
+            #   the assistant.
             def initialize: (?vector_store_ids: ::Array[String]) -> void
 
             def to_hash: -> { ?vector_store_ids: ::Array[String] }

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

@@ -10,10 +10,16 @@ module OpenAI
         }
 
       class BetaApplyPatchTool < OpenAI::Internal::Type::BaseModel
+        # The type of the tool. Always `apply_patch`.
         attr_accessor type: :apply_patch
 
+        # The tool invocation context(s).
         attr_accessor allowed_callers: ::Array[OpenAI::Models::Beta::BetaApplyPatchTool::allowed_caller]?
 
+        # @param allowed_callers
+        #   The tool invocation context(s).
+        # @param type
+        #   The type of the tool. Always `apply_patch`.
         def initialize: (
           ?allowed_callers: ::Array[OpenAI::Models::Beta::BetaApplyPatchTool::allowed_caller]?,
           ?type: :apply_patch

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

@@ -13,16 +13,35 @@ module OpenAI
         }
 
       class BetaCompactedResponse < OpenAI::Internal::Type::BaseModel
+        # The unique identifier for the compacted response.
         attr_accessor id: String
 
+        # Unix timestamp (in seconds) when the compacted conversation was created.
         attr_accessor created_at: Integer
 
+        # The object type. Always `response.compaction`.
         attr_accessor object: :"response.compaction"
 
+        # The compacted list of output items. This is a list of all user messages,
+        # followed by a single compaction item.
         attr_accessor output: ::Array[OpenAI::Models::Beta::beta_response_output_item]
 
+        # Token accounting for the compaction pass, including cached, reasoning, and total
+        # tokens.
         attr_accessor usage: OpenAI::Beta::BetaResponseUsage
 
+        # @param id
+        #   The unique identifier for the compacted response.
+        # @param created_at
+        #   Unix timestamp (in seconds) when the compacted conversation was created.
+        # @param output
+        #   The compacted list of output items. This is a list of all user messages,
+        #   followed by a single compaction item.
+        # @param usage
+        #   Token accounting for the compaction pass, including cached, reasoning, and total
+        #   tokens.
+        # @param object
+        #   The object type. Always `response.compaction`.
         def initialize: (
           id: String,
           created_at: Integer,