SearchCLI
用命令行将火山引擎 AI 搜索、推荐与对话检索接入业务或智能体工作流。
这个 Agent 能做什么,适合哪些场景?
SearchCLI 是面向火山引擎 AI Search 的开源命令行集成工具。它提供 `vs item`、`vs dataset`、`vs app` 与 `vs data` 等命令,用于从结构化业务数据建立数据集和应用配置。运行阶段可通过 `vs search run`、`vs recommend run` 和 `vs chat run` 验证搜索、推荐及对话检索行为,并可用 `vs search tune` 进行首版文本相似度评测与调优。其执行模型包含 dry-run、确认门槛和写后验证,计划文件可在本地 `.viking/item-plans` 路径下复核。项目还提供可安装的 Viking skills,供外部智能体沿用这些工作流。
它读取 JSON 或 JSONL 项目数据文件,通过 vs item profile --file 分析数据,并用 vs item plan --file --goal 生成上线路径。vs item apply --plan-dir 可先以 --dry-run 预演,再以 --confirm-review --wait-ready --run-trials 执行并等待验证;仅创建数据集时可使用 --skip-app、vs dataset create --data @dataset-create.json 与 vs dataset ingest --dataset-id <dataset-id> --fields @<normalized-items-artifact>。数据集、应用和数据管理分别由 vs dataset、vs app、vs data 提供;运行结果通过 vs search run、vs recommend run、vs chat run 获取。调优流程包括 vs search tune query-generate | plan | run | report;可选的 LLM 查询生成或相关性判断通过 vs llm login 或 vs llm import-env 配置兼容 OpenAI 的 LLM API。
- 业务搜索团队要将商品等结构化目录接入火山引擎 AI Search,并在创建应用前审查生成的计划。
- 推荐系统团队需要将应用场景和用户行为关联到推荐流程,并用 `vs recommend run` 做运行验证。
- 对话式检索产品团队需要基于应用搜索测试对话检索行为,并通过 `vs chat run` 检查结果。
- 智能体开发团队希望安装 `vs-shared`、`vs-item-onboarding`、`vs-search` 等 Viking skills,让外部智能体执行受审查的数据接入流程。
- 视频内容团队要建立视频数据集,并在 profile、plan 和 apply 阶段显式传入 `--type video`。
这个 Agent 有哪些优点和局限?
- 将数据画像、计划生成、dry-run、确认执行和运行验证组织为同一套 CLI 工作流。
- 同时覆盖结构化项目搜索、推荐和对话检索,并提供对应的 `run` 验证命令。
- `vs search tune` 提供查询生成、计划、执行和报告的文本相似度评测流程。
- 公开 Viking skills 让外部智能体可安装并复用项目的数据接入与检索工作流。
- 核心能力依赖火山引擎 AI Search,且需要具有访问权限的 Volcengine AK/SK,平台可移植性有限。
- 安装要求 Node.js 20+、`git` 和可用 shell;运行还依赖网络连接及本地凭据存储。
- LLM 查询生成和相关性判断需另行配置兼容 OpenAI 的 API,API 密钥不能以明文配置保存。
- 视频数据集必须显式指定 `--type video`;仅用 `--schema @schema.json` 创建视频数据集可能出现 `MissingParameter.DefaultFieldStrategy`。
如何安装或部署这个 Agent?
需要 Node.js 20 或更高版本、git,以及具备 AI Search 访问权限的火山引擎 AK/SK。安装并导入当前环境中的凭据:git clone [email protected]:volcengine/SearchCLI.git vscd vsbash ./scripts/install.shvs auth import-envvs auth status --jsonvs doctor --json
若环境中没有 VIKING_AK 与 VIKING_SK,在真实终端运行 vs auth login。外部智能体还可运行 npx skills add "[email protected]:volcengine/SearchCLI.git" -y -g 安装公开技能包。
如何使用这个 Agent?
以新建数据集和应用的商品搜索为例:先运行 vs item profile --file ./items.json --pretty,再运行 vs item plan --file ./items.json --goal "Build item search"。使用 vs item apply --plan-dir ./.viking/item-plans/<plan> --dry-run 审查预演,然后运行 vs item apply --plan-dir ./.viking/item-plans/<plan> --confirm-review --wait-ready --run-trials 执行并验证。若只需数据集,请在 plan 命令中加入 --skip-app,随后使用计划生成的 dataset-create.json 执行 vs dataset create --data @dataset-create.json,再用 vs dataset ingest 导入字段数据。