Java/**
 * 添加 AI 监听
 * @param listener
 */
void addAIListener(V2NIMAIListener listener);

Objective-C//AI 消息的响应的回调
- (void)onProxyAIModelCall:(V2NIMAIModelCallResult *)data;
//AI 透传接口的流式响应的回调
- (void)onProxyAIModelStreamCall:(V2NIMAIModelStreamCallResult *)data;
/**
 * 添加数字人监听器
 *
 * @param listener 消息监听回调
 */
- (void)addAIListener:(id<V2NIMAIListener>)listener;

C++// AI 回调
struct V2NIMAIListener {
    nstd::function<void(const V2NIMAIModelCallResult& response)> onProxyAIModelCall;
    nstd::function<void(const V2NIMAIModelStreamCallResult& response)> onProxyAIModelStreamCall;
};
// 添加数字人监听器
virtual void addAIListener(V2NIMAIListener listener) = 0;

JavaV2NIMAIListener listener = new V2NIMAIListener() {
    /**
     * AI 消息的响应的回调
     *
     * @param result 本次响应的结构体
     */
    @Override
    public void onProxyAIModelCall(V2NIMAIModelCallResult result) {
        // do something
    }
    /**
     * AI 透传接口的流式响应的回调
     *
     * @param result 本次响应的结构体
     */
    @Override
    public void onProxyAIModelStreamCall(V2NIMAIModelStreamCallResult result) {
        // do something
    }
};

NIMClient.getService(V2NIMAIService.class).addAIListener(listener);

Objective-C[NIMSDK.sharedSDK.v2AIService addAIListener:self];

C++auto& aiService = v2::V2NIMClient::get().getAIService();
aiService.addAIListener(aiListener);

Java/**
 * 移除 AI 监听
 * @param listener
 */
void removeAIListener(V2NIMAIListener listener);

Objective-C/**
 * 删除数字人监听器
 *
 * @param listener 消息监听回调
 */
- (void)removeAIListener:(id<V2NIMAIListener>)listener;

C++virtual void removeAIListener(V2NIMAIListener listener) = 0;

JavaNIMClient.getService(V2NIMAIService.class).removeAIListener(listener);

Objective-C[NIMSDK.sharedSDK.v2AIService removeAIListener:self];

C++auto& aiService = v2::V2NIMClient::get().getAIService();
aiService.removeAIListener(aiListener);

TypeScript/**
 * 继承自 eventEmitter3 的监听事件方法
 */
interface V2NIMAIService extends EventEmitter3<V2NIMAIListener>

