openai 0.91.0 → 0.93.0

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

@@ -10,14 +10,63 @@ module OpenAI
         }
 
       class BetaResponseTextConfig < OpenAI::Internal::Type::BaseModel
+        # An object specifying the format that the model must output.
+        #
+        # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+        # ensures the model will match your supplied JSON schema. Learn more in the
+        # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        #
+        # The default format is `{ "type": "text" }` with no additional options.
+        #
+        # **Not recommended for gpt-4o and newer models:**
+        #
+        # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+        # ensures the message the model generates is valid JSON. Using `json_schema` is
+        # preferred for models that support it.
         attr_reader format_: OpenAI::Models::Beta::beta_response_format_text_config?
 
+        # An object specifying the format that the model must output.
+        #
+        # Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+        # ensures the model will match your supplied JSON schema. Learn more in the
+        # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        #
+        # The default format is `{ "type": "text" }` with no additional options.
+        #
+        # **Not recommended for gpt-4o and newer models:**
+        #
+        # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+        # ensures the message the model generates is valid JSON. Using `json_schema` is
+        # preferred for models that support it.
         def format_=: (
           OpenAI::Models::Beta::beta_response_format_text_config
         ) -> OpenAI::Models::Beta::beta_response_format_text_config
 
+        # Constrains the verbosity of the model's response. Lower values will result in
+        # more concise responses, while higher values will result in more verbose
+        # responses. Currently supported values are `low`, `medium`, and `high`. The
+        # default is `medium`.
         attr_accessor verbosity: OpenAI::Models::Beta::BetaResponseTextConfig::verbosity?
 
+        # @param format_
+        #   An object specifying the format that the model must output.
+        #
+        #   Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+        #   ensures the model will match your supplied JSON schema. Learn more in the
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        #
+        #   The default format is `{ "type": "text" }` with no additional options.
+        #
+        #   **Not recommended for gpt-4o and newer models:**
+        #
+        #   Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+        #   ensures the message the model generates is valid JSON. Using `json_schema` is
+        #   preferred for models that support it.
+        # @param verbosity
+        #   Constrains the verbosity of the model's response. Lower values will result in
+        #   more concise responses, while higher values will result in more verbose
+        #   responses. Currently supported values are `low`, `medium`, and `high`. The
+        #   default is `medium`.
         def initialize: (
           ?format_: OpenAI::Models::Beta::beta_response_format_text_config,
           ?verbosity: OpenAI::Models::Beta::BetaResponseTextConfig::verbosity?

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

@@ -16,22 +16,46 @@ module OpenAI
         }
 
       class BetaResponseTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that the text delta was added to.
         attr_accessor content_index: Integer
 
+        # The text delta that was added.
         attr_accessor delta: String
 
+        # The ID of the output item that the text delta was added to.
         attr_accessor item_id: String
 
+        # The log probabilities of the tokens in the delta.
         attr_accessor logprobs: ::Array[OpenAI::Beta::BetaResponseTextDeltaEvent::Logprob]
 
