NIMMessageStreamConfig.java

浏览该文件的文档.

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

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

/**
 * 消息体当中的流式相关配置字段
 */
public class NIMMessageStreamConfig implements Serializable {
    /**
     * 流式消息状态
     */
    private NIMMessageStreamStatus status = NIMMessageStreamStatus.NIM_MESSAGE_STREAM_STATUS_NONE;

    /**
     * 流式消息最近一个分片
     * 流式过程中才有该字段，最终完整消息无此字段
     * 注意：流式过程中的消息text是将接收到的分片组装好之后
     */
    private NIMMessageStreamChunk lastChunk;

    /**
     * 流式消息引用资源列表
     * 可为null
     */
    private List<NIMAIRAGInfo> rags;

    public NIMMessageStreamConfig() {
    }

    /**
     * @param status 流式消息状态
     */
    public NIMMessageStreamConfig(NIMMessageStreamStatus status) {
        this.status = status;
    }

    /**
     * @param lastChunk 流式消息最近一个分片
     * @param status    流式消息状态
     */
    public NIMMessageStreamConfig(NIMMessageStreamStatus status,NIMMessageStreamChunk lastChunk) {
        this.status = status;
        this.lastChunk = lastChunk;
    }

    /**
     * @param lastChunk 流式消息最近一个分片
     * @param status    流式消息状态
     * @param rags      流式消息引用资源列表
     */
    public NIMMessageStreamConfig(NIMMessageStreamStatus status, NIMMessageStreamChunk lastChunk, List<NIMAIRAGInfo> rags) {
        this.status = status;
        this.lastChunk = lastChunk;
        this.rags = rags;
    }

    /**
     * 获取流式消息状态
     *
     * @return 流式消息状态
     */
    public NIMMessageStreamStatus getStatus() {
        if (status == null) {
            return NIMMessageStreamStatus.NIM_MESSAGE_STREAM_STATUS_NONE;
        }
        return status;
    }

    /**
     * 设置流式消息状态
     *
     * @param status 流式消息状态
     */
    public void setStatus(NIMMessageStreamStatus status) {
        this.status = status;
    }

    /**
     * 获取流式消息最近一个分片
     *
     * @return 流式消息最近一个分片
     */
    public NIMMessageStreamChunk getLastChunk() {
        return lastChunk;
    }

    /**
     * 设置流式消息最近一个分片
     *
     * @param lastChunk 流式消息最近一个分片
     */
    public void setLastChunk(NIMMessageStreamChunk lastChunk) {
        this.lastChunk = lastChunk;
    }

    /**
     * 获取流式消息引用资源列表
     *
     * @return 流式消息引用资源列表
     */
    public List<NIMAIRAGInfo> getRags() {
        return rags;
    }

    /**
     * 设置流式消息引用资源列表
     *
     * @param rags 流式消息引用资源列表
     */
    public void setRags(List<NIMAIRAGInfo> rags) {
        this.rags = rags;
    }

    public NIMMessageStreamConfig copy() {
        return new NIMMessageStreamConfig(status, lastChunk, rags);
    }
}