From e18143dcbacf9057ef7d1ba06bccb0f4db18b478 Mon Sep 17 00:00:00 2001
From: Krrish Dholakia <krrishdholakia@gmail.com>
Date: Sat, 28 Dec 2024 20:19:12 -0800
Subject: [PATCH] docs(deepgram.md): add deepgram model support to docs

---
 docs/my-website/docs/audio_transcription.md |  3 +-
 docs/my-website/docs/providers/deepgram.md  | 80 +++++++++++++++++++++
 docs/my-website/sidebars.js                 |  1 +
 3 files changed, 83 insertions(+), 1 deletion(-)
 create mode 100644 docs/my-website/docs/providers/deepgram.md

diff --git a/docs/my-website/docs/audio_transcription.md b/docs/my-website/docs/audio_transcription.md
index 1d6ea0e9fa..1695946fe4 100644
--- a/docs/my-website/docs/audio_transcription.md
+++ b/docs/my-website/docs/audio_transcription.md
@@ -112,4 +112,5 @@ transcript = client.audio.transcriptions.create(
 - OpenAI
 - Azure
 - [Fireworks AI](./providers/fireworks_ai.md#audio-transcription)
-- [Groq](./providers/groq.md#speech-to-text---whisper)
\ No newline at end of file
+- [Groq](./providers/groq.md#speech-to-text---whisper)
+- [Deepgram](./providers/deepgram.md)
\ No newline at end of file
diff --git a/docs/my-website/docs/providers/deepgram.md b/docs/my-website/docs/providers/deepgram.md
new file mode 100644
index 0000000000..adc66dfa0e
--- /dev/null
+++ b/docs/my-website/docs/providers/deepgram.md
@@ -0,0 +1,80 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Deepgram 
+
+LiteLLM supports Deepgram's `/listen` endpoint.
+
+## Quick Start
+
+```python
+from litellm import transcription
+import os 
+
+# set api keys 
+os.environ["DEEPGRAM_API_KEY"] = ""
+audio_file = open("/path/to/audio.mp3", "rb")
+
+response = transcription(model="deepgram/nova-2", file=audio_file)
+
+print(f"response: {response}")
+```
+
+## LiteLLM Proxy Usage
+
+### Add model to config 
+
+1. Add model to config.yaml
+
+```yaml
+model_list:
+- model_name: nova-2
+  litellm_params:
+    model: deepgram/nova-2
+    api_key: os.environ/DEEPGRAM_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:4000
+```
+
+### Test 
+
+<Tabs>
+<TabItem value="curl" label="Curl">
+
+```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="nova-2"'
+```
+
+</TabItem>
+<TabItem value="openai" label="OpenAI">
+
+```python
+from openai import OpenAI
+client = openai.OpenAI(
+    api_key="sk-1234",
+    base_url="http://0.0.0.0:4000"
+)
+
+
+audio_file = open("speech.mp3", "rb")
+transcript = client.audio.transcriptions.create(
+  model="nova-2",
+  file=audio_file
+)
+```
+</TabItem>
+</Tabs>
diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js
index 8f237f05b6..7c85c3d6af 100644
--- a/docs/my-website/sidebars.js
+++ b/docs/my-website/sidebars.js
@@ -183,6 +183,7 @@ const sidebars = {
         "providers/anyscale",
         "providers/huggingface", 
         "providers/databricks",
+        "providers/deepgram",
         "providers/watsonx",
         "providers/predibase",
         "providers/nvidia_nim",