Blame view

suggestion/README.md 1.25 KB
ff9efda0   tangwang   suggest
1
  # Suggestion 模块说明(统一入口)
ded6f29e   tangwang   补充suggestion模块
2
  
ff9efda0   tangwang   suggest
3
  本文档是 suggestion 模块的统一入口,遵循 `docs/DEVELOPER_GUIDE.md` 的“单一入口、避免分叉”原则。
316c97c4   tangwang   feat: 完整落地多租户 sug...
4
  
ff9efda0   tangwang   suggest
5
  ## 1. 当前状态(Phase 2)
316c97c4   tangwang   feat: 完整落地多租户 sug...
6
  
ff9efda0   tangwang   suggest
7
8
9
10
11
12
  - 仅保留 Suggest 自动补全能力
  - 不支持结果直达(`with_results` / `result_size` / `products[]` 已移除)
  - 索引采用版本化发布:
    - 物理索引:`{ES_INDEX_NAMESPACE}search_suggestions_tenant_{tenant_id}_v<timestamp>`
    - 读别名:`{ES_INDEX_NAMESPACE}search_suggestions_tenant_{tenant_id}_current`
  - 支持增量更新(watermark + overlap)
ded6f29e   tangwang   补充suggestion模块
13
  
ff9efda0   tangwang   suggest
14
  ## 2. 文档导航(唯一推荐顺序)
ded6f29e   tangwang   补充suggestion模块
15
  
ff9efda0   tangwang   suggest
16
17
18
  1. `ARCHITECTURE_V2.md`:架构与设计原则
  2. `RUNBOOK.md`:构建/发布/验证流程
  3. `TROUBLESHOOTING.md`:常见问题排查
ded6f29e   tangwang   补充suggestion模块
19
  
ff9efda0   tangwang   suggest
20
  ## 3. 命令入口
ded6f29e   tangwang   补充suggestion模块
21
  
ff9efda0   tangwang   suggest
22
  - 全量或增量构建:
316c97c4   tangwang   feat: 完整落地多租户 sug...
23
24
  
  ```bash
ff9efda0   tangwang   suggest
25
26
  ./scripts/build_suggestions.sh <tenant_id> --mode full
  ./scripts/build_suggestions.sh <tenant_id> --mode incremental
316c97c4   tangwang   feat: 完整落地多租户 sug...
27
28
  ```
  
ff9efda0   tangwang   suggest
29
  - 一键重建 + 验证:
316c97c4   tangwang   feat: 完整落地多租户 sug...
30
31
  
  ```bash
ff9efda0   tangwang   suggest
32
  ./scripts/rebuild_suggestions.sh <tenant_id>
316c97c4   tangwang   feat: 完整落地多租户 sug...
33
34
  ```
  
ff9efda0   tangwang   suggest
35
  ## 4. API 约定(简版)
316c97c4   tangwang   feat: 完整落地多租户 sug...
36
  
ff9efda0   tangwang   suggest
37
38
39
  - 端点:`GET /search/suggestions`
  - 参数:`q`, `size`, `language`
  - Header:`X-Tenant-ID`
316c97c4   tangwang   feat: 完整落地多租户 sug...
40
  
ff9efda0   tangwang   suggest
41
  示例:
316c97c4   tangwang   feat: 完整落地多租户 sug...
42
43
  
  ```bash
ff9efda0   tangwang   suggest
44
45
  curl "http://localhost:6002/search/suggestions?q=shi&size=10&language=en" \
    -H "X-Tenant-ID: 162"
316c97c4   tangwang   feat: 完整落地多租户 sug...
46
  ```