Package com.azure.search.documents.agents.models

Class KnowledgeAgentMessage

java.lang.Object

com.azure.search.documents.agents.models.KnowledgeAgentMessage

All Implemented Interfaces:

com.azure.json.JsonSerializable<KnowledgeAgentMessage>

public final class KnowledgeAgentMessage
extends Object
implements com.azure.json.JsonSerializable<KnowledgeAgentMessage>

The natural language message style object.

Constructor Summary

Constructors

Constructor	Description
KnowledgeAgentMessage(String role, List<KnowledgeAgentMessageContent> content)	Creates an instance of KnowledgeAgentMessage class.

Method Summary

Modifier and Type	Method	Description
static KnowledgeAgentMessage	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of KnowledgeAgentMessage from the JsonReader.
List<KnowledgeAgentMessageContent>	getContent()	Get the content property: The content property.
String	getRole()	Get the role property: The role of the tool response.
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

KnowledgeAgentMessage

public KnowledgeAgentMessage(String role,
 List<KnowledgeAgentMessageContent> content)

Creates an instance of KnowledgeAgentMessage class.

Parameters:

role - the role value to set.

content - the content value to set.

Method Details

getRole

public String getRole()

Get the role property: The role of the tool response.

Returns:

the role value.

getContent

public List<KnowledgeAgentMessageContent> getContent()

Get the content property: The content property.

Returns:

the content value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of KnowledgeAgentMessage from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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