openai 0.91.0 → 0.93.0

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

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseFailedEvent < OpenAI::Internal::Type::BaseModel
+        # The response that failed.
         attr_accessor response: OpenAI::Beta::BetaResponse
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.failed`.
         attr_accessor type: :"response.failed"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseFailedEvent::Agent?
 
+        # @param response
+        #   The response that failed.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.failed`.
         def initialize: (
           response: OpenAI::Beta::BetaResponse,
           sequence_number: Integer,
@@ -37,8 +49,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_file_search_call_completed_event.rbs

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseFileSearchCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the output item that the file search call is initiated.
         attr_accessor item_id: String
 
+        # The index of the output item that the file search call is initiated.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.file_search_call.completed`.
         attr_accessor type: :"response.file_search_call.completed"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseFileSearchCallCompletedEvent::Agent?
 
+        # @param item_id
+        #   The ID of the output item that the file search call is initiated.
+        # @param output_index
+        #   The index of the output item that the file search call is initiated.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.file_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_file_search_call_in_progress_event.rbs

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseFileSearchCallInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the output item that the file search call is initiated.
         attr_accessor item_id: String
 
+        # The index of the output item that the file search call is initiated.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.file_search_call.in_progress`.
         attr_accessor type: :"response.file_search_call.in_progress"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseFileSearchCallInProgressEvent::Agent?
 
+        # @param item_id
+        #   The ID of the output item that the file search call is initiated.
+        # @param output_index
+        #   The index of the output item that the file search call is initiated.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.file_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_file_search_call_searching_event.rbs

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseFileSearchCallSearchingEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the output item that the file search call is initiated.
         attr_accessor item_id: String
 
+        # The index of the output item that the file search call is searching.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.file_search_call.searching`.
         attr_accessor type: :"response.file_search_call.searching"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseFileSearchCallSearchingEvent::Agent?
 
+        # @param item_id
+        #   The ID of the output item that the file search call is initiated.
+        # @param output_index
+        #   The index of the output item that the file search call is searching.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.file_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 }

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

@@ -14,18 +14,38 @@ module OpenAI
         }
 
       class BetaResponseFileSearchToolCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the file search tool call.
         attr_accessor id: String
 
+        # The queries used to search for files.
         attr_accessor queries: ::Array[String]
 
+        # The status of the file search tool call. One of `in_progress`, `searching`,
+        # `incomplete` or `failed`,
         attr_accessor status: OpenAI::Models::Beta::BetaResponseFileSearchToolCall::status
 
+        # The type of the file search tool call. Always `file_search_call`.
         attr_accessor type: :file_search_call
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseFileSearchToolCall::Agent?
 
+        # The results of the file search tool call.
         attr_accessor results: ::Array[OpenAI::Beta::BetaResponseFileSearchToolCall::Result]?
 
+        # @param id
+        #   The unique ID of the file search tool call.
+        # @param queries
+        #   The queries used to search for files.
+        # @param status
+        #   The status of the file search tool call. One of `in_progress`, `searching`,
+        #   `incomplete` or `failed`,
+        # @param agent
+        #   The agent that produced this item.
+        # @param results
+        #   The results of the file search tool call.
+        # @param type
+        #   The type of the file search tool call. Always `file_search_call`.
         def initialize: (
           id: String,
           queries: ::Array[String],
@@ -62,8 +82,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 }
@@ -79,24 +102,51 @@ module OpenAI
           }
 
         class Result < OpenAI::Internal::Type::BaseModel
+          # Set of 16 key-value pairs that can be attached to an object. This can be useful
+          # for storing additional information about the object in a structured format, and
+          # querying for objects via API or the dashboard. Keys are strings with a maximum
+          # length of 64 characters. Values are strings with a maximum length of 512
+          # characters, booleans, or numbers.
           attr_accessor attributes: ::Hash[Symbol, OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Result::attribute]?
 
+          # The unique ID of the file.
           attr_reader file_id: String?
 
+          # The unique ID of the file.
           def file_id=: (String) -> String
 
+          # The name of the file.
           attr_reader filename: String?
 
+          # The name of the file.
           def filename=: (String) -> String
 
+          # The relevance score of the file - a value between 0 and 1.
           attr_reader score: Float?
 
+          # The relevance score of the file - a value between 0 and 1.
           def score=: (Float) -> Float
 
+          # The text that was retrieved from the file.
           attr_reader text: String?
 
+          # The text that was retrieved from the file.
           def text=: (String) -> String
 
