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

Class RunStepFileSearchToolCallResults

java.lang.Object

com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResults

All Implemented Interfaces:

com.azure.json.JsonSerializable<RunStepFileSearchToolCallResults>

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

The results of the file search.

Method Summary

Modifier and Type	Method	Description
static RunStepFileSearchToolCallResults	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of RunStepFileSearchToolCallResults from the JsonReader.
FileSearchRankingOptions	getRankingOptions()	Get the rankingOptions property: Ranking options for file search.
List<RunStepFileSearchToolCallResult>	getResults()	Get the results property: The array of a file search results.
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

Method Details

getRankingOptions

public FileSearchRankingOptions getRankingOptions()

Get the rankingOptions property: Ranking options for file search.

Returns:

the rankingOptions value.

getResults

public List<RunStepFileSearchToolCallResult> getResults()

Get the results property: The array of a file search results.

Returns:

the results value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of RunStepFileSearchToolCallResults from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RunStepFileSearchToolCallResults 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 RunStepFileSearchToolCallResults.