openai 0.91.0 → 0.93.0

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

@@ -11,18 +11,37 @@ module OpenAI
         }
 
       class ResponseSteerFailedEvent < OpenAI::Internal::Type::BaseModel
+        # Information about why the input could not be committed.
         attr_accessor error: OpenAI::Responses::ResponseSteerFailedEvent::Error
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The steering submission that could not be committed.
         attr_accessor steer: OpenAI::Responses::ResponseSteerFailedEvent::Steer
 
+        # The event discriminator. Always `response.steer.failed`.
         attr_accessor type: :"response.steer.failed"
 
+        # The WebSocket lane that emitted this event, when the target response is
+        # available and its `response.create` event supplied a `stream_id`.
         attr_reader stream_id: String?
 
+        # The WebSocket lane that emitted this event, when the target response is
+        # available and its `response.create` event supplied a `stream_id`.
         def stream_id=: (String) -> String
 
+        # @param error
+        #   Information about why the input could not be committed.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param steer
+        #   The steering submission that could not be committed.
+        # @param stream_id
+        #   The WebSocket lane that emitted this event, when the target response is
+        #   available and its `response.create` event supplied a `stream_id`.
+        # @param type
+        #   The event discriminator. Always `response.steer.failed`.
         def initialize: (
           error: OpenAI::Responses::ResponseSteerFailedEvent::Error,
           sequence_number: Integer,
@@ -47,12 +66,45 @@ module OpenAI
           }
 
         class Error < OpenAI::Internal::Type::BaseModel
+          # A machine-readable steering error code. Clients should handle unknown values
+          # because additional codes may be introduced. Known values include:
+          #
+          # - `response_not_found`: The target response is not available on this connection.
+          # - `invalid_input`: The event or input failed validation.
+          # - `steering_not_supported`: The model or response execution mode does not
+          #   support steering.
+          # - `too_many_pending_steers`: Too much steering input is pending for the
+          #   response.
+          # - `response_already_completed`: The response completed and is no longer
+          #   accepting steering input.
+          # - `response_not_active`: The response is no longer accepting steering input.
+          # - `successor_creation_failed`: The successor response could not be created.
           attr_accessor code: OpenAI::Models::Responses::response_steer_error_code
 
+          # A human-readable description of the error.
           attr_accessor message: String
 
+          # The error type. Always `invalid_request_error`.
           attr_accessor type: :invalid_request_error
 
+          # @param code
+          #   A machine-readable steering error code. Clients should handle unknown values
+          #   because additional codes may be introduced. Known values include:
+          #
+          #   - `response_not_found`: The target response is not available on this connection.
+          #   - `invalid_input`: The event or input failed validation.
+          #   - `steering_not_supported`: The model or response execution mode does not
+          #     support steering.
+          #   - `too_many_pending_steers`: Too much steering input is pending for the
+          #     response.
+          #   - `response_already_completed`: The response completed and is no longer
+          #     accepting steering input.
+          #   - `response_not_active`: The response is no longer accepting steering input.
+          #   - `successor_creation_failed`: The successor response could not be created.
+          # @param message
+          #   A human-readable description of the error.
+          # @param type
+          #   The error type. Always `invalid_request_error`.
           def initialize: (
             code: OpenAI::Models::Responses::response_steer_error_code,
             message: String,
@@ -74,14 +126,40 @@ module OpenAI
           }
 
         class Steer < OpenAI::Internal::Type::BaseModel
+          # Input to queue for a continuation of the response. Uses the same string or
+          # input-item shape as `response.create.input`, with a non-empty array when
+          # supplying input items.
+          #
+          # Steering accepts only messages with the `user` role. Each message may contain
+          # only `type`, `role`, and `content`, with `content` as a string or an array of
+          # `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
+          # `message`. Other roles, tool outputs, and item types are not supported for
+          # steering.
           attr_accessor input: OpenAI::Models::Responses::response_steer_input
 
+          # The ID of the response that was targeted for steering.
           attr_accessor previous_response_id: String
 
+          # The ID assigned to the steering submission, if one was allocated.
           attr_reader id: String?
 
+          # The ID assigned to the steering submission, if one was allocated.
           def id=: (String) -> String
 
