@wildix/wilma-agents-client 1.0.41 → 1.0.43

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

@@ -57,6 +57,102 @@ export interface AgentAccess {
      */
     grants?: AgentGrantPrincipal[] | undefined;
 }
+/**
+ * One language the assistant audio channel can recognise and speak. There is deliberately no
+ *     greeting here: an assistant conversation is already open when its audio call starts, so there
+ *     is no new conversation to welcome and no initial phrase for the runtime to choose or repeat.
+ * @public
+ */
+export interface AssistantLanguage {
+    /**
+     * BCP-47 code with locale, e.g. 'en-US', 'it-IT'. Reuses the channel-neutral language value so assistant and voice configuration accept the same codes without sharing policy structures.
+     * @public
+     */
+    code: string;
+    /**
+     * Voice this language speaks with. Reuses the channel-neutral URI value so providers and synthesis parameters have the same representation in every channel without coupling their language rules.
+     * @public
+     */
+    voice: string;
+    /**
+     * Marks the language used when the caller's language matches nothing configured.
+     *
+     *         THE FULL RESOLUTION ORDER, because a client author reading only this contract cannot
+     *         otherwise find it: an exact match on the call's language, then a match on its primary
+     *         subtag (`fr` finds `fr-FR`), then the language marked here, then a language whose primary
+     *         subtag is `en`, then the first entry in the list. The same order the voice channel resolves
+     *         by — the rule belongs to choosing a language, not to a channel.
+     *
+     *         At most one language may carry it. A record with two — reachable through the API, where no
+     *         form prevents it — resolves to the first marked one in list order: refusing an
+     *         already-open assistant conversation over configuration drift is worse than serving it.
+     * @public
+     */
+    isDefault?: boolean | undefined;
+}
+/**
+ * Speech-to-text configuration owned by the assistant channel, so changes to assistant recognition policy cannot alter telephony calls.
+ * @public
+ */
+export interface AssistantTranscriptionSettings {
+    /**
+     * Recogniser used for assistant audio. Absent resolves to the platform default, resolved by the server so exactly one component decides it.
+     * @public
+     */
+    engine?: string | undefined;
+    /**
+     * Identify the caller's language per utterance and switch voice and reply language while the
+     *         audio call is open. Absent means off. It requires at least two configured languages and a
+     *         recogniser that can identify them; the server clamps it to false otherwise because passing
+     *         one candidate to an identifying recogniser can make it reject the stream.
+     * @public
+     */
+    autoDetect?: boolean | undefined;
+}
+/**
+ * Recognition and synthesis policy for assistant audio. This is assistant-owned rather than a
+ *     VoiceSpeechSettings reuse so telephony and assistant audio can evolve independently. It has no
+ *     language greeting and no greet-every-language switch because an assistant conversation is
+ *     already open when its audio call starts, leaving nothing for the channel to greet.
+ * @public
+ */
+export interface AssistantSpeechSettings {
+    /**
+     * Languages the assistant audio channel can recognise and speak. The @length bound is a
+     *         STORAGE ceiling, not the product rule: the real cap is the recogniser's own candidate limit,
+     *         enforced in the service so a recogniser with a different limit needs no model change.
+     * @public
+     */
+    languages: AssistantLanguage[];
+    /**
+     * Which recogniser listens to assistant audio and whether it identifies the language. Absent uses the platform default recogniser without language identification.
+     * @public
+     */
+    transcription?: AssistantTranscriptionSettings | undefined;
+}
+/**
+ * Switchable audio for the assistant channel. The settings object keeps enablement beside its
+ *     speech policy, matching the voice channel's switchable blocks so a disabled configuration can
+ *     be retained without serving audio.
+ * @public
+ */
+export interface AssistantAudioSettings {
+    /**
+     * Whether the assistant accepts audio calls. Required so the presence of saved speech configuration is never mistaken for enablement.
+     * @public
+     */
+    enabled: boolean;
+    /**
+     * Which runtime carries the call. Absent is 'voice'.
+     * @public
+     */
+    engine?: string | undefined;
+    /**
+     * Languages, voices and recognition policy for assistant audio. Absent leaves those choices to platform defaults, including when audio is enabled.
+     * @public
+     */
+    speech?: AssistantSpeechSettings | undefined;
+}
 /**
  * A starter prompt offered as a card on an empty thread. Picking it sends `prompt` as the user's first message, so the user never types it.
  * @public
@@ -116,6 +212,7 @@ export interface AssistantUiSettings {
     placeholder?: string | undefined;
 }
 /**
+ * Assistant channel settings. Presence enables the in-app assistant surface; audio remains unavailable unless its separate settings are present and enabled.
  * @public
  */
 export interface AssistantChannelSettings {
@@ -129,6 +226,11 @@ export interface AssistantChannelSettings {
      * @public
      */
     ui?: AssistantUiSettings | undefined;
+    /**
+     * Audio configuration owned by the assistant channel. Absent means the assistant has no audio at all, preserving the behaviour of every existing agent without consulting `channels.voice`.
+     * @public
+     */
+    audio?: AssistantAudioSettings | undefined;
 }
 /**
  * @public
@@ -220,41 +322,15 @@ export interface VoiceInterruptionSettings {
      */
     minWords?: number | undefined;
 }
