Skip to content

Commit

Permalink
✨ feat(lt-lt): Update i18n configuration and add LT documentation
Browse files Browse the repository at this point in the history
The i18n configuration is updated to change the default locale from Lithuanian ('lt-LT') to English ('en-US'), and the output locales are adjusted accordingly. Additionally, new Lithuanian documentation files are added for various API references and components within the project.

Changes include:
- Switching the i18n entryLocale to 'en-US' and adjusting outputLocales.
- Updating the modelName in the i18n configuration to 'gpt-4-1106-preview'.
- Adding Lithuanian translation files for API references, components, and documentation to enhance support for Lithuanian language users.
  • Loading branch information
Gincioks committed Mar 24, 2024
1 parent 3585cc9 commit a521451
Show file tree
Hide file tree
Showing 16 changed files with 410 additions and 4 deletions.
7 changes: 3 additions & 4 deletions .i18nrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
module.exports = {
markdown: {
entry: ['docs/**/**'],
entryLocale: 'lt-LT',
entryExtension: '.lt-LT.md',
entryLocale: 'en-US',
exclude: ['changelog.md'],
outputLocales: ['en-US'],
outputLocales: ['lt-LT'],
outputExtensions: (locale, { getDefaultExtension }) => {
if (locale === 'en-US') return '.md';
return getDefaultExtension(locale);
},
},
modelName: 'gpt-3.5-turbo-1106',
modelName: 'gpt-4-1106-preview',
};
91 changes: 91 additions & 0 deletions docs/api-reference/edge-speech-tts.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
group: TTS
title: EdgeSpeechTTS
apiHeader:
pkg: '@arietta-studio/recognition'
---

`EdgeSpeechTTS` yra klasė skirta teksto keitimui į kalbą, remiantis Edge kalbos paslauga.

Ši klasė palaiko teksto keitimą į kalbą ir suteikia metodų rinkinį, skirtą gauti balsų parinktis ir kurti kalbos sintezės užklausas.

```ts
constructor(options: EdgeSpeechAPI): EdgeSpeechTTS
```

## Parametrai

- `options`: Objektas, neprivalomas.
- `serviceUrl`: Eilutė, nurodanti Edge kalbos paslaugos URL. Jei pateikiamas, užklausos bus siunčiamos į šį URL.
- `locale`: Eilutė, nurodanti naudojamą balsų lokalę. Jei pateikiamas, bus naudojamas norint filtruoti galimų balsų sąrašą.

## Pavyzdžiai

```js
// index.js
import { EdgeSpeechTTS } from '@arietta-studio/recognition';
import { Buffer } from 'buffer';
import fs from 'fs';
import path from 'path';

// Sukurti EdgeSpeechTTS egzempliorių
const tts = new EdgeSpeechTTS({ locale: 'en-US' });

// Sukurti kalbos sintezės užklausos duomenis
const payload = {
input: 'This is a speech demonstration',
options: {
voice: 'en-US-GuyNeural',
},
};

const speechFile = path.resolve('./speech.mp3');

// Iškviesti create metodą kalbos sintezei atlikti
const response = await tts.create(payload);
const mp3Buffer = Buffer.from(await response.arrayBuffer());

fs.writeFileSync(speechFile, mp3Buffer);
```

Paleisti naudojant Bun:

```shell
$ bun index.js
```

Paleisti Node.js aplinkoje:

Kadangi Node.js aplinkoje trūksta `WebSocket` egzemplioriaus, reikia jį polifiliuoti. Tai galima padaryti importuojant ws paketą.

```js
// Importuoti failo viršuje
import WebSocket from 'ws';

global.WebSocket = WebSocket;
```

## Statinės Savybės

- `localeOptions`: Gauti visus palaikomus balsų lokalės parinktis.
- `voiceList`: Visų galimų balsų sąrašas.
- `voiceName`: Objektas, turintis visus balsų pavadinimus.
- `createRequest`: Statinis metodas, naudojamas kalbos sintezės užklausoms kurti.

## Metodai

### `voiceOptions`

Gauti dabartinio egzemplioriaus balsų parinktis, remiantis per instanciją nurodyta `locale`. Grąžina objektą, turintį šiuo metu galimas balsų parinktis.

### `createAudio(payload: EdgeSpeechPayload): Promise<AudioBuffer>`

Sukurti kalbos sintezę naudojant pateiktą užklausos duomenis.

#### Parametrai

- `payload`: `EdgeSpeechPayload` tipo, turintis būtiną informaciją kalbos sintezės užklausai.

#### Grąžinamoji Vertė

