Package com.microsoft.semantickernel.services.chatcompletion.message

Class ChatMessageImageContent<T>

java.lang.Object

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

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

com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent<T>

Type Parameters:

T - the type of the inner content within the message

All Implemented Interfaces:

KernelContent<T>

public class ChatMessageImageContent<T>
extends ChatMessageContent<T>

Represents an image content in a chat message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChatMessageImageContent.Builder<T>	Builder for the ChatMessageImageContent class.
static class	ChatMessageImageContent.ImageDetail	The detail level of the image to include in the chat message.

Constructor Summary

Constructors

Constructor	Description
ChatMessageImageContent(String content, String modelId, ChatMessageImageContent.ImageDetail detail)	Create a new instance of the ChatMessageImageContent class.

Method Summary

Modifier and Type	Method	Description
static <T> ChatMessageImageContent.Builder<T>	builder()	Create a new builder for the ChatMessageImageContent class.
ChatMessageImageContent.ImageDetail	getDetail()	Get the detail level of the image to include in the chat message.

Methods inherited from class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

getAuthorRole, getContent, getContentType, getEncoding, getItems, 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

ChatMessageImageContent

public ChatMessageImageContent(String content,
                               @Nullable
                               String modelId,
                               @Nullable
                               ChatMessageImageContent.ImageDetail detail)

Create a new instance of the ChatMessageImageContent class.

Parameters:

content - The chat message content

modelId - The LLM id to use for the chat

detail - The detail level of the image to include in the chat message

Method Detail

getDetail

public ChatMessageImageContent.ImageDetail getDetail()

Get the detail level of the image to include in the chat message.

Returns:

the detail level of the image

builder

public static <T> ChatMessageImageContent.Builder<T> builder()

Create a new builder for the ChatMessageImageContent class.

Type Parameters:

T - the type of the inner content within the messages

Returns:

a new builder