From fcff488e26a4d87e1b09e959b35817f98bb04738 Mon Sep 17 00:00:00 2001 From: Seven <88984809@qq.com> Date: Mon, 13 Jul 2026 15:47:41 +0800 Subject: [PATCH 1/4] docs(providers): add DaoXE multi-model gateway guide --- docs/providers/daoxe.md | 133 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 docs/providers/daoxe.md diff --git a/docs/providers/daoxe.md b/docs/providers/daoxe.md new file mode 100644 index 00000000..01ccafce --- /dev/null +++ b/docs/providers/daoxe.md @@ -0,0 +1,133 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# DaoXE +https://daoxe.com + +:::tip + +**LiteLLM supports DaoXE OpenAI-compatible models via `model=daoxe/`.** + +DaoXE is a multi-model multi-protocol API gateway (OpenAI Chat Completions / Responses, Anthropic Messages for other clients). Model IDs are account-scoped — copy an exact ID from your DaoXE catalog or authenticated `GET /v1/models`. DaoXE is not available in mainland China. + +::: + +## API Key +```python +import os +os.environ['DAOXE_API_KEY'] +# optional override: +# os.environ['DAOXE_API_BASE'] # defaults to https://daoxe.com/v1 +``` + +## Sample Usage +```python +from litellm import completion +import os + +os.environ['DAOXE_API_KEY'] = "" +response = completion( + model="daoxe/YOUR_ACCOUNT_MODEL_ID", + messages=[ + {"role": "user", "content": "hello from litellm"} + ], + max_tokens=8, +) +print(response) +``` + +## Sample Usage - Streaming +```python +from litellm import completion +import os + +os.environ['DAOXE_API_KEY'] = "" +response = completion( + model="daoxe/YOUR_ACCOUNT_MODEL_ID", + messages=[ + {"role": "user", "content": "hello from litellm"} + ], + stream=True, + max_tokens=8, +) + +for chunk in response: + print(chunk) +``` + +## Sample Usage - Responses API +```python +from litellm import responses +import os + +os.environ['DAOXE_API_KEY'] = "" +response = responses( + model="daoxe/YOUR_ACCOUNT_MODEL_ID", + input="Reply with OK", +) +print(response) +``` + +## Usage with LiteLLM Proxy + +### 1. Set DaoXE on config.yaml + +```yaml +model_list: + - model_name: daoxe + litellm_params: + model: daoxe/YOUR_ACCOUNT_MODEL_ID + api_key: "os.environ/DAOXE_API_KEY" +``` + +### 2. Start Proxy + +``` +litellm --config config.yaml +``` + +### 3. Test it + + + + +```shell +curl --location 'http://0.0.0.0:4000/chat/completions' \ +--header 'Content-Type: application/json' \ +--data ' { + "model": "daoxe", + "messages": [ + { + "role": "user", + "content": "what llm are you" + } + ], + "max_tokens": 8 + } +' +``` + + + +```python +import openai +client = openai.OpenAI( + api_key="anything", + base_url="http://0.0.0.0:4000" +) + +response = client.chat.completions.create( + model="daoxe", + messages=[{"role": "user", "content": "this is a test request"}], + max_tokens=8, +) +print(response) +``` + + + +## Notes + +- Prefer live model discovery over hardcoded lists +- Disclosure: this page was contributed by someone affiliated with DaoXE +- Public client examples: https://github.com/seven7763/DaoXE-AI From e900a1ef61e0fb386d4ab33049fe189509ec499d Mon Sep 17 00:00:00 2001 From: Seven <88984809@qq.com> Date: Mon, 13 Jul 2026 15:48:01 +0800 Subject: [PATCH 2/4] docs(providers): register DaoXE in sidebars --- sidebars.js | 1300 +-------------------------------------------------- 1 file changed, 1 insertion(+), 1299 deletions(-) diff --git a/sidebars.js b/sidebars.js index 1f7ffa24..91989bd3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -342,1302 +342,4 @@ const sidebars = { { type: "doc", id: "text_completion", - label: "text_completion()", - }, - { - type: "doc", - id: "image_generation", - label: "image_generation()", - }, - { - type: "doc", - id: "completion/prompt_compression", - label: "compress()", - }, - { - type: "doc", - id: "audio_transcription", - label: "transcription()", - }, - { - type: "doc", - id: "text_to_speech", - label: "speech()", - }, - { - type: "doc", - id: "sandbox", - label: "acode_interpreter_tool()", - }, - { - type: "link", - label: "All Supported Endpoints →", - href: "https://docs.litellm.ai/docs/supported_endpoints", - }, - ], - }, - { - type: "category", - label: "Configuration", - items: [ - "set_keys", - "proxy_auth", - "caching/all_caches", - ], - }, - "completion/token_usage", - "exception_mapping", - ], - }, - { - type: "category", - label: "LiteLLM AI Gateway (Proxy)", - link: { - type: "generated-index", - title: "LiteLLM AI Gateway (LLM Proxy)", - description: `OpenAI Proxy Server (LLM Gateway) to call 100+ LLMs in a unified interface & track spend, set budgets per virtual key/user`, - slug: "/simple_proxy", - }, - items: [ - { type: "doc", id: "proxy/docker_quick_start", label: "Getting Started Tutorial" }, - { - type: "category", - label: "Agent & MCP Gateway", - items: [ - { - type: "category", - label: "A2A Agent Gateway", - items: [ - "a2a", - "a2a_agent_card", - "a2a_invoking_agents", - "a2a_agent_headers", - "a2a_cost_tracking", - "a2a_agent_permissions", - "a2a_iteration_budgets", - ], - }, - { - type: "category", - label: "MCP Gateway", - items: [ - "mcp", - "mcp_usage", - "mcp_rest_api", - "mcp_openapi", - "mcp_oauth", - "mcp_obo_auth", - "mcp_aws_sigv4", - "mcp_zero_trust", - "mcp_public_internet", - "mcp_deployment", - "mcp_semantic_filter", - "mcp_tool_search", - "mcp_control", - "mcp_cost", - "mcp_guardrail", - "mcp_server_submissions", - "mcp_toolsets", - { - type: "link", - label: "MCP Troubleshooting Guide", - href: "/docs/mcp_troubleshoot" - }, - ], - }, - { - type: "category", - label: "Skills Gateway", - items: [ - "skills_gateway", - ], - }, - { type: "doc", id: "auth_overview", label: "Gateway Auth Reference" }, - ], - }, - { - "type": "category", - "label": "Config.yaml", - "items": ["proxy/configs", "proxy/config_management", "proxy/config_settings"] - }, - { - type: "category", - label: "Setup & Deployment", - items: [ - "proxy/quick_start", - "proxy/cli", - "proxy/debugging", - "proxy/error_diagnosis", - "proxy/deploy", - "proxy/deploy_cloud", - "proxy/microservices_helm", - "proxy/docker_image_security", - "proxy/health", - "proxy/master_key_rotations", - "proxy/model_management", - "proxy/prod", - "proxy/multi_region", - "proxy/worker_startup_hooks", - "proxy/release_cycle", - ], - }, - { - type: "category", - label: "Admin UI", - items: [ - "proxy/ui", - { - type: "category", - label: "Setup & SSO", - items: [ - "proxy/admin_ui_sso", - "proxy/ui/ui_edit_logo", - "proxy/custom_sso", - "proxy/custom_root_ui", - "proxy/plugins", - "tutorials/scim_litellm", - ] - }, - { - type: "category", - label: "Models", - items: [ - "proxy/ui_credentials", - "proxy/ai_hub", - "proxy/model_compare_ui", - "proxy/ui_store_model_db_setting", - "proxy/ui/routing_groups", - ] - }, - { - type: "category", - label: "Teams & Organizations", - items: [ - { - type: "link", - label: "Role-based Access Controls (RBAC) →", - href: "/docs/proxy/access_control" - }, - "proxy/self_serve", - "proxy/public_teams", - "proxy/ui_project_management", - "proxy/ui_search_tools", - "proxy/ui/bulk_edit_users", - "proxy/ui/page_visibility", - ] - }, - { - type: "category", - label: "Observability: Usage", - items: [ - "proxy/customer_usage", - "proxy/endpoint_activity", - ] - }, - { - type: "category", - label: "Logs", - items: [ - "proxy/ui_logs", - "proxy/ui_spend_log_settings", - "proxy/ui_logs_sessions", - "proxy/deleted_keys_teams", - ] - } - ], - }, - { - type: "category", - label: "Architecture", - items: [ - "proxy/architecture", - "proxy/multi_tenant_architecture", - "proxy/high_availability_control_plane", - "proxy/db_deadlocks", - "proxy/db_info", - "proxy/db_read_replica", - "proxy/image_handling", - "proxy/key_auth_arch", - "proxy/jwt_auth_arch", - "proxy/spend_logs_deletion", - "proxy/user_management_heirarchy", - "router_architecture" - ], - }, - { - type: "link", - label: "All Endpoints (Swagger)", - href: "https://litellm-api.up.railway.app/", - }, - { - type: "category", - label: "Authentication", - items: [ - "proxy/virtual_keys", - "proxy/token_auth", - "proxy/jwt_key_mapping", - { - type: "doc", - id: "proxy/identity_provisioning", - label: "Provisioning & Keys", - }, - "proxy/service_accounts", - "proxy/access_control", - "proxy/cli_sso", - "proxy/custom_auth", - "proxy/ip_address", - "proxy/multiple_admins", - "proxy/public_routes", - ], - }, - { - type: "category", - label: "Budgets + Rate Limits", - items: [ - "proxy/users", - "proxy/team_budgets", - "proxy/project_management", - "proxy/ui_team_soft_budget_alerts", - "proxy/tag_budgets", - "proxy/customers", - "proxy/dynamic_rate_limit", - "proxy/io_token_rate_limits", - "proxy/rate_limit_tiers", - "proxy/temporary_budget_increase", - "proxy/budget_reset_and_tz", - "proxy/budget_fallbacks", - ], - }, - "proxy/caching", - "proxy/memory", - { - type: "category", - label: "Guardrails", - items: [ - "proxy/guardrails/quick_start", - "proxy/guardrails/team_based_guardrails", - "proxy/guardrails/guardrail_load_balancing", - "proxy/guardrails/test_playground", - "proxy/guardrails/litellm_content_filter", - "proxy/guardrails/realtime_guardrails", - { - type: "link", - label: "Providers →", - href: "/docs/guardrail_providers", - }, - { - type: "category", - label: "Contributing to Guardrails", - items: [ - "adding_provider/generic_guardrail_api", - "adding_provider/simple_guardrail_tutorial", - "adding_provider/adding_guardrail_support", - ] - }, - ], - }, - { - type: "category", - label: "Policies", - items: [ - "proxy/guardrails/guardrail_policies", - "proxy/guardrails/policy_flow_builder", - "proxy/guardrails/policy_templates", - "proxy/guardrails/policy_tags", - ], - }, - { - type: "category", - label: "Create Custom Plugins", - description: "Modify requests, responses, and more", - items: [ - "proxy/call_hooks", - "proxy/agentic_loop_hook", - "proxy/rules", - ] - }, - "proxy/management_cli", - { - type: "link", - label: "Load Balancing, Routing, Fallbacks (Failover)", - href: "https://docs.litellm.ai/docs/routing-load-balancing", - }, - "traffic_mirroring", - { - type: "category", - label: "Logging, Alerting, Metrics", - items: [ - "proxy/dynamic_logging", - "proxy/logging", - "proxy/logging_spec", - "proxy/team_logging", - "proxy/email", - ], - }, - { - type: "category", - label: "Making LLM Requests", - items: [ - "proxy/user_keys", - "proxy/clientside_auth", - "proxy/request_headers", - "proxy/response_headers", - "proxy/forward_client_headers", - "proxy/model_discovery", - ], - }, - { - type: "category", - label: "Model Access", - items: [ - "proxy/model_access_guide", - "proxy/model_access", - "proxy/model_access_groups", - "proxy/access_groups", - "proxy/team_model_add", - "proxy/credential_routing" - ] - }, - { - type: "category", - label: "Secret Managers", - items: [ - "secret_managers/overview", - "secret_managers/aws_secret_manager", - "secret_managers/aws_kms", - "secret_managers/azure_key_vault", - "secret_managers/cyberark", - "secret_managers/google_secret_manager", - "secret_managers/google_kms", - "secret_managers/hashicorp_vault", - "secret_managers/custom_secret_manager", - "oidc" - ] - }, - { - type: "category", - label: "Spend Tracking", - items: [ - "proxy/cost_tracking", - "tutorials/vertex_ai_pay_go", - "proxy/request_tags", - "proxy/custom_pricing", - "proxy/custom_model_cost_map", - "proxy/pricing_calculator", - "proxy/provider_margins", - "proxy/provider_discounts", - "proxy/sync_models_github", - "proxy/billing", - ], - }, - { - type: "category", - label: "Cost Optimization", - items: [ - "proxy/auto_routing", - "adaptive_router", - { - type: "link", - label: "Prompt Compression", - href: "/docs/completion/prompt_compression#server-side-callback-loop-v1messages", - }, - "proxy/headroom", - ], - }, - ] - }, - { - type: "category", - label: "Supported Endpoints", - link: { - type: "generated-index", - title: "Supported Endpoints", - description: - "Learn how to deploy + call models from different providers on LiteLLM", - slug: "/supported_endpoints", - }, - items: [ - { - type: "link", - label: "/a2a - A2A Agent Gateway", - href: "/docs/a2a", - }, - "assistants", - "audio_transcription", - "text_to_speech", - { - type: "category", - label: "/batches", - items: [ - "batches", - "proxy/managed_batches", - "proxy/unmanaged_vertex_batches", - ] - }, - "containers", - "container_files", - { - type: "category", - label: "/chat/completions", - link: { - type: "generated-index", - title: "Chat Completions", - description: "Details on the completion() function", - slug: "/completion", - }, - items: [ - "completion/input", - "completion/output", - "completion/usage", - "completion/http_handler_config", - ], - }, - "text_completion", - "bedrock_converse", - "embedding/supported_embedding", - { - type: "category", - label: "/files", - items: [ - "files_endpoints", - "proxy/litellm_managed_files", - ], - }, - { - type: "category", - label: "/fine_tuning", - items: [ - "fine_tuning", - "proxy/managed_finetuning", - ] - }, - "evals_api", - "generateContent", - "apply_guardrail", - "bedrock_invoke", - "interactions", - "managed_agents", - "memory_management", - "image_edits", - "image_generation", - "image_variations", - "videos", - "vector_store_files", - "vector_stores/create", - "vector_stores/search", - { - type: "category", - label: "/mcp - Model Context Protocol", - items: [ - "mcp", - "mcp_usage", - "mcp_rest_api", - "mcp_openapi", - "mcp_oauth", - "mcp_obo_auth", - "mcp_aws_sigv4", - "mcp_zero_trust", - "mcp_public_internet", - "mcp_deployment", - "mcp_semantic_filter", - "mcp_tool_search", - "mcp_control", - "mcp_cost", - "mcp_guardrail", - "mcp_server_submissions", - "mcp_zero_trust", - "mcp_troubleshoot", - ] - }, - { - type: "category", - label: "/v1/messages", - items: [ - "anthropic_unified/index", - "anthropic_unified/structured_output", - "anthropic_unified/messages_to_responses_mapping", - ] - }, - "count_tokens", - "anthropic_count_tokens", - "moderation", - "ocr", - { - type: "category", - label: "Pass-through Endpoints (Anthropic SDK, etc.)", - items: [ - "pass_through/intro", - "pass_through/anthropic_completion", - "pass_through/assembly_ai", - "pass_through/bedrock", - "pass_through/azure_passthrough", - "pass_through/cohere", - "pass_through/cursor", - "pass_through/google_ai_studio", - "pass_through/langfuse", - "pass_through/mistral", - "pass_through/openai_passthrough", - "proxy/passthrough_managed_ids", - { - type: "category", - label: "Vertex AI", - items: [ - "pass_through/vertex_ai", - "pass_through/vertex_ai_live_websocket", - "pass_through/vertex_ai_search_datastores", - ] - }, - "pass_through/vllm", - "proxy/pass_through", - "proxy/pass_through_guardrails" - ] - }, - "rag_ingest", - "rag_query", - "realtime", - "proxy/realtime_webrtc", - "rerank", - "response_api", - "prompt_management", - "response_api_compact", - { - type: "category", - label: "/search", - items: [ - "search/index", - "search/perplexity", - "search/tavily", - "search/exa_ai", - "search/brave", - "search/parallel_ai", - "search/google_pse", - "search/dataforseo", - "search/firecrawl", - "search/searxng", - "search/linkup", - "search/serper", - "search/you_com", - "search/apiserpent", - ] - }, - "skills", - - ], - }, - { - type: "category", - label: "Supported Models & Providers", - link: { - type: "generated-index", - title: "Providers", - description: - "Learn how to deploy + call models from different providers on LiteLLM", - slug: "/providers", - }, - items: [ - { - type: "doc", - id: "provider_registration/index", - label: "Integrate as a Model Provider", - }, - { - type: "doc", - id: "contributing/adding_openai_compatible_providers", - label: "Add OpenAI-Compatible Provider (JSON)", - }, - { - type: "doc", - id: "provider_registration/add_model_pricing", - label: "Add Model Pricing & Context Window", - }, - { - type: "category", - label: "OpenAI", - items: [ - "providers/openai", - "providers/openai/responses_api", - "providers/openai/text_to_speech", - "providers/openai/videos", - ] - }, - "providers/text_completion_openai", - "providers/openai_compatible", - { - type: "category", - label: "Azure OpenAI", - items: [ - "providers/azure/azure", - "providers/azure/azure_responses", - "providers/azure/azure_embedding", - "providers/azure/azure_speech", - "providers/azure/videos", - ] - }, - { - type: "category", - label: "Azure AI", - items: [ - "providers/azure_ai", - "providers/azure_ai/azure_model_router", - "providers/azure_ai_agents", - "providers/azure_ocr", - "providers/azure_document_intelligence", - "providers/azure_ai_speech", - "providers/azure_ai_img", - "providers/azure_ai_vector_stores", - "providers/azure_ai/azure_ai_vector_stores_passthrough", - ] - }, - { - type: "category", - label: "Vertex AI", - items: [ - "providers/vertex", - "providers/vertex_ai/videos", - "providers/vertex_partner", - "providers/vertex_self_deployed", - "providers/vertex_embedding", - "providers/vertex_image", - "providers/vertex_speech", - "providers/vertex_batch", - "providers/vertex_ocr", - "providers/vertex_ai_agent_engine", - "providers/vertex_realtime", - ] - }, - { - type: "category", - label: "Google AI Studio", - items: [ - "providers/gemini", - "providers/gemini/videos", - "providers/gemini/music", - "providers/google_ai_studio/files", - "providers/google_ai_studio/image_gen", - "providers/google_ai_studio/realtime", - ] - }, - "providers/anthropic", - "providers/anthropic_tool_search", - "providers/aws_sagemaker", - { - type: "category", - label: "Bedrock", - items: [ - "providers/bedrock", - "providers/bedrock_embedding", - "providers/bedrock_imported", - "providers/bedrock_image_gen", - "providers/bedrock_rerank", - "providers/bedrock_agentcore", - "providers/bedrock_agents", - "providers/bedrock_writer", - "providers/bedrock_batches", - "providers/bedrock_realtime_with_audio", - "providers/aws_polly", - "providers/bedrock_vector_store", - "providers/bedrock_mantle", - ] - }, - "providers/litellm_proxy", - "providers/abliteration", - "providers/ai21", - "providers/aiml", - "providers/aleph_alpha", - "providers/amazon_nova", - "providers/anyscale", - "providers/apertis", - "providers/baseten", - "providers/black_forest_labs", - "providers/black_forest_labs_img_edit", - "providers/bytez", - "providers/cerebras", - "providers/chutes", - "providers/clarifai", - "providers/cloudflare_workers", - "providers/codestral", - "providers/cohere", - "providers/cometapi", - "providers/compactifai", - "providers/crusoe", - "providers/custom_llm_server", - "providers/dashscope", - "providers/databricks", - "providers/datarobot", - "providers/deepgram", - "providers/deepinfra", - "providers/deepseek", - "providers/docker_model_runner", - "providers/elevenlabs", - "providers/empiriolabs", - "providers/fal_ai", - "providers/featherless_ai", - "providers/fireworks_ai", - "providers/friendliai", - "providers/galadriel", - "providers/github", - "providers/github_copilot", - "providers/gmi", - "providers/chatgpt", - "providers/gradient_ai", - "providers/groq", - "providers/helicone", - "providers/heroku", - { - type: "category", - label: "HuggingFace", - items: [ - "providers/huggingface", - "providers/huggingface_rerank", - ] - }, - "providers/hyperbolic", - "providers/inception", - "providers/infinity", - "providers/jina_ai", - "providers/lambda_ai", - "providers/langgraph", - "providers/lemonade", - "providers/llamafile", - "providers/llamagate", - "providers/lm_studio", - "providers/manus", - "providers/meta", - "providers/meta_llama", - "providers/milvus_vector_stores", - "providers/mistral", - "providers/minimax", - "providers/moonshot", - "providers/morph", - "providers/nebius", - "providers/nlp_cloud", - "providers/nano-gpt", - "providers/novita", - { type: "doc", id: "providers/nscale", label: "Nscale (EU Sovereign)" }, - { - type: "category", - label: "Nvidia NIM", - items: [ - "providers/nvidia_nim", - "providers/nvidia_nim_rerank", - ] - }, - "providers/nvidia_riva", - "providers/oci", - "providers/ollama", - "providers/openrouter", - "providers/sarvam", - "providers/ovhcloud", - { - type: "category", - label: "Perplexity AI", - items: [ - "providers/perplexity", - "providers/perplexity_embedding", - ] - }, - "providers/petals", - "providers/poe", - "providers/publicai", - "providers/predibase", - "providers/pydantic_ai_agent", - "providers/ragflow", - "providers/recraft", - "providers/replicate", - { - type: "category", - label: "RunwayML", - items: [ - "providers/runwayml/images", - "providers/runwayml/videos", - ] - }, - "providers/sambanova", - "providers/sap", - "providers/scaleway", - "providers/stability", - "providers/synthetic", - "providers/snowflake", - "providers/tencent", - "providers/tensormesh", - "providers/togetherai", - "providers/topaz", - "providers/triton-inference-server", - "providers/v0", - "providers/vercel_ai_gateway", - { - type: "category", - label: "vLLM", - items: [ - "providers/vllm", - "providers/vllm_batches", - ] - }, - "providers/volcano", - "providers/voyage", - "providers/wandb_inference", - { - type: "category", - label: "WatsonX", - items: [ - "providers/watsonx/index", - "providers/watsonx/audio_transcription", - ] - }, - { - type: "category", - label: "xAI", - items: [ - "providers/xai", - "providers/xai_realtime", - ] - }, - "providers/xiaomi_mimo", - "providers/xinference", - "providers/zai", - ], - }, - - - { - type: "category", - label: "Routing & Load Balancing", - link: { - type: "generated-index", - title: "Routing & Load Balancing", - description: "Learn how to load balance, route, and set fallbacks (provider failover) for your LLM requests", - slug: "/routing-load-balancing", - }, - items: [ - "routing", - "adaptive_router", - "scheduler", - "proxy/auto_routing", - "proxy/load_balancing", - "proxy/keys_teams_router_settings", - "proxy/provider_budget_routing", - "proxy/reliability", - "proxy/fallback_management", - "proxy/tag_routing", - "proxy/timeout", - "wildcard_routing", - "proxy/health_check_routing" - ], - }, - "benchmarks", - { - type: "category", - label: "Contributing", - items: [ - "extras/contributing_code", - { - type: "category", - label: "Adding Providers", - items: [ - "contributing/adding_openai_compatible_providers", - "adding_provider/directory_structure", - "adding_provider/new_rerank_provider", - ] - }, - "extras/contributing", - "contributing", - ] - }, - { - type: "category", - label: "Extras", - items: [ - "sdk_custom_pricing", - "migration", - "data_security", - "proxy/security_encryption_faq", - "migration_policy", - "load_test_advanced", - "load_test_sdk", - "load_test_rpm", - { - type: "category", - label: "❤️ 🚅 Projects built on LiteLLM", - link: { - type: "generated-index", - title: "Projects built on LiteLLM", - description: - "Learn how to deploy + call models from different providers on LiteLLM", - slug: "/project", - }, - items: [ - "projects/smolagents", - "projects/mini-swe-agent", - "projects/openai-agents", - "projects/Google ADK", - "projects/Agent Lightning", - "projects/Harbor", - "projects/CompatCanary", - "projects/GraphRAG", - "projects/Docq.AI", - "projects/PDL", - "projects/OpenInterpreter", - "projects/Elroy", - "projects/dbally", - "projects/FastREPL", - "projects/PROMPTMETHEUS", - "projects/Codium PR Agent", - "projects/Prompt2Model", - "projects/SalesGPT", - "projects/Softgen", - "projects/Quivr", - "projects/Langstream", - "projects/Otter", - "projects/YiVal", - "projects/llm_cord", - "projects/pgai", - "projects/GPTLocalhost", - "projects/HolmesGPT", - "projects/Railtracks", - ], - }, - "extras/code_quality", - "rules", - "proxy/team_based_routing", - "proxy/customer_routing", - "proxy_server", - ], - }, - { - type: "category", - label: "Troubleshooting", - items: [ - "troubleshoot/ui_issues", - "troubleshoot/cost_discrepancy", - "mcp_troubleshoot", - { - type: "category", - label: "Performance / Latency", - items: [ - "troubleshoot/latency_overhead", - "troubleshoot/cpu_issues", - "troubleshoot/memory_issues", - "troubleshoot/spend_queue_warnings", - "troubleshoot/max_callbacks", - "troubleshoot/prisma_migrations", - ], - }, - "troubleshoot/pip_venv_upgrade", - "troubleshoot/rollback", - "troubleshoot", - ], - }, - ], -}; - -const learnSidebar = { - learnSidebar: [ - // ── Landing page ────────────────────────────────────────────────── - { type: "doc", id: "learn/index", label: "Learn" }, - { - type: "category", - label: "Start Here", - collapsible: true, - collapsed: false, - items: [ - "learn/sdk_quickstart", - "learn/gateway_quickstart", - "learn/enterprise_quickstart", - ], - }, - - // ── Guides ──────────────────────────────────────────────────────── - { - type: "category", - label: "Guides", - collapsible: true, - collapsed: false, - link: { type: "doc", id: "guides/index" }, - items: [ - { - type: "category", - label: "Core Requests", - collapsible: true, - collapsed: false, - link: { - type: "generated-index", - title: "Core Requests", - description: "Streaming, batching, structured outputs, and reasoning behavior", - slug: "/guides/core_request_response_patterns" - }, - items: [ - "completion/stream", - "completion/batching", - "completion/json_mode", - "reasoning_content", - ], - }, - { - type: "category", - label: "Tool Calling", - collapsible: true, - collapsed: true, - link: { - type: "generated-index", - title: "Tool Calling", - description: "Function calling, web tools, interception patterns, computer use, code interpreter, and tool-call hygiene", - slug: "/guides/tools_integrations" - }, - items: [ - "completion/function_call", - "completion/web_search", - { - type: "doc", - id: "integrations/websearch_interception", - label: "Web Search Interception", - }, - "completion/web_fetch", - "completion/computer_use", - "guides/code_interpreter", - { - type: "doc", - id: "sandbox", - label: "Code Interpreter Sandbox Interception", - }, - "completion/anthropic_advisor_tool", - "completion/message_sanitization", - ], - }, - { - type: "category", - label: "Multimodal I/O", - collapsible: true, - collapsed: true, - link: { - type: "generated-index", - title: "Multimodal I/O", - description: "Vision, audio, PDFs, image generation, and video generation", - slug: "/guides/multimodal_io" - }, - items: [ - "completion/vision", - "completion/audio", - "completion/document_understanding", - "completion/image_generation_chat", - "proxy/veo_video_generation", - ], - }, - { - type: "category", - label: "Retrieval & Knowledge", - collapsible: true, - collapsed: true, - link: { - type: "generated-index", - title: "Retrieval & Knowledge", - description: "Vector stores, file search, citations, and knowledge-base routing", - slug: "/guides/retrieval_knowledge" - }, - items: [ - "completion/knowledgebase", - ], - }, - { - type: "category", - label: "Prompts & Context", - collapsible: true, - collapsed: true, - link: { - type: "generated-index", - title: "Prompts & Context", - description: "Prompt caching, trimming, formatting, assistant prefill, and predicted outputs", - slug: "/guides/prompts_context" - }, - items: [ - "completion/prefix", - "completion/predict_outputs", - "completion/prompt_compression", - "completion/message_trimming", - "completion/prompt_caching", - "completion/prompt_formatting", - ], - }, - { - type: "category", - label: "Compatibility & Extensibility", - collapsible: true, - collapsed: true, - link: { - type: "generated-index", - title: "Compatibility & Extensibility", - description: "Provider-specific params, model aliases, fine-tuned models, and adapters", - slug: "/guides/compatibility_extensibility" - }, - items: [ - "completion/provider_specific_params", - "completion/drop_params", - "completion/model_alias", - "guides/finetuned_models", - "extras/creating_adapters", - ], - }, - { - type: "category", - label: "Reliability, Testing & Spend", - collapsible: true, - collapsed: true, - link: { - type: "generated-index", - title: "Reliability, Testing & Spend", - description: "Retries, fallbacks (failover), mock responses, and budget controls", - slug: "/guides/reliability_testing_spend" - }, - items: [ - "completion/mock_requests", - "completion/reliable_completions", - ], - }, - { - type: "category", - label: "Security & Network", - collapsible: true, - collapsed: true, - link: { - type: "generated-index", - title: "Security & Network", - description: "SSL, custom CA bundles, HTTP proxy settings, and per-service verification", - slug: "/guides/security_network" - }, - items: [ - "guides/security_settings", - ], - }, - ], - }, - - // ── Tutorials ───────────────────────────────────────────────────── - { - type: "category", - label: "Tutorials", - collapsible: true, - collapsed: false, - link: { type: "doc", id: "tutorials/index" }, - items: [ - { - type: "category", - label: "Getting Started", - collapsed: false, - link: { - type: "generated-index", - title: "Getting Started", - description: "Installation, playground, text completion, and mock completions", - slug: "/tutorials/getting_started" - }, - items: [ - "tutorials/installation", - "tutorials/first_playground", - "tutorials/text_completion", - "tutorials/mock_completion", - ], - }, - { - type: "link", - label: "Agent SDKs & Frameworks", - href: "/docs/agent_sdks", - }, - { - type: "link", - label: "AI Coding Tools", - href: "/docs/ai_tools", - }, - { - type: "category", - label: "Python SDK", - collapsed: true, - link: { - type: "generated-index", - title: "Python SDK", - description: "Tutorials using only the Python SDK — no proxy server required", - slug: "/tutorials/python_sdk" - }, - items: [ - "tutorials/gradio_integration", - "tutorials/provider_specific_params", - "tutorials/model_fallbacks", - "tutorials/fallbacks", - ], - }, - { - type: "category", - label: "Provider Setup", - collapsed: true, - link: { - type: "generated-index", - title: "Provider Setup", - description: "Connect LiteLLM to Azure OpenAI, HuggingFace, TogetherAI, local models, and more", - slug: "/tutorials/provider_tutorials" - }, - items: [ - "tutorials/azure_openai", - "tutorials/TogetherAI_liteLLM", - "tutorials/huggingface_tutorial", - "tutorials/huggingface_codellama", - "tutorials/finetuned_chat_gpt", - "tutorials/oobabooga", - ], - }, - { - type: "category", - label: "Proxy: Admin & Access", - collapsed: true, - link: { - type: "generated-index", - title: "Proxy: Admin & Access", - description: "User and team management, SSO, SCIM, and routing rules", - slug: "/tutorials/proxy_admin_access" - }, - items: [ - "tutorials/default_team_self_serve", - "tutorials/msft_sso", - "tutorials/scim_litellm", - "tutorials/tag_management", - ], - }, - { - type: "category", - label: "Proxy: Features & Safety", - collapsed: true, - link: { - type: "generated-index", - title: "Proxy: Features & Safety", - description: "Prompt caching, passthrough APIs, realtime, guardrails, and PII masking", - slug: "/tutorials/proxy_features_safety" - }, - items: [ - "tutorials/prompt_caching", - "tutorials/file_search_responses_api", - "tutorials/anthropic_file_usage", - "tutorials/gemini_realtime_with_audio", - "tutorials/litellm_proxy_aporia", - "tutorials/presidio_pii_masking", - ], - }, - { - type: "category", - label: "Observability & Evaluation", - collapsed: true, - link: { - type: "generated-index", - title: "Observability & Evaluation", - description: "Logging, monitoring, benchmarking, and evaluation suites", - slug: "/tutorials/observability_evaluation" - }, - items: [ - "tutorials/elasticsearch_logging", - "tutorials/compare_llms", - "tutorials/litellm_Test_Multiple_Providers", - "tutorials/eval_suites", - "tutorials/lm_evaluation_harness", - ], - }, - ], - }, - ], -}; - -module.exports = { ...sidebars, ...learnSidebar }; + label \ No newline at end of file From c55dc77bca57ea38c96f26db5aa64dfe4271a143 Mon Sep 17 00:00:00 2001 From: Seven <88984809@qq.com> Date: Mon, 13 Jul 2026 15:49:03 +0800 Subject: [PATCH 3/4] docs(providers): fix sidebars registration for DaoXE --- sidebars.js | 1301 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 1300 insertions(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index 91989bd3..da7d996e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -342,4 +342,1303 @@ const sidebars = { { type: "doc", id: "text_completion", - label \ No newline at end of file + label: "text_completion()", + }, + { + type: "doc", + id: "image_generation", + label: "image_generation()", + }, + { + type: "doc", + id: "completion/prompt_compression", + label: "compress()", + }, + { + type: "doc", + id: "audio_transcription", + label: "transcription()", + }, + { + type: "doc", + id: "text_to_speech", + label: "speech()", + }, + { + type: "doc", + id: "sandbox", + label: "acode_interpreter_tool()", + }, + { + type: "link", + label: "All Supported Endpoints →", + href: "https://docs.litellm.ai/docs/supported_endpoints", + }, + ], + }, + { + type: "category", + label: "Configuration", + items: [ + "set_keys", + "proxy_auth", + "caching/all_caches", + ], + }, + "completion/token_usage", + "exception_mapping", + ], + }, + { + type: "category", + label: "LiteLLM AI Gateway (Proxy)", + link: { + type: "generated-index", + title: "LiteLLM AI Gateway (LLM Proxy)", + description: `OpenAI Proxy Server (LLM Gateway) to call 100+ LLMs in a unified interface & track spend, set budgets per virtual key/user`, + slug: "/simple_proxy", + }, + items: [ + { type: "doc", id: "proxy/docker_quick_start", label: "Getting Started Tutorial" }, + { + type: "category", + label: "Agent & MCP Gateway", + items: [ + { + type: "category", + label: "A2A Agent Gateway", + items: [ + "a2a", + "a2a_agent_card", + "a2a_invoking_agents", + "a2a_agent_headers", + "a2a_cost_tracking", + "a2a_agent_permissions", + "a2a_iteration_budgets", + ], + }, + { + type: "category", + label: "MCP Gateway", + items: [ + "mcp", + "mcp_usage", + "mcp_rest_api", + "mcp_openapi", + "mcp_oauth", + "mcp_obo_auth", + "mcp_aws_sigv4", + "mcp_zero_trust", + "mcp_public_internet", + "mcp_deployment", + "mcp_semantic_filter", + "mcp_tool_search", + "mcp_control", + "mcp_cost", + "mcp_guardrail", + "mcp_server_submissions", + "mcp_toolsets", + { + type: "link", + label: "MCP Troubleshooting Guide", + href: "/docs/mcp_troubleshoot" + }, + ], + }, + { + type: "category", + label: "Skills Gateway", + items: [ + "skills_gateway", + ], + }, + { type: "doc", id: "auth_overview", label: "Gateway Auth Reference" }, + ], + }, + { + "type": "category", + "label": "Config.yaml", + "items": ["proxy/configs", "proxy/config_management", "proxy/config_settings"] + }, + { + type: "category", + label: "Setup & Deployment", + items: [ + "proxy/quick_start", + "proxy/cli", + "proxy/debugging", + "proxy/error_diagnosis", + "proxy/deploy", + "proxy/deploy_cloud", + "proxy/microservices_helm", + "proxy/docker_image_security", + "proxy/health", + "proxy/master_key_rotations", + "proxy/model_management", + "proxy/prod", + "proxy/multi_region", + "proxy/worker_startup_hooks", + "proxy/release_cycle", + ], + }, + { + type: "category", + label: "Admin UI", + items: [ + "proxy/ui", + { + type: "category", + label: "Setup & SSO", + items: [ + "proxy/admin_ui_sso", + "proxy/ui/ui_edit_logo", + "proxy/custom_sso", + "proxy/custom_root_ui", + "proxy/plugins", + "tutorials/scim_litellm", + ] + }, + { + type: "category", + label: "Models", + items: [ + "proxy/ui_credentials", + "proxy/ai_hub", + "proxy/model_compare_ui", + "proxy/ui_store_model_db_setting", + "proxy/ui/routing_groups", + ] + }, + { + type: "category", + label: "Teams & Organizations", + items: [ + { + type: "link", + label: "Role-based Access Controls (RBAC) →", + href: "/docs/proxy/access_control" + }, + "proxy/self_serve", + "proxy/public_teams", + "proxy/ui_project_management", + "proxy/ui_search_tools", + "proxy/ui/bulk_edit_users", + "proxy/ui/page_visibility", + ] + }, + { + type: "category", + label: "Observability: Usage", + items: [ + "proxy/customer_usage", + "proxy/endpoint_activity", + ] + }, + { + type: "category", + label: "Logs", + items: [ + "proxy/ui_logs", + "proxy/ui_spend_log_settings", + "proxy/ui_logs_sessions", + "proxy/deleted_keys_teams", + ] + } + ], + }, + { + type: "category", + label: "Architecture", + items: [ + "proxy/architecture", + "proxy/multi_tenant_architecture", + "proxy/high_availability_control_plane", + "proxy/db_deadlocks", + "proxy/db_info", + "proxy/db_read_replica", + "proxy/image_handling", + "proxy/key_auth_arch", + "proxy/jwt_auth_arch", + "proxy/spend_logs_deletion", + "proxy/user_management_heirarchy", + "router_architecture" + ], + }, + { + type: "link", + label: "All Endpoints (Swagger)", + href: "https://litellm-api.up.railway.app/", + }, + { + type: "category", + label: "Authentication", + items: [ + "proxy/virtual_keys", + "proxy/token_auth", + "proxy/jwt_key_mapping", + { + type: "doc", + id: "proxy/identity_provisioning", + label: "Provisioning & Keys", + }, + "proxy/service_accounts", + "proxy/access_control", + "proxy/cli_sso", + "proxy/custom_auth", + "proxy/ip_address", + "proxy/multiple_admins", + "proxy/public_routes", + ], + }, + { + type: "category", + label: "Budgets + Rate Limits", + items: [ + "proxy/users", + "proxy/team_budgets", + "proxy/project_management", + "proxy/ui_team_soft_budget_alerts", + "proxy/tag_budgets", + "proxy/customers", + "proxy/dynamic_rate_limit", + "proxy/io_token_rate_limits", + "proxy/rate_limit_tiers", + "proxy/temporary_budget_increase", + "proxy/budget_reset_and_tz", + "proxy/budget_fallbacks", + ], + }, + "proxy/caching", + "proxy/memory", + { + type: "category", + label: "Guardrails", + items: [ + "proxy/guardrails/quick_start", + "proxy/guardrails/team_based_guardrails", + "proxy/guardrails/guardrail_load_balancing", + "proxy/guardrails/test_playground", + "proxy/guardrails/litellm_content_filter", + "proxy/guardrails/realtime_guardrails", + { + type: "link", + label: "Providers →", + href: "/docs/guardrail_providers", + }, + { + type: "category", + label: "Contributing to Guardrails", + items: [ + "adding_provider/generic_guardrail_api", + "adding_provider/simple_guardrail_tutorial", + "adding_provider/adding_guardrail_support", + ] + }, + ], + }, + { + type: "category", + label: "Policies", + items: [ + "proxy/guardrails/guardrail_policies", + "proxy/guardrails/policy_flow_builder", + "proxy/guardrails/policy_templates", + "proxy/guardrails/policy_tags", + ], + }, + { + type: "category", + label: "Create Custom Plugins", + description: "Modify requests, responses, and more", + items: [ + "proxy/call_hooks", + "proxy/agentic_loop_hook", + "proxy/rules", + ] + }, + "proxy/management_cli", + { + type: "link", + label: "Load Balancing, Routing, Fallbacks (Failover)", + href: "https://docs.litellm.ai/docs/routing-load-balancing", + }, + "traffic_mirroring", + { + type: "category", + label: "Logging, Alerting, Metrics", + items: [ + "proxy/dynamic_logging", + "proxy/logging", + "proxy/logging_spec", + "proxy/team_logging", + "proxy/email", + ], + }, + { + type: "category", + label: "Making LLM Requests", + items: [ + "proxy/user_keys", + "proxy/clientside_auth", + "proxy/request_headers", + "proxy/response_headers", + "proxy/forward_client_headers", + "proxy/model_discovery", + ], + }, + { + type: "category", + label: "Model Access", + items: [ + "proxy/model_access_guide", + "proxy/model_access", + "proxy/model_access_groups", + "proxy/access_groups", + "proxy/team_model_add", + "proxy/credential_routing" + ] + }, + { + type: "category", + label: "Secret Managers", + items: [ + "secret_managers/overview", + "secret_managers/aws_secret_manager", + "secret_managers/aws_kms", + "secret_managers/azure_key_vault", + "secret_managers/cyberark", + "secret_managers/google_secret_manager", + "secret_managers/google_kms", + "secret_managers/hashicorp_vault", + "secret_managers/custom_secret_manager", + "oidc" + ] + }, + { + type: "category", + label: "Spend Tracking", + items: [ + "proxy/cost_tracking", + "tutorials/vertex_ai_pay_go", + "proxy/request_tags", + "proxy/custom_pricing", + "proxy/custom_model_cost_map", + "proxy/pricing_calculator", + "proxy/provider_margins", + "proxy/provider_discounts", + "proxy/sync_models_github", + "proxy/billing", + ], + }, + { + type: "category", + label: "Cost Optimization", + items: [ + "proxy/auto_routing", + "adaptive_router", + { + type: "link", + label: "Prompt Compression", + href: "/docs/completion/prompt_compression#server-side-callback-loop-v1messages", + }, + "proxy/headroom", + ], + }, + ] + }, + { + type: "category", + label: "Supported Endpoints", + link: { + type: "generated-index", + title: "Supported Endpoints", + description: + "Learn how to deploy + call models from different providers on LiteLLM", + slug: "/supported_endpoints", + }, + items: [ + { + type: "link", + label: "/a2a - A2A Agent Gateway", + href: "/docs/a2a", + }, + "assistants", + "audio_transcription", + "text_to_speech", + { + type: "category", + label: "/batches", + items: [ + "batches", + "proxy/managed_batches", + "proxy/unmanaged_vertex_batches", + ] + }, + "containers", + "container_files", + { + type: "category", + label: "/chat/completions", + link: { + type: "generated-index", + title: "Chat Completions", + description: "Details on the completion() function", + slug: "/completion", + }, + items: [ + "completion/input", + "completion/output", + "completion/usage", + "completion/http_handler_config", + ], + }, + "text_completion", + "bedrock_converse", + "embedding/supported_embedding", + { + type: "category", + label: "/files", + items: [ + "files_endpoints", + "proxy/litellm_managed_files", + ], + }, + { + type: "category", + label: "/fine_tuning", + items: [ + "fine_tuning", + "proxy/managed_finetuning", + ] + }, + "evals_api", + "generateContent", + "apply_guardrail", + "bedrock_invoke", + "interactions", + "managed_agents", + "memory_management", + "image_edits", + "image_generation", + "image_variations", + "videos", + "vector_store_files", + "vector_stores/create", + "vector_stores/search", + { + type: "category", + label: "/mcp - Model Context Protocol", + items: [ + "mcp", + "mcp_usage", + "mcp_rest_api", + "mcp_openapi", + "mcp_oauth", + "mcp_obo_auth", + "mcp_aws_sigv4", + "mcp_zero_trust", + "mcp_public_internet", + "mcp_deployment", + "mcp_semantic_filter", + "mcp_tool_search", + "mcp_control", + "mcp_cost", + "mcp_guardrail", + "mcp_server_submissions", + "mcp_zero_trust", + "mcp_troubleshoot", + ] + }, + { + type: "category", + label: "/v1/messages", + items: [ + "anthropic_unified/index", + "anthropic_unified/structured_output", + "anthropic_unified/messages_to_responses_mapping", + ] + }, + "count_tokens", + "anthropic_count_tokens", + "moderation", + "ocr", + { + type: "category", + label: "Pass-through Endpoints (Anthropic SDK, etc.)", + items: [ + "pass_through/intro", + "pass_through/anthropic_completion", + "pass_through/assembly_ai", + "pass_through/bedrock", + "pass_through/azure_passthrough", + "pass_through/cohere", + "pass_through/cursor", + "pass_through/google_ai_studio", + "pass_through/langfuse", + "pass_through/mistral", + "pass_through/openai_passthrough", + "proxy/passthrough_managed_ids", + { + type: "category", + label: "Vertex AI", + items: [ + "pass_through/vertex_ai", + "pass_through/vertex_ai_live_websocket", + "pass_through/vertex_ai_search_datastores", + ] + }, + "pass_through/vllm", + "proxy/pass_through", + "proxy/pass_through_guardrails" + ] + }, + "rag_ingest", + "rag_query", + "realtime", + "proxy/realtime_webrtc", + "rerank", + "response_api", + "prompt_management", + "response_api_compact", + { + type: "category", + label: "/search", + items: [ + "search/index", + "search/perplexity", + "search/tavily", + "search/exa_ai", + "search/brave", + "search/parallel_ai", + "search/google_pse", + "search/dataforseo", + "search/firecrawl", + "search/searxng", + "search/linkup", + "search/serper", + "search/you_com", + "search/apiserpent", + ] + }, + "skills", + + ], + }, + { + type: "category", + label: "Supported Models & Providers", + link: { + type: "generated-index", + title: "Providers", + description: + "Learn how to deploy + call models from different providers on LiteLLM", + slug: "/providers", + }, + items: [ + { + type: "doc", + id: "provider_registration/index", + label: "Integrate as a Model Provider", + }, + { + type: "doc", + id: "contributing/adding_openai_compatible_providers", + label: "Add OpenAI-Compatible Provider (JSON)", + }, + { + type: "doc", + id: "provider_registration/add_model_pricing", + label: "Add Model Pricing & Context Window", + }, + { + type: "category", + label: "OpenAI", + items: [ + "providers/openai", + "providers/openai/responses_api", + "providers/openai/text_to_speech", + "providers/openai/videos", + ] + }, + "providers/text_completion_openai", + "providers/openai_compatible", + { + type: "category", + label: "Azure OpenAI", + items: [ + "providers/azure/azure", + "providers/azure/azure_responses", + "providers/azure/azure_embedding", + "providers/azure/azure_speech", + "providers/azure/videos", + ] + }, + { + type: "category", + label: "Azure AI", + items: [ + "providers/azure_ai", + "providers/azure_ai/azure_model_router", + "providers/azure_ai_agents", + "providers/azure_ocr", + "providers/azure_document_intelligence", + "providers/azure_ai_speech", + "providers/azure_ai_img", + "providers/azure_ai_vector_stores", + "providers/azure_ai/azure_ai_vector_stores_passthrough", + ] + }, + { + type: "category", + label: "Vertex AI", + items: [ + "providers/vertex", + "providers/vertex_ai/videos", + "providers/vertex_partner", + "providers/vertex_self_deployed", + "providers/vertex_embedding", + "providers/vertex_image", + "providers/vertex_speech", + "providers/vertex_batch", + "providers/vertex_ocr", + "providers/vertex_ai_agent_engine", + "providers/vertex_realtime", + ] + }, + { + type: "category", + label: "Google AI Studio", + items: [ + "providers/gemini", + "providers/gemini/videos", + "providers/gemini/music", + "providers/google_ai_studio/files", + "providers/google_ai_studio/image_gen", + "providers/google_ai_studio/realtime", + ] + }, + "providers/anthropic", + "providers/anthropic_tool_search", + "providers/aws_sagemaker", + { + type: "category", + label: "Bedrock", + items: [ + "providers/bedrock", + "providers/bedrock_embedding", + "providers/bedrock_imported", + "providers/bedrock_image_gen", + "providers/bedrock_rerank", + "providers/bedrock_agentcore", + "providers/bedrock_agents", + "providers/bedrock_writer", + "providers/bedrock_batches", + "providers/bedrock_realtime_with_audio", + "providers/aws_polly", + "providers/bedrock_vector_store", + "providers/bedrock_mantle", + ] + }, + "providers/litellm_proxy", + "providers/abliteration", + "providers/ai21", + "providers/aiml", + "providers/aleph_alpha", + "providers/amazon_nova", + "providers/anyscale", + "providers/apertis", + "providers/baseten", + "providers/black_forest_labs", + "providers/black_forest_labs_img_edit", + "providers/bytez", + "providers/cerebras", + "providers/chutes", + "providers/clarifai", + "providers/cloudflare_workers", + "providers/codestral", + "providers/cohere", + "providers/cometapi", + "providers/compactifai", + "providers/crusoe", + "providers/custom_llm_server", + "providers/daoxe", + "providers/dashscope", + "providers/databricks", + "providers/datarobot", + "providers/deepgram", + "providers/deepinfra", + "providers/deepseek", + "providers/docker_model_runner", + "providers/elevenlabs", + "providers/empiriolabs", + "providers/fal_ai", + "providers/featherless_ai", + "providers/fireworks_ai", + "providers/friendliai", + "providers/galadriel", + "providers/github", + "providers/github_copilot", + "providers/gmi", + "providers/chatgpt", + "providers/gradient_ai", + "providers/groq", + "providers/helicone", + "providers/heroku", + { + type: "category", + label: "HuggingFace", + items: [ + "providers/huggingface", + "providers/huggingface_rerank", + ] + }, + "providers/hyperbolic", + "providers/inception", + "providers/infinity", + "providers/jina_ai", + "providers/lambda_ai", + "providers/langgraph", + "providers/lemonade", + "providers/llamafile", + "providers/llamagate", + "providers/lm_studio", + "providers/manus", + "providers/meta", + "providers/meta_llama", + "providers/milvus_vector_stores", + "providers/mistral", + "providers/minimax", + "providers/moonshot", + "providers/morph", + "providers/nebius", + "providers/nlp_cloud", + "providers/nano-gpt", + "providers/novita", + { type: "doc", id: "providers/nscale", label: "Nscale (EU Sovereign)" }, + { + type: "category", + label: "Nvidia NIM", + items: [ + "providers/nvidia_nim", + "providers/nvidia_nim_rerank", + ] + }, + "providers/nvidia_riva", + "providers/oci", + "providers/ollama", + "providers/openrouter", + "providers/sarvam", + "providers/ovhcloud", + { + type: "category", + label: "Perplexity AI", + items: [ + "providers/perplexity", + "providers/perplexity_embedding", + ] + }, + "providers/petals", + "providers/poe", + "providers/publicai", + "providers/predibase", + "providers/pydantic_ai_agent", + "providers/ragflow", + "providers/recraft", + "providers/replicate", + { + type: "category", + label: "RunwayML", + items: [ + "providers/runwayml/images", + "providers/runwayml/videos", + ] + }, + "providers/sambanova", + "providers/sap", + "providers/scaleway", + "providers/stability", + "providers/synthetic", + "providers/snowflake", + "providers/tencent", + "providers/tensormesh", + "providers/togetherai", + "providers/topaz", + "providers/triton-inference-server", + "providers/v0", + "providers/vercel_ai_gateway", + { + type: "category", + label: "vLLM", + items: [ + "providers/vllm", + "providers/vllm_batches", + ] + }, + "providers/volcano", + "providers/voyage", + "providers/wandb_inference", + { + type: "category", + label: "WatsonX", + items: [ + "providers/watsonx/index", + "providers/watsonx/audio_transcription", + ] + }, + { + type: "category", + label: "xAI", + items: [ + "providers/xai", + "providers/xai_realtime", + ] + }, + "providers/xiaomi_mimo", + "providers/xinference", + "providers/zai", + ], + }, + + + { + type: "category", + label: "Routing & Load Balancing", + link: { + type: "generated-index", + title: "Routing & Load Balancing", + description: "Learn how to load balance, route, and set fallbacks (provider failover) for your LLM requests", + slug: "/routing-load-balancing", + }, + items: [ + "routing", + "adaptive_router", + "scheduler", + "proxy/auto_routing", + "proxy/load_balancing", + "proxy/keys_teams_router_settings", + "proxy/provider_budget_routing", + "proxy/reliability", + "proxy/fallback_management", + "proxy/tag_routing", + "proxy/timeout", + "wildcard_routing", + "proxy/health_check_routing" + ], + }, + "benchmarks", + { + type: "category", + label: "Contributing", + items: [ + "extras/contributing_code", + { + type: "category", + label: "Adding Providers", + items: [ + "contributing/adding_openai_compatible_providers", + "adding_provider/directory_structure", + "adding_provider/new_rerank_provider", + ] + }, + "extras/contributing", + "contributing", + ] + }, + { + type: "category", + label: "Extras", + items: [ + "sdk_custom_pricing", + "migration", + "data_security", + "proxy/security_encryption_faq", + "migration_policy", + "load_test_advanced", + "load_test_sdk", + "load_test_rpm", + { + type: "category", + label: "❤️ 🚅 Projects built on LiteLLM", + link: { + type: "generated-index", + title: "Projects built on LiteLLM", + description: + "Learn how to deploy + call models from different providers on LiteLLM", + slug: "/project", + }, + items: [ + "projects/smolagents", + "projects/mini-swe-agent", + "projects/openai-agents", + "projects/Google ADK", + "projects/Agent Lightning", + "projects/Harbor", + "projects/CompatCanary", + "projects/GraphRAG", + "projects/Docq.AI", + "projects/PDL", + "projects/OpenInterpreter", + "projects/Elroy", + "projects/dbally", + "projects/FastREPL", + "projects/PROMPTMETHEUS", + "projects/Codium PR Agent", + "projects/Prompt2Model", + "projects/SalesGPT", + "projects/Softgen", + "projects/Quivr", + "projects/Langstream", + "projects/Otter", + "projects/YiVal", + "projects/llm_cord", + "projects/pgai", + "projects/GPTLocalhost", + "projects/HolmesGPT", + "projects/Railtracks", + ], + }, + "extras/code_quality", + "rules", + "proxy/team_based_routing", + "proxy/customer_routing", + "proxy_server", + ], + }, + { + type: "category", + label: "Troubleshooting", + items: [ + "troubleshoot/ui_issues", + "troubleshoot/cost_discrepancy", + "mcp_troubleshoot", + { + type: "category", + label: "Performance / Latency", + items: [ + "troubleshoot/latency_overhead", + "troubleshoot/cpu_issues", + "troubleshoot/memory_issues", + "troubleshoot/spend_queue_warnings", + "troubleshoot/max_callbacks", + "troubleshoot/prisma_migrations", + ], + }, + "troubleshoot/pip_venv_upgrade", + "troubleshoot/rollback", + "troubleshoot", + ], + }, + ], +}; + +const learnSidebar = { + learnSidebar: [ + // ── Landing page ────────────────────────────────────────────────── + { type: "doc", id: "learn/index", label: "Learn" }, + { + type: "category", + label: "Start Here", + collapsible: true, + collapsed: false, + items: [ + "learn/sdk_quickstart", + "learn/gateway_quickstart", + "learn/enterprise_quickstart", + ], + }, + + // ── Guides ──────────────────────────────────────────────────────── + { + type: "category", + label: "Guides", + collapsible: true, + collapsed: false, + link: { type: "doc", id: "guides/index" }, + items: [ + { + type: "category", + label: "Core Requests", + collapsible: true, + collapsed: false, + link: { + type: "generated-index", + title: "Core Requests", + description: "Streaming, batching, structured outputs, and reasoning behavior", + slug: "/guides/core_request_response_patterns" + }, + items: [ + "completion/stream", + "completion/batching", + "completion/json_mode", + "reasoning_content", + ], + }, + { + type: "category", + label: "Tool Calling", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Tool Calling", + description: "Function calling, web tools, interception patterns, computer use, code interpreter, and tool-call hygiene", + slug: "/guides/tools_integrations" + }, + items: [ + "completion/function_call", + "completion/web_search", + { + type: "doc", + id: "integrations/websearch_interception", + label: "Web Search Interception", + }, + "completion/web_fetch", + "completion/computer_use", + "guides/code_interpreter", + { + type: "doc", + id: "sandbox", + label: "Code Interpreter Sandbox Interception", + }, + "completion/anthropic_advisor_tool", + "completion/message_sanitization", + ], + }, + { + type: "category", + label: "Multimodal I/O", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Multimodal I/O", + description: "Vision, audio, PDFs, image generation, and video generation", + slug: "/guides/multimodal_io" + }, + items: [ + "completion/vision", + "completion/audio", + "completion/document_understanding", + "completion/image_generation_chat", + "proxy/veo_video_generation", + ], + }, + { + type: "category", + label: "Retrieval & Knowledge", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Retrieval & Knowledge", + description: "Vector stores, file search, citations, and knowledge-base routing", + slug: "/guides/retrieval_knowledge" + }, + items: [ + "completion/knowledgebase", + ], + }, + { + type: "category", + label: "Prompts & Context", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Prompts & Context", + description: "Prompt caching, trimming, formatting, assistant prefill, and predicted outputs", + slug: "/guides/prompts_context" + }, + items: [ + "completion/prefix", + "completion/predict_outputs", + "completion/prompt_compression", + "completion/message_trimming", + "completion/prompt_caching", + "completion/prompt_formatting", + ], + }, + { + type: "category", + label: "Compatibility & Extensibility", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Compatibility & Extensibility", + description: "Provider-specific params, model aliases, fine-tuned models, and adapters", + slug: "/guides/compatibility_extensibility" + }, + items: [ + "completion/provider_specific_params", + "completion/drop_params", + "completion/model_alias", + "guides/finetuned_models", + "extras/creating_adapters", + ], + }, + { + type: "category", + label: "Reliability, Testing & Spend", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Reliability, Testing & Spend", + description: "Retries, fallbacks (failover), mock responses, and budget controls", + slug: "/guides/reliability_testing_spend" + }, + items: [ + "completion/mock_requests", + "completion/reliable_completions", + ], + }, + { + type: "category", + label: "Security & Network", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Security & Network", + description: "SSL, custom CA bundles, HTTP proxy settings, and per-service verification", + slug: "/guides/security_network" + }, + items: [ + "guides/security_settings", + ], + }, + ], + }, + + // ── Tutorials ───────────────────────────────────────────────────── + { + type: "category", + label: "Tutorials", + collapsible: true, + collapsed: false, + link: { type: "doc", id: "tutorials/index" }, + items: [ + { + type: "category", + label: "Getting Started", + collapsed: false, + link: { + type: "generated-index", + title: "Getting Started", + description: "Installation, playground, text completion, and mock completions", + slug: "/tutorials/getting_started" + }, + items: [ + "tutorials/installation", + "tutorials/first_playground", + "tutorials/text_completion", + "tutorials/mock_completion", + ], + }, + { + type: "link", + label: "Agent SDKs & Frameworks", + href: "/docs/agent_sdks", + }, + { + type: "link", + label: "AI Coding Tools", + href: "/docs/ai_tools", + }, + { + type: "category", + label: "Python SDK", + collapsed: true, + link: { + type: "generated-index", + title: "Python SDK", + description: "Tutorials using only the Python SDK — no proxy server required", + slug: "/tutorials/python_sdk" + }, + items: [ + "tutorials/gradio_integration", + "tutorials/provider_specific_params", + "tutorials/model_fallbacks", + "tutorials/fallbacks", + ], + }, + { + type: "category", + label: "Provider Setup", + collapsed: true, + link: { + type: "generated-index", + title: "Provider Setup", + description: "Connect LiteLLM to Azure OpenAI, HuggingFace, TogetherAI, local models, and more", + slug: "/tutorials/provider_tutorials" + }, + items: [ + "tutorials/azure_openai", + "tutorials/TogetherAI_liteLLM", + "tutorials/huggingface_tutorial", + "tutorials/huggingface_codellama", + "tutorials/finetuned_chat_gpt", + "tutorials/oobabooga", + ], + }, + { + type: "category", + label: "Proxy: Admin & Access", + collapsed: true, + link: { + type: "generated-index", + title: "Proxy: Admin & Access", + description: "User and team management, SSO, SCIM, and routing rules", + slug: "/tutorials/proxy_admin_access" + }, + items: [ + "tutorials/default_team_self_serve", + "tutorials/msft_sso", + "tutorials/scim_litellm", + "tutorials/tag_management", + ], + }, + { + type: "category", + label: "Proxy: Features & Safety", + collapsed: true, + link: { + type: "generated-index", + title: "Proxy: Features & Safety", + description: "Prompt caching, passthrough APIs, realtime, guardrails, and PII masking", + slug: "/tutorials/proxy_features_safety" + }, + items: [ + "tutorials/prompt_caching", + "tutorials/file_search_responses_api", + "tutorials/anthropic_file_usage", + "tutorials/gemini_realtime_with_audio", + "tutorials/litellm_proxy_aporia", + "tutorials/presidio_pii_masking", + ], + }, + { + type: "category", + label: "Observability & Evaluation", + collapsed: true, + link: { + type: "generated-index", + title: "Observability & Evaluation", + description: "Logging, monitoring, benchmarking, and evaluation suites", + slug: "/tutorials/observability_evaluation" + }, + items: [ + "tutorials/elasticsearch_logging", + "tutorials/compare_llms", + "tutorials/litellm_Test_Multiple_Providers", + "tutorials/eval_suites", + "tutorials/lm_evaluation_harness", + ], + }, + ], + }, + ], +}; + +module.exports = { ...sidebars, ...learnSidebar }; From 355af7c3401c9460c2f688a4773128c858f5285e Mon Sep 17 00:00:00 2001 From: Seven <88984809@qq.com> Date: Mon, 13 Jul 2026 15:49:39 +0800 Subject: [PATCH 4/4] docs(providers): fix sidebars registration for DaoXE