Share via

RunStepBingCustomSearchToolCall Class

Package:
com.azure.ai.agents.persistent.models
Maven Artifact:
com.azure:azure-ai-agents-persistent:1.0.0-beta.2

public final class RunStepBingCustomSearchToolCall
extends RunStepToolCall

A record of a call to a bing custom search tool, issued by the model in evaluation of a defined tool, that represents executed search with bing custom search.

Method Summary

Modifier and Type Method and Description
static RunStepBingCustomSearchToolCall fromJson(JsonReader jsonReader)

Reads an instance of RunStepBingCustomSearchToolCall from the JsonReader.
Map<String,String> getBingCustomSearch()

Get the bingCustomSearch property: Reserved for future use.
String getType()

Get the type property: The object type.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from RunStepToolCall

fromJson getId getType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static RunStepBingCustomSearchToolCall fromJson(JsonReader jsonReader)

Reads an instance of RunStepBingCustomSearchToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

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

getBingCustomSearch

public Map<String,String> getBingCustomSearch()

Get the bingCustomSearch property: Reserved for future use.

Returns:

the bingCustomSearch value.

getType

public String getType()

Get the type property: The object type.

Overrides:

RunStepBingCustomSearchToolCall.getType()

Returns:

the type value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RunStepBingCustomSearchToolCall.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to