Main Entry (HwICSUiSdk)

activeInteractionMode

(static) activeInteractionMode(): Promise<InteractionModeResult>

[Function Description]

Obtains the interaction mode (speech/text Q&A) in use.

[Request Parameters]

None.

[Response Parameters]

[Code Examples]

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

addEventListeners

(static) addEventListeners(eventMap: EventMap): void

[Function Description]

Sets the event callback.

[Request Parameters]

[Response Parameters]

None

[Code Examples]

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

changeLanguage

(static) changeLanguage(param: ChangeParam): Promise<void>

[Function Description]

Sets the language of an interaction task.

[Request Parameters]

[Response Parameters]

See Table 22.

[Code Examples]

const { result } = await HwICSUiSdk.changeLanguage({
  langCode: 'zh_CN',
});

checkBrowserSupport

(static) checkBrowserSupport(): Promise<boolean>

[Function Description]

Checks whether the SDK is supported by the browser.

[Request Parameters]

None

[Response Parameters]

Promise<boolean>: whether the SDK is supported by the browser

[Code Examples]

1
2
3
4
5
6

const result = await HwICSUiSdk.checkBrowserSupport();
if (result) {
  // Supported
} else {
  // Not supported
}

create

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

[Function Description]

Creates an intelligent interaction task using the obtained task link and one-off authentication code.

[Request Parameters]

[Response Parameters]

None

[Code Examples]

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>

[Function Description]

Destroys an interaction task.

[Request Parameters]

None

[Response Parameters]

None

[Code Examples]

HwICSUiSdk.destroy();

getJobInfo

(static) getJobInfo(): Promise<JobInfo>

[Function Description]

Obtains interaction task information.

[Request Parameters]

None

[Response Parameters]

[Code Examples]

const jobInfo = await HwICSUiSdk.getJobInfo();

getLanguageInfo

(static) getLanguageInfo(): Promise<LanguageResult>

[Function Description]

Obtains language information of an interaction task. To implement the multilingual capability, you need to create an intelligent interaction page in the backend and set the languages, which can be Chinese and English currently.

[Request Parameters]

None

[Response Parameters]

[Code Examples]

const languageResult = await HwICSUiSdk.getLanguageInfo();

initResourcePath

(static) interactionModeSwitch(param: ResourcePath): Promise<void>

[Function Description]

Initializes voice wakeup resources. If voice wakeup is not used, ignore this API.

The web SDK package later than 3.0.1 contains the following two resource files, which are needed only when voice wakeup is used:

• wasmData.js: voice wakeup algorithm resource file
• modelData.js: voice wakeup model resource file

The SDK has a preset wakeup model that allows customizing wakeup phrases. You can update the model to a local path. For details, see Web Voice Wakeup.

[Request Parameters]

[Response Parameters]

None.

[Code Examples]

await HwICSUiSdk.initResourcePath({
  wasmPath: 'wasmData.js',
  dataPath: 'modelData.js',
  initModel: true,
});

interactionModeSwitch

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

[Function Description]

Switches the interaction mode (speech/text Q&A).

[Request Parameters]

[Response Parameters]

See Table 2.

[Code Examples]

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

interruptSpeaking

(static) interruptSpeaking(): Promise<UISdkResult>

[Function Description]

Interrupts the virtual avatar's speech.

[Request Parameters]

None

[Response Parameters]

See Table 22.

[Code Examples]

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

muteRemoteAudio

(static) muteRemoteAudio(): Promise<boolean>

[Function Description]

Mutes the virtual avatar.

[Request Parameters]

None

[Response Parameters]

Promise<boolean>: whether the virtual avatar has been muted

[Code Examples]

const result = await HwICSUiSdk.muteRemoteAudio();

sendDrivenText

(static) sendDrivenText(param: TextDrivenParam): Promise<ChatResult>

[Function Description]

Sends the text to be read by the interactive virtual avatar.

The parameter isLast:true must be transferred for the last calling when active script reading ends. Otherwise, the virtual avatar cannot receive the notification speakingStop when finishing the reading.

[Request Parameters]

[Response Parameters]

See Table 21.

[Code Examples]

const { result } = await HwICSUiSdk.sendDrivenText({ text: 'Hello', isLast: true });

sendTextQuestion

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

[Function Description]

Sends the question text.

[Request Parameters]

[Response Parameters]

[Code Examples]

const { result } = await HwICSUiSdk.sendTextQuestion({ text: 'Who are you?' });

setConfig

(static) setConfig(config: ConfigMap): void

[Function Description]

Sets config to determine whether to display subtitles or the button for interaction.

[Request Parameters]

[Response Parameters]

None

[Code Examples]

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

setLogLevel

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

[Function Description]

Sets the output log level.

[Request Parameters]

[Response Parameters]

None

[Code Examples]

HwICSUiSdk.setLogLevel('warn');

startChat

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

[Function Description]

Starts a dialog.

[Request Parameters]

[Response Parameters]

[Code Examples]

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

startSpeak

(static) startSpeak(): Promise<UISdkResult>

[Function Description]

Starting speaking

[Request Parameters]

None

[Response Parameters]

See Table 22.

[Code Examples]

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

startUserSpeak

(static) startUserSpeak(): Promise<UISdkResult>

[Function Description]

The user starts to ask questions.

[Request Parameters]

None

[Response Parameters]

[Code Examples]

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

stopChat

(static) stopChat(): Promise<ChatResult>

[Function Description]

Ends a dialog.

[Request Parameters]

None

[Response Parameters]

See Table 21.

[Code Examples]

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

stopSpeak

(static) stopSpeak(): Promise<UISdkResult>

[Function Description]

The virtual avatar stops speaking.

[Request Parameters]

None

[Response Parameters]

See Table 22.

[Code Examples]

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

stopUserSpeak

(static) stopUserSpeak(): Promise<UISdkResult>

[Function Description]

The user stops asking questions.

[Request Parameters]

None

[Response Parameters]

See Table 22.

[Code Examples]

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

unmuteRemoteAudio

(static) unmuteRemoteAudio(): Promise<boolean>

[Function Description]

Unmutes the virtual avatar.

[Request Parameters]

None

[Response Parameters]

Promise<boolean>: whether the virtual avatar has been unmuted

[Code Examples]

const result = await HwICSUiSdk.unmuteRemoteAudio();