-/**
- * One phrase in one language, for a capability that speaks a fixed line on the voice channel.
- *     Which entry is spoken is decided by the call's current language — the one the call resolved
- *     to at connect, or the one automatic detection switched to — matched on `language`
- *     CASE-INSENSITIVELY, the same rule `VoiceBotSpokenPhrase` states for the legacy stack, so a
- *     code written in either case reaches the same entry on either. Blank `text` means the agent
- *     says nothing in that language; it does NOT fall back to the language-agnostic member beside
- *     the list, which would speak one language's text in another language's voice.
- * @public
- */
-export interface AgentSpokenPhrase {
-    /**
-     * BCP-47 language tag, optionally with a region subtag: 'en', 'en-US', 'pt-BR'. Deliberately a
-     *     constrained string rather than an enum: the offerable set is a property of the selected
-     *     recogniser and changes with it, so an enumeration here would cap the set at whatever was known
-     *     when the model was released.
-     * @public
-     */
-    language: string;
-    text: string;
-}
 /**
  * @public
  */
 export interface VoiceTerminateHangupAction {
     /**
-     * Message played before hanging up. Played in every language of the call while `messages` is absent or empty; not consulted once `messages` carries any entry.
+     * Message played before hanging up.
      * @public
      */
     message?: string | undefined;
-    /**
-     * Per-language messages played before hanging up. Same rule as `AgentTool.startMessages`: the entry for the call's current language is played, a language with no entry is silent, and with no effective speech configuration `message` is played.
-     * @public
-     */
-    messages?: AgentSpokenPhrase[] | undefined;
 }
 /**
  * @public
@@ -521,6 +597,10 @@ export interface AgentChannels {
      */
     voice?: VoiceChannelSettings | undefined;
     chat?: ChatChannelSettings | undefined;
+    /**
+     * Assistant channel settings. Presence enables the in-app assistant surface; audio remains unavailable unless its separate settings are present and enabled.
+     * @public
+     */
     assistant?: AssistantChannelSettings | undefined;
 }
 /**
@@ -841,15 +921,10 @@ export interface AgentConnectorCapability {
      */
     id: string;
     /**
-     * Message spoken when a connector action call starts. Honoured on the voice channel. Mirrors `AgentTool.startMessage`. Not applied to the read-only `help` action. Not consulted once `startMessages` carries any entry.
+     * Message spoken when a connector action call starts. Honoured on the voice channel. Mirrors `AgentTool.startMessage`. Not applied to the read-only `help` action.
      * @public
      */
     startMessage?: string | undefined;
