关于 convex-agent
convex-agent 指导开发者使用 @convex-dev/agent 在 Convex 应用中构建 AI Agent 后端,支持持久化对话、工具调用和向量检索。内容涵盖 Convex AI Gateway 模型调用及 RAG 配置。
主要功能
- 01持久化对话线程与消息历史
- 02定义 Agent 工具和指令
- 03通过 Convex AI Gateway 调用模型
- 04构建向量索引并检索文档
- 05在 Convex 环境中安全存储密钥
适用场景
- 01为应用添加持久化 AI 对话
- 02让 Agent 调用应用定义的工具
- 03根据文档检索结果生成回答
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ growthx-club/ build-sprint-skills --skill convex-agent安装后在 Claude Code 中输入/convex-agent确认已加载。
附带文件UPSTREAM-LICENSEUPSTREAM-THIRD_PARTY_NOTICES.md
详细介绍
添加 AI Agent / RAG 后端
安装 @convex-dev/agent,以支持持久化线程、消息历史记录、工具调用和向量搜索/RAG——作为应用内 AI Agent 的后端。默认通过 Convex AI Gateway 调用模型:凭据由 Convex 持有,因此无需获取、存储或轮换 LLM 密钥。
工作流
- 安装 @convex-dev/agent + @convex-dev/ai-sdk-provider;将 agent 组件添加到 convex.config.ts。
- 使用
languageModel: convexGateway("provider/model")定义 Agent(工具、指令)——无需 API 密钥(需要在 Convex Cloud 部署上使用 Convex 1.45+,且需付费计划)。 - 创建线程并流式传输消息;在 Convex 中持久化历史记录。
- 对于 RAG:将文档嵌入向量索引,并在工具中检索。Gateway 目前尚不提供嵌入服务,因此请通过
env微型功能存储嵌入提供商的密钥。 - 仅当 Gateway 不可用时(免费计划、自托管、本地后端),才使用通过
env微型功能存储的密钥调用提供商 SDK。
规则
- 模型调用默认使用 Convex AI Gateway(来自 @convex-dev/ai-sdk-provider 的
convexGateway);仅在 Gateway 不可用时(免费计划、自托管、本地后端),才回退到 Convex env 中的提供商密钥。 - 切勿在客户端公开提供商 API 密钥;需要密钥时(嵌入、Gateway 回退),请通过
env微型功能将其保存在 Convex env 中。 - 在 actions 中运行模型调用(如果 SDK 需要,请使用 'use node')。
- 在 Convex 中持久化线程/消息,以确保持久性和响应性。
评论
支持 Markdown