mirror of
https://github.com/BerriAI/litellm.git
synced 2025-04-26 11:14:04 +00:00
docs(audio_transcription.md): add docs on audio transcription
This commit is contained in:
parent
775997b283
commit
b0fa25dfbd
2 changed files with 88 additions and 2 deletions
85
docs/my-website/docs/audio_transcription.md
Normal file
85
docs/my-website/docs/audio_transcription.md
Normal file
|
@ -0,0 +1,85 @@
|
||||||
|
import Tabs from '@theme/Tabs';
|
||||||
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
|
# Audio Transcription
|
||||||
|
|
||||||
|
Use this to loadbalance across Azure + OpenAI.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
```python
|
||||||
|
from litellm import transcription
|
||||||
|
import os
|
||||||
|
|
||||||
|
# set api keys
|
||||||
|
os.environ["OPENAI_API_KEY"] = ""
|
||||||
|
audio_file = open("/path/to/audio.mp3", "rb")
|
||||||
|
|
||||||
|
response = transcription(model="whisper", file=audio_file)
|
||||||
|
|
||||||
|
print(f"response: {response}")
|
||||||
|
```
|
||||||
|
|
||||||
|
## Proxy Usage
|
||||||
|
|
||||||
|
### Add model to config
|
||||||
|
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<TabItem value="openai" label="OpenAI">
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
model_list:
|
||||||
|
- model_name: whisper
|
||||||
|
litellm_params:
|
||||||
|
model: whisper-1
|
||||||
|
api_key: os.environ/OPENAI_API_KEY
|
||||||
|
model_info:
|
||||||
|
mode: audio_transcription
|
||||||
|
|
||||||
|
general_settings:
|
||||||
|
master_key: sk-1234
|
||||||
|
```
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="openai+azure" label="OpenAI + Azure">
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
model_list:
|
||||||
|
- model_name: whisper
|
||||||
|
litellm_params:
|
||||||
|
model: whisper-1
|
||||||
|
api_key: os.environ/OPENAI_API_KEY
|
||||||
|
model_info:
|
||||||
|
mode: audio_transcription
|
||||||
|
- model_name: whisper
|
||||||
|
litellm_params:
|
||||||
|
model: azure/azure-whisper
|
||||||
|
api_version: 2024-02-15-preview
|
||||||
|
api_base: os.environ/AZURE_EUROPE_API_BASE
|
||||||
|
api_key: os.environ/AZURE_EUROPE_API_KEY
|
||||||
|
model_info:
|
||||||
|
mode: audio_transcription
|
||||||
|
|
||||||
|
general_settings:
|
||||||
|
master_key: sk-1234
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
### Start proxy
|
||||||
|
|
||||||
|
```bash
|
||||||
|
litellm --config /path/to/config.yaml
|
||||||
|
|
||||||
|
# RUNNING on http://0.0.0.0:8000
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl --location 'http://0.0.0.0:4000/v1/audio/transcriptions' \
|
||||||
|
--header 'Authorization: Bearer sk-1234' \
|
||||||
|
--form 'file=@"/Users/krrishdholakia/Downloads/gettysburg.wav"' \
|
||||||
|
--form 'model="whisper"'
|
||||||
|
```
|
|
@ -101,12 +101,13 @@ const sidebars = {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
label: "Embedding(), Moderation(), Image Generation()",
|
label: "Embedding(), Moderation(), Image Generation(), Audio Transcriptions()",
|
||||||
items: [
|
items: [
|
||||||
"embedding/supported_embedding",
|
"embedding/supported_embedding",
|
||||||
"embedding/async_embedding",
|
"embedding/async_embedding",
|
||||||
"embedding/moderation",
|
"embedding/moderation",
|
||||||
"image_generation"
|
"image_generation",
|
||||||
|
"audio_transcription"
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue