openai 0.91.0 → 0.93.0

data/sig/openai/models/responses/response_created_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The response that was created.
         attr_accessor response: OpenAI::Responses::Response
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.created`.
         attr_accessor type: :"response.created"
 
+        # @param response
+        #   The response that was created.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param type
+        #   The type of the event. Always `response.created`.
         def initialize: (
           response: OpenAI::Responses::Response,
           sequence_number: Integer,

data/sig/openai/models/responses/response_custom_tool_call.rbs

@@ -14,28 +14,55 @@ module OpenAI
         }
 
       class ResponseCustomToolCall < OpenAI::Internal::Type::BaseModel
+        # An identifier used to map this custom tool call to a tool call output.
         attr_accessor call_id: String
 
+        # The input for the custom tool call generated by the model.
         attr_accessor input: String
 
+        # The name of the custom tool being called.
         attr_accessor name: String
 
+        # The type of the custom tool call. Always `custom_tool_call`.
         attr_accessor type: :custom_tool_call
 
+        # The unique ID of the custom tool call in the OpenAI platform.
         attr_reader id: String?
 
+        # The unique ID of the custom tool call in the OpenAI platform.
         def id=: (String) -> String
 
+        # Whether the custom tool call runs asynchronously.
         attr_reader async: bool?
 
+        # Whether the custom tool call runs asynchronously.
         def async=: (bool) -> bool
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseCustomToolCall::caller_?
 
+        # The namespace of the custom tool being called.
         attr_reader namespace: String?
 
+        # The namespace of the custom tool being called.
         def namespace=: (String) -> String
 
+        # @param call_id
+        #   An identifier used to map this custom tool call to a tool call output.
+        # @param input
+        #   The input for the custom tool call generated by the model.
+        # @param name
+        #   The name of the custom tool being called.
+        # @param id
+        #   The unique ID of the custom tool call in the OpenAI platform.
+        # @param async
+        #   Whether the custom tool call runs asynchronously.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param namespace
+        #   The namespace of the custom tool being called.
+        # @param type
+        #   The type of the custom tool call. Always `custom_tool_call`.
         def initialize: (
           call_id: String,
           input: String,
@@ -78,10 +105,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 }

data/sig/openai/models/responses/response_custom_tool_call_input_delta_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseCustomToolCallInputDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The incremental input data (delta) for the custom tool call.
         attr_accessor delta: String
 
+        # Unique identifier for the API item associated with this event.
         attr_accessor item_id: String
 
+        # The index of the output this delta applies to.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The event type identifier.
         attr_accessor type: :"response.custom_tool_call_input.delta"
 
+        # @param delta
+        #   The incremental input data (delta) for the custom tool call.
+        # @param item_id
+        #   Unique identifier for the API item associated with this event.
+        # @param output_index
+        #   The index of the output this delta applies to.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The event type identifier.
         def initialize: (
           delta: String,
           item_id: String,

data/sig/openai/models/responses/response_custom_tool_call_input_done_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseCustomToolCallInputDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The complete input data for the custom tool call.
         attr_accessor input: String
 
+        # Unique identifier for the API item associated with this event.
         attr_accessor item_id: String
 
+        # The index of the output this event applies to.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The event type identifier.
         attr_accessor type: :"response.custom_tool_call_input.done"
 
+        # @param input
+        #   The complete input data for the custom tool call.
+        # @param item_id
+        #   Unique identifier for the API item associated with this event.
+        # @param output_index
+        #   The index of the output this event applies to.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The event type identifier.
         def initialize: (
           input: String,
           item_id: String,

data/sig/openai/models/responses/response_custom_tool_call_item.rbs

@@ -16,20 +16,49 @@ module OpenAI
         }
 
       class ResponseCustomToolCallItem < OpenAI::Models::Responses::ResponseCustomToolCall
+        # The unique ID of the custom tool call item.
         def id: -> String
 
+        # The unique ID of the custom tool call item.
         def id=: (String _) -> String
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status: -> OpenAI::Models::Responses::ResponseCustomToolCallItem::status
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status=: (
           OpenAI::Models::Responses::ResponseCustomToolCallItem::status _
         ) -> OpenAI::Models::Responses::ResponseCustomToolCallItem::status
 
+        # The identifier of the actor that created the item.
         def created_by: -> String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String _) -> String
 
+        # @param call_id
+        #   An identifier used to map this custom tool call to a tool call output.
+        # @param input
+        #   The input for the custom tool call generated by the model.
+        # @param name
+        #   The name of the custom tool being called.
+        # @param id
+        #   The unique ID of the custom tool call item.
+        # @param status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        # @param async
+        #   Whether the custom tool call runs asynchronously.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param namespace
+        #   The namespace of the custom tool being called.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the custom tool call. Always `custom_tool_call`.
         def initialize: (
           call_id: String,
           input: String,

data/sig/openai/models/responses/response_custom_tool_call_output.rbs

@@ -11,18 +11,36 @@ module OpenAI
         }
 
       class ResponseCustomToolCallOutput < OpenAI::Internal::Type::BaseModel
+        # The call ID, used to map this custom tool call output to a custom tool call.
         attr_accessor call_id: String
 
+        # The output from the custom tool call generated by your code. Can be a string or
+        # an list of output content.
         attr_accessor output: OpenAI::Models::Responses::ResponseCustomToolCallOutput::output
 
+        # The type of the custom tool call output. Always `custom_tool_call_output`.
         attr_accessor type: :custom_tool_call_output
 
+        # The unique ID of the custom tool call output in the OpenAI platform.
         attr_reader id: String?
 
+        # The unique ID of the custom tool call output in the OpenAI platform.
         def id=: (String) -> String
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseCustomToolCallOutput::caller_?
 
+        # @param call_id
+        #   The call ID, used to map this custom tool call output to a custom tool call.
+        # @param output
+        #   The output from the custom tool call generated by your code. Can be a string or
+        #   an list of output content.
+        # @param id
+        #   The unique ID of the custom tool call output in the OpenAI platform.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param type
+        #   The type of the custom tool call output. Always `custom_tool_call_output`.
         def initialize: (
           call_id: String,
           output: OpenAI::Models::Responses::ResponseCustomToolCallOutput::output,
@@ -72,8 +90,11 @@ module OpenAI
           type direct = { ?type: :direct }
 
           class Direct < OpenAI::Internal::Type::BaseModel
+            # The caller type. Always `direct`.
             attr_accessor type: :direct
 
+            # @param type
+            #   The caller type. Always `direct`.
             def initialize: (?type: :direct) -> void
 
             def to_hash: -> { ?type: :direct }
@@ -82,10 +103,16 @@ 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
 
+            # The caller type. Always `program`.
             attr_accessor type: :program
 
+            # @param caller_id
+            #   The call ID of the program item that produced this tool call.
+            # @param type
+            #   The caller type. Always `program`.
             def initialize: (caller_id: String, ?type: :program) -> void
 
             def to_hash: -> { caller_id: String, ?type: :program }

data/sig/openai/models/responses/response_custom_tool_call_output_item.rbs

@@ -13,20 +13,44 @@ module OpenAI
         }
 
       class ResponseCustomToolCallOutputItem < OpenAI::Models::Responses::ResponseCustomToolCallOutput
+        # The unique ID of the custom tool call output item.
         def id: -> String
 
+        # The unique ID of the custom tool call output item.
         def id=: (String _) -> String
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status: -> OpenAI::Models::Responses::ResponseCustomToolCallOutputItem::status
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status=: (
           OpenAI::Models::Responses::ResponseCustomToolCallOutputItem::status _
         ) -> OpenAI::Models::Responses::ResponseCustomToolCallOutputItem::status
 
+        # The identifier of the actor that created the item.
         def created_by: -> String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String _) -> String
 
+        # @param call_id
+        #   The call ID, used to map this custom tool call output to a custom tool call.
+        # @param output
+        #   The output from the custom tool call generated by your code. Can be a string or
+        #   an list of output content.
+        # @param id
+        #   The unique ID of the custom tool call output item.
+        # @param status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the custom tool call output. Always `custom_tool_call_output`.
         def initialize: (
           call_id: String,
           output: OpenAI::Models::Responses::ResponseCustomToolCallOutput::output,

data/sig/openai/models/responses/response_error.rbs

@@ -9,8 +9,10 @@ module OpenAI
         }
 
       class ResponseError < OpenAI::Internal::Type::BaseModel
+        # The error code for the response.
         attr_accessor code: OpenAI::Models::Responses::ResponseError::code
 
+        # A human-readable description of the error.
         attr_accessor message: String
 
         attr_reader misalignment: OpenAI::Responses::ResponseError::Misalignment?
@@ -19,6 +21,10 @@ module OpenAI
           OpenAI::Responses::ResponseError::Misalignment
         ) -> OpenAI::Responses::ResponseError::Misalignment
 
+        # @param code
+        #   The error code for the response.
+        # @param message
+        #   A human-readable description of the error.
         def initialize: (
           code: OpenAI::Models::Responses::ResponseError::code,
           message: String,
@@ -90,22 +96,34 @@ module OpenAI
           }
 
         class Misalignment < OpenAI::Internal::Type::BaseModel
+          # The public explanation for this block.
           attr_reader detailed_explanation: String?
 
+          # The public explanation for this block.
           def detailed_explanation=: (String) -> String
 
+          # An optional classification; clients must accept additional values.
           attr_reader error_type: OpenAI::Models::Responses::ResponseError::Misalignment::error_type?
 
+          # An optional classification; clients must accept additional values.
           def error_type=: (
             OpenAI::Models::Responses::ResponseError::Misalignment::error_type
           ) -> OpenAI::Models::Responses::ResponseError::Misalignment::error_type
 
+          # An optional public continuation instruction.
           attr_reader steer: OpenAI::Responses::ResponseError::Misalignment::Steer?
 
+          # An optional public continuation instruction.
           def steer=: (
             OpenAI::Responses::ResponseError::Misalignment::Steer
           ) -> OpenAI::Responses::ResponseError::Misalignment::Steer
 
+          # @param detailed_explanation
+          #   The public explanation for this block.
+          # @param error_type
+          #   An optional classification; clients must accept additional values.
+          # @param steer
+          #   An optional public continuation instruction.
           def initialize: (
             ?detailed_explanation: String,
             ?error_type: OpenAI::Models::Responses::ResponseError::Misalignment::error_type,
@@ -139,8 +157,11 @@ module OpenAI
           type steer = { message: String }
 
           class Steer < OpenAI::Internal::Type::BaseModel
+            # The public continuation instruction.
             attr_accessor message: String
 
+            # @param message
+            #   The public continuation instruction.
             def initialize: (message: String) -> void
 
             def to_hash: -> { message: String }

data/sig/openai/models/responses/response_error_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseErrorEvent < OpenAI::Internal::Type::BaseModel
+        # The error code.
         attr_accessor code: String?
 
+        # The error message.
         attr_accessor message: String
 
+        # The error parameter.
         attr_accessor param: String?
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `error`.
         attr_accessor type: :error
 
+        # @param code
+        #   The error code.
+        # @param message
+        #   The error message.
+        # @param param
+        #   The error parameter.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always `error`.
         def initialize: (
           code: String?,
           message: String,

data/sig/openai/models/responses/response_failed_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseFailedEvent < OpenAI::Internal::Type::BaseModel
+        # The response that failed.
         attr_accessor response: OpenAI::Responses::Response
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.failed`.
         attr_accessor type: :"response.failed"
 
