主入口（HwICSUiSdk）

activeInteractionMode

(static) activeInteractionMode(): Promise<InteractionModeResult>

【功能说明】

获取当前生效的交互模式（语音问答/文本问答）。

【请求参数】

无。

【返回参数】

【代码示例】

const { result, interactionMode } = await HwICSUiSdk.activeInteractionMode();

addEventListeners

(static) addEventListeners(eventMap: EventMap): void

【功能说明】

设置事件回调。

【请求参数】

【返回参数】

无

【代码示例】

HwICSUiSdk.addEventListeners({
  error: (icsError) => {
    console.error('icsError', icsError);
  },
  jobInfoChange: (jobInfo) => {
    console.info('jobInfoChange', jobInfo);
  } 
});

checkBrowserSupport

(static) checkBrowserSupport(): Promise<boolean>

【功能说明】

检查当前浏览器是否支持运行SDK。

【请求参数】

无

【返回参数】

Promise<boolean>：当前浏览器是否支持运行SDK。

【代码示例】

1
2
3
4
5
6

const result = await HwICSUiSdk.checkBrowserSupport();
if (result) {
  // 支持
} else {
  // 不支持
}

create

(static) create(param: CreateParam): Promise<void>

【功能说明】

通过获取的任务链接和一次性鉴权码，创建智能交互任务。

【请求参数】

【返回参数】

无

【代码示例】

HwICSUiSdk.create({
  serverAddress: 'serverAddress',
  onceCode: 'onceCode',
  robotId: 'robotId',
  containerId: 'ics-root',
  logLevel: 'debug',
  config: {
    enableCaption: true,
    enableChatBtn: false
  },
  eventListeners: {
    error: (error) => {
      console.error('sdk error', {
        message: error.message,
        code: error.code,
      }, error);
    }
  }
});

destroy

(static) destroy(): Promise<void>

【功能说明】

销毁交互任务。

【请求参数】

无

【返回参数】

无

【代码示例】

HwICSUiSdk.destroy();

getJobInfo

(static) getJobInfo(): Promise<JobInfo>

【功能说明】

获取交互任务信息。

【请求参数】

无

【返回参数】

【代码示例】

const jobInfo = await HwICSUiSdk.getJobInfo();

interactionModeSwitch

(static) interactionModeSwitch(param: InteractionModeParam): Promise<InteractionModeResult>

【功能说明】

切换交互模式（语音问答/文本问答）。

【请求参数】

【返回参数】

见：表2

【代码示例】

const { result } = await HwICSUiSdk.interactionModeSwitch({ interactionMode: 'AUDIO' });

interruptSpeaking

(static) interruptSpeaking(): Promise<UISdkResult>

【功能说明】

中断数字人讲话。

【请求参数】

无

【返回参数】

请参见表16。

【代码示例】

const { result } = await HwICSUiSdk.interruptSpeaking();

muteRemoteAudio

(static) muteRemoteAudio(): Promise<boolean>

【功能说明】

数字人静音。

【请求参数】

无

【返回参数】

Promise<boolean>：数字人静音是否成功。

【代码示例】

const result = await HwICSUiSdk.muteRemoteAudio();

sendTextQuestion

(static) sendTextQuestion(param: TextQuestionParam): Promise<TextQuestionResult>

【功能说明】

发送问题文本。

【请求参数】

【返回参数】

【代码示例】

const { result } = await HwICSUiSdk.startChat({ interactionMode: 'AUDIO' });

setConfig

(static) setConfig(config: ConfigMap): void

【功能说明】

设置配置项，用于控制是否显示字幕或交互按钮。

【请求参数】

【返回参数】

无

【代码示例】

HwICSUiSdk.setConfig({
  enableCaption: true,
  enableChatBtn: false,
  enableHotIssues: false,
  enableWeakErrorInfo: true,
});

setLogLevel

(static) setLogLevel(logLevel: 'debug' | 'info' | 'warn' | 'error' | 'none'): void

【功能说明】

设置输出日志的级别。

【请求参数】

【返回参数】

无

【代码示例】

HwICSUiSdk.setLogLevel('warn');

startChat

(static) startChat(param?: ChatParam): Promise<ChatResult>

【功能说明】

开始对话。

【请求参数】

【返回参数】

【代码示例】

const { result } = await HwICSUiSdk.startChat({ interactionMode: 'AUDIO' });

startSpeak

(static) startSpeak(): Promise<UISdkResult>

【功能说明】

开始说话。

【请求参数】

无

【返回参数】

请参见表16。

【代码示例】

const { result } = await HwICSUiSdk.startSpeak();

startUserSpeak

(static) startUserSpeak(): Promise<UISdkResult>

【功能说明】

用户开始提问。

【请求参数】

无

【返回参数】

【代码示例】

const { result } = await HwICSUiSdk.startUserSpeak();

stopChat

(static) stopChat(): Promise<ChatResult>

【功能说明】

结束对话。

【请求参数】

无

【返回参数】

请参见表15。

【代码示例】

const { result } = await HwICSUiSdk.stopChat();

stopSpeak

(static) stopSpeak(): Promise<UISdkResult>

【功能说明】

停止说话。

【请求参数】

无

【返回参数】

请参见表16。

【代码示例】

const { result } = await HwICSUiSdk.stopSpeak();

stopUserSpeak

(static) stopUserSpeak(): Promise<UISdkResult>

【功能说明】

用户停止提问。

【请求参数】

无

【返回参数】

请参见表16。

【代码示例】

const { result } = await HwICSUiSdk.stopUserSpeak();

unmuteRemoteAudio

(static) unmuteRemoteAudio(): Promise<boolean>

【功能说明】

数字人取消静音。

【请求参数】

无

【返回参数】

Promise<boolean>：数字人取消静音是否成功。

【代码示例】

const result = await HwICSUiSdk.unmuteRemoteAudio();