NIMProxyAIModelCallParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.ai.params;

import android.text.TextUtils;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.ai.config.NIMProxyAICallAntispamConfig;
import com.netease.nimlib.util.StringUtil;
import java.io.Serializable;
import java.util.List;

public class NIMProxyAIModelCallParams implements Serializable {

    private static final String TAG = "NIMProxyAIModelCallParams";

    /**
     * 机器人账号ID，AIUser对应的账号ID
     */
    private final String accountId;

    /**
     * 请求id
     */
    private final String requestId;

    /**
     * 请求大模型的内容
     */
    private final NIMAIModelCallContent content;

    /**
     * 上下文内容
     */
    private List<NIMAIModelCallMessage> messages;

    /**
     * 提示词变量占位符替换，JSON 格式的字符串用于填充prompt中的变量
     */
    private String promptVariables;

    /**
     * 请求接口模型相关参数配置， 如果参数不为空，则默认覆盖控制相关配置
     */
    private NIMAIModelConfigParams modelConfigParams;

    /**
     * 反垃圾配置, 复用消息体里的部分反垃圾字段
     */
    private NIMProxyAICallAntispamConfig antispamConfig;

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

    private NIMProxyAIModelCallParams() {
        this(null, null, null);
    }

    /**
     * 构造函数
     *
     * @param accountId 机器人账号ID
     * @param requestId 请求id
     * @param content 请求大模型的内容
     */
    public NIMProxyAIModelCallParams(String accountId, String requestId, NIMAIModelCallContent content) {
        this.accountId = accountId;
        this.requestId = requestId;
        this.content = content;
    }



    /**
     * 获取机器人账号ID
     *
     * @return 机器人账号ID
     */
    public String getAccountId() {
        return accountId;
    }


    /**
     * 获取请求id
     *
     * @return 请求id
     */
    public String getRequestId() {
        return requestId;
    }


    /**
     * 获取请求大模型的内容
     *
     * @return 请求大模型的内容
     */
    public NIMAIModelCallContent getContent() {
        return 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 NIMProxyAICallAntispamConfig getAntispamConfig() {
        return antispamConfig;
    }

    /**
     * 设置反垃圾配置
     *
     * @param antispamConfig 反垃圾配置
     */
    public void setAntispamConfig(NIMProxyAICallAntispamConfig antispamConfig) {
        this.antispamConfig = antispamConfig;
    }

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

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

    /**
     * 是否有效
     * @return 是否有效
     */
    public boolean isValid(){
        if(TextUtils.isEmpty(accountId)){
            NimLog.e(TAG, "accountId is empty");
            return false;
        }

        if(TextUtils.isEmpty(requestId)){
            NimLog.e(TAG, "requestId 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 String requestId;
        private NIMAIModelCallContent content;
        private List<NIMAIModelCallMessage> messages;
        private String promptVariables;
        private NIMAIModelConfigParams modelConfigParams;
        private NIMProxyAICallAntispamConfig antispamConfig;

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

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

        /**
         * 设置请求id
         * @param requestId 请求id
         * @return Builder
         */
        public Builder requestId(String requestId) {
            this.requestId = requestId;
            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;
        }

        public Builder antispamConfig(NIMProxyAICallAntispamConfig antispamConfig) {
            this.antispamConfig = antispamConfig;
            return this;
        }

        public Builder aiStream(boolean aiStream) {
            this.aiStream = aiStream;
            return this;
        }

        /**
         * 构建NIMProxyAIModelCallParams
         * @return NIMProxyAIModelCallParams
         */
        public NIMProxyAIModelCallParams build() {
            NIMProxyAIModelCallParams params = new NIMProxyAIModelCallParams(accountId, requestId, content);
            params.messages = messages;
            params.promptVariables = promptVariables;
            params.modelConfigParams = modelConfigParams;
            params.antispamConfig = antispamConfig;
            params.aiStream = aiStream;
            return params;
        }
    }
}