@volley/recognition-client-sdk 0.1.707 → 0.1.782

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,6 +22,9 @@ declare enum RecognitionProvider {
22
22
  CARTESIA = "cartesia",
23
23
  DASHSCOPE = "dashscope",
24
24
  BEDROCK = "bedrock",
25
+ INWORLD_STT = "inworld-stt",
26
+ AWS_TRANSCRIBE = "aws-transcribe",
27
+ AMAZON_NOVA_SONIC = "amazon-nova-sonic",
25
28
  TEST_ASR_PROVIDER_QUOTA = "test-asr-provider-quota",
26
29
  TEST_ASR_STREAMING = "test-asr-streaming"
27
30
  }
@@ -94,6 +97,7 @@ declare enum ElevenLabsModel {
94
97
  * @see https://platform.openai.com/docs/models/gpt-4o-transcribe
95
98
  */
96
99
  declare enum OpenAIRealtimeModel {
100
+ GPT_REALTIME_WHISPER = "gpt-realtime-whisper",
97
101
  GPT_4O_TRANSCRIBE = "gpt-4o-transcribe",
98
102
  GPT_4O_MINI_TRANSCRIBE = "gpt-4o-mini-transcribe"
99
103
  }
@@ -130,134 +134,40 @@ declare enum BedrockModel {
130
134
  VOXTRAL_SMALL_24B_2507 = "mistral.voxtral-small-24b-2507"
131
135
  }
132
136
  /**
133
- * Self-serve vLLM batch transcription models
134
- * Backed by recognition-inference / RunPod `/transcribe`
137
+ * Inworld AI STT models
138
+ * @see https://docs.inworld.ai/stt/overview
135
139
  */
136
- declare enum SelfServeVllmModel {
137
- QWEN3_ASR_1_7B = "qwen3-asr-1.7b"
140
+ declare enum InworldSttModel {
141
+ INWORLD_STT_1 = "inworld/inworld-stt-1"
138
142
  }
139
143
  /**
140
- * Type alias for any model from any provider
144
+ * AWS Transcribe streaming model
145
+ * AWS Transcribe uses a single default streaming model
146
+ * @see https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html
141
147
  */
142
- type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | SelfServeVllmModel | BedrockModel | string;
143
-
148
+ declare enum AwsTranscribeModel {
149
+ DEFAULT = "default"
150
+ }
144
151
  /**
145
- * Audio encoding types
152
+ * Amazon Nova Sonic bidirectional streaming model (Bedrock).
153
+ * Speech-to-speech model; we consume the USER FINAL transcript and discard the assistant text/audio output.
154
+ * @see https://docs.aws.amazon.com/nova/latest/userguide/speech-bidirection.html
146
155
  */
147
- declare enum AudioEncoding {
148
- ENCODING_UNSPECIFIED = 0,
149
- LINEAR16 = 1,
150
- OGG_OPUS = 2,
151
- FLAC = 3,
152
- MULAW = 4,
153
- ALAW = 5
154
- }
155
- declare namespace AudioEncoding {
156
- /**
157
- * Convert numeric ID to AudioEncoding enum
158
- * @param id - Numeric encoding identifier (0-5)
159
- * @returns AudioEncoding enum value or undefined if invalid
160
- */
161
- function fromId(id: number): AudioEncoding | undefined;
162
- /**
163
- * Convert string name to AudioEncoding enum
164
- * @param nameStr - String name like "linear16", "LINEAR16", "ogg_opus", "OGG_OPUS", etc. (case insensitive)
165
- * @returns AudioEncoding enum value or undefined if invalid
166
- */
167
- function fromName(nameStr: string): AudioEncoding | undefined;
168
- /**
169
- * Convert AudioEncoding enum to numeric ID
170
- * @param encoding - AudioEncoding enum value
171
- * @returns Numeric ID (0-5)
172
- */
173
- function toId(encoding: AudioEncoding): number;
174
- /**
175
- * Convert AudioEncoding enum to string name
176
- * @param encoding - AudioEncoding enum value
177
- * @returns String name like "LINEAR16", "MULAW", etc.
178
- */
179
- function toName(encoding: AudioEncoding): string;
180
- /**
181
- * Check if a numeric ID is a valid encoding
182
- * @param id - Numeric identifier to validate
183
- * @returns true if valid encoding ID
184
- */
185
- function isIdValid(id: number): boolean;
186
- /**
187
- * Check if a string name is a valid encoding
188
- * @param nameStr - String name to validate
189
- * @returns true if valid encoding name
190
- */
191
- function isNameValid(nameStr: string): boolean;
156
+ declare enum AmazonNovaSonicModel {
157
+ AMAZON_NOVA_SONIC_V1 = "amazon.nova-sonic-v1:0",
158
+ AMAZON_NOVA_2_SONIC = "amazon.nova-2-sonic-v1:0"
192
159
  }
193
160
  /**
194
- * Common sample rates (in Hz)
161
+ * Self-serve vLLM batch transcription models
162
+ * Backed by recognition-inference / RunPod `/transcribe`
195
163
  */
196
- declare enum SampleRate {
197
- RATE_8000 = 8000,
198
- RATE_16000 = 16000,
199
- RATE_22050 = 22050,
200
- RATE_24000 = 24000,
201
- RATE_32000 = 32000,
202
- RATE_44100 = 44100,
203
- RATE_48000 = 48000
204
- }
205
- declare namespace SampleRate {
206
- /**
207
- * Convert Hz value to SampleRate enum
208
- * @param hz - Sample rate in Hz (8000, 16000, etc.)
209
- * @returns SampleRate enum value or undefined if invalid
210
- */
211
- function fromHz(hz: number): SampleRate | undefined;
212
- /**
213
- * Convert string name to SampleRate enum
214
- * @param nameStr - String name like "rate_8000", "RATE_16000", etc. (case insensitive)
215
- * @returns SampleRate enum value or undefined if invalid
216
- */
217
- function fromName(nameStr: string): SampleRate | undefined;
218
- /**
219
- * Convert SampleRate enum to Hz value
220
- * @param rate - SampleRate enum value
221
- * @returns Hz value (8000, 16000, etc.)
222
- */
223
- function toHz(rate: SampleRate): number;
224
- /**
225
- * Convert SampleRate enum to string name
226
- * @param rate - SampleRate enum value
227
- * @returns String name like "RATE_8000", "RATE_16000", etc.
228
- */
229
- function toName(rate: SampleRate): string;
230
- /**
231
- * Check if a numeric Hz value is a valid sample rate
232
- * @param hz - Hz value to validate
233
- * @returns true if valid sample rate
234
- */
235
- function isHzValid(hz: number): boolean;
236
- /**
237
- * Check if a string name is a valid sample rate
238
- * @param nameStr - String name to validate
239
- * @returns true if valid sample rate name
240
- */
241
- function isNameValid(nameStr: string): boolean;
164
+ declare enum SelfServeVllmModel {
165
+ QWEN3_ASR_1_7B = "qwen3-asr-1.7b"
242
166
  }
243
167
  /**
244
- * Supported languages for recognition
245
- * Using BCP-47 language tags
168
+ * Type alias for any model from any provider
246
169
  */
247
- declare enum Language {
248
- ENGLISH_US = "en-US",
249
- ENGLISH_GB = "en-GB",
250
- SPANISH_ES = "es-ES",
251
- SPANISH_MX = "es-MX",
252
- FRENCH_FR = "fr-FR",
253
- GERMAN_DE = "de-DE",
254
- ITALIAN_IT = "it-IT",
255
- PORTUGUESE_BR = "pt-BR",
256
- JAPANESE_JP = "ja-JP",
257
- KOREAN_KR = "ko-KR",
258
- CHINESE_CN = "zh-CN",
259
- CHINESE_TW = "zh-TW"
260
- }
170
+ type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | InworldSttModel | SelfServeVllmModel | BedrockModel | AwsTranscribeModel | AmazonNovaSonicModel | string;
261
171
 
262
172
  /**
263
173
  * Recognition Result Types V1
@@ -277,6 +187,16 @@ declare enum RecognitionResultTypeV1 {
277
187
  AUDIO_METRICS = "AudioMetrics",
278
188
  SESSION_CONFIGURED = "SessionConfigured"
279
189
  }
190
+ /**
191
+ * Source of a phrase detection — what kind of provider feature produced
192
+ * the hit. Currently only Deepgram's `search` parameter is wired up, so
193
+ * this enum has one value. New entries (e.g. KEYWORDS, KEYTERMS,
194
+ * SPEECH_CONTEXTS) get added when other providers join.
195
+ */
196
+ declare enum DetectionTypeV1 {
197
+ /** Deepgram phonetic phrase match via the `search=…` request parameter */
198
+ SEARCH = "search"
199
+ }
280
200
  /**
281
201
  * Transcription result V1 - contains transcript message
282
202
  * In the long run game side should not need to know it. In the short run it is send back to client.
@@ -301,6 +221,25 @@ declare const TranscriptionResultSchemaV1: z.ZodObject<{
301
221
  receivedAtMs: z.ZodOptional<z.ZodNumber>;
302
222
  accumulatedAudioTimeMs: z.ZodOptional<z.ZodNumber>;
303
223
  rawAudioTimeMs: z.ZodOptional<z.ZodNumber>;
224
+ detections: z.ZodOptional<z.ZodArray<z.ZodObject<{
225
+ type: z.ZodNativeEnum<typeof DetectionTypeV1>;
226
+ query: z.ZodString;
227
+ score: z.ZodNumber;
228
+ startMs: z.ZodOptional<z.ZodNumber>;
229
+ endMs: z.ZodOptional<z.ZodNumber>;
230
+ }, "strip", z.ZodTypeAny, {
231
+ type: DetectionTypeV1;
232
+ query: string;
233
+ score: number;
234
+ startMs?: number | undefined;
235
+ endMs?: number | undefined;
236
+ }, {
237
+ type: DetectionTypeV1;
238
+ query: string;
239
+ score: number;
240
+ startMs?: number | undefined;
241
+ endMs?: number | undefined;
242
+ }>, "many">>;
304
243
  }, "strip", z.ZodTypeAny, {
305
244
  type: RecognitionResultTypeV1.TRANSCRIPTION;
306
245
  audioUtteranceId: string;
@@ -320,6 +259,13 @@ declare const TranscriptionResultSchemaV1: z.ZodObject<{
320
259
  receivedAtMs?: number | undefined;
321
260
  accumulatedAudioTimeMs?: number | undefined;
322
261
  rawAudioTimeMs?: number | undefined;
262
+ detections?: {
263
+ type: DetectionTypeV1;
264
+ query: string;
265
+ score: number;
266
+ startMs?: number | undefined;
267
+ endMs?: number | undefined;
268
+ }[] | undefined;
323
269
  }, {
324
270
  type: RecognitionResultTypeV1.TRANSCRIPTION;
325
271
  audioUtteranceId: string;
@@ -339,6 +285,13 @@ declare const TranscriptionResultSchemaV1: z.ZodObject<{
339
285
  receivedAtMs?: number | undefined;
340
286
  accumulatedAudioTimeMs?: number | undefined;
341
287
  rawAudioTimeMs?: number | undefined;
288
+ detections?: {
289
+ type: DetectionTypeV1;
290
+ query: string;
291
+ score: number;
292
+ startMs?: number | undefined;
293
+ endMs?: number | undefined;
294
+ }[] | undefined;
342
295
  }>;
343
296
  type TranscriptionResultV1 = z.infer<typeof TranscriptionResultSchemaV1>;
344
297
  /**
@@ -603,6 +556,179 @@ declare const SessionConfiguredSchemaV1: z.ZodObject<{
603
556
  providerConfig?: string | undefined;
604
557
  }>;
605
558
  type SessionConfiguredV1 = z.infer<typeof SessionConfiguredSchemaV1>;
559
+ /**
560
+ * Audio metrics result V1 - contains audio quality metrics
561
+ * Extracted from raw PCM audio without AI/ML, pure signal analysis
562
+ * Used to detect mic issues (muted, low gain, clipping) and audio quality
563
+ */
564
+ declare const AudioMetricsResultSchemaV1: z.ZodObject<{
565
+ type: z.ZodLiteral<RecognitionResultTypeV1.AUDIO_METRICS>;
566
+ valid: z.ZodBoolean;
567
+ audioBeginMs: z.ZodNumber;
568
+ audioEndMs: z.ZodNumber;
569
+ maxVolume: z.ZodNumber;
570
+ minVolume: z.ZodNumber;
571
+ avgVolume: z.ZodNumber;
572
+ peakVolumeDb: z.ZodNullable<z.ZodNumber>;
573
+ avgVolumeDb: z.ZodNullable<z.ZodNumber>;
574
+ silenceRatio: z.ZodNumber;
575
+ clippingRatio: z.ZodNumber;
576
+ snrEstimate: z.ZodNullable<z.ZodNumber>;
577
+ lastNonSilenceMs: z.ZodNumber;
578
+ timestamp: z.ZodString;
579
+ isFinal: z.ZodOptional<z.ZodBoolean>;
580
+ }, "strip", z.ZodTypeAny, {
581
+ valid: boolean;
582
+ type: RecognitionResultTypeV1.AUDIO_METRICS;
583
+ audioBeginMs: number;
584
+ audioEndMs: number;
585
+ maxVolume: number;
586
+ minVolume: number;
587
+ avgVolume: number;
588
+ silenceRatio: number;
589
+ clippingRatio: number;
590
+ snrEstimate: number | null;
591
+ lastNonSilenceMs: number;
592
+ timestamp: string;
593
+ peakVolumeDb: number | null;
594
+ avgVolumeDb: number | null;
595
+ isFinal?: boolean | undefined;
596
+ }, {
597
+ valid: boolean;
598
+ type: RecognitionResultTypeV1.AUDIO_METRICS;
599
+ audioBeginMs: number;
600
+ audioEndMs: number;
601
+ maxVolume: number;
602
+ minVolume: number;
603
+ avgVolume: number;
604
+ silenceRatio: number;
605
+ clippingRatio: number;
606
+ snrEstimate: number | null;
607
+ lastNonSilenceMs: number;
608
+ timestamp: string;
609
+ peakVolumeDb: number | null;
610
+ avgVolumeDb: number | null;
611
+ isFinal?: boolean | undefined;
612
+ }>;
613
+ type AudioMetricsResultV1 = z.infer<typeof AudioMetricsResultSchemaV1>;
614
+
615
+ /**
616
+ * Audio encoding types
617
+ */
618
+ declare enum AudioEncoding {
619
+ ENCODING_UNSPECIFIED = 0,
620
+ LINEAR16 = 1,
621
+ OGG_OPUS = 2,
622
+ FLAC = 3,
623
+ MULAW = 4,
624
+ ALAW = 5
625
+ }
626
+ declare namespace AudioEncoding {
627
+ /**
628
+ * Convert numeric ID to AudioEncoding enum
629
+ * @param id - Numeric encoding identifier (0-5)
630
+ * @returns AudioEncoding enum value or undefined if invalid
631
+ */
632
+ function fromId(id: number): AudioEncoding | undefined;
633
+ /**
634
+ * Convert string name to AudioEncoding enum
635
+ * @param nameStr - String name like "linear16", "LINEAR16", "ogg_opus", "OGG_OPUS", etc. (case insensitive)
636
+ * @returns AudioEncoding enum value or undefined if invalid
637
+ */
638
+ function fromName(nameStr: string): AudioEncoding | undefined;
639
+ /**
640
+ * Convert AudioEncoding enum to numeric ID
641
+ * @param encoding - AudioEncoding enum value
642
+ * @returns Numeric ID (0-5)
643
+ */
644
+ function toId(encoding: AudioEncoding): number;
645
+ /**
646
+ * Convert AudioEncoding enum to string name
647
+ * @param encoding - AudioEncoding enum value
648
+ * @returns String name like "LINEAR16", "MULAW", etc.
649
+ */
650
+ function toName(encoding: AudioEncoding): string;
651
+ /**
652
+ * Check if a numeric ID is a valid encoding
653
+ * @param id - Numeric identifier to validate
654
+ * @returns true if valid encoding ID
655
+ */
656
+ function isIdValid(id: number): boolean;
657
+ /**
658
+ * Check if a string name is a valid encoding
659
+ * @param nameStr - String name to validate
660
+ * @returns true if valid encoding name
661
+ */
662
+ function isNameValid(nameStr: string): boolean;
663
+ }
664
+ /**
665
+ * Common sample rates (in Hz)
666
+ */
667
+ declare enum SampleRate {
668
+ RATE_8000 = 8000,
669
+ RATE_16000 = 16000,
670
+ RATE_22050 = 22050,
671
+ RATE_24000 = 24000,
672
+ RATE_32000 = 32000,
673
+ RATE_44100 = 44100,
674
+ RATE_48000 = 48000
675
+ }
676
+ declare namespace SampleRate {
677
+ /**
678
+ * Convert Hz value to SampleRate enum
679
+ * @param hz - Sample rate in Hz (8000, 16000, etc.)
680
+ * @returns SampleRate enum value or undefined if invalid
681
+ */
682
+ function fromHz(hz: number): SampleRate | undefined;
683
+ /**
684
+ * Convert string name to SampleRate enum
685
+ * @param nameStr - String name like "rate_8000", "RATE_16000", etc. (case insensitive)
686
+ * @returns SampleRate enum value or undefined if invalid
687
+ */
688
+ function fromName(nameStr: string): SampleRate | undefined;
689
+ /**
690
+ * Convert SampleRate enum to Hz value
691
+ * @param rate - SampleRate enum value
692
+ * @returns Hz value (8000, 16000, etc.)
693
+ */
694
+ function toHz(rate: SampleRate): number;
695
+ /**
696
+ * Convert SampleRate enum to string name
697
+ * @param rate - SampleRate enum value
698
+ * @returns String name like "RATE_8000", "RATE_16000", etc.
699
+ */
700
+ function toName(rate: SampleRate): string;
701
+ /**
702
+ * Check if a numeric Hz value is a valid sample rate
703
+ * @param hz - Hz value to validate
704
+ * @returns true if valid sample rate
705
+ */
706
+ function isHzValid(hz: number): boolean;
707
+ /**
708
+ * Check if a string name is a valid sample rate
709
+ * @param nameStr - String name to validate
710
+ * @returns true if valid sample rate name
711
+ */
712
+ function isNameValid(nameStr: string): boolean;
713
+ }
714
+ /**
715
+ * Supported languages for recognition
716
+ * Using BCP-47 language tags
717
+ */
718
+ declare enum Language {
719
+ ENGLISH_US = "en-US",
720
+ ENGLISH_GB = "en-GB",
721
+ SPANISH_ES = "es-ES",
722
+ SPANISH_MX = "es-MX",
723
+ FRENCH_FR = "fr-FR",
724
+ GERMAN_DE = "de-DE",
725
+ ITALIAN_IT = "it-IT",
726
+ PORTUGUESE_BR = "pt-BR",
727
+ JAPANESE_JP = "ja-JP",
728
+ KOREAN_KR = "ko-KR",
729
+ CHINESE_CN = "zh-CN",
730
+ CHINESE_TW = "zh-TW"
731
+ }
606
732
 
607
733
  /**
608
734
  * Error Exception Types
@@ -621,9 +747,9 @@ declare const AuthenticationExceptionSchema: z.ZodObject<{
621
747
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
622
748
  message: z.ZodString;
623
749
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
624
- description: z.ZodOptional<z.ZodString>;
625
750
  audioUtteranceId: z.ZodOptional<z.ZodString>;
626
751
  timestamp: z.ZodOptional<z.ZodNumber>;
752
+ description: z.ZodOptional<z.ZodString>;
627
753
  errorType: z.ZodLiteral<ErrorTypeV1.AUTHENTICATION_ERROR>;
628
754
  isImmediatelyAvailable: z.ZodLiteral<false>;
629
755
  service: z.ZodOptional<z.ZodString>;
@@ -634,9 +760,9 @@ declare const AuthenticationExceptionSchema: z.ZodObject<{
634
760
  isImmediatelyAvailable: false;
635
761
  code?: string | number | undefined;
636
762
  provider?: RecognitionProvider | undefined;
637
- description?: string | undefined;
638
763
  audioUtteranceId?: string | undefined;
639
764
  timestamp?: number | undefined;
765
+ description?: string | undefined;
640
766
  service?: string | undefined;
641
767
  authMethod?: string | undefined;
642
768
  }, {
@@ -645,9 +771,9 @@ declare const AuthenticationExceptionSchema: z.ZodObject<{
645
771
  isImmediatelyAvailable: false;
646
772
  code?: string | number | undefined;
647
773
  provider?: RecognitionProvider | undefined;
648
- description?: string | undefined;
649
774
  audioUtteranceId?: string | undefined;
650
775
  timestamp?: number | undefined;
776
+ description?: string | undefined;
651
777
  service?: string | undefined;
652
778
  authMethod?: string | undefined;
653
779
  }>;
@@ -661,9 +787,9 @@ declare const ValidationExceptionSchema: z.ZodObject<{
661
787
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
662
788
  message: z.ZodString;
663
789
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
664
- description: z.ZodOptional<z.ZodString>;
665
790
  audioUtteranceId: z.ZodOptional<z.ZodString>;
666
791
  timestamp: z.ZodOptional<z.ZodNumber>;
792
+ description: z.ZodOptional<z.ZodString>;
667
793
  errorType: z.ZodLiteral<ErrorTypeV1.VALIDATION_ERROR>;
668
794
  isImmediatelyAvailable: z.ZodLiteral<true>;
669
795
  field: z.ZodOptional<z.ZodString>;
@@ -675,9 +801,9 @@ declare const ValidationExceptionSchema: z.ZodObject<{
675
801
  isImmediatelyAvailable: true;
676
802
  code?: string | number | undefined;
677
803
  provider?: RecognitionProvider | undefined;
678
- description?: string | undefined;
679
804
  audioUtteranceId?: string | undefined;
680
805
  timestamp?: number | undefined;
806
+ description?: string | undefined;
681
807
  field?: string | undefined;
682
808
  expected?: string | undefined;
683
809
  received?: string | undefined;
@@ -687,9 +813,9 @@ declare const ValidationExceptionSchema: z.ZodObject<{
687
813
  isImmediatelyAvailable: true;
688
814
  code?: string | number | undefined;
689
815
  provider?: RecognitionProvider | undefined;
690
- description?: string | undefined;
691
816
  audioUtteranceId?: string | undefined;
692
817
  timestamp?: number | undefined;
818
+ description?: string | undefined;
693
819
  field?: string | undefined;
694
820
  expected?: string | undefined;
695
821
  received?: string | undefined;
@@ -703,9 +829,9 @@ type ValidationException = z.infer<typeof ValidationExceptionSchema>;
703
829
  declare const ProviderExceptionSchema: z.ZodObject<{
704
830
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
705
831
  message: z.ZodString;
706
- description: z.ZodOptional<z.ZodString>;
707
832
  audioUtteranceId: z.ZodOptional<z.ZodString>;
708
833
  timestamp: z.ZodOptional<z.ZodNumber>;
834
+ description: z.ZodOptional<z.ZodString>;
709
835
  errorType: z.ZodLiteral<ErrorTypeV1.PROVIDER_ERROR>;
710
836
  isImmediatelyAvailable: z.ZodLiteral<false>;
711
837
  provider: z.ZodOptional<z.ZodString>;
@@ -716,9 +842,9 @@ declare const ProviderExceptionSchema: z.ZodObject<{
716
842
  errorType: ErrorTypeV1.PROVIDER_ERROR;
717
843
  isImmediatelyAvailable: false;
718
844
  code?: string | number | undefined;
719
- description?: string | undefined;
720
845
  audioUtteranceId?: string | undefined;
721
846
  timestamp?: number | undefined;
847
+ description?: string | undefined;
722
848
  provider?: string | undefined;
723
849
  providerErrorCode?: string | number | undefined;
724
850
  isTransient?: boolean | undefined;
@@ -727,9 +853,9 @@ declare const ProviderExceptionSchema: z.ZodObject<{
727
853
  errorType: ErrorTypeV1.PROVIDER_ERROR;
728
854
  isImmediatelyAvailable: false;
729
855
  code?: string | number | undefined;
730
- description?: string | undefined;
731
856
  audioUtteranceId?: string | undefined;
732
857
  timestamp?: number | undefined;
858
+ description?: string | undefined;
733
859
  provider?: string | undefined;
734
860
  providerErrorCode?: string | number | undefined;
735
861
  isTransient?: boolean | undefined;
@@ -744,9 +870,9 @@ declare const TimeoutExceptionSchema: z.ZodObject<{
744
870
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
745
871
  message: z.ZodString;
746
872
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
747
- description: z.ZodOptional<z.ZodString>;
748
873
  audioUtteranceId: z.ZodOptional<z.ZodString>;
749
874
  timestamp: z.ZodOptional<z.ZodNumber>;
875
+ description: z.ZodOptional<z.ZodString>;
750
876
  errorType: z.ZodLiteral<ErrorTypeV1.TIMEOUT_ERROR>;
751
877
  isImmediatelyAvailable: z.ZodLiteral<true>;
752
878
  timeoutMs: z.ZodOptional<z.ZodNumber>;
@@ -757,9 +883,9 @@ declare const TimeoutExceptionSchema: z.ZodObject<{
757
883
  isImmediatelyAvailable: true;
758
884
  code?: string | number | undefined;
759
885
  provider?: RecognitionProvider | undefined;
760
- description?: string | undefined;
761
886
  audioUtteranceId?: string | undefined;
762
887
  timestamp?: number | undefined;
888
+ description?: string | undefined;
763
889
  timeoutMs?: number | undefined;
764
890
  operation?: string | undefined;
765
891
  }, {
@@ -768,9 +894,9 @@ declare const TimeoutExceptionSchema: z.ZodObject<{
768
894
  isImmediatelyAvailable: true;
769
895
  code?: string | number | undefined;
770
896
  provider?: RecognitionProvider | undefined;
771
- description?: string | undefined;
772
897
  audioUtteranceId?: string | undefined;
773
898
  timestamp?: number | undefined;
899
+ description?: string | undefined;
774
900
  timeoutMs?: number | undefined;
775
901
  operation?: string | undefined;
776
902
  }>;
@@ -784,9 +910,9 @@ declare const QuotaExceededExceptionSchema: z.ZodObject<{
784
910
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
785
911
  message: z.ZodString;
786
912
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
787
- description: z.ZodOptional<z.ZodString>;
788
913
  audioUtteranceId: z.ZodOptional<z.ZodString>;
789
914
  timestamp: z.ZodOptional<z.ZodNumber>;
915
+ description: z.ZodOptional<z.ZodString>;
790
916
  errorType: z.ZodLiteral<ErrorTypeV1.QUOTA_EXCEEDED>;
791
917
  isImmediatelyAvailable: z.ZodLiteral<true>;
792
918
  quotaType: z.ZodOptional<z.ZodString>;
@@ -798,9 +924,9 @@ declare const QuotaExceededExceptionSchema: z.ZodObject<{
798
924
  isImmediatelyAvailable: true;
799
925
  code?: string | number | undefined;
800
926
  provider?: RecognitionProvider | undefined;
801
- description?: string | undefined;
802
927
  audioUtteranceId?: string | undefined;
803
928
  timestamp?: number | undefined;
929
+ description?: string | undefined;
804
930
  quotaType?: string | undefined;
805
931
  resetAt?: number | undefined;
806
932
  retryAfterSeconds?: number | undefined;
@@ -810,9 +936,9 @@ declare const QuotaExceededExceptionSchema: z.ZodObject<{
810
936
  isImmediatelyAvailable: true;
811
937
  code?: string | number | undefined;
812
938
  provider?: RecognitionProvider | undefined;
813
- description?: string | undefined;
814
939
  audioUtteranceId?: string | undefined;
815
940
  timestamp?: number | undefined;
941
+ description?: string | undefined;
816
942
  quotaType?: string | undefined;
817
943
  resetAt?: number | undefined;
818
944
  retryAfterSeconds?: number | undefined;
@@ -827,9 +953,9 @@ declare const ConnectionExceptionSchema: z.ZodObject<{
827
953
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
828
954
  message: z.ZodString;
829
955
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
830
- description: z.ZodOptional<z.ZodString>;
831
956
  audioUtteranceId: z.ZodOptional<z.ZodString>;
832
957
  timestamp: z.ZodOptional<z.ZodNumber>;
958
+ description: z.ZodOptional<z.ZodString>;
833
959
  errorType: z.ZodLiteral<ErrorTypeV1.CONNECTION_ERROR>;
834
960
  isImmediatelyAvailable: z.ZodLiteral<true>;
835
961
  attempts: z.ZodOptional<z.ZodNumber>;
@@ -841,9 +967,9 @@ declare const ConnectionExceptionSchema: z.ZodObject<{
841
967
  isImmediatelyAvailable: true;
842
968
  code?: string | number | undefined;
843
969
  provider?: RecognitionProvider | undefined;
844
- description?: string | undefined;
845
970
  audioUtteranceId?: string | undefined;
846
971
  timestamp?: number | undefined;
972
+ description?: string | undefined;
847
973
  attempts?: number | undefined;
848
974
  url?: string | undefined;
849
975
  underlyingError?: string | undefined;
@@ -853,9 +979,9 @@ declare const ConnectionExceptionSchema: z.ZodObject<{
853
979
  isImmediatelyAvailable: true;
854
980
  code?: string | number | undefined;
855
981
  provider?: RecognitionProvider | undefined;
856
- description?: string | undefined;
857
982
  audioUtteranceId?: string | undefined;
858
983
  timestamp?: number | undefined;
984
+ description?: string | undefined;
859
985
  attempts?: number | undefined;
860
986
  url?: string | undefined;
861
987
  underlyingError?: string | undefined;
@@ -870,9 +996,9 @@ declare const UnknownExceptionSchema: z.ZodObject<{
870
996
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
871
997
  message: z.ZodString;
872
998
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
873
- description: z.ZodOptional<z.ZodString>;
874
999
  audioUtteranceId: z.ZodOptional<z.ZodString>;
875
1000
  timestamp: z.ZodOptional<z.ZodNumber>;
1001
+ description: z.ZodOptional<z.ZodString>;
876
1002
  errorType: z.ZodLiteral<ErrorTypeV1.UNKNOWN_ERROR>;
877
1003
  isImmediatelyAvailable: z.ZodLiteral<false>;
878
1004
  stack: z.ZodOptional<z.ZodString>;
@@ -883,9 +1009,9 @@ declare const UnknownExceptionSchema: z.ZodObject<{
883
1009
  isImmediatelyAvailable: false;
884
1010
  code?: string | number | undefined;
885
1011
  provider?: RecognitionProvider | undefined;
886
- description?: string | undefined;
887
1012
  audioUtteranceId?: string | undefined;
888
1013
  timestamp?: number | undefined;
1014
+ description?: string | undefined;
889
1015
  stack?: string | undefined;
890
1016
  context?: Record<string, unknown> | undefined;
891
1017
  }, {
@@ -894,9 +1020,9 @@ declare const UnknownExceptionSchema: z.ZodObject<{
894
1020
  isImmediatelyAvailable: false;
895
1021
  code?: string | number | undefined;
896
1022
  provider?: RecognitionProvider | undefined;
897
- description?: string | undefined;
898
1023
  audioUtteranceId?: string | undefined;
899
1024
  timestamp?: number | undefined;
1025
+ description?: string | undefined;
900
1026
  stack?: string | undefined;
901
1027
  context?: Record<string, unknown> | undefined;
902
1028
  }>;
@@ -909,9 +1035,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
909
1035
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
910
1036
  message: z.ZodString;
911
1037
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
912
- description: z.ZodOptional<z.ZodString>;
913
1038
  audioUtteranceId: z.ZodOptional<z.ZodString>;
914
1039
  timestamp: z.ZodOptional<z.ZodNumber>;
1040
+ description: z.ZodOptional<z.ZodString>;
915
1041
  errorType: z.ZodLiteral<ErrorTypeV1.AUTHENTICATION_ERROR>;
916
1042
  isImmediatelyAvailable: z.ZodLiteral<false>;
917
1043
  service: z.ZodOptional<z.ZodString>;
@@ -922,9 +1048,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
922
1048
  isImmediatelyAvailable: false;
923
1049
  code?: string | number | undefined;
924
1050
  provider?: RecognitionProvider | undefined;
925
- description?: string | undefined;
926
1051
  audioUtteranceId?: string | undefined;
927
1052
  timestamp?: number | undefined;
1053
+ description?: string | undefined;
928
1054
  service?: string | undefined;
929
1055
  authMethod?: string | undefined;
930
1056
  }, {
@@ -933,18 +1059,18 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
933
1059
  isImmediatelyAvailable: false;
934
1060
  code?: string | number | undefined;
935
1061
  provider?: RecognitionProvider | undefined;
936
- description?: string | undefined;
937
1062
  audioUtteranceId?: string | undefined;
938
1063
  timestamp?: number | undefined;
1064
+ description?: string | undefined;
939
1065
  service?: string | undefined;
940
1066
  authMethod?: string | undefined;
941
1067
  }>, z.ZodObject<{
942
1068
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
943
1069
  message: z.ZodString;
944
1070
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
945
- description: z.ZodOptional<z.ZodString>;
946
1071
  audioUtteranceId: z.ZodOptional<z.ZodString>;
947
1072
  timestamp: z.ZodOptional<z.ZodNumber>;
1073
+ description: z.ZodOptional<z.ZodString>;
948
1074
  errorType: z.ZodLiteral<ErrorTypeV1.VALIDATION_ERROR>;
949
1075
  isImmediatelyAvailable: z.ZodLiteral<true>;
950
1076
  field: z.ZodOptional<z.ZodString>;
@@ -956,9 +1082,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
956
1082
  isImmediatelyAvailable: true;
957
1083
  code?: string | number | undefined;
958
1084
  provider?: RecognitionProvider | undefined;
959
- description?: string | undefined;
960
1085
  audioUtteranceId?: string | undefined;
961
1086
  timestamp?: number | undefined;
1087
+ description?: string | undefined;
962
1088
  field?: string | undefined;
963
1089
  expected?: string | undefined;
964
1090
  received?: string | undefined;
@@ -968,18 +1094,18 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
968
1094
  isImmediatelyAvailable: true;
969
1095
  code?: string | number | undefined;
970
1096
  provider?: RecognitionProvider | undefined;
971
- description?: string | undefined;
972
1097
  audioUtteranceId?: string | undefined;
973
1098
  timestamp?: number | undefined;
1099
+ description?: string | undefined;
974
1100
  field?: string | undefined;
975
1101
  expected?: string | undefined;
976
1102
  received?: string | undefined;
977
1103
  }>, z.ZodObject<{
978
1104
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
979
1105
  message: z.ZodString;
980
- description: z.ZodOptional<z.ZodString>;
981
1106
  audioUtteranceId: z.ZodOptional<z.ZodString>;
982
1107
  timestamp: z.ZodOptional<z.ZodNumber>;
1108
+ description: z.ZodOptional<z.ZodString>;
983
1109
  errorType: z.ZodLiteral<ErrorTypeV1.PROVIDER_ERROR>;
984
1110
  isImmediatelyAvailable: z.ZodLiteral<false>;
985
1111
  provider: z.ZodOptional<z.ZodString>;
@@ -990,9 +1116,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
990
1116
  errorType: ErrorTypeV1.PROVIDER_ERROR;
991
1117
  isImmediatelyAvailable: false;
992
1118
  code?: string | number | undefined;
993
- description?: string | undefined;
994
1119
  audioUtteranceId?: string | undefined;
995
1120
  timestamp?: number | undefined;
1121
+ description?: string | undefined;
996
1122
  provider?: string | undefined;
997
1123
  providerErrorCode?: string | number | undefined;
998
1124
  isTransient?: boolean | undefined;
@@ -1001,9 +1127,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1001
1127
  errorType: ErrorTypeV1.PROVIDER_ERROR;
1002
1128
  isImmediatelyAvailable: false;
1003
1129
  code?: string | number | undefined;
1004
- description?: string | undefined;
1005
1130
  audioUtteranceId?: string | undefined;
1006
1131
  timestamp?: number | undefined;
1132
+ description?: string | undefined;
1007
1133
  provider?: string | undefined;
1008
1134
  providerErrorCode?: string | number | undefined;
1009
1135
  isTransient?: boolean | undefined;
@@ -1011,9 +1137,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1011
1137
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
1012
1138
  message: z.ZodString;
1013
1139
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
1014
- description: z.ZodOptional<z.ZodString>;
1015
1140
  audioUtteranceId: z.ZodOptional<z.ZodString>;
1016
1141
  timestamp: z.ZodOptional<z.ZodNumber>;
1142
+ description: z.ZodOptional<z.ZodString>;
1017
1143
  errorType: z.ZodLiteral<ErrorTypeV1.TIMEOUT_ERROR>;
1018
1144
  isImmediatelyAvailable: z.ZodLiteral<true>;
1019
1145
  timeoutMs: z.ZodOptional<z.ZodNumber>;
@@ -1024,9 +1150,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1024
1150
  isImmediatelyAvailable: true;
1025
1151
  code?: string | number | undefined;
1026
1152
  provider?: RecognitionProvider | undefined;
1027
- description?: string | undefined;
1028
1153
  audioUtteranceId?: string | undefined;
1029
1154
  timestamp?: number | undefined;
1155
+ description?: string | undefined;
1030
1156
  timeoutMs?: number | undefined;
1031
1157
  operation?: string | undefined;
1032
1158
  }, {
@@ -1035,18 +1161,18 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1035
1161
  isImmediatelyAvailable: true;
1036
1162
  code?: string | number | undefined;
1037
1163
  provider?: RecognitionProvider | undefined;
1038
- description?: string | undefined;
1039
1164
  audioUtteranceId?: string | undefined;
1040
1165
  timestamp?: number | undefined;
1166
+ description?: string | undefined;
1041
1167
  timeoutMs?: number | undefined;
1042
1168
  operation?: string | undefined;
1043
1169
  }>, z.ZodObject<{
1044
1170
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
1045
1171
  message: z.ZodString;
1046
1172
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
1047
- description: z.ZodOptional<z.ZodString>;
1048
1173
  audioUtteranceId: z.ZodOptional<z.ZodString>;
1049
1174
  timestamp: z.ZodOptional<z.ZodNumber>;
1175
+ description: z.ZodOptional<z.ZodString>;
1050
1176
  errorType: z.ZodLiteral<ErrorTypeV1.QUOTA_EXCEEDED>;
1051
1177
  isImmediatelyAvailable: z.ZodLiteral<true>;
1052
1178
  quotaType: z.ZodOptional<z.ZodString>;
@@ -1058,9 +1184,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1058
1184
  isImmediatelyAvailable: true;
1059
1185
  code?: string | number | undefined;
1060
1186
  provider?: RecognitionProvider | undefined;
1061
- description?: string | undefined;
1062
1187
  audioUtteranceId?: string | undefined;
1063
1188
  timestamp?: number | undefined;
1189
+ description?: string | undefined;
1064
1190
  quotaType?: string | undefined;
1065
1191
  resetAt?: number | undefined;
1066
1192
  retryAfterSeconds?: number | undefined;
@@ -1070,9 +1196,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1070
1196
  isImmediatelyAvailable: true;
1071
1197
  code?: string | number | undefined;
1072
1198
  provider?: RecognitionProvider | undefined;
1073
- description?: string | undefined;
1074
1199
  audioUtteranceId?: string | undefined;
1075
1200
  timestamp?: number | undefined;
1201
+ description?: string | undefined;
1076
1202
  quotaType?: string | undefined;
1077
1203
  resetAt?: number | undefined;
1078
1204
  retryAfterSeconds?: number | undefined;
@@ -1080,9 +1206,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1080
1206
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
1081
1207
  message: z.ZodString;
1082
1208
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
1083
- description: z.ZodOptional<z.ZodString>;
1084
1209
  audioUtteranceId: z.ZodOptional<z.ZodString>;
1085
1210
  timestamp: z.ZodOptional<z.ZodNumber>;
1211
+ description: z.ZodOptional<z.ZodString>;
1086
1212
  errorType: z.ZodLiteral<ErrorTypeV1.CONNECTION_ERROR>;
1087
1213
  isImmediatelyAvailable: z.ZodLiteral<true>;
1088
1214
  attempts: z.ZodOptional<z.ZodNumber>;
@@ -1094,9 +1220,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1094
1220
  isImmediatelyAvailable: true;
1095
1221
  code?: string | number | undefined;
1096
1222
  provider?: RecognitionProvider | undefined;
1097
- description?: string | undefined;
1098
1223
  audioUtteranceId?: string | undefined;
1099
1224
  timestamp?: number | undefined;
1225
+ description?: string | undefined;
1100
1226
  attempts?: number | undefined;
1101
1227
  url?: string | undefined;
1102
1228
  underlyingError?: string | undefined;
@@ -1106,18 +1232,18 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1106
1232
  isImmediatelyAvailable: true;
1107
1233
  code?: string | number | undefined;
1108
1234
  provider?: RecognitionProvider | undefined;
1109
- description?: string | undefined;
1110
1235
  audioUtteranceId?: string | undefined;
1111
1236
  timestamp?: number | undefined;
1237
+ description?: string | undefined;
1112
1238
  attempts?: number | undefined;
1113
1239
  url?: string | undefined;
1114
1240
  underlyingError?: string | undefined;
1115
1241
  }>, z.ZodObject<{
1116
1242
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
1117
1243
  message: z.ZodString;
1118
- description: z.ZodOptional<z.ZodString>;
1119
1244
  audioUtteranceId: z.ZodOptional<z.ZodString>;
1120
1245
  timestamp: z.ZodOptional<z.ZodNumber>;
1246
+ description: z.ZodOptional<z.ZodString>;
1121
1247
  errorType: z.ZodLiteral<ErrorTypeV1.CIRCUIT_BREAKER_OPEN>;
1122
1248
  isImmediatelyAvailable: z.ZodLiteral<true>;
1123
1249
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
@@ -1127,9 +1253,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1127
1253
  errorType: ErrorTypeV1.CIRCUIT_BREAKER_OPEN;
1128
1254
  isImmediatelyAvailable: true;
1129
1255
  code?: string | number | undefined;
1130
- description?: string | undefined;
1131
1256
  audioUtteranceId?: string | undefined;
1132
1257
  timestamp?: number | undefined;
1258
+ description?: string | undefined;
1133
1259
  provider?: RecognitionProvider | undefined;
1134
1260
  model?: string | undefined;
1135
1261
  }, {
@@ -1137,18 +1263,18 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1137
1263
  errorType: ErrorTypeV1.CIRCUIT_BREAKER_OPEN;
1138
1264
  isImmediatelyAvailable: true;
1139
1265
  code?: string | number | undefined;
1140
- description?: string | undefined;
1141
1266
  audioUtteranceId?: string | undefined;
1142
1267
  timestamp?: number | undefined;
1268
+ description?: string | undefined;
1143
1269
  provider?: RecognitionProvider | undefined;
1144
1270
  model?: string | undefined;
1145
1271
  }>, z.ZodObject<{
1146
1272
  code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
1147
1273
  message: z.ZodString;
1148
1274
  provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
1149
- description: z.ZodOptional<z.ZodString>;
1150
1275
  audioUtteranceId: z.ZodOptional<z.ZodString>;
1151
1276
  timestamp: z.ZodOptional<z.ZodNumber>;
1277
+ description: z.ZodOptional<z.ZodString>;
1152
1278
  errorType: z.ZodLiteral<ErrorTypeV1.UNKNOWN_ERROR>;
1153
1279
  isImmediatelyAvailable: z.ZodLiteral<false>;
1154
1280
  stack: z.ZodOptional<z.ZodString>;
@@ -1159,9 +1285,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1159
1285
  isImmediatelyAvailable: false;
1160
1286
  code?: string | number | undefined;
1161
1287
  provider?: RecognitionProvider | undefined;
1162
- description?: string | undefined;
1163
1288
  audioUtteranceId?: string | undefined;
1164
1289
  timestamp?: number | undefined;
1290
+ description?: string | undefined;
1165
1291
  stack?: string | undefined;
1166
1292
  context?: Record<string, unknown> | undefined;
1167
1293
  }, {
@@ -1170,9 +1296,9 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
1170
1296
  isImmediatelyAvailable: false;
1171
1297
  code?: string | number | undefined;
1172
1298
  provider?: RecognitionProvider | undefined;
1173
- description?: string | undefined;
1174
1299
  audioUtteranceId?: string | undefined;
1175
1300
  timestamp?: number | undefined;
1301
+ description?: string | undefined;
1176
1302
  stack?: string | undefined;
1177
1303
  context?: Record<string, unknown> | undefined;
1178
1304
  }>]>;
@@ -1298,6 +1424,8 @@ declare const ASRRequestSchemaV1: z.ZodObject<{
1298
1424
  prefixMode: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof PrefixMode>>>;
1299
1425
  prefixId: z.ZodOptional<z.ZodString>;
1300
1426
  prefixTextToRemove: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
1427
+ audioMetricsIntervalMs: z.ZodOptional<z.ZodNumber>;
1428
+ appendSearch: z.ZodOptional<z.ZodBoolean>;
1301
1429
  debugCommand: z.ZodOptional<z.ZodObject<{
1302
1430
  enableDebugLog: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
1303
1431
  enableAudioStorage: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
@@ -1339,6 +1467,8 @@ declare const ASRRequestSchemaV1: z.ZodObject<{
1339
1467
  }[] | undefined;
1340
1468
  prefixId?: string | undefined;
1341
1469
  prefixTextToRemove?: string[] | undefined;
1470
+ audioMetricsIntervalMs?: number | undefined;
1471
+ appendSearch?: boolean | undefined;
1342
1472
  debugCommand?: {
1343
1473
  enableDebugLog: boolean;
1344
1474
  enableAudioStorage: boolean;
@@ -1370,6 +1500,8 @@ declare const ASRRequestSchemaV1: z.ZodObject<{
1370
1500
  prefixMode?: PrefixMode | undefined;
1371
1501
  prefixId?: string | undefined;
1372
1502
  prefixTextToRemove?: string[] | undefined;
1503
+ audioMetricsIntervalMs?: number | undefined;
1504
+ appendSearch?: boolean | undefined;
1373
1505
  debugCommand?: {
1374
1506
  enableDebugLog?: boolean | undefined;
1375
1507
  enableAudioStorage?: boolean | undefined;
@@ -1590,6 +1722,40 @@ interface ASRRequestConfig {
1590
1722
  * ```
1591
1723
  */
1592
1724
  providerOptions?: Record<string, any>;
1725
+ /**
1726
+ * Streaming audio metrics opt-in interval (ms).
1727
+ *
1728
+ * When set to a positive number, server forwards AudioMetrics results to the
1729
+ * client over the WebSocket, throttled so at most one result is sent per
1730
+ * `audioMetricsIntervalMs`. Undefined / 0 disables streaming audio metrics
1731
+ * (final metrics still embedded in the Metadata result).
1732
+ *
1733
+ * @example 500
1734
+ */
1735
+ audioMetricsIntervalMs?: number;
1736
+ /**
1737
+ * Opt-in: round-trip Deepgram `search` phrase hits into the transcript.
1738
+ *
1739
+ * When `true` AND the resolved provider/model is **deepgram nova-2** AND the
1740
+ * GameContext `gamePhase` is `'Solve Puzzle'`, every Deepgram Results event
1741
+ * with a `channel.search` hit at confidence ≥ 0.6 has the original query
1742
+ * prepended to the transcript text delivered to the client. This restores
1743
+ * parity with the legacy Roku→Deepgram WoF Puzzle-Solve path where the
1744
+ * phrase round-trip lets downstream NLU match multi-word puzzle solutions
1745
+ * even when nova-2's primary transcription drifts.
1746
+ *
1747
+ * Default: `false` (no prepend; transcript is whatever nova-2 produces).
1748
+ *
1749
+ * Scope guard rationale:
1750
+ * - nova-2 only: nova-3 / flux do not need this (they handle phrase
1751
+ * spotting differently and the prepend would only add noise).
1752
+ * - Solve-Puzzle scene only: other WoF scenes (Letter-Guess,
1753
+ * Bonus-Round, etc.) do NOT want the slotMap phrase prepended — only
1754
+ * Puzzle-Solve depends on the phrase round-trip.
1755
+ *
1756
+ * @default false
1757
+ */
1758
+ appendSearch?: boolean;
1593
1759
  /**
1594
1760
  * Optional fallback ASR configurations
1595
1761
  *
@@ -1650,7 +1816,10 @@ declare enum GeminiModel {
1650
1816
  }
1651
1817
 
1652
1818
  /**
1653
- * OpenAI Model Types
1819
+ * OpenAI Batch API Model Types (HTTP API)
1820
+ * @see https://platform.openai.com/docs/guides/speech-to-text
1821
+ *
1822
+ * Note: For openai-realtime provider models, see OpenAIRealtimeModel in provider.types.ts
1654
1823
  */
1655
1824
  declare enum OpenAIModel {
1656
1825
  WHISPER_1 = "whisper-1"
@@ -1926,6 +2095,12 @@ interface IRecognitionClientConfig {
1926
2095
  onFunctionCall?: (result: FunctionCallResultV1) => void;
1927
2096
  /** Callback when metadata is received. Only once after transcription is complete.*/
1928
2097
  onMetadata?: (metadata: MetadataResultV1) => void;
2098
+ /**
2099
+ * Callback when streaming audio metrics arrive (volume, silence ratio, clipping, SNR, etc.).
2100
+ * Only fires when `asrRequestConfig.audioMetricsIntervalMs > 0`.
2101
+ * Final metrics still arrive embedded in `onMetadata.audioMetrics`.
2102
+ */
2103
+ onAudioMetrics?: (metrics: AudioMetricsResultV1) => void;
1929
2104
  /** Callback when session is configured with actual ASR provider/model (optional) */
1930
2105
  onSessionConfigured?: (config: SessionConfiguredV1) => void;
1931
2106
  /** Callback when error occurs */
@@ -2375,6 +2550,11 @@ declare class ConfigBuilder {
2375
2550
  * Set session configured callback (optional)
2376
2551
  */
2377
2552
  onSessionConfigured(callback: (config: SessionConfiguredV1) => void): this;
2553
+ /**
2554
+ * Set streaming audio metrics callback (optional).
2555
+ * Only fires when `asrRequestConfig.audioMetricsIntervalMs > 0`.
2556
+ */
2557
+ onAudioMetrics(callback: (metrics: AudioMetricsResultV1) => void): this;
2378
2558
  /**
2379
2559
  * Set error callback
2380
2560
  */
@@ -2837,5 +3017,5 @@ declare function getRecognitionConductorHttpBase(stage?: Stage | string | null |
2837
3017
  declare function getRecognitionConductorWsBase(stage?: Stage | string | null | undefined): string;
2838
3018
  declare function getRecognitionConductorHost(stage?: Stage | string | null | undefined): string;
2839
3019
 
2840
- export { AudioEncoding, BedrockModel, CartesiaModel, ClientControlActionV1, ClientState, ConfigBuilder, ConnectionError, ControlSignalTypeV1 as ControlSignal, ControlSignalTypeV1, DashScopeModel, DeepgramModel, ElevenLabsModel, ErrorTypeV1, FinalTranscriptStability, FireworksModel, GeminiModel, GladiaModel, GoogleModel, Language, MistralVoxtralModel, OpenAIModel, OpenAIRealtimeModel, RECOGNITION_CONDUCTOR_BASES, RECOGNITION_SERVICE_BASES, RealTimeTwoWayWebSocketRecognitionClient, RecognitionContextTypeV1, RecognitionError, RecognitionProvider, RecognitionResultTypeV1, RecognitionVGFStateSchema, RecordingStatus, STAGES, SampleRate, SelfServeVllmModel, SimplifiedVGFRecognitionClient, TimeoutError, TranscriptionStatus, ValidationError, createClient, createClientWithBuilder, createDefaultASRConfig, createInitialRecognitionState, createSimplifiedVGFClient, getRecognitionConductorBase, getRecognitionConductorHost, getRecognitionConductorHttpBase, getRecognitionConductorWsBase, getRecognitionServiceBase, getRecognitionServiceHost, getRecognitionServiceHttpBase, getRecognitionServiceWsBase, getUserFriendlyMessage, isExceptionImmediatelyAvailable, isNormalDisconnection, isValidRecordingStatusTransition, normalizeStage, resetRecognitionVGFState };
2841
- export type { ASRRequestConfig, ASRRequestV1, AuthenticationException, ConnectionException, ErrorResultV1, FunctionCallResultV1, GameContextV1, IRecognitionClient, IRecognitionClientConfig, IRecognitionClientStats, ISimplifiedVGFRecognitionClient, MetadataResultV1, ProviderException, QuotaExceededException, RealTimeTwoWayWebSocketRecognitionClientConfig, RecognitionCallbackUrl, RecognitionException, RecognitionState, RecordingStatusType, SimplifiedVGFClientConfig, SlotMap, Stage, TimeoutException, TranscriptionResult, TranscriptionResultV1, TranscriptionStatusType, UnknownException, ValidationException };
3020
+ export { AmazonNovaSonicModel, AudioEncoding, AwsTranscribeModel, BedrockModel, CartesiaModel, ClientControlActionV1, ClientState, ConfigBuilder, ConnectionError, ControlSignalTypeV1 as ControlSignal, ControlSignalTypeV1, DashScopeModel, DeepgramModel, ElevenLabsModel, ErrorTypeV1, FinalTranscriptStability, FireworksModel, GeminiModel, GladiaModel, GoogleModel, Language, MistralVoxtralModel, OpenAIModel, OpenAIRealtimeModel, RECOGNITION_CONDUCTOR_BASES, RECOGNITION_SERVICE_BASES, RealTimeTwoWayWebSocketRecognitionClient, RecognitionContextTypeV1, RecognitionError, RecognitionProvider, RecognitionResultTypeV1, RecognitionVGFStateSchema, RecordingStatus, STAGES, SampleRate, SelfServeVllmModel, SimplifiedVGFRecognitionClient, TimeoutError, TranscriptionStatus, ValidationError, createClient, createClientWithBuilder, createDefaultASRConfig, createInitialRecognitionState, createSimplifiedVGFClient, getRecognitionConductorBase, getRecognitionConductorHost, getRecognitionConductorHttpBase, getRecognitionConductorWsBase, getRecognitionServiceBase, getRecognitionServiceHost, getRecognitionServiceHttpBase, getRecognitionServiceWsBase, getUserFriendlyMessage, isExceptionImmediatelyAvailable, isNormalDisconnection, isValidRecordingStatusTransition, normalizeStage, resetRecognitionVGFState };
3021
+ export type { ASRRequestConfig, ASRRequestV1, AudioMetricsResultV1, AuthenticationException, ConnectionException, ErrorResultV1, FunctionCallResultV1, GameContextV1, IRecognitionClient, IRecognitionClientConfig, IRecognitionClientStats, ISimplifiedVGFRecognitionClient, MetadataResultV1, ProviderException, QuotaExceededException, RealTimeTwoWayWebSocketRecognitionClientConfig, RecognitionCallbackUrl, RecognitionException, RecognitionState, RecordingStatusType, SimplifiedVGFClientConfig, SlotMap, Stage, TimeoutException, TranscriptionResult, TranscriptionResultV1, TranscriptionStatusType, UnknownException, ValidationException };