Language

ShellToolboxTool Class

Definition

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 class ShellToolboxTool : Azure.AI.Projects.Agents.ToolboxTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.ShellToolboxTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.ShellToolboxTool>
type ShellToolboxTool = class
    inherit ToolboxTool
    interface IJsonModel<ShellToolboxTool>
    interface IPersistableModel<ShellToolboxTool>
Public Class ShellToolboxTool
Inherits ToolboxTool
Implements IJsonModel(Of ShellToolboxTool), IPersistableModel(Of ShellToolboxTool)
Inheritance
ShellToolboxTool
Implements

Constructors

Name Description
ShellToolboxTool(ToolboxShellEnvironment)

Initializes a new instance of ShellToolboxTool.

Properties

Name Description
AllowedCallers

Gets or sets the AllowedCallers.

Description

Optional user-defined description for this tool or configuration.

(Inherited from ToolboxTool)
Environment

The environment in which shell commands are executed. Specify an automatically provisioned container or an existing container.

Name

Optional user-defined name for this tool or configuration.

(Inherited from ToolboxTool)
ToolConfigs

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.

(Inherited from ToolboxTool)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<ShellToolboxTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ShellToolboxTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ToolboxTool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ToolboxTool)
IJsonModel<ToolboxTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ToolboxTool)
IPersistableModel<ShellToolboxTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ShellToolboxTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ShellToolboxTool>.Write(ModelReaderWriterOptions)
IPersistableModel<ToolboxTool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ToolboxTool)
IPersistableModel<ToolboxTool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ToolboxTool)
IPersistableModel<ToolboxTool>.Write(ModelReaderWriterOptions) (Inherited from ToolboxTool)

Applies to