@volley/recognition-client-sdk 0.1.670 → 0.1.707
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.
- package/dist/browser.bundled.d.ts +59 -2
- package/dist/config-builder.d.ts +14 -1
- package/dist/config-builder.d.ts.map +1 -1
- package/dist/index.bundled.d.ts +118 -48
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +66 -4
- package/dist/index.js.map +3 -3
- package/dist/recog-client-sdk.browser.js +43 -4
- package/dist/recog-client-sdk.browser.js.map +3 -3
- package/dist/recognition-client.d.ts.map +1 -1
- package/dist/recognition-client.types.d.ts +7 -1
- package/dist/recognition-client.types.d.ts.map +1 -1
- package/dist/utils/message-handler.d.ts +2 -1
- package/dist/utils/message-handler.d.ts.map +1 -1
- package/dist/utils/url-builder.d.ts +4 -0
- package/dist/utils/url-builder.d.ts.map +1 -1
- package/package.json +3 -3
- package/src/config-builder.ts +26 -0
- package/src/index.ts +1 -0
- package/src/recognition-client.ts +7 -1
- package/src/recognition-client.types.ts +10 -0
- package/src/utils/message-handler.ts +7 -1
- package/src/utils/url-builder.ts +14 -0
|
@@ -21,6 +21,7 @@ declare enum RecognitionProvider {
|
|
|
21
21
|
MISTRAL_VOXTRAL = "mistral-voxtral",
|
|
22
22
|
CARTESIA = "cartesia",
|
|
23
23
|
DASHSCOPE = "dashscope",
|
|
24
|
+
BEDROCK = "bedrock",
|
|
24
25
|
TEST_ASR_PROVIDER_QUOTA = "test-asr-provider-quota",
|
|
25
26
|
TEST_ASR_STREAMING = "test-asr-streaming"
|
|
26
27
|
}
|
|
@@ -119,6 +120,15 @@ declare enum DashScopeModel {
|
|
|
119
120
|
QWEN3_ASR_FLASH_REALTIME_2602 = "qwen3-asr-flash-realtime-2026-02-10",
|
|
120
121
|
QWEN3_ASR_FLASH_REALTIME = "qwen3-asr-flash-realtime"
|
|
121
122
|
}
|
|
123
|
+
/**
|
|
124
|
+
* AWS Bedrock batch transcription models
|
|
125
|
+
* Accessed via AWS Bedrock InvokeModelWithResponseStream
|
|
126
|
+
* @see https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-mistral.html
|
|
127
|
+
*/
|
|
128
|
+
declare enum BedrockModel {
|
|
129
|
+
VOXTRAL_MINI_3B_2507 = "mistral.voxtral-mini-3b-2507",
|
|
130
|
+
VOXTRAL_SMALL_24B_2507 = "mistral.voxtral-small-24b-2507"
|
|
131
|
+
}
|
|
122
132
|
/**
|
|
123
133
|
* Self-serve vLLM batch transcription models
|
|
124
134
|
* Backed by recognition-inference / RunPod `/transcribe`
|
|
@@ -129,7 +139,7 @@ declare enum SelfServeVllmModel {
|
|
|
129
139
|
/**
|
|
130
140
|
* Type alias for any model from any provider
|
|
131
141
|
*/
|
|
132
|
-
type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | SelfServeVllmModel | string;
|
|
142
|
+
type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | SelfServeVllmModel | BedrockModel | string;
|
|
133
143
|
|
|
134
144
|
/**
|
|
135
145
|
* Audio encoding types
|
|
@@ -264,7 +274,8 @@ declare enum RecognitionResultTypeV1 {
|
|
|
264
274
|
METADATA = "Metadata",
|
|
265
275
|
ERROR = "Error",
|
|
266
276
|
CLIENT_CONTROL_MESSAGE = "ClientControlMessage",
|
|
267
|
-
AUDIO_METRICS = "AudioMetrics"
|
|
277
|
+
AUDIO_METRICS = "AudioMetrics",
|
|
278
|
+
SESSION_CONFIGURED = "SessionConfigured"
|
|
268
279
|
}
|
|
269
280
|
/**
|
|
270
281
|
* Transcription result V1 - contains transcript message
|
|
@@ -543,6 +554,46 @@ declare const ErrorResultSchemaV1: z.ZodObject<{
|
|
|
543
554
|
description?: string | undefined;
|
|
544
555
|
}>;
|
|
545
556
|
type ErrorResultV1 = z.infer<typeof ErrorResultSchemaV1>;
|
|
557
|
+
/**
|
|
558
|
+
* Session configured message V1 - sent after ASR provider is selected and configured
|
|
559
|
+
* Fires after circuit breaker checks pass and provider/model are finalized,
|
|
560
|
+
* before audio streaming begins. Contains the actual ASR config that will be used.
|
|
561
|
+
*/
|
|
562
|
+
declare const SessionConfiguredSchemaV1: z.ZodObject<{
|
|
563
|
+
type: z.ZodLiteral<RecognitionResultTypeV1.SESSION_CONFIGURED>;
|
|
564
|
+
audioUtteranceId: z.ZodString;
|
|
565
|
+
provider: z.ZodOptional<z.ZodString>;
|
|
566
|
+
model: z.ZodOptional<z.ZodString>;
|
|
567
|
+
sampleRate: z.ZodOptional<z.ZodNumber>;
|
|
568
|
+
encoding: z.ZodOptional<z.ZodString>;
|
|
569
|
+
apiType: z.ZodOptional<z.ZodNativeEnum<typeof ASRApiType>>;
|
|
570
|
+
isFallback: z.ZodOptional<z.ZodBoolean>;
|
|
571
|
+
asrRequest: z.ZodOptional<z.ZodString>;
|
|
572
|
+
providerConfig: z.ZodOptional<z.ZodString>;
|
|
573
|
+
}, "strip", z.ZodTypeAny, {
|
|
574
|
+
type: RecognitionResultTypeV1.SESSION_CONFIGURED;
|
|
575
|
+
audioUtteranceId: string;
|
|
576
|
+
provider?: string | undefined;
|
|
577
|
+
model?: string | undefined;
|
|
578
|
+
sampleRate?: number | undefined;
|
|
579
|
+
encoding?: string | undefined;
|
|
580
|
+
apiType?: ASRApiType | undefined;
|
|
581
|
+
isFallback?: boolean | undefined;
|
|
582
|
+
asrRequest?: string | undefined;
|
|
583
|
+
providerConfig?: string | undefined;
|
|
584
|
+
}, {
|
|
585
|
+
type: RecognitionResultTypeV1.SESSION_CONFIGURED;
|
|
586
|
+
audioUtteranceId: string;
|
|
587
|
+
provider?: string | undefined;
|
|
588
|
+
model?: string | undefined;
|
|
589
|
+
sampleRate?: number | undefined;
|
|
590
|
+
encoding?: string | undefined;
|
|
591
|
+
apiType?: ASRApiType | undefined;
|
|
592
|
+
isFallback?: boolean | undefined;
|
|
593
|
+
asrRequest?: string | undefined;
|
|
594
|
+
providerConfig?: string | undefined;
|
|
595
|
+
}>;
|
|
596
|
+
type SessionConfiguredV1 = z.infer<typeof SessionConfiguredSchemaV1>;
|
|
546
597
|
|
|
547
598
|
/**
|
|
548
599
|
* Recognition Context Types V1
|
|
@@ -1102,6 +1153,10 @@ interface IRecognitionClientConfig {
|
|
|
1102
1153
|
questionAnswerId?: string;
|
|
1103
1154
|
/** Platform for audio recording device (optional, e.g., 'ios', 'android', 'web', 'unity') */
|
|
1104
1155
|
platform?: string;
|
|
1156
|
+
/** Experiment cohort (optional). Defaults to 'control' if not provided. */
|
|
1157
|
+
experimentCohort?: 'treatment' | 'control';
|
|
1158
|
+
/** Explicit major version for ASR config selection (e.g. 1, 3). Takes precedence over experimentCohort. */
|
|
1159
|
+
experimentMajorVersion?: number;
|
|
1105
1160
|
/** Callback when transcript is received */
|
|
1106
1161
|
onTranscript?: (result: TranscriptionResultV1) => void;
|
|
1107
1162
|
/**
|
|
@@ -1111,6 +1166,8 @@ interface IRecognitionClientConfig {
|
|
|
1111
1166
|
onFunctionCall?: (result: FunctionCallResultV1) => void;
|
|
1112
1167
|
/** Callback when metadata is received. Only once after transcription is complete.*/
|
|
1113
1168
|
onMetadata?: (metadata: MetadataResultV1) => void;
|
|
1169
|
+
/** Callback when session is configured with actual ASR provider/model (optional) */
|
|
1170
|
+
onSessionConfigured?: (config: SessionConfiguredV1) => void;
|
|
1114
1171
|
/** Callback when error occurs */
|
|
1115
1172
|
onError?: (error: ErrorResultV1) => void;
|
|
1116
1173
|
/** Callback when connected to WebSocket */
|
package/dist/config-builder.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Simple builder pattern for RealTimeTwoWayWebSocketRecognitionClientConfig
|
|
5
5
|
*/
|
|
6
6
|
import type { RealTimeTwoWayWebSocketRecognitionClientConfig, RecognitionCallbackUrl } from './recognition-client.types.js';
|
|
7
|
-
import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, ErrorResultV1, Stage } from '@recog/shared-types';
|
|
7
|
+
import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, SessionConfiguredV1, ErrorResultV1, Stage } from '@recog/shared-types';
|
|
8
8
|
/**
|
|
9
9
|
* Builder for RealTimeTwoWayWebSocketRecognitionClientConfig
|
|
10
10
|
*
|
|
@@ -86,6 +86,15 @@ export declare class ConfigBuilder {
|
|
|
86
86
|
* Set platform
|
|
87
87
|
*/
|
|
88
88
|
platform(platform: string): this;
|
|
89
|
+
/**
|
|
90
|
+
* Set experiment cohort (optional, defaults to 'control')
|
|
91
|
+
*/
|
|
92
|
+
experimentCohort(cohort: 'treatment' | 'control'): this;
|
|
93
|
+
/**
|
|
94
|
+
* Set explicit major version for ASR config selection.
|
|
95
|
+
* Takes precedence over experimentCohort-based version resolution.
|
|
96
|
+
*/
|
|
97
|
+
experimentMajorVersion(version: number): this;
|
|
89
98
|
/**
|
|
90
99
|
* Set transcript callback
|
|
91
100
|
*/
|
|
@@ -94,6 +103,10 @@ export declare class ConfigBuilder {
|
|
|
94
103
|
* Set metadata callback
|
|
95
104
|
*/
|
|
96
105
|
onMetadata(callback: (metadata: MetadataResultV1) => void): this;
|
|
106
|
+
/**
|
|
107
|
+
* Set session configured callback (optional)
|
|
108
|
+
*/
|
|
109
|
+
onSessionConfigured(callback: (config: SessionConfiguredV1) => void): this;
|
|
97
110
|
/**
|
|
98
111
|
* Set error callback
|
|
99
112
|
*/
|
|
@@ -1 +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,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,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,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"}
|
|
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"}
|