openai 0.92.0 → 0.94.0

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

@@ -11,20 +11,41 @@ module OpenAI
         }
 
       class ResponseInputMessageItem < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the message input.
         attr_accessor id: String
 
+        # A list of one or many input items to the model, containing different content
+        # types.
         attr_accessor content: OpenAI::Models::Responses::response_input_message_content_list
 
+        # The role of the message input. One of `user`, `system`, or `developer`.
         attr_accessor role: OpenAI::Models::Responses::ResponseInputMessageItem::role
 
+        # The type of the message input. Always set to `message`.
         attr_accessor type: :message
 
+        # The status of item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         attr_reader status: OpenAI::Models::Responses::ResponseInputMessageItem::status?
 
+        # The status of item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status=: (
           OpenAI::Models::Responses::ResponseInputMessageItem::status
         ) -> OpenAI::Models::Responses::ResponseInputMessageItem::status
 
+        # @param id
+        #   The unique ID of the message input.
+        # @param content
+        #   A list of one or many input items to the model, containing different content
+        #   types.
+        # @param role
+        #   The role of the message input. One of `user`, `system`, or `developer`.
+        # @param status
+        #   The status of item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        # @param type
+        #   The type of the message input. Always set to `message`.
         def initialize: (
           id: String,
           content: OpenAI::Models::Responses::response_input_message_content_list,

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

@@ -9,16 +9,32 @@ module OpenAI
         }
 
       class ResponseInputText < OpenAI::Internal::Type::BaseModel
+        # The text input to the model.
         attr_accessor text: String
 
+        # The type of the input item. Always `input_text`.
         attr_accessor type: :input_text
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         attr_reader prompt_cache_breakpoint: OpenAI::Responses::ResponseInputText::PromptCacheBreakpoint?
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         def prompt_cache_breakpoint=: (
           OpenAI::Responses::ResponseInputText::PromptCacheBreakpoint
         ) -> OpenAI::Responses::ResponseInputText::PromptCacheBreakpoint
 
+        # @param text
+        #   The text input to the model.
+        # @param prompt_cache_breakpoint
+        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #   token block.
+        # @param type
+        #   The type of the input item. Always `input_text`.
         def initialize: (
           text: String,
           ?prompt_cache_breakpoint: OpenAI::Responses::ResponseInputText::PromptCacheBreakpoint,
@@ -34,8 +50,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }

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

@@ -9,12 +9,25 @@ module OpenAI
         }
 
       class ResponseInputTextContent < OpenAI::Internal::Type::BaseModel
+        # The text input to the model.
         attr_accessor text: String
 
+        # The type of the input item. Always `input_text`.
         attr_accessor type: :input_text
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         attr_accessor prompt_cache_breakpoint: OpenAI::Responses::ResponseInputTextContent::PromptCacheBreakpoint?
 
+        # @param text
+        #   The text input to the model.
+        # @param prompt_cache_breakpoint
+        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #   token block.
+        # @param type
+        #   The type of the input item. Always `input_text`.
         def initialize: (
           text: String,
           ?prompt_cache_breakpoint: OpenAI::Responses::ResponseInputTextContent::PromptCacheBreakpoint?,
@@ -30,8 +43,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }

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

@@ -45,14 +45,26 @@ module OpenAI
           }
 
         class AdditionalTools < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the additional tools item.
           attr_accessor id: String
 
+          # The role that provided the additional tools.
           attr_accessor role: OpenAI::Models::Responses::ResponseItem::AdditionalTools::role
 
+          # The additional tool definitions made available at this item.
           attr_accessor tools: ::Array[OpenAI::Models::Responses::tool]
 
+          # The type of the item. Always `additional_tools`.
           attr_accessor type: :additional_tools
 
+          # @param id
+          #   The unique ID of the additional tools item.
+          # @param role
+          #   The role that provided the additional tools.
+          # @param tools
+          #   The additional tool definitions made available at this item.
+          # @param type
+          #   The type of the item. Always `additional_tools`.
           def initialize: (
             id: String,
             role: OpenAI::Models::Responses::ResponseItem::AdditionalTools::role,
@@ -103,16 +115,31 @@ module OpenAI
           }
 
         class Program < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the program item.
           attr_accessor id: String
 
+          # The stable call ID of the program item.
           attr_accessor call_id: String
 
+          # The JavaScript source executed by programmatic tool calling.
           attr_accessor code: String
 
+          # Opaque program replay fingerprint that must be round-tripped.
           attr_accessor fingerprint: String
 
+          # The type of the item. Always `program`.
           attr_accessor type: :program
 
