ExternalVendorCode/LocalAI
1
0
Fork 0
mirror of https://github.com/mudler/LocalAI.git synced 2024-12-19 20:57:54 +00:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity

docs: Update documentation for text-to-audio feature regarding response_format (#4038)

Browse Source
This commit is contained in:
Arnaud A 2024-11-03 03:15:54 +01:00 committed by GitHub
parent abd5eea66d
commit 0b3a55b9fe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content/docs/features/text-to-audio.md
View File

@ -201,3 +201,21 @@ curl -L http://localhost:8080/tts \
"input": "Bonjour, je suis Ana Florence. Comment puis-je vous aider?"
}' | aplay
```
## Response format
To provide some compatibility with OpenAI API regarding `response_format`, ffmpeg must be installed (or a docker image including ffmpeg used) to leverage converting the generated wav file before the api provide its response.
Warning regarding a change in behaviour. Before this addition, the parameter was ignored and a wav file was always returned, with potential codec errors later in the integration (like trying to decode a mp3 file from a wav, which is the default format used by OpenAI)
Supported format thanks to ffmpeg are `wav`, `mp3`, `aac`, `flac`, `opus`, defaulting to `wav` if an unknown or no format is provided.
```bash
curl http://localhost:8080/tts -H "Content-Type: application/json" -d '{
"input": "Hello world",
"model": "tts",
"response_format": "mp3"
}'
```
If a `response_format` is added in the query (other than `wav`) and ffmpeg is not available, the call will fail.