Refactor documentation structure and enhance content

This commit is contained in:
Arindam200 2026-03-17 02:40:46 +05:30
parent 57f2af8ea7
commit 9cf80132ed
6 changed files with 829 additions and 94 deletions

View file

@ -0,0 +1,58 @@
---
title: Guides
sidebar_label: Overview
---
import NavigationCards from '@site/src/components/NavigationCards';
**Guides** are focused references for specific LiteLLM SDK features and proxy configuration options. Each guide is self-contained — jump to any topic without reading the others first.
> Looking for step-by-step integration walkthroughs? See [Tutorials →](/docs/tutorials)
---
## Model Configuration
<NavigationCards
columns={2}
items={[
{
icon: "🎛️",
title: "Fine-tuned Models",
description: "Call fine-tuned OpenAI, Azure, and Vertex AI models using LiteLLM with custom model names.",
to: "/docs/guides/finetuned_models",
},
]}
/>
---
## Security & Networking
<NavigationCards
columns={2}
items={[
{
icon: "🔒",
title: "Security Settings",
description: "Configure SSL certificates and HTTP proxy settings for secure LiteLLM deployments.",
to: "/docs/guides/security_settings",
},
]}
/>
---
## AI Capabilities
<NavigationCards
columns={2}
items={[
{
icon: "🖥️",
title: "Code Interpreter",
description: "Use OpenAI's Code Interpreter tool to execute Python code in a secure, sandboxed environment.",
to: "/docs/guides/code_interpreter",
},
]}
/>

View file