+        # @param response
+        #   The response that failed.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always `response.failed`.
         def initialize: (
           response: OpenAI::Responses::Response,
           sequence_number: Integer,

data/sig/openai/models/responses/response_file_search_call_completed_event.rbs

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseFileSearchCallCompletedEvent < 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"
 
+        # @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 type
+        #   The type of the event. Always `response.file_search_call.completed`.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_file_search_call_in_progress_event.rbs

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseFileSearchCallInProgressEvent < 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"
 
+        # @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 type
+        #   The type of the event. Always `response.file_search_call.in_progress`.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_file_search_call_searching_event.rbs

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseFileSearchCallSearchingEvent < 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"
 
+        # @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 type
+        #   The type of the event. Always `response.file_search_call.searching`.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_file_search_tool_call.rbs

@@ -11,16 +11,33 @@ module OpenAI
         }
 
       class ResponseFileSearchToolCall < 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::Responses::ResponseFileSearchToolCall::status
 
+        # The type of the file search tool call. Always `file_search_call`.
         attr_accessor type: :file_search_call
 
+        # The results of the file search tool call.
         attr_accessor results: ::Array[OpenAI::Responses::ResponseFileSearchToolCall::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 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,24 +79,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::Responses::ResponseFileSearchToolCall::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::Responses::ResponseFileSearchToolCall::Result::attribute]?,
             ?file_id: String,

data/sig/openai/models/responses/response_format_text_json_schema_config.rbs

@@ -11,18 +11,49 @@ module OpenAI
         }
 
       class ResponseFormatTextJSONSchemaConfig < 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],