-    /**
-     * Forward-compatible per-language connector start messages, mirroring `AgentTool.startMessages`. Accepted and stored so clients can configure connector and tool phrases consistently, but currently ignored at execution time because the voice runtime does not read connector start messages yet. Runtime enablement is tracked in wilma-services docs/todo.md item 8.
-     * @public
-     */
-    startMessages?: AgentSpokenPhrase[] | undefined;
     /**
      * How the model waits for a connector action and whether it synthesizes a reply from the result. The `help` action carries no pipeline.
      * @public
@@ -1221,19 +1296,10 @@ export interface AgentTool {
      */
     fields?: AgentToolField[] | undefined;
     /**
-     * Message spoken when the tool call starts. Honoured on the voice channel. Spoken in every language of the call while `startMessages` is absent or empty; not consulted once `startMessages` carries any entry.
+     * Message spoken when the tool call starts. Honoured on the voice channel.
      * @public
      */
     startMessage?: string | undefined;
-    /**
-     * Per-language start messages. When present and non-empty, the entry for the call's current
-     *         language is spoken and `startMessage` is not consulted; a language with no entry is silent.
-     *         When absent or empty, `startMessage` is spoken as before. On a call with no effective speech
-     *         configuration — no configured languages, or a PBX below protocol 2 — `startMessage` is spoken
-     *         regardless, because there is no current language to choose by.
-     * @public
-     */
-    startMessages?: AgentSpokenPhrase[] | undefined;
     /**
      * How the model waits for the tool and whether it synthesizes a reply from the result.
      * @public
@@ -1316,15 +1382,10 @@ export interface AgentWaitCapability {
      */
     description?: string | undefined;
     /**
-     * Message spoken when entering the wait state. Spoken in every language of the call while `messages` is absent or empty; not consulted once `messages` carries any entry.
+     * Message spoken when entering the wait state.
      * @public
      */
     message?: string | undefined;
