SuperAPI AI 工具集

ask-ai

智能体与模型

查看项目

更新于 10-15 21:40

技能介绍

用途:为 @farming-labs/docs 站点加入内置 AI 聊天(Ask AI / DocsBot),AI 会检索相关文档页面、构建上下文,并通过兼容 OpenAI 的 LLM 流式返回回答。

主要能力:以搜索管道检索文档作为上下文;支持 search(Cmd+K 搜索弹窗内的 AI 标签页)与 floating(浮动聊天组件)两种模式;floating 模式下可选 panel、modal、popover、full-modal 样式及位置;支持单模型或多模型下拉;支持命名提供商(OpenAI、Groq 等,须兼容 OpenAI Chat Completions API);可设置 baseUrl/apiKey、suggestedQuestions、systemPrompt、maxResults(默认 5)、feedback 与 onActions 回调、aiLabel、packageName;可用 useMcp 通过内置 MCP search_docs 工具检索。

必要用法:在 docs.config.ts 的 ai 对象中配置,最简为 ai: { enabled: true };AI 读取 process.env.OPENAI_API_KEY,默认模型 gpt-4o-mini。各框架需把密钥传入 docs 服务端配置:Next.js 用 .env 的 process.env.OPENAI_API_KEY;TanStack Start、SvelteKit、Astro、Nuxt 分别在 createDocsServer 或 Nitro 运行时配置中传入对应环境变量。不要硬编码 API 密钥。

限制:静态导出(staticExport: true)时 AI 聊天被隐藏且不部署 API 路由;多提供商时须为每个模型指定 provider;自定义或代理 baseUrl 需相应设置;自定义 MCP 端点须支持 Streamable HTTP MCP 并在 initialize 返回 mcp-session-id,且暴露搜索工具(默认 search_docs)。其余如具体收费与价格信息暂未提供。