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

Class BingGroundingSearchToolParameters

java.lang.Object

com.azure.ai.agents.persistent.models.BingGroundingSearchToolParameters

All Implemented Interfaces:

com.azure.json.JsonSerializable<BingGroundingSearchToolParameters>

public final class BingGroundingSearchToolParameters
extends Object
implements com.azure.json.JsonSerializable<BingGroundingSearchToolParameters>

The bing grounding search tool parameters.

Constructor Summary

Constructors

Constructor	Description
BingGroundingSearchToolParameters(List<BingGroundingSearchConfiguration> searchConfigurations)	Creates an instance of BingGroundingSearchToolParameters class.

Method Summary

Modifier and Type	Method	Description
static BingGroundingSearchToolParameters	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of BingGroundingSearchToolParameters from the JsonReader.
List<BingGroundingSearchConfiguration>	getSearchConfigurations()	Get the searchConfigurations property: The search configurations attached to this tool.
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

BingGroundingSearchToolParameters

public BingGroundingSearchToolParameters(List<BingGroundingSearchConfiguration> searchConfigurations)

Creates an instance of BingGroundingSearchToolParameters class.

Parameters:

searchConfigurations - the searchConfigurations value to set.

Method Details

getSearchConfigurations

public List<BingGroundingSearchConfiguration> getSearchConfigurations()

Get the searchConfigurations property: The search configurations attached to this tool. There can be a maximum of 1 search configuration resource attached to the tool.

Returns:

the searchConfigurations value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of BingGroundingSearchToolParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the BingGroundingSearchToolParameters.