V2NIMMessageAIConfigParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message.params;

import android.text.TextUtils;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.v2.ai.params.V2NIMAIModelCallContent;
import com.netease.nimlib.sdk.v2.ai.params.V2NIMAIModelCallMessage;
import com.netease.nimlib.sdk.v2.ai.params.V2NIMAIModelConfigParams;
import com.netease.nimlib.util.StringUtil;
import java.io.Serializable;
import java.util.List;

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

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

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

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

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

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

    private V2NIMMessageAIConfigParams() {
        this(null);
    }

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

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


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

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

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

    /**
     * 获取过滤后的上下文内容（过滤掉 msg 为 null 或 trim 后为空字符串的 message）
     * @return 过滤后的上下文内容
     */
    public List<V2NIMAIModelCallMessage> getFilteredMessages() {
        if (messages == null || messages.isEmpty()) {
            return messages;
        }
        List<V2NIMAIModelCallMessage> filteredMessages = new java.util.ArrayList<>();
        for (V2NIMAIModelCallMessage message : messages) {
            if (message != null && !message.shouldBeFiltered()) {
                filteredMessages.add(message);
            }
        }
        return filteredMessages;
    }

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

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

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

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

    /**
     * 设置请求接口模型相关参数配置
     * @param modelConfigParams 请求接口模型相关参数配置
     */
    public void setModelConfigParams(V2NIMAIModelConfigParams 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;
        }

        // 只校验不会被过滤掉的 message（msg 非空且 trim 后非空的 message）
        if(messages != null && !messages.isEmpty()){
            for(V2NIMAIModelCallMessage message : messages){
                // 跳过 null 或会被过滤掉的 message，不进行校验
                if(message == null || message.shouldBeFiltered()){
                    continue;
                }
                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 String getInvalidMsg() {
        if (TextUtils.isEmpty(accountId)) {
            return "accountId is empty";
        }

        if (content != null && !content.isValid()) {
            return "content is invalid";
        }

        // 只校验不会被过滤掉的 message（msg 非空且 trim 后非空的 message）
        if(messages != null && !messages.isEmpty()){
            for(V2NIMAIModelCallMessage message : messages){
                // 跳过 null 或会被过滤掉的 message，不进行校验
                if(message == null || message.shouldBeFiltered()){
                    continue;
                }
                String invalidMsg = message.getInvalidMsg();
                if(invalidMsg != null){
                    return "message."+invalidMsg;
                }
            }
        }

        if(promptVariables != null && !StringUtil.isJson(promptVariables)){
            return "promptVariables is not json";
        }

        return null;
    }

    public static class Builder {
        private String accountId;
        private V2NIMAIModelCallContent content;
        private List<V2NIMAIModelCallMessage> messages;
        private String promptVariables;
        private V2NIMAIModelConfigParams modelConfigParams;
        private boolean aiStream = false;

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

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

        /**
         * 设置上下文内容
         * @param messages 上下文内容
         * @return Builder
         */
        public Builder messages(List<V2NIMAIModelCallMessage> 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(V2NIMAIModelConfigParams modelConfigParams) {
            this.modelConfigParams = modelConfigParams;
            return this;
        }
        /**
         * 设置是否流式响应
         * @param aiStream 是否流式响应
         * @return Builder
         */
        public Builder aiStream(boolean aiStream) {
            this.aiStream = aiStream;
            return this;
        }
        /**
         * 构建V2NIMMessageAIConfigParams对象
         * @return V2NIMMessageAIConfigParams
         */
        public V2NIMMessageAIConfigParams build() {
            V2NIMMessageAIConfigParams params = new V2NIMMessageAIConfigParams(this.accountId);
            params.setContent(this.content);
            params.setMessages(this.messages);
            params.setPromptVariables(this.promptVariables);
            params.setModelConfigParams(this.modelConfigParams);
            params.setAIStream(this.aiStream);
            return params;
        }
    }
}