@ -1,18 +1,342 @@
# Integrations
---
title: Integrations
sidebar_label: Overview
---
import NavigationCards from '@site/src/components/NavigationCards';
This section covers integrations with various tools and services that can be used with LiteLLM (either Proxy or SDK).
## AI Agent Frameworks
- **[Letta](./letta.md)** - Build stateful LLM agents with persistent memory using LiteLLM Proxy
---
## Development Tools
- **[OpenWebUI](../tutorials/openweb_ui.md)** - Self-hosted ChatGPT-style interface
## Observability
## Observability & Monitoring
- **[Langfuse](../observability/langfuse_integration.md)** - LLM observability and analytics
- **[Prometheus](../proxy/prometheus.md)** - Metrics collection and monitoring
- **[PagerDuty](../proxy/pagerduty.md)** - Incident response and alerting
- **[Datadog](../observability/datadog.md)**
Track, debug, and analyze LLM calls with observability platforms.
<NavigationCards
columns={3}
items={[
{
icon: "🪢",
title: "Langfuse",
description: "LLM observability and analytics.",
to: "../observability/langfuse_integration",
},
{
icon: "🐶",
title: "Datadog",
description: "Metrics, traces, and dashboards.",
to: "../observability/datadog",
},
{
icon: "📡",
title: "OpenTelemetry",
description: "Vendor-neutral tracing.",
to: "../observability/opentelemetry_integration",
},
{
icon: "🔗",
title: "LangSmith",
description: "LLM debugging and evaluation.",
to: "../observability/langsmith_integration",
},
{
icon: "🔥",
title: "Arize / Phoenix",
description: "ML observability and evaluation.",
to: "../observability/arize_integration",
},
{
icon: "🌀",
title: "Helicone",
description: "LLM request logging and analytics.",
to: "../observability/helicone_integration",
},
{
icon: "📊",
title: "MLflow",
description: "Experiment tracking.",
to: "../observability/mlflow",
},
{
icon: "🏋️",
title: "Weights & Biases",
description: "ML experiment tracking.",
to: "../observability/wandb_integration",
},
{
icon: "📉",
title: "PostHog",
description: "Product analytics.",
to: "../observability/posthog_integration",
},
]}
/>
Click into each section to learn more about the integrations.
[View all observability integrations →](../observability/callbacks.md)
---
## Alerting & Monitoring
Set up alerts, metrics collection, and infrastructure monitoring.
<NavigationCards
columns={2}
items={[
{
icon: "📈",
title: "Prometheus",
description: "Metrics collection and monitoring.",
to: "../proxy/prometheus",
},
{
icon: "🚨",
title: "PagerDuty",
description: "Incident response and alerting.",
to: "../proxy/pagerduty",
},
{
icon: "🔔",
title: "Alerting",
description: "Slack, Teams, and webhook alerts.",
to: "../proxy/alerting",
},
{
icon: "🔍",
title: "Pyroscope",
description: "Continuous profiling.",
to: "../proxy/pyroscope_profiling",
},
]}
/>
---
## Guardrails
Add safety and content filtering to LLM calls.
<NavigationCards
columns={3}
items={[
{
icon: "⚡",
title: "Quick Start",
description: "Get started with guardrails.",
to: "../proxy/guardrails/quick_start",
},
{
icon: "🛡️",
title: "Lakera AI",
description: "Prompt injection detection.",
to: "../proxy/guardrails/lakera_ai",
},
{
icon: "☁️",
title: "Azure Content Safety",
description: "Content moderation.",
to: "../proxy/guardrails/azure_content_guardrail",
},
{
icon: "🛏️",
title: "Bedrock Guardrails",
description: "AWS Bedrock safety.",
to: "../proxy/guardrails/bedrock",
},
{
icon: "🤖",
title: "OpenAI Moderation",
description: "OpenAI content policy.",
to: "../proxy/guardrails/openai_moderation",
},
{
icon: "🔐",
title: "Secret Detection",
description: "Prevent credential leaks.",
to: "../proxy/guardrails/secret_detection",
},
{
icon: "🕵️",
title: "PII Masking",
description: "Mask sensitive data.",
to: "../proxy/guardrails/pii_masking_v2",
},
]}
/>
[View all guardrail providers →](../proxy/guardrails/quick_start.md)
---
## Policies
Define and enforce usage policies across your LLM deployment.
<NavigationCards
columns={3}
items={[
{
icon: "📋",
title: "Guardrail Policies",
description: "Policy-based guardrail rules.",
to: "../proxy/guardrails/guardrail_policies",
},
{
icon: "🔀",
title: "Policy Flow Builder",
description: "Visual policy configuration.",
to: "../proxy/guardrails/policy_flow_builder",
},
{
icon: "📄",
title: "Policy Templates",
description: "Pre-built policy templates.",
to: "../proxy/guardrails/policy_templates",
},
]}
/>
---
## AI Tools
Connect LiteLLM to AI-powered coding and productivity tools.
<NavigationCards
columns={3}
items={[
{
icon: "💬",
title: "OpenWebUI",
description: "Self-hosted ChatGPT-style interface.",
to: "../tutorials/openweb_ui",
},
{
icon: "🤖",
title: "Claude Code",
description: "Use LiteLLM with Claude Code.",
to: "../tutorials/claude_responses_api",
},
{
icon: "🖱️",
title: "Cursor",
description: "AI code editor integration.",
to: "../tutorials/cursor_integration",
},
{
icon: "🐙",
title: "GitHub Copilot",
description: "GitHub Copilot integration.",
to: "../tutorials/github_copilot_integration",
},
{
icon: "💻",
title: "OpenCode",
description: "Open source coding assistant.",
to: "../tutorials/opencode_integration",
},
{
icon: "🔧",
title: "Retool Assist",
description: "Retool AI assistant.",
to: "../tutorials/retool_assist",
},
]}
/>
---
## Agent SDKs
Use LiteLLM with agent frameworks and SDKs.
<NavigationCards
columns={3}
items={[
{
icon: "🤖",
title: "OpenAI Agents SDK",
description: "Build agents with OpenAI's SDK.",
to: "../tutorials/openai_agents_sdk",
},
{
icon: "🧠",
title: "Claude Agent SDK",
description: "Build agents with Anthropic's SDK.",
to: "../tutorials/claude_agent_sdk",
},
{
icon: "🌐",
title: "Google ADK",
description: "Google Agent Development Kit.",
to: "../tutorials/google_adk",
},
{
icon: "🚀",
title: "CopilotKit",
description: "In-app AI copilots.",
to: "../tutorials/copilotkit_sdk",
},
{
icon: "🧬",
title: "Letta",
description: "Build stateful LLM agents with persistent memory.",
to: "./letta",
},
{
icon: "🎙️",
title: "LiveKit",
description: "Real-time voice and video AI agents.",
to: "../tutorials/livekit_xai_realtime",
},
]}
/>
---
## Prompt Management
Manage, version, and deploy prompts.
<NavigationCards
columns={3}
items={[
{
icon: "📝",
title: "LiteLLM Prompt Management",
description: "Built-in prompt management.",
to: "../proxy/litellm_prompt_management",
},
{
icon: "🔌",
title: "Custom Prompt Management",
description: "Bring your own prompt store.",
to: "../proxy/custom_prompt_management",
},
{
icon: "🔥",
title: "Arize Phoenix Prompts",
description: "Prompt management with Phoenix.",
to: "../proxy/arize_phoenix_prompts",
},
]}
/>
---
## Manage with AI Agents
Use AI agents to manage your LiteLLM deployment — create users, teams, keys, models, and more via natural language.
<NavigationCards
columns={1}
items={[
{
icon: "🤖",
title: "LiteLLM Skills",
description: "Manage LiteLLM via Claude Code — create keys, teams, models, and more using natural language commands.",
to: "../tutorials/claude_code_skills",
},
]}
/>