+          # @param id
+          #   The unique ID of the program item.
+          # @param call_id
+          #   The stable call ID of the program item.
+          # @param code
+          #   The JavaScript source executed by programmatic tool calling.
+          # @param fingerprint
+          #   Opaque program replay fingerprint that must be round-tripped.
+          # @param type
+          #   The type of the item. Always `program`.
           def initialize: (
             id: String,
             call_id: String,
@@ -140,16 +167,31 @@ module OpenAI
           }
 
         class ProgramOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the program output item.
           attr_accessor id: String
 
+          # The call ID of the program item.
           attr_accessor call_id: String
 
+          # The result produced by the program item.
           attr_accessor result: String
 
+          # The terminal status of the program output item.
           attr_accessor status: OpenAI::Models::Responses::ResponseItem::ProgramOutput::status
 
+          # The type of the item. Always `program_output`.
           attr_accessor type: :program_output
 
+          # @param id
+          #   The unique ID of the program output item.
+          # @param call_id
+          #   The call ID of the program item.
+          # @param result
+          #   The result produced by the program item.
+          # @param status
+          #   The terminal status of the program output item.
+          # @param type
+          #   The type of the item. Always `program_output`.
           def initialize: (
             id: String,
             call_id: String,
@@ -193,26 +235,58 @@ module OpenAI
           }
 
         class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the image generation call.
           attr_accessor id: String
 
+          # The generated image encoded in base64.
           attr_accessor result: String?
 
+          # The status of the image generation call.
           attr_accessor status: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::status
 
+          # The type of the image generation call. Always `image_generation_call`.
           attr_accessor type: :image_generation_call
 
+          # The action used for image generation.
           attr_accessor action: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::action?
 
+          # The background setting used for generation.
           attr_accessor background: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::background?
 
+          # The output format used for generation.
           attr_accessor output_format: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::output_format?
 
+          # The quality of the image generated by the image generation tool call. One of
+          # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           attr_accessor quality: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::quality?
 
+          # The prompt that was used after any model prompt rewriting.
           attr_accessor revised_prompt: String?
 
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           attr_accessor size: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size?
 
+          # @param id
+          #   The unique ID of the image generation call.
+          # @param result
+          #   The generated image encoded in base64.
+          # @param status
+          #   The status of the image generation call.
+          # @param action
+          #   The action used for image generation.
+          # @param background
+          #   The background setting used for generation.
+          # @param output_format
+          #   The output format used for generation.
+          # @param quality
+          #   The quality of the image generated by the image generation tool call. One of
+          #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          # @param revised_prompt
+          #   The prompt that was used after any model prompt rewriting.
+          # @param size
+          #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          # @param type
+          #   The type of the image generation call. Always `image_generation_call`.
           def initialize: (
             id: String,
             result: String?,
@@ -326,16 +400,31 @@ module OpenAI
           }
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the local shell call.
           attr_accessor id: String
 
+          # Execute a shell command on the server.
           attr_accessor action: OpenAI::Responses::ResponseItem::LocalShellCall::Action
 
+          # The unique ID of the local shell tool call generated by the model.
           attr_accessor call_id: String
 
+          # The status of the local shell call.
           attr_accessor status: OpenAI::Models::Responses::ResponseItem::LocalShellCall::status
 
+          # The type of the local shell call. Always `local_shell_call`.
           attr_accessor type: :local_shell_call
 
+          # @param id
+          #   The unique ID of the local shell call.
+          # @param action
+          #   Execute a shell command on the server.
+          # @param call_id
+          #   The unique ID of the local shell tool call generated by the model.
+          # @param status
+          #   The status of the local shell call.
+          # @param type
+          #   The type of the local shell call. Always `local_shell_call`.
           def initialize: (
             id: String,
             action: OpenAI::Responses::ResponseItem::LocalShellCall::Action,
@@ -363,18 +452,36 @@ module OpenAI
             }
 
           class Action < OpenAI::Internal::Type::BaseModel
+            # The command to run.
             attr_accessor command: ::Array[String]
 
+            # Environment variables to set for the command.
             attr_accessor env: ::Hash[Symbol, String]
 
+            # The type of the local shell action. Always `exec`.
             attr_accessor type: :exec
 
+            # Optional timeout in milliseconds for the command.
             attr_accessor timeout_ms: Integer?
 
+            # Optional user to run the command as.
             attr_accessor user: String?
 
+            # Optional working directory to run the command in.
             attr_accessor working_directory: String?
 
