Share via


AzureAISearchAgentTool Class

Definition

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

public class AzureAISearchAgentTool : Azure.AI.AgentServer.Contracts.Generated.OpenAI.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AzureAISearchAgentTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AzureAISearchAgentTool>
type AzureAISearchAgentTool = class
    inherit Tool
    interface IUtf8JsonSerializable
    interface IJsonModel<AzureAISearchAgentTool>
    interface IPersistableModel<AzureAISearchAgentTool>
Public Class AzureAISearchAgentTool
Inherits Tool
Implements IJsonModel(Of AzureAISearchAgentTool), IPersistableModel(Of AzureAISearchAgentTool)
Inheritance
AzureAISearchAgentTool
Implements

Constructors

Name Description
AzureAISearchAgentTool()

Initializes a new instance of AzureAISearchAgentTool for deserialization.

AzureAISearchAgentTool(AzureAISearchToolResource)

Initializes a new instance of AzureAISearchAgentTool.

AzureAISearchAgentTool(ToolType, IDictionary<String,BinaryData>, AzureAISearchToolResource)

Initializes a new instance of AzureAISearchAgentTool.

Properties

Name Description
AzureAiSearch

The azure ai search index resource.

Type

Gets or sets the type.

(Inherited from Tool)

Methods

Name Description
DeserializeAzureAISearchAgentTool(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<AzureAISearchAgentTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AzureAISearchAgentTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from Tool)
IJsonModel<Tool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from Tool)
IPersistableModel<AzureAISearchAgentTool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureAISearchAgentTool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AzureAISearchAgentTool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from Tool)
IPersistableModel<Tool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from Tool)
IPersistableModel<Tool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from Tool)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to