Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Nov 3, 2024
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9cbdca
docs: Update documentation for text-to-audio feature regarding respon…
n-Arno Nov 2, 2024
b40e1be
Merge branch 'master' into tts-format-docs
dave-gray101 Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/content/docs/features/text-to-audio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.