MemoryCommandToolCall Class

Package:
com.azure.ai.agents.models
Maven Artifact:
com.azure:azure-ai-agents:2.2.0
  • java.lang.Object
    • com.azure.ai.agents.models.MemoryCommandToolCall

Implements

JsonSerializable<MemoryCommandToolCall>

public final class MemoryCommandToolCall
implements JsonSerializable<MemoryCommandToolCall>

A memory command tool call.

Constructor Summary

Constructor Description
MemoryCommandToolCall(String callId, String arguments, ToolCallStatus status)

Creates an instance of MemoryCommandToolCall class.

Method Summary

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

Reads an instance of MemoryCommandToolCall from the JsonReader.
String getArguments()

Get the arguments property: A JSON string of the arguments to pass to the tool, including `action` (`remember` or `forget`) and `content`.
String getCallId()

Get the callId property: The unique ID of the tool call generated by the model.
ToolCallStatus getStatus()

Get the status property: The status of the tool call.
String getType()

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MemoryCommandToolCall

public MemoryCommandToolCall(String callId, String arguments, ToolCallStatus status)

Creates an instance of MemoryCommandToolCall class.

Parameters:

callId - the callId value to set.
arguments - the arguments value to set.
status - the status value to set.

Method Details

fromJson

public static MemoryCommandToolCall fromJson(JsonReader jsonReader)

Reads an instance of MemoryCommandToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getArguments

public String getArguments()

Get the arguments property: A JSON string of the arguments to pass to the tool, including `action` (`remember` or `forget`) and `content`.

Returns:

the arguments value.

getCallId

public String getCallId()

Get the callId property: The unique ID of the tool call generated by the model.

Returns:

the callId value.

getStatus

public ToolCallStatus getStatus()

Get the status property: The status of the tool call.

Returns:

the status value.

getType

public String getType()

Get the type property: The type property.

Returns:

the type value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to