Skip to content

Commit 494b382

Browse files
committed
update README
1 parent f873f62 commit 494b382

4 files changed

Lines changed: 130 additions & 0 deletions

File tree

sdk/cpp/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,35 @@ audio.TranscribeAudioStreaming(R"(C:\path\to\audio.wav)", [](const AudioCreateTr
278278
});
279279
```
280280
281+
#### Multilingual Language Codes
282+
283+
When using a multilingual ASR model (e.g. `nvidia-nemotron-3.5-asr-streaming-multilingual-0.6b`), set the language to a BCP-47 language code to hint the expected language.
284+
285+
| Code | Language | Code | Language |
286+
|------|----------|------|----------|
287+
| `en-US` | English (US) | `en-GB` | English (UK) |
288+
| `zh-CN` | Chinese (Simplified) | `ja-JP` | Japanese |
289+
| `ko-KR` | Korean | `de-DE` | German |
290+
| `fr-FR` | French | `fr-CA` | French (Canada) |
291+
| `es-ES` | Spanish (Spain) | `es-US` | Spanish (US) |
292+
| `it-IT` | Italian | `pt-BR` | Portuguese (Brazil) |
293+
| `pt-PT` | Portuguese (Portugal) | `ru-RU` | Russian |
294+
| `ar-AR` | Arabic | `hi-IN` | Hindi |
295+
| `nl-NL` | Dutch | `pl-PL` | Polish |
296+
| `sv-SE` | Swedish | `da-DK` | Danish |
297+
| `fi-FI` | Finnish | `cs-CZ` | Czech |
298+
| `ro-RO` | Romanian | `hu-HU` | Hungarian |
299+
| `sk-SK` | Slovak | `bg-BG` | Bulgarian |
300+
| `el-GR` | Greek | `et-EE` | Estonian |
301+
| `hr-HR` | Croatian | `lt-LT` | Lithuanian |
302+
| `lv-LV` | Latvian | `sl-SL` | Slovenian |
303+
| `uk-UA` | Ukrainian | `he-IL` | Hebrew |
304+
| `nb-NO` | Norwegian (Bokmål) | `nn-NO` | Norwegian (Nynorsk) |
305+
| `th-TH` | Thai | `tr-TR` | Turkish |
306+
| `vi-VN` | Vietnamese | `auto` | Auto-detect |
307+
308+
Use `"auto"` to let the model detect the spoken language automatically.
309+
281310
### Tool Calling
282311
283312
See `sample/main.cpp` (Example 5) for a full tool-calling walkthrough.

sdk/cs/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,41 @@ audioClient.Settings.Language = "en";
300300
audioClient.Settings.Temperature = 0.0f;
301301
```
302302

303+
#### Multilingual Language Codes
304+
305+
When using a multilingual ASR model (e.g. `nvidia-nemotron-3.5-asr-streaming-multilingual-0.6b`), set `Language` to a BCP-47 language code to hint the expected language. This applies to both `OpenAIAudioClient.Settings.Language` and `LiveAudioTranscriptionSession.Settings.Language`.
306+
307+
| Code | Language | Code | Language |
308+
|------|----------|------|----------|
309+
| `en-US` | English (US) | `en-GB` | English (UK) |
310+
| `zh-CN` | Chinese (Simplified) | `ja-JP` | Japanese |
311+
| `ko-KR` | Korean | `de-DE` | German |
312+
| `fr-FR` | French | `fr-CA` | French (Canada) |
313+
| `es-ES` | Spanish (Spain) | `es-US` | Spanish (US) |
314+
| `it-IT` | Italian | `pt-BR` | Portuguese (Brazil) |
315+
| `pt-PT` | Portuguese (Portugal) | `ru-RU` | Russian |
316+
| `ar-AR` | Arabic | `hi-IN` | Hindi |
317+
| `nl-NL` | Dutch | `pl-PL` | Polish |
318+
| `sv-SE` | Swedish | `da-DK` | Danish |
319+
| `fi-FI` | Finnish | `cs-CZ` | Czech |
320+
| `ro-RO` | Romanian | `hu-HU` | Hungarian |
321+
| `sk-SK` | Slovak | `bg-BG` | Bulgarian |
322+
| `el-GR` | Greek | `et-EE` | Estonian |
323+
| `hr-HR` | Croatian | `lt-LT` | Lithuanian |
324+
| `lv-LV` | Latvian | `sl-SL` | Slovenian |
325+
| `uk-UA` | Ukrainian | `he-IL` | Hebrew |
326+
| `nb-NO` | Norwegian (Bokmål) | `nn-NO` | Norwegian (Nynorsk) |
327+
| `th-TH` | Thai | `tr-TR` | Turkish |
328+
| `vi-VN` | Vietnamese | `auto` | Auto-detect |
329+
330+
Use `"auto"` to let the model detect the spoken language automatically.
331+
332+
```csharp
333+
// Multilingual example
334+
audioClient.Settings.Language = "zh-CN"; // Chinese
335+
session.Settings.Language = "auto"; // Auto-detect
336+
```
337+
303338
### Live Audio Transcription (Real-Time Streaming)
304339

