ProjectsAgentsModelFactory.ShellToolboxTool Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A shell tool stored in a toolbox. This model is additive to toolbox configuration and does not modify the OpenAI tool contract or existing toolbox tool definitions.
public static Azure.AI.Projects.Agents.ShellToolboxTool ShellToolboxTool(string name = default, string description = default, System.Collections.Generic.IDictionary<string,Azure.AI.Extensions.OpenAI.ToolConfig> toolConfigs = default, System.Collections.Generic.IEnumerable<OpenAI.CallableToolAllowedCaller> allowedCallers = default, Azure.AI.Projects.Agents.ToolboxShellEnvironment environment = default);static member ShellToolboxTool : string * string * System.Collections.Generic.IDictionary<string, Azure.AI.Extensions.OpenAI.ToolConfig> * seq<OpenAI.CallableToolAllowedCaller> * Azure.AI.Projects.Agents.ToolboxShellEnvironment -> Azure.AI.Projects.Agents.ShellToolboxToolPublic Shared Function ShellToolboxTool (Optional name As String = Nothing, Optional description As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional allowedCallers As IEnumerable(Of CallableToolAllowedCaller) = Nothing, Optional environment As ToolboxShellEnvironment = Nothing) As ShellToolboxToolParameters
- name
- String
Optional user-defined name for this tool or configuration.
- description
- String
Optional user-defined description for this tool or configuration.
- toolConfigs
- IDictionary<String,ToolConfig>
Per-tool configuration map. Keys are tool names or * (catch-all default).
Resolution order: exact tool name match takes priority over *.
Unknown tool names are silently ignored at runtime.
- allowedCallers
- IEnumerable<CallableToolAllowedCaller>
- environment
- ToolboxShellEnvironment
The environment in which shell commands are executed. Specify an automatically provisioned container or an existing container.
Returns
A new ShellToolboxTool instance for mocking.
