NIMAIModelStreamCallResult.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.ai.model.NIMAIModelStreamCallContent;
import com.netease.nimlib.sdk.ai.model.NIMAIRAGInfo;
import java.io.Serializable;
import java.util.List;

/**
 * NIMAIModelStreamCallResult接口
 * <p>
 * 数字人请求代理接口的流式回复的结构体。
 * </p>
 *
 * @author jintao
 * @version 1.0
 */
public interface NIMAIModelStreamCallResult extends Serializable {

    /**
     * 获取 AI 响应的状态码。
     * <p>
     * 默认值为200，表示请求成功。
     *
     * @return 状态码
     */
    int getCode();

    /**
     * 获取数字人的 accountId。
     * <p>
     * 这是数字人唯一的标识符。
     *
     * @return 数字人的 accountId
     */
    String getAccountId();

    /**
     * 获取本次响应的标识。
     * <p>
     * 每次请求都会生成一个唯一的 requestId，用于追踪请求和响应。
     *
     * @return 请求标识
     */
    String getRequestId();

    /**
     * 获取请求 AI 的回复内容。
     * <p>
     * 这个对象包含了流式回复的具体内容。
     *
     * @return 回复内容
     */
    NIMAIModelStreamCallContent getContent();

    /**
     * 获取数字人回复内容的引用资源列表。
     * <p>
     * 这些资源可能包含图片、音频等多媒体信息。
     *
     * @return 引用资源列表
     */
    List<NIMAIRAGInfo> getAIRAGs();

    /**
     * 获取分片的时间戳。
     * <p>
     * 表示该分片生成的时间点。
     *
     * @return 时间戳（毫秒）
     */
    long getTimestamp();
}