NIMAIModelCallResult.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.ai.enums.NIMAIModelStreamCallStatus;
import com.netease.nimlib.sdk.ai.model.NIMAIRAGInfo;
import com.netease.nimlib.sdk.ai.params.NIMAIModelCallContent;
import java.io.Serializable;
import java.util.List;

/**
 * 透传接口的 AI 回复的结构体
 */
public interface NIMAIModelCallResult extends Serializable {
    /**
     * 获取 AI 响应的状态码
     * @return 状态码
     */
    int getCode();

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

    /**
     * 获取本次响应的标识
     * @return requestId
     */
    String getRequestId();

    /**
     * 获取请求 AI 的回复
     * @return AI 的回复
     */
    NIMAIModelCallContent getContent();
    /**
     * 获取数字人回复内容引用资源列表
     * 可为null
     * @return 数字人回复内容引用资源列表
     */
    List<NIMAIRAGInfo> getAIRAGs();
    /**
     * 获取回复时间戳
     * @return 回复时间戳
     */
    long getTimestamp();
    /**
     * 获取是否是流式响应，默认值为false
     * @return 是否是流式响应
     */
    boolean isAIStream();
    /**
     * 获取数字人流式响应状态
     * @return 数字人流式响应状态
     */
    NIMAIModelStreamCallStatus getAIStreamStatus();


}