Package com.azure.ai.openai.assistants.models

Class RunStepFileSearchToolCall

java.lang.Object

com.azure.ai.openai.assistants.models.RunStepToolCall

com.azure.ai.openai.assistants.models.RunStepFileSearchToolCall

All Implemented Interfaces:

com.azure.json.JsonSerializable<RunStepToolCall>

public final class RunStepFileSearchToolCall
extends RunStepToolCall

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

Method Summary

Modifier and Type	Method	Description
static RunStepFileSearchToolCall	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of RunStepFileSearchToolCall from the JsonReader.
List<FileSearchToolCallResult>	getFileSearch()	Get the fileSearch property: The results of the file search.
String	getType()	Get the type property: The object type.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class com.azure.ai.openai.assistants.models.RunStepToolCall

getId

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

getType

public String getType()

Get the type property: The object type.

Overrides:

getType in class RunStepToolCall

Returns:

the type value.

getFileSearch

public List<FileSearchToolCallResult> getFileSearch()

Get the fileSearch property: The results of the file search.

Returns:

the fileSearch value.

toJson

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

Specified by:

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

Overrides:

toJson in class RunStepToolCall

Throws:

IOException

fromJson

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

Reads an instance of RunStepFileSearchToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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