RubyGems - openai - Versions diffs - 0.92.0 → 0.94.0 - Mend

openai 0.92.0 → 0.94.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1311) hide show

data/sig/openai/models/conversations/conversation_item.rbs CHANGED Viewed

@@ -52,26 +52,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::Conversations::ConversationItem::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::Conversations::ConversationItem::ImageGenerationCall::action?
+          # The background setting used for generation.
           attr_accessor background: OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::background?
+          # The output format used for generation.
           attr_accessor output_format: OpenAI::Models::Conversations::ConversationItem::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::Conversations::ConversationItem::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::Conversations::ConversationItem::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?,
@@ -184,14 +216,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::Conversations::ConversationItem::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::Conversations::ConversationItem::AdditionalTools::role,
@@ -242,16 +286,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,
@@ -279,16 +338,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::Conversations::ConversationItem::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,
@@ -327,16 +401,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::Conversations::ConversationItem::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::Conversations::ConversationItem::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::Conversations::ConversationItem::LocalShellCall::Action,
@@ -364,18 +453,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],
@@ -417,14 +524,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::Conversations::ConversationItem::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,
@@ -462,16 +581,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::Conversations::ConversationItem::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,
@@ -497,14 +631,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,
@@ -531,16 +677,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,
@@ -568,16 +729,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,
@@ -609,28 +785,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::Conversations::ConversationItem::McpCall::status?
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
           def status=: (
             OpenAI::Models::Conversations::ConversationItem::McpCall::status
           ) -> OpenAI::Models::Conversations::ConversationItem::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/conversations/conversation_item_list.rbs CHANGED Viewed

@@ -13,16 +13,31 @@ module OpenAI
         }
       class ConversationItemList < OpenAI::Internal::Type::BaseModel
