Package com.microsoft.semantickernel.services.chatcompletion

Class ChatMessageContent<T>

java.lang.Object

com.microsoft.semantickernel.services.KernelContentImpl<T>

com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent<T>

Type Parameters:

T - the type of the inner content within the messages

All Implemented Interfaces:

KernelContent<T>

Direct Known Subclasses:

ChatMessageImageContent, ChatMessageTextContent

public class ChatMessageContent<T>
extends KernelContentImpl<T>

Represents the content of a chat message

This class defaults to a ChatMessageContentType.TEXT content type if none is specified. However, if using this for text content, consider using ChatMessageTextContent and its builders instead.

Constructor Summary

Constructors

Constructor	Description
ChatMessageContent(AuthorRole authorRole, String content)	Creates a new instance of the ChatMessageContent class.
ChatMessageContent(AuthorRole authorRole, String content, String modelId, T innerContent, Charset encoding, FunctionResultMetadata metadata)	Creates a new instance of the ChatMessageContent class.
ChatMessageContent(AuthorRole authorRole, String content, String modelId, T innerContent, Charset encoding, FunctionResultMetadata metadata, ChatMessageContentType contentType)	Creates a new instance of the ChatMessageContent class.
ChatMessageContent(AuthorRole authorRole, List<KernelContent<T>> items, String modelId, T innerContent, Charset encoding, FunctionResultMetadata metadata, ChatMessageContentType contentType)	Creates a new instance of the ChatMessageContent class.

Method Summary

Modifier and Type	Method	Description
AuthorRole	getAuthorRole()	Gets the author role that generated the content
String	getContent()	Gets the content
ChatMessageContentType	getContentType()	Gets the content type
Charset	getEncoding()	Gets the encoding of the content
List<KernelContent<T>>	getItems()	Gets the KernelContent items that comprise the content.
String	toString()

Methods inherited from class com.microsoft.semantickernel.services.KernelContentImpl

getInnerContent, getMetadata

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChatMessageContent

public ChatMessageContent(AuthorRole authorRole,
                          String content)

Creates a new instance of the ChatMessageContent class. Defaults to ChatMessageContentType.TEXT content type.

Parameters:

authorRole - the author role that generated the content

content - the content

ChatMessageContent

public ChatMessageContent(AuthorRole authorRole,
                          String content,
                          @Nullable
                          String modelId,
                          @Nullable
                          T innerContent,
                          @Nullable
                          Charset encoding,
                          @Nullable
                          FunctionResultMetadata metadata)

Creates a new instance of the ChatMessageContent class. Defaults to ChatMessageContentType.TEXT content type.

Parameters:

authorRole - the author role that generated the content

content - the content

modelId - the model id

innerContent - the inner content

encoding - the encoding

metadata - the metadata

ChatMessageContent

public ChatMessageContent(AuthorRole authorRole,
                          String content,
                          @Nullable
                          String modelId,
                          @Nullable
                          T innerContent,
                          @Nullable
                          Charset encoding,
                          @Nullable
                          FunctionResultMetadata metadata,
                          ChatMessageContentType contentType)

Creates a new instance of the ChatMessageContent class.

Parameters:

authorRole - the author role that generated the content

content - the content

modelId - the model id

innerContent - the inner content

encoding - the encoding

metadata - the metadata

contentType - the content type

ChatMessageContent

public ChatMessageContent(AuthorRole authorRole,
                          @Nullable
                          List<KernelContent<T>> items,
                          String modelId,
                          T innerContent,
                          Charset encoding,
                          FunctionResultMetadata metadata,
                          ChatMessageContentType contentType)

Creates a new instance of the ChatMessageContent class.

Parameters:

authorRole - the author role that generated the content

items - the items

modelId - the model id

innerContent - the inner content

encoding - the encoding

metadata - the metadata

contentType - the content type

Method Detail

getAuthorRole

public AuthorRole getAuthorRole()

Gets the author role that generated the content

Returns:

the author role that generated the content

getContent

@Nullable
public String getContent()

Gets the content

Returns:

the content, which may be null

getItems

@Nullable
public List<KernelContent<T>> getItems()

Gets the KernelContent items that comprise the content.

Returns:

the items, which may be null

getEncoding

@Nullable
public Charset getEncoding()

Gets the encoding of the content

Returns:

the encoding, which may be null

getContentType

public ChatMessageContentType getContentType()

Gets the content type

Returns:

the content type

toString

public String toString()

Overrides:

toString in class Object