View file

@ -0,0 +1,141 @@
---
title: Learn LiteLLM
sidebar_label: Learn
slug: /learn
---
import NavigationCards from '@site/src/components/NavigationCards';
LiteLLM gives you a single OpenAI-compatible interface to 100+ LLM providers. Use this page to find the right starting point for where you are.
---
## 1. Make Your First Call
Set up your environment and call your first model.
<NavigationCards
columns={2}
items={[
{
icon: "⚡",
title: "Set Up Your Environment",
description: "Get API keys and configure your environment before making your first LLM call.",
to: "/docs/tutorials/installation",
},
{
icon: "🧪",
title: "Build an LLM Playground",
description: "Compare multiple LLM providers side by side in under 10 minutes with Streamlit.",
to: "/docs/tutorials/first_playground",
},
]}
/>
---
## 2. Connect Your Tools
Point your existing tools and frameworks at LiteLLM.
<NavigationCards
columns={2}
items={[
{
icon: "🛠️",
title: "AI Coding Tools",
description: "Route Claude Code, Cursor, GitHub Copilot, Gemini CLI, and OpenAI Codex through LiteLLM.",
to: "/docs/tutorials/cursor_integration",
},
{
icon: "🤖",
title: "Agent Frameworks",
description: "Use LiteLLM with OpenAI Agents SDK, Claude Agent SDK, Google ADK, CopilotKit, and more.",
to: "/docs/tutorials/openai_agents_sdk",
},
{
icon: "🐍",
title: "Provider Setup",
description: "Configure Azure OpenAI, HuggingFace, TogetherAI, local models, and 100+ other providers.",
to: "/docs/tutorials/azure_openai",
},
{
icon: "💬",
title: "Chat Interfaces",
description: "Connect LiteLLM to OpenWebUI, LangChain, and other chat frontends.",
to: "/docs/tutorials/openweb_ui",
},
]}
/>
---
## 3. Configure LiteLLM
Learn how specific SDK features and proxy options work.
<NavigationCards
columns={2}
items={[
{
icon: "🎛️",
title: "Fine-tuned Models",
description: "Call fine-tuned OpenAI, Azure, and Vertex AI models with custom model names.",
to: "/docs/guides/finetuned_models",
},
{
icon: "🔒",
title: "Security Settings",
description: "Configure SSL certificates and HTTP proxy settings for secure deployments.",
to: "/docs/guides/security_settings",
},
{
icon: "🖥️",
title: "Code Interpreter",
description: "Execute Python code in a secure sandbox via OpenAI's Code Interpreter tool.",
to: "/docs/guides/code_interpreter",
},
{
icon: "⚙️",
title: "Advanced Techniques",
description: "Prompt caching, model fallbacks, tag management, and provider-specific parameters.",
to: "/docs/tutorials/prompt_caching",
},
]}
/>
---
## 4. Run in Production
Add observability, access control, and safety to your deployment.
<NavigationCards
columns={2}
items={[
{
icon: "🔍",
title: "Observability & Safety",
description: "Logging to Elasticsearch, Aporia guardrails, and Presidio PII masking.",
to: "/docs/tutorials/elasticsearch_logging",
},
{
icon: "👥",
title: "Access Control & Administration",
description: "SSO, SCIM, team onboarding, and spend tracking.",
to: "/docs/tutorials/default_team_self_serve",
},
{
icon: "📊",
title: "Evaluation & Benchmarking",
description: "Compare models, run evaluation suites, and benchmark with LM Evaluation Harness.",
to: "/docs/tutorials/compare_llms",
},
{
icon: "📈",
title: "Integrations Overview",
description: "Langfuse, Datadog, Prometheus, Guardrails, Prompt Management, and more.",
to: "/docs/integrations",
},
]}
/>

