node-nim 10.8.10 → 10.8.30-beta.215

package/types/v2_def/v2_nim_struct_def.d.ts

@@ -1,4 +1,4 @@
-import { V2NIMAIModelType, V2NIMAsymmetricEncryptionAlgorithm, V2NIMChatroomKickedReason, V2NIMChatroomMemberRole, V2NIMChatroomMessageNotificationType, V2NIMChatroomQueueChangeType, V2NIMChatroomQueueLevelMode, V2NIMClientAntispamOperateType, V2NIMClientAntispamThesaurusMatchType, V2NIMConversationType, V2NIMDataSyncType, V2NIMDownloadAttachmentType, V2NIMFCSAuthType, V2NIMFriendAddApplicationStatus, V2NIMFriendAddMode, V2NIMIPProtocolVersion, V2NIMLoginAuthType, V2NIMLoginClientType, V2NIMMessageAttachmentUploadState, V2NIMMessageClientAntispamOperatorType, V2NIMMessageNotificationType, V2NIMMessagePinState, V2NIMMessageRevokeType, V2NIMMessageSendingState, V2NIMMessageType, V2NIMProxyRequestMethod, V2NIMQueryDirection, V2NIMSDKLogLevel, V2NIMSignallingChannelType, V2NIMSignallingEventType, V2NIMSortOrder, V2NIMSQLCipherVersion, V2NIMSymmetricEncryptionAlgorithm, V2NIMTeamAgreeMode, V2NIMTeamChatBannedMode, V2NIMTeamInviteMode, V2NIMTeamJoinActionStatus, V2NIMTeamJoinActionType, V2NIMTeamJoinMode, V2NIMTeamMemberRole, V2NIMTeamMemberRoleQueryType, V2NIMTeamType, V2NIMTeamUpdateExtensionMode, V2NIMTeamUpdateInfoMode, V2NIMSearchKeywordMathType, V2NIMClearHistoryMode, V2NIMAIModelRoleType } from './v2_nim_enum_def';
+import { V2NIMAIModelType, V2NIMMessageAIStatus, V2NIMAsymmetricEncryptionAlgorithm, V2NIMChatroomKickedReason, V2NIMChatroomMemberRole, V2NIMChatroomMessageNotificationType, V2NIMChatroomQueueChangeType, V2NIMChatroomQueueLevelMode, V2NIMClientAntispamOperateType, V2NIMClientAntispamThesaurusMatchType, V2NIMConversationType, V2NIMDataSyncType, V2NIMDownloadAttachmentType, V2NIMFCSAuthType, V2NIMFriendAddApplicationStatus, V2NIMFriendAddMode, V2NIMIPProtocolVersion, V2NIMLoginAuthType, V2NIMLoginClientType, V2NIMMessageAttachmentUploadState, V2NIMMessageClientAntispamOperatorType, V2NIMMessageNotificationType, V2NIMMessagePinState, V2NIMMessageRevokeType, V2NIMMessageSendingState, V2NIMMessageType, V2NIMProxyRequestMethod, V2NIMQueryDirection, V2NIMSDKLogLevel, V2NIMSignallingChannelType, V2NIMSignallingEventType, V2NIMSortOrder, V2NIMSQLCipherVersion, V2NIMSymmetricEncryptionAlgorithm, V2NIMTeamAgreeMode, V2NIMTeamChatBannedMode, V2NIMTeamInviteMode, V2NIMTeamJoinActionStatus, V2NIMTeamJoinActionType, V2NIMTeamJoinMode, V2NIMTeamMemberRole, V2NIMTeamMemberRoleQueryType, V2NIMTeamType, V2NIMTeamUpdateExtensionMode, V2NIMTeamUpdateInfoMode, V2NIMSearchKeywordMathType, V2NIMClearHistoryMode, V2NIMAIModelRoleType, V2NIMMessageAIStreamStatus, V2NIMAIModelStreamCallStatus, V2NIMMessageAIStreamStopOpType, V2NIMMessageAIRegenOpType } from './v2_nim_enum_def';
 export interface V2NIMError {
     /** 错误码, 详见 V2NIMErrorCode */
     code?: number;
@@ -444,6 +444,21 @@ export interface V2NIMAIModelConfigParams {
     /** 取值范围(0,2)，用于控制随机性和多样性的程度。 */
     temperature?: number;
 }
+/** @brief 消息 AI RAG 信息 @since v10.8.30 */
+export interface V2NIMAIRAGInfo {
+    /** 引用资源的名称 */
+    name: string;
+    /** 引用资源的描述 */
+    description: string;
+    /** 引用资源的图标 */
+    icon: string;
+    /** 引用资源的链接 */
+    url: string;
+    /** 引用资源的标题 */
+    title: string;
+    /** 引用资源的时间 */
+    time: number;
+}
 export interface V2NIMAIModelCallResult {
     /** AI 响应的状态码 */
     code?: number;
@@ -453,6 +468,14 @@ export interface V2NIMAIModelCallResult {
     requestId?: string;
     /** 请求 AI 的回复 */
     content?: V2NIMAIModelCallContent;
+    /** 数字人回复内容的引用资源列表 @since v10.8.30 */
+    aiRAGs?: Array<V2NIMAIRAGInfo>;
+    /** 回复的时间戳 @since v10.8.30 */
+    timestamp: number;
+    /** 是否是流式响应，默认 false @since v10.8.30 */
+    aiStream: boolean;
+    /** 数字人流式响应状态 @since v10.8.30 */
+    aiStreamStatus: V2NIMAIModelStreamCallStatus;
 }
 export interface V2NIMProxyAIModelCallParams {
     /** 机器人账号 ID */
@@ -468,6 +491,20 @@ export interface V2NIMProxyAIModelCallParams {
     /** 请求接口模型相关参数配置， 如果参数不为空，则默认覆盖控制相关配置 */
     modelConfigParams?: V2NIMAIModelConfigParams;
 }
+export interface V2NIMMessageAIConfig {
+    /** 数字人账号信息 */
+    accountId?: string;
+    /** 缺省表示普通消息 */
+    aiStatus?: V2NIMMessageAIStatus;
+    /** 是否是流式消息 @since v10.8.30 */
+    aiStream: boolean;
+    /** 流式消息状态 @since v10.8.30 */
+    aiStreamStatus: V2NIMMessageAIStreamStatus;
+    /** AI RAG(Retrieval-Augmented Generation) 信息 @since v10.8.30 */
+    aiRAGs?: Array<V2NIMAIRAGInfo>;
+    /** 流式消息的分片信息 @since v10.8.30 */
+    aiStreamLastChunk?: V2NIMMessageAIStreamChunk;
+}
 export interface V2NIMMessage {
     /** 客户端消息 id */
     messageClientId?: string;
@@ -522,7 +559,7 @@ export interface V2NIMMessage {
     /** 消息发送者是否是自己 */
     isSelf?: boolean;
     /** AI 数字人相关信息 */
-    aiConfig?: V2NIMAIModelConfig;
+    aiConfig?: V2NIMMessageAIConfig;
     /** 消息更新时间 */
     modifyTime?: number;
     /** 消息更新者账号 */
@@ -595,13 +632,18 @@ export interface V2NIMMessageTargetConfig {
     newMemberVisible?: boolean;
 }
 export interface V2NIMAIModelCallMessage {
+    /** 上下文内容的角色 */
     role: V2NIMAIModelRoleType;
+    /** 上下文的内容 */
     msg: string;
+    /** 类型, 暂时只有 0, 代表文本, 预留扩展能力 */
     type: number;
 }
 export interface V2NIMMessageAIConfigParams {
     /** 数字人账号信息 */
     accountId: string;
+    /** 是否是流式响应，默认 false @since v10.8.30 */
+    aiStream: boolean;
     /** 请求大模型的内容 */
     content?: V2NIMAIModelCallContent;
     /** 上下文内容 */
@@ -2083,6 +2125,7 @@ export interface V2NIMCustomUserStatusPublishResult {
     /** 用户状态发布时的时间 */
     publishTime: number;
 }
+/** @brief 用户状态订阅结果 */
 export interface V2NIMUserStatusSubscribeResult {
     /** 查询的用户账号 */
     accountId: string;
@@ -2150,6 +2193,8 @@ export interface V2NIMMessageSearchExParams {
     senderAccountIds?: Array<string>;
     /** 匹配消息类型，为空则匹配所有类型 */
     messageTypes?: Array<V2NIMMessageType>;
+    /** 匹配消息子类型，为空则匹配所有子类型 @since v10.8.10 */
+    messageSubtypes?: Array<number>;
     /** 搜索的起始时间点，默认为 0（从现在开始搜索）。UTC 时间戳，单位：毫秒 */
     searchStartTime: number;
     /** 从起始时间点开始的过去时间范围，默认为 0（不限制时间范围）。24 x 60 x 60 x 1000 代表过去一天，单位：毫秒 */
@@ -2161,8 +2206,11 @@ export interface V2NIMMessageSearchExParams {
 }
 /** @brief 查询消息返回的结果项 @since v10.7.0 */
 export interface V2NIMMessageSearchItem {
+    /** 会话 ID */
     conversationId: string;
+    /** 返回的消息列表 */
     messages: Array<V2NIMMessage>;
+    /** 单个会话命中的数量 */
     count: number;
 }
 /** @brief 查询消息返回的结果 @since v10.7.0 */
@@ -2259,3 +2307,70 @@ export interface V2NIMLocalConversationOperationResult {
     /** 错误 */
     error?: V2NIMError;
 }
+/** @brief 消息 AI 流式消息分片信息 @since v10.8.30 */
+export interface V2NIMMessageAIStreamChunk {
+    /** 流式消息回复分片文本 */
+    content: string;
+    /** 流式消息时间，即占位消息时间 */
+    messageTime: number;
+    /** 流式消息当前分片时间，chunkTime >= messageTime */
+    chunkTime: number;
+    /** 类型，当前仅支持 0 表示文本 */
+    type: number;
+    /** 分片序号，从 0 开始 */
+    index: number;
+}
+/** @brief 停止数字人流式输出配置参数 @since v10.8.30 */
+export interface V2NIMMessageAIStreamStopParams {
+    /** 停止流式消息的操作类型 */
+    operationType: V2NIMMessageAIStreamStopOpType;
+    /** 更新的消息内容，仅当 operationType == V2NIM_MESSAGE_AI_STREAM_STOP_OP_UPDATE 有效 */
+    updateContent?: string;
+}
+/** @brief 重新生成 AI 回复消息参数 @since v10.8.30 */
+export interface V2NIMMessageAIRegenParams {
+    /** 重新输出数字人消息操作类型 */
+    operationType: V2NIMMessageAIRegenOpType;
+}
+/** @brief 透传协议流式分片信息 @since v10.8.30 */
+export interface V2NIMAIModelStreamCallChunk {
+    /** 数字人流式回复分片文本 */
+    content: string;
+    /** 数字人流式回复当前分片时间 */
+    chunkTime: number;
+    /** 类型，当前仅支持 0 表示文本 */
+    type: number;
+    /** 分片序号，从 0 开始 */
+    index: number;
+}
+/** @brief 流式回复内容 @since v10.8.30 */
+export interface V2NIMAIModelStreamCallContent {
+    /** 数字人流式回复分片组装好后的文本 */
+    msg: string;
+    /** 类型，当前仅支持 0 表示文本 */
+    type: number;
+    /** 数字人流式回复最近一个分片 */
+    lastChunk: V2NIMAIModelStreamCallChunk;
+}
+/** @brief 发送透传的 AI 流式消息响应内容 @since v10.8.30 */
+export interface V2NIMAIModelStreamCallResult {
+    /** AI 响应的状态码 */
+    code: number;
+    /** 数字人的账号 ID */
+    accountId: string;
+    /** 本次响应的标识 */
+    requestId: string;
+    /** 请求 AI 的回复内容 */
+    content?: V2NIMAIModelStreamCallContent;
+    /** 数字人回复内容的引用资源列表 */
+    aiRAGs?: Array<V2NIMAIRAGInfo>;
+    /** 分片的时间戳 */
+    timestamp: number;
+}
+/** @brief 停止透传接口的 AI 流式回复 @since v10.8.30 */
+export interface V2NIMAIModelStreamCallStopParams {
+    /** 数字人账号 ID */
+    accountId: string;
+    /** 请求 ID */
+    requestId: string;
+}