-    /**
-     * Per-language wait messages. Same rule as `AgentTool.startMessages`: the entry for the call's current language is spoken, a language with no entry is silent, and with no effective speech configuration `message` is spoken.
-     * @public
-     */
-    messages?: AgentSpokenPhrase[] | undefined;
     /**
      * Channels this capability is offered on. Absent or empty — the default — means every channel the agent serves
      *     that can honour it. Listing channels narrows that set and never widens it: a `transfer` listed for `chat` is

package/dist-types/schemas/schemas_0.d.ts

@@ -39,7 +39,6 @@ export declare var AgentInfo$: StaticStructureSchema;
 export declare var AgentKnowledgeBase$: StaticStructureSchema;
 export declare var AgentSettings$: StaticStructureSchema;
 export declare var AgentSnapshotSandboxOptions$: StaticStructureSchema;
-export declare var AgentSpokenPhrase$: StaticStructureSchema;
 export declare var AgentSqsEngine$: StaticStructureSchema;
 export declare var AgentSuggestionsCapability$: StaticStructureSchema;
 export declare var AgentTool$: StaticStructureSchema;
@@ -96,8 +95,12 @@ export declare var AgentWorkflowStep$: StaticStructureSchema;
 export declare var AgentWorkflowStepPosition$: StaticStructureSchema;
 export declare var AgentWorkflowTransition$: StaticStructureSchema;
 export declare var AgentWorkflowVariablesHandler$: StaticStructureSchema;
+export declare var AssistantAudioSettings$: StaticStructureSchema;
 export declare var AssistantChannelSettings$: StaticStructureSchema;
+export declare var AssistantLanguage$: StaticStructureSchema;
 export declare var AssistantQuickCommand$: StaticStructureSchema;
+export declare var AssistantSpeechSettings$: StaticStructureSchema;
+export declare var AssistantTranscriptionSettings$: StaticStructureSchema;
 export declare var AssistantUiSettings$: StaticStructureSchema;
 export declare var AssistantWelcomeSettings$: StaticStructureSchema;
 export declare var ChatChannelSettings$: StaticStructureSchema;

package/package.json

@@ -1,59 +1,59 @@
 {
-    "name": "@wildix/wilma-agents-client",
-    "description": "@wildix/wilma-agents-client client",
-    "version": "1.0.41",
-    "scripts": {
-        "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
-        "build:cjs": "tsc -p tsconfig.cjs.json",
-        "build:es": "tsc -p tsconfig.es.json",
-        "build:types": "tsc -p tsconfig.types.json",
-        "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
-        "clean": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo",
-        "prepack": "yarn run clean && yarn run build",
-        "postpublish": "node ../../scripts/postpublish.js"
-    },
-    "main": "./dist-cjs/index.js",
-    "types": "./dist-types/index.d.ts",
-    "module": "./dist-es/index.js",
-    "sideEffects": false,
-    "dependencies": {
-        "tslib": "^2.6.2",
-        "@aws-crypto/sha256-browser": "5.2.0",
-        "@aws-crypto/sha256-js": "5.2.0",
-        "@aws-sdk/core": "^3.974.15",
-        "@smithy/core": "^3.24.5",
-        "@smithy/fetch-http-handler": "^5.4.5",
-        "@smithy/node-http-handler": "^4.7.5",
-        "@smithy/types": "^4.14.2",
-        "@wildix/smithy-react-native": "^1.0.0"
-    },
-    "devDependencies": {
-        "@tsconfig/node20": "20.1.8",
-        "concurrently": "7.0.0",
-        "downlevel-dts": "0.10.1",
-        "premove": "4.0.0",
-        "typescript": "~5.8.3",
-        "@types/node": "^20.14.8"
-    },
-    "engines": {
-        "node": ">=20.0.0"
-    },
-    "typesVersions": {
-        "<4.5": {
-            "dist-types/*": [
-                "dist-types/ts3.4/*"
-            ]
-        }
-    },
-    "files": [
-        "dist-*/**"
-    ],
-    "license": "Apache-2.0",
-    "react-native": {
-        "@aws-sdk/core/client": "@aws-sdk/core/dist-es/submodules/client/index.native.js",
-        "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
-    },
-    "browser": {
-        "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
+  "name": "@wildix/wilma-agents-client",
+  "description": "@wildix/wilma-agents-client client",
+  "version": "1.0.43",
+  "scripts": {
+    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:es": "tsc -p tsconfig.es.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
+    "clean": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo",
+    "prepack": "yarn run clean && yarn run build",
+    "postpublish": "node ../../scripts/postpublish.js"
+  },
+  "main": "./dist-cjs/index.js",
+  "types": "./dist-types/index.d.ts",
+  "module": "./dist-es/index.js",
+  "sideEffects": false,
+  "dependencies": {
+    "tslib": "^2.6.2",
+    "@aws-crypto/sha256-browser": "5.2.0",
+    "@aws-crypto/sha256-js": "5.2.0",
+    "@aws-sdk/core": "^3.974.15",
+    "@smithy/core": "^3.24.5",
+    "@smithy/fetch-http-handler": "^5.4.5",
+    "@smithy/node-http-handler": "^4.7.5",
+    "@smithy/types": "^4.14.2",
+    "@wildix/smithy-react-native": "^1.0.0"
+  },
+  "devDependencies": {
+    "@tsconfig/node20": "20.1.8",
+    "concurrently": "7.0.0",
+    "downlevel-dts": "0.10.1",
+    "premove": "4.0.0",
+    "typescript": "~5.8.3",
+    "@types/node": "^20.14.8"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "typesVersions": {
+    "<4.5": {
+      "dist-types/*": [
+        "dist-types/ts3.4/*"
+      ]
     }
+  },
+  "files": [
+    "dist-*/**"
+  ],
+  "license": "Apache-2.0",
+  "react-native": {
+    "@aws-sdk/core/client": "@aws-sdk/core/dist-es/submodules/client/index.native.js",
+    "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
+  },
+  "browser": {
+    "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
+  }
 }