ThreadMessageOptions Class

Package:
com.azure.ai.agents.persistent.models
Maven Artifact:
com.azure:azure-ai-agents-persistent:1.0.0-beta.2
  • java.lang.Object
    • com.azure.ai.agents.persistent.models.ThreadMessageOptions

Implements

JsonSerializable<ThreadMessageOptions>

public final class ThreadMessageOptions
implements JsonSerializable<ThreadMessageOptions>

A single message within an agent thread, as provided during that thread's creation for its initial state.

Constructor Summary

Constructor Description
ThreadMessageOptions(MessageRole role, BinaryData content)

Creates an instance of ThreadMessageOptions class.

Method Summary

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

Reads an instance of ThreadMessageOptions from the JsonReader.
List<MessageAttachment> getAttachments()

Get the attachments property: A list of files attached to the message, and the tools they should be added to.
BinaryData getContent()

Get the content property: The content of the initial message.
Map<String,String> getMetadata()

Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
MessageRole getRole()

Get the role property: The role of the entity that is creating the message.
ThreadMessageOptions setAttachments(List<MessageAttachment> attachments)

Set the attachments property: A list of files attached to the message, and the tools they should be added to.
ThreadMessageOptions setMetadata(Map<String,String> metadata)

Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ThreadMessageOptions

public ThreadMessageOptions(MessageRole role, BinaryData content)

Creates an instance of ThreadMessageOptions class.

Parameters:

role - the role value to set.
content - the content value to set.

Method Details

fromJson

public static ThreadMessageOptions fromJson(JsonReader jsonReader)

Reads an instance of ThreadMessageOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAttachments

public List<MessageAttachment> getAttachments()

Get the attachments property: A list of files attached to the message, and the tools they should be added to.

Returns:

the attachments value.

getContent

public BinaryData getContent()

Get the content property: The content of the initial message. This may be a basic string (if you only need text) or an array of typed content blocks (for example, text, image_file, image_url, and so on).

Returns:

the content value.

getMetadata

public Map<String,String> getMetadata()

Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

Returns:

the metadata value.

getRole

public MessageRole getRole()

Get the role property: The role of the entity that is creating the message. Allowed values include: `user`, which indicates the message is sent by an actual user (and should be used in most cases to represent user-generated messages), and `assistant`, which indicates the message is generated by the agent (use this value to insert messages from the agent into the conversation).

Returns:

the role value.

setAttachments

public ThreadMessageOptions setAttachments(List<MessageAttachment> attachments)

Set the attachments property: A list of files attached to the message, and the tools they should be added to.

Parameters:

attachments - the attachments value to set.

Returns:

the ThreadMessageOptions object itself.

setMetadata

public ThreadMessageOptions setMetadata(Map<String,String> metadata)

Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

Parameters:

metadata - the metadata value to set.

Returns:

the ThreadMessageOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to