AnswerLens

审计产品页面,查看报告,再修正 AI 助手读不清的内容。

语言: 简体中文 / English

CI 交接

把一轮有用的本地审计变成 GitHub Action。

看完演示、跑过一次真实站点之后,再使用这一页。它会说明该复制哪些文件、密钥放在哪里,以及第一次 CI 结果该怎么看。

CI 设置

本地报告已经看懂之后,再复制这些文件。

这套设置会在 CI 中生成同一组报告:站点设置、竞品、提示词、runtime 默认值,以及固定版本的 Action。

  1. 1

    先跑真实站点审计

    先有一轮有用的本地审计,让报告内容变得可理解。

    开始 5 分钟检查
  2. 2

    复制接入文件

    把 .github/answerlens 文件和工作流移到你要审计的仓库里。

    打开来源
  3. 3

    设置 runtime 默认值

    把非密钥的评估默认值放进 runtime.yaml,把模型服务 key 留在 secrets。

    打开 runtime
  4. 4

    使用固定版本的 Action

    在 pull request 或 workflow_dispatch 里运行经过审阅的稳定 release tag。

    打开工作流

外部仓库布局

设置文件

.github/
  answerlens/
    brand.yaml
    competitors.yaml
    prompts.yaml
    runtime.yaml
  workflows/
    answerlens.yml

这就是 examples/consumer-repo 使用的同一套目录结构。

文件职责

每个文件分别负责什么

  • brand.yaml:定义产品名、域名、proof-page 提示,以及可选的 site_display_name
  • competitors.yaml:声明你真正要打进去的竞品集合。
  • prompts.yaml:写给真实买家与评估场景的比较、引用和推荐问题。
  • runtime.yaml:保存非密钥的 评估默认值,例如 模型服务、模型、语言、样本数和超时设置。
  • answerlens.yml:在 CI 里运行 AnswerLens、上传同一组报告文件,并 固定到当前稳定 Action release 的 GitHub Actions 工作流。

当前接入工作流 使用 YSCJRH/ai-visibility-auditor@v0.3.2;有新 release 后,先读 发布说明,再更新这个 固定。

API keys 继续放在 GitHub secrets 或本地环境变量里,不要写进 runtime.yaml

审阅顺序

先按这个顺序审阅

share-summary.md

用于审计概览和 PR 摘要。

scorecard.md

用于检查覆盖、规则和得分。

recommendations.md

用于审阅后的修复清单。

看完这三份之后,再用 pr-snippet.md 处理 GitHub 文案,用 run.json 处理机器可读元数据。

公开示例

先看这次接入示例结果

示例站点: 示例 Product public site

这个公开示例会把接入文件跑在示例站点上,让外部团队在接自己站点之前,先看清最终报告会是什么样。

设置你的仓库

把它接进真实仓库时怎么走

文件复制完成后,第一轮保持小而清晰:

  1. 替换示例产品、域名、竞品和 prompts。
  2. 把非密钥的 评估默认值放进 runtime.yaml,API keys 留在 secrets。
  3. 如果想先用最低摩擦的 eval,可以从 profile: fast-first-eval 开始。
  4. 如果已经有一轮可读的 OpenAI baseline,并想临时加一个 search-shaped 第二意见,可以使用 profile: perplexity-cross-check
  5. 本地结果已经足够可审阅之后,再进入 GitHub Action

相关证明页面

这页应该和哪些公开页一起看

  • 示例页:先看在线演示报告。
  • 文档页:继续看上手路径、评分说明和规范文档。
  • 集成页:看接入文件如何进入 GitHub Actions 工作流。
  • 发布页:把发布资源当作第二个公开入口。