Blame view

README.md 7.88 KB
9c712e64   tangwang   增加索引字段qanchors ke...
1
  
19d2d90f   tangwang   卖家精灵数据
2
3
4
  # TODO
  多语言:
  语义:
472cca0c   tangwang   doc
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
  多语言:
  1. dis_max的方式
  "query" : {
    "dis_max" : {
      "queries" : [
        {"match" : { "title_en" : xxx }},
        {"match" : { "title_zh" : xxx }},
        {"match" : { "title_xx" : xxx }}    
      ],
      "tie_breakler" : 0.8
    }
  }
  
  
  
  "corss_field":
  "multi_match" : {
    "query" : 
    "fields" : [...],
    "type": "cross_fields",
    "operator" : "and"
  }
  
  
  支持英文的拼写接错:
  title: multi_field
  "query" : {
    "query_string" : {
      "query": "xxx",
      "default_field": "title.ngram",
      "minimum_should_match": "85%"
    }
  }
  
  
  
  业务提权:
  rescore: window_size query_weight rescore_query_weight
  
  function_score:
  boost
  以及 可以把每个子查询用function_score包一下
  
  
19d2d90f   tangwang   卖家精灵数据
49
  
9c712e64   tangwang   增加索引字段qanchors ke...
50
  
7bfb9946   tangwang   向量化模块
51
  query anchor  
9c712e64   tangwang   增加索引字段qanchors ke...
52
53
54
55
56
57
58
59
60
  我想给elasticsearch 增加字段 query anchor ,即哪些query点击到了这个doc,一个doc下面有多个query anchor,每个query anchor又有这两个属性:weight、dweight,分别代表 query在doc下的点击分布权重、doc在query下的点击分布权重。请问该如何设计这两个ES字段。
  
  需要有zh en两套query anchor,因为他们的解析器不一样。
  
  他的功能是辅助召回和排序。我搜索一个query,那么每个query跟 doc中的query anchor的相关性,也就是,除了将query到title 和keywords / brief等文本字段中搜索,也到 query anchor中搜索,从而辅助召回和相关性的计算。
  
  
  
  
768ad710   tangwang   MySQL到ES字段映射说明-业务...
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
  
  对外:
  embedding服务:
    curl -X POST http://120.76.41.98:6005/embed/text \
      -H "Content-Type: application/json" \
      -d '["衣服", "Bohemian Maxi Dress"]'
  
  
  翻译服务:
  # 方式1:直接运行
  python api/translator_app.py
  # 方式2:使用 uvicorn
  uvicorn api.translator_app:app --host 0.0.0.0 --port 6006 --reload
  
  curl -X POST http://localhost:6006/translate      -H "Content-Type: application/json"      -d '{
         "text": "商品名称",
         "target_lang": "en",
         "source_lang": "zh"
       }'
  
  localhost替换为
  服务器内网地址:
  10.0.163.168
  公网地址:
  120.76.41.98
  
  
670c701f   tangwang   文档完善
88
  # 电商搜索引擎 SaaS
be52af70   tangwang   first commit
89
  
670c701f   tangwang   文档完善
90
  一个针对跨境独立站(店匠 Shoplazza 等)的多租户可配置搜索平台。README 作为项目导航入口,帮助你在不同阶段定位到更详细的文档。
be52af70   tangwang   first commit
91
  
a10a89a3   tangwang   构造测试数据用于测试分类 和 三种...
92
  
