Metadata-Version: 2.3
Name: fasr-service-transcribe
Version: 0.5.8
Summary: FastAPI transcribe service plugin for fasr
Author: osc
Author-email: osc <790990241@qq.com>
Requires-Dist: fasr>=0.5.8
Requires-Dist: fastapi>=0.115.4
Requires-Dist: uvicorn>=0.32.0
Requires-Dist: typer>=0.16.0
Requires-Dist: rich>=13.9.4
Requires-Python: >=3.10, <3.13
Description-Content-Type: text/markdown

# fasr-service-transcribe

英文文档地址: [README_EN.md](README_EN.md)

fasr 的 FastAPI transcribe 服务插件。

## 注册入口

服务 entry point：

- `transcribe.fastapi.v1`

router entry point：

- `transcribe.fastapi.v1`

## CLI

```bash
fasr-service-transcribe serve \
  --vad marblenet \
  --asr paraformer \
  --enhance deepfilternet \
  --punc ct_transformer \
  --host 0.0.0.0 \
  --port 8000

fasr-service-transcribe init \
  --cfg transcribe.cfg \
  --vad marblenet \
  --asr paraformer \
  --enhance deepfilternet \
  --punc ct_transformer

# init 默认会在每个参数上方写入 # 注释，方便理解参数作用；
# 如需生成纯配置文件，可以加 --no-comments。
fasr-service-transcribe init --cfg transcribe.cfg --no-comments

fasr-service-transcribe serve --cfg transcribe.cfg
```

扁平 CLI 参数适合快速启动 transcribe 服务；如果需要细调模型参数，再通过
`init --cfg` 生成 `transcribe.cfg` 并修改配置文件。该服务会暴露
`POST /transcribe` 与 `POST /inference` 接口。`--enhance` 是可选参数，
用于在离线转写前先执行批量音频增强。

服务启动后，也可以直接打开 `/` 或 `/demo` 使用内置可视化页面测试转写接口。

## API 文档

- 中文：[TRANSCRIBE_API_ZH.md](TRANSCRIBE_API_ZH.md)
- 英文：[TRANSCRIBE_API.md](TRANSCRIBE_API.md)

## Client 示例

- Python client: [client.py](client.py)