+            # @param command
+            #   The command to run.
+            # @param env
+            #   Environment variables to set for the command.
+            # @param timeout_ms
+            #   Optional timeout in milliseconds for the command.
+            # @param user
+            #   Optional user to run the command as.
+            # @param working_directory
+            #   Optional working directory to run the command in.
+            # @param type
+            #   The type of the local shell action. Always `exec`.
             def initialize: (
               command: ::Array[String],
               env: ::Hash[Symbol, String],
@@ -416,14 +523,26 @@ module OpenAI
           }
 
         class LocalShellCallOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the local shell tool call generated by the model.
           attr_accessor id: String
 
+          # A JSON string of the output of the local shell tool call.
           attr_accessor output: String
 
+          # The type of the local shell tool call output. Always `local_shell_call_output`.
           attr_accessor type: :local_shell_call_output
 
+          # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           attr_accessor status: OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput::status?
 
+          # @param id
+          #   The unique ID of the local shell tool call generated by the model.
+          # @param output
+          #   A JSON string of the output of the local shell tool call.
+          # @param status
+          #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          # @param type
+          #   The type of the local shell tool call output. Always `local_shell_call_output`.
           def initialize: (
             id: String,
             output: String,
@@ -461,16 +580,31 @@ module OpenAI
           }
 
         class McpListTools < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the list.
           attr_accessor id: String
 
+          # The label of the MCP server.
           attr_accessor server_label: String
 
+          # The tools available on the server.
           attr_accessor tools: ::Array[OpenAI::Responses::ResponseItem::McpListTools::Tool]
 
+          # The type of the item. Always `mcp_list_tools`.
           attr_accessor type: :mcp_list_tools
 
+          # Error message if the server could not list tools.
           attr_accessor error: String?
 
+          # @param id
+          #   The unique ID of the list.
+          # @param server_label
+          #   The label of the MCP server.
+          # @param tools
+          #   The tools available on the server.
+          # @param error
+          #   Error message if the server could not list tools.
+          # @param type
+          #   The type of the item. Always `mcp_list_tools`.
           def initialize: (
             id: String,
             server_label: String,
@@ -496,14 +630,26 @@ module OpenAI
             }
 
           class Tool < OpenAI::Internal::Type::BaseModel
+            # The JSON schema describing the tool's input.
             attr_accessor input_schema: top
 
+            # The name of the tool.
             attr_accessor name: String
 
+            # Additional annotations about the tool.
             attr_accessor annotations: top?
 
+            # The description of the tool.
             attr_accessor description: String?
 
+            # @param input_schema
+            #   The JSON schema describing the tool's input.
+            # @param name
+            #   The name of the tool.
+            # @param annotations
+            #   Additional annotations about the tool.
+            # @param description
+            #   The description of the tool.
             def initialize: (
               input_schema: top,
               name: String,
@@ -530,16 +676,31 @@ module OpenAI
           }
 
         class McpApprovalRequest < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the approval request.
           attr_accessor id: String
 
+          # A JSON string of arguments for the tool.
           attr_accessor arguments: String
 
+          # The name of the tool to run.
           attr_accessor name: String
 
+          # The label of the MCP server making the request.
           attr_accessor server_label: String
 
+          # The type of the item. Always `mcp_approval_request`.
           attr_accessor type: :mcp_approval_request
 
+          # @param id
+          #   The unique ID of the approval request.
+          # @param arguments
+          #   A JSON string of arguments for the tool.
+          # @param name
+          #   The name of the tool to run.
+          # @param server_label
+          #   The label of the MCP server making the request.
+          # @param type
+          #   The type of the item. Always `mcp_approval_request`.
           def initialize: (
             id: String,
             arguments: String,
@@ -567,16 +728,31 @@ module OpenAI
           }
 
         class McpApprovalResponse < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the approval response
           attr_accessor id: String
 
+          # The ID of the approval request being answered.
           attr_accessor approval_request_id: String
 
+          # Whether the request was approved.
           attr_accessor approve: bool
 
+          # The type of the item. Always `mcp_approval_response`.
           attr_accessor type: :mcp_approval_response
 
+          # Optional reason for the decision.
           attr_accessor reason: String?
 
+          # @param id
+          #   The unique ID of the approval response
+          # @param approval_request_id
+          #   The ID of the approval request being answered.
+          # @param approve
+          #   Whether the request was approved.
+          # @param reason
+          #   Optional reason for the decision.
+          # @param type
+          #   The type of the item. Always `mcp_approval_response`.
           def initialize: (
             id: String,
             approval_request_id: String,
@@ -608,28 +784,63 @@ module OpenAI
           }
 
         class McpCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the tool call.
           attr_accessor id: String
 
