Package com.azure.ai.agents.persistent.models

Class AzureAISearchToolDefinition

java.lang.Object

com.azure.ai.agents.persistent.models.ToolDefinition

com.azure.ai.agents.persistent.models.AzureAISearchToolDefinition

All Implemented Interfaces:

com.azure.json.JsonSerializable<ToolDefinition>

public final class AzureAISearchToolDefinition
extends ToolDefinition

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

Constructor Summary

Constructors

Constructor	Description
AzureAISearchToolDefinition()	Creates an instance of AzureAISearchToolDefinition class.

Method Summary

Modifier and Type	Method	Description
static AzureAISearchToolDefinition	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AzureAISearchToolDefinition from the JsonReader.
String	getType()	Get the type property: The object type.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

AzureAISearchToolDefinition

public AzureAISearchToolDefinition()

Creates an instance of AzureAISearchToolDefinition class.

Method Details

getType

public String getType()

Get the type property: The object type.

Overrides:

getType in class ToolDefinition

Returns:

the type value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ToolDefinition>

Overrides:

toJson in class ToolDefinition

Throws:

IOException

fromJson

public static AzureAISearchToolDefinition fromJson(com.azure.json.JsonReader jsonReader)
                                            throws IOException

Reads an instance of AzureAISearchToolDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureAISearchToolDefinition if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException - If an error occurs while reading the AzureAISearchToolDefinition.