View file

@ -0,0 +1,90 @@
---
title: Tutorials
sidebar_label: Overview
---
import NavigationCards from '@site/src/components/NavigationCards';
**Tutorials** are step-by-step walkthroughs for integrating LiteLLM with external tools, frameworks, and services — or building complete end-to-end workflows.
> Need help with a specific LiteLLM SDK feature or proxy config? See [Guides →](/docs/guides)
---
## Getting Started
<NavigationCards
columns={2}
items={[
{
icon: "⚡",
title: "Set Up Your Environment",
description: "Get your API keys for OpenAI, Cohere, and AI21 — no waitlist required — and configure your environment before making your first LLM call.",
to: "/docs/tutorials/installation",
},
{
icon: "🧪",
title: "Build an LLM Playground",
description: "Create a Streamlit playground to evaluate and compare multiple LLM providers side by side in under 10 minutes.",
to: "/docs/tutorials/first_playground",
},
]}
/>
---
## Browse All Tutorials
<NavigationCards
columns={2}
items={[
{
icon: "🤖",
title: "Agent Frameworks",
description: "OpenAI Agents SDK, Claude Agent SDK, Google ADK, CopilotKit, Letta, LiveKit, Instructor.",
to: "/docs/tutorials/openai_agents_sdk",
},
{
icon: "🛠️",
title: "AI Coding Tools",
description: "Claude Code, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Qwen Code, OpenAI Codex.",
to: "/docs/tutorials/cursor_integration",
},
{
icon: "🐍",
title: "Provider Setup",
description: "Step-by-step setup for Azure OpenAI, HuggingFace, TogetherAI, local models, and more.",
to: "/docs/tutorials/azure_openai",
},
{
icon: "📊",
title: "Evaluation & Benchmarking",
description: "Compare LLMs side by side, run evaluation suites, and benchmark with LM Evaluation Harness.",
to: "/docs/tutorials/compare_llms",
},
{
icon: "🔍",
title: "Observability & Safety",
description: "Send logs to Elasticsearch and other platforms. Add Aporia guardrails and Presidio PII masking.",
to: "/docs/tutorials/elasticsearch_logging",
},
{
icon: "👥",
title: "Access Control & Administration",
description: "Onboard users to default teams, configure Microsoft SSO, set up SCIM, and track spend.",
to: "/docs/tutorials/default_team_self_serve",
},
{
icon: "🎙️",
title: "Realtime & Audio",
description: "Build real-time audio apps with Gemini and xAI via the LiteLLM proxy.",
to: "/docs/tutorials/gemini_realtime_with_audio",
},
{
icon: "⚙️",
title: "Advanced Techniques",
description: "Prompt caching, model fallbacks, tag management, provider-specific parameters, and more.",
to: "/docs/tutorials/prompt_caching",
},
]}
/>

View file