+        # The index of the output item that the text delta was added to.
         attr_accessor output_index: Integer
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.output_text.delta`.
         attr_accessor type: :"response.output_text.delta"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseTextDeltaEvent::Agent?
 
+        # @param content_index
+        #   The index of the content part that the text delta was added to.
+        # @param delta
+        #   The text delta that was added.
+        # @param item_id
+        #   The ID of the output item that the text delta was added to.
+        # @param logprobs
+        #   The log probabilities of the tokens in the delta.
+        # @param output_index
+        #   The index of the output item that the text delta was added to.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.output_text.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,
@@ -62,16 +86,26 @@ module OpenAI
           }
 
         class Logprob < OpenAI::Internal::Type::BaseModel
+          # A possible text token.
           attr_accessor token: String
 
+          # The log probability of this token.
           attr_accessor logprob: Float
 
+          # The log probabilities of up to 20 of the most likely tokens.
           attr_reader top_logprobs: ::Array[OpenAI::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob]?
 
+          # The log probabilities of up to 20 of the most likely tokens.
           def top_logprobs=: (
             ::Array[OpenAI::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob]
           ) -> ::Array[OpenAI::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob]
 
+          # @param token
+          #   A possible text token.
+          # @param logprob
+          #   The log probability of this token.
+          # @param top_logprobs
+          #   The log probabilities of up to 20 of the most likely tokens.
           def initialize: (
             token: String,
             logprob: Float,
@@ -87,14 +121,22 @@ module OpenAI
           type top_logprob = { ?token: String, ?logprob: Float }
 
           class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # A possible text token.
             attr_reader token: String?
 
+            # A possible text token.
             def token=: (String) -> String
 
+            # The log probability of this token.
             attr_reader logprob: Float?
 
+            # The log probability of this token.
             def logprob=: (Float) -> Float
 
+            # @param token
+            #   A possible text token.
+            # @param logprob
+            #   The log probability of this token.
             def initialize: (?token: String, ?logprob: Float) -> void
 
             def to_hash: -> { ?token: String, ?logprob: Float }
@@ -104,8 +146,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

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

@@ -16,22 +16,46 @@ module OpenAI
         }
 
       class BetaResponseTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that the text content is finalized.
         attr_accessor content_index: Integer
 
+        # The ID of the output item that the text content is finalized.
         attr_accessor item_id: String
 
+        # The log probabilities of the tokens in the delta.
         attr_accessor logprobs: ::Array[OpenAI::Beta::BetaResponseTextDoneEvent::Logprob]
 
+        # The index of the output item that the text content is finalized.
         attr_accessor output_index: Integer
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The text content that is finalized.
         attr_accessor text: String
 
+        # The type of the event. Always `response.output_text.done`.
         attr_accessor type: :"response.output_text.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseTextDoneEvent::Agent?
 
+        # @param content_index
+        #   The index of the content part that the text content is finalized.
+        # @param item_id
+        #   The ID of the output item that the text content is finalized.
+        # @param logprobs
+        #   The log probabilities of the tokens in the delta.
+        # @param output_index
+        #   The index of the output item that the text content is finalized.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param text
+        #   The text content that is finalized.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.output_text.done`.
         def initialize: (
           content_index: Integer,
           item_id: String,
@@ -62,16 +86,26 @@ module OpenAI
           }
 
         class Logprob < OpenAI::Internal::Type::BaseModel
+          # A possible text token.
           attr_accessor token: String
 
+          # The log probability of this token.
           attr_accessor logprob: Float
 
+          # The log probabilities of up to 20 of the most likely tokens.
           attr_reader top_logprobs: ::Array[OpenAI::Beta::BetaResponseTextDoneEvent::Logprob::TopLogprob]?
 
+          # The log probabilities of up to 20 of the most likely tokens.
           def top_logprobs=: (
             ::Array[OpenAI::Beta::BetaResponseTextDoneEvent::Logprob::TopLogprob]
           ) -> ::Array[OpenAI::Beta::BetaResponseTextDoneEvent::Logprob::TopLogprob]
 
+          # @param token
+          #   A possible text token.
+          # @param logprob
+          #   The log probability of this token.
+          # @param top_logprobs
+          #   The log probabilities of up to 20 of the most likely tokens.
           def initialize: (
             token: String,
             logprob: Float,
@@ -87,14 +121,22 @@ module OpenAI
           type top_logprob = { ?token: String, ?logprob: Float }
 
           class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # A possible text token.
             attr_reader token: String?
 
+            # A possible text token.
             def token=: (String) -> String
 
+            # The log probability of this token.
             attr_reader logprob: Float?
 
+            # The log probability of this token.
             def logprob=: (Float) -> Float
 
+            # @param token
+            #   A possible text token.
+            # @param logprob
+            #   The log probability of this token.
             def initialize: (?token: String, ?logprob: Float) -> void
 
             def to_hash: -> { ?token: String, ?logprob: Float }
@@ -104,8 +146,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

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

@@ -16,28 +16,54 @@ module OpenAI
         }
 
       class BetaResponseToolSearchCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the tool search call item.
         attr_accessor id: String
 
+        # Arguments used for the tool search call.
         attr_accessor arguments: top
 
+        # The unique ID of the tool search call generated by the model.
         attr_accessor call_id: String?
 
+        # Whether tool search was executed by the server or by the client.
         attr_accessor execution: OpenAI::Models::Beta::BetaResponseToolSearchCall::execution
 
