RunStepFunctionToolCall Class

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

public final class RunStepFunctionToolCall
extends RunStepToolCall

A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs and output consumed and emitted by the specified function.

Method Summary

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

Reads an instance of RunStepFunctionToolCall from the JsonReader.
RunStepFunctionToolCallDetails getFunction()

Get the function property: The detailed information about the function called by the model.
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 RunStepFunctionToolCall fromJson(JsonReader jsonReader)

Reads an instance of RunStepFunctionToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getFunction

public RunStepFunctionToolCallDetails getFunction()

Get the function property: The detailed information about the function called by the model.

Returns:

the function value.

getType

public String getType()

Get the type property: The object type.

Overrides:

RunStepFunctionToolCall.getType()

Returns:

the type value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RunStepFunctionToolCall.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to