USER GUIDE · 用户使用指南
GEO-Optimizer
用户使用指南
本指南帮助您通过 Web 控制台 和 开放 API 两种方式,完成网站 GEO(生成式引擎优化)评估与优化。
01平台简介
GEO-Optimizer 是面向 AI 搜索引擎的生成式引擎优化(GEO)平台,核心能力:
用户角色
普通用户可使用以下功能:评估任务、历史管理、报告下载、API 密钥管理、算力配置。管理员功能(系统配置、用户管理、审计等)不在本指南范围内。
02快速开始
访问平台
浏览器打开平台地址(默认 http://localhost:5001),进入登录页。
登录
使用管理员分配的账号和密码登录;如尚未拥有账号,请联系管理员创建。
发起第一次评估
点击「新建评估」→ 输入目标 URL(如 https://example.com)→ 选择任务类型 → 提交。
查看结果
等待 30–120 秒,任务完成后查看评分与报告;plan 类型还可下载改进方案 ZIP。
03控制台操作指南
控制台首页(Dashboard)
登录后进入个人控制台,展示:
- 个人概览:我的任务数、剩余配额
- 评估历史:最近 10 条评估任务,可快速查看详情或重试
新建评估(/eval/new)
| 字段 | 说明 |
|---|---|
| 目标 URL | 必填,待评估的网站地址 |
| 任务类型 | eval(仅评分)/ plan(评分+方案) |
任务详情(/eval/<task_id>)
任务提交后自动跳转至详情页,展示:
- 状态进度条:queued → running → completed / failed
- 实时进度:百分比 + 当前步骤描述
- 处理日志:时间倒排,每 3 秒自动刷新
- 评分结果:完成后展示总分、国内/国外分、各维度明细
| 任务状态 | 可用操作 |
|---|---|
| 排队中 / 运行中 | 终止任务 |
| 失败 / 已取消 | 重试 |
| 已完成(plan) | 查看改进方案 · 下载报告 ZIP |
评估历史(/history)
- 分页展示所有历史任务(支持 10 / 20 / 50 条每页)
- 每条记录显示:URL、类型、状态、评分、创建时间
- 操作:查看详情、删除(级联删除方案、产出物、日志)
改进方案(/plan/<task_id>)
plan 类型任务完成后生成改进方案:
- 方案条目列表:按优先级分组(high / mid / low)
- 条目标签:标注适配的 AI 引擎(如「适配:豆包、ChatGPT」)
- 条目编辑:点击条目可在线编辑内容
产出物管理(/plan/<task_id>/artifacts)
- 查看已生成的产出物(FAQ、Schema、多平台文章等)
- 在线编辑产出物内容,新增生成尚未创建的产出物
- 单项下载 / 整体打包下载
API 密钥管理(/api-keys)
生成密钥
填写名称 + 有效期(1–3650 天)→ 获得 geo_ 开头的密钥。
查看列表
显示所有密钥的前缀、名称、调用次数、状态,支持行内复制与重新生成。
停用 / 删除
点击「停用」使密钥立即失效;「删除」将移除密钥及其调用日志。
调用明细
点击密钥查看分页调用日志。
算力配置(/llm-config)
用户可配置自己的 LLM 算力:
| 算力方案 | Base URL | API Key 格式 |
|---|---|---|
| 百炼按量付费 | https://dashscope.aliyuncs.com/compatible-mode/v1 | sk- 开头 |
| Token Plan 团队版 | https://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1 | sk-sp- 开头 |
| 自定义 MaaS | 自行填写 | 视端点而定 |
操作步骤:「新增配置」→ 选择方案 → 填写 API Key → 保存 → 「激活」设为当前算力 → 「测试」验证连通性。支持多条配置,同一时间仅一条激活。
优化指导(/guide)
内置 AI 引擎收录指南:各引擎站长平台提交入口(Google / Bing / Perplexity / 百度 / 神马)、国内 AI 模型收录机制(千问 / 豆包 / 混元 / 文心)、robots.txt 配置示例与实操优先级清单。
语言切换
支持中 / 英双语:点击顶部导航栏语言切换按钮(/lang/zh 或 /lang/en),设置会保存到用户偏好。
04开放 API 调用指南
认证
所有 API 请求需携带 Bearer Token,密钥在控制台「API 密钥管理」页面生成:
Authorization: Bearer geo_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
API 端点一览
完整调用流程
Step 1 · 提交任务
$ curl -X POST http://localhost:5001/api/v1/tasks \ -H "Authorization: Bearer geo_your_key" \ -H "Content-Type: application/json" \ -d '{"target_url": "https://example.com", "task_type": "plan"}'
{
"task_id": "67dcbe3c-6bfb-47fa-8856-de467a39cefc",
"status": "pending",
"target_url": "https://example.com",
"task_type": "plan",
"queued": false,
"message": "Task submitted successfully"
}
Step 2 · 轮询状态
$ curl http://localhost:5001/api/v1/tasks/67dcbe3c-... \ -H "Authorization: Bearer geo_your_key"
状态流转:
Step 3 · 获取结果(仅 completed 状态)
{
"task_id": "67dcbe3c-...",
"status": "completed",
"overall_score": 72.5,
"result": {
"url": "https://example.com",
"title": "Example Domain",
"engine_scores": [...],
"strengths": [...],
"weaknesses": [...]
},
"download_url": "/api/v1/tasks/67dcbe3c-.../download"
}
Step 4 · 下载报告
$ curl -o report.zip http://localhost:5001/api/v1/tasks/67dcbe3c-.../download \ -H "Authorization: Bearer geo_your_key"
ZIP 包内容(plan 类型):
geo_analysis_report.md— 完整分析报告schema.jsonld.html— Schema.org 结构化数据wechat_*.md/zhihu_*.md/toutiao_*.md— 国内平台文章medium_*.md/quora_*.md/reddit_*.md— 国际平台文章plan_items/— 分优先级改进方案
终止任务
$ curl -X POST http://localhost:5001/api/v1/tasks/67dcbe3c-.../cancel \ -H "Authorization: Bearer geo_your_key"
错误码
| HTTP 状态 | error 字段 | 说明 |
|---|---|---|
| 400 | invalid_params | 缺少 target_url |
| 401 | missing_token / invalid_token | 密钥缺失或无效 |
| 403 | quota_exceeded | 配额用尽 |
| 403 | forbidden | 无权访问他人任务 |
| 404 | not_found | 任务不存在 |
| 409 | invalid_state | 无法取消已完成的任务 |
| 429 | concurrent_limit | 并发任务数超限 |
Python 客户端
from client.geo_api_client import GeoApiClient with GeoApiClient("http://localhost:5001", "geo_your_key") as client: # 提交任务 task_id = client.submit_task("https://example.com", task_type="plan") # 等待完成(自动轮询) result = client.wait_for_completion(task_id, timeout=600) print(f"GEO Score: {result['overall_score']}") # 下载报告 client.download(task_id, "./output/report.zip") # 查看用量 usage = client.get_usage() print(f"Total calls: {usage['total_calls']}")
05CLI 命令行工具
适合本地开发调试,无需启动 Web 服务。
安装
$ pip install -e . # 或未安装时使用: python -m geo_optimizer <子命令>
命令一览
| 命令 | 说明 |
|---|---|
geo-optimizer analyze <URL> | 爬取 + GEO 分析 |
geo-optimizer optimize <URL> | 完整优化 pipeline |
geo-optimizer export <URL> | 优化 + 多平台导出 |
geo-optimizer report <URL> | 生成分析报告 |
geo-optimizer faq <URL> | 仅生成 FAQ |
geo-optimizer schema <URL> | 仅生成 Schema |
geo-optimizer monitor <URL> | 引擎引用监控 |
环境变量
| 变量 | 说明 |
|---|---|
DASHSCOPE_API_KEY | 百炼 API Key |
GEO_CONFIG | 配置文件路径(默认 geo_config.yaml) |
示例
# 完整分析并导出 $ export DASHSCOPE_API_KEY=sk-xxxxx $ geo-optimizer export https://example.com # 仅评分 $ geo-optimizer analyze https://example.com
06Skill 客户端(AI Agent 集成)
面向 AI Agent 的封装客户端,支持一键完成「提交 → 等待 → 结果 → 下载」全流程。
获取 Skill 文件(公开访问,无需登录)
使用方式
import sys sys.path.insert(0, "docs/geo-skill") from geo_skill_client import GeoSkillClient client = GeoSkillClient("http://localhost:5001", "geo_your_key") # 一键完整分析 result = client.run_full_analysis( target_url="https://example.com", task_type="plan", output_path="./output/report.zip", timeout=600 ) print(f"Score: {result['result']['overall_score']}") print(f"Downloaded: {result['download_path']}")
CLI 模式
$ python docs/geo-skill/geo_skill_client.py \ --base-url http://localhost:5001 \ --api-key geo_your_key \ --url https://example.com \ --type plan \ --output ./report.zip # 查询已有任务状态 $ python docs/geo-skill/geo_skill_client.py --api-key geo_your_key --status <task_id> # JSON 格式输出 $ python docs/geo-skill/geo_skill_client.py --api-key geo_your_key --url https://example.com --json
07常见问题
提交任务时提示「配额不足」怎么办?
联系管理员在「用户管理」中增加您的评估配额。
任务一直处于 queued 状态?
全局并发已满,任务自动排队。等待其他任务完成后自动启动。
任务失败如何重试?
在任务详情页点击「重试」按钮,或调用 API POST /api/v1/tasks/{id}/cancel 后重新提交。
API 密钥忘记了怎么办?
密钥明文仅在生成时展示一次。如遗忘,请在密钥管理页「重新生成」(原地重置)或删除旧密钥后新建。
如何选择算力方案?
如果平台未提供统一算力,您需要自行配置算力方案(/llm-config)。支持百炼按量付费、Token Plan 团队版和自定义 MaaS 三种方案,配置后激活即可使用。若平台已开通算力权限,系统会自动使用平台算力,无需额外配置。
eval 和 plan 任务有什么区别?
eval 仅输出评分报告;plan 在评分基础上额外生成改进方案、FAQ、Schema、六平台适配文章,并打包为 ZIP 下载。
支持哪些 AI 引擎的评估?
国内 5 个(豆包、通义千问、混元、智谱清言、DeepSeek)+ 国际 6 个(Google AI、ChatGPT Search、Perplexity、Claude、Copilot、Gemini),共 11 个。
平台支持哪些语言?
中文和英文双语。通过顶部导航栏切换,设置会保存到用户偏好。