mirror of
https://github.com/mudler/LocalAI.git
synced 2026-07-31 02:18:50 -04:00
* docs: fix CPU image tag (latest, not latest-cpu) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: use canonical localai/localai registry in models guide Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: replace dead llama-stable backend with llama-cpp Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: correct mitm-proxy intercept config and redaction tier Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fix text-to-audio endpoint and broken notice block Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fix VAD example, stale FAQ, broken link, CLI list, whats-new dump Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: render advanced/reference section indexes (consolidate _index) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: remove duplicate getting-started build/kubernetes pages Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fold container image reference into installation/containers Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: remove stale advanced fine-tuning page (superseded by features/fine-tuning) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fold distribution/longcat/sound pages into their parents Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: make getting-started index accurate and complete Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: carry one concrete model through the getting-started path Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add end-to-end 'build your first agent' walkthrough Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add runtime errors reference; consolidate troubleshooting from FAQ Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add agent actions catalog Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: agent-scoped MCP, skills walkthrough, agentic disambiguation Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add concrete gallery install lines to media feature pages Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: merge installation into getting-started (URLs preserved via aliases) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add Operations section; move operator pages and P2P API reference Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: journey-ordered top nav and grouped feature sections Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add docs-with-code process gate (PR template + agent instructions) Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: remove em/en dashes from documentation prose Signed-off-by: Ettore Di Giacinto <mudler@localai.io> --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
109 lines
2.7 KiB
Markdown
109 lines
2.7 KiB
Markdown
+++
|
|
disableToc = false
|
|
title = "Voice Activity Detection (VAD)"
|
|
weight = 35
|
|
url = "/features/voice-activity-detection/"
|
|
+++
|
|
|
|
Voice Activity Detection (VAD) identifies segments of speech in audio data. LocalAI provides a `/v1/vad` endpoint powered by the [Silero VAD](https://github.com/snakers4/silero-vad) backend.
|
|
|
|
## API
|
|
|
|
- **Method:** `POST`
|
|
- **Endpoints:** `/v1/vad`, `/vad`
|
|
|
|
### Request
|
|
|
|
The request body is JSON with the following fields:
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------------|----------|------------------------------------------|
|
|
| `model` | `string` | Yes | Model name (e.g. `silero-vad`) |
|
|
| `audio` | `float32[]`| Yes | Array of audio samples (16kHz PCM float) |
|
|
|
|
### Response
|
|
|
|
Returns a JSON object with detected speech segments:
|
|
|
|
| Field | Type | Description |
|
|
|--------------------|-----------|------------------------------------|
|
|
| `segments` | `array` | List of detected speech segments |
|
|
| `segments[].start` | `float` | Start time in seconds |
|
|
| `segments[].end` | `float` | End time in seconds |
|
|
|
|
## Usage
|
|
|
|
### Example request
|
|
|
|
The `/v1/vad` endpoint expects the `audio` field to be an array of raw
|
|
16kHz mono PCM samples as `float32` values, so the request body is usually
|
|
built from a real audio file rather than typed by hand.
|
|
|
|
First convert any audio file to 16kHz mono with ffmpeg:
|
|
|
|
```bash
|
|
ffmpeg -i input.mp3 -ar 16000 -ac 1 -f wav speech.wav
|
|
```
|
|
|
|
Then load the samples and POST them (this snippet needs
|
|
`pip install soundfile numpy requests`):
|
|
|
|
```python
|
|
import soundfile as sf
|
|
import numpy as np
|
|
import requests
|
|
|
|
audio, sample_rate = sf.read("speech.wav")
|
|
if audio.ndim > 1:
|
|
audio = audio.mean(axis=1) # downmix to mono
|
|
samples = audio.astype(np.float32).tolist()
|
|
|
|
response = requests.post(
|
|
"http://localhost:8080/v1/vad",
|
|
json={"model": "silero-vad", "audio": samples},
|
|
)
|
|
print(response.json())
|
|
```
|
|
|
|
### Example response
|
|
|
|
```json
|
|
{
|
|
"segments": [
|
|
{
|
|
"start": 0.5,
|
|
"end": 2.3
|
|
},
|
|
{
|
|
"start": 3.1,
|
|
"end": 5.8
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Model Configuration
|
|
|
|
Create a YAML configuration file for the VAD model:
|
|
|
|
```yaml
|
|
name: silero-vad
|
|
backend: silero-vad
|
|
```
|
|
|
|
## Detection Parameters
|
|
|
|
The Silero VAD backend uses the following internal defaults:
|
|
|
|
- **Sample rate:** 16kHz
|
|
- **Threshold:** 0.5
|
|
- **Min silence duration:** 100ms
|
|
- **Speech pad duration:** 30ms
|
|
|
|
## Error Responses
|
|
|
|
| Status Code | Description |
|
|
|-------------|---------------------------------------------------|
|
|
| 400 | Missing or invalid `model` or `audio` field |
|
|
| 500 | Backend error during VAD processing |
|