Share via

AgentTool Class

Definition

Namespace:
Azure.AI.Projects.OpenAI
Assembly:
Azure.AI.Projects.OpenAI.dll
Package:
Azure.AI.Projects.OpenAI v1.0.0-beta.4
Source:
AgentTool.cs

The AgentTool. Please note this is the abstract base class. The derived classes available for instantiation are: LocalShellAgentTool, BingGroundingAgentTool, MicrosoftFabricAgentTool, SharepointAgentTool, AzureAISearchAgentTool, OpenAPIAgentTool, BingCustomSearchAgentTool, BrowserAutomationAgentTool, AzureFunctionAgentTool, CaptureStructuredOutputsTool, A2ATool, and MemorySearchTool.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(OpenAI.UnknownTool))]
public abstract class AgentTool : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.OpenAI.AgentTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.OpenAI.AgentTool>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(OpenAI.UnknownTool))>]
type AgentTool = class
    interface IJsonModel<AgentTool>
    interface IPersistableModel<AgentTool>
Public MustInherit Class AgentTool
Implements IJsonModel(Of AgentTool), IPersistableModel(Of AgentTool)
Inheritance
Object
AgentTool
Derived
Attributes
PersistableModelProxyAttribute
Implements
IJsonModel<AgentTool> IPersistableModel<AgentTool> IPersistableModel<T>

Methods

Name Description
CreateA2ATool(Uri, String)
CreateAzureAISearchTool(AzureAISearchToolOptions)
CreateBingCustomSearchTool(BingCustomSearchToolParameters)
CreateBingGroundingTool(BingGroundingSearchToolOptions)
CreateBrowserAutomationTool(BrowserAutomationToolParameters)
CreateLocalShellTool()
CreateMicrosoftFabricTool(FabricDataAgentToolOptions)
CreateOpenApiTool(OpenAPIFunctionDefinition)
CreateSharepointTool(SharePointGroundingToolOptions)
CreateStructuredOutputsTool(StructuredOutputDefinition)
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Implicit(AgentTool to ResponseTool)

Explicit Interface Implementations

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

Applies to