openai 0.92.0 → 0.94.0

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseFunctionCallArgumentsDeltaEvent < 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"
 
+        # @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 type
+        #   The type of the event. Always `response.function_call_arguments.delta`.
         def initialize: (
           delta: String,
           item_id: String,

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

@@ -11,16 +11,28 @@ module OpenAI
         }
 
       class ResponseFunctionCallArgumentsDoneEvent < 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"
 
+        # @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.
         def initialize: (
           arguments: String,
           item_id: String,

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseFunctionShellCallOutputContent < OpenAI::Internal::Type::BaseModel
+        # The exit or timeout outcome associated with this shell call.
         attr_accessor outcome: OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent::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::Responses::ResponseFunctionShellCallOutputContent::outcome,
           stderr: String,
@@ -37,8 +46,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 }
@@ -47,10 +59,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/responses/response_function_shell_tool_call.rbs

@@ -14,24 +14,53 @@ module OpenAI
         }
 
       class ResponseFunctionShellToolCall < 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::Responses::ResponseFunctionShellToolCall::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::Responses::ResponseFunctionShellToolCall::environment?
 
+        # The status of the shell call. One of `in_progress`, `completed`, or
+        # `incomplete`.
         attr_accessor status: OpenAI::Models::Responses::ResponseFunctionShellToolCall::status
 
+        # The type of the item. Always `shell_call`.
         attr_accessor type: :shell_call
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseFunctionShellToolCall::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 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::Responses::ResponseFunctionShellToolCall::Action,
@@ -64,10 +93,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?,
@@ -123,10 +158,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_function_shell_tool_call_output.rbs

@@ -14,24 +14,55 @@ module OpenAI
         }
 
       class ResponseFunctionShellToolCallOutput < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the shell call output. Populated when this item is returned via
+        # API.
         attr_accessor id: String
 
+        # The unique ID of the shell tool call generated by the model.
         attr_accessor call_id: String
 
+        # The maximum length of the shell command output. This is generated by the model
+        # and should be passed back with the raw output.
         attr_accessor max_output_length: Integer?
 
+        # An array of shell call output contents
         attr_accessor output: ::Array[OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output]
 
+        # The status of the shell call output. One of `in_progress`, `completed`, or
+        # `incomplete`.
         attr_accessor status: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::status
 
+        # The type of the shell call output. Always `shell_call_output`.
         attr_accessor type: :shell_call_output
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::caller_?
 
+        # 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 shell call output. Populated when this item is returned via
+        #   API.
+        # @param call_id
+        #   The unique ID of the shell tool call generated by the model.
+        # @param max_output_length
+        #   The maximum length of the shell command output. This is generated by the model
+        #   and should be passed back with the raw output.
+        # @param output
+        #   An array of shell call output contents
+        # @param status
+        #   The status of the shell call output. One of `in_progress`, `completed`, or
+        #   `incomplete`.
+        # @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 shell call output. Always `shell_call_output`.
         def initialize: (
           id: String,
           call_id: String,
@@ -63,16 +94,31 @@ module OpenAI
           }
 
         class Output < OpenAI::Internal::Type::BaseModel
+          # Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          # shell call output chunk.
           attr_accessor outcome: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Output::outcome
 
+          # The standard error output that was captured.
           attr_accessor stderr: String
 
+          # The standard output that was captured.
           attr_accessor stdout: String
 
+          # 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 outcome
+          #   Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          #   shell call output chunk.
+          # @param stderr
+          #   The standard error output that was captured.
+          # @param stdout
+          #   The standard output that was captured.
+          # @param created_by
+          #   The identifier of the actor that created the item.
           def initialize: (
             outcome: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Output::outcome,
             stderr: String,
@@ -97,8 +143,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 }
@@ -107,10 +156,16 @@ module OpenAI
             type exit_ = { exit_code: Integer, ?type: :exit }
 
             class Exit < OpenAI::Internal::Type::BaseModel
+              # Exit code from the shell process.
               attr_accessor exit_code: Integer
 
