@wildix/wilma-voice-client 0.0.44 → 0.0.46

package/dist-cjs/models/enums.js

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MediaVadFrameType = exports.MediaStartFrameType = exports.MediaRunPurpose = exports.MediaAudioEncoding = exports.MediaPlaybackFrameType = exports.MediaPlaybackEvent = exports.MediaPlaybackStopCause = exports.MediaFinishFrameType = exports.MediaFinishReason = exports.MediaDtmfFrameType = exports.MediaTransferFrameType = exports.MediaTranscriptionFrameType = exports.MediaParty = exports.MediaStopFrameType = exports.MediaStartedFrameType = exports.MediaRestoreFrameType = exports.MediaLanguageFrameType = exports.MediaHangupFrameType = exports.MediaFinishedFrameType = exports.MediaErrorFrameType = exports.MediaDuckFrameType = exports.MediaAudioEndFrameType = exports.MediaAudioBeginFrameType = exports.VoiceCommandType = exports.VoiceInputMode = exports.VoiceAudioEncoding = exports.VoiceTranscriptionDropReason = exports.VoiceCallToolPhase = exports.VoiceCallEndReason = exports.VoiceControlAction = exports.VoiceEventType = exports.VoicePronunciationEncoding = void 0;
+exports.MediaVadFrameType = exports.MediaStartFrameType = exports.MediaRunPurpose = exports.MediaAudioEncoding = exports.MediaPlaybackFrameType = exports.MediaPlaybackEvent = exports.MediaPlaybackStopCause = exports.MediaFinishFrameType = exports.MediaFinishReason = exports.MediaDtmfFrameType = exports.MediaTransferFrameType = exports.MediaTranscriptionFrameType = exports.MediaParty = exports.MediaStopFrameType = exports.MediaStartedFrameType = exports.MediaRestoreFrameType = exports.MediaLanguageFrameType = exports.MediaHangupFrameType = exports.MediaFinishedFrameType = exports.MediaErrorFrameType = exports.MediaDuckFrameType = exports.MediaAudioEndFrameType = exports.MediaAudioBeginFrameType = exports.VoiceCommandType = exports.VoiceInputMode = exports.VoiceAudioEncoding = exports.VoiceTranscriptionDropReason = exports.VoiceCallToolPhase = exports.VoiceCallEndReason = exports.VoiceControlAction = exports.VoiceEventType = exports.VoiceLowConfidenceAction = exports.VoicePronunciationEncoding = void 0;
 exports.VoicePronunciationEncoding = {
     ALIAS: "alias",
     IPA: "ipa",
 };
