vanna

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• Python 运行环境（README 未标注具体版本要求）
• 可用的 SQLite 数据库文件（示例路径 ./data.db）
• Anthropic API 凭据（示例使用 AnthropicLlmService）
• 已有的 FastAPI 应用（用于注册聊天路由）
• 前端页面（React、Vue 或纯 HTML 均可）

安装与启动步骤

1. 1查阅官方文档

   README 未提供 pip 安装命令，安装与配置请以官网 Quickstart 和 Configure 文档为准，先完成基础环境准备。

2. 2准备数据库

   示例用 SQLite，需在项目中准备好数据库文件，代码中通过 SqliteRunner 指向该文件路径。

3. 3导入 Vanna 模块

   在你的 FastAPI 项目中导入 Agent、FastAPI 路由注册、Anthropic LLM 服务、SQL 工具与用户解析相关模块。

   from fastapi import FastAPI
   from vanna import Agent
   from vanna.servers.fastapi.routes import register_chat_routes
   from vanna.servers.base import ChatHandler
   from vanna.core.user import UserResolver, User, RequestContext
   from vanna.integrations.anthropic import AnthropicLlmService
   from vanna.tools import RunSqlTool
   from vanna.integrations.sqlite import SqliteRunner
   from vanna.core.registry import ToolRegistry

   复制

4. 4装配 Agent

   创建 Anthropic LLM 服务、把 RunSqlTool 注册进工具表，再实例化 Agent 并传入你自己的 user_resolver。

   llm = AnthropicLlmService(model="claude-sonnet-4-5")
   tools = ToolRegistry()
   tools.register(RunSqlTool(sql_runner=SqliteRunner("./data.db")))
   
   agent = Agent(
       llm_service=llm,
       tool_registry=tools,
       user_resolver=MyUserResolver()
   )

   复制

5. 5注册聊天路由

   用 README 提到的 register_chat_routes 把聊天接口挂到现有 FastAPI 应用上，并配合你自己的鉴权逻辑。

   register_chat_routes(app, agent)

   复制

6. 6嵌入前端组件

   在任意网页引入 vanna-components.js，放置 vanna-chat 标签，把 sse-endpoint 指向你的聊天接口。

   复制

关键配置

如何确认成功

打开嵌入 vanna-chat 的页面，用自然语言提问，观察是否流式返回进度、SQL、数据表与图表。

常见问题

注意事项

• README 未给出 pip 安装命令与具体依赖版本，安装方式请以 https://vanna.ai/docs 为准。
• 示例中的 MyUserResolver 需由使用者自行实现，否则无法完成用户解析与权限过滤。
• register_chat_routes 的完整参数签名 README 未列出，请参考官方文档与源码。
• 版本迭代较快，生产使用前建议核对 MIGRATION_GUIDE.md。