acf1349c   tangwang   fake 批量导入数据的脚步 ( ...
93
94
95
  ## 项目环境
  source /home/tw/miniconda3/etc/profile.d/conda.sh
  conda activate searchengine
33839b37   tangwang   属性值参与搜索:
96
  source .env
acf1349c   tangwang   fake 批量导入数据的脚步 ( ...
97
  
a10a89a3   tangwang   构造测试数据用于测试分类 和 三种...
98
99
  ## 测试pipeline
  
148ab60d   tangwang   docs
100
101
102
  1. 
  店铺1  tenant_id=162:
  fake数据 生成商品导入数据 提交到店匠的店铺:
a10a89a3   tangwang   构造测试数据用于测试分类 和 三种...
103
104
  cd /home/tw/SearchEngine && source /home/tw/miniconda3/etc/profile.d/conda.sh && conda activate searchengine && python scripts/csv_to_excel_multi_variant.py --output  with_colors.xlsx 
  
148ab60d   tangwang   docs
105
106
107
  店铺2  tenant_id= 
  
  
f3c11fef   tangwang   亚马逊格式数据 导入店匠
108
109
110
  2. 后端:自动同步到mysql
  
  3. mysql到ES:
a10a89a3   tangwang   构造测试数据用于测试分类 和 三种...
111
112
113
114
115
116
117
118
119
120
  
  python scripts/recreate_and_import.py \
      --tenant-id 162 \
      --db-host <mysql_host> \
      --db-database saas \
      --db-username saas \
      --db-password <password> \
      --es-host http://localhost:9200
  
  构造查询:
33839b37   tangwang   属性值参与搜索:
121
  参考 @常用查询 - ES.md
a10a89a3   tangwang   构造测试数据用于测试分类 和 三种...
122
123
  
  
670c701f   tangwang   文档完善
124
  ## 核心能力速览
be52af70   tangwang   first commit
125
  
670c701f   tangwang   文档完善
126
127
128
129
130
131
  - **多语言 + 自动翻译**:中文、英文、俄文等语言检测与路由(BGE-M3、DeepL)
  - **语义 + 关键词混排**:BM25、dense vector(BGE-M3/CN-CLIP)融合
  - **布尔与分面**:AND / OR / ANDNOT / RANK、Terms & Range facets
  - **多租户隔离**:共享 `search_products` 索引,通过 `tenant_id` 严格隔离
  - **可配置化**:字段/索引域/排序表达式/查询改写全部配置驱动
  - **脚本化流水线**:Mock/CSV 数据 → MySQL → Elasticsearch → API/前端
be52af70   tangwang   first commit
132
  
670c701f   tangwang   文档完善
133
  ## 快速上手(概览)
be52af70   tangwang   first commit
134
  
670c701f   tangwang   文档完善
135
136
  | 步骤 | 去哪里看 | 摘要 |
  |------|---------|------|
4a677843   tangwang   文档完善
137
138
139
140
141
142
  | 1. 准备环境 | `环境配置说明.md` / `Usage-Guide.md` | Conda/依赖、Elasticsearch、MySQL、必需变量 |
  | 2. 构造测试数据 | `测试数据指南.md` | Tenant1 Mock、Tenant2 CSV、`mock_data.sh` / `ingest.sh` |
  | 3. 启动与验证 | `Usage-Guide.md` | `run.sh` 一键启动、分步脚本、日志与健康检查 |
  | 4. 理解架构 | `系统设计文档.md` | 数据流、配置系统、查询/搜索/索引模块 |
  | 5. 接入搜索 API | `搜索API对接指南.md` / `搜索API速查表.md` | REST 端点、参数、响应、最佳实践 |
  | 6. 查字段定义 | `索引字段说明.md` | `search_products` 映射、字段来源、类型与用途 |
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
143
  
670c701f   tangwang   文档完善
144
  > README 仅保留最常用命令的“索引”。细节以主题文档为准。
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
145
  
670c701f   tangwang   文档完善
146
  ### Runtimes & 命令示例
be52af70   tangwang   first commit
147
148
  
  ```bash
670c701f   tangwang   文档完善
149
150
151
  # 1. 安装依赖与准备服务
  pip install -r requirements.txt                      # 详见 USAGE_GUIDE.md
  docker run -d --name es -p 9200:9200 elasticsearch:8.11.0
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
152
  
670c701f   tangwang   文档完善
153
154
  # 2. 构造测试数据并导入 MySQL
  ./scripts/mock_data.sh                               # 详见 TEST_DATA_GUIDE.md
be52af70   tangwang   first commit
155
  
670c701f   tangwang   文档完善
156
157
158
  # 3. 从 MySQL 注入到 Elasticsearch
  ./scripts/ingest.sh 1 true
  ./scripts/ingest.sh 2 true
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
159
  
670c701f   tangwang   文档完善
160
161
  # 4. 启动服务
  ./run.sh
be52af70   tangwang   first commit
162
  
7bfb9946   tangwang   向量化模块
163
164
165
166
167
168
169
  # (可选)启动本地向量服务(BGE-M3 / CN-CLIP,本地模型推理)
  # 提供: POST http://localhost:6005/embed/text
  #       POST http://localhost:6005/embed/image
  ./scripts/start_embedding_service.sh
  #
  # 详细说明见:`embeddings/README.md`
  
670c701f   tangwang   文档完善
170
  # 5. 调用文本搜索 API
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
171
  curl -X POST http://localhost:6002/search/ \
be52af70   tangwang   first commit
172
    -H "Content-Type: application/json" \
670c701f   tangwang   文档完善
173
174
    -H "X-Tenant-ID: 1" \
    -d '{"query": "玩具", "size": 10}'
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
175
176
  ```
  
670c701f   tangwang   文档完善
177
  ## 文档地图
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
178
  
670c701f   tangwang   文档完善
179
180
  | 文档 | 内容提要 | 适用场景 |
  |------|----------|----------|
4a677843   tangwang   文档完善
181
182
  | `环境配置说明.md` | 系统要求、Conda/依赖、外部服务账号、常用端口 | 首次部署、环境核对 |
  | `Usage-Guide.md` | 环境准备、服务启动、配置、日志、验证手册 | 日常运维、调试 |
f7d3cf70   tangwang   更新文档
183
  | `基础配置指南.md` | 统一硬编码配置说明、索引结构、查询配置 | 了解系统配置、修改配置 |
4a677843   tangwang   文档完善
184
185
186
  | `测试数据指南.md` | 两个租户的模拟/CSV 数据构造 & MySQL→ES 流程 | 数据准备、联调 |
  | `测试Pipeline说明.md` | 测试流水线、CI 脚本、上下文说明 | 自动化测试、追踪流水线 |
  | `系统设计文档.md` | 架构、配置系统、索引/查询/排序模块细节 | 研发/扩展功能 |
f7d3cf70   tangwang   更新文档
187
  | `索引字段说明v2.md` | `search_products` 字段、类型、来源、嵌套结构 | 新增字段、数据对齐 |
4a677843   tangwang   文档完善
188
189
190
191
  | `搜索API对接指南.md` | REST API(文本/图片/管理)详解、示例、响应格式 | API 使用、测试 |
  | `搜索API速查表.md` | 常用请求体、过滤器、分面速查表 | 支持团队快速查阅 |
  | `Search-API-Examples.md` | Python/JS/cURL 端到端示例 | 客户工程、SDK 参考 |
  | `环境配置说明.md` + `.env` 模板 | 运行依赖账号、端口、密钥对照表 | 交付 & 运维 |
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
192
  
670c701f   tangwang   文档完善
193
  更多补充材料:
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
194
  
4a677843   tangwang   文档完善
195
  - `测试数据指南.md`:包含完整工作流脚本示例
670c701f   tangwang   文档完善
196
197
  - `商品数据源入ES配置规范.md`:数据源映射约定
  - `MULTILANG_FEATURE.md`:多语言处理细节
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
198
  
670c701f   tangwang   文档完善
199
  ## 关键工作流指引
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
200
  
670c701f   tangwang   文档完善
201
202
203
  - **数据构建 → MySQL → Elasticsearch**  
    - `scripts/mock_data.sh`:Tenant1 Mock + Tenant2 CSV 一条龙  
    - `scripts/ingest.sh <tenant_id> [recreate]`:驱动 `indexer/` 模块写入 `search_products`
4a677843   tangwang   文档完善
204
    - 详解:`测试数据指南.md`
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
205
  
670c701f   tangwang   文档完善
206
207
  - **搜索服务 & API**  
    - `api/`(FastAPI)承载 REST API,`search/` + `query/` 负责查询解析与下发  
4a677843   tangwang   文档完善
208
209
    - API、分页、过滤、Facet、KNN 等:`搜索API对接指南.md`
    - 对接案例、示例与错误码:`搜索API对接指南.md`、`Search-API-Examples.md`
be52af70   tangwang   first commit
210
  
f7d3cf70   tangwang   更新文档
211
212
213
214
215
  - **统一配置**  
    - 所有租户共享统一的索引结构和查询配置(硬编码)  
    - 索引 mapping: `mappings/search_products.json`  
    - 查询配置: `search/query_config.py`  
    - 详解:`基础配置指南.md`、`索引字段说明v2.md`
a5a3856d   tangwang   店匠体系数据的搜索:mock da...
216
  
670c701f   tangwang   文档完善
217
  ## 仓库结构(概览)
be52af70   tangwang   first commit
218
  
be52af70   tangwang   first commit
219
  ```
670c701f   tangwang   文档完善
220
221
222
223
224
225
226
227
  api/            FastAPI 服务与路由
  config/         字段/索引/查询配置体系
  indexer/        MySQL → ES 管道(mapping / transformer / bulk)
  query/          查询解析、改写、翻译、embedding
  search/         多语言构建、布尔解析、排序引擎
  scripts/        数据/服务脚本(mock_data, ingest, run 等)
  frontend/       简易调试页面
  docs/           运营及中文资料
be52af70   tangwang   first commit
228
  ```