fasr-service-fastapi
FastAPI service plugin for fasr. This package provides the concrete online
service implementation while the core fasr package keeps only service base
classes and registries.
Features
- Demo web page:
GET /(same asGET /demo)
- Optional batch transcription HTTP endpoints:
POST /transcribePOST /inference
- Optional realtime websocket endpoints:
GET /v1/realtimeGET /api-ws/v1/realtime
- Health endpoint:
GET /health
- Config-driven model and router initialization through fasr registries
Realtime API Docs
- English: REALTIME_API.md
- Chinese: REALTIME_API_ZH.md
The realtime router supports runtime turn_detection updates through the VAD
model's apply_turn_detection(...) hook. At the moment, the streaming VAD
models with documented runtime support are:
fsmn_onlinestream_silero
Client-side realtime VAD updates use the websocket session.update event. The
server replies with session.updated when the update is accepted. Example:
{
"type": "session.update",
"session": {
"turn_detection": {
"type": "server_vad",
"silence_duration_ms": 300,
"threshold": 0.5,
"prefix_padding_ms": 100
}
}
}
The currently documented server_vad runtime fields are:
silence_duration_msthresholdprefix_padding_ms
See REALTIME_API.md and REALTIME_API_ZH.md for the full event contract and field semantics.
Registered entry points
| Group | Name | Entry point |
|---|---|---|
fasr_services |
fastapi.v1 |
fasr_service_fastapi.service:FastAPIASRService |
fasr_service_routers |
transcribe.v1 |
fasr_service_fastapi.routers.transcribe:transcribe_entrypoint |
fasr_service_routers |
realtime.v1 |
fasr_service_fastapi.routers.realtime:realtime_entrypoint |
Configuration
The service owns model instances under [service.models]. Each router owns its
own model_map, which maps router argument names to model names from
[service.models]. Routers are enabled only when their config block exists, so
omitting [service.transcribe_router] skips batch HTTP routes and omitting
[service.realtime_router] skips realtime websocket routes.
Configuring neither router is invalid and fasr-fastapi serve will fail fast
with a clear error.
The config has four layers:
[service]: service-level knobs such ashost,port, anddebug_logging.[service.models.*]: model instances owned by the service.[service.<router>.model_map]: which service-owned models are wired into a router.[service.<router>.component_configs]and[service.<router>.pipe_configs]: runtime tuning for transcribe components and their threadedPipewrappers.
When using nested dictionary sections such as component_configs or
pipe_configs, keep the empty parent section in the file first:
[service.transcribe_router.component_configs]
[service.transcribe_router.component_configs.detector]
num_threads = 4
Without the parent section, confection may fail to parse the nested config.
Minimal transcribe-only config:
[service]
@services = "fastapi.v1"
[service.models.paraformer]
@asr_models = "paraformer"
[service.models.marblenet]
@vad_models = "marblenet"
[service.transcribe_router]
@service_routers = "transcribe.v1"
[service.transcribe_router.model_map]
vad_model = "marblenet"
asr_model = "paraformer"
Full example with punctuation and tunable runtime parameters:
[service]
@services = "fastapi.v1"
host = "0.0.0.0"
port = 8000
debug_logging = false
[service.models.qwen3_asr]
@asr_models = "qwen3asr"
size = "small"
[service.models.marblenet]
@vad_models = "marblenet"
[service.models.ct_transformer]
@punc_models = "ct_transformer"
[service.models.fsmn_online]
@vad_models = "fsmn_online"
[service.transcribe_router]
@service_routers = "transcribe.v1"
[service.transcribe_router.model_map]
vad_model = "marblenet"
asr_model = "qwen3_asr"
punc_model = "ct_transformer"
[service.transcribe_router.component_configs]
[service.transcribe_router.component_configs.loader]
timeout_seconds = 60.0
max_concurrency = 32
[service.transcribe_router.component_configs.detector]
num_threads = 4
max_segment_duration = 30.0
[service.transcribe_router.component_configs.recognizer]
num_threads = 2
batch_size_s = 30
[service.transcribe_router.component_configs.sentencizer]
num_threads = 2
[service.transcribe_router.pipe_configs]
[service.transcribe_router.pipe_configs.detector]
batch_size = 8
batch_timeout = 0.2
verbose = false
[service.transcribe_router.pipe_configs.recognizer]
batch_size = 8
batch_timeout = 0.2
verbose = false
[service.transcribe_router.pipe_configs.sentencizer]
batch_size = 8
batch_timeout = 0.2
verbose = false
[service.realtime_router]
@service_routers = "realtime.v1"
[service.realtime_router.model_map]
vad_model = "fsmn_online"
asr_model = "qwen3_asr"
Set debug_logging = true if you want to keep the service's DEBUG logs
during development.
Router entry points are factory functions. For example, transcribe_entrypoint
creates default AudioLoader, VoiceDetector, and SpeechRecognizer
instances when the config only provides model_map. This avoids requiring users
to spell out internal router components in simple service configs. When
punc_model is present in the transcribe router model_map, the router also
creates a default SpeechSentencizer and adds it after the recognizer.
pipe_configs forwards runtime knobs to the underlying Pipe wrappers. Each
transcribe pipe can currently configure:
batch_sizebatch_timeoutverbose
component_configs forwards keyword arguments to each component's setup().
This is the place to tune component-native knobs such as:
loader.max_concurrencyloader.timeout_secondsdetector.num_threadsdetector.max_segment_durationrecognizer.num_threadsrecognizer.batch_size_ssentencizer.num_threads
CLI
Install the service plugin through the root project extra:
uv sync --extra service
Or install the plugin package directly:
pip install fasr-service-fastapi
Generate and run a default config:
fasr-fastapi init --cfg run.cfg
fasr-fastapi serve --cfg run.cfg
Inspect or write the default config without starting the server:
fasr-fastapi serve --print_default_config true
fasr-fastapi serve --write_default_config run.cfg
The legacy fasr init and fasr serve commands still forward to this plugin
CLI for now, but fasr-fastapi is the supported command surface going
forward.
The same default config is available from:
from fasr_service_fastapi import FastAPIASRService
config = FastAPIASRService.model_construct().get_default_config()
Realtime Protocol
The websocket protocol is documented separately in REALTIME_API.md.
Development
Install from the repository root:
uv sync
Run service tests:
uv run pytest tests/test_online_service.py -q
Build the plugin:
uv build --package fasr-service-fastapi
Metadata
Release files for fasr-service-fastapi 0.5.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fasr_service_fastapi-0.5.3.tar.gz | 27.8 kB | Without provenance | Details for fasr_service_fastapi-0.5.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fasr_service_fastapi-0.5.3-py3-none-any.whl | Python 3 | none | any | Details for fasr_service_fastapi-0.5.3-py3-none-any.whl |
Total release size: 63.1 kB
Release files / fasr_service_fastapi-0.5.3.tar.gz
| Download URL | fasr_service_fastapi-0.5.3.tar.gz |
|---|---|
| Size | 27.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e514a783922e67ca5479961373d96d1b41d1dcc0b158443df9c00202b1fc4fa0
|
|
BLAKE2b-256 checksum How to use checksums |
5d99eba7f5cc561efd8de62eddabff254a7dbc04cf8ef2322c9d6551dafaa786
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / fasr_service_fastapi-0.5.3-py3-none-any.whl
| Download URL | fasr_service_fastapi-0.5.3-py3-none-any.whl |
|---|---|
| Size | 35.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
201320b4e1d8df0c066ff9721746c154c8573d764706d4e3cca78b0611126b36
|
|
BLAKE2b-256 checksum How to use checksums |
c2c87a2a3cea34a2136d286d6f6f3c126f0fae4601405c56287eb10a599f16a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for fasr-service-fastapi 0.5.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.