Lingua

ToolboxTool Class

Definition

An abstract representation of a tool stored in a toolbox. Please note this is the abstract base class. The derived classes available for instantiation are: A2APreviewToolboxTool, A2AToolboxTool, AzureAISearchToolboxTool, Azure.AI.Projects.Agents.BrowserAutomationPreviewToolboxTool, BrowserAutomationToolboxTool, CodeInterpreterToolboxTool, FabricIQPreviewToolboxTool, FileSearchToolboxTool, MCPToolboxTool, OpenApiToolboxTool, ReminderPreviewToolboxTool, ShellToolboxTool, ToolSearchToolboxTool, ToolboxSearchPreviewToolboxTool, WebIQPreviewToolboxTool, WebSearchToolboxTool, and WorkIQPreviewToolboxTool.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.Agents.UnknownToolboxTool))]
public abstract class ToolboxTool : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.ToolboxTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.ToolboxTool>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.Agents.UnknownToolboxTool))>]
type ToolboxTool = class
    interface IJsonModel<ToolboxTool>
    interface IPersistableModel<ToolboxTool>
Public MustInherit Class ToolboxTool
Implements IJsonModel(Of ToolboxTool), IPersistableModel(Of ToolboxTool)
Inheritance
ToolboxTool
Derived
Attributes
Implements

Properties

Name Description
Description

Optional user-defined description for this tool or configuration.

Name

Optional user-defined name for this tool or configuration.

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.

Methods

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

Explicit Interface Implementations

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

Applies to