@volley/recognition-client-sdk 0.1.707 → 0.1.767

package/dist/browser.bundled.d.ts

@@ -22,6 +22,8 @@ declare enum RecognitionProvider {
     CARTESIA = "cartesia",
     DASHSCOPE = "dashscope",
     BEDROCK = "bedrock",
+    INWORLD_STT = "inworld-stt",
+    AWS_TRANSCRIBE = "aws-transcribe",
     TEST_ASR_PROVIDER_QUOTA = "test-asr-provider-quota",
     TEST_ASR_STREAMING = "test-asr-streaming"
 }
@@ -129,6 +131,21 @@ declare enum BedrockModel {
     VOXTRAL_MINI_3B_2507 = "mistral.voxtral-mini-3b-2507",
     VOXTRAL_SMALL_24B_2507 = "mistral.voxtral-small-24b-2507"
 }
+/**
+ * Inworld AI STT models
+ * @see https://docs.inworld.ai/stt/overview
+ */
+declare enum InworldSttModel {
+    INWORLD_STT_1 = "inworld/inworld-stt-1"
+}
+/**
+ * AWS Transcribe streaming model
+ * AWS Transcribe uses a single default streaming model
+ * @see https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html
+ */
+declare enum AwsTranscribeModel {
+    DEFAULT = "default"
+}
 /**
  * Self-serve vLLM batch transcription models
  * Backed by recognition-inference / RunPod `/transcribe`
@@ -139,7 +156,7 @@ declare enum SelfServeVllmModel {
 /**
  * Type alias for any model from any provider
  */
-type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | SelfServeVllmModel | BedrockModel | string;
+type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | InworldSttModel | SelfServeVllmModel | BedrockModel | AwsTranscribeModel | string;
 
 /**
  * Audio encoding types
@@ -594,6 +611,61 @@ declare const SessionConfiguredSchemaV1: z.ZodObject<{
     providerConfig?: string | undefined;
 }>;
 type SessionConfiguredV1 = z.infer<typeof SessionConfiguredSchemaV1>;
+/**
+ * Audio metrics result V1 - contains audio quality metrics
+ * Extracted from raw PCM audio without AI/ML, pure signal analysis
+ * Used to detect mic issues (muted, low gain, clipping) and audio quality
+ */
+declare const AudioMetricsResultSchemaV1: z.ZodObject<{
+    type: z.ZodLiteral<RecognitionResultTypeV1.AUDIO_METRICS>;
+    valid: z.ZodBoolean;
+    audioBeginMs: z.ZodNumber;
+    audioEndMs: z.ZodNumber;
+    maxVolume: z.ZodNumber;
+    minVolume: z.ZodNumber;
+    avgVolume: z.ZodNumber;
+    peakVolumeDb: z.ZodNullable<z.ZodNumber>;
+    avgVolumeDb: z.ZodNullable<z.ZodNumber>;
+    silenceRatio: z.ZodNumber;
+    clippingRatio: z.ZodNumber;
+    snrEstimate: z.ZodNullable<z.ZodNumber>;
+    lastNonSilenceMs: z.ZodNumber;
+    timestamp: z.ZodString;
+    isFinal: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    valid: boolean;
+    type: RecognitionResultTypeV1.AUDIO_METRICS;
+    audioBeginMs: number;
+    audioEndMs: number;
+    maxVolume: number;
+    minVolume: number;
+    avgVolume: number;
+    silenceRatio: number;
+    clippingRatio: number;
+    snrEstimate: number | null;
+    lastNonSilenceMs: number;
+    timestamp: string;
+    peakVolumeDb: number | null;
+    avgVolumeDb: number | null;
+    isFinal?: boolean | undefined;
+}, {
+    valid: boolean;
+    type: RecognitionResultTypeV1.AUDIO_METRICS;
+    audioBeginMs: number;
+    audioEndMs: number;
+    maxVolume: number;
+    minVolume: number;
+    avgVolume: number;
+    silenceRatio: number;
+    clippingRatio: number;
+    snrEstimate: number | null;
+    lastNonSilenceMs: number;
+    timestamp: string;
+    peakVolumeDb: number | null;
+    avgVolumeDb: number | null;
+    isFinal?: boolean | undefined;
+}>;
+type AudioMetricsResultV1 = z.infer<typeof AudioMetricsResultSchemaV1>;
 
 /**
  * Recognition Context Types V1
@@ -866,6 +938,17 @@ interface ASRRequestConfig {
      * ```
      */
     providerOptions?: Record<string, any>;