+          # @param attributes
+          #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+          #   for storing additional information about the object in a structured format, and
+          #   querying for objects via API or the dashboard. Keys are strings with a maximum
+          #   length of 64 characters. Values are strings with a maximum length of 512
+          #   characters, booleans, or numbers.
+          # @param file_id
+          #   The unique ID of the file.
+          # @param filename
+          #   The name of the file.
+          # @param score
+          #   The relevance score of the file - a value between 0 and 1.
+          # @param text
+          #   The text that was retrieved from the file.
           def initialize: (
             ?attributes: ::Hash[Symbol, OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Result::attribute]?,
             ?file_id: String,

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

@@ -14,8 +14,11 @@ module OpenAI
         type text = { ?type: :text }
 
         class Text < OpenAI::Internal::Type::BaseModel
+          # The type of response format being defined. Always `text`.
           attr_accessor type: :text
 
+          # @param type
+          #   The type of response format being defined. Always `text`.
           def initialize: (?type: :text) -> void
 
           def to_hash: -> { ?type: :text }
@@ -24,8 +27,11 @@ module OpenAI
         type json_object = { ?type: :json_object }
 
         class JSONObject < OpenAI::Internal::Type::BaseModel
+          # The type of response format being defined. Always `json_object`.
           attr_accessor type: :json_object
 
+          # @param type
+          #   The type of response format being defined. Always `json_object`.
           def initialize: (?type: :json_object) -> void
 
           def to_hash: -> { ?type: :json_object }

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

@@ -13,18 +13,49 @@ module OpenAI
         }
 
       class BetaResponseFormatTextJSONSchemaConfig < OpenAI::Internal::Type::BaseModel
+        # The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
+        # and dashes, with a maximum length of 64.
         attr_accessor name: String
 
+        # The schema for the response format, described as a JSON Schema object. Learn how
+        # to build JSON schemas [here](https://json-schema.org/).
         attr_accessor schema: ::Hash[Symbol, top]
 
+        # The type of response format being defined. Always `json_schema`.
         attr_accessor type: :json_schema
 
+        # A description of what the response format is for, used by the model to determine
+        # how to respond in the format.
         attr_reader description: String?
 
+        # A description of what the response format is for, used by the model to determine
+        # how to respond in the format.
         def description=: (String) -> String
 
+        # Whether to enable strict schema adherence when generating the output. If set to
+        # true, the model will always follow the exact schema defined in the `schema`
+        # field. Only a subset of JSON Schema is supported when `strict` is `true`. To
+        # learn more, read the
+        # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         attr_accessor strict: bool?
 
+        # @param name
+        #   The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
+        #   and dashes, with a maximum length of 64.
+        # @param schema
+        #   The schema for the response format, described as a JSON Schema object. Learn how
+        #   to build JSON schemas [here](https://json-schema.org/).
+        # @param description
+        #   A description of what the response format is for, used by the model to determine
+        #   how to respond in the format.
+        # @param strict
+        #   Whether to enable strict schema adherence when generating the output. If set to
+        #   true, the model will always follow the exact schema defined in the `schema`
+        #   field. Only a subset of JSON Schema is supported when `strict` is `true`. To
+        #   learn more, read the
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        # @param type
+        #   The type of response format being defined. Always `json_schema`.
         def initialize: (
           name: String,
           schema: ::Hash[Symbol, top],

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

@@ -14,18 +14,36 @@ module OpenAI
         }
 
       class BetaResponseFunctionCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The function-call arguments delta that is added.
         attr_accessor delta: String
 
+        # The ID of the output item that the function-call arguments delta is added to.
         attr_accessor item_id: String
 
+        # The index of the output item that the function-call arguments delta is added to.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.function_call_arguments.delta`.
         attr_accessor type: :"response.function_call_arguments.delta"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseFunctionCallArgumentsDeltaEvent::Agent?
 
+        # @param delta
+        #   The function-call arguments delta that is added.
+        # @param item_id
+        #   The ID of the output item that the function-call arguments delta is added to.
+        # @param output_index
+        #   The index of the output item that the function-call arguments delta is added to.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.function_call_arguments.delta`.
         def initialize: (
           delta: String,
           item_id: String,
@@ -47,8 +65,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_function_call_arguments_done_event.rbs

@@ -14,18 +14,33 @@ module OpenAI
         }
 
       class BetaResponseFunctionCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The function-call arguments.
         attr_accessor arguments: String
 
+        # The ID of the item.
         attr_accessor item_id: String
 
+        # The index of the output item.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
         attr_accessor type: :"response.function_call_arguments.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseFunctionCallArgumentsDoneEvent::Agent?
 
+        # @param arguments
+        #   The function-call arguments.
+        # @param item_id
+        #   The ID of the item.
+        # @param output_index
+        #   The index of the output item.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
         def initialize: (
           arguments: String,
           item_id: String,
@@ -47,8 +62,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_function_shell_call_output_content.rbs

@@ -11,12 +11,21 @@ module OpenAI
         }
 
       class BetaResponseFunctionShellCallOutputContent < OpenAI::Internal::Type::BaseModel
+        # The exit or timeout outcome associated with this shell call.
         attr_accessor outcome: OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::outcome
 
