ProjectsAgentTool Class
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 tool that can be used to generate a response. Please note this is the abstract base class. The derived classes available for instantiation are: FabricIQPreviewTool, BingGroundingTool, MicrosoftFabricPreviewTool, SharepointPreviewTool, AzureAISearchTool, OpenAPITool, BingCustomSearchPreviewTool, BrowserAutomationPreviewTool, AzureFunctionTool, CaptureStructuredOutputsTool, A2APreviewTool, WorkIQPreviewTool, MemorySearchPreviewTool, ReminderPreviewTool, and ToolSearchTool.
[System.ClientModel.Primitives.PersistableModelProxy(typeof(OpenAI.UnknownTool))]
public abstract class ProjectsAgentTool : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.ProjectsAgentTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.ProjectsAgentTool>[<System.ClientModel.Primitives.PersistableModelProxy(typeof(OpenAI.UnknownTool))>]
type ProjectsAgentTool = class
interface IJsonModel<ProjectsAgentTool>
interface IPersistableModel<ProjectsAgentTool>Public MustInherit Class ProjectsAgentTool
Implements IJsonModel(Of ProjectsAgentTool), IPersistableModel(Of ProjectsAgentTool)- Inheritance
-
ProjectsAgentTool
- Derived
- Attributes
- Implements
Methods
| Name | Description |
|---|---|
| AsProjectTool<T>(T) |
Reinterprets a tool from the OpenAI |
| CreateA2ATool(Uri, String) |
Creates a new tool that lets the agent communicate with another agent over the Agent-to-Agent (A2A) protocol. |
| CreateAzureAISearchTool(AzureAISearchToolOptions) |
Creates an Azure AI Search tool with the supplied options. |
| CreateBingCustomSearchTool(BingCustomSearchToolOptions) |
Creates a Bing custom search tool with the supplied options. |
| CreateBingGroundingTool(BingGroundingSearchToolOptions) |
Creates a Bing grounding tool with the supplied options. |
| CreateBrowserAutomationTool(BrowserAutomationToolOptions) |
Creates a browser-automation tool with the supplied options. |
| CreateMicrosoftFabricTool(FabricDataAgentToolOptions) |
Creates a Microsoft Fabric data agent tool with the supplied options. |
| CreateOpenApiTool(OpenApiFunctionDefinition) |
Creates an OpenAPI tool from the supplied function definition. |
| CreateSharepointTool(SharePointGroundingToolOptions) |
Creates a SharePoint grounding tool with the supplied options. |
| CreateStructuredOutputsTool(StructuredOutputDefinition) |
Creates a tool that captures structured outputs from the agent. |
| JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions) | |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions) | |
| PersistableModelWriteCore(ModelReaderWriterOptions) | |
Operators
| Name | Description |
|---|---|
| Implicit(ProjectsAgentTool to ResponseTool) |
Implicitly converts a ProjectsAgentTool into the underlying OpenAI.Responses.ResponseTool representation by round-tripping through the wire format. |