+        # The status of the tool search call item that was recorded.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseToolSearchCall::status
 
+        # The type of the item. Always `tool_search_call`.
         attr_accessor type: :tool_search_call
 
+        # The agent that produced this item.
         attr_reader agent: OpenAI::Beta::BetaResponseToolSearchCall::Agent?
 
+        # The agent that produced this item.
         def agent=: (
           OpenAI::Beta::BetaResponseToolSearchCall::Agent
         ) -> OpenAI::Beta::BetaResponseToolSearchCall::Agent
 
+        # The identifier of the actor that created the item.
         attr_reader created_by: String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String) -> String
 
+        # @param id
+        #   The unique ID of the tool search call item.
+        # @param arguments
+        #   Arguments used for the tool search call.
+        # @param call_id
+        #   The unique ID of the tool search call generated by the model.
+        # @param execution
+        #   Whether tool search was executed by the server or by the client.
+        # @param status
+        #   The status of the tool search call item that was recorded.
+        # @param agent
+        #   The agent that produced this item.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the item. Always `tool_search_call`.
         def initialize: (
           id: String,
           arguments: top,
@@ -86,8 +112,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

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

@@ -16,28 +16,54 @@ module OpenAI
         }
 
       class BetaResponseToolSearchOutputItem < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the tool search output item.
         attr_accessor id: String
 
+        # The unique ID of the tool search call generated by the model.
         attr_accessor call_id: String?
 
+        # Whether tool search was executed by the server or by the client.
         attr_accessor execution: OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::execution
 
+        # The status of the tool search output item that was recorded.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::status
 
+        # The loaded tool definitions returned by tool search.
         attr_accessor tools: ::Array[OpenAI::Models::Beta::beta_tool]
 
+        # The type of the item. Always `tool_search_output`.
         attr_accessor type: :tool_search_output
 
+        # The agent that produced this item.
         attr_reader agent: OpenAI::Beta::BetaResponseToolSearchOutputItem::Agent?
 
+        # The agent that produced this item.
         def agent=: (
           OpenAI::Beta::BetaResponseToolSearchOutputItem::Agent
         ) -> OpenAI::Beta::BetaResponseToolSearchOutputItem::Agent
 
+        # The identifier of the actor that created the item.
         attr_reader created_by: String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String) -> String
 
+        # @param id
+        #   The unique ID of the tool search output item.
+        # @param call_id
+        #   The unique ID of the tool search call generated by the model.
+        # @param execution
+        #   Whether tool search was executed by the server or by the client.
+        # @param status
+        #   The status of the tool search output item that was recorded.
+        # @param tools
+        #   The loaded tool definitions returned by tool search.
+        # @param agent
+        #   The agent that produced this item.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the item. Always `tool_search_output`.
         def initialize: (
           id: String,
           call_id: String?,
@@ -86,8 +112,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

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

@@ -15,24 +15,46 @@ module OpenAI
         }
 
       class BetaResponseToolSearchOutputItemParam < OpenAI::Internal::Type::BaseModel
+        # The loaded tool definitions returned by the tool search output.
         attr_accessor tools: ::Array[OpenAI::Models::Beta::beta_tool]
 
+        # The item type. Always `tool_search_output`.
         attr_accessor type: :tool_search_output
 
+        # The unique ID of this tool search output.
         attr_accessor id: String?
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Agent?
 
+        # The unique ID of the tool search call generated by the model.
         attr_accessor call_id: String?
 
+        # Whether tool search was executed by the server or by the client.
         attr_reader execution: OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::execution?
 
+        # Whether tool search was executed by the server or by the client.
         def execution=: (
           OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::execution
         ) -> OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::execution
 
+        # The status of the tool search output.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::status?
 