@ -1,7 +1,3 @@
---
displayed_sidebar: tutorialSidebar
---
# Set up environment
Let's get the necessary keys to set up our demo environment.
@ -11,7 +7,5 @@ Every LLM provider needs API keys (e.g. `OPENAI_API_KEY`). You can get API keys
Let's get them for our demo!
**OpenAI**: https://platform.openai.com/account/api-keys
**Cohere**: https://dashboard.cohere.com/welcome/login?redirect_uri=%2Fapi-keys (no credit card required)
**Cohere**: https://dashboard.cohere.com/welcome/login?redirect_uri=%2Fapi-keys (no credit card required)
**AI21**: https://studio.ai21.com/account/api-key (no credit card required)

View file

@ -986,44 +986,7 @@ const sidebars = {
"providers/zai",
],
},
{
type: "category",
label: "Guides",
items: [
"budget_manager",
"completion/computer_use",
"completion/web_search",
"completion/web_fetch",
"completion/function_call",
"completion/audio",
"completion/document_understanding",
"completion/drop_params",
"completion/image_generation_chat",
"completion/json_mode",
"completion/knowledgebase",
"providers/anthropic_tool_search",
"guides/code_interpreter",
"completion/message_trimming",
"completion/message_sanitization",
"completion/model_alias",
"completion/mock_requests",
"completion/predict_outputs",
"completion/prefix",
"completion/prompt_caching",
"completion/prompt_formatting",
"completion/reliable_completions",
"completion/stream",
"completion/provider_specific_params",
"completion/vision",
"exception_mapping",
"completion/batching",
"guides/finetuned_models",
"guides/security_settings",
"proxy/veo_video_generation",
"reasoning_content",
"extras/creating_adapters",
]
},
{
type: "category",
@ -1058,43 +1021,6 @@ const sidebars = {
"load_test_rpm",
]
},
{
type: "category",
label: "Tutorials",
items: [
{
type: "link",
label: "AI Coding Tools (OpenWebUI, Claude Code, Gemini CLI, OpenAI Codex, etc.)",
href: "/docs/ai_tools",
},
"tutorials/anthropic_file_usage",
"tutorials/default_team_self_serve",
"tutorials/msft_sso",
"tutorials/prompt_caching",
"tutorials/tag_management",
'tutorials/litellm_proxy_aporia',
"tutorials/presidio_pii_masking",
"tutorials/elasticsearch_logging",
"tutorials/gemini_realtime_with_audio",
"tutorials/claude_code_beta_headers",
{
type: "category",
label: "LiteLLM Python SDK Tutorials",
items: [
'tutorials/azure_openai',
'tutorials/instructor',
"tutorials/gradio_integration",
"tutorials/huggingface_codellama",
"tutorials/huggingface_tutorial",
"tutorials/TogetherAI_liteLLM",
"tutorials/finetuned_chat_gpt",
"tutorials/text_completion",
"tutorials/first_playground",
"tutorials/model_fallbacks",
],
},
]
},
{
type: "category",
label: "Contributing",
@ -1197,4 +1123,206 @@ const sidebars = {
],
};
module.exports = sidebars;
const learnSidebar = {
learnSidebar: [
// ── Landing page ──────────────────────────────────────────────────
{ type: "doc", id: "learn/index", label: "Learn" },
// ── Guides ────────────────────────────────────────────────────────
{
type: "category",
label: "Guides",
collapsible: true,
collapsed: false,
link: { type: "doc", id: "guides/index" },
items: [
{
type: "category",
label: "Completion & Messaging",
collapsible: true,
collapsed: false,
items: [
"completion/stream",
"completion/function_call",
"completion/json_mode",
"completion/vision",
"completion/audio",
"completion/document_understanding",
"completion/image_generation_chat",
"completion/batching",
"completion/prefix",
"completion/predict_outputs",
"completion/provider_specific_params",
"reasoning_content",
{
type: "category",
label: "Prompt Config",
collapsible: true,
collapsed: true,
items: [
"completion/prompt_caching",
"completion/prompt_formatting",
],
},
"completion/drop_params",
"completion/message_trimming",
"completion/message_sanitization",
"completion/model_alias",
"completion/mock_requests",
"completion/reliable_completions",
],
},
{
type: "category",
label: "AI Capabilities",
collapsible: true,
collapsed: true,
items: [
"completion/web_search",
"completion/web_fetch",
"completion/computer_use",
"completion/knowledgebase",
"guides/code_interpreter",
"proxy/veo_video_generation",
{ type: "doc", id: "rag_ingest", label: "RAG Ingest" },
{ type: "doc", id: "rag_query", label: "RAG Query" },
],
},
{
type: "category",
label: "Models & Customization",
collapsible: true,
collapsed: true,
items: [
"guides/finetuned_models",
"guides/security_settings",
"budget_manager",
"extras/creating_adapters",
],
},
],
},
// ── Tutorials ─────────────────────────────────────────────────────
{
type: "category",
label: "Tutorials",
collapsible: true,
collapsed: false,
link: { type: "doc", id: "tutorials/index" },
items: [
{
type: "category",
label: "Getting Started",
collapsed: false,
items: [
"tutorials/first_playground",
"tutorials/installation",
"tutorials/text_completion",
"tutorials/mock_completion",
],
},
{
type: "category",
label: "Agent SDKs & Frameworks",
collapsed: true,
items: [
"tutorials/openai_agents_sdk",
"tutorials/claude_agent_sdk",
"tutorials/copilotkit_sdk",
"tutorials/google_adk",
"tutorials/livekit_xai_realtime",
"tutorials/instructor",
],
},
{
type: "category",
label: "AI Coding Tools",
collapsed: true,
items: [
"tutorials/openweb_ui",
{
type: "category",
label: "Claude Code",
collapsed: true,
items: [
"tutorials/claude_responses_api",
"tutorials/claude_code_max_subscription",
"tutorials/claude_code_customer_tracking",
"tutorials/claude_code_prompt_cache_routing",
"tutorials/claude_code_websearch",
"tutorials/claude_mcp",
"tutorials/claude_non_anthropic_models",
"tutorials/claude_code_plugin_marketplace",
"tutorials/claude_code_beta_headers",
],
},
"tutorials/cursor_integration",
"tutorials/github_copilot_integration",
"tutorials/opencode_integration",
"tutorials/openclaw_integration",
"tutorials/cost_tracking_coding",
"tutorials/litellm_gemini_cli",
"tutorials/litellm_qwen_code_cli",
"tutorials/openai_codex",
"tutorials/google_genai_sdk",
],
},
{
type: "category",
label: "Provider Tutorials",
collapsed: true,
items: [
"tutorials/azure_openai",
"tutorials/TogetherAI_liteLLM",
"tutorials/huggingface_codellama",
"tutorials/huggingface_tutorial",
"tutorials/finetuned_chat_gpt",
"tutorials/gradio_integration",
"tutorials/compare_llms",
"tutorials/litellm_Test_Multiple_Providers",
"tutorials/oobabooga",
],
},
{
type: "category",
label: "Proxy & Gateway",
collapsed: true,
items: [
"tutorials/default_team_self_serve",
"tutorials/msft_sso",
"tutorials/scim_litellm",
"tutorials/tag_management",
"tutorials/prompt_caching",
"tutorials/anthropic_file_usage",
],
},
{
type: "category",
label: "Observability & Safety",
collapsed: true,
items: [
"tutorials/elasticsearch_logging",
"tutorials/litellm_proxy_aporia",
"tutorials/presidio_pii_masking",
"tutorials/eval_suites",
"tutorials/lm_evaluation_harness",
],
},
{
type: "category",
label: "Advanced Features",
collapsed: true,
items: [
"tutorials/model_fallbacks",
"tutorials/fallbacks",
"tutorials/provider_specific_params",
"tutorials/gemini_realtime_with_audio",
],
},
],
},
],
};
module.exports = { ...sidebars, ...learnSidebar };