xyz.felh.openai.assistant.message.MessageContent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core of OpenAI API
There is a newer version: 4.0.2024102501
package xyz.felh.openai.assistant.message;

import com.alibaba.fastjson2.annotation.JSONField;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import lombok.Data;
import xyz.felh.openai.IOpenAiBean;

import java.util.Arrays;
import java.util.List;

@Data
public class MessageContent implements IOpenAiBean {

    /**
     * The index of the content part in the message.
     * It is shown in message delta.
     */
    @JSONField(name = "index")
    @JsonProperty("index")
    private Integer index;

    /**
     * image_file or text
     * 
     * See {@link Type}
     */
    @JSONField(name = "type")
    @JsonProperty("type")
    private Type type;

    /**
     * References an image {@link xyz.felh.openai.file.File} in the content of a message.
     */
    @JSONField(name = "image_file")
    @JsonProperty("image_file")
    private ImageFile imageFile;

    /**
     * The text content that is part of a message.
     */
    @JSONField(name = "text")
    @JsonProperty("text")
    private Text text;

    @Data
    public static class ImageFile {
        /**
         * The {@link xyz.felh.openai.file.File} ID of the image in the message content.
         */
        @JSONField(name = "file_id")
        @JsonProperty("file_id")
        private String fileId;
    }

    @Data
    public static class Text {
        /**
         * The data that makes up the text.
         */
        @JSONField(name = "value")
        @JsonProperty("value")
        private String value;

        /**
         * annotations
         * 

         * File citation
         * A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files.
         * 
         * File path
         * A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.
         */
        @JSONField(name = "annotations")
        @JsonProperty("annotations")
        private List annotations;
    }

    @Data
    public static class TextAnnotation {
        /**
         * file_citation or file_path
         */
        @JSONField(name = "type")
        @JsonProperty("type")
        private String type;

        /**
         * The text in the message content that needs to be replaced.
         */
        @JSONField(name = "text")
        @JsonProperty("text")
        private String text;

        @JSONField(name = "file_citation")
        @JsonProperty("file_citation")
        private FileCitation fileCitation;

        @JSONField(name = "file_path")
        @JsonProperty("file_path")
        private FilePath filePath;

        @JSONField(name = "start_index")
        @JsonProperty("start_index")
        private Integer startIndex;

        @JSONField(name = "end_index")
        @JsonProperty("end_index")
        private Integer endIndex;
    }

    @Data
    public static class FileCitation {
        /**
         * The ID of the specific File the citation is from.
         */
        @JSONField(name = "file_id")
        @JsonProperty("file_id")
        private String fileId;

        /**
         * The specific quote in the file.
         */
        @JSONField(name = "quote")
        @JsonProperty("quote")
        private String quote;
    }

    @Data
    public static class FilePath {
        /**
         * The ID of the specific File the citation is from.
         */
        @JSONField(name = "file_id")
        @JsonProperty("file_id")
        private String fileId;
    }

    public enum Type {
        IMAGE_FILE("image_file"),
        TEXT("text");

        private final String value;

        Type(final String value) {
            this.value = value;
        }

        @JsonValue
        public String value() {
            return value;
        }

        public static Type findByValue(String value) {
            return Arrays.stream(values()).filter(it ->
                    it.value.equals(value)).findFirst().orElse(null);
        }

    }

}