io.github.sashirestela.openai.domain.chat.ChatMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of simple-openai Show documentation
A Java library to use the OpenAI API in the simplest possible way.
There is a newer version: 3.8.1
package io.github.sashirestela.openai.domain.chat;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;
import com.fasterxml.jackson.databind.annotation.JsonNaming;
import io.github.sashirestela.openai.common.content.ContentPart.ChatContentPart;
import io.github.sashirestela.openai.common.tool.ToolCall;
import io.github.sashirestela.slimvalidator.constraints.ObjectType;
import io.github.sashirestela.slimvalidator.constraints.Required;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

import java.util.List;

@Getter
@Setter
public abstract class ChatMessage {

    protected ChatRole role;

    public enum ChatRole {

        @JsonProperty("system")
        SYSTEM,

        @JsonProperty("user")
        USER,

        @JsonProperty("assistant")
        ASSISTANT,

        @JsonProperty("tool")
        TOOL;

    }

    @Getter
    @JsonInclude(Include.NON_EMPTY)
    public static class SystemMessage extends ChatMessage {

        @Required
        private String content;

        private String name;

        private SystemMessage(String content, String name) {
            this.role = ChatRole.SYSTEM;
            this.content = content;
            this.name = name;
        }

        public static SystemMessage of(String content, String name) {
            return new SystemMessage(content, name);
        }

        public static SystemMessage of(String content) {
            return new SystemMessage(content, null);
        }

    }

    @Getter
    @JsonInclude(Include.NON_EMPTY)
    public static class UserMessage extends ChatMessage {

        @Required
        @ObjectType(baseClass = String.class)
        @ObjectType(baseClass = ChatContentPart.class, firstGroup = true)
        private Object content;

        private String name;

        private UserMessage(Object content, String name) {
            this.role = ChatRole.USER;
            this.content = content;
            this.name = name;
        }

        public static UserMessage of(Object content, String name) {
            return new UserMessage(content, name);
        }

        public static UserMessage of(Object content) {
            return new UserMessage(content, null);
        }

    }

    @Getter
    @JsonInclude(Include.NON_EMPTY)
    @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
    public static class AssistantMessage extends ChatMessage {

        @JsonInclude
        private String content;

        private String name;

        private List toolCalls;

        private AssistantMessage(String content, String name, List toolCalls) {
            this.role = ChatRole.ASSISTANT;
            this.content = content;
            this.name = name;
            this.toolCalls = toolCalls;
        }

        public static AssistantMessage of(String content, String name, List toolCalls) {
            return new AssistantMessage(content, name, toolCalls);
        }

        public static AssistantMessage of(String content, List toolCalls) {
            return new AssistantMessage(content, null, toolCalls);
        }

        public static AssistantMessage of(String content, String name) {
            return new AssistantMessage(content, name, null);
        }

        public static AssistantMessage of(String content) {
            return new AssistantMessage(content, null, null);
        }

    }

    @Getter
    @ToString
    @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
    public static class ToolMessage extends ChatMessage {

        @Required
        private String content;

        @Required
        private String toolCallId;

        private ToolMessage(String content, String toolCallId) {
            this.role = ChatRole.TOOL;
            this.content = content;
            this.toolCallId = toolCallId;
        }

        public static ToolMessage of(String content, String toolCallId) {
            return new ToolMessage(content, toolCallId);
        }

    }

    @NoArgsConstructor
    @Getter
    @Setter
    @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
    public static class ResponseMessage extends ChatMessage {

        private String content;
        private List toolCalls;
        private String refusal;

    }

}