+              # The outcome type. Always `exit`.
               attr_accessor type: :exit
 
+              # @param exit_code
+              #   Exit code from 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 }
@@ -152,10 +207,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_function_tool_call.rbs

@@ -15,34 +15,68 @@ module OpenAI
         }
 
       class ResponseFunctionToolCall < OpenAI::Internal::Type::BaseModel
+        # A JSON string of the arguments to pass to the function.
         attr_accessor arguments: String
 
+        # The unique ID of the function tool call generated by the model.
         attr_accessor call_id: String
 
+        # The name of the function to run.
         attr_accessor name: String
 
+        # The type of the function tool call. Always `function_call`.
         attr_accessor type: :function_call
 
+        # The unique ID of the function tool call.
         attr_reader id: String?
 
+        # The unique ID of the function tool call.
         def id=: (String) -> String
 
+        # Whether the function tool call runs asynchronously.
         attr_reader async: bool?
 
+        # Whether the function tool call runs asynchronously.
         def async=: (bool) -> bool
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseFunctionToolCall::caller_?
 
+        # The namespace of the function to run.
         attr_reader namespace: String?
 
+        # The namespace of the function to run.
         def namespace=: (String) -> String
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         attr_reader status: OpenAI::Models::Responses::ResponseFunctionToolCall::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::ResponseFunctionToolCall::status
         ) -> OpenAI::Models::Responses::ResponseFunctionToolCall::status
 
+        # @param arguments
+        #   A JSON string of the arguments to pass to the function.
+        # @param call_id
+        #   The unique ID of the function tool call generated by the model.
+        # @param name
+        #   The name of the function to run.
+        # @param id
+        #   The unique ID of the function tool call.
+        # @param async
+        #   Whether the function tool call runs asynchronously.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param namespace
+        #   The namespace of the function to run.
+        # @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. Always `function_call`.
         def initialize: (
           arguments: String,
           call_id: String,
@@ -87,10 +121,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_function_tool_call_item.rbs

@@ -16,20 +16,49 @@ module OpenAI
         }
 
       class ResponseFunctionToolCallItem < OpenAI::Models::Responses::ResponseFunctionToolCall
+        # The unique ID of the function tool call.
         def id: -> String
 
+        # The unique ID of the function tool call.
         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::ResponseFunctionToolCallItem::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::ResponseFunctionToolCallItem::status _
         ) -> OpenAI::Models::Responses::ResponseFunctionToolCallItem::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 arguments
+        #   A JSON string of the arguments to pass to the function.
+        # @param call_id
+        #   The unique ID of the function tool call generated by the model.
+        # @param name
+        #   The name of the function to run.
+        # @param id
+        #   The unique ID of the function tool call.
+        # @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 function tool call runs asynchronously.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param namespace
+        #   The namespace of the function to run.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the function tool call. Always `function_call`.
         def initialize: (
           arguments: String,
           call_id: String,

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

@@ -15,32 +15,67 @@ module OpenAI
         }
 
       class ResponseFunctionToolCallOutputItem < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the function call tool output.
         attr_accessor id: String
 
+        # The output from the function call generated by your code. Can be a string or an
+        # list of output content.
         attr_accessor output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output
 
+        # 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::ResponseFunctionToolCallOutputItem::status
 
+        # 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 generated by the model.
         attr_reader call_id: String?
 
+        # The unique ID of the function tool call generated by the model.
         def call_id=: (String) -> String
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::caller_?
 
+        # 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
 
+        # The name of the tool that produced the output.
         attr_reader name: String?
 
+        # The name of the tool that produced the output.
         def name=: (String) -> String
 
+        # The namespace of the tool that produced the output.
         attr_reader namespace: String?
 
+        # The namespace of the tool that produced the output.
         def namespace=: (String) -> String
 