+          # A JSON string of the arguments passed to the tool.
           attr_accessor arguments: String
 
+          # The name of the tool that was run.
           attr_accessor name: String
 
+          # The label of the MCP server running the tool.
           attr_accessor server_label: String
 
+          # The type of the item. Always `mcp_call`.
           attr_accessor type: :mcp_call
 
+          # Unique identifier for the MCP tool call approval request. Include this value in
+          # a subsequent `mcp_approval_response` input to approve or reject the
+          # corresponding tool call.
           attr_accessor approval_request_id: String?
 
+          # The error from the tool call, if any.
           attr_accessor error: OpenAI::Models::Responses::mcp_tool_call_error?
 
+          # The output from the tool call.
           attr_accessor output: String?
 
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
           attr_reader status: OpenAI::Models::Responses::ResponseItem::McpCall::status?
 
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
           def status=: (
             OpenAI::Models::Responses::ResponseItem::McpCall::status
           ) -> OpenAI::Models::Responses::ResponseItem::McpCall::status
 
+          # @param id
+          #   The unique ID of the tool call.
+          # @param arguments
+          #   A JSON string of the arguments passed to the tool.
+          # @param name
+          #   The name of the tool that was run.
+          # @param server_label
+          #   The label of the MCP server running the tool.
+          # @param approval_request_id
+          #   Unique identifier for the MCP tool call approval request. Include this value in
+          #   a subsequent `mcp_approval_response` input to approve or reject the
+          #   corresponding tool call.
+          # @param error
+          #   The error from the tool call, if any.
+          # @param output
+          #   The output from the tool call.
+          # @param status
+          #   The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          #   `calling`, or `failed`.
+          # @param type
+          #   The type of the item. Always `mcp_call`.
           def initialize: (
             id: String,
             arguments: String,

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

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class ResponseItemList < OpenAI::Internal::Type::BaseModel
+        # A list of items used to generate this response.
         attr_accessor data: ::Array[OpenAI::Models::Responses::response_item]
 
+        # The ID of the first item in the list.
         attr_accessor first_id: String
 
+        # Whether there are more items available.
         attr_accessor has_more: bool
 
+        # The ID of the last item in the list.
         attr_accessor last_id: String
 
+        # The type of object returned, must be `list`.
         attr_accessor object: :list
 
+        # @param data
+        #   A list of items used to generate this response.
+        # @param first_id
+        #   The ID of the first item in the list.
+        # @param has_more
+        #   Whether there are more items available.
+        # @param last_id
+        #   The ID of the last item in the list.
+        # @param object
+        #   The type of object returned, must be `list`.
         def initialize: (
           data: ::Array[OpenAI::Models::Responses::response_item],
           first_id: String,

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

@@ -4,8 +4,11 @@ module OpenAI
       type response_local_environment = { ?type: :local }
 
       class ResponseLocalEnvironment < OpenAI::Internal::Type::BaseModel
+        # The environment type. Always `local`.
         attr_accessor type: :local
 
+        # @param type
+        #   The environment type. Always `local`.
         def initialize: (?type: :local) -> void
 
         def to_hash: -> { ?type: :local }

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

@@ -11,16 +11,33 @@ module OpenAI
         }
 
       class ResponseMcpCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # A JSON string containing the partial update to the arguments for the MCP tool
+        # call.
         attr_accessor delta: String
 
+        # The unique identifier of the MCP tool call item being processed.
         attr_accessor item_id: String
 
+        # The index of the output item in the response's output array.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.mcp_call_arguments.delta'.
         attr_accessor type: :"response.mcp_call_arguments.delta"
 
+        # @param delta
+        #   A JSON string containing the partial update to the arguments for the MCP tool
+        #   call.
+        # @param item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        # @param output_index
+        #   The index of the output item in the response's output array.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always 'response.mcp_call_arguments.delta'.
         def initialize: (
           delta: String,
           item_id: String,

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseMcpCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
+        # A JSON string containing the finalized arguments for the MCP tool call.
         attr_accessor arguments: String
 
+        # The unique identifier of the MCP tool call item being processed.
         attr_accessor item_id: String
 
+        # The index of the output item in the response's output array.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.mcp_call_arguments.done'.
         attr_accessor type: :"response.mcp_call_arguments.done"
 
+        # @param arguments
+        #   A JSON string containing the finalized arguments for the MCP tool call.
+        # @param item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        # @param output_index
+        #   The index of the output item in the response's output array.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always 'response.mcp_call_arguments.done'.
         def initialize: (
           arguments: String,
           item_id: String,