NIMMessageAIConfig.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg.model;

import com.netease.nimlib.sdk.ai.model.NIMAIRAGInfo;
import com.netease.nimlib.sdk.msg.constant.NIMMessageAIStatus;
import com.netease.nimlib.sdk.msg.enums.NIMMessageAIStreamStatus;
import java.io.Serializable;
import java.util.List;

/**
 * 用于配置消息 AI 的参数类
 */
public class NIMMessageAIConfig implements Serializable{
    /** 数字人的 accountId，发送/响应 都存在 */
    private String accountId;

    /** 该 AI 消息的询问和应答标识 0 表示普通消息, 1 表示是一个艾特数字人的消息, 2 表示是数字人响应艾特的消息，响应回参 */
    private NIMMessageAIStatus aiStatus;

    /**
     * 数字人回复内容引用资源列表
     * 可为null
     */
    private List<NIMAIRAGInfo> aiRAGs;

    /**
     * 是否是流式响应，默认值为false
     */
    private boolean aiStream = false;

    /**
     * 数字人流式消息状态
     */
    private NIMMessageAIStreamStatus aiStreamStatus = NIMMessageAIStreamStatus.NIM_MESSAGE_AI_STREAM_STATUS_NONE;

    /**
     * 数字人流式消息最近一个分片
     * 可为null
     * 注意：流式过程中的消息text是将接收到的分片组装好之后
     */
    private NIMMessageAIStreamChunk aiStreamLastChunk;



    /**
     * 获取数字人的 accountId
     * @return 数字人的 accountId
     */
    public String getAccountId() {
        return accountId;
    }

    /**
     * 设置数字人的 accountId
     * @param accountId 数字人的 accountId
     */
    public void setAccountId(String accountId) {
        this.accountId = accountId;
    }

    /**
     * 获取该 AI 消息的询问和应答标识
     * @return 该 AI 消息的询问和应答标识
     */
    public NIMMessageAIStatus getAIStatus() {
        return aiStatus;
    }

    /**
     * 设置该 AI 消息的询问和应答标识
     * @param aiStatus 该 AI 消息的询问和应答标识
     */
    public void setAIStatus(NIMMessageAIStatus aiStatus) {
        this.aiStatus = aiStatus;
    }

    /**
     * 获取数字人回复内容引用资源列表
     *
     * @return 引用资源列表
     */
    public List<NIMAIRAGInfo> getAIRAGs() {
        return aiRAGs;
    }

    /**
     * 设置数字人回复内容引用资源列表
     *
     * @param aiRAGs 引用资源列表
     */
    public void setAIRAGs(List<NIMAIRAGInfo> aiRAGs) {
        this.aiRAGs = aiRAGs;
    }

    /**
     * 判断是否为流式响应
     *
     * @return 如果是流式响应则返回true，否则返回false
     */
    public boolean isAIStream() {
        return aiStream;
    }

    /**
     * 设置是否为流式响应
     *
     * @param aiStream 是否为流式响应
     */
    public void setAIStream(boolean aiStream) {
        this.aiStream = aiStream;
    }

    /**
     * 获取数字人流式消息状态
     *
     * @return 流式消息状态
     */
    public NIMMessageAIStreamStatus getAIStreamStatus() {
        return aiStreamStatus;
    }

    /**
     * 设置数字人流式消息状态
     *
     * @param aiStreamStatus 流式消息状态
     */
    public void setAIStreamStatus(NIMMessageAIStreamStatus aiStreamStatus) {
        this.aiStreamStatus = aiStreamStatus;
        if(this.aiStreamStatus == null){
            this.aiStreamStatus = NIMMessageAIStreamStatus.NIM_MESSAGE_AI_STREAM_STATUS_NONE;
        }
    }

    /**
     * 获取数字人流式消息最近一个分片
     *
     * @return 流式消息最近一个分片
     */
    public NIMMessageAIStreamChunk getAIStreamLastChunk() {
        return aiStreamLastChunk;
    }

    /**
     * 设置数字人流式消息最近一个分片
     *
     * @param aiStreamLastChunk 流式消息最近一个分片
     */
    public void setAIStreamLastChunk(NIMMessageAIStreamChunk aiStreamLastChunk) {
        this.aiStreamLastChunk = aiStreamLastChunk;
    }

    @Override
    public String toString() {
        return "NIMMessageAIConfig{" +
                "accountId='" + accountId + '\'' +
                ", aiStatus=" + aiStatus +
                ", aiRAGs=" + aiRAGs +
                ", aiStream=" + aiStream +
                ", aiStreamStatus=" + aiStreamStatus +
                ", aiStreamLastChunk=" + aiStreamLastChunk +
                '}';
    }

    /**
     * 浅拷贝
     * @return 拷贝后的对象
     */
    public NIMMessageAIConfig copy() {
        NIMMessageAIConfig copy = new NIMMessageAIConfig();
        copy.accountId = accountId;
        copy.aiStatus = aiStatus;
        copy.aiRAGs = aiRAGs;
        copy.aiStream = aiStream;
        copy.aiStreamStatus = aiStreamStatus;
        copy.aiStreamLastChunk = aiStreamLastChunk;
        return copy;
    }
}