+        # Captured stderr output for the shell call.
         attr_accessor stderr: String
 
+        # Captured stdout output for the shell call.
         attr_accessor stdout: String
 
+        # @param outcome
+        #   The exit or timeout outcome associated with this shell call.
+        # @param stderr
+        #   Captured stderr output for the shell call.
+        # @param stdout
+        #   Captured stdout output for the shell call.
         def initialize: (
           outcome: OpenAI::Models::Beta::BetaResponseFunctionShellCallOutputContent::outcome,
           stderr: String,
@@ -39,8 +48,11 @@ module OpenAI
           type timeout = { ?type: :timeout }
 
           class Timeout < OpenAI::Internal::Type::BaseModel
+            # The outcome type. Always `timeout`.
             attr_accessor type: :timeout
 
+            # @param type
+            #   The outcome type. Always `timeout`.
             def initialize: (?type: :timeout) -> void
 
             def to_hash: -> { ?type: :timeout }
@@ -49,10 +61,16 @@ module OpenAI
           type exit_ = { exit_code: Integer, ?type: :exit }
 
           class Exit < OpenAI::Internal::Type::BaseModel
+            # The exit code returned by the shell process.
             attr_accessor exit_code: Integer
 
+            # The outcome type. Always `exit`.
             attr_accessor type: :exit
 
+            # @param exit_code
+            #   The exit code returned by the shell process.
+            # @param type
+            #   The outcome type. Always `exit`.
             def initialize: (exit_code: Integer, ?type: :exit) -> void
 
             def to_hash: -> { exit_code: Integer, ?type: :exit }

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

@@ -17,30 +17,63 @@ module OpenAI
         }
 
       class BetaResponseFunctionShellToolCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the shell tool call. Populated when this item is returned via
+        # API.
         attr_accessor id: String
 
+        # The shell commands and limits that describe how to run the tool call.
         attr_accessor action: OpenAI::Beta::BetaResponseFunctionShellToolCall::Action
 
+        # The unique ID of the shell tool call generated by the model.
         attr_accessor call_id: String
 
+        # Represents the use of a local environment to perform shell actions.
         attr_accessor environment: OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::environment?
 
+        # The status of the shell call. One of `in_progress`, `completed`, or
+        # `incomplete`.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::status
 
+        # The type of the item. Always `shell_call`.
         attr_accessor type: :shell_call
 
+        # The agent that produced this item.
         attr_reader agent: OpenAI::Beta::BetaResponseFunctionShellToolCall::Agent?
 
+        # The agent that produced this item.
         def agent=: (
           OpenAI::Beta::BetaResponseFunctionShellToolCall::Agent
         ) -> OpenAI::Beta::BetaResponseFunctionShellToolCall::Agent
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Beta::BetaResponseFunctionShellToolCall::caller_?
 
+        # The ID of the entity that created this tool call.
         attr_reader created_by: String?
 
+        # The ID of the entity that created this tool call.
         def created_by=: (String) -> String
 
+        # @param id
+        #   The unique ID of the shell tool call. Populated when this item is returned via
+        #   API.
+        # @param action
+        #   The shell commands and limits that describe how to run the tool call.
+        # @param call_id
+        #   The unique ID of the shell tool call generated by the model.
+        # @param environment
+        #   Represents the use of a local environment to perform shell actions.
+        # @param status
+        #   The status of the shell call. One of `in_progress`, `completed`, or
+        #   `incomplete`.
+        # @param agent
+        #   The agent that produced this item.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param created_by
+        #   The ID of the entity that created this tool call.
+        # @param type
+        #   The type of the item. Always `shell_call`.
         def initialize: (
           id: String,
           action: OpenAI::Beta::BetaResponseFunctionShellToolCall::Action,
@@ -75,10 +108,16 @@ module OpenAI
         class Action < OpenAI::Internal::Type::BaseModel
           attr_accessor commands: ::Array[String]
 
+          # Optional maximum number of characters to return from each command.
           attr_accessor max_output_length: Integer?
 
+          # Optional timeout in milliseconds for the commands.
           attr_accessor timeout_ms: Integer?
 
+          # @param max_output_length
+          #   Optional maximum number of characters to return from each command.
+          # @param timeout_ms
+          #   Optional timeout in milliseconds for the commands.
           def initialize: (
             commands: ::Array[String],
             max_output_length: Integer?,
@@ -117,8 +156,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 }
@@ -144,10 +186,13 @@ module OpenAI
           type program = { caller_id: String, ?type: :program }
 
           class Program < OpenAI::Internal::Type::BaseModel
+            # The call ID of the program item that produced this tool call.
             attr_accessor caller_id: String
 
             attr_accessor type: :program
 
+            # @param caller_id
+            #   The call ID of the program item that produced this tool call.
             def initialize: (caller_id: String, ?type: :program) -> void
 
             def to_hash: -> { caller_id: String, ?type: :program }