cogito-client 1.0.67 → 1.0.69

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export declare interface CogitoAgent {
     id: string;
     greeting?: CogitoMessage[];
     prompt: string;
+    tts?: CogitoTTSConfig;
     tools?: {
         [k: string]: CogitoTool;
     };
@@ -31,6 +32,10 @@ export declare interface CogitoApprovalCardSurface {
 export declare interface CogitoAssistantMessage {
     role: "assistant";
     id?: string;
+    /**
+     * The ID of the assistant that delivered this message
+     */
+    assistantId?: string;
     date?: string;
     content: string;
     /**
@@ -195,24 +200,8 @@ export declare interface CogitoConfig {
         message?: string;
         [k: string]: unknown;
     };
-    stt?: {
-        model?: string;
-        language?: string;
-        [k: string]: unknown;
-    };
-    tts?: {
-        model?: string;
-        voice?: string;
-        language?: string;
-        voiceOverrides?: {
-            voice?: string;
-            language?: string;
-        }[];
-        pronunciation?: {
-            [k: string]: string;
-        };
-        [k: string]: unknown;
-    };
+    stt?: CogitoSTTConfig;
+    tts?: CogitoTTSConfig;
     llm?: {
         model?: string;
         extra_kwargs?: {
@@ -389,7 +378,7 @@ export declare interface CogitoHandoffTool {
      */
     targetName?: string;
     /**
-     * The message to say to the caller before putting them on hold during the transfer process
+     * The message to say to the caller before putting them on hold during the warm transfer process or before handing them to another agent
      */
     messageToCaller?: string;
     /**
@@ -966,6 +955,20 @@ export declare interface CogitoStatsDisplaySurface {
     };
 }
 
+export declare interface CogitoSTTConfig {
+    model?: string;
+    language?: string;
+    smartFormat?: SmartFormat;
+    punctuate?: Punctuation;
+    numerals?: Numerals;
+    profanityFilter?: ProfanityFilter;
+    fillerWords?: KeepFillerWords;
+    endpointing?: EndpointingMs;
+    keyterms?: KeyTerms;
+    extra_kwargs?: ExtraOptions;
+    [k: string]: unknown;
+}
+
 export declare interface CogitoSurfaceActionPayload {
     type: "surface-action";
     /**
@@ -1107,6 +1110,32 @@ export declare interface CogitoToolMessage {
     isError?: boolean;
 }
 
+export declare interface CogitoTTSConfig {
+    model?: string;
+    voice?: string;
+    language?: string;
+    speed?: Speed;
+    stability?: Stability;
+    similarityBoost?: SimilarityBoost;
+    style?: StyleExaggeration;
+    useSpeakerBoost?: SpeakerBoost;
+    voiceOverrides?: {
+        voice?: string;
+        language?: string;
+        speed?: Speed1;
+        stability?: Stability1;
+        similarityBoost?: SimilarityBoost1;
+        style?: StyleExaggeration1;
+        useSpeakerBoost?: SpeakerBoost1;
+        extra_kwargs?: ExtraOptions1;
+    }[];
+    pronunciation?: {
+        [k: string]: string;
+    };
+    extra_kwargs?: ExtraOptions2;
+    [k: string]: unknown;
+}
+
 export declare interface CogitoUserMessage {
     role: "user";
     userName?: string;
@@ -1388,6 +1417,109 @@ export declare type CogitoWebhookPayload = CogitoMessageWebhook | CogitoCallComp
 
 export declare type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'error';
 
+/**
+ * Silence in milliseconds before an utterance is considered finished.
+ */
+export declare type EndpointingMs = number;
+
+/**
+ * Escape hatch for provider STT options not promoted to typed fields.
+ */
+export declare interface ExtraOptions {
+    [k: string]: unknown;
+}
+
+export declare interface ExtraOptions1 {
+    [k: string]: unknown;
+}
+
+/**
+ * Escape hatch for provider TTS options not promoted to typed fields.
+ */
+export declare interface ExtraOptions2 {
+    [k: string]: unknown;
+}
+
+/**
+ * Keep filler words (um, uh) in transcripts.
+ */
+export declare type KeepFillerWords = boolean;
+
+/**
+ * Boost recognition of domain words/names (nova-3 only).
+ */
+export declare type KeyTerms = string[];
+
+/**
+ * Convert spoken numbers to digits.
+ */
+export declare type Numerals = boolean;
+
+/**
+ * Mask profanity in transcripts.
+ */
+export declare type ProfanityFilter = boolean;
+
+/**
+ * Add punctuation to transcripts.
+ */
+export declare type Punctuation = boolean;
+
+/**
+ * How closely the output matches the original voice.
+ */
+export declare type SimilarityBoost = number;
+
+/**
+ * Inherits from top-level TTS when unset.
+ */
+export declare type SimilarityBoost1 = number;
+
+/**
+ * Apply Deepgram smart formatting (dates, times, currency, etc.).
+ */
+export declare type SmartFormat = boolean;
+
+/**
+ * Boosts similarity to the original speaker (adds slight latency).
+ */
+export declare type SpeakerBoost = boolean;
+
+/**
+ * Inherits from top-level TTS when unset.
+ */
+export declare type SpeakerBoost1 = boolean;
+
+/**
+ * Speech rate. 1.0 = normal.
+ */
+export declare type Speed = number;
+
+/**
+ * Speech rate. 1.0 = normal. Inherits from top-level TTS when unset.
+ */
+export declare type Speed1 = number;
+
+/**
+ * Lower = more expressive/variable, higher = more consistent/flat.
+ */
+export declare type Stability = number;
+
+/**
+ * Inherits from top-level TTS when unset.
+ */
+export declare type Stability1 = number;
+
+/**
+ * Amplifies the speaker's style. 0 = off (lowest latency).
+ */
+export declare type StyleExaggeration = number;
+
+/**
+ * Inherits from top-level TTS when unset.
+ */
+export declare type StyleExaggeration1 = number;
+
 export declare function useCogito({ mode, server, configuration, applicationId, tenantId, id }: UseCogitoOptions): {
     messages: CogitoMessage[];
     connectionState: ConnectionState;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cogito-client",
-    "version": "1.0.67",
+    "version": "1.0.69",
     "type": "module",
     "files": [
         "dist"