Grąžina `Promise`, kuris išsprendžiamas į `AudioBuffer` objektą, turintį sintezuoto garso duomenis.
14 changes: 14 additions & 0 deletions docs/api-reference/index.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: API Nuoroda
nav:
title: API
order: 10
---

# API Nuorodos Vadovas

## TTS (teksto į kalbą)

- [EdgeSpeechTTS](./edge-speech-tts.lt-LT.md)
- [MicrosoftSpeechTTS](microsoft-speech-tts.lt-LT.md)
- [OpenaiTTS](openai-tts.lt-LT.md)
103 changes: 103 additions & 0 deletions docs/api-reference/microsoft-speech-tts.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
group: TTS
title: MicrosoftSpeechTTS
apiHeader:
pkg: '@arietta-studio/recognition'
---

`MicrosoftSpeechTTS` yra klasė tekstui versti į kalbą naudojant Microsoft kalbos paslaugas.

Ši klasė palaiko teksto konvertavimą į kalbą ir suteikia keletą metodų kalbos nustatymų gavimui ir kalbos sintezės užklausų kūrimui.

```ts
constructor(options: MicrosoftSpeechAPI): MicrosoftSpeechTTS
```

## Parametrai

- `options`: Objektas, neprivalomas.
- `serviceUrl`: Eilutė, nurodo Microsoft kalbos paslaugų URL. Jei pateikiamas, užklausos bus siunčiamos į šį URL.
- `locale`: Eilutė, nurodo naudojamą kalbos regioną. Jei pateikiamas, bus naudojamas norint filtruoti galimas balsus.

## Pavyzdžiai

```js
// index.js
// index.js
import { MicrosoftSpeechTTS } from '@arietta-studio/recognition';

// gauti MicrosoftSpeechTTS egzempliorių
const tts = new MicrosoftSpeechTTS({ locale: 'en-US' });

// sukurti duomenų paketą
const payload: MicrosoftSpeechPayload = {
input: 'this is a message',
options: {
voice: 'en-US-JacobNeural',
style: 'embarrassed',
},
};

const speechFile = path.resolve('./speech.mp3');

// sukurti kalbą
const response = await tts.create(payload);
const mp3Buffer = Buffer.from(await response.arrayBuffer());

fs.writeFileSync(speechFile, mp3Buffer);
```

Paleisti naudojant Bun:

```shell
$ bun index.js
```

Paleisti Node.js aplinkoje:

Dėl `WebSocket` egzemplioriaus trūkumo Nodejs aplinkoje, reikia panaudoti WebSocket polifilą. Importuojant ws paketą.

```js
// importuoti failo viršuje
import WebSocket from 'ws';

global.WebSocket = WebSocket;
```

## Statinės Savybės

- `localeOptions`: Gauti visus palaikomus kalbos regionų nustatymus.
- `voiceList`: Visų galimų balsų sąrašas.
- `voiceName`: Objektas, turintis visus balsų pavadinimus.
- `styleList`: Visų galimų balsų stilių sąrašas.
- `createRequest`: Statinis metodas kalbos sintezės užklausoms kurti.

## Metodai

### `voiceOptions`

Gauti dabartinio egzemplioriaus balsų nustatymus, remiantis per sukūrimą nurodytu `locale`. Grąžina objektą, turintį galimus balsų nustatymus.

### `create(payload: MicrosoftSpeechPayload): Promise<Response>`

Sukurti kalbos sintezę naudojant pateiktą užklausos duomenų paketą.

#### Parametrai

- `payload`: `MicrosoftSpeechPayload` tipo, turintis būtiną informaciją kalbos sintezės užklausai.

#### Grąžinimo Reikšmė

Grąžina `Promise`, kuris išsprendžiamas į `Response` objektą, turintį sintezuotos kalbos duomenis.

### `createAudio(payload: MicrosoftSpeechPayload): Promise<AudioBuffer>`

Sukurti kalbos sintezę naudojant pateiktą užklausos duomenų paketą ir konvertuoti ją į `AudioBuffer` objektą.

#### Parametrai

- `payload`: `MicrosoftSpeechPayload` tipo, turintis būtiną informaciją kalbos sintezės užklausai.

#### Grąžinimo Reikšmė

Grąžina `Promise`, kuris išsprendžiamas į `AudioBuffer` objektą, turintį sintezuotus garso duomenis.
88 changes: 88 additions & 0 deletions docs/api-reference/openai-tts.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
group: TTS
title: OpenAITTS
apiHeader:
pkg: '@arietta-studio/recognition'
---

`OpenAITTS` yra klasė tekstui versti į kalbą naudojant OpenAI balso paslaugą.

