SuperAPI AI 工具集

truefoundry-onboarding

通用与其它

查看项目

更新于 10-16 06:43

技能介绍

用途:把新用户从零带到可用的 TrueFoundry 环境,覆盖账号创建、凭据配置和首次成功 API 调用。适用于用户还没有 TrueFoundry 账号,或说“get started”“set up”“register”“onboard”“I'm new to TrueFoundry”,或缺少 TFY_BASE_URL、TFY_API_KEY 且此前未配置,或明确询问如何创建账号、获取 API Key。

主要流程:先检测当前状态,检查 TFY_BASE_URL、TFY_HOST、TFY_API_KEY 以及 .env 中的 TFY_ 变量;若凭据已存在则跳到验证连接。若已有账号,跳到配置凭据;若无账号,运行 tfy register 注册。该命令是交互式的,需要用户在终端输入,不要用管道或自动化。未安装 CLI 时可用 uv run --from truefoundry tfy register。注册向导包含账号信息(租户名 3-15 位小写字母数字与短横线、工作邮箱、至少 8 位密码)、主要用途(ai gateway 或 llm ops)、条款确认、必要的人工验证、创建账号及邮箱验证。完成后 CLI 输出租户 URL 与创建个人访问令牌(PAT)的指引:在浏览器打开租户 URL,进入 Settings → Access → Personal Access Tokens → Generate New Token,复制令牌。

配置凭据:方式 A 环境变量(开发推荐):export TFY_BASE_URL="https://your-org.truefoundry.cloud"、export TFY_API_KEY="tfy-..."、export TFY_HOST="${TFY_BASE_URL}"。方式 B .env 文件(项目级配置推荐),写入 TFY_BASE_URL 与 TFY_API_KEY。安全提示:不要把含 API Key 的 .env 提交到 Git,确保它在 .gitignore 中。不要用 source .env。

可选安装 CLI:tfy --version 检查;未安装可 pip install 'truefoundry==0.5.0'。使用 CLI 且已设置 TFY_API_KEY 时需同时设置 TFY_HOST:export TFY_HOST="${TFY_HOST:-${TFY_BASE_URL%/}}"。

验证连接:用轻量 API 调用测试,先设置 TFY_API_SH 为该技能的 scripts/tfy-api.sh 完整路径,然后执行 GET '/api/svc/v1/workspaces?limit=1',展示 Base URL、API Key 与连接状态。失败时按错误处理排查。

适用场景与后续:完成后可转向 ai-gateway、guardrails、mcp-servers、workspaces、logs 等技能;部署服务、LLM、作业和 notebook 需要具备已连接集群的 TrueFoundry Enterprise 账号(见 https://truefoundry.com)。

限制与错误处理:tfy register 失败时,检查是否安装 CLI、到 registration.truefoundry.com 的网络连通性、字段校验错误会重试对应字段;出现 CAPTCHA 或人工验证时让浏览器完成,未自动打开则复制 CLI 显示的 URL。邮箱验证未收到可查垃圾邮件、用同一邮箱重试,仍失败联系 support@truefoundry.com。401 表示 API Key 无效或过期,需在 Settings → API Keys 重新生成并更新 TFY_API_KEY。连接被拒或超时检查 URL 是否正确(含 https://)、网络或 VPN、是否有多余结尾斜杠。.env 必须在当前工作目录且变量名精确匹配、值不加引号。CLI 报 “TFY_HOST env must be set” 时需设置 TFY_HOST。成功标准:拥有账号、凭据配置完成、测试调用连通、用户知道下一步,且代理未记录或回显任何凭据。