> For the complete documentation index, see [llms.txt](https://docs.mikopbx.com/mikopbx/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mikopbx.com/mikopbx/modules/miko/module-local-speech-to-text/quick-start.md).

# Быстрый старт

Быстрый запуск модуля локальной транскрибации и Local STT Worker

### Установка модуля

1. Откройте веб-интерфейс MikoPBX.
2. Перейдите в раздел **Модули** → **Маркетплейс модулей**.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2FmxR3E47vRwk4is6vayNM%2FMikoPBXModuleMarketplace.png?alt=media&amp;token=13a28fc5-173b-4251-bfd9-d362dcd73a6b" alt=""><figcaption><p>Маркетплейс модулей</p></figcaption></figure>

3. Найдите **Модуль локальной транскрибации** и установите его.
4. Откройте список установленных модулей и включите модуль.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2Ft0qmpS8ZminKzHV82iyk%2FSTTModuleInstalledModulesSection.png?alt=media&amp;token=f78715a4-614d-4f42-8d36-98e956befa74" alt=""><figcaption><p>Включение модуля локальной транскрибации</p></figcaption></figure>

5. Нажмите кнопку настроек справа от версии модуля.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2FOJNPbd9N4CPH72ZrmMCN%2FSTTModuleOpen.png?alt=media&amp;token=f4d9b0b5-8d48-4984-9b2c-26fbe54cfbf7" alt=""><figcaption><p>Переход на страницу модуля</p></figcaption></figure>

### Первичная настройка модуля

1. На вкладке **Настройки** выберите основной язык звонков или оставьте **Определять автоматически**.
2. Проверьте **Максимальную длительность распознаваемой записи**. Значение по умолчанию — 60 минут.
3. Выберите **Период обработки записей** и **Срок хранения расшифровок**. Период обработки не должен превышать срок хранения.
4. При необходимости добавьте внутренние названия и сокращения в список терминов.
5. Сохраните настройки.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2F5TquJrLzZZ2QkRI7YazD%2FSTTModuleMain.png?alt=media&amp;token=852fb709-e2a9-4fe1-9a38-c4b02efc91ff" alt=""><figcaption><p>Прежний вид страницы настроек</p></figcaption></figure>

### Выбор модели

1. Откройте вкладку **Каталог моделей**.
2. Выберите модель для транскрибации звонков. Для большинства звонков рекомендуется выбранная по умолчанию **Parakeet TDT 0.6B v3**; для языков вне поддерживаемых Parakeet 25 языков используйте модель WhisperKit.
3. Нажмите **Сохранить модель**.

{% hint style="info" %}
Выбранная модель загружается на Mac при первом задании. До завершения первой загрузки модели и ее служебных файлов Mac должен иметь доступ в интернет.
{% endhint %}

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2F606DfEcJzVJgNlFxLgtF%2FSTTModuleChoosingModel.png?alt=media&amp;token=79bd4735-7b00-49fe-87ee-8f566cc30602" alt=""><figcaption><p>Выбор модели распознавания</p></figcaption></figure>

### Создание ключа Worker

1. Откройте вкладку **Обработчики**.
2. Нажмите **Создать ключ доступа**.
3. Сразу скопируйте показанный токен: после обновления страницы его нельзя будет посмотреть повторно.

{% hint style="info" %}
Для каждого Mac рекомендуется создавать отдельный ключ. Один ключ нельзя привязать к нескольким UID обработчиков.
{% endhint %}

<mark style="color:red;">Устарело, обновить после реализации загрузки обработчика</mark>

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2FbxY0OZrCV8HUXrTKVTsE%2FSTTModuleCreatingANewWorkerKey.png?alt=media&amp;token=4fcd14b2-7ed9-40ba-84b5-c3a4992f436f" alt=""><figcaption><p>Прежний вид вкладки обработчиков</p></figcaption></figure>

### Подключение Local STT Worker

Установите и откройте приложение **Local STT Worker**. При первом запуске появится онбоардинг из трех шагов.

#### Шаг 1. Язык

Выберите русский или английский язык интерфейса и нажмите **Далее**. При смене языка может потребоваться перезапуск; после него онбоардинг откроется снова.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2FqNoK2zlr7dPoZNllxBjI%2FUPDSTTOnboardLang.png?alt=media&amp;token=44e6af84-f5e8-401e-abd3-a4b2b05efbcb" alt=""><figcaption><p>Экран выбора языка MIKO AI Worker</p></figcaption></figure>

#### Шаг 2. Подключение к MikoPBX

Заполните поля:

| Поле                 | Что указать                                                     |
| -------------------- | --------------------------------------------------------------- |
| **Адрес MikoPBX**    | Адрес вида `https://pbx.example.com` без логина и пароля в URL. |
| **Имя обработчика**  | Понятное имя Mac, которое будет видно в MikoPBX.                |
| **Токен STT Worker** | Ключ, созданный на вкладке **Обработчики**.                     |

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2FNoumoJ2H0qy2B1NAuV0L%2FUPDSTTOndoardConnection.png?alt=media&amp;token=d0bde6a1-2f86-4070-a530-8233e05faeec" alt=""><figcaption><p>Настройка параметров подключения к станции</p></figcaption></figure>

В раскрывающемся блоке **Дополнительные настройки** доступны:

* проверка TLS-сертификата;
* добавление PEM-файла собственного CA;
* указание собственного UID обработчика.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2F6DtyDomNbgi0VCaD2tpV%2FUPDSTTOnboardingAdditionalSettings.png?alt=media&amp;token=a8a3999e-6a43-4f7d-ac3c-093d8293e225" alt=""><figcaption><p>Дополнительные настройки подключения к станции</p></figcaption></figure>

Нажмите **Подключить и продолжить**. Приложение проверит соединение и корректность указанных параметров.

#### Шаг 3. Завершение

На финальном шаге будет показано состояние обработчика. Здесь также можно включить два параметра:

* **Запускать при входе** — приложение будет открываться автоматически после входа в macOS.
* **Поддерживать работу обработчика** — Worker будет автоматически возобновлять работу после восстановления сети, пробуждения Mac или временной ошибки.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2FtCs3KLB6CPoDQT27pkdu%2FUPDSTTOnboardingFinalPage.png?alt=media&amp;token=6b1e4b8f-1eb1-4db4-aef8-126925449346" alt=""><figcaption><p>Финальный шаг настройки воркера</p></figcaption></figure>

В приложении откройте **Обзор**. Если обработчик остановлен, нажмите **Запустить обработчик**. В блоке готовности должна отображаться модель, выбранная в MikoPBX.

### Проверка работы

1. Совершите звонок, для которого включена запись разговора.
2. Дождитесь появления задания на вкладке **Очередь** модуля.
3. При первом запуске дождитесь загрузки модели на Mac.
4. Проверьте локальные этапы в разделе **Обзор** или события в разделе **Диагностика**.
5. Откройте готовый результат на вкладке **Расшифровки** в MikoPBX.

<figure><img src="https://3704471835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MPK4TuzRBnP7rt8htho-887967055%2Fuploads%2FC7WECu4qVhaZchmYEIct%2FSTTWorkerTranscribationProcess.png?alt=media&amp;token=c7eb366d-9827-4403-9640-b0949b51d391" alt=""><figcaption><p>Процесс обработки звонка. Главный экран обработчика.</p></figcaption></figure>

Подробное описание разделов приложения приведено в статье [Local STT Worker](/mikopbx/modules/miko/module-local-speech-to-text/miko-ai-worker.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mikopbx.com/mikopbx/modules/miko/module-local-speech-to-text/quick-start.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.