Blame view

docs/搜索API速查表.md 5.43 KB
6aa246be   tangwang   问题:Pydantic 应该能自动...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
  # API 快速参考 (v3.0)
  
  ## 基础搜索
  
  ```bash
  POST /search/
  {
    "query": "芭比娃娃",
    "size": 20
  }
  ```
  
  ---
  
  ## 精确匹配过滤
  
  ```bash
  {
    "filters": {
f7d3cf70   tangwang   更新文档
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
      "category_name": "手机",                    // 单值
      "category1_name": "服装",                  // 一级类目
      "vendor_zh.keyword": ["奇乐", "品牌A"],    // 多值(OR)
      "tags": "手机",                             // 标签
      // specifications 嵌套过滤
      "specifications": {
        "name": "color",
        "value": "white"
      }
    }
  }
  ```
  
  ### Specifications 过滤
  
  **单个规格**:
  ```bash
  {
    "filters": {
      "specifications": {"name": "color", "value": "white"}
    }
  }
  ```
  
  **多个规格(OR)**:
  ```bash
  {
    "filters": {
      "specifications": [
        {"name": "color", "value": "white"},
        {"name": "size", "value": "256GB"}
      ]
6aa246be   tangwang   问题:Pydantic 应该能自动...
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
    }
  }
  ```
  
  ---
  
  ## 范围过滤
  
  ```bash
  {
    "range_filters": {
      "price": {
        "gte": 50,    // >=
        "lte": 200    // <=
      }
    }
  }
  ```
  
  **操作符**: `gte` (>=), `gt` (>), `lte` (<=), `lt` (<)
  
  ---
  
  ## 分面搜索
  
  ### 简单模式
  
  ```bash
  {
f7d3cf70   tangwang   更新文档
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
    "facets": ["category1_name", "category2_name", "category3_name", "specifications"]
  }
  ```
  
  ### Specifications 分面
  
  **所有规格名称**:
  ```bash
  {
    "facets": ["specifications"]  // 返回所有name及其value列表
  }
  ```
  
  **指定规格名称**:
  ```bash
  {
    "facets": ["specifications.color", "specifications.size"]  // 只返回指定name的value列表
6aa246be   tangwang   问题:Pydantic 应该能自动...
98
99
100
101
102
103
104
105
  }
  ```
  
  ### 高级模式
  
  ```bash
  {
    "facets": [
f7d3cf70   tangwang   更新文档
106
      {"field": "category1_name", "size": 15},
6aa246be   tangwang   问题:Pydantic 应该能自动...
107
      {
f7d3cf70   tangwang   更新文档
108
        "field": "min_price",
6aa246be   tangwang   问题:Pydantic 应该能自动...
109
110
111
112
113
        "type": "range",
        "ranges": [
          {"key": "0-50", "to": 50},
          {"key": "50-100", "from": 50, "to": 100}
        ]
f7d3cf70   tangwang   更新文档
114
115
116
117
      },
      "specifications",              // 所有规格名称
      "specifications.color",         // 指定规格名称
      "specifications.size"
6aa246be   tangwang   问题:Pydantic 应该能自动...
118
119
120
121
122
123
124
125
126
127
    ]
  }
  ```
  
  ---
  
  ## 排序
  
  ```bash
  {
cd3799c6   tangwang   tenant2 1w测试数据 mo...
128
    "sort_by": "min_price",
6aa246be   tangwang   问题:Pydantic 应该能自动...
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
    "sort_order": "asc"    // asc 或 desc
  }
  ```
  
  ---
  
  ## 布尔表达式
  
  ```bash
  {
    "query": "玩具 AND (乐高 OR 芭比) ANDNOT 电动"
  }
  ```
  
  **操作符优先级**: `()` > `ANDNOT` > `AND` > `OR` > `RANK`
  
  ---
  
  ## 分页
  
  ```bash
  {
    "size": 20,      // 每页数量
    "from": 0        // 偏移量(第1页=0,第2页=20)
  }
  ```
  
  ---
  
  ## 完整示例
  
  ```bash
  POST /search/
f7d3cf70   tangwang   更新文档
162
  Headers: X-Tenant-ID: 2
6aa246be   tangwang   问题:Pydantic 应该能自动...
163
  {
f7d3cf70   tangwang   更新文档
164
    "query": "手机",
6aa246be   tangwang   问题:Pydantic 应该能自动...
165
166
    "size": 20,
    "from": 0,
f7d3cf70   tangwang   更新文档
167
    "language": "zh",
6aa246be   tangwang   问题:Pydantic 应该能自动...
168
    "filters": {
f7d3cf70   tangwang   更新文档
169
170
171
      "category_name": "手机",
      "category1_name": "电子产品",
      "specifications": {"name": "color", "value": "white"}
6aa246be   tangwang   问题:Pydantic 应该能自动...
172
173
    },
    "range_filters": {
f7d3cf70   tangwang   更新文档
174
      "min_price": {"gte": 50, "lte": 200}
6aa246be   tangwang   问题:Pydantic 应该能自动...
175
176
    },
    "facets": [
f7d3cf70   tangwang   更新文档
177
178
179
180
      {"field": "category1_name", "size": 15},
      {"field": "category2_name", "size": 15},
      "specifications.color",
      "specifications.size"
6aa246be   tangwang   问题:Pydantic 应该能自动...
181
    ],
cd3799c6   tangwang   tenant2 1w测试数据 mo...
182
    "sort_by": "min_price",
6aa246be   tangwang   问题:Pydantic 应该能自动...
183
184
185
186
187
188
189
190
191
192
    "sort_order": "asc"
  }
  ```
  
  ---
  
  ## 响应格式
  
  ```json
  {
f7d3cf70   tangwang   更新文档
193
    "results": [
6aa246be   tangwang   问题:Pydantic 应该能自动...
194
      {
f7d3cf70   tangwang   更新文档
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
        "spu_id": "12345",
        "title": "商品标题",
        "brief": "短描述",
        "description": "详细描述",
        "vendor": "供应商",
        "category": "类目",
        "category_path": "类目/路径",
        "category_name": "类目名称",
        "category1_name": "一级类目",
        "category2_name": "二级类目",
        "category3_name": "三级类目",
        "tags": ["标签1", "标签2"],
        "price": 99.99,
        "compare_at_price": 149.99,
        "sku_prices": [99.99, 109.99],
        "total_inventory": 500,
        "specifications": [
          {"sku_id": "sku_001", "name": "color", "value": "white"}
        ],
        "skus": [...],
        "relevance_score": 8.5
6aa246be   tangwang   问题:Pydantic 应该能自动...
216
217
218
219
220
221
222
      }
    ],
    "total": 118,
    "max_score": 8.5,
    "took_ms": 45,
    "facets": [
      {
f7d3cf70   tangwang   更新文档
223
224
        "field": "category1_name",
        "label": "category1_name",
6aa246be   tangwang   问题:Pydantic 应该能自动...
225
226
227
        "type": "terms",
        "values": [
          {
f7d3cf70   tangwang   更新文档
228
229
            "value": "手机",
            "label": "手机",
6aa246be   tangwang   问题:Pydantic 应该能自动...
230
231
232
233
            "count": 85,
            "selected": false
          }
        ]
f7d3cf70   tangwang   更新文档
234
235
236
237
238
239
240
241
242
243
244
245
246
      },
      {
        "field": "specifications.color",
        "label": "color",
        "type": "terms",
        "values": [
          {
            "value": "white",
            "label": "white",
            "count": 30,
            "selected": false
          }
        ]
6aa246be   tangwang   问题:Pydantic 应该能自动...
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
      }
    ]
  }
  ```
  
  ---
  
  ## 其他端点
  
  ```bash
  POST /search/image
  {
    "image_url": "https://example.com/image.jpg",
    "size": 20
  }
  
  GET /search/suggestions?q=芭&size=5
  
  GET /search/instant?q=玩具&size=5
  
  GET /search/{doc_id}
  
  GET /admin/health
  GET /admin/config
  GET /admin/stats
  ```
  
  ---
  
  ## Python 快速示例
  
  ```python
  import requests
  
f7d3cf70   tangwang   更新文档
281
282
283
284
285
286
287
288
289
290
291
292
293
  result = requests.post(
      'http://localhost:6002/search/',
      headers={'X-Tenant-ID': '2'},
      json={
          "query": "手机",
          "language": "zh",
          "filters": {"category_name": "手机"},
          "range_filters": {"min_price": {"gte": 50, "lte": 200}},
          "facets": ["category1_name", "specifications"],
          "sort_by": "min_price",
          "sort_order": "asc"
      }
  ).json()
6aa246be   tangwang   问题:Pydantic 应该能自动...
294
295
296
297
298
299
300
301
302
303
304
  
  print(f"找到 {result['total']} 个结果")
  ```
  
  ---
  
  ## JavaScript 快速示例
  
  ```javascript
  const result = await fetch('http://localhost:6002/search/', {
      method: 'POST',
f7d3cf70   tangwang   更新文档
305
306
307
308
      headers: {
          'Content-Type': 'application/json',
          'X-Tenant-ID': '2'
      },
6aa246be   tangwang   问题:Pydantic 应该能自动...
309
      body: JSON.stringify({
f7d3cf70   tangwang   更新文档
310
311
312
313
314
          query: "手机",
          language: "zh",
          filters: {category_name: "手机"},
          range_filters: {min_price: {gte: 50, lte: 200}},
          facets: ["category1_name", "specifications"],
cd3799c6   tangwang   tenant2 1w测试数据 mo...
315
          sort_by: "min_price",
6aa246be   tangwang   问题:Pydantic 应该能自动...
316
317
318
319
320
321
322
323
          sort_order: "asc"
      })
  }).then(r => r.json());
  
  console.log(`找到 ${result.total} 个结果`);
  ```
  
  ---