+          # @param input
+          #   Input to queue for a continuation of the response. Uses the same string or
+          #   input-item shape as `response.create.input`, with a non-empty array when
+          #   supplying input items.
+          #
+          #   Steering accepts only messages with the `user` role. Each message may contain
+          #   only `type`, `role`, and `content`, with `content` as a string or an array of
+          #   `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
+          #   `message`. Other roles, tool outputs, and item types are not supported for
+          #   steering.
+          # @param previous_response_id
+          #   The ID of the response that was targeted for steering.
+          # @param id
+          #   The ID assigned to the steering submission, if one was allocated.
           def initialize: (
             input: OpenAI::Models::Responses::response_steer_input,
             previous_response_id: String,

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

@@ -25,16 +25,31 @@ module OpenAI
             }
 
           class Message < OpenAI::Internal::Type::BaseModel
+            # The message content, as an array of content parts.
             attr_accessor content: OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::Message::content
 
+            # The message role. Always `user`.
             attr_accessor role: :user
 
+            # The item type. Always `message`.
             attr_accessor type: :message
 
+            # The unique ID of this message item.
             attr_accessor id: String?
 
+            # The status of the message item.
             attr_accessor status: String?
 
+            # @param content
+            #   The message content, as an array of content parts.
+            # @param id
+            #   The unique ID of this message item.
+            # @param status
+            #   The status of the message item.
+            # @param role
+            #   The message role. Always `user`.
+            # @param type
+            #   The item type. Always `message`.
             def initialize: (
               content: OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::Message::content,
               ?id: String?,
@@ -77,22 +92,50 @@ module OpenAI
             }
 
           class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
+            # Text, image, or file output of the function tool call.
             attr_accessor output: OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::output
 
+            # The type of the function tool call output. Always `function_call_output`.
             attr_accessor type: :function_call_output
 
+            # The unique ID of the function tool call output. Populated when this item is
+            # returned via API.
             attr_accessor id: String?
 
+            # The unique ID of the function tool call generated by the model.
             attr_accessor call_id: String?
 
+            # The execution context that produced this tool call.
             attr_accessor caller_: OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::caller_?
 
+            # The name of the tool that produced the output.
             attr_accessor name: String?
 
+            # The namespace of the tool that produced the output.
             attr_accessor namespace: String?
 
+            # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+            # Populated when items are returned via API.
             attr_accessor status: OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::status?
 
+            # @param output
+            #   Text, image, or file output of the function tool call.
+            # @param id
+            #   The unique ID of the function tool call output. Populated when this item is
+            #   returned via API.
+            # @param call_id
+            #   The unique ID of the function tool call generated by the model.
+            # @param caller_
+            #   The execution context that produced this tool call.
+            # @param name
+            #   The name of the tool that produced the output.
+            # @param namespace
+            #   The namespace of the tool that produced the output.
+            # @param status
+            #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+            #   Populated when items are returned via API.
+            # @param type
+            #   The type of the function tool call output. Always `function_call_output`.
             def initialize: (
               output: OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::output,
               ?id: String?,
@@ -135,8 +178,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 }
@@ -145,10 +191,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_steer_pending_event.rbs

@@ -12,20 +12,56 @@ module OpenAI
         }
 
       class ResponseSteerPendingEvent < OpenAI::Internal::Type::BaseModel
+        # An extensible enum describing why accepted steering input is still queued.
+        # Clients should handle unknown values because additional reasons may be
+        # introduced. Known values include:
+        #
+        # - `waiting_for_required_input`: The response is waiting for the tool results or
+        #   approval decisions identified by `required_input`.
         attr_accessor reason: OpenAI::Models::Responses::response_steer_pending_reason
 
+        # Input stubs identifying outstanding client-owned tool results or approval
+        # decisions. Each stub contains identifying fields only; the client supplies the
+        # result before including it in `response.create`.
         attr_accessor required_input: ::Array[OpenAI::Models::Responses::response_steer_required_input]
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The steering submission that remains queued.
         attr_accessor steer: OpenAI::Responses::ResponseSteerPendingEvent::Steer
 
+        # The event discriminator. Always `response.steer.pending`.
         attr_accessor type: :"response.steer.pending"
 
+        # The WebSocket lane that emitted this event. This field is present when the
+        # target response's `response.create` event supplied a `stream_id`.
         attr_reader stream_id: String?
 