+        # A list of conversation items.
         attr_accessor data: ::Array[OpenAI::Models::Conversations::conversation_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 conversation items.
+        # @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::Conversations::conversation_item],
           first_id: String,

data/sig/openai/models/conversations/conversation_update_params.rbs CHANGED Viewed

@@ -14,8 +14,19 @@ module OpenAI
         attr_accessor conversation_id: String
+        # 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.
         attr_accessor metadata: OpenAI::Models::metadata?
+        # @param metadata
+        #   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.
         def initialize: (
           conversation_id: String,
           metadata: OpenAI::Models::metadata?,

data/sig/openai/models/conversations/item_create_params.rbs CHANGED Viewed

@@ -15,14 +15,27 @@ module OpenAI
         attr_accessor conversation_id: String
+        # The items to add to the conversation. You may add up to 20 items at a time.
         attr_accessor items: ::Array[OpenAI::Models::Responses::response_input_item]
+        # Additional fields to include in the response. See the `include` parameter for
+        # [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        # for more information.
         attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
+        # Additional fields to include in the response. See the `include` parameter for
+        # [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        # for more information.
         def include=: (
           ::Array[OpenAI::Models::Responses::response_includable]
         ) -> ::Array[OpenAI::Models::Responses::response_includable]
+        # @param items
+        #   The items to add to the conversation. You may add up to 20 items at a time.
+        # @param include
+        #   Additional fields to include in the response. See the `include` parameter for
+        #   [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        #   for more information.
         def initialize: (
           conversation_id: String,
           items: ::Array[OpenAI::Models::Responses::response_input_item],

data/sig/openai/models/conversations/item_list_params.rbs CHANGED Viewed

@@ -17,26 +17,105 @@ module OpenAI
         attr_accessor conversation_id: String
+        # An item ID to list items after, used in pagination.
         attr_reader after: String?
+        # An item ID to list items after, used in pagination.
         def after=: (String) -> String
+        # Specify additional output data to include in the model response. Currently
+        # supported values are:
+        #
+        # - `web_search_call.action.sources`: Include the sources of the web search tool
+        #   call.
+        # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #   in code interpreter tool call items.
+        # - `computer_call_output.output.image_url`: Include image urls from the computer
+        #   call output.
+        # - `file_search_call.results`: Include the search results of the file search tool
+        #   call.
+        # - `message.input_image.image_url`: Include image urls from the input message.
+        # - `message.output_text.logprobs`: Include logprobs with assistant messages.
+        # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+        #   tokens in reasoning item outputs. This enables reasoning items to be used in
+        #   multi-turn conversations when using the Responses API statelessly (like when
+        #   the `store` parameter is set to `false`, or when an organization is enrolled
+        #   in the zero data retention program).
         attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
+        # Specify additional output data to include in the model response. Currently
+        # supported values are:
+        #
+        # - `web_search_call.action.sources`: Include the sources of the web search tool
+        #   call.
+        # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #   in code interpreter tool call items.
+        # - `computer_call_output.output.image_url`: Include image urls from the computer
+        #   call output.
+        # - `file_search_call.results`: Include the search results of the file search tool
+        #   call.
+        # - `message.input_image.image_url`: Include image urls from the input message.
+        # - `message.output_text.logprobs`: Include logprobs with assistant messages.
+        # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+        #   tokens in reasoning item outputs. This enables reasoning items to be used in
+        #   multi-turn conversations when using the Responses API statelessly (like when
+        #   the `store` parameter is set to `false`, or when an organization is enrolled
+        #   in the zero data retention program).
         def include=: (
           ::Array[OpenAI::Models::Responses::response_includable]
         ) -> ::Array[OpenAI::Models::Responses::response_includable]
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
         attr_reader limit: Integer?
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
         def limit=: (Integer) -> Integer
+        # The order to return the input items in. Default is `desc`.
+        #
+        # - `asc`: Return the input items in ascending order.
+        # - `desc`: Return the input items in descending order.
         attr_reader order: OpenAI::Models::Conversations::ItemListParams::order?
+        # The order to return the input items in. Default is `desc`.
+        #
+        # - `asc`: Return the input items in ascending order.
+        # - `desc`: Return the input items in descending order.
         def order=: (
           OpenAI::Models::Conversations::ItemListParams::order
         ) -> OpenAI::Models::Conversations::ItemListParams::order
+        # @param after
+        #   An item ID to list items after, used in pagination.
+        # @param include
+        #   Specify additional output data to include in the model response. Currently
+        #   supported values are:
+        #
+        #   - `web_search_call.action.sources`: Include the sources of the web search tool
+        #     call.
+        #   - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #     in code interpreter tool call items.
+        #   - `computer_call_output.output.image_url`: Include image urls from the computer
+        #     call output.
+        #   - `file_search_call.results`: Include the search results of the file search tool
+        #     call.
+        #   - `message.input_image.image_url`: Include image urls from the input message.
+        #   - `message.output_text.logprobs`: Include logprobs with assistant messages.
+        #   - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+        #     tokens in reasoning item outputs. This enables reasoning items to be used in
+        #     multi-turn conversations when using the Responses API statelessly (like when
+        #     the `store` parameter is set to `false`, or when an organization is enrolled
+        #     in the zero data retention program).
+        # @param limit
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
+        # @param order
+        #   The order to return the input items in. Default is `desc`.
+        #
+        #   - `asc`: Return the input items in ascending order.
+        #   - `desc`: Return the input items in descending order.
         def initialize: (
           conversation_id: String,
           ?after: String,

data/sig/openai/models/conversations/item_retrieve_params.rbs CHANGED Viewed

@@ -17,12 +17,22 @@ module OpenAI
         attr_accessor item_id: String
+        # Additional fields to include in the response. See the `include` parameter for
+        # [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        # for more information.
         attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
+        # Additional fields to include in the response. See the `include` parameter for
+        # [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        # for more information.
         def include=: (
           ::Array[OpenAI::Models::Responses::response_includable]
         ) -> ::Array[OpenAI::Models::Responses::response_includable]
+        # @param include
+        #   Additional fields to include in the response. See the `include` parameter for
+        #   [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        #   for more information.
         def initialize: (
           conversation_id: String,
           item_id: String,