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

Class RunStepOpenApiToolCall

java.lang.Object

com.azure.ai.agents.persistent.models.RunStepToolCall

com.azure.ai.agents.persistent.models.RunStepOpenApiToolCall

All Implemented Interfaces:

com.azure.json.JsonSerializable<RunStepToolCall>

public final class RunStepOpenApiToolCall
extends RunStepToolCall

A record of a call to an OpenAPI tool, issued by the model in evaluation of a defined tool, that represents executed OpenAPI operations.

Method Summary

Modifier and Type	Method	Description
static RunStepOpenApiToolCall	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of RunStepOpenApiToolCall from the JsonReader.
Map<String,String>	getOpenApi()	Get the openApi property: Reserved for future use.
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.agents.persistent.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.

getOpenApi

public Map<String,String> getOpenApi()

Get the openApi property: Reserved for future use.

Returns:

the openApi 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 RunStepOpenApiToolCall fromJson(com.azure.json.JsonReader jsonReader)
                                       throws IOException

Reads an instance of RunStepOpenApiToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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