NIMAIRAGInfo.java

浏览该文件的文档.

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

import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.util.EncryptUtil;
import java.io.Serializable;
import java.util.Objects;

/**
 * NIMAIRAGInfo类
 * <p>
 * 用于表示RAG(检索增强生成)信息，存储与引用资源相关的数据。
 * </p>
 *
 * @author jintao
 * @version 1.0
 */
public class NIMAIRAGInfo implements Serializable {

    private String name = "";

    private String icon = "";

    /**
     * 引用资源的标题
     * <p>
     * 该字段存储引用资源的标题信息，必须存在。
     * </p>
     */
    private String title = "";

    /**
     * 引用资源的描述
     * <p>
     * 该字段存储引用资源的描述信息，必须存在。
     * 默认值为空字符串("")。
     * </p>
     */
    private String description = "";

    /**
     * 引用资源的时间戳
     * <p>
     * 该字段表示引用资源的时间信息，以毫秒为单位，必须存在。
     * </p>
     */
    private long time = 0L;

    /**
     * 引用资源的URL链接
     * <p>
     * 该字段存储引用资源的网络地址，必须存在。
     * </p>
     */
    private String url = "";

    /**
     * 默认构造函数
     */
    private NIMAIRAGInfo() {
    }

    /**
     * 完整参数构造函数
     *
     * @param name rag的名称
     * @param icon rag的icon
     * @param title 引用资源的标题
     * @param description 引用资源的描述
     * @param time 引用资源的时间戳
     * @param url 引用资源的URL链接
     */
    public NIMAIRAGInfo(String name,String icon,String title, String description, long time, String url) {
        this.name = name;
        this.icon = icon;
        this.title = title;
        this.description = description;
        this.time = time;
        this.url = url;
    }
    /**
     * 获取rag的名称
     *
     * @return  rag的名称
     */
    public String getName() {
        return name;
    }

    /**
     * 获取rag的icon
     * @return rag的icon
     */
    public String getIcon() {
        return icon;
    }

    /**
     * 获取引用资源的标题
     *
     * @return  引用资源的标题
     */
    public String getTitle() {
        return title;
    }

    /**
     * 获取引用资源的描述
     *
     * @return  引用资源的描述
     */
    public String getDescription() {
        return description;
    }

    /**
     * 获取引用资源的时间戳
     *
     * @return  引用资源的时间戳
     */
    public long getTime() {
        return time;
    }

    /**
     * 获取引用资源的URL链接
     *
     * @return  引用资源的URL链接
     */
    public String getUrl() {
        return url;
    }

    @Override
    public boolean equals(Object o) {
        if (!(o instanceof NIMAIRAGInfo)) {
            return false;
        }
        NIMAIRAGInfo that = (NIMAIRAGInfo) o;
        return time == that.time && Objects.equals(name, that.name) && Objects.equals(icon, that.icon) && Objects.equals(title, that.title)
            && Objects.equals(description, that.description) && Objects.equals(url, that.url);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, icon, title, description, time, url);
    }

    /**
     * 重写toString方法，用于调试和日志输出
     *
     * @return 对象的字符串表示形式
     */
    @Override
    public String toString() {
        if(NimLog.isDebugLog()){
            return "NIMAIRAGInfo{" +
                "name='" + name + '\'' +
                ", icon='" + icon + '\'' +
                ", title='" + title + '\'' +
                ", description='" + description + '\'' +
                ", time=" + time +
                ", url='" + url + '\'' +
                '}';
        }else{
            return "NIMAIRAGInfo{" +
                "name='" + EncryptUtil.encryptBase64(name) + '\'' +
                ", icon='" + EncryptUtil.encryptBase64(icon) + '\'' +
                ", title='" + EncryptUtil.encryptBase64(title) + '\'' +
                ", description='" + EncryptUtil.encryptBase64(description) + '\'' +
                ", time=" + time +
                ", url='" + EncryptUtil.encryptBase64(url) + '\'' +
                '}';
        }

    }
}