TypeScript```TypeScript
/**
 * 继承自 eventEmitter3 的监听事件方法
 */
interface V2NIMAIService extends EventEmitter3<V2NIMAIListener>

TypeScript/**
 * 继承自 eventEmitter3 的监听事件方法
 */
interface V2NIMAIService extends EventEmitter3<V2NIMAIListener>

TypeScriptnim.V2NIMAIService.on('onProxyAIModelCall', function() {
    // ... do something
})
nim.V2NIMAIService.on('onProxyAIModelStreamCall', function() {
    // ... do something
})

TypeScriptv2.aIListener.on("proxyAIModelCall", function (userStatusList: Array<V2NIMUserStatus>) {})
v2.aIListener.on("proxyAIModelStreamCall", function (aiStreamStatus: Array<V2NIMAIModelStreamCallStatus>) {})

TypeScriptnim.aiService.on('onProxyAIModelCall', function() {
    // ... do something
})
nim.aiService.on('onProxyAIModelStreamCall', function() {
    // ... do something
})

TypeScript/**
 * 继承自 eventEmitter3 的监听事件方法
 */
interface V2NIMAIService extends EventEmitter3<V2NIMAIListener>

TypeScript/**
 * 继承自 eventEmitter3 的监听事件方法
 */
interface V2NIMAIService extends EventEmitter3<V2NIMAIListener>

TypeScript/**
 * 继承自 eventEmitter3 的监听事件方法
 */
interface V2NIMAIService extends EventEmitter3<V2NIMAIListener>

TypeScriptnim.V2NIMAIService.off('onProxyAIModelCall', function() {
    // ... do something
})
nim.V2NIMAIService.off('onProxyAIModelStreamCall', function() {
    // ... do something
})

TypeScriptv2.aIListener.off("proxyAIModelCall", function () {
    // ... do something
})
v2.aIListener.off("proxyAIModelStreamCall", function () {
    // ... do something
})

TypeScriptnim.aiService.off('onProxyAIModelCall')
nim.aiService.off('onProxyAIModelStreamCall')

Java/**
 * 数字人拉取接口
 * @param success 成功回调
 * @param failure 失败回调
 */
void getAIUserList(V2NIMSuccessCallback<List<V2NIMAIUser>> success, V2NIMFailureCallback failure);

Objective-C/**
 * 数字人拉取接口
 * 返回全量的本 Appkey 相关的数字人用户
 *
 * @param success 请求成功回调
 * @param failure 请求失败回调
 */
- (void)getAIUserList:(nullable V2NIMGetAlUserListSuccess)success
              failure:(nullable V2NIMFailureCallback)failure;

C++    /// @brief 获取 AI 数字人列表
    /// @param success 成功回调
    /// @param failure 失败回调
    /// @return void
    /// @par 示例代码
    /// @code
    /// aiService.getAIUserList(
    ///     [](nstd::vector<nstd::shared_ptr<V2NIMAIUser>> result) {
    ///         // get AI users success
    ///     },
    ///     [](V2NIMError error) {
    ///         // get AI users failed, handle error
    ///     });
    /// @endcode
    virtual void getAIUserList(V2NIMSuccessCallback<nstd::vector<nstd::shared_ptr<V2NIMAIUser>>> success, V2NIMFailureCallback failure) = 0;

TypeScript/**
 * ESM 模式时，需要动态引入 V2NIMAIService 后使用:
 * NIM.registerService(V2NIMAIService, 'V2NIMAIService')
 *
 * 数字人拉取接口
 *
 * 注: 返回全量的本 Appkey 相关的数字人用户
 *
 * @returns 数字人用户列表
 */
getAIUserList(): Promise<V2NIMAIUser[]>

TypeScript/**
 * ESM 模式时，需要动态引入 V2NIMAIService 后使用:
 * NIM.registerService(V2NIMAIService, 'V2NIMAIService')
 *
 * 数字人拉取接口
 *
 * 注: 返回全量的本 Appkey 相关的数字人用户
 *
 * @returns 数字人用户列表
 */
getAIUserList(): Promise<V2NIMAIUser[]>

TypeScript  /**
 * 数字人拉取接口
 *
 * 注: 返回全量的本 Appkey 相关的数字人用户
 *
 * @returns 数字人用户列表
 */
getAIUserList(): Promise<V2NIMAIUser[]>

JavaNIMClient.getService(V2NIMAIService.class).getAIUserList(new V2NIMSuccessCallback<List<V2NIMAIUser>>() {
    @Override
    public void onSuccess(List<V2NIMAIUser> users) {
        // success
    }
}, new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // failure
    }
});

Objective-C[NIMSDK.sharedSDK.v2AIService getAIUserList:^(NSArray<V2NIMAIUser *> * _Nullable result) {
           // 成功回调
        } failure:^(V2NIMError * _Nonnull error) {
            // 失败回调
        }];

C++auto& AIService = v2::V2NIMClient::get().getAIService();
AIService.getAIUserList(
    [=](nstd::vector<nstd::shared_ptr<V2NIMAIUser>> result) {
        // 成功回调                                      auto detailString = xpack::json::encode(result);
    },
    [=](v2::V2NIMError error) {
        // 失败回调
    });

TypeScriptconst aiUsers = await nim.V2NIMAIService.getAIUserList()

TypeScriptconst aiUsers = await v2.aIService.getAIUserList()

TypeScriptconst aiUsers = await nim.aiService.getAIUserList()

无返回值。

Promise<V2NIMAIUser[]>：查询到的 AI 数字人列表。

• 请求成功，返回 V2NIMSuccessCallback 回调，包含 V2NIMAIUser AI 数字人列表。
• 请求失败，返回 V2NIMFailureCallback 回调，包含 AI 数字人相关错误码。

无。

Java/**
 * AI 数字人请求代理接口
 * @param params 请求参数
 * @param success 成功回调
 * @param failure 失败回调
 */
void proxyAIModelCall(V2NIMProxyAIModelCallParams params, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

Objective-C/**
 * AI 数字人请求代理接口
 *
 * @param params   接口入参
 * @param success 请求成功回调
 * @param failure 请求失败回调
 */

- (void)proxyAIModelCall:(V2NIMProxyAIModelCallParams *)params
                 success:(nullable V2NIMSuccessCallback)success
                 failure:(nullable V2NIMFailureCallback)failure;

C++    /// @brief AI 数字人请求代理接口
    /// @param params 接口入参
    /// @param success 成功回调
    /// @param failure 失败回调
    /// @return void
    /// @par 示例代码
    /// @code
    /// V2NIMProxyAIModelCallParams params;
    /// aiService.proxyAIModelCall(
    ///     params,
    ///     []() {
    ///         // update success
    ///     },
    ///     [](V2NIMError error) {
    ///         // update failed, handle error
    ///     });
    /// @endcode
    virtual void proxyAIModelCall(V2NIMProxyAIModelCallParams params, V2NIMSuccessCallback<void> success, V2NIMFailureCallback failure) = 0;

TypeScript/**
 * ESM 模式时，需要动态引入 V2NIMAIService 后使用:
 * NIM.registerService(V2NIMAIService, 'V2NIMAIService')
 *
 * AI 数字人请求代理接口
 *
 * @param params 接口入参
 */
proxyAIModelCall(params: V2NIMProxyAIModelCallParams): Promise<void>

TypeScript/**
 * ESM 模式时，需要动态引入 V2NIMAIService 后使用:
 * NIM.registerService(V2NIMAIService, 'V2NIMAIService')
 *
 * AI 数字人请求代理接口
 *
 * @param params 接口入参
 */
proxyAIModelCall(params): Promise<void>

TypeScriptproxyAIModelCall(params: V2NIMProxyAIModelCallParams): Promise<void>

JavaV2NIMProxyAIModelCallParams params = new V2NIMProxyAIModelCallParams.Builder()
    .accountId("accountId")
    .requestId("requestId")
    .content(new V2NIMAIModelCallContent("msg",0))
    .build();
NIMClient.getService(V2NIMAIService.class).proxyAIModelCall(params, new V2NIMSuccessCallback<Void>() {
    @Override
    public void onSuccess(Void unused) {
        // success
    }
}, new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // failure
    }
});

Objective-CV2NIMProxyAIModelCallParams *params = [[V2NIMProxyAIModelCallParams alloc] init];
    params.accountId = @"accid";
    params.requestId = @"requestId"
    //...
    [NIMSDK.sharedSDK.v2AIService proxyAIModelCall:params success:^{
        // 成功回调
    } failure:^(V2NIMError * _Nonnull error) {
        // 失败回调
    }];

C++auto& aiService = v2::V2NIMClient::get().getAIService();
V2NIMProxyAIModelCallParams proxyAIModelCallParams;
aiService.proxyAIModelCall(
    proxyAIModelCallParams,
    [=]() {
        // 成功回调
    },
    [=](v2::V2NIMError error) {
        // 失败回调
    });

TypeScriptawait nim.V2NIMAIService.proxyAIModelCall({
  "accountId": "YOUR_AI_ACCOUNT_ID",
  "requestId": "YOUR_REQUEST_ID",
  "content": {
    "msg": "YOUR_CONTENT_MSG",
    "type": 0
  }
})

TypeScriptawait v2.aIService.proxyAIModelCall({
  "accountId": "YOUR_AI_ACCOUNT_ID",
  "requestId": "YOUR_REQUEST_ID",
  "content": {
    "msg": "YOUR_CONTENT_MSG",
    "type": 0
  }
})

TypeScriptawait nim.aiService.proxyAIModelCall({
  "accountId": "YOUR_AI_ACCOUNT_ID",
  "requestId": "YOUR_REQUEST_ID",
  "content": {
    "msg": "YOUR_CONTENT_MSG",
    "type": 0
  }
})

无返回值。

Promise<void>

• 请求成功，返回 V2NIMSuccessCallback 回调，包含 V2NIMAIListener AI 数字人列表。
• 请求失败，返回 V2NIMFailureCallback 回调，包含 AI 数字人相关错误码。

调用成功，返回 onProxyAIModelCall 回调或 onProxyAIModelStreamCall 回调。

调用成功，返回 proxyAIModelCall 回调或 proxyAIModelStreamCall 回调。

Java/**
* 停止流式输出接口
* @param params 请求参数
* @param success 成功回调
* @param failure 失败回调
*/
void stopAIModelStreamCall(V2NIMAIModelStreamCallStopParams params, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

Objective-C/**
 * 停止流式输出
 *
 *  @param params   接口入参
 *  @param completion  完成后的回调
 */
- (void)stopAIModelStreamCall:(V2NIMAIModelStreamCallStopParams *)params
                            success:(nullable V2NIMSuccessCallback)success
                            failure:(nullable V2NIMFailureCallback)failure;

C++virtual void stopAIModelStreamCall(const V2NIMAIModelStreamCallStopParams& params,
    V2NIMSuccessCallback<void> success,
    V2NIMFailureCallback failure) = 0;

TypeScriptstopAIModelStreamCall(params: V2NIMAIModelStreamCallStopParams): Promise<void>

TypeScriptstopAIModelStreamCall(params): Promise<void>

TypeScriptstopAIModelStreamCall(params): Promise<void>

JavaV2NIMAIModelStreamCallStopParams params = new V2NIMAIModelStreamCallStopParams();
// AI 账号 ID
params.setAccountId(aiAccountId);
// 请求ID，和 proxyAIModelCall 中一致
params.setRequestId(requestId);

NIMSDK.sharedSDK().getV2AIService().stopAIModelStreamCall(params,
    new RequestCallback<Void>() {
        @Override
        public void onSuccess(Void result) {
            // Stop AI success
        }
        
        @Override
        public void onFailed(int code) {
            // Stop AI failed
        }
        
        @Override
        public void onException(Throwable exception) {
            // Exception occurred
        }
    });

Objective-CV2NIMAIModelStreamCallStopParams *params = [[V2NIMAIModelStreamCallStopParams alloc] init];
// AI 账号
params.accountId = aiAccountId;
// 请求 ID，和 proxyAIModelCall:completion:中一致
params.requestId = requestId;
[[NIMSDK sharedSDK].v2AIService stopAIModelStreamCall:params
                                            success:^{
   // Stop AI success
} failure:^(V2NIMError * _Nonnull error) {
   // Stop AI failed
}];

C++V2NIMAIModelStreamCallStopParams params;
params.accountId = "account_id";
params.requestId = "request_id";
aiService.stopAIModelStreamCall(
    params,
    []() {
        // stop AI model stream call success
    },
    [](V2NIMError error) {
        // stop AI model stream call failed, handle error
    });

TypeScriptawait nim.V2NIMAIService.stopAIModelStreamCall({
  accountId: 'AI user account ID',
  requestId: 'Request ID'
})

TypeScriptconst message = v2.aiService.stopAIModelStreamCall({
   accountId: 'AI user account ID',
   requestId: 'Request ID'
})

TypeScriptconst params: V2NIMAIModelStreamCallStopParams = {
  accountId: this.stopAccountId,
  requestId: this.stopRequestId
}
const aiService = nim.aiService! // Demo启用 ai 模块，aiService不为空
const res = await aiService.stopAIModelStreamCall(params)

无返回值。

Promise<void>

• 请求成功，返回 V2NIMSuccessCallback 回调。
• 请求失败，返回 V2NIMFailureCallback 回调，包含 AI 数字人相关错误码。

无。