305340
For real-time microphone-to-text transcription, use `CreateLiveTranscriptionSession()`. Audio is pushed as raw PCM chunks and transcription results stream back as an `IAsyncEnumerable`.

sdk/js/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,39 @@ for await (const chunk of audioClient.transcribeStreaming('/path/to/audio.wav'))
265265
}
266266
```
267267

268+
#### Multilingual Language Codes
269+
270+
When using a multilingual ASR model (e.g. `nvidia-nemotron-3.5-asr-streaming-multilingual-0.6b`), set `language` to a BCP-47 language code to hint the expected language.
271+
272+
| Code | Language | Code | Language |
273+
|------|----------|------|----------|
274+
| `en-US` | English (US) | `en-GB` | English (UK) |
275+
| `zh-CN` | Chinese (Simplified) | `ja-JP` | Japanese |
276+
| `ko-KR` | Korean | `de-DE` | German |
277+
| `fr-FR` | French | `fr-CA` | French (Canada) |
278+
| `es-ES` | Spanish (Spain) | `es-US` | Spanish (US) |
279+
| `it-IT` | Italian | `pt-BR` | Portuguese (Brazil) |
280+
| `pt-PT` | Portuguese (Portugal) | `ru-RU` | Russian |
281+
| `ar-AR` | Arabic | `hi-IN` | Hindi |
282+
| `nl-NL` | Dutch | `pl-PL` | Polish |
283+
| `sv-SE` | Swedish | `da-DK` | Danish |
284+
| `fi-FI` | Finnish | `cs-CZ` | Czech |
285+
| `ro-RO` | Romanian | `hu-HU` | Hungarian |
286+
| `sk-SK` | Slovak | `bg-BG` | Bulgarian |
287+
| `el-GR` | Greek | `et-EE` | Estonian |
288+
| `hr-HR` | Croatian | `lt-LT` | Lithuanian |
289+
| `lv-LV` | Latvian | `sl-SL` | Slovenian |
290+
| `uk-UA` | Ukrainian | `he-IL` | Hebrew |
291+
| `nb-NO` | Norwegian (Bokmål) | `nn-NO` | Norwegian (Nynorsk) |
292+
| `th-TH` | Thai | `tr-TR` | Turkish |
293+
| `vi-VN` | Vietnamese | `auto` | Auto-detect |
294+
295+
```typescript
296+
// Multilingual example
297+
audioClient.settings.language = 'zh-CN'; // Chinese
298+
audioClient.settings.language = 'auto'; // Auto-detect
299+
```
300+
268301
### Embedded Web Service
269302

270303
Start a local HTTP server that exposes an OpenAI-compatible API:

sdk/rust/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,39 @@ while let Some(chunk) = stream.next().await {
441441
}
442442
```
443443

444+
#### Multilingual Language Codes
445+
446+
When using a multilingual ASR model (e.g. `nvidia-nemotron-3.5-asr-streaming-multilingual-0.6b`), set `language` to a BCP-47 language code to hint the expected language.
447+
448+
| Code | Language | Code | Language |
449+
|------|----------|------|----------|
450+
| `en-US` | English (US) | `en-GB` | English (UK) |
451+
| `zh-CN` | Chinese (Simplified) | `ja-JP` | Japanese |
452+
| `ko-KR` | Korean | `de-DE` | German |
453+
| `fr-FR` | French | `fr-CA` | French (Canada) |
454+
| `es-ES` | Spanish (Spain) | `es-US` | Spanish (US) |
455+
| `it-IT` | Italian | `pt-BR` | Portuguese (Brazil) |
456+
| `pt-PT` | Portuguese (Portugal) | `ru-RU` | Russian |
457+
| `ar-AR` | Arabic | `hi-IN` | Hindi |
458+
| `nl-NL` | Dutch | `pl-PL` | Polish |
459+
| `sv-SE` | Swedish | `da-DK` | Danish |
460+
| `fi-FI` | Finnish | `cs-CZ` | Czech |
461+
| `ro-RO` | Romanian | `hu-HU` | Hungarian |
462+
| `sk-SK` | Slovak | `bg-BG` | Bulgarian |
463+
| `el-GR` | Greek | `et-EE` | Estonian |
464+
| `hr-HR` | Croatian | `lt-LT` | Lithuanian |
465+
| `lv-LV` | Latvian | `sl-SL` | Slovenian |
466+
| `uk-UA` | Ukrainian | `he-IL` | Hebrew |
467+
| `nb-NO` | Norwegian (Bokmål) | `nn-NO` | Norwegian (Nynorsk) |
468+
| `th-TH` | Thai | `tr-TR` | Turkish |
469+
| `vi-VN` | Vietnamese | `auto` | Auto-detect |
470+
471+
```rust
472+
// Multilingual example
473+
let audio_client = model.create_audio_client()
474+
.language("zh-CN"); // Chinese
475+
```
476+
444477
### Embedded Web Service
445478

446479
Start a local HTTP server that exposes an OpenAI-compatible REST API:

0 commit comments

Comments
 (0)