Add documentation for target storage

2026-08-17 02:23:32 +00:00 · 2025-12-12 22:44:53 +05:30
parent cf5dab7f52
commit 6f0efff28b
1 changed files with 147 additions and 0 deletions
@@ -159,3 +159,150 @@ print(completion.choices[0].message)
 </TabItem>
 </Tabs>

+## Azure Blob Storage Integration
+
+LiteLLM supports using Azure Blob Storage as a target storage backend for Gemini file uploads. This allows you to store files in Azure Data Lake Storage Gen2 instead of Google's managed storage.
+
+### Step 1: Setup Azure Blob Storage
+
+Configure your Azure Blob Storage account by setting the following environment variables:
+
+**Required Environment Variables:**
+- `AZURE_STORAGE_ACCOUNT_NAME` - Your Azure Storage account name
+- `AZURE_STORAGE_FILE_SYSTEM` - The container/filesystem name where files will be stored
+- `AZURE_STORAGE_ACCOUNT_KEY` - Your account key
+
+### Step 2: Pass Azure Blob Storage as Target Storage
+
+When uploading files, specify `target_storage: "azure_storage"` to use Azure Blob Storage instead of the default storage.
+
+**Supported File Types:**
+
+Azure Blob Storage supports all Gemini-compatible file types:
+
+- **Images**: PNG, JPEG, WEBP
+- **Audio**: AAC, FLAC, MP3, MPA, MPEG, MPGA, OPUS, PCM, WAV, WEBM
+- **Video**: FLV, MOV, MPEG, MPEGPS, MPG, MP4, WEBM, WMV, 3GPP
+- **Documents**: PDF, TXT
+
+> **Note:** Only small files can be sent as inline data because the total request size limit is 20 MB.
+
+
+### Step 3: Upload Files with Azure Blob Storage for Gemini
+
+<Tabs>
+<TabItem value="proxy" label="PROXY">
+
+1. Setup config.yaml
+
+```yaml
+model_list:
+    - model_name: "gemini-2.5-flash"
+      litellm_params:
+        model: gemini/gemini-2.5-flash
+        api_key: os.environ/GEMINI_API_KEY
+```
+
+2. Set environment variables
+
+```bash
+export AZURE_STORAGE_ACCOUNT_NAME="your-storage-account"
+export AZURE_STORAGE_FILE_SYSTEM="your-container-name"
+export AZURE_STORAGE_ACCOUNT_KEY="your-account-key"
+```
+or add them in your `.env`
+
+3. Start proxy
+
+```bash
+litellm --config config.yaml
+```
+
+4. Upload file with Azure Blob Storage
+
+```python
+from openai import OpenAI
+
+client = OpenAI(
+    base_url="http://0.0.0.0:4000",
+    api_key="sk-1234"
+)
+
+# Upload file to Azure Blob Storage
+file = client.files.create(
+    file=open("document.pdf", "rb"),
+    purpose="user_data",
+    extra_body={
+        "target_model_names": "gemini-2.0-flash",
+        "target_storage": "azure_storage"  # 👈 Use Azure Blob Storage
+    }
+)
+
+print(f"File uploaded to Azure Blob Storage: {file.id}")
+
+# Use the file with Gemini
+completion = client.chat.completions.create(
+    model="gemini-2.0-flash",
+    messages=[
+        {
+            "role": "user",
+            "content": [
+                {"type": "text", "text": "Summarize this document"},
+                {
+                    "type": "file",
+                    "file": {
+                        "file_id": file.id,
+                    }
+                }
+            ]
+        }
+    ]
+)
+
+print(completion.choices[0].message.content)
+```
+
+</TabItem>
+<TabItem value="curl" label="cURL">
+
+```bash
+# Upload file with Azure Blob Storage
+curl -X POST "http://0.0.0.0:4000/v1/files" \
+  -H "Authorization: Bearer sk-1234" \
+  -F "file=@document.pdf" \
+  -F "purpose=user_data" \
+  -F "target_storage=azure_storage" \
+  -F "target_model_names=gemini-2.0-flash" \
+  -F "custom_llm_provider=gemini"
+
+# Use the file with Gemini
+curl -X POST "http://0.0.0.0:4000/v1/chat/completions" \
+  -H "Authorization: Bearer sk-1234" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-2.0-flash",
+    "messages": [
+      {
+        "role": "user",
+        "content": [
+          {"type": "text", "text": "Summarize this document"},
+          {
+            "type": "file",
+            "file": {
+              "file_id": "file-id-from-upload",
+              "format": "application/pdf"
+            }
+          }
+        ]
+      }
+    ]
+  }'
+```
+
+</TabItem>
+</Tabs>
+
+:::info
+Files uploaded to Azure Blob Storage are stored in your Azure account and can be accessed via the returned file ID. The file URL format is: `https://{account}.blob.core.windows.net/{container}/{path}`
+:::
+