@wildix/wilma-agents-client 1.0.39 → 1.0.40

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

@@ -79,6 +79,12 @@ declare const UpdateAgentCommand_base: {
  *         action: { // VoiceTerminateAction Union: only one key present
  *           hangup: { // VoiceTerminateHangupAction
  *             message: "STRING_VALUE",
+ *             messages: [ // AgentSpokenPhraseList
+ *               { // AgentSpokenPhrase
+ *                 language: "STRING_VALUE", // required
+ *                 text: "STRING_VALUE", // required
+ *               },
+ *             ],
  *           },
  *           transfer: { // VoiceTransferTarget
  *             name: "STRING_VALUE", // required
@@ -93,6 +99,12 @@ declare const UpdateAgentCommand_base: {
  *         action: {//  Union: only one key present
  *           hangup: {
  *             message: "STRING_VALUE",
+ *             messages: [
+ *               {
+ *                 language: "STRING_VALUE", // required
+ *                 text: "STRING_VALUE", // required
+ *               },
+ *             ],
  *           },
  *           transfer: {
  *             name: "STRING_VALUE", // required
@@ -177,6 +189,12 @@ declare const UpdateAgentCommand_base: {
  *                         },
  *                       ],
  *                       startMessage: "STRING_VALUE",
+ *                       startMessages: [
+ *                         {
+ *                           language: "STRING_VALUE", // required
+ *                           text: "STRING_VALUE", // required
+ *                         },
+ *                       ],
  *                       pipeline: { // AgentToolPipeline
  *                         type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  *                         instructions: "STRING_VALUE",
@@ -207,6 +225,12 @@ declare const UpdateAgentCommand_base: {
  *                     connector: { // AgentConnectorCapability
  *                       id: "STRING_VALUE", // required
  *                       startMessage: "STRING_VALUE",
+ *                       startMessages: [
+ *                         {
+ *                           language: "STRING_VALUE", // required
+ *                           text: "STRING_VALUE", // required
+ *                         },
+ *                       ],
  *                       pipeline: {
  *                         type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  *                         instructions: "STRING_VALUE",
@@ -237,9 +261,6 @@ declare const UpdateAgentCommand_base: {
  *                     kb: { // AgentKnowledgeBase
  *                       knowledgeBaseId: "STRING_VALUE",
  *                       instructions: "STRING_VALUE",
- *                       searchStrategy: "bm25" || "vector" || "hybrid",
- *                       searchThreshold: "low" || "medium" || "high",
- *                       searchLimit: Number("int"),
  *                       channels: [
  *                         "voice" || "chat" || "assistant",
  *                       ],
@@ -396,7 +417,6 @@ declare const UpdateAgentCommand_base: {
  *                     },
  *                     suggestions: { // AgentSuggestionsCapability
  *                       name: "STRING_VALUE",
- *                       instructions: "STRING_VALUE",
  *                       channels: "<AgentCapabilityChannelsList>",
  *                       annotations: "<AgentToolAnnotationsList>",
  *                     },
@@ -414,6 +434,12 @@ declare const UpdateAgentCommand_base: {
  *                       name: "STRING_VALUE",
  *                       description: "STRING_VALUE",
  *                       message: "STRING_VALUE",
+ *                       messages: [
+ *                         {
+ *                           language: "STRING_VALUE", // required
+ *                           text: "STRING_VALUE", // required
+ *                         },
+ *                       ],
  *                       channels: "<AgentCapabilityChannelsList>",
  *                       annotations: "<AgentToolAnnotationsList>",
  *                     },
@@ -472,6 +498,7 @@ declare const UpdateAgentCommand_base: {
  *                       },
  *                     ],
  *                     startMessage: "STRING_VALUE",
+ *                     startMessages: "<AgentSpokenPhraseList>",
  *                     pipeline: {
  *                       type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  *                       instructions: "STRING_VALUE",
@@ -485,6 +512,7 @@ declare const UpdateAgentCommand_base: {
  *                   connector: {
  *                     id: "STRING_VALUE", // required
  *                     startMessage: "STRING_VALUE",
+ *                     startMessages: "<AgentSpokenPhraseList>",
  *                     pipeline: {
  *                       type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  *                       instructions: "STRING_VALUE",
@@ -573,6 +601,7 @@ declare const UpdateAgentCommand_base: {
  *                     name: "STRING_VALUE",
  *                     description: "STRING_VALUE",
  *                     message: "STRING_VALUE",
+ *                     messages: "<AgentSpokenPhraseList>",
  *                     channels: "<AgentCapabilityChannelsList>",
  *                     annotations: "<AgentToolAnnotationsList>",
  *                   },
@@ -651,9 +680,6 @@ declare const UpdateAgentCommand_base: {
  *                         kb: {
  *                           knowledgeBaseId: "STRING_VALUE",
  *                           instructions: "STRING_VALUE",
- *                           searchStrategy: "bm25" || "vector" || "hybrid",
- *                           searchThreshold: "low" || "medium" || "high",
- *                           searchLimit: Number("int"),
  *                           channels: "<AgentCapabilityChannelsList>",
  *                           annotations: "<AgentToolAnnotationsList>",
  *                         },
@@ -691,7 +717,6 @@ declare const UpdateAgentCommand_base: {
  *                         transfer: "<AgentTransferCapability>",
  *                         suggestions: {
  *                           name: "STRING_VALUE",
- *                           instructions: "STRING_VALUE",
  *                           channels: "<AgentCapabilityChannelsList>",
  *                           annotations: "<AgentToolAnnotationsList>",
  *                         },
@@ -935,6 +960,12 @@ declare const UpdateAgentCommand_base: {
  * //           action: { // VoiceTerminateAction Union: only one key present
  * //             hangup: { // VoiceTerminateHangupAction
  * //               message: "STRING_VALUE",
+ * //               messages: [ // AgentSpokenPhraseList
+ * //                 { // AgentSpokenPhrase
+ * //                   language: "STRING_VALUE", // required
+ * //                   text: "STRING_VALUE", // required
+ * //                 },
+ * //               ],
  * //             },
  * //             transfer: { // VoiceTransferTarget
  * //               name: "STRING_VALUE", // required
@@ -949,6 +980,12 @@ declare const UpdateAgentCommand_base: {
  * //           action: {//  Union: only one key present
  * //             hangup: {
  * //               message: "STRING_VALUE",
+ * //               messages: [
+ * //                 {
+ * //                   language: "STRING_VALUE", // required
+ * //                   text: "STRING_VALUE", // required
+ * //                 },
+ * //               ],
  * //             },
  * //             transfer: {
  * //               name: "STRING_VALUE", // required
@@ -1033,6 +1070,12 @@ declare const UpdateAgentCommand_base: {
  * //                           },
  * //                         ],
  * //                         startMessage: "STRING_VALUE",
+ * //                         startMessages: [
+ * //                           {
+ * //                             language: "STRING_VALUE", // required
+ * //                             text: "STRING_VALUE", // required
+ * //                           },
+ * //                         ],
  * //                         pipeline: { // AgentToolPipeline
  * //                           type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  * //                           instructions: "STRING_VALUE",
@@ -1063,6 +1106,12 @@ declare const UpdateAgentCommand_base: {
  * //                       connector: { // AgentConnectorCapability
  * //                         id: "STRING_VALUE", // required
  * //                         startMessage: "STRING_VALUE",
+ * //                         startMessages: [
+ * //                           {
+ * //                             language: "STRING_VALUE", // required
+ * //                             text: "STRING_VALUE", // required
+ * //                           },
+ * //                         ],
  * //                         pipeline: {
  * //                           type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  * //                           instructions: "STRING_VALUE",
@@ -1093,9 +1142,6 @@ declare const UpdateAgentCommand_base: {
  * //                       kb: { // AgentKnowledgeBase
  * //                         knowledgeBaseId: "STRING_VALUE",
  * //                         instructions: "STRING_VALUE",
- * //                         searchStrategy: "bm25" || "vector" || "hybrid",
- * //                         searchThreshold: "low" || "medium" || "high",
- * //                         searchLimit: Number("int"),
  * //                         channels: [
  * //                           "voice" || "chat" || "assistant",
  * //                         ],
@@ -1252,7 +1298,6 @@ declare const UpdateAgentCommand_base: {
  * //                       },
  * //                       suggestions: { // AgentSuggestionsCapability
  * //                         name: "STRING_VALUE",
- * //                         instructions: "STRING_VALUE",
  * //                         channels: "<AgentCapabilityChannelsList>",
  * //                         annotations: "<AgentToolAnnotationsList>",
  * //                       },
@@ -1270,6 +1315,12 @@ declare const UpdateAgentCommand_base: {
  * //                         name: "STRING_VALUE",
  * //                         description: "STRING_VALUE",
  * //                         message: "STRING_VALUE",
+ * //                         messages: [
+ * //                           {
+ * //                             language: "STRING_VALUE", // required
+ * //                             text: "STRING_VALUE", // required
+ * //                           },
+ * //                         ],
  * //                         channels: "<AgentCapabilityChannelsList>",
  * //                         annotations: "<AgentToolAnnotationsList>",
  * //                       },
@@ -1328,6 +1379,7 @@ declare const UpdateAgentCommand_base: {
  * //                         },
  * //                       ],
  * //                       startMessage: "STRING_VALUE",
+ * //                       startMessages: "<AgentSpokenPhraseList>",
  * //                       pipeline: {
  * //                         type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  * //                         instructions: "STRING_VALUE",
@@ -1341,6 +1393,7 @@ declare const UpdateAgentCommand_base: {
  * //                     connector: {
  * //                       id: "STRING_VALUE", // required
  * //                       startMessage: "STRING_VALUE",
+ * //                       startMessages: "<AgentSpokenPhraseList>",
  * //                       pipeline: {
  * //                         type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
  * //                         instructions: "STRING_VALUE",
@@ -1429,6 +1482,7 @@ declare const UpdateAgentCommand_base: {
  * //                       name: "STRING_VALUE",
  * //                       description: "STRING_VALUE",
  * //                       message: "STRING_VALUE",
+ * //                       messages: "<AgentSpokenPhraseList>",
  * //                       channels: "<AgentCapabilityChannelsList>",
  * //                       annotations: "<AgentToolAnnotationsList>",
  * //                     },
@@ -1507,9 +1561,6 @@ declare const UpdateAgentCommand_base: {
  * //                           kb: {
  * //                             knowledgeBaseId: "STRING_VALUE",
  * //                             instructions: "STRING_VALUE",
- * //                             searchStrategy: "bm25" || "vector" || "hybrid",
- * //                             searchThreshold: "low" || "medium" || "high",
- * //                             searchLimit: Number("int"),
  * //                             channels: "<AgentCapabilityChannelsList>",
  * //                             annotations: "<AgentToolAnnotationsList>",
  * //                           },
@@ -1547,7 +1598,6 @@ declare const UpdateAgentCommand_base: {
  * //                           transfer: "<AgentTransferCapability>",
  * //                           suggestions: {
  * //                             name: "STRING_VALUE",
- * //                             instructions: "STRING_VALUE",
  * //                             channels: "<AgentCapabilityChannelsList>",
  * //                             annotations: "<AgentToolAnnotationsList>",
  * //                           },

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

@@ -161,41 +161,6 @@ export declare const AgentHangupPipelineType: {
  * @public
  */
 export type AgentHangupPipelineType = (typeof AgentHangupPipelineType)[keyof typeof AgentHangupPipelineType];
-/**
- * @public
- * @enum
- */
-export declare const KnowledgeBaseSearchStrategy: {
-    /**
-     * Full-text keyword search. Suits corpora callers address by exact product name, code or error string.
-     */
-    readonly BM25: "bm25";
-    /**
-     * Both, combined. The service default and the right answer for most agents.
-     */
-    readonly HYBRID: "hybrid";
-    /**
-     * Semantic similarity over embeddings. Suits callers who paraphrase rather than quote.
-     */
-    readonly VECTOR: "vector";
-};
-/**
- * @public
- */
-export type KnowledgeBaseSearchStrategy = (typeof KnowledgeBaseSearchStrategy)[keyof typeof KnowledgeBaseSearchStrategy];
-/**
- * @public
- * @enum
- */
-export declare const KnowledgeBaseSearchThreshold: {
-    readonly HIGH: "high";
-    readonly LOW: "low";
-    readonly MEDIUM: "medium";
-};
-/**
- * @public
- */
-export type KnowledgeBaseSearchThreshold = (typeof KnowledgeBaseSearchThreshold)[keyof typeof KnowledgeBaseSearchThreshold];
 /**
  * @public
  * @enum

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

@@ -1,5 +1,5 @@
 import type { DocumentType as __DocumentType } from "@smithy/types";
-import type { ActorType, AgentGuardrailErrorMode, AgentGuardrailMode, AgentGuardrailPreset, AgentGuardrailSensitivity, AgentGuardrailWindow, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, AgentWorkflowEntryBehavior, AgentWorkflowFailureKind, AgentWorkflowLayout, AgentWorkflowMessageButtonVariant, ChannelType, KnowledgeBaseSearchStrategy, KnowledgeBaseSearchThreshold, SandboxNetworkAccess, SandboxSize, VoicePronunciationEncoding, WebSearchContextSize } from "./enums";
+import type { ActorType, AgentGuardrailErrorMode, AgentGuardrailMode, AgentGuardrailPreset, AgentGuardrailSensitivity, AgentGuardrailWindow, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, AgentWorkflowEntryBehavior, AgentWorkflowFailureKind, AgentWorkflowLayout, AgentWorkflowMessageButtonVariant, ChannelType, SandboxNetworkAccess, SandboxSize, VoicePronunciationEncoding, WebSearchContextSize } from "./enums";
 /**
  * A user or group that access is granted to.
  * @public
@@ -220,15 +220,40 @@ 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`.
+ *     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.
+     * 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.
      * @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
@@ -815,10 +840,15 @@ 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.
+     * 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.
      * @public
      */
     startMessage?: string | undefined;
+    /**
+     * Mirrors `AgentTool.startMessages`. Stored for contract symmetry; the voice runtime does not read connector start messages yet (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
@@ -975,21 +1005,6 @@ export interface AgentKnowledgeBase {
      * @public
      */
     instructions?: string | undefined;
-    /**
-     * Search algorithm used for this capability. Defaults to the knowledge base service's own default (`hybrid`) when omitted.
-     * @public
-     */
-    searchStrategy?: KnowledgeBaseSearchStrategy | undefined;
-    /**
-     * Minimum similarity a passage needs to be returned by this capability. Defaults to the knowledge base service's own default (`medium`) when omitted. Worth raising on voice, where an off-target passage is spoken aloud.
-     * @public
-     */
-    searchThreshold?: KnowledgeBaseSearchThreshold | undefined;
-    /**
-     * Maximum number of passages this capability returns. Defaults to the knowledge base service's own default (10) when omitted. Keep it low on voice: every passage is prompt the model reads before it can speak.
-     * @public
-     */
-    searchLimit?: number | 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
@@ -1101,20 +1116,6 @@ export interface AgentSuggestionsCapability {
      * @public
      */
     name?: string | undefined;
-    /**
-     * Steers what the suggestions say. Appended to the platform's own generation prompt rather than
-     *         replacing it, so the shape of a suggestion — short, tappable, a plausible next thing to send —
-     *         stays the platform's to keep, and this narrows the subject: 'offer a callback and a link to the
-     *         status page, never a discount'.
-     *
-     *         NOT a tool description, unlike the `description` every other capability carries: suggestions are
-     *         not a tool the model chooses to call. They are generated from a reply that has already been
-     *         written, so there is no decision to describe — only the generation to steer.
-     *
-     *         Absent means the platform's prompt alone.
-     * @public
-     */
-    instructions?: string | 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
@@ -1219,10 +1220,19 @@ export interface AgentTool {
      */
     fields?: AgentToolField[] | undefined;
     /**
-     * Message spoken when the tool call starts. Honoured on the voice channel.
+     * 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.
      * @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
@@ -1305,10 +1315,15 @@ export interface AgentWaitCapability {
      */
     description?: string | undefined;
     /**
-     * Message spoken when entering the wait state.
+     * 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.
      * @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,6 +39,7 @@ 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;

package/package.json

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