Ši klasė palaiko teksto konvertavimą į kalbą ir suteikia metodų rinkinį gauti balso parinktis ir kurti kalbos sintezės užklausas.

```ts
constructor(options: OpenAITTSAPI): OpenAITTS
```

## Parametrai

- `options`: Objektas, neprivalomas.
- `OPENAI_PROXY_URL`: Eilutė, nurodo OpenAI tarpinio serverio URL. Jei pateikiamas, užklausos bus siunčiamos į šį URL.
- `OPENAI_API_KEY`: Eilutė, nurodo OpenAI API raktą. Jei pateikiamas, bus naudojamas autentifikacijai.
- `serviceUrl`: Eilutė, nurodo naudojamos OpenAI balso paslaugos URL. Jei pateikiamas, bus naudojamas siųsti užklausas.

## Pavyzdžiai

```js
// index.js
import { OpenAITTS } from '@arietta-studio/recognition';
import { Buffer } from 'buffer';
import fs from 'fs';
import path from 'path';

// Sukurti OpenAITTS egzempliorių
const tts = new OpenAITTS({ OPENAI_API_KEY: 'jūsų-api-raktas' });

// Sukurti kalbos sintezės užklausos duomenų paketą
const payload = {
input: 'Tai yra balso sintezės demonstracija',
options: {
model: 'tts-1',
voice: 'alloy',
},
};

const speechFile = path.resolve('./speech.mp3');

// Iškviesti create metodą sintezuoti kalbą
const response = await tts.create(payload);
const mp3Buffer = Buffer.from(await response.arrayBuffer());

fs.writeFileSync(speechFile, mp3Buffer);
```

Paleisti naudojant Bun:

```shell
$ bun index.js
```

Node.js aplinkoje:

```js
// Importuoti failo viršuje
import WebSocket from 'ws';

global.WebSocket = WebSocket;
```

## Statinės Savybės

- `voiceList`: Visų galimų balsų sąrašas.

## Metodai

### `voiceOptions`

Gauti dabartinio egzemplioriaus balso parinktis remiantis per instancijos sukūrimą nurodytu `serviceUrl`. Grąžina objektą, kuriame yra prieinamos balso parinktys.

### `createAudio(payload: OpenAITTSPayload): Promise<AudioBuffer>`

Sukurti kalbos sintezę naudojant pateiktą užklausos duomenų paketą.

#### Parametrai

- `payload`: `OpenAITTSPayload` tipas, apima būtiną informaciją kalbos sintezės užklausai.

#### Grąžinimas

Grąžina `Promise`, kuris išsprendžiamas į `AudioBuffer` objektą, kuriame yra sintezuoti garso duomenys.
9 changes: 9 additions & 0 deletions docs/changelog.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Atnaujinimai
description: Nauji atnaujinimai ir patobulinimai @arietta-studio/recognition
nav:
title: Atnaujinimai
order: 999
---

<embed src="../CHANGELOG.md"></embed>
7 changes: 7 additions & 0 deletions docs/index.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
hero:
title: Arietta <b>Recognition</b>
description: Aukštos kokybės, didelio našumo ir lengvai naudojama kalbos atpažinimo biblioteka internetui, naudojama Arietta platformose.
---

<code src="./index.tsx" inline></code>
9 changes: 9 additions & 0 deletions src/react/AudioPlayer/index.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
nav: Komponentai
group: Vartotojo sąsaja
title: AudioPlayer
---

## default

<code src="./demos/index.tsx" nopadding></code>
9 changes: 9 additions & 0 deletions src/react/AudioVisualizer/index.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
nav: Komponentai
group: Vartotojo sąsaja
title: AudioVisualizer
---

## default

<code src="./demos/index.tsx" nopadding></code>
9 changes: 9 additions & 0 deletions src/react/useAudioRecorder/index.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
nav: Komponentai
group: STT
title: useAudioRecorder
---

## Kabliukai (hooks)

<code src="./demos/index.tsx" center></code>
9 changes: 9 additions & 0 deletions src/react/useEdgeSpeech/index.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
nav: Komponentai
group: TTS
title: useEdgeSpeech
---

## Kabliukai (hooks)

<code src="./demos/index.tsx" nopadding></code>
11 changes: 11 additions & 0 deletions src/react/useMicrosoftSpeech/index.lt-LT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
nav: Komponentai
group: TTS
title: useMicrosoftSpeech
---

## Kabliukai (hooks)

- ENV: `MICROSOFT_SPEECH_BACKEND_URL`

<code src="./demos/index.tsx" nopadding></code>
Loading

0 comments on commit a521451

Please sign in to comment.