From b0fa25dfbda17a02df36a47b2236612424a22876 Mon Sep 17 00:00:00 2001 From: Krrish Dholakia Date: Fri, 8 Mar 2024 23:51:24 -0800 Subject: [PATCH] docs(audio_transcription.md): add docs on audio transcription --- docs/my-website/docs/audio_transcription.md | 85 +++++++++++++++++++++ docs/my-website/sidebars.js | 5 +- 2 files changed, 88 insertions(+), 2 deletions(-) create mode 100644 docs/my-website/docs/audio_transcription.md diff --git a/docs/my-website/docs/audio_transcription.md b/docs/my-website/docs/audio_transcription.md new file mode 100644 index 000000000..09fa1a1b9 --- /dev/null +++ b/docs/my-website/docs/audio_transcription.md @@ -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 + + + + + +```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 +``` + + + +```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 +``` + + + + +### 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"' +``` diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js index 7aaf2e114..33720b43e 100644 --- a/docs/my-website/sidebars.js +++ b/docs/my-website/sidebars.js @@ -101,12 +101,13 @@ const sidebars = { }, { type: "category", - label: "Embedding(), Moderation(), Image Generation()", + label: "Embedding(), Moderation(), Image Generation(), Audio Transcriptions()", items: [ "embedding/supported_embedding", "embedding/async_embedding", "embedding/moderation", - "image_generation" + "image_generation", + "audio_transcription" ], }, {