From 52564b685ce4b79515842f2cc54c53da47eb79f1 Mon Sep 17 00:00:00 2001
From: Krrish Dholakia <krrishdholakia@gmail.com>
Date: Thu, 14 Dec 2023 12:03:29 -0800
Subject: [PATCH] docs(openai_compatible.md): add docs on calling openai
 compatible endpoints via litellm pkg

---
 .../docs/providers/openai_compatible.md       | 47 +++++++++++++++++++
 docs/my-website/sidebars.js                   |  1 +
 2 files changed, 48 insertions(+)
 create mode 100644 docs/my-website/docs/providers/openai_compatible.md

diff --git a/docs/my-website/docs/providers/openai_compatible.md b/docs/my-website/docs/providers/openai_compatible.md
new file mode 100644
index 000000000..ff68d7a00
--- /dev/null
+++ b/docs/my-website/docs/providers/openai_compatible.md
@@ -0,0 +1,47 @@
+# OpenAI-Compatible Endpoints
+
+To call models hosted behind an openai proxy, make 2 changes:
+
+1. Put `openai/` in front of your model name, so litellm knows you're trying to call an openai-compatible endpoint. 
+
+2. **Do NOT** add anything additional to the base url e.g. `/v1/embedding`. LiteLLM uses the openai-client to make these calls, and that automatically adds the relevant endpoints. 
+
+## Usage
+
+```python
+import litellm
+from litellm import embedding
+litellm.set_verbose = True
+import os
+
+ 
+litellm_proxy_endpoint = "http://0.0.0.0:8000"
+bearer_token = "sk-1234"
+
+CHOSEN_LITE_LLM_EMBEDDING_MODEL = "openai/GPT-J 6B - Sagemaker Text Embedding (Internal)"
+
+litellm.set_verbose = False
+
+print(litellm_proxy_endpoint)
+
+ 
+
+response = embedding(
+
+    model = CHOSEN_LITE_LLM_EMBEDDING_MODEL,     # add `openai/` prefix to model so litellm knows to route to OpenAI
+
+    api_key=bearer_token,
+
+    api_base=litellm_proxy_endpoint,       # set API Base of your Custom OpenAI Endpoint
+
+    input=["good morning from litellm"],
+
+    api_version='2023-07-01-preview'
+
+)
+
+print('================================================')
+
+print(len(response.data[0]['embedding']))
+
+```
\ No newline at end of file
diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js
index 082c4247e..8ba176d21 100644
--- a/docs/my-website/sidebars.js
+++ b/docs/my-website/sidebars.js
@@ -61,6 +61,7 @@ const sidebars = {
       },
       items: [
         "providers/openai", 
+        "providers/openai_compatible",
         "providers/azure", 
         "providers/huggingface", 
         "providers/ollama",