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/beta/agent_tool.rbs CHANGED Viewed

@@ -20,16 +20,31 @@ module OpenAI
           }
         class Function < OpenAI::Internal::Type::BaseModel
+          # Whether the function is deferred and discovered through tool search.
           attr_accessor defer_loading: bool
+          # A description of what the function does.
           attr_accessor description: String
+          # The name of the function.
           attr_accessor name: String
+          # A JSON Schema object describing the function's arguments.
           attr_accessor parameters: ::Hash[Symbol, top]
+          # The type of the object. Always `function`.
           attr_accessor type: :function
+          # @param defer_loading
+          #   Whether the function is deferred and discovered through tool search.
+          # @param description
+          #   A description of what the function does.
+          # @param name
+          #   The name of the function.
+          # @param parameters
+          #   A JSON Schema object describing the function's arguments.
+          # @param type
+          #   The type of the object. Always `function`.
           def initialize: (
             defer_loading: bool,
             description: String,
@@ -51,10 +66,16 @@ module OpenAI
           { enabled: bool, ?type: :programmatic_tool_calling }
         class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          # Whether tools can be called from model-generated code.
           attr_accessor enabled: bool
+          # The type of the object. Always `programmatic_tool_calling`.
           attr_accessor type: :programmatic_tool_calling
+          # @param enabled
+          #   Whether tools can be called from model-generated code.
+          # @param type
+          #   The type of the object. Always `programmatic_tool_calling`.
           def initialize: (
             enabled: bool,
             ?type: :programmatic_tool_calling
@@ -76,22 +97,48 @@ module OpenAI
           }
         class Mcp < OpenAI::Internal::Type::BaseModel
+          # The MCP tools the agent may call.
           attr_accessor allowed_tools: ::Array[String]?
+          # Where outbound MCP HTTP connections originate.
           attr_accessor connection_origin: OpenAI::Models::Beta::AgentTool::Mcp::connection_origin
+          # The attached vault credential selected for this MCP server, if any. Optional
+          # when exactly one attached credential matches the server URL.
           attr_accessor credential_id: String?
+          # Metadata included with requests to this MCP server.
           attr_accessor request_metadata: ::Hash[Symbol, top]
+          # Whether this MCP server must initialize before the first turn.
           attr_accessor required: bool
+          # A label used to identify the MCP server in tool calls.
           attr_accessor server_label: String
+          # The transport used to connect to the MCP server.
           attr_accessor transport: OpenAI::Models::Beta::mcp_transport
+          # The type of the object. Always `mcp`.
           attr_accessor type: :mcp
+          # @param allowed_tools
+          #   The MCP tools the agent may call.
+          # @param connection_origin
+          #   Where outbound MCP HTTP connections originate.
+          # @param credential_id
+          #   The attached vault credential selected for this MCP server, if any. Optional
+          #   when exactly one attached credential matches the server URL.
+          # @param request_metadata
+          #   Metadata included with requests to this MCP server.
+          # @param required
+          #   Whether this MCP server must initialize before the first turn.
+          # @param server_label
+          #   A label used to identify the MCP server in tool calls.
+          # @param transport
+          #   The transport used to connect to the MCP server.
+          # @param type
+          #   The type of the object. Always `mcp`.
           def initialize: (
             allowed_tools: ::Array[String]?,
             connection_origin: OpenAI::Models::Beta::AgentTool::Mcp::connection_origin,
@@ -136,16 +183,31 @@ module OpenAI
           }
         class WebSearch < OpenAI::Internal::Type::BaseModel
+          # Allowed search domains, or `null` when the search is unrestricted.
           attr_accessor allowed_domains: ::Array[String]?
+          # The amount of search context made available to the model. Defaults to `medium`.
           attr_accessor context_size: OpenAI::Models::Beta::AgentTool::WebSearch::context_size
+          # Approximate location used to localize search results, if provided.
           attr_accessor location: OpenAI::Beta::AgentTool::WebSearch::Location?
+          # The source used for web search results.
           attr_accessor mode: OpenAI::Models::Beta::AgentTool::WebSearch::mode
+          # The type of the object. Always `web_search`.
           attr_accessor type: :web_search
+          # @param allowed_domains
+          #   Allowed search domains, or `null` when the search is unrestricted.
+          # @param context_size
+          #   The amount of search context made available to the model. Defaults to `medium`.
+          # @param location
+          #   Approximate location used to localize search results, if provided.
+          # @param mode
+          #   The source used for web search results.
+          # @param type
+          #   The type of the object. Always `web_search`.
           def initialize: (
             allowed_domains: ::Array[String]?,
             context_size: OpenAI::Models::Beta::AgentTool::WebSearch::context_size,
@@ -183,14 +245,26 @@ module OpenAI
             }
           class Location < OpenAI::Internal::Type::BaseModel
+            # The city name.
             attr_accessor city: String?
+            # The two-letter ISO country code, such as `US`.
             attr_accessor country: String?
+            # The region or state name.
             attr_accessor region: String?
+            # The IANA timezone, such as `America/Los_Angeles`.
             attr_accessor timezone: String?
+            # @param city
+            #   The city name.
+            # @param country
+            #   The two-letter ISO country code, such as `US`.
+            # @param region
+            #   The region or state name.
+            # @param timezone
+            #   The IANA timezone, such as `America/Los_Angeles`.
             def initialize: (
               city: String?,
               country: String?,

data/sig/openai/models/beta/agent_tool_param.rbs CHANGED Viewed

@@ -21,18 +21,37 @@ module OpenAI
           }
         class Function < OpenAI::Internal::Type::BaseModel
+          # A description of what the function does.
           attr_accessor description: String
+          # The name of the function.
           attr_accessor name: String
+          # A JSON Schema object describing the function's arguments.
           attr_accessor parameters: ::Hash[Symbol, top]
+          # The type of the object. Always `function`.
           attr_accessor type: :function
+          # Whether this function is deferred and discovered through tool search. Defaults
+          # to `false`.
           attr_reader defer_loading: bool?
+          # Whether this function is deferred and discovered through tool search. Defaults
+          # to `false`.
           def defer_loading=: (bool) -> bool
+          # @param description
+          #   A description of what the function does.
+          # @param name
+          #   The name of the function.
+          # @param parameters
+          #   A JSON Schema object describing the function's arguments.
+          # @param defer_loading
+          #   Whether this function is deferred and discovered through tool search. Defaults
+          #   to `false`.
+          # @param type
+          #   The type of the object. Always `function`.
           def initialize: (
             description: String,
             name: String,
@@ -53,8 +72,11 @@ module OpenAI
         type tool_search = { ?type: :tool_search }
         class ToolSearch < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `tool_search`.
           attr_accessor type: :tool_search
+          # @param type
+          #   The type of the object. Always `tool_search`.
           def initialize: (?type: :tool_search) -> void
           def to_hash: -> { ?type: :tool_search }
@@ -64,12 +86,19 @@ module OpenAI
           { ?type: :programmatic_tool_calling, ?enabled: bool }
         class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `programmatic_tool_calling`.
           attr_accessor type: :programmatic_tool_calling
+          # Whether tools can be called from model-generated code. Defaults to `true`.
           attr_reader enabled: bool?
+          # Whether tools can be called from model-generated code. Defaults to `true`.
           def enabled=: (bool) -> bool
+          # @param enabled
+          #   Whether tools can be called from model-generated code. Defaults to `true`.
+          # @param type
+          #   The type of the object. Always `programmatic_tool_calling`.
           def initialize: (
             ?enabled: bool,
             ?type: :programmatic_tool_calling
@@ -91,24 +120,58 @@ module OpenAI
           }
         class Mcp < OpenAI::Internal::Type::BaseModel
+          # A label used to identify the MCP server in tool calls.
           attr_accessor server_label: String
+          # The transport used to connect to the MCP server.
           attr_accessor transport: OpenAI::Models::Beta::mcp_transport_param
+          # The type of the object. Always `mcp`.
           attr_accessor type: :mcp
+          # The MCP tools the agent may call. All server tools are allowed when omitted.
           attr_accessor allowed_tools: ::Array[String]?
+          # Selects where outbound MCP HTTP connections originate. Omitted or `service` uses
+          # the Managed Agents service network; `environment` uses the session's selected
+          # environment.
           attr_accessor connection_origin: OpenAI::Models::Beta::AgentToolParam::Mcp::connection_origin?
+          # The attached vault credential used to authenticate this MCP server. Optional
+          # when exactly one attached credential matches the server URL.
           attr_accessor credential_id: String?
+          # Metadata included with requests to this MCP server.
           attr_accessor request_metadata: ::Hash[Symbol, top]?
+          # Whether this MCP server must initialize before the first turn. Defaults to
+          # `false`.
           attr_reader required: bool?
+          # Whether this MCP server must initialize before the first turn. Defaults to
+          # `false`.
           def required=: (bool) -> bool
+          # @param server_label
+          #   A label used to identify the MCP server in tool calls.
+          # @param transport
+          #   The transport used to connect to the MCP server.
+          # @param allowed_tools
+          #   The MCP tools the agent may call. All server tools are allowed when omitted.
+          # @param connection_origin
+          #   Selects where outbound MCP HTTP connections originate. Omitted or `service` uses
+          #   the Managed Agents service network; `environment` uses the session's selected
+          #   environment.
+          # @param credential_id
+          #   The attached vault credential used to authenticate this MCP server. Optional
+          #   when exactly one attached credential matches the server URL.
+          # @param request_metadata
+          #   Metadata included with requests to this MCP server.
+          # @param required
+          #   Whether this MCP server must initialize before the first turn. Defaults to
+          #   `false`.
+          # @param type
+          #   The type of the object. Always `mcp`.
           def initialize: (
             server_label: String,
             transport: OpenAI::Models::Beta::mcp_transport_param,
@@ -156,16 +219,31 @@ module OpenAI
           }
         class WebSearch < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `web_search`.
           attr_accessor type: :web_search
+          # Domains the search may include.
           attr_accessor allowed_domains: ::Array[String]?
+          # The amount of search context made available to the model. Defaults to `medium`.
           attr_accessor context_size: OpenAI::Models::Beta::AgentToolParam::WebSearch::context_size?
+          # Approximate location used to localize search results.
           attr_accessor location: OpenAI::Beta::AgentToolParam::WebSearch::Location?
+          # The source used for web search results. Defaults to `live`.
           attr_accessor mode: OpenAI::Models::Beta::AgentToolParam::WebSearch::mode?
+          # @param allowed_domains
+          #   Domains the search may include.
+          # @param context_size
+          #   The amount of search context made available to the model. Defaults to `medium`.
+          # @param location
+          #   Approximate location used to localize search results.
+          # @param mode
+          #   The source used for web search results. Defaults to `live`.
+          # @param type
+          #   The type of the object. Always `web_search`.
           def initialize: (
             ?allowed_domains: ::Array[String]?,
             ?context_size: OpenAI::Models::Beta::AgentToolParam::WebSearch::context_size?,
@@ -203,14 +281,26 @@ module OpenAI
             }
           class Location < OpenAI::Internal::Type::BaseModel
+            # The city name.
             attr_accessor city: String?
+            # The two-letter ISO country code, such as `US`.
             attr_accessor country: String?
+            # The region or state name.
             attr_accessor region: String?
+            # The IANA timezone, such as `America/Los_Angeles`.
             attr_accessor timezone: String?
+            # @param city
+            #   The city name.
+            # @param country
+            #   The two-letter ISO country code, such as `US`.
+            # @param region
+            #   The region or state name.
+            # @param timezone
+            #   The IANA timezone, such as `America/Los_Angeles`.
             def initialize: (
               ?city: String?,
               ?country: String?,

data/sig/openai/models/beta/agent_update_params.rbs CHANGED Viewed

@@ -22,26 +22,62 @@ module OpenAI
         attr_accessor agent_id: String
+        # Additional instructions appended to the agent's default base instructions. Omit
+        # to leave unchanged.
         attr_accessor instructions: String?
+        # Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+        # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+        # characters.
         attr_accessor metadata: ::Hash[Symbol, String]?
+        # The model to use for the agent. The requested model name is preserved.
         attr_reader model: String?
+        # The model to use for the agent. The requested model name is preserved.
         def model=: (String) -> String
+        # Configuration for creating and coordinating subagents.
         attr_accessor multi_agent: OpenAI::Beta::MultiAgentConfigParam?
+        # A replacement name. Omit to leave unchanged, or pass null to clear it.
         attr_accessor name: String?
+        # Configuration for model reasoning. Omit to keep the current settings; pass
+        # `null` to reset to the model's default effort.
         attr_accessor reasoning: OpenAI::Beta::AgentReasoningParam?
+        # The service tier used for model requests.
         attr_accessor service_tier: OpenAI::Models::Beta::AgentUpdateParams::service_tier?
+        # Configuration for text generated by the agent.
         attr_accessor text: OpenAI::Beta::AgentTextParam?
+        # Tools available to the agent.
         attr_accessor tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?
+        # @param instructions
+        #   Additional instructions appended to the agent's default base instructions. Omit
+        #   to leave unchanged.
+        # @param metadata
+        #   Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+        #   Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+        #   characters.
+        # @param model
+        #   The model to use for the agent. The requested model name is preserved.
+        # @param multi_agent
+        #   Configuration for creating and coordinating subagents.
+        # @param name
+        #   A replacement name. Omit to leave unchanged, or pass null to clear it.
+        # @param reasoning
+        #   Configuration for model reasoning. Omit to keep the current settings; pass
+        #   `null` to reset to the model's default effort.
+        # @param service_tier
+        #   The service tier used for model requests.
+        # @param text
+        #   Configuration for text generated by the agent.
+        # @param tools
+        #   Tools available to the agent.
         def initialize: (
           agent_id: String,
           ?instructions: String?,

data/sig/openai/models/beta/agent_wait_for_subagents_call_item.rbs CHANGED Viewed

@@ -12,18 +12,36 @@ module OpenAI
         }
       class AgentWaitForSubagentsCallItem < OpenAI::Internal::Type::BaseModel
+        # The ID of the tool call item.
         attr_accessor id: String
+        # The IDs of the agents to wait for.
         attr_accessor recipient_agent_ids: ::Array[String]
+        # The ID of the agent waiting for results.
         attr_accessor sender_agent_id: String
+        # The status of the tool call.
         attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
+        # The ID of the turn that contains this item.
         attr_accessor turn_id: String
+        # The item type. Always `wait_for_subagents_call`.
         attr_accessor type: :wait_for_subagents_call
+        # @param id
+        #   The ID of the tool call item.
+        # @param recipient_agent_ids
+        #   The IDs of the agents to wait for.
+        # @param sender_agent_id
+        #   The ID of the agent waiting for results.
+        # @param status
+        #   The status of the tool call.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param type
+        #   The item type. Always `wait_for_subagents_call`.
         def initialize: (
           id: String,
           recipient_agent_ids: ::Array[String],

data/sig/openai/models/beta/agent_web_search_call_item.rbs CHANGED Viewed

@@ -11,16 +11,31 @@ module OpenAI
         }
       class AgentWebSearchCallItem < OpenAI::Internal::Type::BaseModel
+        # The ID of the web search call.
         attr_accessor id: String
+        # The action performed by the web search tool.
         attr_accessor action: OpenAI::Models::Beta::web_search_action?
+        # The status of the web search call.
         attr_accessor status: OpenAI::Models::Beta::agent_output_item_status
+        # The ID of the turn that contains this item.
         attr_accessor turn_id: String
+        # The item type. Always `web_search_call`.
         attr_accessor type: :web_search_call
+        # @param id
+        #   The ID of the web search call.
+        # @param action
+        #   The action performed by the web search tool.
+        # @param status
+        #   The status of the web search call.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param type
+        #   The item type. Always `web_search_call`.
         def initialize: (
           id: String,
           action: OpenAI::Models::Beta::web_search_action?,

data/sig/openai/models/beta/agents/environment_info.rbs CHANGED Viewed

@@ -14,20 +14,41 @@ module OpenAI
           }
         class EnvironmentInfo < OpenAI::Internal::Type::BaseModel
+          # The ID of the environment.
           attr_accessor id: String
+          # Files installed in the environment, without their contents.
           attr_accessor files: ::Array[OpenAI::Models::Beta::hosted_environment_file]
+          # The object type. Always `agent.environment`.
           attr_accessor object: :"agent.environment"
+          # Plugins installed in the environment, without their archive contents.
           attr_accessor plugins: ::Array[OpenAI::Beta::HostedPlugin]
+          # Skills installed in the environment, without their archive contents.
           attr_accessor skills: ::Array[OpenAI::Models::Beta::hosted_skill]
+          # The current environment connection status.
           attr_accessor status: OpenAI::Models::Beta::Agents::EnvironmentInfo::status
+          # Whether the environment is hosted by OpenAI or by the application.
           attr_accessor type: OpenAI::Models::Beta::Agents::EnvironmentInfo::type_
+          # @param id
+          #   The ID of the environment.
+          # @param files
+          #   Files installed in the environment, without their contents.
+          # @param plugins
+          #   Plugins installed in the environment, without their archive contents.
+          # @param skills
+          #   Skills installed in the environment, without their archive contents.
+          # @param status
+          #   The current environment connection status.
+          # @param type
+          #   Whether the environment is hosted by OpenAI or by the application.
+          # @param object
+          #   The object type. Always `agent.environment`.
           def initialize: (
             id: String,
             files: ::Array[OpenAI::Models::Beta::hosted_environment_file],

data/sig/openai/models/beta/agents/environments/environment_file.rbs CHANGED Viewed

@@ -14,14 +14,26 @@ module OpenAI
             }
           class EnvironmentFile < OpenAI::Internal::Type::BaseModel
+            # The ID of the environment containing this file.
             attr_accessor environment_id: String
+            # The object type. Always `agent.environment.file`.
             attr_accessor object: :"agent.environment.file"
+            # The absolute file path inside the environment's workspace.
             attr_accessor path: String
+            # The file size in bytes.
             attr_accessor size_bytes: Integer
+            # @param environment_id
+            #   The ID of the environment containing this file.
+            # @param path
+            #   The absolute file path inside the environment's workspace.
+            # @param size_bytes
+            #   The file size in bytes.
+            # @param object
+            #   The object type. Always `agent.environment.file`.
             def initialize: (
               environment_id: String,
               path: String,