+    /**
+     * Streaming audio metrics opt-in interval (ms).
+     *
+     * When set to a positive number, server forwards AudioMetrics results to the
+     * client over the WebSocket, throttled so at most one result is sent per
+     * `audioMetricsIntervalMs`. Undefined / 0 disables streaming audio metrics
+     * (final metrics still embedded in the Metadata result).
+     *
+     * @example 500
+     */
+    audioMetricsIntervalMs?: number;
     /**
      * Optional fallback ASR configurations
      *
@@ -1166,6 +1249,12 @@ interface IRecognitionClientConfig {
     onFunctionCall?: (result: FunctionCallResultV1) => void;
     /** Callback when metadata is received. Only once after transcription is complete.*/
     onMetadata?: (metadata: MetadataResultV1) => void;
+    /**
+     * Callback when streaming audio metrics arrive (volume, silence ratio, clipping, SNR, etc.).
+     * Only fires when `asrRequestConfig.audioMetricsIntervalMs > 0`.
+     * Final metrics still arrive embedded in `onMetadata.audioMetrics`.
+     */
+    onAudioMetrics?: (metrics: AudioMetricsResultV1) => void;
     /** Callback when session is configured with actual ASR provider/model (optional) */
     onSessionConfigured?: (config: SessionConfiguredV1) => void;
     /** Callback when error occurs */

package/dist/config-builder.d.ts

@@ -4,7 +4,7 @@
  * Simple builder pattern for RealTimeTwoWayWebSocketRecognitionClientConfig
  */
 import type { RealTimeTwoWayWebSocketRecognitionClientConfig, RecognitionCallbackUrl } from './recognition-client.types.js';
-import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, SessionConfiguredV1, ErrorResultV1, Stage } from '@recog/shared-types';
+import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, SessionConfiguredV1, AudioMetricsResultV1, ErrorResultV1, Stage } from '@recog/shared-types';
 /**
  * Builder for RealTimeTwoWayWebSocketRecognitionClientConfig
  *
@@ -107,6 +107,11 @@ export declare class ConfigBuilder {
      * Set session configured callback (optional)
      */
     onSessionConfigured(callback: (config: SessionConfiguredV1) => void): this;
+    /**
+     * Set streaming audio metrics callback (optional).
+     * Only fires when `asrRequestConfig.audioMetricsIntervalMs > 0`.
+     */
+    onAudioMetrics(callback: (metrics: AudioMetricsResultV1) => void): this;
     /**
      * Set error callback
      */

package/dist/config-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-builder.d.ts","sourceRoot":"","sources":["../src/config-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,8CAA8C,EAC9C,sBAAsB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,KAAK,EACN,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAA+D;IAE7E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKtB;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAKhD;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAKzC;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,IAAI;IAKlD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK/B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK1B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKhC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI;IAKvD;;;OAGG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK7C;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAAG,IAAI;IAKrE;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI;IAKhE;;OAEG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI;IAK1E;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAKvD;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAKvC;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAKtE;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKjC;;OAEG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK3C;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKrC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAKvG;;OAEG;IACH,KAAK,IAAI,8CAA8C;CAGxD"}
+{"version":3,"file":"config-builder.d.ts","sourceRoot":"","sources":["../src/config-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,8CAA8C,EAC9C,sBAAsB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,KAAK,EACN,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAA+D;IAE7E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKtB;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAKhD;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAKzC;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,IAAI;IAKlD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK/B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK1B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKhC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI;IAKvD;;;OAGG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK7C;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAAG,IAAI;IAKrE;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI;IAKhE;;OAEG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI;IAK1E;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GAAG,IAAI;IAKvE;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAKvD;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAKvC;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAKtE;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKjC;;OAEG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK3C;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKrC;;OAEG;IAEH,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAKvG;;OAEG;IACH,KAAK,IAAI,8CAA8C;CAGxD"}