com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of semantickernel-api Show documentation
Defines the public interface for the Semantic Kernel
There is a newer version: 1.3.0
// Copyright (c) Microsoft. All rights reserved.
package com.microsoft.semantickernel.services.chatcompletion.message;

import com.microsoft.semantickernel.builders.SemanticKernelBuilder;
import com.microsoft.semantickernel.exceptions.SKException;
import com.microsoft.semantickernel.services.chatcompletion.AuthorRole;
import com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent;
import java.net.URL;
import java.util.Base64;
import javax.annotation.Nullable;

/**
 * Represents an image content in a chat message.
 *
 * @param  the type of the inner content within the message
 */
public class ChatMessageImageContent extends ChatMessageContent {

    private final ImageDetail detail;

    /**
     * Create a new instance of the {@link ChatMessageImageContent} class.
     * @param content The chat message content
     * @param modelId The LLM id to use for the chat
     * @param detail The detail level of the image to include in the chat message
     */
    public ChatMessageImageContent(
        String content,
        @Nullable String modelId,
        @Nullable ImageDetail detail) {
        super(
            AuthorRole.USER,
            content,
            modelId,
            null,
            null,
            null,
            ChatMessageContentType.IMAGE_URL);

        if (detail == null) {
            detail = ImageDetail.AUTO;
        }
        this.detail = detail;
    }

    /**
     * Get the detail level of the image to include in the chat message.
     *
     * @return the detail level of the image
     */
    public ImageDetail getDetail() {
        return detail;
    }

    /**
     * The detail level of the image to include in the chat message.
     */
    public enum ImageDetail {
        /**
         * Low detail
         */
        LOW,
        /**
         * High detail
         */
        HIGH,
        /**
         * Automatically determine the detail level
         */
        AUTO
    }

    /**
     * Create a new builder for the {@link ChatMessageImageContent} class.
     *
     * @param  the type of the inner content within the messages
     * @return a new builder
     */
    public static  Builder builder() {
        return new Builder<>();
    }

    /**
     * Builder for the {@link ChatMessageImageContent} class.
     * @param  the type of the inner content within the message
     */
    public static class Builder implements SemanticKernelBuilder> {

        @Nullable
        private String modelId = null;
        @Nullable
        private String content = null;
        @Nullable
        private ImageDetail detail = null;

        /**
         * Set the model ID to use for the chat message.
         *
         * @param modelId the model ID
         * @return {@code this} builder
         */
        public Builder withModelId(String modelId) {
            this.modelId = modelId;
            return this;
        }

        /**
         * Set the image content to include in the chat message.
         * @param imageType For instance jpg or png. For known types known to OpenAI see: docs.
         * @param content   the image content
         * @return {@code this} builder
         */
        public Builder withImage(
            String imageType,
            byte[] content) {
            this.content = String.format("data:image/%s;base64,%s",
                imageType,
                Base64.getEncoder().encodeToString(content));
            return this;
        }

        /**
         * Set the URL of the image to include in the chat message.
         *
         * @param url the URL of the image
         * @return {@code this} builder
         */
        public Builder withImageUrl(String url) {
            this.content = url;
            return this;
        }

        /**
         * Set the URL of the image to include in the chat message.
         *
         * @param url the URL of the image
         * @return {@code this} builder
         */
        public Builder withImageUrl(URL url) {
            this.content = url.toString();
            return this;
        }

        /**
         * Set the detail level of the image to include in the chat message.
         *
         * @param detail the detail level of the image
         * @return {@code this} builder
         */
        public Builder withDetail(ImageDetail detail) {
            this.detail = detail;
            return this;
        }

        @Override
        public ChatMessageImageContent build() {
            if (detail == null) {
                detail = ImageDetail.AUTO;
            }
            if (content == null) {
                throw new SKException("Image content is required");
            }
            return new ChatMessageImageContent<>(
                content,
                modelId,
                detail);
        }
    }
}