b73baf85
tangwang
撰写接口文档
|
1
2
3
4
5
6
7
|
# 搜索API接口对接指南
本文档为搜索服务的使用方提供完整的API对接指南,包括接口说明、请求参数、响应格式和使用示例。
## 目录
1. [快速开始](#快速开始)
|
11237cf2
tangwang
搜索API对接指南.md
|
8
9
10
11
12
|
- 1.1 [基础信息](#11-基础信息)
- 1.2 [最简单的搜索请求](#12-最简单的搜索请求)
- 1.3 [带过滤与分页的搜索](#13-带过滤与分页的搜索)
- 1.4 [开启分面的搜索](#14-开启分面的搜索)
|
b73baf85
tangwang
撰写接口文档
|
13
|
2. [接口概览](#接口概览)
|
11237cf2
tangwang
搜索API对接指南.md
|
14
|
|
af249836
tangwang
文档完善
|
15
|
3. [搜索接口](#搜索接口)
|
11237cf2
tangwang
搜索API对接指南.md
|
16
17
18
19
20
|
- 3.1 [接口信息](#31-接口信息)
- 3.2 [请求参数](#32-请求参数)
- 3.3 [过滤器详解](#33-过滤器详解)
- 3.4 [分面配置](#34-分面配置)
- 3.5 [SKU筛选维度](#35-sku筛选维度)
|
bd96cead
tangwang
1. 动态多语言字段与统一策略配置
|
21
22
23
|
- 3.6 [搜索建议接口](#37-搜索建议接口)
- 3.7 [即时搜索接口](#38-即时搜索接口)
- 3.8 [获取单个文档](#39-获取单个文档)
|
11237cf2
tangwang
搜索API对接指南.md
|
24
|
|
af249836
tangwang
文档完善
|
25
|
4. [响应格式说明](#响应格式说明)
|
11237cf2
tangwang
搜索API对接指南.md
|
26
27
|
- 4.1 [标准响应结构](#41-标准响应结构)
- 4.2 [响应字段说明](#42-响应字段说明)
|
3a5fda00
tangwang
1. ES字段 skus的 ima...
|
28
|
- 4.2.1 [query_info 说明](#421-query_info-说明)
|
11237cf2
tangwang
搜索API对接指南.md
|
29
30
31
32
33
|
- 4.3 [SpuResult字段说明](#43-spuresult字段说明)
- 4.4 [SkuResult字段说明](#44-skuresult字段说明)
- 4.5 [多语言字段说明](#45-多语言字段说明)
5. [索引接口](#索引接口)
|
80f87e57
tangwang
多语言索引修改 对应的 索引创建、...
|
34
35
|
- 5.0 [为租户创建索引](#50-为租户创建索引)
- 5.1 [全量索引接口](#51-全量索引接口)
|
775ef237
tangwang
docs: 更新文档目录,修正索引...
|
36
37
38
|
- 5.2 [增量索引接口](#52-增量索引接口)
- 5.3 [查询文档接口](#53-查询文档接口)
- 5.4 [索引健康检查接口](#54-索引健康检查接口)
|
2e3670ab
tangwang
index services
|
39
40
|
- 5.5 [文档构建接口(正式对接)](#55-文档构建接口正式对接推荐)
- 5.6 [文档构建接口(测试/自测)](#56-文档构建接口测试--自测)
|
11237cf2
tangwang
搜索API对接指南.md
|
41
42
43
44
45
46
|
6. [管理接口](#管理接口)
- 6.1 [健康检查](#61-健康检查)
- 6.2 [获取配置](#62-获取配置)
- 6.3 [索引统计](#63-索引统计)
|
07cf5a93
tangwang
START_EMBEDDING=...
|
47
48
49
50
51
52
53
54
55
56
57
|
7. [微服务接口(向量、重排、翻译)](#7-微服务接口向量重排翻译)
- 7.1 [向量服务(Embedding)](#71-向量服务embedding)
- 7.2 [重排服务(Reranker)](#72-重排服务reranker)
- 7.3 [翻译服务(Translation)](#73-翻译服务translation)
8. [常见场景示例](#8-常见场景示例)
- 8.1 [基础搜索与排序](#81-基础搜索与排序)
- 8.2 [过滤搜索](#82-过滤搜索)
- 8.3 [分面搜索](#83-分面搜索)
- 8.4 [规格过滤与分面](#84-规格过滤与分面)
- 8.5 [SKU筛选](#85-sku筛选)
|
bd96cead
tangwang
1. 动态多语言字段与统一策略配置
|
58
|
- 8.6 [分页查询](#87-分页查询)
|
07cf5a93
tangwang
START_EMBEDDING=...
|
59
60
61
62
63
64
|
9. [数据模型](#9-数据模型)
- 9.1 [商品字段定义](#91-商品字段定义)
- 9.2 [字段类型速查](#92-字段类型速查)
- 9.3 [常用字段列表](#93-常用字段列表)
- 9.4 [支持的分析器](#94-支持的分析器)
|
b73baf85
tangwang
撰写接口文档
|
65
66
67
68
69
|
---
## 快速开始
|
11237cf2
tangwang
搜索API对接指南.md
|
70
|
### 1.1 基础信息
|
b73baf85
tangwang
撰写接口文档
|
71
|
|
484adbfe
tangwang
adapt ubuntu; con...
|
72
|
- **Base URL**: `http://43.166.252.75:6002`
|
b73baf85
tangwang
撰写接口文档
|
73
74
75
76
77
|
- **协议**: HTTP/HTTPS
- **数据格式**: JSON
- **字符编码**: UTF-8
- **请求方法**: POST(搜索接口)
|
11237cf2
tangwang
搜索API对接指南.md
|
78
79
|
**重要提示**: `tenant_id` 通过 HTTP Header `X-Tenant-ID` 传递,不在请求体中。
|
07cf5a93
tangwang
START_EMBEDDING=...
|
80
81
|
**环境与凭证**:MySQL、Redis、Elasticsearch 等外部服务的 AI 生产地址与凭证见 [QUICKSTART.md §1.6](./QUICKSTART.md#16-外部服务与-env含生产凭证)。
|
11237cf2
tangwang
搜索API对接指南.md
|
82
|
### 1.2 最简单的搜索请求
|
b73baf85
tangwang
撰写接口文档
|
83
84
|
```bash
|
484adbfe
tangwang
adapt ubuntu; con...
|
85
|
curl -X POST "http://43.166.252.75:6002/search/" \
|
b73baf85
tangwang
撰写接口文档
|
86
|
-H "Content-Type: application/json" \
|
a10a89a3
tangwang
构造测试数据用于测试分类 和 三种...
|
87
|
-H "X-Tenant-ID: 162" \
|
97a5d59d
tangwang
文档修改
|
88
|
-d '{"query": "芭比娃娃"}'
|
b73baf85
tangwang
撰写接口文档
|
89
90
|
```
|
11237cf2
tangwang
搜索API对接指南.md
|
91
|
### 1.3 带过滤与分页的搜索
|
b73baf85
tangwang
撰写接口文档
|
92
|
|
b0ad8e89
tangwang
文档完善
|
93
|
```bash
|
484adbfe
tangwang
adapt ubuntu; con...
|
94
|
curl -X POST "http://43.166.252.75:6002/search/" \
|
b0ad8e89
tangwang
文档完善
|
95
|
-H "Content-Type: application/json" \
|
a10a89a3
tangwang
构造测试数据用于测试分类 和 三种...
|
96
|
-H "X-Tenant-ID: 162" \
|
b0ad8e89
tangwang
文档完善
|
97
|
-d '{
|
97a5d59d
tangwang
文档修改
|
98
|
"query": "芭比娃娃",
|
b0ad8e89
tangwang
文档完善
|
99
100
|
"size": 5,
"from": 10,
|
11237cf2
tangwang
搜索API对接指南.md
|
101
102
103
104
105
106
107
108
|
"range_filters": {
"min_price": {
"gte": 50,
"lte": 200
},
"create_time": {
"gte": "2020-01-01T00:00:00Z"
}
|
b0ad8e89
tangwang
文档完善
|
109
|
},
|
13320ac6
tangwang
分面接口修改:
|
110
|
"sort_by": "price",
|
b0ad8e89
tangwang
文档完善
|
111
112
|
"sort_order": "asc"
}'
|
b73baf85
tangwang
撰写接口文档
|
113
114
|
```
|
11237cf2
tangwang
搜索API对接指南.md
|
115
|
### 1.4 开启分面的搜索
|
b73baf85
tangwang
撰写接口文档
|
116
|
|
b0ad8e89
tangwang
文档完善
|
117
|
```bash
|
484adbfe
tangwang
adapt ubuntu; con...
|
118
|
curl -X POST "http://43.166.252.75:6002/search/" \
|
b0ad8e89
tangwang
文档完善
|
119
|
-H "Content-Type: application/json" \
|
a10a89a3
tangwang
构造测试数据用于测试分类 和 三种...
|
120
|
-H "X-Tenant-ID: 162" \
|
b0ad8e89
tangwang
文档完善
|
121
|
-d '{
|
b0ad8e89
tangwang
文档完善
|
122
|
"query": "芭比娃娃",
|
13320ac6
tangwang
分面接口修改:
|
123
124
125
126
127
|
"facets": [
{"field": "category1_name", "size": 10, "type": "terms"},
{"field": "specifications.color", "size": 10, "type": "terms"},
{"field": "specifications.size", "size": 10, "type": "terms"}
],
|
97a5d59d
tangwang
文档修改
|
128
|
"min_score": 0.2
|
b0ad8e89
tangwang
文档完善
|
129
|
}'
|
b73baf85
tangwang
撰写接口文档
|
130
131
132
133
134
135
|
```
---
## 接口概览
|
3c1f8031
tangwang
api/routes/indexe...
|
136
137
138
|
| 接口 | HTTP Method | Endpoint | 说明 |
|------|------|------|------|
| 搜索 | POST | `/search/` | 执行搜索查询 |
|
316c97c4
tangwang
feat: 完整落地多租户 sug...
|
139
|
| 搜索建议 | GET | `/search/suggestions` | 搜索建议(自动补全/热词,多语言 + 结果直达) |
|
26b910bd
tangwang
refactor service ...
|
140
|
| 即时搜索 | GET | `/search/instant` | 即时搜索预留接口(当前返回 `501 Not Implemented`) |
|
11237cf2
tangwang
搜索API对接指南.md
|
141
|
| 获取文档 | GET | `/search/{doc_id}` | 获取单个文档 |
|
89638140
tangwang
重构 indexer 文档构建接口...
|
142
143
|
| 全量索引 | POST | `/indexer/reindex` | 全量索引接口(导入数据,不删除索引,仅推荐自测使用) |
| 增量索引 | POST | `/indexer/index` | 增量索引接口(指定SPU ID列表进行索引,支持自动检测删除和显式删除,仅推荐自测使用) |
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
144
|
| 查询文档 | POST | `/indexer/documents` | 查询SPU文档数据(不写入ES) |
|
89638140
tangwang
重构 indexer 文档构建接口...
|
145
146
|
| 构建ES文档(正式对接) | POST | `/indexer/build-docs` | 基于上游提供的 MySQL 行数据构建 ES doc,不写入 ES,供 Java 等调用后自行写入 |
| 构建ES文档(测试用) | POST | `/indexer/build-docs-from-db` | 仅在测试/调试时使用,根据 `tenant_id + spu_ids` 内部查库并构建 ES doc |
|
3c1f8031
tangwang
api/routes/indexe...
|
147
|
| 索引健康检查 | GET | `/indexer/health` | 检查索引服务状态 |
|
3c1f8031
tangwang
api/routes/indexe...
|
148
|
| 健康检查 | GET | `/admin/health` | 服务健康检查 |
|
11237cf2
tangwang
搜索API对接指南.md
|
149
|
| 获取配置 | GET | `/admin/config` | 获取租户配置 |
|
26b910bd
tangwang
refactor service ...
|
150
|
| 索引统计 | GET | `/admin/stats` | 获取租户索引统计信息(需 tenant_id) |
|
b73baf85
tangwang
撰写接口文档
|
151
|
|
07cf5a93
tangwang
START_EMBEDDING=...
|
152
153
154
155
156
157
158
159
160
|
**微服务(独立端口,外部可直连)**:
| 服务 | 端口 | 接口 | 说明 |
|------|------|------|------|
| 向量服务 | 6005 | `POST /embed/text` | 文本向量化 |
| 向量服务 | 6005 | `POST /embed/image` | 图片向量化 |
| 翻译服务 | 6006 | `POST /translate` | 文本翻译(Qwen/DeepL) |
| 重排服务 | 6007 | `POST /rerank` | 检索结果重排 |
|
b73baf85
tangwang
撰写接口文档
|
161
162
|
---
|
af249836
tangwang
文档完善
|
163
|
## 搜索接口
|
b73baf85
tangwang
撰写接口文档
|
164
|
|
11237cf2
tangwang
搜索API对接指南.md
|
165
|
### 3.1 接口信息
|
b73baf85
tangwang
撰写接口文档
|
166
167
|
- **端点**: `POST /search/`
|
bd96cead
tangwang
1. 动态多语言字段与统一策略配置
|
168
|
- **描述**: 执行文本搜索查询,支持多语言、过滤器和分面搜索
|
cd6d887e
tangwang
reranker doc
|
169
170
171
172
173
174
175
176
177
178
179
|
- **租户标识**:`tenant_id` 通过 HTTP 请求头 **`X-Tenant-ID`** 传递(推荐);也可通过 URL query 参数 **`tenant_id`** 传递。**不要放在请求体中。**
**请求示例(推荐)**:
```python
url = f"{base_url.rstrip('/')}/search/"
headers = {
"Content-Type": "application/json",
"X-Tenant-ID": "162", # 租户ID,必填
}
response = requests.post(url, headers=headers, json={"query": "芭比娃娃"})
```
|
b73baf85
tangwang
撰写接口文档
|
180
|
|
11237cf2
tangwang
搜索API对接指南.md
|
181
|
### 3.2 请求参数
|
b73baf85
tangwang
撰写接口文档
|
182
183
184
185
186
|
#### 完整请求体结构
```json
{
|
b73baf85
tangwang
撰写接口文档
|
187
188
189
|
"query": "string (required)",
"size": 10,
"from": 0,
|
f7d3cf70
tangwang
更新文档
|
190
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
191
192
193
194
195
196
|
"filters": {},
"range_filters": {},
"facets": [],
"sort_by": "string",
"sort_order": "desc",
"min_score": 0.0,
|
a3a5d41b
tangwang
(sku_filter_dimen...
|
197
|
"sku_filter_dimension": ["string"],
|
b73baf85
tangwang
撰写接口文档
|
198
|
"debug": false,
|
ff32d894
tangwang
rerank
|
199
200
201
|
"enable_rerank": false,
"rerank_query_template": "{query}",
"rerank_doc_template": "{title}",
|
b73baf85
tangwang
撰写接口文档
|
202
203
204
205
206
|
"user_id": "string",
"session_id": "string"
}
```
|
b73baf85
tangwang
撰写接口文档
|
207
208
209
210
|
#### 参数详细说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|------|------|------|--------|------|
|
bd96cead
tangwang
1. 动态多语言字段与统一策略配置
|
211
|
| `query` | string | Y | - | 搜索查询字符串(统一文本检索策略) |
|
af249836
tangwang
文档完善
|
212
213
|
| `size` | integer | N | 10 | 返回结果数量(1-100) |
| `from` | integer | N | 0 | 分页偏移量(用于分页) |
|
f7d3cf70
tangwang
更新文档
|
214
|
| `language` | string | N | "zh" | 返回语言:`zh`(中文)或 `en`(英文)。后端会根据此参数选择对应的中英文字段返回 |
|
11237cf2
tangwang
搜索API对接指南.md
|
215
216
217
|
| `filters` | object | N | null | 精确匹配过滤器(见[过滤器详解](#33-过滤器详解)) |
| `range_filters` | object | N | null | 数值范围过滤器(见[过滤器详解](#33-过滤器详解)) |
| `facets` | array | N | null | 分面配置(见[分面配置](#34-分面配置)) |
|
13320ac6
tangwang
分面接口修改:
|
218
219
|
| `sort_by` | string | N | null | 排序字段名。支持:`price`(价格)、`sales`(销量)、`create_time`(创建时间)、`update_time`(更新时间)。默认按相关性排序 |
| `sort_order` | string | N | "desc" | 排序方向:`asc`(升序)或 `desc`(降序)。注意:`price`+`asc`=价格从低到高,`price`+`desc`=价格从高到低(后端自动映射为min_price或max_price) |
|
af249836
tangwang
文档完善
|
220
|
| `min_score` | float | N | null | 最小相关性分数阈值 |
|
11237cf2
tangwang
搜索API对接指南.md
|
221
|
| `sku_filter_dimension` | array[string] | N | null | 子SKU筛选维度列表(见[SKU筛选维度](#35-sku筛选维度)) |
|
af249836
tangwang
文档完善
|
222
|
| `debug` | boolean | N | false | 是否返回调试信息 |
|
ff32d894
tangwang
rerank
|
223
224
225
|
| `enable_rerank` | boolean | N | false | 是否开启重排(调用外部重排服务对 ES 结果进行二次排序)。开启后若 `from+size<=rerank_window` 才会触发重排 |
| `rerank_query_template` | string | N | null | 重排 query 模板(可选)。支持 `{query}` 占位符;不传则使用服务端配置 |
| `rerank_doc_template` | string | N | null | 重排 doc 模板(可选)。支持 `{title} {brief} {vendor} {description} {category_path}`;不传则使用服务端配置 |
|
af249836
tangwang
文档完善
|
226
227
|
| `user_id` | string | N | null | 用户ID(用于个性化,预留) |
| `session_id` | string | N | null | 会话ID(用于分析,预留) |
|
b73baf85
tangwang
撰写接口文档
|
228
|
|
11237cf2
tangwang
搜索API对接指南.md
|
229
|
### 3.3 过滤器详解
|
b73baf85
tangwang
撰写接口文档
|
230
|
|
11237cf2
tangwang
搜索API对接指南.md
|
231
|
#### 3.3.1 精确匹配过滤器 (filters)
|
b73baf85
tangwang
撰写接口文档
|
232
|
|
985d7fe3
tangwang
为 filters 中所有字段加上...
|
233
|
用于精确匹配或多值匹配。对于普通字段,数组表示 OR 逻辑(匹配任意一个值);对于 specifications 字段,按维度分组处理。**任意字段名加 `_all` 后缀**表示多值 AND 逻辑(必须同时匹配所有值)。
|
b73baf85
tangwang
撰写接口文档
|
234
235
236
237
238
|
**格式**:
```json
{
"filters": {
|
985d7fe3
tangwang
为 filters 中所有字段加上...
|
239
240
241
242
243
244
245
246
|
"category_name": "手机", // 可以为单值 或者 数组 匹配数组中任意一个(OR)
"category1_name": "服装", // 可以为单值 或者 数组 匹配数组中任意一个(OR)
"category2_name": "男装", // 可以为单值 或者 数组 匹配数组中任意一个(OR)
"category3_name": "衬衫", // 可以为单值 或者 数组 匹配数组中任意一个(OR)
"vendor.zh.keyword": ["奇乐", "品牌A"], // 可以为单值 或者 数组 匹配数组中任意一个(OR)
"tags": "手机", // 可以为单值 或者 数组 匹配数组中任意一个(OR)
"tags_all": ["手机", "促销", "新品"], // *_all:多值为 AND,必须同时包含所有标签
"category1_name_all": ["服装", "男装"], // 同上,适用于任意可过滤字段
|
f7d3cf70
tangwang
更新文档
|
247
248
249
250
251
|
// specifications 嵌套过滤(特殊格式)
"specifications": {
"name": "color",
"value": "white"
}
|
b73baf85
tangwang
撰写接口文档
|
252
253
254
255
256
257
258
259
|
}
}
```
**支持的值类型**:
- 字符串:精确匹配
- 整数:精确匹配
- 布尔值:精确匹配
|
985d7fe3
tangwang
为 filters 中所有字段加上...
|
260
|
- 数组:匹配任意值(OR 逻辑);若字段名以 `_all` 结尾,则数组表示 AND 逻辑(必须同时匹配所有值)
|
f7d3cf70
tangwang
更新文档
|
261
262
|
- 对象:specifications 嵌套过滤(见下文)
|
985d7fe3
tangwang
为 filters 中所有字段加上...
|
263
264
265
266
267
|
**`*_all` 语义(多值 AND)**:
- 任意过滤字段均可使用 `_all` 后缀,对应 ES 字段名为去掉 `_all` 后的名称。
- 例如:`tags_all: ["A", "B"]` 表示文档的 `tags` 必须**同时包含** A 和 B;`vendor.zh.keyword_all: ["奇乐", "品牌A"]` 表示同时匹配两个品牌(通常用于 keyword 多值场景)。
- `specifications_all`:传列表 `[{"name":"color","value":"white"},{"name":"size","value":"256GB"}]` 时,表示所有列出的规格条件都要满足(与 `specifications` 多维度时的 AND 一致;若同维度多值则要求文档同时满足多个值,一般用于嵌套多值场景)。
|
f7d3cf70
tangwang
更新文档
|
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
**Specifications 嵌套过滤**:
`specifications` 是嵌套字段,支持按规格名称和值进行过滤。
**单个规格过滤**:
```json
{
"filters": {
"specifications": {
"name": "color",
"value": "white"
}
}
}
```
查询规格名称为"color"且值为"white"的商品。
|
85f08823
tangwang
过滤逻辑
|
285
|
**多个规格过滤(按维度分组)**:
|
f7d3cf70
tangwang
更新文档
|
286
287
288
289
290
291
292
293
294
295
|
```json
{
"filters": {
"specifications": [
{"name": "color", "value": "white"},
{"name": "size", "value": "256GB"}
]
}
}
```
|
85f08823
tangwang
过滤逻辑
|
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
查询同时满足所有规格的商品(color=white **且** size=256GB)。
**相同维度的多个值(OR 逻辑)**:
```json
{
"filters": {
"specifications": [
{"name": "size", "value": "3"},
{"name": "size", "value": "4"},
{"name": "size", "value": "5"},
{"name": "color", "value": "green"}
]
}
}
```
查询满足 (size=3 **或** size=4 **或** size=5) **且** color=green 的商品。
**过滤逻辑说明**:
- **不同维度**(不同的 `name`)之间是 **AND** 关系(求交集)
- **相同维度**(相同的 `name`)的多个值之间是 **OR** 关系(求并集)
|
b73baf85
tangwang
撰写接口文档
|
316
|
|
11237cf2
tangwang
搜索API对接指南.md
|
317
|
**常用过滤字段**(详见[常用字段列表](#83-常用字段列表)):
|
f7d3cf70
tangwang
更新文档
|
318
319
320
|
- `category_name`: 类目名称
- `category1_name`, `category2_name`, `category3_name`: 多级类目
- `category_id`: 类目ID
|
d7d48f52
tangwang
改动(mapping + 灌入结构)
|
321
|
- `vendor.zh.keyword`, `vendor.en.keyword`: 供应商/品牌(使用keyword子字段)
|
f7d3cf70
tangwang
更新文档
|
322
323
324
|
- `tags`: 标签(keyword类型,支持数组)
- `option1_name`, `option2_name`, `option3_name`: 选项名称
- `specifications`: 规格过滤(嵌套字段,格式见上文)
|
985d7fe3
tangwang
为 filters 中所有字段加上...
|
325
|
- 以上任意字段均可加 `_all` 后缀表示多值 AND,如 `tags_all`、`category1_name_all`。
|
b73baf85
tangwang
撰写接口文档
|
326
|
|
11237cf2
tangwang
搜索API对接指南.md
|
327
|
#### 3.3.2 范围过滤器 (range_filters)
|
b73baf85
tangwang
撰写接口文档
|
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
用于数值字段的范围过滤。
**格式**:
```json
{
"range_filters": {
"min_price": {
"gte": 50, // 大于等于
"lte": 200 // 小于等于
},
"max_price": {
"gt": 100 // 大于
},
"create_time": {
"gte": "2024-01-01T00:00:00Z" // 日期时间字符串
}
}
}
```
**支持的操作符**:
- `gte`: 大于等于 (>=)
- `gt`: 大于 (>)
- `lte`: 小于等于 (<=)
- `lt`: 小于 (<)
**注意**: 至少需要指定一个操作符。
|
11237cf2
tangwang
搜索API对接指南.md
|
357
|
**常用范围字段**(详见[常用字段列表](#83-常用字段列表)):
|
b73baf85
tangwang
撰写接口文档
|
358
359
360
361
362
363
|
- `min_price`: 最低价格
- `max_price`: 最高价格
- `compare_at_price`: 原价
- `create_time`: 创建时间
- `update_time`: 更新时间
|
11237cf2
tangwang
搜索API对接指南.md
|
364
|
### 3.4 分面配置
|
b73baf85
tangwang
撰写接口文档
|
365
366
367
|
用于生成分面统计(分组聚合),常用于构建筛选器UI。
|
11237cf2
tangwang
搜索API对接指南.md
|
368
|
#### 3.4.1 配置格式
|
b73baf85
tangwang
撰写接口文档
|
369
|
|
b73baf85
tangwang
撰写接口文档
|
370
371
372
373
|
```json
{
"facets": [
{
|
f7d3cf70
tangwang
更新文档
|
374
|
"field": "category1_name",
|
b73baf85
tangwang
撰写接口文档
|
375
|
"size": 15,
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
376
|
"type": "terms",
|
9a9b9ec5
tangwang
1. facet disjunctive
|
377
|
"disjunctive": false
|
b73baf85
tangwang
撰写接口文档
|
378
379
|
},
{
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
380
|
"field": "brand_name",
|
13320ac6
tangwang
分面接口修改:
|
381
|
"size": 10,
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
382
|
"type": "terms",
|
9a9b9ec5
tangwang
1. facet disjunctive
|
383
|
"disjunctive": true
|
13320ac6
tangwang
分面接口修改:
|
384
385
386
387
|
},
{
"field": "specifications.color",
"size": 20,
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
388
|
"type": "terms",
|
9a9b9ec5
tangwang
1. facet disjunctive
|
389
|
"disjunctive": true
|
13320ac6
tangwang
分面接口修改:
|
390
391
|
},
{
|
b73baf85
tangwang
撰写接口文档
|
392
393
394
395
396
397
398
399
|
"field": "min_price",
"type": "range",
"ranges": [
{"key": "0-50", "to": 50},
{"key": "50-100", "from": 50, "to": 100},
{"key": "100-200", "from": 100, "to": 200},
{"key": "200+", "from": 200}
]
|
13320ac6
tangwang
分面接口修改:
|
400
|
}
|
f7d3cf70
tangwang
更新文档
|
401
402
403
404
|
]
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
405
|
#### 3.4.2 Facet 字段说明
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
406
407
408
409
410
411
|
| 字段 | 类型 | 必填 | 默认值 | 说明 |
|------|------|------|--------|------|
| `field` | string | 是 | - | 分面字段名 |
| `size` | int | 否 | 10 | 返回的分面值数量(1-100) |
| `type` | string | 否 | "terms" | 分面类型:`terms`(词条聚合)或 `range`(范围聚合) |
|
7ac1534b
tangwang
disjunctive 修改默认值...
|
412
|
| `disjunctive` | bool | 否 | false | 是否支持多选(disjunctive faceting)。启用后,选中该分面的过滤器时,仍会显示其他可选项 |
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
413
414
|
| `ranges` | array | 否 | null | 范围配置(仅 `type="range"` 时需要) |
|
7ac1534b
tangwang
disjunctive 修改默认值...
|
415
|
#### 3.4.3 disjunctive字段说明
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
416
|
|
7ac1534b
tangwang
disjunctive 修改默认值...
|
417
|
**重要特性**: `disjunctive` 字段控制分面的行为模式。启用后,选中该分面的过滤器时,仍会显示其他可选项
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
418
|
|
11237cf2
tangwang
搜索API对接指南.md
|
419
|
**标准模式 (disjunctive: false)**:
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
420
421
422
423
|
- **行为**: 选中某个分面值后,该分面只显示选中的值
- **适用场景**: 层级类目、互斥选择
- **示例**: 类目下钻(玩具 > 娃娃 > 芭比)
|
11237cf2
tangwang
搜索API对接指南.md
|
424
|
**Multi-Select 模式 (disjunctive: true)** ⭐:
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
425
426
427
428
|
- **行为**: 选中某个分面值后,该分面仍显示所有可选项
- **适用场景**: 颜色、品牌、尺码等可切换属性
- **示例**: 选择了"红色"后,仍能看到"蓝色"、"绿色"等选项
|
11237cf2
tangwang
搜索API对接指南.md
|
429
|
**推荐配置**:
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
430
|
|
9a9b9ec5
tangwang
1. facet disjunctive
|
431
|
| 分面类型 | disjunctive | 原因 |
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
432
433
434
435
436
437
438
|
|---------|-------------|------|
| 颜色 | `true` | 用户需要切换颜色 |
| 品牌 | `true` | 用户需要比较品牌 |
| 尺码 | `true` | 用户需要查看其他尺码 |
| 类目 | `false` | 层级下钻 |
| 价格区间 | `false` | 互斥选择 |
|
11237cf2
tangwang
搜索API对接指南.md
|
439
|
#### 3.4.4 规格分面说明
|
f7d3cf70
tangwang
更新文档
|
440
441
442
|
`specifications` 是嵌套字段,支持两种分面模式:
|
13320ac6
tangwang
分面接口修改:
|
443
|
**模式1:所有规格名称的分面**:
|
f7d3cf70
tangwang
更新文档
|
444
445
|
```json
{
|
13320ac6
tangwang
分面接口修改:
|
446
447
448
449
450
451
452
|
"facets": [
{
"field": "specifications",
"size": 10,
"type": "terms"
}
]
|
f7d3cf70
tangwang
更新文档
|
453
454
455
456
|
}
```
返回所有规格名称(name)及其对应的值(value)列表。每个 name 会生成一个独立的分面结果。
|
13320ac6
tangwang
分面接口修改:
|
457
|
**模式2:指定规格名称的分面**:
|
f7d3cf70
tangwang
更新文档
|
458
459
|
```json
{
|
13320ac6
tangwang
分面接口修改:
|
460
461
462
463
|
"facets": [
{
"field": "specifications.color",
"size": 20,
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
464
|
"type": "terms",
|
9a9b9ec5
tangwang
1. facet disjunctive
|
465
|
"disjunctive": true
|
13320ac6
tangwang
分面接口修改:
|
466
467
468
469
|
},
{
"field": "specifications.size",
"size": 15,
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
470
|
"type": "terms",
|
9a9b9ec5
tangwang
1. facet disjunctive
|
471
|
"disjunctive": true
|
13320ac6
tangwang
分面接口修改:
|
472
473
|
}
]
|
f7d3cf70
tangwang
更新文档
|
474
475
|
}
```
|
a10a89a3
tangwang
构造测试数据用于测试分类 和 三种...
|
476
|
只返回指定规格名称的值列表。格式:`specifications.{name}`,其中 `{name}` 是规格名称(如"color"、"size"、"material")。
|
f7d3cf70
tangwang
更新文档
|
477
478
479
480
481
482
483
484
485
486
|
**返回格式示例**:
```json
{
"facets": [
{
"field": "specifications.color",
"label": "color",
"type": "terms",
"values": [
|
c581becd
tangwang
feat: 实现 Multi-Se...
|
487
488
489
|
{"value": "white", "count": 50, "selected": true}, // ✓ selected 字段由后端标记
{"value": "black", "count": 30, "selected": false},
{"value": "red", "count": 20, "selected": false}
|
f7d3cf70
tangwang
更新文档
|
490
491
492
493
494
495
496
497
498
499
|
]
},
{
"field": "specifications.size",
"label": "size",
"type": "terms",
"values": [
{"value": "256GB", "count": 40, "selected": false},
{"value": "512GB", "count": 20, "selected": false}
]
|
b73baf85
tangwang
撰写接口文档
|
500
501
502
503
504
|
}
]
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
505
|
### 3.5 SKU筛选维度
|
ca91352a
tangwang
更新文档
|
506
507
|
**功能说明**:
|
0a915b21
tangwang
fix last up
|
508
509
510
|
`sku_filter_dimension` 用于控制搜索列表页中 **每个 SPU 下方可切换的子款式(子 SKU)维度**,为字符串列表。
在店铺的 **主题装修配置** 中,商家可以为店铺设置一个或多个子款式筛选维度(例如 `color`、`size`),前端列表页会在每个 SPU 下展示这些维度对应的子 SKU 列表,用户可以通过点击不同维度值(如不同颜色)来切换展示的子款式。
当指定 `sku_filter_dimension` 后,后端会根据店铺的这项配置,从所有 SKU 中筛选出这些维度组合对应的子 SKU 数据:系统会按指定维度**组合**对 SKU 进行分组,每个维度组合只返回第一个 SKU(从简实现,选择该组合下的第一款),其余不在这些维度组合中的子 SKU 将不返回。
|
ca91352a
tangwang
更新文档
|
511
|
|
ca91352a
tangwang
更新文档
|
512
513
514
515
|
**支持的维度值**:
1. **直接选项字段**: `option1`、`option2`、`option3`
- 直接使用对应的 `option1_value`、`option2_value`、`option3_value` 字段进行分组
|
a3a5d41b
tangwang
(sku_filter_dimen...
|
516
517
|
2. **规格/选项名称**: 通过 `option1_name`、`option2_name`、`option3_name` 匹配
- 例如:如果 `option1_name` 为 `"color"`,则可以使用 `sku_filter_dimension: ["color"]` 来按颜色分组
|
ca91352a
tangwang
更新文档
|
518
519
520
521
522
523
524
|
**示例**:
**按颜色筛选(假设 option1_name = "color")**:
```json
{
"query": "芭比娃娃",
|
a3a5d41b
tangwang
(sku_filter_dimen...
|
525
|
"sku_filter_dimension": ["color"]
|
ca91352a
tangwang
更新文档
|
526
527
528
529
530
531
532
|
}
```
**按选项1筛选**:
```json
{
"query": "芭比娃娃",
|
a3a5d41b
tangwang
(sku_filter_dimen...
|
533
|
"sku_filter_dimension": ["option1"]
|
ca91352a
tangwang
更新文档
|
534
535
536
|
}
```
|
a3a5d41b
tangwang
(sku_filter_dimen...
|
537
538
539
540
541
|
**按颜色 + 尺寸组合筛选(假设 option1_name = "color", option2_name = "size")**:
```json
{
"query": "芭比娃娃",
"sku_filter_dimension": ["color", "size"]
|
ca91352a
tangwang
更新文档
|
542
543
544
|
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
545
|
### 3.7 搜索建议接口
|
b73baf85
tangwang
撰写接口文档
|
546
|
|
11237cf2
tangwang
搜索API对接指南.md
|
547
|
- **端点**: `GET /search/suggestions`
|
f251cf2d
tangwang
suggestion全量索引程序跑通
|
548
|
- **描述**: 返回搜索建议(自动补全/热词),支持多语言与“结果直达”(每条 suggestion 附带商品列表)。
|
11237cf2
tangwang
搜索API对接指南.md
|
549
550
551
552
553
554
|
#### 查询参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|------|------|------|--------|------|
| `q` | string | Y | - | 查询字符串(至少 1 个字符) |
|
316c97c4
tangwang
feat: 完整落地多租户 sug...
|
555
|
| `size` | integer | N | 10 | 返回建议数量(1-200) |
|
f251cf2d
tangwang
suggestion全量索引程序跑通
|
556
557
558
559
560
561
|
| `language` | string | N | `en` | 请求语言,如 `zh` / `en` / `ar` / `ru`,用于路由到对应语种 suggestion 索引 |
| `with_results` | bool | N | `true` | 是否为每条 suggestion 返回商品列表(结果直达) |
| `result_size` | integer | N | 3 | 每条 suggestion 返回的商品数量(1-10) |
| `debug` | bool | N | `false` | 是否开启调试(目前主要用于排查 suggestion 排序与语言解析) |
> **租户标识**:同 [3.1](#31-接口信息),通过请求头 `X-Tenant-ID` 或 query 参数 `tenant_id` 传递。
|
b73baf85
tangwang
撰写接口文档
|
562
|
|
11237cf2
tangwang
搜索API对接指南.md
|
563
|
#### 响应示例
|
b73baf85
tangwang
撰写接口文档
|
564
565
566
|
```json
{
|
f251cf2d
tangwang
suggestion全量索引程序跑通
|
567
568
569
|
"query": "iph",
"language": "en",
"resolved_language": "en",
|
11237cf2
tangwang
搜索API对接指南.md
|
570
|
"suggestions": [
|
b73baf85
tangwang
撰写接口文档
|
571
|
{
|
f251cf2d
tangwang
suggestion全量索引程序跑通
|
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
|
"text": "iphone 15",
"lang": "en",
"score": 12.37,
"rank_score": 5.1,
"sources": ["query_log", "qanchor"],
"lang_source": "log_field",
"lang_confidence": 1.0,
"lang_conflict": false,
"products": [
{
"spu_id": "12345",
"title": "iPhone 15 Pro Max",
"price": 999.0,
"image_url": "https://example.com/image.jpg",
"score": 3.21
}
]
|
11237cf2
tangwang
搜索API对接指南.md
|
589
590
|
}
],
|
f251cf2d
tangwang
suggestion全量索引程序跑通
|
591
|
"took_ms": 12
|
11237cf2
tangwang
搜索API对接指南.md
|
592
593
594
595
596
597
|
}
```
#### 请求示例
```bash
|
f251cf2d
tangwang
suggestion全量索引程序跑通
|
598
599
|
curl "http://localhost:6002/search/suggestions?q=芭&size=5&language=zh&with_results=true" \
-H "X-Tenant-ID: 162"
|
11237cf2
tangwang
搜索API对接指南.md
|
600
601
602
603
|
```
### 3.8 即时搜索接口
|
26b910bd
tangwang
refactor service ...
|
604
|
> ⚠️ 当前版本未开放该能力。接口会明确返回 `501 Not Implemented`,避免误用未完成实现。
|
11237cf2
tangwang
搜索API对接指南.md
|
605
606
|
- **端点**: `GET /search/instant`
|
26b910bd
tangwang
refactor service ...
|
607
|
- **描述**: 即时搜索预留端点,后续会在独立实现完成后开放。
|
11237cf2
tangwang
搜索API对接指南.md
|
608
609
610
611
612
613
614
615
616
617
618
619
620
621
|
#### 查询参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|------|------|------|--------|------|
| `q` | string | Y | - | 搜索查询(至少 2 个字符) |
| `size` | integer | N | 5 | 返回结果数量(1-20) |
#### 请求示例
```bash
curl "http://localhost:6002/search/instant?q=玩具&size=5"
```
|
26b910bd
tangwang
refactor service ...
|
622
623
624
625
626
627
628
629
630
|
#### 当前响应
```json
{
"error": "/search/instant is not implemented yet. Use POST /search/ for production traffic.",
"status_code": 501
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
631
632
633
634
|
### 3.9 获取单个文档
- **端点**: `GET /search/{doc_id}`
- **描述**: 根据文档 ID 获取单个商品详情,用于点击结果后的详情页或排查问题。
|
cd6d887e
tangwang
reranker doc
|
635
|
- **租户标识**:同 [3.1](#31-接口信息),通过请求头 `X-Tenant-ID` 或 query 参数 `tenant_id` 传递。
|
11237cf2
tangwang
搜索API对接指南.md
|
636
637
638
639
640
641
642
643
644
645
646
647
648
|
#### 路径参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `doc_id` | string | 商品或文档 ID |
#### 响应示例
```json
{
"id": "12345",
"source": {
|
d7d48f52
tangwang
改动(mapping + 灌入结构)
|
649
650
651
|
"title": {
"zh": "芭比时尚娃娃"
},
|
11237cf2
tangwang
搜索API对接指南.md
|
652
653
654
655
656
657
658
659
660
|
"min_price": 89.99,
"category1_name": "玩具"
}
}
```
#### 请求示例
```bash
|
cd6d887e
tangwang
reranker doc
|
661
662
|
curl "http://localhost:6002/search/12345" -H "X-Tenant-ID: 162"
# 或使用 query 参数:curl "http://localhost:6002/search/12345?tenant_id=162"
|
11237cf2
tangwang
搜索API对接指南.md
|
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
|
```
---
## 响应格式说明
### 4.1 标准响应结构
```json
{
"results": [
{
"spu_id": "12345",
"title": "芭比时尚娃娃",
"brief": "高品质芭比娃娃",
"description": "详细描述...",
"vendor": "美泰",
"category": "玩具",
"category_path": "玩具/娃娃/时尚",
"category_name": "时尚",
"category_id": "cat_001",
"category_level": 3,
"category1_name": "玩具",
"category2_name": "娃娃",
"category3_name": "时尚",
"tags": ["娃娃", "玩具", "女孩"],
"price": 89.99,
"compare_at_price": 129.99,
"currency": "USD",
"image_url": "https://example.com/image.jpg",
"in_stock": true,
"sku_prices": [89.99, 99.99, 109.99],
"sku_weights": [100, 150, 200],
"sku_weight_units": ["g", "g", "g"],
"total_inventory": 500,
"option1_name": "color",
"option2_name": "size",
"option3_name": null,
"specifications": [
{"sku_id": "sku_001", "name": "color", "value": "pink"},
{"sku_id": "sku_001", "name": "size", "value": "standard"}
],
"skus": [
{
"sku_id": "67890",
"price": 89.99,
"compare_at_price": 129.99,
"sku": "BARBIE-001",
"stock": 100,
"weight": 0.1,
"weight_unit": "kg",
"option1_value": "pink",
"option2_value": "standard",
"option3_value": null,
"image_src": "https://example.com/sku1.jpg"
}
],
"relevance_score": 8.5
}
|
b73baf85
tangwang
撰写接口文档
|
722
723
724
725
726
|
],
"total": 118,
"max_score": 8.5,
"facets": [
{
|
f7d3cf70
tangwang
更新文档
|
727
728
|
"field": "category1_name",
"label": "category1_name",
|
b73baf85
tangwang
撰写接口文档
|
729
730
731
732
733
734
735
736
737
|
"type": "terms",
"values": [
{
"value": "玩具",
"label": "玩具",
"count": 85,
"selected": false
}
]
|
f7d3cf70
tangwang
更新文档
|
738
739
740
741
742
743
744
745
746
747
748
749
750
|
},
{
"field": "specifications.color",
"label": "color",
"type": "terms",
"values": [
{
"value": "pink",
"label": "pink",
"count": 30,
"selected": false
}
]
|
b73baf85
tangwang
撰写接口文档
|
751
752
753
754
|
}
],
"query_info": {
"original_query": "芭比娃娃",
|
3a5fda00
tangwang
1. ES字段 skus的 ima...
|
755
756
|
"query_normalized": "芭比娃娃",
"rewritten_query": "芭比娃娃",
|
b73baf85
tangwang
撰写接口文档
|
757
758
759
|
"detected_language": "zh",
"translations": {
"en": "barbie doll"
|
3a5fda00
tangwang
1. ES字段 skus的 ima...
|
760
|
},
|
d90e7428
tangwang
补充重排
|
761
|
"domain": "default"
|
b73baf85
tangwang
撰写接口文档
|
762
763
764
765
766
767
768
769
770
|
},
"suggestions": [],
"related_searches": [],
"took_ms": 45,
"performance_info": null,
"debug_info": null
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
771
|
### 4.2 响应字段说明
|
b73baf85
tangwang
撰写接口文档
|
772
773
774
|
| 字段 | 类型 | 说明 |
|------|------|------|
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
775
776
|
| `results` | array | 搜索结果列表(SpuResult对象数组) |
| `results[].spu_id` | string | SPU ID |
|
b73baf85
tangwang
撰写接口文档
|
777
778
|
| `results[].title` | string | 商品标题 |
| `results[].price` | float | 价格(min_price) |
|
ca91352a
tangwang
更新文档
|
779
|
| `results[].skus` | array | SKU列表(如果指定了`sku_filter_dimension`,则按维度过滤后的SKU) |
|
b73baf85
tangwang
撰写接口文档
|
780
781
782
783
|
| `results[].relevance_score` | float | 相关性分数 |
| `total` | integer | 匹配的总文档数 |
| `max_score` | float | 最高相关性分数 |
| `facets` | array | 分面统计结果 |
|
d90e7428
tangwang
补充重排
|
784
|
| `query_info` | object | query处理信息 |
|
b73baf85
tangwang
撰写接口文档
|
785
786
|
| `took_ms` | integer | 搜索耗时(毫秒) |
|
3a5fda00
tangwang
1. ES字段 skus的 ima...
|
787
788
789
790
791
792
793
794
795
796
797
798
|
#### 4.2.1 query_info 说明
`query_info` 包含本次搜索的查询解析与处理结果:
| 子字段 | 类型 | 说明 |
|--------|------|------|
| `original_query` | string | 用户原始查询 |
| `query_normalized` | string | 归一化后的查询(去空白、大小写等预处理,用于后续解析与改写) |
| `rewritten_query` | string | 重写后的查询(同义词/词典扩展等) |
| `detected_language` | string | 检测到的查询语言(如 `zh`、`en`) |
| `translations` | object | 翻译结果,键为语言代码,值为翻译文本 |
| `domain` | string | 查询域(如 `default`、`title`、`brand` 等) |
|
3a5fda00
tangwang
1. ES字段 skus的 ima...
|
799
|
|
11237cf2
tangwang
搜索API对接指南.md
|
800
|
### 4.3 SpuResult字段说明
|
b73baf85
tangwang
撰写接口文档
|
801
802
803
|
| 字段 | 类型 | 说明 |
|------|------|------|
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
804
|
| `spu_id` | string | SPU ID |
|
d7d48f52
tangwang
改动(mapping + 灌入结构)
|
805
|
| `title` | string | 商品标题(根据language参数自动选择 `title.zh` 或 `title.en`) |
|
f7d3cf70
tangwang
更新文档
|
806
807
808
809
810
811
812
813
814
815
816
817
|
| `brief` | string | 商品短描述(根据language参数自动选择) |
| `description` | string | 商品详细描述(根据language参数自动选择) |
| `vendor` | string | 供应商/品牌(根据language参数自动选择) |
| `category` | string | 类目(兼容字段,等同于category_name) |
| `category_path` | string | 类目路径(多级,用于面包屑,根据language参数自动选择) |
| `category_name` | string | 类目名称(展示用,根据language参数自动选择) |
| `category_id` | string | 类目ID |
| `category_level` | integer | 类目层级(1/2/3) |
| `category1_name` | string | 一级类目名称 |
| `category2_name` | string | 二级类目名称 |
| `category3_name` | string | 三级类目名称 |
| `tags` | array[string] | 标签列表 |
|
b73baf85
tangwang
撰写接口文档
|
818
819
820
821
|
| `price` | float | 价格(min_price) |
| `compare_at_price` | float | 原价 |
| `currency` | string | 货币单位(默认USD) |
| `image_url` | string | 主图URL |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
822
|
| `in_stock` | boolean | 是否有库存(任意SKU有库存即为true) |
|
f7d3cf70
tangwang
更新文档
|
823
824
825
826
|
| `sku_prices` | array[float] | 所有SKU价格列表 |
| `sku_weights` | array[integer] | 所有SKU重量列表 |
| `sku_weight_units` | array[string] | 所有SKU重量单位列表 |
| `total_inventory` | integer | 总库存 |
|
13320ac6
tangwang
分面接口修改:
|
827
|
| `sales` | integer | 销量(展示销量) |
|
f7d3cf70
tangwang
更新文档
|
828
829
830
831
|
| `option1_name` | string | 选项1名称(如"color") |
| `option2_name` | string | 选项2名称(如"size") |
| `option3_name` | string | 选项3名称 |
| `specifications` | array[object] | 规格列表(与ES specifications字段对应) |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
832
|
| `skus` | array | SKU 列表 |
|
506c39b7
tangwang
feat(search): 统一重...
|
833
|
| `relevance_score` | float | 相关性分数(默认为 ES 原始分数;当开启 AI 搜索时为融合后的最终分数) |
|
b73baf85
tangwang
撰写接口文档
|
834
|
|
11237cf2
tangwang
搜索API对接指南.md
|
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
|
### 4.4 SkuResult字段说明
| 字段 | 类型 | 说明 |
|------|------|------|
| `sku_id` | string | SKU ID |
| `price` | float | 价格 |
| `compare_at_price` | float | 原价 |
| `sku` | string | SKU编码(sku_code) |
| `stock` | integer | 库存数量 |
| `weight` | float | 重量 |
| `weight_unit` | string | 重量单位 |
| `option1_value` | string | 选项1取值(如color值) |
| `option2_value` | string | 选项2取值(如size值) |
| `option3_value` | string | 选项3取值 |
| `image_src` | string | SKU图片地址 |
### 4.5 多语言字段说明
- `title`, `brief`, `description`, `vendor`, `category_path`, `category_name` 会根据请求的 `language` 参数自动选择对应的中英文字段
- `language="zh"`: 优先返回 `*_zh` 字段,如果为空则回退到 `*_en` 字段
- `language="en"`: 优先返回 `*_en` 字段,如果为空则回退到 `*_zh` 字段
---
## 索引接口
|
2e3670ab
tangwang
index services
|
861
862
863
864
865
866
867
868
869
870
871
|
本节内容与 `api/routes/indexer.py` 中的索引相关服务一致,包含以下接口:
| 接口 | 方法 | 路径 | 说明 |
|------|------|------|------|
| 全量重建索引 | POST | `/indexer/reindex` | 将指定租户所有 SPU 导入 ES(不删现有索引) |
| 增量索引 | POST | `/indexer/index` | 按 SPU ID 列表索引/删除,支持自动检测删除与显式删除 |
| 查询文档 | POST | `/indexer/documents` | 按 SPU ID 列表查询 ES 文档,不写入 ES |
| 构建 ES 文档(正式) | POST | `/indexer/build-docs` | 由上游提供 MySQL 行数据,返回 ES-ready 文档,不写 ES |
| 构建 ES 文档(测试) | POST | `/indexer/build-docs-from-db` | 由本服务查库并构建文档,仅测试/调试用 |
| 索引健康检查 | GET | `/indexer/health` | 检查索引服务与数据库连接状态 |
|
80f87e57
tangwang
多语言索引修改 对应的 索引创建、...
|
872
873
874
875
|
### 5.0 为租户创建索引
为租户创建索引需要两个步骤:
|
648cb4c2
tangwang
ES docs
|
876
|
1. **创建索引结构**(可选,仅在需要更新 mapping 或在新环境首次创建时执行)
|
80f87e57
tangwang
多语言索引修改 对应的 索引创建、...
|
877
878
879
880
881
882
|
- 使用脚本创建 ES 索引结构(基于 `mappings/search_products.json`)
- 如果索引已存在,会提示用户确认(会删除现有数据)
2. **导入数据**(必需)
- 使用全量索引接口 `/indexer/reindex` 导入数据
|
648cb4c2
tangwang
ES docs
|
883
|
**创建索引结构(支持多环境 namespace)**:
|
80f87e57
tangwang
多语言索引修改 对应的 索引创建、...
|
884
885
|
```bash
|
648cb4c2
tangwang
ES docs
|
886
887
888
889
890
891
892
|
# 以 UAT 环境为例:
# 1. 准备 UAT 环境的 .env(包含 UAT 的 ES_HOST/DB_HOST 等)
# 2. 设置环境前缀(也可以直接在 .env 中配置):
export RUNTIME_ENV=uat
export ES_INDEX_NAMESPACE=uat_
# 3. 为 tenant_id=170 创建索引结构
|
80f87e57
tangwang
多语言索引修改 对应的 索引创建、...
|
893
894
895
|
./scripts/create_tenant_index.sh 170
```
|
648cb4c2
tangwang
ES docs
|
896
897
898
899
|
脚本会自动从项目根目录的 `.env` 文件加载 ES 配置,并根据 `ES_INDEX_NAMESPACE` 创建:
- prod 环境(ES_INDEX_NAMESPACE 为空):`search_products_tenant_170`
- UAT 环境(ES_INDEX_NAMESPACE=uat_):`uat_search_products_tenant_170`
|
80f87e57
tangwang
多语言索引修改 对应的 索引创建、...
|
900
901
902
903
904
905
906
907
|
**注意事项**:
- ⚠️ 如果索引已存在,脚本会提示确认,确认后会删除现有数据
- 创建索引后,**必须**调用 `/indexer/reindex` 导入数据
- 如果只是更新数据而不需要修改索引结构,直接使用 `/indexer/reindex` 即可
---
|
351a7eb5
tangwang
1. 新的重建索引脚本
|
908
|
### 5.1 全量索引接口
|
11237cf2
tangwang
搜索API对接指南.md
|
909
|
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
910
|
- **端点**: `POST /indexer/reindex`
|
89638140
tangwang
重构 indexer 文档构建接口...
|
911
|
- **描述**: 全量索引,将指定租户的所有SPU数据导入到ES索引(不会删除现有索引)。**推荐仅用于自测/运维场景**;生产环境下更推荐由 Java 等上游控制调度与写 ES。
|
11237cf2
tangwang
搜索API对接指南.md
|
912
913
914
915
916
917
|
#### 请求参数
```json
{
"tenant_id": "162",
|
11237cf2
tangwang
搜索API对接指南.md
|
918
919
920
921
922
923
924
|
"batch_size": 500
}
```
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|------|------|------|--------|------|
| `tenant_id` | string | Y | - | 租户ID |
|
11237cf2
tangwang
搜索API对接指南.md
|
925
926
927
928
|
| `batch_size` | integer | N | 500 | 批量导入大小 |
#### 响应格式
|
648cb4c2
tangwang
ES docs
|
929
|
**成功响应(200 OK)**(示例,实际 `index_name` 会带上 tenant 和环境前缀):
|
11237cf2
tangwang
搜索API对接指南.md
|
930
931
932
933
934
935
936
|
```json
{
"success": true,
"total": 1000,
"indexed": 1000,
"failed": 0,
"elapsed_time": 12.34,
|
648cb4c2
tangwang
ES docs
|
937
|
"index_name": "search_products_tenant_162",
|
11237cf2
tangwang
搜索API对接指南.md
|
938
939
940
941
942
943
944
945
946
947
|
"tenant_id": "162"
}
```
**错误响应**:
- `400 Bad Request`: 参数错误
- `503 Service Unavailable`: 服务未初始化
#### 请求示例
|
351a7eb5
tangwang
1. 新的重建索引脚本
|
948
|
**全量索引(不会删除现有索引)**:
|
11237cf2
tangwang
搜索API对接指南.md
|
949
|
```bash
|
bb9c626c
tangwang
搜索服务(6002)不再初始化/挂...
|
950
|
curl -X POST "http://localhost:6004/indexer/reindex" \
|
11237cf2
tangwang
搜索API对接指南.md
|
951
952
953
|
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
|
11237cf2
tangwang
搜索API对接指南.md
|
954
955
956
957
958
959
960
961
962
963
964
965
966
|
"batch_size": 500
}'
```
**查看日志**:
```bash
# 查看API日志(包含索引操作日志)
tail -f logs/api.log
# 或者查看所有日志文件
tail -f logs/*.log
```
|
d1d356f8
tangwang
脚本优化
|
967
|
> ⚠️ **重要提示**:如需 **创建索引结构**,请参考 [5.0 为租户创建索引](#50-为租户创建索引) 章节,使用 `./scripts/create_tenant_index.sh <tenant_id>`。创建后需要调用 `/indexer/reindex` 导入数据。
|
11237cf2
tangwang
搜索API对接指南.md
|
968
|
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
969
|
**查看索引日志**:
|
11237cf2
tangwang
搜索API对接指南.md
|
970
|
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
|
索引操作的所有关键信息都会记录到 `logs/indexer.log` 文件中(JSON 格式),包括:
- 请求开始和结束时间
- 租户ID、SPU ID、操作类型
- 每个SPU的处理状态
- ES批量写入结果
- 成功/失败统计和详细错误信息
```bash
# 实时查看索引日志(包含全量和增量索引的所有操作)
tail -f logs/indexer.log
# 使用 grep 查询(简单方式)
# 查看全量索引日志
grep "\"index_type\":\"bulk\"" logs/indexer.log | tail -100
# 查看增量索引日志
grep "\"index_type\":\"incremental\"" logs/indexer.log | tail -100
# 查看特定租户的索引日志
grep "\"tenant_id\":\"162\"" logs/indexer.log | tail -100
# 使用 jq 查询(推荐,更精确的 JSON 查询)
# 安装 jq: sudo apt-get install jq 或 brew install jq
# 查看全量索引日志
cat logs/indexer.log | jq 'select(.index_type == "bulk")' | tail -100
# 查看增量索引日志
cat logs/indexer.log | jq 'select(.index_type == "incremental")' | tail -100
# 查看特定租户的索引日志
cat logs/indexer.log | jq 'select(.tenant_id == "162")' | tail -100
# 查看失败的索引操作
cat logs/indexer.log | jq 'select(.operation == "request_complete" and .failed_count > 0)'
# 查看特定SPU的处理日志
cat logs/indexer.log | jq 'select(.spu_id == "123")'
# 查看最近的索引请求统计
cat logs/indexer.log | jq 'select(.operation == "request_complete") | {timestamp, index_type, tenant_id, total_count, success_count, failed_count, elapsed_time}'
```
### 5.2 增量索引接口
- **端点**: `POST /indexer/index`
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1017
|
- **描述**: 增量索引接口,根据指定的SPU ID列表进行索引,直接将数据写入ES。用于增量更新指定商品。**推荐仅作为内部/调试入口**;正式对接建议改用 `/indexer/build-docs`,由上游写 ES。
|
11237cf2
tangwang
搜索API对接指南.md
|
1018
|
|
7af56df3
tangwang
文档优化
|
1019
1020
1021
|
**删除说明**:
- `spu_ids`中的SPU:如果数据库`deleted=1`,自动从ES删除,响应状态为`deleted`
- `delete_spu_ids`中的SPU:直接删除,响应状态为`deleted`、`not_found`或`failed`
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1022
|
|
11237cf2
tangwang
搜索API对接指南.md
|
1023
1024
1025
1026
1027
|
#### 请求参数
```json
{
"tenant_id": "162",
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1028
1029
|
"spu_ids": ["123", "456", "789"],
"delete_spu_ids": ["100", "101"]
|
11237cf2
tangwang
搜索API对接指南.md
|
1030
1031
1032
1033
1034
1035
|
}
```
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `tenant_id` | string | Y | 租户ID |
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1036
1037
1038
1039
1040
1041
1042
|
| `spu_ids` | array[string] | N | SPU ID列表(1-100个),要索引的SPU。如果为空,则只执行删除操作 |
| `delete_spu_ids` | array[string] | N | 显式指定要删除的SPU ID列表(1-100个),可选。无论数据库状态如何,都会从ES中删除这些SPU |
**注意**:
- `spu_ids` 和 `delete_spu_ids` 不能同时为空
- 每个列表最多支持100个SPU ID
- 如果SPU在`spu_ids`中且数据库`deleted=1`,会自动从ES删除(自动检测删除)
|
11237cf2
tangwang
搜索API对接指南.md
|
1043
1044
1045
1046
1047
|
#### 响应格式
```json
{
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1048
|
"spu_ids": [
|
11237cf2
tangwang
搜索API对接指南.md
|
1049
1050
|
{
"spu_id": "123",
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1051
|
"status": "indexed"
|
11237cf2
tangwang
搜索API对接指南.md
|
1052
1053
1054
|
},
{
"spu_id": "456",
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1055
1056
1057
1058
1059
1060
|
"status": "deleted"
},
{
"spu_id": "789",
"status": "failed",
"msg": "SPU not found (unexpected)"
|
11237cf2
tangwang
搜索API对接指南.md
|
1061
1062
|
}
],
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1063
|
"delete_spu_ids": [
|
11237cf2
tangwang
搜索API对接指南.md
|
1064
|
{
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
|
"spu_id": "100",
"status": "deleted"
},
{
"spu_id": "101",
"status": "not_found"
},
{
"spu_id": "102",
"status": "failed",
"msg": "Failed to delete from ES: Connection timeout"
|
11237cf2
tangwang
搜索API对接指南.md
|
1076
1077
|
}
],
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1078
1079
1080
1081
1082
1083
|
"total": 6,
"success_count": 4,
"failed_count": 2,
"elapsed_time": 1.23,
"index_name": "search_products",
"tenant_id": "162"
|
11237cf2
tangwang
搜索API对接指南.md
|
1084
1085
1086
|
}
```
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
|
| 字段 | 类型 | 说明 |
|------|------|------|
| `spu_ids` | array | spu_ids对应的响应列表,每个元素包含 `spu_id` 和 `status` |
| `spu_ids[].status` | string | 状态:`indexed`(已索引)、`deleted`(已删除,自动检测)、`failed`(失败) |
| `spu_ids[].msg` | string | 当status为`failed`时,包含失败原因(可选) |
| `delete_spu_ids` | array | delete_spu_ids对应的响应列表,每个元素包含 `spu_id` 和 `status` |
| `delete_spu_ids[].status` | string | 状态:`deleted`(已删除)、`not_found`(ES中不存在)、`failed`(失败) |
| `delete_spu_ids[].msg` | string | 当status为`failed`时,包含失败原因(可选) |
| `total` | integer | 总处理数量(spu_ids数量 + delete_spu_ids数量) |
| `success_count` | integer | 成功数量(indexed + deleted + not_found) |
| `failed_count` | integer | 失败数量 |
| `elapsed_time` | float | 耗时(秒) |
| `index_name` | string | 索引名称 |
| `tenant_id` | string | 租户ID |
**状态说明**:
- `spu_ids` 的状态:
- `indexed`: SPU已成功索引到ES
- `deleted`: SPU在数据库中被标记为deleted=1,已从ES删除(自动检测)
- `failed`: 处理失败,会包含`msg`字段说明失败原因
- `delete_spu_ids` 的状态:
- `deleted`: SPU已从ES成功删除
- `not_found`: SPU在ES中不存在(也算成功,可能已经被删除过)
- `failed`: 删除失败,会包含`msg`字段说明失败原因
|
11237cf2
tangwang
搜索API对接指南.md
|
1112
1113
|
#### 请求示例
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1114
|
**示例1:普通增量索引(自动检测删除)**:
|
11237cf2
tangwang
搜索API对接指南.md
|
1115
|
```bash
|
bb9c626c
tangwang
搜索服务(6002)不再初始化/挂...
|
1116
|
curl -X POST "http://localhost:6004/indexer/index" \
|
11237cf2
tangwang
搜索API对接指南.md
|
1117
1118
1119
1120
1121
1122
|
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
"spu_ids": ["123", "456", "789"]
}'
```
|
7af56df3
tangwang
文档优化
|
1123
|
说明:如果SPU 456在数据库中`deleted=1`,会自动从ES删除,在响应中`spu_ids`列表里456的状态为`deleted`。
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1124
1125
1126
|
**示例2:显式删除(批量删除)**:
```bash
|
bb9c626c
tangwang
搜索服务(6002)不再初始化/挂...
|
1127
|
curl -X POST "http://localhost:6004/indexer/index" \
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
|
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
"spu_ids": ["123", "456"],
"delete_spu_ids": ["100", "101", "102"]
}'
```
说明:SPU 100、101、102会被显式删除,无论数据库状态如何。
**示例3:仅删除(不索引)**:
```bash
|
bb9c626c
tangwang
搜索服务(6002)不再初始化/挂...
|
1139
|
curl -X POST "http://localhost:6004/indexer/index" \
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
|
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
"spu_ids": [],
"delete_spu_ids": ["100", "101"]
}'
```
说明:只执行删除操作,不进行索引。
**示例4:混合操作(索引+删除)**:
```bash
|
bb9c626c
tangwang
搜索服务(6002)不再初始化/挂...
|
1151
|
curl -X POST "http://localhost:6004/indexer/index" \
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1152
1153
1154
1155
1156
1157
1158
1159
1160
|
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
"spu_ids": ["123", "456", "789"],
"delete_spu_ids": ["100", "101"]
}'
```
说明:同时执行索引和删除操作。
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
1161
1162
1163
1164
|
#### 日志说明
增量索引操作的所有关键信息都会记录到 `logs/indexer.log` 文件中(JSON格式),包括:
- 请求开始和结束时间
|
c797ba2b
tangwang
1. 增量索引接口,增加删除操作后...
|
1165
|
- 每个SPU的处理状态(获取、转换、索引、删除)
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
1166
1167
|
- ES批量写入结果
- 成功/失败统计
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
1168
1169
1170
1171
|
- 详细的错误信息
日志查询方式请参考[5.1节查看索引日志](#51-全量重建索引接口)部分。
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
|
### 5.3 查询文档接口
- **端点**: `POST /indexer/documents`
- **描述**: 查询文档接口,根据SPU ID列表获取ES文档数据(**不写入ES**)。用于查看、调试或验证SPU数据。
#### 请求参数
```json
{
"tenant_id": "162",
"spu_ids": ["123", "456", "789"]
}
```
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `tenant_id` | string | Y | 租户ID |
| `spu_ids` | array[string] | Y | SPU ID列表(1-100个) |
#### 响应格式
```json
{
"success": [
{
"spu_id": "123",
"document": {
"tenant_id": "162",
"spu_id": "123",
|
d7d48f52
tangwang
改动(mapping + 灌入结构)
|
1201
1202
1203
|
"title": {
"zh": "商品标题"
},
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
|
...
}
},
{
"spu_id": "456",
"document": {...}
}
],
"failed": [
{
"spu_id": "789",
"error": "SPU not found or deleted"
}
],
"total": 3,
"success_count": 2,
"failed_count": 1
}
```
| 字段 | 类型 | 说明 |
|------|------|------|
| `success` | array | 成功获取的SPU列表,每个元素包含 `spu_id` 和 `document`(完整的ES文档数据) |
| `failed` | array | 失败的SPU列表,每个元素包含 `spu_id` 和 `error`(失败原因) |
| `total` | integer | 总SPU数量 |
| `success_count` | integer | 成功数量 |
| `failed_count` | integer | 失败数量 |
#### 请求示例
**单个SPU查询**:
```bash
|
bb9c626c
tangwang
搜索服务(6002)不再初始化/挂...
|
1236
|
curl -X POST "http://localhost:6004/indexer/documents" \
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
1237
1238
1239
1240
1241
1242
1243
1244
1245
|
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
"spu_ids": ["123"]
}'
```
**批量SPU查询**:
```bash
|
bb9c626c
tangwang
搜索服务(6002)不再初始化/挂...
|
1246
|
curl -X POST "http://localhost:6004/indexer/documents" \
|
c55c5e47
tangwang
feat: 新增增量索引接口并重构...
|
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
|
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
"spu_ids": ["123", "456", "789"]
}'
```
#### 与 `/indexer/index` 的区别
| 接口 | 功能 | 是否写入ES | 返回内容 |
|------|------|-----------|----------|
| `/indexer/documents` | 查询SPU文档数据 | 否 | 返回完整的ES文档数据 |
| `/indexer/index` | 增量索引 | 是 | 返回成功/失败列表和统计信息 |
**使用场景**:
- `/indexer/documents`:用于查看、调试或验证SPU数据,不修改ES索引
- `/indexer/index`:用于实际的增量索引操作,将更新的SPU数据同步到ES
### 5.4 索引健康检查接口
|
11237cf2
tangwang
搜索API对接指南.md
|
1266
1267
|
- **端点**: `GET /indexer/health`
|
2e3670ab
tangwang
index services
|
1268
|
- **描述**: 检查索引服务健康状态(与 `api/routes/indexer.py` 中 `indexer_health_check` 一致)
|
11237cf2
tangwang
搜索API对接指南.md
|
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
|
#### 响应格式
```json
{
"status": "available",
"database": "connected",
"preloaded_data": {
"category_mappings": 150
}
}
```
|
2e3670ab
tangwang
index services
|
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
|
| 字段 | 类型 | 说明 |
|------|------|------|
| `status` | string | `available`(服务可用)、`unavailable`(未初始化)、`error`(异常) |
| `database` | string | 数据库连接状态,如 `connected` 或 `disconnected: ...` |
| `preloaded_data.category_mappings` | integer | 已加载的分类映射数量 |
#### 请求示例
```bash
curl -X GET "http://localhost:6004/indexer/health"
```
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
|
### 5.5 文档构建接口(正式对接推荐)
#### 5.5.1 `POST /indexer/build-docs`
- **描述**:
基于调用方(通常是 Java 索引程序)提供的 **MySQL 行数据** 构建 ES 文档(doc),**不写入 ES**。
由本服务负责“如何构建 doc”(多语言、翻译、向量、规格聚合等),由调用方负责“何时调度 + 如何写 ES”。
#### 请求参数
```json
{
"tenant_id": "170",
"items": [
{
"spu": { "id": 223167, "tenant_id": 170, "title": "..." },
"skus": [
{ "id": 3988393, "spu_id": 223167, "price": 25.99, "compare_at_price": 25.99 }
],
"options": []
}
]
}
```
|
2e3670ab
tangwang
index services
|
1319
1320
1321
1322
1323
|
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `tenant_id` | string | Y | 租户 ID |
| `items` | array | Y | 需构建 doc 的 SPU 列表(每项含 `spu`、`skus`、`options`),**单次最多 200 条** |
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1324
1325
|
> `spu` / `skus` / `options` 字段应当直接使用从 `shoplazza_product_spu` / `shoplazza_product_sku` / `shoplazza_product_option` 查询出的行字段。
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
|
#### 请求示例(完整 curl)
> 完整请求体参考 `scripts/test_build_docs_api.py` 中的 `build_sample_request()`。
```bash
# 单条 SPU 示例(含 spu、skus、options)
curl -X POST "http://localhost:6004/indexer/build-docs" \
-H "Content-Type: application/json" \
-d '{
"tenant_id": "162",
"items": [
{
"spu": {
"id": 10001,
"tenant_id": "162",
"title": "测试T恤 纯棉短袖",
"brief": "舒适纯棉,多色可选",
"description": "这是一款适合日常穿着的纯棉T恤,透气吸汗。",
"vendor": "测试品牌",
"category": "服装/上衣/T恤",
"category_id": 100,
"category_level": 2,
"category_path": "服装/上衣/T恤",
"fake_sales": 1280,
"image_src": "https://oss.essa.cn/98532128-cf8e-456c-9e30-6f2a5ea0c19f.jpg",
"tags": "T恤,纯棉,短袖,夏季",
"create_time": "2024-01-01T00:00:00Z",
"update_time": "2024-01-01T00:00:00Z"
},
"skus": [
{
"id": 20001,
"spu_id": 10001,
"price": 99.0,
"compare_at_price": 129.0,
"sku": "SKU-TSHIRT-001",
"inventory_quantity": 50,
"option1": "黑色",
"option2": "M",
"option3": null
},
{
"id": 20002,
"spu_id": 10001,
"price": 99.0,
"compare_at_price": 129.0,
"sku": "SKU-TSHIRT-002",
"inventory_quantity": 30,
"option1": "白色",
"option2": "L",
"option3": null
}
],
"options": [
{"id": 1, "position": 1, "name": "颜色"},
{"id": 2, "position": 2, "name": "尺码"}
]
}
]
}'
```
生产环境替换 `localhost:6004` 为实际 Indexer 地址,如 `http://43.166.252.75:6004`。
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
|
#### 响应示例(节选)
```json
{
"tenant_id": "170",
"docs": [
{
"tenant_id": "170",
"spu_id": "223167",
"title": { "en": "...", "zh": "..." },
"tags": ["Floerns", "Clothing", "Shoes & Jewelry"],
"skus": [
{
"sku_id": "3988393",
"price": 25.99,
"compare_at_price": 25.99,
"stock": 100
}
],
"min_price": 25.99,
"max_price": 25.99,
"compare_at_price": 25.99,
"total_inventory": 100,
"title_embedding": [/* 1024 维向量 */]
// 其余字段与 mappings/search_products.json 一致
}
],
"total": 1,
"success_count": 1,
"failed_count": 0,
"failed": []
}
```
|
2e3670ab
tangwang
index services
|
1424
1425
1426
1427
1428
1429
1430
1431
1432
|
| 字段 | 类型 | 说明 |
|------|------|------|
| `tenant_id` | string | 租户 ID |
| `docs` | array | 构建成功的 ES 文档列表,与 `mappings/search_products.json` 一致 |
| `total` | integer | 请求的 items 总数 |
| `success_count` | integer | 成功构建数量 |
| `failed_count` | integer | 失败数量 |
| `failed` | array | 失败项列表,每项含 `spu_id`、`error` |
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
|
#### 使用建议
- **生产环境推荐流程**:
1. Java 根据业务逻辑决定哪些 SPU 需要(全量/增量)处理;
2. Java 从 MySQL 查询 SPU/SKU/Option 行,拼成 `items`;
3. 调用 `/indexer/build-docs` 获取 ES-ready `docs`;
4. Java 使用自己的 ES 客户端写入 `search_products_tenant_{tenant_id}`。
### 5.6 文档构建接口(测试 / 自测)
#### 5.6.1 `POST /indexer/build-docs-from-db`
- **描述**:
|
2e3670ab
tangwang
index services
|
1446
|
仅用于测试/调试:调用方只提供 `tenant_id` 和 `spu_ids`,由 indexer 服务内部从 MySQL 查询 SPU/SKU/Option,然后调用与 `/indexer/build-docs` 相同的文档构建逻辑,返回 ES-ready doc。**生产环境请使用 `/indexer/build-docs`,由上游查库并写 ES。**
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1447
1448
1449
1450
1451
1452
|
#### 请求参数
```json
{
"tenant_id": "170",
|
2e3670ab
tangwang
index services
|
1453
|
"spu_ids": ["223167", "223168"]
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1454
1455
1456
|
}
```
|
2e3670ab
tangwang
index services
|
1457
1458
1459
1460
1461
1462
1463
1464
1465
|
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `tenant_id` | string | Y | 租户 ID |
| `spu_ids` | array[string] | Y | SPU ID 列表,**单次最多 200 个** |
#### 响应格式
与 `/indexer/build-docs` 相同:`tenant_id`、`docs`、`total`、`success_count`、`failed_count`、`failed`。
|
89638140
tangwang
重构 indexer 文档构建接口...
|
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
|
#### 请求示例
```bash
curl -X POST "http://127.0.0.1:6004/indexer/build-docs-from-db" \
-H "Content-Type: application/json" \
-d '{"tenant_id": "170", "spu_ids": ["223167"]}'
```
返回结构与 `/indexer/build-docs` 相同,可直接用于对比 ES 实际文档或调试字段映射问题。
|
11237cf2
tangwang
搜索API对接指南.md
|
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
|
---
## 管理接口
### 6.1 健康检查
- **端点**: `GET /admin/health`
- **描述**: 检查服务与依赖(如 Elasticsearch)状态。
```json
{
"status": "healthy",
"elasticsearch": "connected",
"tenant_id": "tenant1"
}
```
### 6.2 获取配置
- **端点**: `GET /admin/config`
- **描述**: 返回当前租户的脱敏配置,便于核对索引及排序表达式。
```json
{
"tenant_id": "tenant1",
"tenant_name": "Tenant1 Test Instance",
"es_index_name": "search_tenant1",
"num_fields": 20,
"num_indexes": 4,
"supported_languages": ["zh", "en", "ru"],
"ranking_expression": "bm25() + 0.2*text_embedding_relevance()",
"spu_enabled": false
}
```
### 6.3 索引统计
|
f7d3cf70
tangwang
更新文档
|
1512
|
|
11237cf2
tangwang
搜索API对接指南.md
|
1513
|
- **端点**: `GET /admin/stats`
|
26b910bd
tangwang
refactor service ...
|
1514
1515
|
- **描述**: 获取指定租户索引文档数量与磁盘大小,方便监控。
- **租户标识**:通过请求头 `X-Tenant-ID` 或 query 参数 `tenant_id` 传递(必填)。
|
b73baf85
tangwang
撰写接口文档
|
1516
|
|
11237cf2
tangwang
搜索API对接指南.md
|
1517
1518
|
```json
{
|
26b910bd
tangwang
refactor service ...
|
1519
1520
|
"tenant_id": "162",
"index_name": "search_products_tenant_162",
|
11237cf2
tangwang
搜索API对接指南.md
|
1521
1522
1523
1524
|
"document_count": 10000,
"size_mb": 523.45
}
```
|
b73baf85
tangwang
撰写接口文档
|
1525
1526
1527
|
---
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
|
## 7. 微服务接口(向量、重排、翻译)
以下三个微服务独立部署,**外部系统可直接调用**。它们被搜索后端(6002)和索引服务(6004)内部使用,也可供其他业务系统直接对接。
| 服务 | 默认端口 | Base URL | 说明 |
|------|----------|----------|------|
| 向量服务 | 6005 | `http://localhost:6005` | 文本/图片向量化,用于语义搜索与以图搜图 |
| 翻译服务 | 6006 | `http://localhost:6006` | 多语言翻译(Qwen/DeepL) |
| 重排服务 | 6007 | `http://localhost:6007` | 对检索结果进行二次排序 |
生产环境请将 `localhost` 替换为实际服务地址。
### 7.1 向量服务(Embedding)
- **Base URL**: `http://localhost:6005`(可通过 `EMBEDDING_SERVICE_URL` 覆盖)
- **启动**: `./scripts/start_embedding_service.sh`
- **依赖**:
- 文本向量后端默认走 TEI(`http://127.0.0.1:8080`)
- 图片向量依赖 `cnclip`(`grpc://127.0.0.1:51000`)
- TEI 默认使用 GPU(`TEI_USE_GPU=1`);当配置为 GPU 且不可用时会启动失败(不会自动降级到 CPU)
- cnclip 默认使用 `cuda`;若配置为 `cuda` 但 GPU 不可用会启动失败(不会自动降级到 `cpu`)
#### 7.1.1 `POST /embed/text` — 文本向量化
将文本列表转为 1024 维向量,用于语义搜索、文档索引等。
**请求体**(JSON 数组):
```json
["文本1", "文本2", "文本3"]
```
**响应**(JSON 数组,与输入一一对应):
```json
[[0.01, -0.02, ...], [0.03, 0.01, ...], ...]
```
**完整 curl 示例**:
```bash
curl -X POST "http://localhost:6005/embed/text" \
-H "Content-Type: application/json" \
-d '["芭比娃娃 儿童玩具", "纯棉T恤 短袖"]'
```
#### 7.1.2 `POST /embed/image` — 图片向量化
将图片 URL 或路径转为向量,用于以图搜图。
前置条件:`cnclip` 服务已启动(默认端口 `51000`)。若未启动,`/embed/image` 会返回 500。
**请求体**(JSON 数组):
```json
["https://example.com/image1.jpg", "https://example.com/image2.jpg"]
```
**响应**(JSON 数组,与输入一一对应):
```json
[[0.01, -0.02, ...], [0.03, 0.01, ...], ...]
```
**完整 curl 示例**:
```bash
curl -X POST "http://localhost:6005/embed/image" \
-H "Content-Type: application/json" \
-d '["https://oss.essa.cn/98532128-cf8e-456c-9e30-6f2a5ea0c19f.jpg"]'
```
#### 7.1.3 `GET /health` — 健康检查
```bash
curl "http://localhost:6005/health"
```
### 7.2 重排服务(Reranker)
- **Base URL**: `http://localhost:6007`(可通过 `RERANKER_SERVICE_URL` 覆盖)
- **启动**: `./scripts/start_reranker.sh`
说明:默认后端为 `qwen3_vllm`(`Qwen/Qwen3-Reranker-0.6B`),需要可用 GPU 显存。
#### 7.2.1 `POST /rerank` — 结果重排
根据 query 与 doc 的相关性对文档列表重新打分排序。
**请求体**:
```json
{
"query": "玩具 芭比",
"docs": [
"12PCS 6 Types of Dolls with Bottles",
"纯棉T恤 短袖 夏季"
],
"normalize": true
}
```
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `query` | string | Y | 搜索查询 |
| `docs` | array[string] | Y | 待重排的文档列表(单次最多由服务端配置限制) |
| `normalize` | boolean | N | 是否对分数做 sigmoid 归一化,默认 true |
**响应**:
```json
{
"scores": [0.92, 0.15],
"meta": {
"service_elapsed_ms": 45.2,
"input_docs": 2,
"unique_docs": 2
}
}
```
**完整 curl 示例**:
```bash
curl -X POST "http://localhost:6007/rerank" \
-H "Content-Type: application/json" \
-d '{
"query": "玩具 芭比",
"docs": ["12PCS 6 Types of Dolls with Bottles", "纯棉T恤 短袖"],
"normalize": true
}'
```
#### 7.2.2 `GET /health` — 健康检查
```bash
curl "http://localhost:6007/health"
```
### 7.3 翻译服务(Translation)
- **Base URL**: `http://localhost:6006`(可通过 `TRANSLATION_SERVICE_URL` 覆盖)
- **启动**: `./scripts/start_translator.sh`
#### 7.3.1 `POST /translate` — 文本翻译
支持 Qwen(默认)与 DeepL 模型,适用于商品名称、描述等电商场景。
**请求体**:
```json
{
"text": "商品名称",
"target_lang": "en",
"source_lang": "zh",
"model": "qwen"
}
```
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `text` | string | Y | 待翻译文本 |
| `target_lang` | string | Y | 目标语言:`zh`、`en`、`ru` 等 |
| `source_lang` | string | N | 源语言,不传则自动检测 |
| `model` | string | N | `qwen`(默认)或 `deepl` |
**响应**:
```json
{
"text": "商品名称",
"target_lang": "en",
"source_lang": "zh",
"translated_text": "Product name",
"status": "success",
"model": "qwen"
}
```
**完整 curl 示例**:
中文 → 英文:
```bash
curl -X POST "http://localhost:6006/translate" \
-H "Content-Type: application/json" \
-d '{
"text": "商品名称",
"target_lang": "en",
"source_lang": "zh"
}'
```
俄文 → 英文:
```bash
curl -X POST "http://localhost:6006/translate" \
-H "Content-Type: application/json" \
-d '{
"text": "Название товара",
"target_lang": "en",
"source_lang": "ru"
}'
```
使用 DeepL 模型:
```bash
curl -X POST "http://localhost:6006/translate" \
-H "Content-Type: application/json" \
-d '{
"text": "商品名称",
"target_lang": "en",
"source_lang": "zh",
"model": "deepl"
}'
```
#### 7.3.2 `GET /health` — 健康检查
```bash
curl "http://localhost:6006/health"
```
---
## 8. 常见场景示例
|
b73baf85
tangwang
撰写接口文档
|
1741
|
|
cd6d887e
tangwang
reranker doc
|
1742
1743
|
以下示例仅展示**请求体**(body);实际调用时请加上请求头 `X-Tenant-ID: <租户ID>`(或 URL 参数 `tenant_id`),参见 [3.1 接口信息](#31-接口信息)。
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1744
|
### 8.1 基础搜索与排序
|
b73baf85
tangwang
撰写接口文档
|
1745
|
|
11237cf2
tangwang
搜索API对接指南.md
|
1746
|
**按价格从低到高排序**:
|
b73baf85
tangwang
撰写接口文档
|
1747
1748
1749
1750
1751
|
```json
{
"query": "玩具",
"size": 20,
"from": 0,
|
13320ac6
tangwang
分面接口修改:
|
1752
|
"sort_by": "price",
|
b73baf85
tangwang
撰写接口文档
|
1753
1754
1755
1756
|
"sort_order": "asc"
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
1757
|
**按价格从高到低排序**:
|
13320ac6
tangwang
分面接口修改:
|
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
|
```json
{
"query": "玩具",
"size": 20,
"from": 0,
"sort_by": "price",
"sort_order": "desc"
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
1768
|
**按销量从高到低排序**:
|
13320ac6
tangwang
分面接口修改:
|
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
|
```json
{
"query": "玩具",
"size": 20,
"from": 0,
"sort_by": "sales",
"sort_order": "desc"
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
1779
|
**按默认(相关性)排序**:
|
13320ac6
tangwang
分面接口修改:
|
1780
1781
1782
1783
1784
1785
1786
1787
|
```json
{
"query": "玩具",
"size": 20,
"from": 0
}
```
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1788
|
### 8.2 过滤搜索
|
ca91352a
tangwang
更新文档
|
1789
|
|
11237cf2
tangwang
搜索API对接指南.md
|
1790
|
**需求**: 搜索"玩具",筛选类目为"益智玩具",价格在50-200之间
|
ca91352a
tangwang
更新文档
|
1791
1792
1793
|
```json
{
|
11237cf2
tangwang
搜索API对接指南.md
|
1794
|
"query": "玩具",
|
ca91352a
tangwang
更新文档
|
1795
|
"size": 20,
|
11237cf2
tangwang
搜索API对接指南.md
|
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
|
"language": "zh",
"filters": {
"category_name": "益智玩具"
},
"range_filters": {
"min_price": {
"gte": 50,
"lte": 200
}
}
|
ca91352a
tangwang
更新文档
|
1806
1807
1808
|
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
1809
|
**需求**: 搜索"手机",筛选多个品牌,价格范围
|
b73baf85
tangwang
撰写接口文档
|
1810
1811
1812
|
```json
{
|
11237cf2
tangwang
搜索API对接指南.md
|
1813
|
"query": "手机",
|
b73baf85
tangwang
撰写接口文档
|
1814
|
"size": 20,
|
f7d3cf70
tangwang
更新文档
|
1815
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
1816
|
"filters": {
|
d7d48f52
tangwang
改动(mapping + 灌入结构)
|
1817
|
"vendor.zh.keyword": ["品牌A", "品牌B"]
|
b73baf85
tangwang
撰写接口文档
|
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
|
},
"range_filters": {
"min_price": {
"gte": 50,
"lte": 200
}
}
}
```
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1828
|
### 8.3 分面搜索
|
b73baf85
tangwang
撰写接口文档
|
1829
|
|
13320ac6
tangwang
分面接口修改:
|
1830
|
**需求**: 搜索"玩具",获取类目和规格的分面统计,用于构建筛选器
|
b73baf85
tangwang
撰写接口文档
|
1831
1832
1833
1834
1835
|
```json
{
"query": "玩具",
"size": 20,
|
f7d3cf70
tangwang
更新文档
|
1836
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
1837
|
"facets": [
|
13320ac6
tangwang
分面接口修改:
|
1838
1839
1840
|
{"field": "category1_name", "size": 15, "type": "terms"},
{"field": "category2_name", "size": 10, "type": "terms"},
{"field": "specifications", "size": 10, "type": "terms"}
|
b73baf85
tangwang
撰写接口文档
|
1841
1842
1843
1844
|
]
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
1845
|
**需求**: 搜索"手机",获取价格区间和规格的分面统计
|
b73baf85
tangwang
撰写接口文档
|
1846
1847
1848
|
```json
{
|
f7d3cf70
tangwang
更新文档
|
1849
|
"query": "手机",
|
b73baf85
tangwang
撰写接口文档
|
1850
|
"size": 20,
|
f7d3cf70
tangwang
更新文档
|
1851
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
1852
1853
|
"facets": [
{
|
b73baf85
tangwang
撰写接口文档
|
1854
1855
1856
1857
1858
1859
1860
1861
|
"field": "min_price",
"type": "range",
"ranges": [
{"key": "0-50", "to": 50},
{"key": "50-100", "from": 50, "to": 100},
{"key": "100-200", "from": 100, "to": 200},
{"key": "200+", "from": 200}
]
|
f7d3cf70
tangwang
更新文档
|
1862
|
},
|
13320ac6
tangwang
分面接口修改:
|
1863
1864
1865
1866
1867
|
{
"field": "specifications",
"size": 10,
"type": "terms"
}
|
11237cf2
tangwang
搜索API对接指南.md
|
1868
|
]
|
b73baf85
tangwang
撰写接口文档
|
1869
1870
1871
|
}
```
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1872
|
### 8.4 规格过滤与分面
|
f7d3cf70
tangwang
更新文档
|
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
|
**需求**: 搜索"手机",筛选color为"white"的商品
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"filters": {
"specifications": {
"name": "color",
"value": "white"
}
}
}
```
|
85f08823
tangwang
过滤逻辑
|
1890
|
**需求**: 搜索"手机",筛选color为"white"且size为"256GB"的商品
|
f7d3cf70
tangwang
更新文档
|
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
|
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"filters": {
"specifications": [
{"name": "color", "value": "white"},
{"name": "size", "value": "256GB"}
]
}
}
```
|
85f08823
tangwang
过滤逻辑
|
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
|
**需求**: 搜索"手机",筛选size为"3"、"4"或"5",且color为"green"的商品
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"filters": {
"specifications": [
{"name": "size", "value": "3"},
{"name": "size", "value": "4"},
{"name": "size", "value": "5"},
{"name": "color", "value": "green"}
]
}
}
```
|
f7d3cf70
tangwang
更新文档
|
1924
1925
1926
1927
1928
1929
1930
|
**需求**: 搜索"手机",获取所有规格的分面统计
```json
{
"query": "手机",
"size": 20,
"language": "zh",
|
13320ac6
tangwang
分面接口修改:
|
1931
1932
1933
|
"facets": [
{"field": "specifications", "size": 10, "type": "terms"}
]
|
f7d3cf70
tangwang
更新文档
|
1934
1935
1936
|
}
```
|
13320ac6
tangwang
分面接口修改:
|
1937
|
**需求**: 只获取"color"和"size"规格的分面统计
|
f7d3cf70
tangwang
更新文档
|
1938
1939
1940
1941
1942
1943
|
```json
{
"query": "手机",
"size": 20,
"language": "zh",
|
13320ac6
tangwang
分面接口修改:
|
1944
1945
1946
1947
|
"facets": [
{"field": "specifications.color", "size": 20, "type": "terms"},
{"field": "specifications.size", "size": 15, "type": "terms"}
]
|
f7d3cf70
tangwang
更新文档
|
1948
1949
1950
|
}
```
|
f7d3cf70
tangwang
更新文档
|
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
|
**需求**: 搜索"手机",筛选类目和规格,并获取对应的分面统计
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"filters": {
"category_name": "手机",
"specifications": {
"name": "color",
"value": "white"
}
},
"facets": [
|
13320ac6
tangwang
分面接口修改:
|
1966
1967
1968
1969
|
{"field": "category1_name", "size": 15, "type": "terms"},
{"field": "category2_name", "size": 10, "type": "terms"},
{"field": "specifications.color", "size": 20, "type": "terms"},
{"field": "specifications.size", "size": 15, "type": "terms"}
|
f7d3cf70
tangwang
更新文档
|
1970
1971
1972
1973
|
]
}
```
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1974
|
### 8.5 SKU筛选
|
b73baf85
tangwang
撰写接口文档
|
1975
|
|
11237cf2
tangwang
搜索API对接指南.md
|
1976
|
**需求**: 搜索"芭比娃娃",每个SPU下按颜色筛选,每种颜色只显示一个SKU
|
b73baf85
tangwang
撰写接口文档
|
1977
1978
1979
|
```json
{
|
11237cf2
tangwang
搜索API对接指南.md
|
1980
|
"query": "芭比娃娃",
|
b73baf85
tangwang
撰写接口文档
|
1981
|
"size": 20,
|
11237cf2
tangwang
搜索API对接指南.md
|
1982
|
"sku_filter_dimension": ["color"]
|
4a677843
tangwang
文档完善
|
1983
1984
1985
|
}
```
|
11237cf2
tangwang
搜索API对接指南.md
|
1986
1987
1988
1989
|
**说明**:
- 如果 `option1_name` 为 `"color"`,则使用 `sku_filter_dimension: ["color"]` 可以按颜色分组
- 每个SPU下,每种颜色只会返回第一个SKU
- 如果维度不匹配,返回所有SKU(不进行过滤)
|
4a677843
tangwang
文档完善
|
1990
|
|
07cf5a93
tangwang
START_EMBEDDING=...
|
1991
|
### 8.7 分页查询
|
4a677843
tangwang
文档完善
|
1992
|
|
11237cf2
tangwang
搜索API对接指南.md
|
1993
|
**需求**: 获取第2页结果(每页20条)
|
4a677843
tangwang
文档完善
|
1994
1995
1996
|
```json
{
|
11237cf2
tangwang
搜索API对接指南.md
|
1997
1998
1999
|
"query": "手机",
"size": 20,
"from": 20
|
4a677843
tangwang
文档完善
|
2000
2001
2002
2003
2004
|
}
```
---
|
07cf5a93
tangwang
START_EMBEDDING=...
|
2005
|
## 9. 数据模型
|
4a677843
tangwang
文档完善
|
2006
|
|
07cf5a93
tangwang
START_EMBEDDING=...
|
2007
|
### 9.1 商品字段定义
|
4a677843
tangwang
文档完善
|
2008
2009
2010
|
| 字段名 | 类型 | 描述 |
|--------|------|------|
|
f7d3cf70
tangwang
更新文档
|
2011
|
| `tenant_id` | keyword | 租户ID(多租户隔离) |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
2012
|
| `spu_id` | keyword | SPU ID |
|
d7d48f52
tangwang
改动(mapping + 灌入结构)
|
2013
2014
2015
2016
2017
2018
|
| `title.<lang>` | object/text | 商品标题(多语言对象,如 `title.zh`, `title.en`) |
| `brief.<lang>` | object/text | 商品短描述(多语言对象,如 `brief.zh`, `brief.en`) |
| `description.<lang>` | object/text | 商品详细描述(多语言对象,如 `description.zh`, `description.en`) |
| `vendor.<lang>` | object/text | 供应商/品牌(多语言对象,且带 keyword 子字段,如 `vendor.zh.keyword`) |
| `category_path.<lang>` | object/text | 类目路径(多语言对象,用于搜索,如 `category_path.zh`) |
| `category_name_text.<lang>` | object/text | 类目名称(多语言对象,用于搜索,如 `category_name_text.zh`) |
|
f7d3cf70
tangwang
更新文档
|
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
|
| `category_id` | keyword | 类目ID |
| `category_name` | keyword | 类目名称(用于过滤) |
| `category_level` | integer | 类目层级 |
| `category1_name`, `category2_name`, `category3_name` | keyword | 多级类目名称(用于过滤和分面) |
| `tags` | keyword | 标签(数组) |
| `specifications` | nested | 规格(嵌套对象数组) |
| `option1_name`, `option2_name`, `option3_name` | keyword | 选项名称 |
| `min_price`, `max_price` | float | 最低/最高价格 |
| `compare_at_price` | float | 原价 |
| `sku_prices` | float | SKU价格列表(数组) |
| `sku_weights` | long | SKU重量列表(数组) |
| `sku_weight_units` | keyword | SKU重量单位列表(数组) |
| `total_inventory` | long | 总库存 |
|
13320ac6
tangwang
分面接口修改:
|
2032
|
| `sales` | long | 销量(展示销量) |
|
f7d3cf70
tangwang
更新文档
|
2033
2034
2035
2036
2037
2038
|
| `skus` | nested | SKU详细信息(嵌套对象数组) |
| `create_time`, `update_time` | date | 创建/更新时间 |
| `title_embedding` | dense_vector | 标题向量(1024维,仅用于搜索) |
| `image_embedding` | nested | 图片向量(嵌套,仅用于搜索) |
> 所有租户共享统一的索引结构。文本字段支持中英文双语,后端根据 `language` 参数自动选择对应字段返回。
|
4a677843
tangwang
文档完善
|
2039
|
|
07cf5a93
tangwang
START_EMBEDDING=...
|
2040
|
### 9.2 字段类型速查
|
4a677843
tangwang
文档完善
|
2041
|
|
11237cf2
tangwang
搜索API对接指南.md
|
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
|
| 类型 | ES Mapping | 用途 |
|------|------------|------|
| `text` | `text` | 全文检索(支持中英文分析器) |
| `keyword` | `keyword` | 精确匹配、聚合、排序 |
| `integer` | `integer` | 整数 |
| `long` | `long` | 长整数 |
| `float` | `float` | 浮点数 |
| `date` | `date` | 日期时间 |
| `nested` | `nested` | 嵌套对象(specifications, skus, image_embedding) |
| `dense_vector` | `dense_vector` | 向量字段(title_embedding,仅用于搜索) |
|
b73baf85
tangwang
撰写接口文档
|
2052
|
|
07cf5a93
tangwang
START_EMBEDDING=...
|
2053
|
### 9.3 常用字段列表
|
b73baf85
tangwang
撰写接口文档
|
2054
|
|
f7d3cf70
tangwang
更新文档
|
2055
|
#### 过滤字段
|
b73baf85
tangwang
撰写接口文档
|
2056
|
|
f7d3cf70
tangwang
更新文档
|
2057
2058
2059
|
- `category_name`: 类目名称
- `category1_name`, `category2_name`, `category3_name`: 多级类目
- `category_id`: 类目ID
|
d7d48f52
tangwang
改动(mapping + 灌入结构)
|
2060
|
- `vendor.zh.keyword`, `vendor.en.keyword`: 供应商/品牌(使用keyword子字段)
|
f7d3cf70
tangwang
更新文档
|
2061
2062
|
- `tags`: 标签(keyword类型)
- `option1_name`, `option2_name`, `option3_name`: 选项名称
|
11237cf2
tangwang
搜索API对接指南.md
|
2063
|
- `specifications`: 规格过滤(嵌套字段,格式见[过滤器详解](#33-过滤器详解))
|
b73baf85
tangwang
撰写接口文档
|
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
|
#### 范围字段
- `min_price`: 最低价格
- `max_price`: 最高价格
- `compare_at_price`: 原价
- `create_time`: 创建时间
- `update_time`: 更新时间
#### 排序字段
|
13320ac6
tangwang
分面接口修改:
|
2075
2076
|
- `price`: 价格(后端自动根据sort_order映射:asc→min_price,desc→max_price)
- `sales`: 销量
|
b73baf85
tangwang
撰写接口文档
|
2077
2078
|
- `create_time`: 创建时间
- `update_time`: 更新时间
|
13320ac6
tangwang
分面接口修改:
|
2079
2080
2081
2082
2083
|
- `relevance_score`: 相关性分数(默认,不指定sort_by时使用)
**注意**: 前端只需传 `price`,后端会自动处理:
- `sort_by: "price"` + `sort_order: "asc"` → 按 `min_price` 升序(价格从低到高)
- `sort_by: "price"` + `sort_order: "desc"` → 按 `max_price` 降序(价格从高到低)
|
b73baf85
tangwang
撰写接口文档
|
2084
|
|
07cf5a93
tangwang
START_EMBEDDING=...
|
2085
|
### 9.4 支持的分析器
|
4a677843
tangwang
文档完善
|
2086
2087
2088
|
| 分析器 | 语言 | 描述 |
|--------|------|------|
|
3c1f8031
tangwang
api/routes/indexe...
|
2089
2090
|
| `index_ansj` | 中文 | 中文索引分析器(用于中文字段) |
| `query_ansj` | 中文 | 中文查询分析器(用于中文字段) |
|
11237cf2
tangwang
搜索API对接指南.md
|
2091
2092
|
| `hanlp_index` ⚠️ TODO(暂不支持) | 中文 | 中文索引分析器(用于中文字段) |
| `hanlp_standard` ⚠️ TODO(暂不支持) | 中文 | 中文查询分析器(用于中文字段) |
|
f7d3cf70
tangwang
更新文档
|
2093
2094
|
| `english` | 英文 | 标准英文分析器(用于英文字段) |
| `lowercase` | - | 小写标准化器(用于keyword子字段) |
|