跳转到主要内容

​
搜索和 AI 聊天设置

本指南说明如何为您的 PipeLLM 网关文档设置搜索功能和 AI 聊天。

​
🔍 搜索配置

​
选项 1：Algolia（推荐）

  1. 创建 Algolia 账户
    • 在 Algolia 注册
    • 创建新索引（例如 pipellm-docs）
  2. 更新 docs.json 
{
  "search": {
    "enabled": true,
    "provider": "algolia",
    "algolia": {
      "applicationId": "YOUR_APPLICATION_ID",
      "indexName": "pipellm-docs",
      "apiKey": "YOUR_SEARCH_ONLY_API_KEY"
    }
  }
}
  1. 索引您的文档
    • Mintlify 自动索引您的内容
    • 搜索更新通常需要几分钟

​
选项 2：Google 自定义搜索

{
  "search": {
    "enabled": true,
    "provider": "google",
    "google": {
      "customSearchId": "YOUR_CUSTOM_SEARCH_ID",
      "apiKey": "YOUR_API_KEY"
    }
  }
}

​
选项 3：本地搜索

{
  "search": {
    "enabled": true,
    "provider": "local"
  }
}

​
🤖 AI 聊天配置

​
选项 1：Anthropic Claude（推荐）

  1. 获取 API 密钥
  2. 更新 docs.json 
{
  "aiChat": {
    "enabled": true,
    "provider": "anthropic",
    "anthropic": {
      "apiKey": "your-anthropic-api-key",
      "model": "claude-3-sonnet",
      "systemPrompt": "You are an AI assistant that helps developers with PipeLLM Gateway documentation. Only answer questions related to the documentation content."
    }
  }
}

​
选项 2：OpenAI GPT

{
  "aiChat": {
    "enabled": true,
    "provider": "openai",
    "openai": {
      "apiKey": "your-openai-api-key",
      "model": "gpt-4",
      "systemPrompt": "You are an AI assistant that helps developers with PipeLLM Gateway documentation."
    }
  }
}

​
选项 3：Google Gemini

{
  "aiChat": {
    "enabled": true,
    "provider": "google",
    "google": {
      "apiKey": "your-gemini-api-key",
      "model": "gemini-pro",
      "systemPrompt": "You are an AI assistant that helps developers with PipeLLM Gateway documentation."
    }
  }
}

​
⚙️ 环境变量

为了安全起见，将 API 密钥存储在环境变量中：

​
创建 .env.local 文件

# 搜索
NEXT_PUBLIC_ALGOLIA_APP_ID=your_application_id
NEXT_PUBLIC_ALGOLIA_SEARCH_KEY=your_search_only_key
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=pipellm-docs

# AI 聊天
NEXT_PUBLIC_ANTHROPIC_API_KEY=your_anthropic_api_key
NEXT_PUBLIC_OPENAI_API_KEY=your_openai_api_key
NEXT_PUBLIC_GOOGLE_API_KEY=your_gemini_api_key

​
更新 docs.json 使用环境变量

{
  "search": {
    "provider": "algolia",
    "algolia": {
      "applicationId": "${NEXT_PUBLIC_ALGOLIA_APP_ID}",
      "apiKey": "${NEXT_PUBLIC_ALGOLIA_SEARCH_KEY}",
      "indexName": "${NEXT_PUBLIC_ALGOLIA_INDEX_NAME}"
    }
  },
  "aiChat": {
    "provider": "anthropic",
    "anthropic": {
      "apiKey": "${NEXT_PUBLIC_ANTHROPIC_API_KEY}",
      "model": "claude-3-sonnet"
    }
  }
}

​
🚀 部署注意事项

​
Vercel 部署

  1. 添加环境变量
    • 在 Vercel 仪表板中，进入 Settings → Environment Variables
    • 添加所有必需的 API 密钥
  2. 构建配置 
{
  "build": {
    "env": {
      "NEXT_PUBLIC_ALGOLIA_APP_ID": "${NEXT_PUBLIC_ALGOLIA_APP_ID}",
      "NEXT_PUBLIC_ALGOLIA_SEARCH_KEY": "${NEXT_PUBLIC_ALGOLIA_SEARCH_KEY}",
      "NEXT_PUBLIC_ANTHROPIC_API_KEY": "${NEXT_PUBLIC_ANTHROPIC_API_KEY}"
    }
  }
}

​
Mintlify 部署

  1. 添加环境变量
    • 在 Mintlify Console 中，进入 Settings → Environment Variables
    • 添加必需的 API 密钥
  2. 自动索引
    • Mintlify 自动处理搜索索引
    • AI 聊天配置在构建期间处理

​
🎨 自定义

​
搜索样式

{
  "search": {
    "theme": {
      "primaryColor": "#16A34A",
      "borderRadius": "8px",
      "highlightColor": "#07C983"
    }
  }
}

​
AI 聊天小部件

{
  "aiChat": {
    "theme": {
      "position": "right",
      "bubbleColor": "#16A34A",
      "textColor": "#FFFFFF"
    },
    "branding": {
      "title": "PipeLLM 文档助手",
      "subtitle": "询问有关 PipeLLM 网关的任何问题",
      "logo": "/logo/chat-icon.svg"
    }
  }
}

​
🔧 故障排除

​
搜索问题

  1. 搜索不工作
    • 检查 API 密钥是否正确
    • 验证索引存在且已填充
    • 检查浏览器控制台错误
  2. 索引问题
    • 等待 5-10 分钟让索引完成
    • 检查 Algolia 仪表板的索引状态
    • 必要时重新部署

​
AI 聊天问题

  1. 聊天无响应
    • 验证 API 密钥有效
    • 检查 API 提供商的速率限制
    • 确保模型名称正确
  2. 回复质量差
    • 调整系统提示
    • 尝试不同的模型（例如 gpt-4 vs gpt-3.5-turbo）
    • 检查提示长度限制

​
📊 监控和分析

​
搜索分析

  • Algolia：内置分析仪表板
  • Google：Search Console 集成
  • 本地：基本使用统计

​
AI 聊天分析

  • 跟踪使用模式
  • 监控回复质量
  • 为高使用率设置告警

​
🛡️ 安全最佳实践

  1. API 密钥安全
    • 切勿将 API 密钥提交到版本控制
    • 使用环境变量
    • 在可能的地方设置 API 密钥限制
  2. 速率限制
    • 配置适当的速率限制
    • 监控使用模式
    • 为异常活动设置告警
  3. 内容安全
    • 使用适当的系统提示
    • 实现内容过滤
    • 监控不当使用

​
📝 下一步

  1. 测试搜索功能
  2. 测试 AI 聊天回复
  3. 监控使用情况和性能
  4. 根据用户反馈优化
需要帮助？ 如需搜索和 AI 聊天设置帮助，请联系 [email protected]。