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

Class ChatMessageImageContent.Builder<T>

java.lang.Object

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

Type Parameters:

T - the type of the inner content within the message

All Implemented Interfaces:

SemanticKernelBuilder<ChatMessageImageContent<T>>

Enclosing class:

ChatMessageImageContent<T>

public static class ChatMessageImageContent.Builder<T>
extends Object
implements SemanticKernelBuilder<ChatMessageImageContent<T>>

Builder for the ChatMessageImageContent class.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ChatMessageImageContent<T>	build()	Build the object.
ChatMessageImageContent.Builder<T>	withDetail(ChatMessageImageContent.ImageDetail detail)	Set the detail level of the image to include in the chat message.
ChatMessageImageContent.Builder<T>	withImage(String imageType, byte[] content)	Set the image content to include in the chat message.
ChatMessageImageContent.Builder<T>	withImageUrl(String url)	Set the URL of the image to include in the chat message.
ChatMessageImageContent.Builder<T>	withImageUrl(URL url)	Set the URL of the image to include in the chat message.
ChatMessageImageContent.Builder<T>	withModelId(String modelId)	Set the model ID to use for the chat message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withModelId

public ChatMessageImageContent.Builder<T> withModelId(String modelId)

Set the model ID to use for the chat message.

Parameters:

modelId - the model ID

Returns:

this builder

withImage

public ChatMessageImageContent.Builder<T> withImage(String imageType,
                                                    byte[] content)

Set the image content to include in the chat message.

Parameters:

imageType - For instance jpg or png. For known types known to OpenAI see: docs.

content - the image content

Returns:

this builder

withImageUrl

public ChatMessageImageContent.Builder<T> withImageUrl(String url)

Set the URL of the image to include in the chat message.

Parameters:

url - the URL of the image

Returns:

this builder

withImageUrl

public ChatMessageImageContent.Builder<T> withImageUrl(URL url)

Set the URL of the image to include in the chat message.

Parameters:

url - the URL of the image

Returns:

this builder

withDetail

public ChatMessageImageContent.Builder<T> withDetail(ChatMessageImageContent.ImageDetail detail)

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

Parameters:

detail - the detail level of the image

Returns:

this builder

build

public ChatMessageImageContent<T> build()

Description copied from interface: SemanticKernelBuilder

Build the object.

Specified by:

build in interface SemanticKernelBuilder<T>

Returns:

a constructed object.