+        # @param id
+        #   The unique ID of the function call tool output.
+        # @param output
+        #   The output from the function call generated by your code. Can be a string or an
+        #   list of output content.
+        # @param status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are 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 created_by
+        #   The identifier of the actor that created the item.
+        # @param name
+        #   The name of the tool that produced the output.
+        # @param namespace
+        #   The namespace of the tool that produced the output.
+        # @param type
+        #   The type of the function tool call output. Always `function_call_output`.
         def initialize: (
           id: String,
           output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output,
@@ -110,8 +145,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 }
@@ -120,10 +158,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_function_web_search.rbs

@@ -10,14 +10,28 @@ module OpenAI
         }
 
       class ResponseFunctionWebSearch < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the web search tool call.
         attr_accessor id: String
 
+        # An object describing the specific action taken in this web search call. Includes
+        # details on how the model used the web (search, open_page, find_in_page).
         attr_accessor action: OpenAI::Models::Responses::ResponseFunctionWebSearch::action
 
+        # The status of the web search tool call.
         attr_accessor status: OpenAI::Models::Responses::ResponseFunctionWebSearch::status
 
+        # The type of the web search tool call. Always `web_search_call`.
         attr_accessor type: :web_search_call
 
+        # @param id
+        #   The unique ID of the web search tool call.
+        # @param action
+        #   An object describing the specific action taken in this web search call. Includes
+        #   details on how the model used the web (search, open_page, find_in_page).
+        # @param status
+        #   The status of the web search tool call.
+        # @param type
+        #   The type of the web search tool call. Always `web_search_call`.
         def initialize: (
           id: String,
           action: OpenAI::Models::Responses::ResponseFunctionWebSearch::action,
@@ -49,22 +63,37 @@ module OpenAI
             }
 
           class Search < OpenAI::Internal::Type::BaseModel
+            # The action type.
             attr_accessor type: :search
 
+            # The search queries.
             attr_reader queries: ::Array[String]?
 
+            # The search queries.
             def queries=: (::Array[String]) -> ::Array[String]
 
+            # The search query.
             attr_reader query: String?
 
+            # The search query.
             def query=: (String) -> String
 
+            # The sources used in the search.
             attr_reader sources: ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source]?
 
+            # The sources used in the search.
             def sources=: (
               ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source]
             ) -> ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source]
 
+            # @param queries
+            #   The search queries.
+            # @param query
+            #   The search query.
+            # @param sources
+            #   The sources used in the search.
+            # @param type
+            #   The action type.
             def initialize: (
               ?queries: ::Array[String],
               ?query: String,
@@ -82,10 +111,16 @@ module OpenAI
             type source = { ?type: :url, url: String }
 
             class Source < OpenAI::Internal::Type::BaseModel
+              # The type of source. Always `url`.
               attr_accessor type: :url
 
+              # The URL of the source.
               attr_accessor url: String
 
+              # @param url
+              #   The URL of the source.
+              # @param type
+              #   The type of source. Always `url`.
               def initialize: (url: String, ?type: :url) -> void
 
               def to_hash: -> { ?type: :url, url: String }
@@ -95,10 +130,16 @@ module OpenAI
           type open_page = { ?type: :open_page, ?url: String? }
 
           class OpenPage < OpenAI::Internal::Type::BaseModel
+            # The action type.
             attr_accessor type: :open_page
 
+            # The URL opened by the model.
             attr_accessor url: String?
 
+            # @param url
+            #   The URL opened by the model.
+            # @param type
+            #   The action type.
             def initialize: (?url: String?, ?type: :open_page) -> void
 
             def to_hash: -> { ?type: :open_page, ?url: String? }
@@ -108,12 +149,21 @@ module OpenAI
             { pattern: String, ?type: :find_in_page, url: String }
 
           class Find < OpenAI::Internal::Type::BaseModel
+            # The pattern or text to search for within the page.
             attr_accessor pattern: String
 
+            # The action type.
             attr_accessor type: :find_in_page
 
+            # The URL of the page searched for the pattern.
             attr_accessor url: String
 
+            # @param pattern
+            #   The pattern or text to search for within the page.
+            # @param url
+            #   The URL of the page searched for the pattern.
+            # @param type
+            #   The action type.
             def initialize: (
               pattern: String,
               url: String,