+        # The WebSocket lane that emitted this event. This field is present when the
+        # target response's `response.create` event supplied a `stream_id`.
         def stream_id=: (String) -> String
 
+        # @param reason
+        #   An extensible enum describing why accepted steering input is still queued.
+        #   Clients should handle unknown values because additional reasons may be
+        #   introduced. Known values include:
+        #
+        #   - `waiting_for_required_input`: The response is waiting for the tool results or
+        #     approval decisions identified by `required_input`.
+        # @param required_input
+        #   Input stubs identifying outstanding client-owned tool results or approval
+        #   decisions. Each stub contains identifying fields only; the client supplies the
+        #   result before including it in `response.create`.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param steer
+        #   The steering submission that remains queued.
+        # @param stream_id
+        #   The WebSocket lane that emitted this event. This field is present when the
+        #   target response's `response.create` event supplied a `stream_id`.
+        # @param type
+        #   The event discriminator. Always `response.steer.pending`.
         def initialize: (
           reason: OpenAI::Models::Responses::response_steer_pending_reason,
           required_input: ::Array[OpenAI::Models::Responses::response_steer_required_input],
@@ -47,10 +83,16 @@ module OpenAI
         type steer = { id: String, previous_response_id: String }
 
         class Steer < OpenAI::Internal::Type::BaseModel
+          # The ID assigned to the steering submission.
           attr_accessor id: String
 
+          # The ID of the response being steered.
           attr_accessor previous_response_id: String
 
+          # @param id
+          #   The ID assigned to the steering submission.
+          # @param previous_response_id
+          #   The ID of the response being steered.
           def initialize: (id: String, previous_response_id: String) -> void
 
           def to_hash: -> { id: String, previous_response_id: String }

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

@@ -8,14 +8,63 @@ module OpenAI
         }
 
       class ResponseTextConfig < 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::Responses::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::Responses::response_format_text_config
         ) -> OpenAI::Models::Responses::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::Responses::ResponseTextConfig::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::Responses::response_format_text_config,
           ?verbosity: OpenAI::Models::Responses::ResponseTextConfig::verbosity?

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseTextDeltaEvent < 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::Responses::ResponseTextDeltaEvent::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"
 
+        # @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 type
+        #   The type of the event. Always `response.output_text.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,
@@ -55,16 +76,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::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob]?
 
+          # The log probabilities of up to 20 of the most likely tokens.
           def top_logprobs=: (
             ::Array[OpenAI::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob]
           ) -> ::Array[OpenAI::Responses::ResponseTextDeltaEvent::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,
@@ -80,14 +111,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 }

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseTextDoneEvent < 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::Responses::ResponseTextDoneEvent::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"
 
+        # @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 type
+        #   The type of the event. Always `response.output_text.done`.
         def initialize: (
           content_index: Integer,
           item_id: String,
@@ -55,16 +76,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::Responses::ResponseTextDoneEvent::Logprob::TopLogprob]?
 
+          # The log probabilities of up to 20 of the most likely tokens.
           def top_logprobs=: (
             ::Array[OpenAI::Responses::ResponseTextDoneEvent::Logprob::TopLogprob]
           ) -> ::Array[OpenAI::Responses::ResponseTextDoneEvent::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,
@@ -80,14 +111,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 }

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

@@ -13,22 +13,44 @@ module OpenAI
         }
 
       class ResponseToolSearchCall < 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::Responses::ResponseToolSearchCall::execution
 
+        # The status of the tool search call item that was recorded.
         attr_accessor status: OpenAI::Models::Responses::ResponseToolSearchCall::status
 
+        # The type of the item. Always `tool_search_call`.
         attr_accessor type: :tool_search_call
 
+        # 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 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,

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

@@ -13,22 +13,44 @@ module OpenAI
         }
 
       class ResponseToolSearchOutputItem < 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::Responses::ResponseToolSearchOutputItem::execution
 
+        # The status of the tool search output item that was recorded.
         attr_accessor status: OpenAI::Models::Responses::ResponseToolSearchOutputItem::status
 
+        # The loaded tool definitions returned by tool search.
         attr_accessor tools: ::Array[OpenAI::Models::Responses::tool]
 
+        # The type of the item. Always `tool_search_output`.
         attr_accessor type: :tool_search_output
 
+        # 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 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?,