+exports.VoiceLowConfidenceAction = {
+    ANSWER: "answer",
+    ASK_TO_REPEAT: "ask_to_repeat",
+    SKIP: "skip",
+};
 exports.VoiceEventType = {
     AGENT_TRANSCRIPTION: "agentTranscription",
     AUDIO: "audio",

package/dist-cjs/schemas/schemas_0.js

@@ -201,6 +201,7 @@ const _in = "interruptions";
 const _int = "interruptible";
 const _inte = "interruption";
 const _l = "language";
+const _lC = "lowConfidence";
 const _la = "languages";
 const _m = "message";
 const _mC = "minConfidence";
@@ -781,8 +782,8 @@ exports.VoiceErrorEvent$ = [3, n1, _VEE,
 ];
 exports.VoiceInterruptionDefaults$ = [3, n1, _VID,
     0,
-    [_mW, _mC, _dAM, _dVD, _rAMe],
-    [1, 1, 1, 1, 1], 5
+    [_mW, _dAM, _dVD, _rAMe],
+    [1, 1, 1, 1], 4
 ];
 exports.VoiceSpeechPayload$ = [3, n1, _VSP,
     0,
@@ -791,8 +792,8 @@ exports.VoiceSpeechPayload$ = [3, n1, _VSP,
 ];
 exports.VoiceTurnEndDefaults$ = [3, n1, _VTED,
     0,
-    [_hM, _mWM],
-    [1, 1], 2
+    [_hM, _mWM, _mC, _lC],
+    [1, 1, 1, 0], 4
 ];
 var LanguageCodeList = 64 | 0;
 var VoicePronunciationList = [1, n2, _VPL,

package/dist-es/models/enums.js

@@ -2,6 +2,11 @@ export const VoicePronunciationEncoding = {
     ALIAS: "alias",
     IPA: "ipa",
 };
+export const VoiceLowConfidenceAction = {
+    ANSWER: "answer",
+    ASK_TO_REPEAT: "ask_to_repeat",
+    SKIP: "skip",
+};
 export const VoiceEventType = {
     AGENT_TRANSCRIPTION: "agentTranscription",
     AUDIO: "audio",

package/dist-es/schemas/schemas_0.js

@@ -196,6 +196,7 @@ const _in = "interruptions";
 const _int = "interruptible";
 const _inte = "interruption";
 const _l = "language";
+const _lC = "lowConfidence";
 const _la = "languages";
 const _m = "message";
 const _mC = "minConfidence";
@@ -776,8 +777,8 @@ export var VoiceErrorEvent$ = [3, n1, _VEE,
 ];
 export var VoiceInterruptionDefaults$ = [3, n1, _VID,
     0,
-    [_mW, _mC, _dAM, _dVD, _rAMe],
-    [1, 1, 1, 1, 1], 5
+    [_mW, _dAM, _dVD, _rAMe],
+    [1, 1, 1, 1], 4
 ];
 export var VoiceSpeechPayload$ = [3, n1, _VSP,
     0,
@@ -786,8 +787,8 @@ export var VoiceSpeechPayload$ = [3, n1, _VSP,
 ];
 export var VoiceTurnEndDefaults$ = [3, n1, _VTED,
     0,
-    [_hM, _mWM],
-    [1, 1], 2
+    [_hM, _mWM, _mC, _lC],
+    [1, 1, 1, 0], 4
 ];
 var LanguageCodeList = 64 | 0;
 var VoicePronunciationList = [1, n2, _VPL,

package/dist-types/commands/GetVoiceDefaultsCommand.d.ts

@@ -47,7 +47,6 @@ declare const GetVoiceDefaultsCommand_base: {
  * //   },
  * //   interruptions: { // VoiceInterruptionDefaults
  * //     minWords: Number("int"), // required
- * //     minConfidence: Number("double"), // required
  * //     duckAfterMs: Number("int"), // required
  * //     duckVolumeDb: Number("int"), // required
  * //     restoreAfterMs: Number("int"), // required
@@ -55,6 +54,8 @@ declare const GetVoiceDefaultsCommand_base: {
  * //   turnEnd: { // VoiceTurnEndDefaults
  * //     holdMs: Number("int"), // required
  * //     maxWaitMs: Number("int"), // required
+ * //     minConfidence: Number("double"), // required
+ * //     lowConfidence: "answer" || "ask_to_repeat" || "skip", // required
  * //   },
  * // };
  *

package/dist-types/models/enums.d.ts

@@ -16,6 +16,28 @@ export declare const VoicePronunciationEncoding: {
  * @public
  */
 export type VoicePronunciationEncoding = (typeof VoicePronunciationEncoding)[keyof typeof VoicePronunciationEncoding];
+/**
+ * @public
+ * @enum
+ */
+export declare const VoiceLowConfidenceAction: {
+    /**
+     * The agent answers the words as they were recognised.
+     */
+    readonly ANSWER: "answer";
+    /**
+     * The agent asks the caller to repeat.
+     */
+    readonly ASK_TO_REPEAT: "ask_to_repeat";
+    /**
+     * The agent does not answer the turn.
+     */
+    readonly SKIP: "skip";
+};
+/**
+ * @public
+ */
+export type VoiceLowConfidenceAction = (typeof VoiceLowConfidenceAction)[keyof typeof VoiceLowConfidenceAction];
 /**
  * @public
  * @enum
@@ -435,7 +457,7 @@ export declare const MediaRunPurpose: {
      */
     readonly AGENT: "agent";
     /**
-     * The cloud transcribes the call and sends no audio.
+     * Reserved: the cloud transcribes the call and sends no audio. The cloud does not serve it at this time and closes the socket with 4400.
      */
     readonly TRANSCRIPTION: "transcription";
 };

package/dist-types/models/models_0.d.ts

@@ -1,5 +1,5 @@
 import type { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
-import type { MediaAudioBeginFrameType, MediaAudioEncoding, MediaAudioEndFrameType, MediaDtmfFrameType, MediaDuckFrameType, MediaErrorFrameType, MediaFinishedFrameType, MediaFinishFrameType, MediaFinishReason, MediaHangupFrameType, MediaLanguageFrameType, MediaParty, MediaPlaybackEvent, MediaPlaybackFrameType, MediaPlaybackStopCause, MediaRestoreFrameType, MediaRunPurpose, MediaStartedFrameType, MediaStartFrameType, MediaStopFrameType, MediaTranscriptionFrameType, MediaTransferFrameType, MediaVadFrameType, VoiceAudioEncoding, VoiceCallEndReason, VoiceCallToolPhase, VoiceCommandType, VoiceControlAction, VoiceEventType, VoiceInputMode, VoicePronunciationEncoding, VoiceTranscriptionDropReason } from "./enums";
+import type { MediaAudioBeginFrameType, MediaAudioEncoding, MediaAudioEndFrameType, MediaDtmfFrameType, MediaDuckFrameType, MediaErrorFrameType, MediaFinishedFrameType, MediaFinishFrameType, MediaFinishReason, MediaHangupFrameType, MediaLanguageFrameType, MediaParty, MediaPlaybackEvent, MediaPlaybackFrameType, MediaPlaybackStopCause, MediaRestoreFrameType, MediaRunPurpose, MediaStartedFrameType, MediaStartFrameType, MediaStopFrameType, MediaTranscriptionFrameType, MediaTransferFrameType, MediaVadFrameType, VoiceAudioEncoding, VoiceCallEndReason, VoiceCallToolPhase, VoiceCommandType, VoiceControlAction, VoiceEventType, VoiceInputMode, VoiceLowConfidenceAction, VoicePronunciationEncoding, VoiceTranscriptionDropReason } from "./enums";
 /**
  * A pronunciation rule for one phrase. Belongs to a LANGUAGE, not to the agent: 'Wildix' is
  *     respelled differently for an Italian and a German voice, so one list shared ACROSS languages
@@ -352,7 +352,7 @@ export interface VoiceCallTranscriptionEvent {
      */
     time?: number | undefined;
     /**
-     * Present on a final that did not go to the agent as a caller turn. It came while the agent spoke and the cloud took it for noise or echo, or for another speaker.
+     * Present on a final that did not go to the agent as a caller turn. It came while the agent spoke, and its recognition confidence was below the minimum of the call or the recogniser labelled it with another speaker.
      * @public
      */
     dropped?: VoiceTranscriptionDropReason | undefined;
@@ -900,7 +900,7 @@ export interface MediaVoiceDetection {
      */
     silenceMs: number;
     /**
-     * Level in dBFS below which caller audio is silence.
+     * Mean frame level in dBFS below which caller audio is silence.
      * @public
      */
     silenceLevelDb: number;
@@ -1163,7 +1163,7 @@ export interface MediaStartAgent {
     version?: number | undefined;
 }
 /**
- * Format of the binary PBX audio (`MediaPbxAudio`). Channel 0 is the caller; channel 1, when present, is the callee. Samples interleave.
+ * Format of the binary PBX audio (`MediaPbxAudio`). Channel 0 is the caller; channel 1, when present, is the callee. Samples interleave. The cloud accepts only 8000 Hz and one channel at this time; another format closes the socket with 4400.
  * @public
  */
 export interface MediaAudioFormat {
@@ -1220,7 +1220,7 @@ export interface MediaStartFrame {
      */
     sessionId: string;
     /**
-     * True when an earlier connection of this run got `started`: the cloud continues that session without a new greeting.
+     * True when an earlier connection of this run got agent audio (`audio.begin`): the cloud continues that session without a new greeting.
      * @public
      */
     resume: boolean;
@@ -1230,7 +1230,7 @@ export interface MediaStartFrame {
      */
     resumeAtMs: number;
     /**
-     * Format of the binary PBX audio (`MediaPbxAudio`). Channel 0 is the caller; channel 1, when present, is the callee. Samples interleave.
+     * Format of the binary PBX audio (`MediaPbxAudio`). Channel 0 is the caller; channel 1, when present, is the callee. Samples interleave. The cloud accepts only 8000 Hz and one channel at this time; another format closes the socket with 4400.
      * @public
      */
     audio: MediaAudioFormat;
@@ -1879,11 +1879,6 @@ export interface VoiceInterruptionDefaults {
      * @public
      */
     minWords: number;
-    /**
-     * Minimum recognition confidence, from 0 to 1, of the caller words that count as an interruption.
-     * @public
-     */
-    minConfidence: number;
     /**
      * Caller speech in ms before the agent's reply is lowered.
      * @public
@@ -1915,6 +1910,16 @@ export interface VoiceTurnEndDefaults {
      * @public
      */
     maxWaitMs: number;
+    /**
+     * Default of `minConfidence`. 0: off.
+     * @public
+     */
+    minConfidence: number;
+    /**
+     * Default of `lowConfidence`.
+     * @public
+     */
+    lowConfidence: VoiceLowConfidenceAction;
 }
 /**
  * Defaults of `VoiceChannelSettings.voiceDetection`.
@@ -1927,7 +1932,7 @@ export interface VoiceDetectionDefaults {
      */
     silenceMs: number;
     /**
-     * Level in dBFS below which caller audio is silence.
+     * Mean frame level in dBFS below which caller audio is silence.
      * @public
      */
     silenceLevelDb: number;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wilma-voice-client",
     "description": "@wildix/wilma-voice-client client",
-    "version": "0.0.44",
+    "version": "0.0.46",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",