+        # @param tools
+        #   The loaded tool definitions returned by the tool search output.
+        # @param id
+        #   The unique ID of this tool search output.
+        # @param agent
+        #   The agent that produced this item.
+        # @param call_id
+        #   The unique ID of the tool search call generated by the model.
+        # @param execution
+        #   Whether tool search was executed by the server or by the client.
+        # @param status
+        #   The status of the tool search output.
+        # @param type
+        #   The item type. Always `tool_search_output`.
         def initialize: (
           tools: ::Array[OpenAI::Models::Beta::beta_tool],
           ?id: String?,
@@ -56,8 +78,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

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

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseUsage < OpenAI::Internal::Type::BaseModel
+        # The number of input tokens.
         attr_accessor input_tokens: Integer
 
+        # A detailed breakdown of the input tokens.
         attr_accessor input_tokens_details: OpenAI::Beta::BetaResponseUsage::InputTokensDetails
 
+        # The number of output tokens.
         attr_accessor output_tokens: Integer
 
+        # A detailed breakdown of the output tokens.
         attr_accessor output_tokens_details: OpenAI::Beta::BetaResponseUsage::OutputTokensDetails
 
+        # The total number of tokens used.
         attr_accessor total_tokens: Integer
 
+        # @param input_tokens
+        #   The number of input tokens.
+        # @param input_tokens_details
+        #   A detailed breakdown of the input tokens.
+        # @param output_tokens
+        #   The number of output tokens.
+        # @param output_tokens_details
+        #   A detailed breakdown of the output tokens.
+        # @param total_tokens
+        #   The total number of tokens used.
         def initialize: (
           input_tokens: Integer,
           input_tokens_details: OpenAI::Beta::BetaResponseUsage::InputTokensDetails,
@@ -43,10 +58,18 @@ module OpenAI
           { cache_write_tokens: Integer, cached_tokens: Integer }
 
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # The number of input tokens that were written to the cache.
           attr_accessor cache_write_tokens: Integer
 
+          # The number of tokens that were retrieved from the cache.
+          # [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
           attr_accessor cached_tokens: Integer
 
+          # @param cache_write_tokens
+          #   The number of input tokens that were written to the cache.
+          # @param cached_tokens
+          #   The number of tokens that were retrieved from the cache.
+          #   [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
           def initialize: (
             cache_write_tokens: Integer,
             cached_tokens: Integer
@@ -61,8 +84,11 @@ module OpenAI
         type output_tokens_details = { reasoning_tokens: Integer }
 
         class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # The number of reasoning tokens.
           attr_accessor reasoning_tokens: Integer
 
+          # @param reasoning_tokens
+          #   The number of reasoning tokens.
           def initialize: (reasoning_tokens: Integer) -> void
 
           def to_hash: -> { reasoning_tokens: Integer }

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

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseWebSearchCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # Unique ID for the output item associated with the web search call.
         attr_accessor item_id: String
 
+        # The index of the output item that the web search call is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of the web search call being processed.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.web_search_call.completed`.
         attr_accessor type: :"response.web_search_call.completed"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent::Agent?
 
+        # @param item_id
+        #   Unique ID for the output item associated with the web search call.
+        # @param output_index
+        #   The index of the output item that the web search call is associated with.
+        # @param sequence_number
+        #   The sequence number of the web search call being processed.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.web_search_call.completed`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -42,8 +57,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

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

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseWebSearchCallInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # Unique ID for the output item associated with the web search call.
         attr_accessor item_id: String
 
+        # The index of the output item that the web search call is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of the web search call being processed.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.web_search_call.in_progress`.
         attr_accessor type: :"response.web_search_call.in_progress"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseWebSearchCallInProgressEvent::Agent?
 
+        # @param item_id
+        #   Unique ID for the output item associated with the web search call.
+        # @param output_index
+        #   The index of the output item that the web search call is associated with.
+        # @param sequence_number
+        #   The sequence number of the web search call being processed.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.web_search_call.in_progress`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -42,8 +57,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

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

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseWebSearchCallSearchingEvent < OpenAI::Internal::Type::BaseModel
+        # Unique ID for the output item associated with the web search call.
         attr_accessor item_id: String
 
+        # The index of the output item that the web search call is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of the web search call being processed.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.web_search_call.searching`.
         attr_accessor type: :"response.web_search_call.searching"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseWebSearchCallSearchingEvent::Agent?
 
+        # @param item_id
+        #   Unique ID for the output item associated with the web search call.
+        # @param output_index
+        #   The index of the output item that the web search call is associated with.
+        # @param sequence_number
+        #   The sequence number of the web search call being processed.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.web_search_call.searching`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -42,8 +57,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }