ProjectsAgentsModelFactory.AzureAISearchTool Method

Definition

The input definition information for an Azure AI search tool as used to configure an agent.

public static Azure.AI.Projects.Agents.AzureAISearchTool AzureAISearchTool(string name = default, string description = default, System.Collections.Generic.IDictionary<string,Azure.AI.Projects.Agents.ToolConfig> toolConfigs = default, Azure.AI.Projects.Agents.AzureAISearchToolOptions options = default);
static member AzureAISearchTool : string * string * System.Collections.Generic.IDictionary<string, Azure.AI.Projects.Agents.ToolConfig> * Azure.AI.Projects.Agents.AzureAISearchToolOptions -> Azure.AI.Projects.Agents.AzureAISearchTool
Public Shared Function AzureAISearchTool (Optional name As String = Nothing, Optional description As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional options As AzureAISearchToolOptions = Nothing) As AzureAISearchTool

Parameters

name
String

Optional user-defined name for this tool or configuration.

description
String

Optional user-defined description for this tool or configuration.

toolConfigs
IDictionary<String,ToolConfig>

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.

options
AzureAISearchToolOptions

The azure ai search index resource.

Returns

A new AzureAISearchTool instance for mocking.

Applies to