b73baf85
tangwang
撰写接口文档
|
1
2
3
4
5
6
7
8
|
# 搜索API接口对接指南
本文档为搜索服务的使用方提供完整的API对接指南,包括接口说明、请求参数、响应格式和使用示例。
## 目录
1. [快速开始](#快速开始)
2. [接口概览](#接口概览)
|
af249836
tangwang
文档完善
|
9
10
11
|
3. [搜索接口](#搜索接口)
4. [响应格式说明](#响应格式说明)
5. [常见场景示例](#常见场景示例)
|
b73baf85
tangwang
撰写接口文档
|
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
---
## 快速开始
### 基础信息
- **Base URL**: `http://your-domain:6002` 或 `http://120.76.41.98:6002`
- **协议**: HTTP/HTTPS
- **数据格式**: JSON
- **字符编码**: UTF-8
- **请求方法**: POST(搜索接口)
### 最简单的搜索请求
```bash
|
97a5d59d
tangwang
文档修改
|
28
|
curl -X POST "http://120.76.41.98:6002/search/" \
|
b73baf85
tangwang
撰写接口文档
|
29
|
-H "Content-Type: application/json" \
|
97a5d59d
tangwang
文档修改
|
30
31
|
-H "X-Tenant-ID: 2" \
-d '{"query": "芭比娃娃"}'
|
b73baf85
tangwang
撰写接口文档
|
32
33
|
```
|
b0ad8e89
tangwang
文档完善
|
34
|
### curl示例:带过滤与分页
|
b73baf85
tangwang
撰写接口文档
|
35
|
|
b0ad8e89
tangwang
文档完善
|
36
|
```bash
|
97a5d59d
tangwang
文档修改
|
37
|
curl -X POST "http://120.76.41.98:6002/search/" \
|
b0ad8e89
tangwang
文档完善
|
38
|
-H "Content-Type: application/json" \
|
97a5d59d
tangwang
文档修改
|
39
|
-H "X-Tenant-ID: 2" \
|
b0ad8e89
tangwang
文档完善
|
40
|
-d '{
|
97a5d59d
tangwang
文档修改
|
41
|
"query": "芭比娃娃",
|
b0ad8e89
tangwang
文档完善
|
42
43
|
"size": 5,
"from": 10,
|
97a5d59d
tangwang
文档修改
|
44
45
46
47
|
"range_filters": {
"min_price": {
"gte": 50,
"lte": 200
|
b0ad8e89
tangwang
文档完善
|
48
|
},
|
97a5d59d
tangwang
文档修改
|
49
50
51
52
|
"create_time": {
"gte": "2020-01-01T00:00:00Z"
}
},
|
b0ad8e89
tangwang
文档完善
|
53
54
55
|
"sort_by": "min_price",
"sort_order": "asc"
}'
|
b73baf85
tangwang
撰写接口文档
|
56
57
|
```
|
97a5d59d
tangwang
文档修改
|
58
|
### curl示例:开启分面
|
b73baf85
tangwang
撰写接口文档
|
59
|
|
b0ad8e89
tangwang
文档完善
|
60
|
```bash
|
97a5d59d
tangwang
文档修改
|
61
|
curl -X POST "http://120.76.41.98:6002/search/" \
|
b0ad8e89
tangwang
文档完善
|
62
|
-H "Content-Type: application/json" \
|
97a5d59d
tangwang
文档修改
|
63
|
-H "X-Tenant-ID: 2" \
|
b0ad8e89
tangwang
文档完善
|
64
65
66
|
-d '{
"tenant_id": "demo-tenant",
"query": "芭比娃娃",
|
f7d3cf70
tangwang
更新文档
|
67
|
"facets": ["category.keyword", "specifications.color", "specifications.size"],
|
97a5d59d
tangwang
文档修改
|
68
|
"min_score": 0.2
|
b0ad8e89
tangwang
文档完善
|
69
|
}'
|
b73baf85
tangwang
撰写接口文档
|
70
71
72
73
74
75
|
```
---
## 接口概览
|
3cf1c64d
tangwang
文档完善
|
76
77
78
79
80
81
|
| 接口 | HTTP Method | Endpoint |
|------|------|------|
| 搜索 | POST | `/search/` |
| 搜索建议(框架,暂未实现) | GET | `/search/suggestions` |
| 获取文档 | GET | `/search/{doc_id}` |
| 健康检查 | GET | `/admin/health` |
|
b73baf85
tangwang
撰写接口文档
|
82
83
84
|
---
|
af249836
tangwang
文档完善
|
85
|
## 搜索接口
|
b73baf85
tangwang
撰写接口文档
|
86
87
88
89
90
91
92
93
94
95
96
97
|
### 接口信息
- **端点**: `POST /search/`
- **描述**: 执行文本搜索查询,支持多语言、布尔表达式、过滤器和分面搜索
### 请求参数
#### 完整请求体结构
```json
{
|
b73baf85
tangwang
撰写接口文档
|
98
99
100
|
"query": "string (required)",
"size": 10,
"from": 0,
|
f7d3cf70
tangwang
更新文档
|
101
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
102
103
104
105
106
107
108
109
110
111
112
113
|
"filters": {},
"range_filters": {},
"facets": [],
"sort_by": "string",
"sort_order": "desc",
"min_score": 0.0,
"debug": false,
"user_id": "string",
"session_id": "string"
}
```
|
f7d3cf70
tangwang
更新文档
|
114
115
|
**注意**: `tenant_id` 通过 HTTP Header `X-Tenant-ID` 传递,不在请求体中。
|
b73baf85
tangwang
撰写接口文档
|
116
117
118
119
|
#### 参数详细说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|------|------|------|--------|------|
|
af249836
tangwang
文档完善
|
120
121
122
|
| `query` | string | Y | - | 搜索查询字符串,支持布尔表达式(AND, OR, RANK, ANDNOT) |
| `size` | integer | N | 10 | 返回结果数量(1-100) |
| `from` | integer | N | 0 | 分页偏移量(用于分页) |
|
f7d3cf70
tangwang
更新文档
|
123
|
| `language` | string | N | "zh" | 返回语言:`zh`(中文)或 `en`(英文)。后端会根据此参数选择对应的中英文字段返回 |
|
af249836
tangwang
文档完善
|
124
125
126
|
| `filters` | object | N | null | 精确匹配过滤器(见下文) |
| `range_filters` | object | N | null | 数值范围过滤器(见下文) |
| `facets` | array | N | null | 分面配置(见下文) |
|
f7d3cf70
tangwang
更新文档
|
127
|
| `sort_by` | string | N | null | 排序字段名(如 `min_price`, `max_price`) |
|
af249836
tangwang
文档完善
|
128
129
130
131
132
|
| `sort_order` | string | N | "desc" | 排序方向:`asc`(升序)或 `desc`(降序) |
| `min_score` | float | N | null | 最小相关性分数阈值 |
| `debug` | boolean | N | false | 是否返回调试信息 |
| `user_id` | string | N | null | 用户ID(用于个性化,预留) |
| `session_id` | string | N | null | 会话ID(用于分析,预留) |
|
b73baf85
tangwang
撰写接口文档
|
133
134
135
136
137
138
139
140
141
142
143
|
### 过滤器详解
#### 1. 精确匹配过滤器 (filters)
用于精确匹配或多值匹配(OR 逻辑)。
**格式**:
```json
{
"filters": {
|
f7d3cf70
tangwang
更新文档
|
144
145
146
147
148
149
150
151
152
153
154
|
"category_name": "手机", // 单值:精确匹配
"category1_name": "服装", // 一级类目
"category2_name": "男装", // 二级类目
"category3_name": "衬衫", // 三级类目
"vendor_zh.keyword": ["奇乐", "品牌A"], // 数组:匹配任意值(OR)
"tags": "手机", // 标签(keyword类型)
// specifications 嵌套过滤(特殊格式)
"specifications": {
"name": "color",
"value": "white"
}
|
b73baf85
tangwang
撰写接口文档
|
155
156
157
158
159
160
161
162
163
|
}
}
```
**支持的值类型**:
- 字符串:精确匹配
- 整数:精确匹配
- 布尔值:精确匹配
- 数组:匹配任意值(OR 逻辑)
|
f7d3cf70
tangwang
更新文档
|
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
- 对象:specifications 嵌套过滤(见下文)
**Specifications 嵌套过滤**:
`specifications` 是嵌套字段,支持按规格名称和值进行过滤。
**单个规格过滤**:
```json
{
"filters": {
"specifications": {
"name": "color",
"value": "white"
}
}
}
```
查询规格名称为"color"且值为"white"的商品。
**多个规格过滤(OR 逻辑)**:
```json
{
"filters": {
"specifications": [
{"name": "color", "value": "white"},
{"name": "size", "value": "256GB"}
]
}
}
```
查询满足任意一个规格的商品(color=white **或** size=256GB)。
|
b73baf85
tangwang
撰写接口文档
|
195
196
|
**常用过滤字段**:
|
f7d3cf70
tangwang
更新文档
|
197
198
199
200
201
202
203
|
- `category_name`: 类目名称
- `category1_name`, `category2_name`, `category3_name`: 多级类目
- `category_id`: 类目ID
- `vendor_zh.keyword`, `vendor_en.keyword`: 供应商/品牌(使用keyword子字段)
- `tags`: 标签(keyword类型,支持数组)
- `option1_name`, `option2_name`, `option3_name`: 选项名称
- `specifications`: 规格过滤(嵌套字段,格式见上文)
|
b73baf85
tangwang
撰写接口文档
|
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
#### 2. 范围过滤器 (range_filters)
用于数值字段的范围过滤。
**格式**:
```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`: 小于 (<)
**注意**: 至少需要指定一个操作符。
**常用范围字段**:
- `min_price`: 最低价格
- `max_price`: 最高价格
- `compare_at_price`: 原价
- `create_time`: 创建时间
- `update_time`: 更新时间
#### 3. 分面配置 (facets)
用于生成分面统计(分组聚合),常用于构建筛选器UI。
**简单模式**(字符串数组):
```json
{
|
f7d3cf70
tangwang
更新文档
|
249
|
"facets": ["category1_name", "category2_name", "category3_name", "specifications"]
|
b73baf85
tangwang
撰写接口文档
|
250
251
252
253
254
255
256
257
|
}
```
**高级模式**(配置对象数组):
```json
{
"facets": [
{
|
f7d3cf70
tangwang
更新文档
|
258
|
"field": "category1_name",
|
b73baf85
tangwang
撰写接口文档
|
259
260
261
262
263
264
265
266
267
268
269
270
|
"size": 15,
"type": "terms"
},
{
"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
更新文档
|
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
},
"specifications" // 规格分面(特殊处理:嵌套聚合,按name分组,然后按value聚合)
]
}
```
**规格分面说明**:
`specifications` 是嵌套字段,支持两种分面模式:
**模式1:所有规格名称的分面** (`"specifications"`):
```json
{
"facets": ["specifications"]
}
```
返回所有规格名称(name)及其对应的值(value)列表。每个 name 会生成一个独立的分面结果。
**模式2:指定规格名称的分面** (`"specifications.color"`):
```json
{
"facets": ["specifications.color", "specifications.size"]
}
```
只返回指定规格名称的值列表。格式:`specifications.{name}`,其中 `{name}` 是规格名称(如"color"、"size")。
**返回格式示例**:
```json
{
"facets": [
{
"field": "specifications.color",
"label": "color",
"type": "terms",
"values": [
{"value": "white", "count": 50, "selected": false},
{"value": "black", "count": 30, "selected": false}
]
},
{
"field": "specifications.size",
"label": "size",
"type": "terms",
"values": [
{"value": "256GB", "count": 40, "selected": false},
{"value": "512GB", "count": 20, "selected": false}
]
|
b73baf85
tangwang
撰写接口文档
|
318
319
320
321
322
323
324
325
326
327
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
357
358
359
360
|
}
]
}
```
**分面配置参数**:
- `field`: 字段名(必填)
- `size`: 返回的分组数量(默认:10,范围:1-100)
- `type`: 分面类型,`terms`(分组统计)或 `range`(范围统计)
- `ranges`: 范围定义(仅当 type='range' 时需要)
### 布尔表达式语法
搜索查询支持布尔表达式,提供更灵活的搜索能力。
**支持的操作符**:
| 操作符 | 描述 | 示例 |
|--------|------|------|
| `AND` | 所有词必须匹配 | `玩具 AND 乐高` |
| `OR` | 任意词匹配 | `芭比 OR 娃娃` |
| `ANDNOT` | 排除特定词 | `玩具 ANDNOT 电动` |
| `RANK` | 排序加权(不强制匹配) | `玩具 RANK 乐高` |
| `()` | 分组 | `玩具 AND (乐高 OR 芭比)` |
**操作符优先级**(从高到低):
1. `()` - 括号
2. `ANDNOT` - 排除
3. `AND` - 与
4. `OR` - 或
5. `RANK` - 排序
**示例**:
```
"芭比娃娃" // 简单查询
"玩具 AND 乐高" // AND 查询
"芭比 OR 娃娃" // OR 查询
"玩具 ANDNOT 电动" // 排除查询
"玩具 AND (乐高 OR 芭比)" // 复杂查询
```
---
|
b73baf85
tangwang
撰写接口文档
|
361
362
363
364
365
366
367
368
|
## 响应格式说明
### 标准响应结构
```json
{
"results": [
{
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
369
|
"spu_id": "12345",
|
b73baf85
tangwang
撰写接口文档
|
370
|
"title": "芭比时尚娃娃",
|
f7d3cf70
tangwang
更新文档
|
371
372
|
"brief": "高品质芭比娃娃",
"description": "详细描述...",
|
b73baf85
tangwang
撰写接口文档
|
373
|
"vendor": "美泰",
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
374
|
"category": "玩具",
|
f7d3cf70
tangwang
更新文档
|
375
376
377
378
379
380
381
382
|
"category_path": "玩具/娃娃/时尚",
"category_name": "时尚",
"category_id": "cat_001",
"category_level": 3,
"category1_name": "玩具",
"category2_name": "娃娃",
"category3_name": "时尚",
"tags": ["娃娃", "玩具", "女孩"],
|
b73baf85
tangwang
撰写接口文档
|
383
384
385
386
387
|
"price": 89.99,
"compare_at_price": 129.99,
"currency": "USD",
"image_url": "https://example.com/image.jpg",
"in_stock": true,
|
f7d3cf70
tangwang
更新文档
|
388
389
390
391
392
393
394
395
396
397
398
|
"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"}
],
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
399
|
"skus": [
|
b73baf85
tangwang
撰写接口文档
|
400
|
{
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
401
|
"sku_id": "67890",
|
b73baf85
tangwang
撰写接口文档
|
402
403
404
405
|
"price": 89.99,
"compare_at_price": 129.99,
"sku": "BARBIE-001",
"stock": 100,
|
f7d3cf70
tangwang
更新文档
|
406
407
408
409
410
411
|
"weight": 0.1,
"weight_unit": "kg",
"option1_value": "pink",
"option2_value": "standard",
"option3_value": null,
"image_src": "https://example.com/sku1.jpg"
|
b73baf85
tangwang
撰写接口文档
|
412
413
414
415
416
417
418
419
420
|
}
],
"relevance_score": 8.5
}
],
"total": 118,
"max_score": 8.5,
"facets": [
{
|
f7d3cf70
tangwang
更新文档
|
421
422
|
"field": "category1_name",
"label": "category1_name",
|
b73baf85
tangwang
撰写接口文档
|
423
424
425
426
427
428
429
430
431
|
"type": "terms",
"values": [
{
"value": "玩具",
"label": "玩具",
"count": 85,
"selected": false
}
]
|
f7d3cf70
tangwang
更新文档
|
432
433
434
435
436
437
438
439
440
441
442
443
444
|
},
{
"field": "specifications.color",
"label": "color",
"type": "terms",
"values": [
{
"value": "pink",
"label": "pink",
"count": 30,
"selected": false
}
]
|
b73baf85
tangwang
撰写接口文档
|
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
|
}
],
"query_info": {
"original_query": "芭比娃娃",
"detected_language": "zh",
"translations": {
"en": "barbie doll"
}
},
"suggestions": [],
"related_searches": [],
"took_ms": 45,
"performance_info": null,
"debug_info": null
}
```
### 响应字段说明
| 字段 | 类型 | 说明 |
|------|------|------|
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
466
467
|
| `results` | array | 搜索结果列表(SpuResult对象数组) |
| `results[].spu_id` | string | SPU ID |
|
b73baf85
tangwang
撰写接口文档
|
468
469
|
| `results[].title` | string | 商品标题 |
| `results[].price` | float | 价格(min_price) |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
470
|
| `results[].skus` | array | SKU列表 |
|
b73baf85
tangwang
撰写接口文档
|
471
472
473
474
475
476
477
|
| `results[].relevance_score` | float | 相关性分数 |
| `total` | integer | 匹配的总文档数 |
| `max_score` | float | 最高相关性分数 |
| `facets` | array | 分面统计结果 |
| `query_info` | object | 查询处理信息 |
| `took_ms` | integer | 搜索耗时(毫秒) |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
478
|
### SpuResult字段说明
|
b73baf85
tangwang
撰写接口文档
|
479
480
481
|
| 字段 | 类型 | 说明 |
|------|------|------|
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
482
|
| `spu_id` | string | SPU ID |
|
f7d3cf70
tangwang
更新文档
|
483
484
485
486
487
488
489
490
491
492
493
494
495
|
| `title` | string | 商品标题(根据language参数自动选择title_zh或title_en) |
| `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
撰写接口文档
|
496
497
498
499
|
| `price` | float | 价格(min_price) |
| `compare_at_price` | float | 原价 |
| `currency` | string | 货币单位(默认USD) |
| `image_url` | string | 主图URL |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
500
|
| `in_stock` | boolean | 是否有库存(任意SKU有库存即为true) |
|
f7d3cf70
tangwang
更新文档
|
501
502
503
504
505
506
507
508
|
| `sku_prices` | array[float] | 所有SKU价格列表 |
| `sku_weights` | array[integer] | 所有SKU重量列表 |
| `sku_weight_units` | array[string] | 所有SKU重量单位列表 |
| `total_inventory` | integer | 总库存 |
| `option1_name` | string | 选项1名称(如"color") |
| `option2_name` | string | 选项2名称(如"size") |
| `option3_name` | string | 选项3名称 |
| `specifications` | array[object] | 规格列表(与ES specifications字段对应) |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
509
|
| `skus` | array | SKU 列表 |
|
b73baf85
tangwang
撰写接口文档
|
510
511
|
| `relevance_score` | float | 相关性分数 |
|
f7d3cf70
tangwang
更新文档
|
512
513
514
515
516
|
**多语言字段说明**:
- `title`, `brief`, `description`, `vendor`, `category_path`, `category_name` 会根据请求的 `language` 参数自动选择对应的中英文字段
- `language="zh"`: 优先返回 `*_zh` 字段,如果为空则回退到 `*_en` 字段
- `language="en"`: 优先返回 `*_en` 字段,如果为空则回退到 `*_zh` 字段
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
517
|
### SkuResult字段说明
|
b73baf85
tangwang
撰写接口文档
|
518
519
520
|
| 字段 | 类型 | 说明 |
|------|------|------|
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
521
|
| `sku_id` | string | SKU ID |
|
b73baf85
tangwang
撰写接口文档
|
522
523
|
| `price` | float | 价格 |
| `compare_at_price` | float | 原价 |
|
f7d3cf70
tangwang
更新文档
|
524
|
| `sku` | string | SKU编码(sku_code) |
|
b73baf85
tangwang
撰写接口文档
|
525
|
| `stock` | integer | 库存数量 |
|
f7d3cf70
tangwang
更新文档
|
526
527
528
529
530
531
|
| `weight` | float | 重量 |
| `weight_unit` | string | 重量单位 |
| `option1_value` | string | 选项1取值(如color值) |
| `option2_value` | string | 选项2取值(如size值) |
| `option3_value` | string | 选项3取值 |
| `image_src` | string | SKU图片地址 |
|
b73baf85
tangwang
撰写接口文档
|
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
|
---
## 常见场景示例
### 场景1:商品列表页搜索
**需求**: 搜索"玩具",按价格从低到高排序,显示前20个结果
```json
{
"query": "玩具",
"size": 20,
"from": 0,
"sort_by": "min_price",
"sort_order": "asc"
}
```
### 场景2:带筛选的商品搜索
**需求**: 搜索"玩具",筛选类目为"益智玩具",价格在50-200之间
```json
{
"query": "玩具",
"size": 20,
|
f7d3cf70
tangwang
更新文档
|
559
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
560
|
"filters": {
|
f7d3cf70
tangwang
更新文档
|
561
|
"category_name": "益智玩具"
|
b73baf85
tangwang
撰写接口文档
|
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
|
},
"range_filters": {
"min_price": {
"gte": 50,
"lte": 200
}
}
}
```
### 场景3:带分面的商品搜索
**需求**: 搜索"玩具",获取类目和品牌的分面统计,用于构建筛选器
```json
{
"query": "玩具",
"size": 20,
|
f7d3cf70
tangwang
更新文档
|
580
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
581
|
"facets": [
|
f7d3cf70
tangwang
更新文档
|
582
583
584
|
"category1_name",
"category2_name",
"specifications"
|
b73baf85
tangwang
撰写接口文档
|
585
586
587
588
589
590
|
]
}
```
### 场景4:多条件组合搜索
|
f7d3cf70
tangwang
更新文档
|
591
|
**需求**: 搜索"手机",筛选多个品牌,价格范围,并获取分面统计
|
b73baf85
tangwang
撰写接口文档
|
592
593
594
|
```json
{
|
f7d3cf70
tangwang
更新文档
|
595
|
"query": "手机",
|
b73baf85
tangwang
撰写接口文档
|
596
|
"size": 20,
|
f7d3cf70
tangwang
更新文档
|
597
|
"language": "zh",
|
b73baf85
tangwang
撰写接口文档
|
598
|
"filters": {
|
f7d3cf70
tangwang
更新文档
|
599
|
"vendor_zh.keyword": ["品牌A", "品牌B"]
|
b73baf85
tangwang
撰写接口文档
|
600
601
602
603
604
605
606
607
608
|
},
"range_filters": {
"min_price": {
"gte": 50,
"lte": 200
}
},
"facets": [
{
|
f7d3cf70
tangwang
更新文档
|
609
|
"field": "category1_name",
|
b73baf85
tangwang
撰写接口文档
|
610
611
612
613
614
615
616
617
618
619
620
|
"size": 15
},
{
"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
更新文档
|
621
622
|
},
"specifications"
|
b73baf85
tangwang
撰写接口文档
|
623
624
625
626
627
628
|
],
"sort_by": "min_price",
"sort_order": "asc"
}
```
|
f7d3cf70
tangwang
更新文档
|
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
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
|
### 场景5:规格过滤搜索
**需求**: 搜索"手机",筛选color为"white"的商品
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"filters": {
"specifications": {
"name": "color",
"value": "white"
}
}
}
```
### 场景6:多个规格过滤(OR逻辑)
**需求**: 搜索"手机",筛选color为"white"或size为"256GB"的商品
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"filters": {
"specifications": [
{"name": "color", "value": "white"},
{"name": "size", "value": "256GB"}
]
}
}
```
### 场景7:规格分面搜索
**需求**: 搜索"手机",获取所有规格的分面统计
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"facets": ["specifications"]
}
```
**需求**: 只获取"color"规格的分面统计
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"facets": ["specifications.color", "specifications.size"]
}
```
### 场景8:组合过滤和分面
**需求**: 搜索"手机",筛选类目和规格,并获取对应的分面统计
```json
{
"query": "手机",
"size": 20,
"language": "zh",
"filters": {
"category_name": "手机",
"specifications": {
"name": "color",
"value": "white"
}
},
"facets": [
"category1_name",
"category2_name",
"specifications.color",
"specifications.size"
]
}
```
### 场景9:布尔表达式搜索
|
b73baf85
tangwang
撰写接口文档
|
715
|
|
f7d3cf70
tangwang
更新文档
|
716
|
**需求**: 搜索包含"手机"和"智能"的商品,排除"二手"
|
b73baf85
tangwang
撰写接口文档
|
717
718
719
|
```json
{
|
f7d3cf70
tangwang
更新文档
|
720
|
"query": "手机 AND 智能 ANDNOT 二手",
|
b73baf85
tangwang
撰写接口文档
|
721
722
723
724
|
"size": 20
}
```
|
f7d3cf70
tangwang
更新文档
|
725
|
### 场景10:分页查询
|
b73baf85
tangwang
撰写接口文档
|
726
727
728
729
730
|
**需求**: 获取第2页结果(每页20条)
```json
{
|
f7d3cf70
tangwang
更新文档
|
731
|
"query": "手机",
|
b73baf85
tangwang
撰写接口文档
|
732
733
734
735
736
737
738
|
"size": 20,
"from": 20
}
```
---
|
b73baf85
tangwang
撰写接口文档
|
739
740
|
---
|
4a677843
tangwang
文档完善
|
741
742
743
744
745
746
747
748
749
750
751
|
## 其他接口
### 搜索建议(框架)
- **端点**: `GET /search/suggestions`
- **描述**: 返回搜索建议(自动补全/热词)。当前为框架实现,接口和响应格式已经固定,可平滑扩展。
#### 查询参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|------|------|------|--------|------|
|
af249836
tangwang
文档完善
|
752
753
754
|
| `q` | string | Y | - | 查询字符串(至少 1 个字符) |
| `size` | integer | N | 5 | 返回建议数量(1-20) |
| `types` | string | N | `query` | 建议类型(逗号分隔):`query`, `product`, `category`, `brand` |
|
4a677843
tangwang
文档完善
|
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
|
#### 响应示例
```json
{
"query": "芭",
"suggestions": [
{
"text": "芭比娃娃",
"type": "query",
"highlight": "<em>芭</em>比娃娃",
"popularity": 850
}
],
"took_ms": 5
}
```
#### 请求示例
```bash
curl "http://localhost:6002/search/suggestions?q=芭&size=5&types=query,product"
```
---
### 即时搜索(框架)
- **端点**: `GET /search/instant`
- **描述**: 边输入边搜索,采用轻量参数响应当前输入。底层复用标准搜索能力。
#### 查询参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|------|------|------|--------|------|
|
af249836
tangwang
文档完善
|
790
791
|
| `q` | string | Y | - | 搜索查询(至少 2 个字符) |
| `size` | integer | N | 5 | 返回结果数量(1-20) |
|
4a677843
tangwang
文档完善
|
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
|
#### 请求示例
```bash
curl "http://localhost:6002/search/instant?q=玩具&size=5"
```
---
### 获取单个文档
- **端点**: `GET /search/{doc_id}`
- **描述**: 根据文档 ID 获取单个商品详情,用于点击结果后的详情页或排查问题。
#### 路径参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `doc_id` | string | 商品或文档 ID |
#### 响应示例
```json
{
"id": "12345",
"source": {
"title": "芭比时尚娃娃",
"min_price": 89.99,
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
820
|
"category.keyword": "玩具"
|
4a677843
tangwang
文档完善
|
821
822
823
824
825
826
827
828
829
830
831
832
833
834
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
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
|
}
}
```
#### 请求示例
```bash
curl "http://localhost:6002/search/12345"
```
---
## 管理接口
### 健康检查
- **端点**: `GET /admin/health`
- **描述**: 检查服务与依赖(如 Elasticsearch)状态。
```json
{
"status": "healthy",
"elasticsearch": "connected",
"tenant_id": "tenant1"
}
```
---
### 获取配置
- **端点**: `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
}
```
---
### 索引统计
- **端点**: `GET /admin/stats`
- **描述**: 获取索引文档数量与磁盘大小,方便监控。
```json
{
"index_name": "search_tenant1",
"document_count": 10000,
"size_mb": 523.45
}
```
---
## 数据模型
### 商品字段
| 字段名 | 类型 | 描述 |
|--------|------|------|
|
f7d3cf70
tangwang
更新文档
|
891
|
| `tenant_id` | keyword | 租户ID(多租户隔离) |
|
cadc77b6
tangwang
索引字段名、变量名、API数据结构...
|
892
|
| `spu_id` | keyword | SPU ID |
|
f7d3cf70
tangwang
更新文档
|
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
|
| `title_zh`, `title_en` | text | 商品标题(中英文) |
| `brief_zh`, `brief_en` | text | 商品短描述(中英文) |
| `description_zh`, `description_en` | text | 商品详细描述(中英文) |
| `vendor_zh`, `vendor_en` | text | 供应商/品牌(中英文,含keyword子字段) |
| `category_path_zh`, `category_path_en` | text | 类目路径(中英文,用于搜索) |
| `category_name_zh`, `category_name_en` | text | 类目名称(中英文,用于搜索) |
| `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 | 总库存 |
| `skus` | nested | SKU详细信息(嵌套对象数组) |
| `create_time`, `update_time` | date | 创建/更新时间 |
| `title_embedding` | dense_vector | 标题向量(1024维,仅用于搜索) |
| `image_embedding` | nested | 图片向量(嵌套,仅用于搜索) |
> 所有租户共享统一的索引结构。文本字段支持中英文双语,后端根据 `language` 参数自动选择对应字段返回。
|
4a677843
tangwang
文档完善
|
918
919
920
|
---
|
b73baf85
tangwang
撰写接口文档
|
921
922
923
924
|
## 附录
### 常用字段列表
|
f7d3cf70
tangwang
更新文档
|
925
|
#### 过滤字段
|
b73baf85
tangwang
撰写接口文档
|
926
|
|
f7d3cf70
tangwang
更新文档
|
927
928
929
930
931
932
|
- `category_name`: 类目名称
- `category1_name`, `category2_name`, `category3_name`: 多级类目
- `category_id`: 类目ID
- `vendor_zh.keyword`, `vendor_en.keyword`: 供应商/品牌(使用keyword子字段)
- `tags`: 标签(keyword类型)
- `option1_name`, `option2_name`, `option3_name`: 选项名称
|
b73baf85
tangwang
撰写接口文档
|
933
934
935
936
937
938
939
940
941
942
943
944
945
|
#### 范围字段
- `min_price`: 最低价格
- `max_price`: 最高价格
- `compare_at_price`: 原价
- `create_time`: 创建时间
- `update_time`: 更新时间
#### 排序字段
- `min_price`: 最低价格
- `max_price`: 最高价格
|
b73baf85
tangwang
撰写接口文档
|
946
947
948
949
|
- `create_time`: 创建时间
- `update_time`: 更新时间
- `relevance_score`: 相关性分数(默认)
|
4a677843
tangwang
文档完善
|
950
951
952
953
|
### 支持的分析器
| 分析器 | 语言 | 描述 |
|--------|------|------|
|
f7d3cf70
tangwang
更新文档
|
954
955
956
957
|
| `hanlp_index` | 中文 | 中文索引分析器(用于中文字段) |
| `hanlp_standard` | 中文 | 中文查询分析器(用于中文字段) |
| `english` | 英文 | 标准英文分析器(用于英文字段) |
| `lowercase` | - | 小写标准化器(用于keyword子字段) |
|
4a677843
tangwang
文档完善
|
958
959
960
961
962
|
### 字段类型速查
| 类型 | ES Mapping | 用途 |
|------|------------|------|
|
f7d3cf70
tangwang
更新文档
|
963
964
965
966
967
968
969
970
|
| `text` | `text` | 全文检索(支持中英文分析器) |
| `keyword` | `keyword` | 精确匹配、聚合、排序 |
| `integer` | `integer` | 整数 |
| `long` | `long` | 长整数 |
| `float` | `float` | 浮点数 |
| `date` | `date` | 日期时间 |
| `nested` | `nested` | 嵌套对象(specifications, skus, image_embedding) |
| `dense_vector` | `dense_vector` | 向量字段(title_embedding,仅用于搜索) |
|
4a677843
tangwang
文档完善
|
|
|