ToolDefinition Class

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

Source:: ToolDefinition.cs

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.

An abstract representation of an input tool definition that an agent can use. Please note ToolDefinition is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureAISearchToolDefinition, BingGroundingToolDefinition, CodeInterpreterToolDefinition, FileSearchToolDefinition, FunctionToolDefinition, MicrosoftFabricToolDefinition and SharepointToolDefinition.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownToolDefinition))]
public abstract class ToolDefinition : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.ToolDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.ToolDefinition>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownToolDefinition))>]
type ToolDefinition = class
    interface IJsonModel<ToolDefinition>
    interface IPersistableModel<ToolDefinition>

Public MustInherit Class ToolDefinition
Implements IJsonModel(Of ToolDefinition), IPersistableModel(Of ToolDefinition)

Inheritance: Object
ToolDefinition

Derived: Azure.AI.Projects.AzureAISearchToolDefinition

Azure.AI.Projects.BingGroundingToolDefinition

Azure.AI.Projects.CodeInterpreterToolDefinition

Azure.AI.Projects.FileSearchToolDefinition

Azure.AI.Projects.FunctionToolDefinition

More…

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<ToolDefinition> IPersistableModel<ToolDefinition> IPersistableModel<T>

Constructors

ToolDefinition()

Initializes a new instance of ToolDefinition.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ToolDefinition>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ToolDefinition>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via