NIMMessageAIConfigParams.java

浏览该文件的文档.

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

import android.text.TextUtils;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.ai.params.NIMAIModelCallContent;
import com.netease.nimlib.sdk.ai.params.NIMAIModelCallMessage;
import com.netease.nimlib.sdk.ai.params.NIMAIModelConfigParams;
import com.netease.nimlib.util.StringUtil;
import java.io.Serializable;
import java.util.List;

/**
 * 用于配置 NIM 消息 AI 的参数类
 */
public class NIMMessageAIConfigParams implements Serializable {

    private static final String TAG = "NIMMessageAIConfigParams";
    /** 数字人的 accountId，发送/响应 都存在 */
    private final String accountId;

    /** 请求大模型的内容，发送入参 */
    private NIMAIModelCallContent content;

    /** 上下文内容，当前只支持文本消息，发送入参 */
    private List<NIMAIModelCallMessage> messages;

    /** 提示词变量占位符替换，JSON 格式的字符串，用于填充 prompt 中的变量。如果 NIMAIUser 中的 modelConfig.prompt 定义了变量，则必填. 端测不校验，发送入参 */
    private String promptVariables;

    /** 请求接口模型相关参数配置，如果参数不为空，则默认覆盖控制相关配置，发送入参 */
    private NIMAIModelConfigParams modelConfigParams;
    /**
     * 是否流式响应，默认为 false
     */
    private boolean aiStream = false;

    private NIMMessageAIConfigParams() {
        this(null);
    }

    /**
     * 构造函数
     * @param accountId 数字人的 accountId
     */
    public NIMMessageAIConfigParams(String accountId) {
        this.accountId = accountId;
    }

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


    /**
     * 获取请求大模型的内容
     * @return 请求大模型的内容
     */
    public NIMAIModelCallContent getContent() {
        return content;
    }

    /**
     * 设置请求大模型的内容
     * @param content 请求大模型的内容
     */
    public void setContent(NIMAIModelCallContent content) {
        this.content = content;
    }

    /**
     * 获取上下文内容
     * @return 上下文内容
     */
    public List<NIMAIModelCallMessage> getMessages() {
        return messages;
    }

    /**
     * 设置上下文内容
     * @param messages 上下文内容
     */
    public void setMessages(List<NIMAIModelCallMessage> messages) {
        this.messages = messages;
    }

    /**
     * 获取提示词变量占位符替换
     * @return 提示词变量占位符替换
     */
    public String getPromptVariables() {
        return promptVariables;
    }

    /**
     * 设置提示词变量占位符替换
     * @param promptVariables 提示词变量占位符替换
     */
    public void setPromptVariables(String promptVariables) {
        this.promptVariables = promptVariables;
    }

    /**
     * 获取请求接口模型相关参数配置
     * @return 请求接口模型相关参数配置
     */
    public NIMAIModelConfigParams getModelConfigParams() {
        return modelConfigParams;
    }

    /**
     * 设置请求接口模型相关参数配置
     * @param modelConfigParams 请求接口模型相关参数配置
     */
    public void setModelConfigParams(NIMAIModelConfigParams modelConfigParams) {
        this.modelConfigParams = modelConfigParams;
    }

    /**
     * 是否流式响应
     * @return 是否流式响应
     */
    public boolean isAIStream() {
        return aiStream;
    }

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

    public boolean isValid() {
        if (TextUtils.isEmpty(accountId)) {
            NimLog.e(TAG, "accountId is empty");
            return false;
        }

        if (content != null && !content.isValid()) {
            NimLog.e(TAG, "content is invalid");
            return false;
        }

        if(messages != null && !messages.isEmpty()){
            for(NIMAIModelCallMessage message : messages){
                if(!message.isValid()){
                    NimLog.e(TAG, "message is invalid");
                    return false;
                }
            }
        }

        if(promptVariables != null && !StringUtil.isJson(promptVariables)){
            NimLog.e(TAG, "promptVariables is invalid");
            return false;
        }

        return true;
    }

    /**
     * 构造器
     */
    public static class Builder {
        private String accountId;
        private NIMAIModelCallContent content;
        private List<NIMAIModelCallMessage> messages;
        private String promptVariables;
        private NIMAIModelConfigParams modelConfigParams;
        private boolean aiStream = false;

        /**
         * 设置机器人账号ID
         * @param accountId 机器人账号ID
         * @return Builder
         */
        public Builder accountId(String accountId) {
            this.accountId = accountId;
            return this;
        }

        /**
         * 设置请求大模型的内容
         * @param content 请求大模型的内容
         * @return Builder
         */
        public Builder content(NIMAIModelCallContent content) {
            this.content = content;
            return this;
        }

        /**
         * 设置上下文内容
         * @param messages 上下文内容
         * @return Builder
         */
        public Builder messages(List<NIMAIModelCallMessage> messages) {
            this.messages = messages;
            return this;
        }

        /**
         * 设置提示词变量占位符替换
         * @param promptVariables 提示词变量占位符替换
         * @return Builder
         */
        public Builder promptVariables(String promptVariables) {
            this.promptVariables = promptVariables;
            return this;
        }

        /**
         * 设置请求接口模型相关参数配置
         * @param modelConfigParams 请求接口模型相关参数配置
         * @return Builder
         */
        public Builder modelConfigParams(NIMAIModelConfigParams modelConfigParams) {
            this.modelConfigParams = modelConfigParams;
            return this;
        }

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

        /**
         * 构建 NIMMessageAIConfigParams 对象
         * @return NIMMessageAIConfigParams 对象
         */
        public NIMMessageAIConfigParams build() {
            NIMMessageAIConfigParams params = new NIMMessageAIConfigParams(accountId);
                params.content = content;
                params.messages = messages;
                params.promptVariables = promptVariables;
                params.modelConfigParams = modelConfigParams;
                params.aiStream= aiStream;
                return params;
        }
    }
}