AzureAISearchTool Class

Definition

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

public class AzureAISearchTool : Azure.AI.Projects.Agents.ProjectsAgentTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.AzureAISearchTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.AzureAISearchTool>
type AzureAISearchTool = class
    inherit ProjectsAgentTool
    interface IJsonModel<AzureAISearchTool>
    interface IPersistableModel<AzureAISearchTool>
Public Class AzureAISearchTool
Inherits ProjectsAgentTool
Implements IJsonModel(Of AzureAISearchTool), IPersistableModel(Of AzureAISearchTool)
Inheritance
AzureAISearchTool
Implements

Constructors

Name Description
AzureAISearchTool(AzureAISearchToolOptions)

Properties

Name Description
Description

Optional user-defined description for this tool or configuration.

Name

Optional user-defined name for this tool or configuration.

Options

Options applied to the AzureAISearchTool instance.

ToolConfigs

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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<AzureAISearchTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AzureAISearchTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ProjectsAgentTool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IJsonModel<ProjectsAgentTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IPersistableModel<AzureAISearchTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AzureAISearchTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AzureAISearchTool>.Write(ModelReaderWriterOptions)
IPersistableModel<ProjectsAgentTool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IPersistableModel<ProjectsAgentTool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IPersistableModel<ProjectsAgentTool>.Write(ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)

Applies to