Package com.azure.ai.inference.models
Class ChatRequestToolMessage
java.lang.Object
com.azure.ai.inference.models.ChatRequestMessage
com.azure.ai.inference.models.ChatRequestToolMessage
- All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatRequestMessage>
A request chat message representing requested output from a configured tool.
-
Constructor Summary
ConstructorsConstructorDescriptionChatRequestToolMessage
(String toolCallId) Creates an instance of ChatRequestToolMessage class. -
Method Summary
Modifier and TypeMethodDescriptionstatic ChatRequestToolMessage
fromJson
(com.azure.json.JsonReader jsonReader) Reads an instance of ChatRequestToolMessage from the JsonReader.Get the content property: The content of the message.getRole()
Get the role property: The chat role associated with this message.Get the toolCallId property: The ID of the tool call resolved by the provided content.setContent
(String content) Set the content property: The content of the message.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
-
Constructor Details
-
ChatRequestToolMessage
Creates an instance of ChatRequestToolMessage class.- Parameters:
toolCallId
- the toolCallId value to set.
-
-
Method Details
-
getRole
Get the role property: The chat role associated with this message.- Overrides:
getRole
in classChatRequestMessage
- Returns:
- the role value.
-
getContent
Get the content property: The content of the message.- Returns:
- the content value.
-
getToolCallId
Get the toolCallId property: The ID of the tool call resolved by the provided content.- Returns:
- the toolCallId value.
-
toJson
- Specified by:
toJson
in interfacecom.azure.json.JsonSerializable<ChatRequestMessage>
- Overrides:
toJson
in classChatRequestMessage
- Throws:
IOException
-
fromJson
public static ChatRequestToolMessage fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of ChatRequestToolMessage from the JsonReader.- Parameters:
jsonReader
- The JsonReader being read.- Returns:
- An instance of ChatRequestToolMessage 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 ChatRequestToolMessage.
-
setContent
Set the content property: The content of the message.- Parameters:
content
- the content value to set.- Returns:
- the ChatRequestToolMessage object itself.
-