@wildix/wim-voicebots-client 1.1.8 → 1.1.9

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

@@ -23,6 +23,127 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * Tool result captured for an annotation. Runtime services enforce serialized payload size limits.
+ * @public
+ */
+export interface AnnotationResultValue {
+    value: __DocumentType;
+}
+/**
+ * Capability variable values captured for an annotation. Runtime services enforce serialized payload size limits.
+ * @public
+ */
+export interface AnnotationVariablesValue {
+    value: __DocumentType;
+}
+/**
+ * @public
+ */
+export type AnnotationPayload = AnnotationPayload.ResultMember | AnnotationPayload.TagMember | AnnotationPayload.TextMember | AnnotationPayload.VariablesMember | AnnotationPayload.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace AnnotationPayload {
+    interface TagMember {
+        tag: string;
+        text?: never;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    interface TextMember {
+        tag?: never;
+        text: string;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Capability variable values captured for an annotation. Runtime services enforce serialized payload size limits.
+     * @public
+     */
+    interface VariablesMember {
+        tag?: never;
+        text?: never;
+        variables: AnnotationVariablesValue;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Tool result captured for an annotation. Runtime services enforce serialized payload size limits.
+     * @public
+     */
+    interface ResultMember {
+        tag?: never;
+        text?: never;
+        variables?: never;
+        result: AnnotationResultValue;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        tag?: never;
+        text?: never;
+        variables?: never;
+        result?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        tag: (value: string) => T;
+        text: (value: string) => T;
+        variables: (value: AnnotationVariablesValue) => T;
+        result: (value: AnnotationResultValue) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: AnnotationPayload, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const AnnotationSourceType: {
+    readonly CHATBOT: "chatbot";
+    readonly SYSTEM: "system";
+    readonly USER: "user";
+    readonly VOICEBOT: "voicebot";
+};
+/**
+ * @public
+ */
+export type AnnotationSourceType = typeof AnnotationSourceType[keyof typeof AnnotationSourceType];
+/**
+ * Producer of an annotation. Generic identifiers allow callers to attach context such as tool id/name, user id/name, etc., without constraining the source type to a fixed shape.
+ * @public
+ */
+export interface AnnotationSource {
+    type: AnnotationSourceType;
+    /**
+     * Stable identifier of the producer (e.g. tool id, user id).
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * Human-readable name of the producer (e.g. tool name, user display name).
+     * @public
+     */
+    name?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface Annotation {
+    id: string;
+    time: number;
+    payload: AnnotationPayload;
+    /**
+     * Producer of an annotation. Generic identifiers allow callers to attach context such as tool id/name, user id/name, etc., without constraining the source type to a fixed shape.
+     * @public
+     */
+    source: AnnotationSource;
+}
 /**
  * @public
  * @enum
@@ -87,6 +208,132 @@ export interface CompleteWebsocketEvent {
     type: string;
     event: CompleteEvent;
 }
+/**
+ * Comment annotation emitted after a voice bot tool completes.
+ * @public
+ */
+export interface VoiceBotToolCommentAnnotation {
+    /**
+     * Static handlebars expression resolved against bot variables and helpers.
+     * @public
+     */
+    value?: string | undefined;
+    /**
+     * Apply when the tool succeeds.
+     * @public
+     */
+    applyOnSuccess?: boolean | undefined;
+    /**
+     * Apply when the tool fails.
+     * @public
+     */
+    applyOnFailure?: boolean | undefined;
+}
+/**
+ * Result annotation emitted after a voice bot tool completes.
+ * @public
+ */
+export interface VoiceBotToolResultAnnotation {
+}
+/**
+ * Tag annotation emitted after a voice bot tool completes.
+ * @public
+ */
+export interface VoiceBotToolTagAnnotation {
+    /**
+     * Static handlebars expression resolved against bot variables and helpers.
+     * @public
+     */
+    value?: string | undefined;
+    /**
+     * Apply when the tool succeeds.
+     * @public
+     */
+    applyOnSuccess?: boolean | undefined;
+    /**
+     * Apply when the tool fails.
+     * @public
+     */
+    applyOnFailure?: boolean | undefined;
+}
+/**
+ * Variables annotation emitted after a voice bot tool completes.
+ * @public
+ */
+export interface VoiceBotToolVariablesAnnotation {
+}
+/**
+ * Configuration for annotations emitted after a tool completes. Tag and comment annotations can provide a handlebars value, while variables and result annotations opt into logging runtime data.
+ * @public
+ */
+export type VoiceBotToolAnnotation = VoiceBotToolAnnotation.CommentMember | VoiceBotToolAnnotation.ResultMember | VoiceBotToolAnnotation.TagMember | VoiceBotToolAnnotation.VariablesMember | VoiceBotToolAnnotation.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace VoiceBotToolAnnotation {
+    /**
+     * Tag annotation emitted after a voice bot tool completes.
+     * @public
+     */
+    interface TagMember {
+        tag: VoiceBotToolTagAnnotation;
+        comment?: never;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Comment annotation emitted after a voice bot tool completes.
+     * @public
+     */
+    interface CommentMember {
+        tag?: never;
+        comment: VoiceBotToolCommentAnnotation;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Variables annotation emitted after a voice bot tool completes.
+     * @public
+     */
+    interface VariablesMember {
+        tag?: never;
+        comment?: never;
+        variables: VoiceBotToolVariablesAnnotation;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Result annotation emitted after a voice bot tool completes.
+     * @public
+     */
+    interface ResultMember {
+        tag?: never;
+        comment?: never;
+        variables?: never;
+        result: VoiceBotToolResultAnnotation;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        tag?: never;
+        comment?: never;
+        variables?: never;
+        result?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        tag: (value: VoiceBotToolTagAnnotation) => T;
+        comment: (value: VoiceBotToolCommentAnnotation) => T;
+        variables: (value: VoiceBotToolVariablesAnnotation) => T;
+        result: (value: VoiceBotToolResultAnnotation) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: VoiceBotToolAnnotation, visitor: Visitor<T>) => T;
+}
 /**
  * @public
  */
@@ -97,6 +344,7 @@ export interface VoiceBotKnowledgeBase {
      * @public
      */
     instructions?: string | undefined;
+    annotations?: (VoiceBotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -218,6 +466,7 @@ export interface VoiceBotCapabilityTool {
      * @public
      */
     pipeline?: VoiceBotCapabilityToolPipeline | undefined;
+    annotations?: (VoiceBotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -302,6 +551,7 @@ export interface VoiceBotEmbeddedTool {
      * @public
      */
     parameters?: __DocumentType | undefined;
+    annotations?: (VoiceBotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -539,6 +789,7 @@ export type VoiceBotToolType = typeof VoiceBotToolType[keyof typeof VoiceBotTool
 export interface VoiceBotTool {
     type: VoiceBotToolType;
     function?: VoiceBotFunctionDefinition | undefined;
+    annotations?: (VoiceBotToolAnnotation)[] | undefined;
 }
 /**
  * @public
@@ -1008,6 +1259,13 @@ export declare const TraceActivityStatus: {
  * @public
  */
 export type TraceActivityStatus = typeof TraceActivityStatus[keyof typeof TraceActivityStatus];
+/**
+ * Trace activity written when the voicebot emits an annotation.
+ * @public
+ */
+export interface TraceAnnotationCommand {
+    annotation: Annotation;
+}
 /**
  * @public
  */
@@ -1080,6 +1338,11 @@ export interface TranscriptionEvent {
     type: VoiceBotEventType;
     id: string;
     text: string;
+    /**
+     * Transcription confidence score (accuracy level) in range from 0.0 to 1.0. Value -1.0 indicates confidence is unavailable.
+     * @public
+     */
+    confidence?: number | undefined;
     final?: boolean | undefined;
     time: number;
 }
@@ -1108,7 +1371,7 @@ export interface TransferWebsocketCommand {
 /**
  * @public
  */
-export type TraceActivityTrigger = TraceActivityTrigger.CompleteEventMember | TraceActivityTrigger.ConnectEventMember | TraceActivityTrigger.DisconnectEventMember | TraceActivityTrigger.DurationTimeoutTaskMember | TraceActivityTrigger.HangupCommandMember | TraceActivityTrigger.InterruptionEventMember | TraceActivityTrigger.PlaybackEventMember | TraceActivityTrigger.ReplyEventMember | TraceActivityTrigger.SayCommandMember | TraceActivityTrigger.SilenceTimeoutTaskMember | TraceActivityTrigger.TranscriptionEventMember | TraceActivityTrigger.TransferCommandMember | TraceActivityTrigger.$UnknownMember;
+export type TraceActivityTrigger = TraceActivityTrigger.AnnotationCommandMember | TraceActivityTrigger.CompleteEventMember | TraceActivityTrigger.ConnectEventMember | TraceActivityTrigger.DisconnectEventMember | TraceActivityTrigger.DurationTimeoutTaskMember | TraceActivityTrigger.HangupCommandMember | TraceActivityTrigger.InterruptionEventMember | TraceActivityTrigger.PlaybackEventMember | TraceActivityTrigger.ReplyEventMember | TraceActivityTrigger.SayCommandMember | TraceActivityTrigger.SilenceTimeoutTaskMember | TraceActivityTrigger.TranscriptionEventMember | TraceActivityTrigger.TransferCommandMember | TraceActivityTrigger.$UnknownMember;
 /**
  * @public
  */
@@ -1124,6 +1387,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1139,6 +1403,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1154,6 +1419,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1169,6 +1435,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1184,6 +1451,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1199,6 +1467,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1214,6 +1483,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1229,6 +1499,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand: SayWebsocketCommand;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1244,6 +1515,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand: HangupWebsocketCommand;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1259,6 +1531,27 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand: TransferWebsocketCommand;
+        annotationCommand?: never;
+        silenceTimeoutTask?: never;
+        durationTimeoutTask?: never;
+        $unknown?: never;
+    }
+    /**
+     * Trace activity written when the voicebot emits an annotation.
+     * @public
+     */
+    interface AnnotationCommandMember {
+        connectEvent?: never;
+        disconnectEvent?: never;
+        replyEvent?: never;
+        completeEvent?: never;
+        interruptionEvent?: never;
+        playbackEvent?: never;
+        transcriptionEvent?: never;
+        sayCommand?: never;
+        hangupCommand?: never;
+        transferCommand?: never;
+        annotationCommand: TraceAnnotationCommand;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1274,6 +1567,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask: TraceSilenceTimeoutTaskTrigger;
         durationTimeoutTask?: never;
         $unknown?: never;
@@ -1289,6 +1583,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask: TraceDurationTimeoutTaskTrigger;
         $unknown?: never;
@@ -1307,6 +1602,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand?: never;
         hangupCommand?: never;
         transferCommand?: never;
+        annotationCommand?: never;
         silenceTimeoutTask?: never;
         durationTimeoutTask?: never;
         $unknown: [string, any];
@@ -1322,6 +1618,7 @@ export declare namespace TraceActivityTrigger {
         sayCommand: (value: SayWebsocketCommand) => T;
         hangupCommand: (value: HangupWebsocketCommand) => T;
         transferCommand: (value: TransferWebsocketCommand) => T;
+        annotationCommand: (value: TraceAnnotationCommand) => T;
         silenceTimeoutTask: (value: TraceSilenceTimeoutTaskTrigger) => T;
         durationTimeoutTask: (value: TraceDurationTimeoutTaskTrigger) => T;
         _: (name: string, value: any) => T;

package/dist-types/runtimeConfig.browser.d.ts

@@ -9,7 +9,7 @@ export declare const getRuntimeConfig: (config: VoiceBotsClientConfig) => {
     bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
     defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
     maxAttempts: number | import("@smithy/types").Provider<number>;
-    requestHandler: import("@smithy/protocol-http").HttpHandler<any> | RequestHandler;
+    requestHandler: import("@smithy/core/protocols").HttpHandler<any> | RequestHandler;
     retryMode: string | import("@smithy/types").Provider<string>;
     sha256: import("@smithy/types").HashConstructor;
     streamCollector: import("@smithy/types").StreamCollector;

package/dist-types/runtimeConfig.d.ts

@@ -9,7 +9,7 @@ export declare const getRuntimeConfig: (config: VoiceBotsClientConfig) => {
     bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
     defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
     maxAttempts: number | import("@smithy/types").Provider<number>;
-    requestHandler: RequestHandler | import("@smithy/protocol-http").HttpHandler<any>;
+    requestHandler: RequestHandler | import("@smithy/core/protocols").HttpHandler<any>;
     retryMode: string | import("@smithy/types").Provider<string>;
     sha256: import("@smithy/types").HashConstructor;
     streamCollector: import("@smithy/types").StreamCollector;

package/dist-types/runtimeConfig.native.d.ts

@@ -7,7 +7,7 @@ export declare const getRuntimeConfig: (config: VoiceBotsClientConfig) => {
     sha256: import("@smithy/types").HashConstructor;
     env?: "stage" | "stable" | "prod" | undefined;
     token: import("@wildix/smithy-utils").TokenProvider;
-    requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/protocol-http").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
+    requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/core/protocols").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
     cacheMiddleware?: boolean | undefined;
     protocol?: import("@smithy/types").ClientProtocol<any, any> | import("@smithy/types").$ClientProtocol<any, any> | import("@smithy/types").ClientProtocolCtor<any, any> | import("@smithy/types").$ClientProtocolCtor<any, any> | undefined;
     protocolSettings?: {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wim-voicebots-client",
     "description": "@wildix/wim-voicebots-client client",
-    "version": "1.1.8",
+    "version": "1.1.9",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",