Response.Tools Property
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.
An array of tools the model may call while generating a response. You
can specify which tool to use by setting the tool_choice parameter.
The two categories of tools you can provide the model are:
- Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools.
- Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code. Learn more about function calling. Please note Tool 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 A2ATool, AzureAISearchAgentTool, AzureFunctionAgentTool, BingCustomSearchAgentTool, BingGroundingAgentTool, BrowserAutomationAgentTool, CaptureStructuredOutputsTool, CodeInterpreterTool, ComputerUsePreviewTool, MicrosoftFabricAgentTool, FileSearchTool, FunctionTool, ImageGenTool, LocalShellTool, MCPTool, MemorySearchTool, OpenApiAgentTool, SharepointAgentTool and WebSearchPreviewTool.
public System.Collections.Generic.IReadOnlyList<Azure.AI.AgentServer.Contracts.Generated.OpenAI.Tool> Tools { get; }member this.Tools : System.Collections.Generic.IReadOnlyList<Azure.AI.AgentServer.Contracts.Generated.OpenAI.Tool>Public ReadOnly Property Tools As IReadOnlyList(Of Tool)