be52af70
tangwang
first commit
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
"""
Configuration loader and validator for customer-specific search configurations.
This module handles loading, parsing, and validating YAML configuration files
that define how each customer's data should be indexed and searched.
"""
import yaml
import os
from typing import Dict, Any, List, Optional
from dataclasses import dataclass, field
from pathlib import Path
from .field_types import (
FieldConfig, FieldType, AnalyzerType,
FIELD_TYPE_MAP, ANALYZER_MAP
)
@dataclass
class IndexConfig:
"""Configuration for an index domain (e.g., default, title, brand)."""
name: str
label: str
fields: List[str] # List of field names to include
analyzer: AnalyzerType
boost: float = 1.0
example: Optional[str] = None
|
b926f678
tangwang
多语言查询
|
30
31
32
|
# Multi-language field mapping: {"zh": ["name"], "en": ["enSpuName"], "ru": ["ruSkuName"]}
language_field_mapping: Optional[Dict[str, List[str]]] = None
|
be52af70
tangwang
first commit
|
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
@dataclass
class RankingConfig:
"""Configuration for ranking expressions."""
expression: str # e.g., "bm25() + 0.2*text_embedding_relevance()"
description: str
@dataclass
class QueryConfig:
"""Configuration for query processing."""
supported_languages: List[str] = field(default_factory=lambda: ["zh", "en"])
default_language: str = "zh"
enable_translation: bool = True
enable_text_embedding: bool = True
enable_query_rewrite: bool = True
rewrite_dictionary: Dict[str, str] = field(default_factory=dict)
# Translation API settings
translation_api_key: Optional[str] = None
translation_service: str = "deepl" # deepl, google, etc.
|
13377199
tangwang
接口优化
|
55
56
57
58
59
60
61
|
# ES source fields configuration - fields to return in search results
source_fields: List[str] = field(default_factory=lambda: [
"id", "spuId", "skuNo", "spuNo", "title", "enSpuName", "brandId",
"brandName", "enBrandName", "categoryId", "categoryName", "enCategoryName",
"price", "originalPrice", "currency", "image", "status", "createdAt", "updatedAt"
])
|
be52af70
tangwang
first commit
|
62
63
64
65
66
67
68
69
70
71
|
@dataclass
class SPUConfig:
"""Configuration for SPU aggregation."""
enabled: bool = False
spu_field: Optional[str] = None # Field containing SPU ID
inner_hits_size: int = 3
@dataclass
|
a00c3672
tangwang
feat: Function Sc...
|
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
class FunctionScoreConfig:
"""Function Score配置(ES层打分规则)"""
score_mode: str = "sum" # multiply, sum, avg, first, max, min
boost_mode: str = "multiply" # multiply, replace, sum, avg, max, min
functions: List[Dict[str, Any]] = field(default_factory=list)
@dataclass
class RerankConfig:
"""本地重排配置(当前禁用)"""
enabled: bool = False
expression: str = ""
description: str = ""
@dataclass
|
be52af70
tangwang
first commit
|
88
89
90
91
92
93
94
|
class CustomerConfig:
"""Complete configuration for a customer."""
customer_id: str
customer_name: str
# Database settings
mysql_config: Dict[str, Any]
|
be52af70
tangwang
first commit
|
95
96
97
98
99
100
101
102
103
104
105
106
107
|
# Field definitions
fields: List[FieldConfig]
# Index structure (query domains)
indexes: List[IndexConfig]
# Query processing
query_config: QueryConfig
# Ranking configuration
ranking: RankingConfig
|
a00c3672
tangwang
feat: Function Sc...
|
108
109
110
111
112
113
|
# Function Score configuration (ES层打分)
function_score: FunctionScoreConfig
# Rerank configuration (本地重排)
rerank: RerankConfig
|
be52af70
tangwang
first commit
|
114
115
116
117
118
|
# SPU configuration
spu_config: SPUConfig
# ES index settings
es_index_name: str
|
b926f678
tangwang
多语言查询
|
119
120
121
122
|
# Optional fields with defaults
main_table: str = "shoplazza_product_sku"
extension_table: Optional[str] = None
|
be52af70
tangwang
first commit
|
123
124
125
126
127
128
129
130
131
132
133
134
135
|
es_settings: Dict[str, Any] = field(default_factory=dict)
class ConfigurationError(Exception):
"""Raised when configuration validation fails."""
pass
class ConfigLoader:
"""Loads and validates customer configurations from YAML files."""
def __init__(self, config_dir: str = "config/schema"):
self.config_dir = Path(config_dir)
|
a77693fe
tangwang
调整配置目录结构
|
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
162
163
164
165
166
167
168
169
170
171
172
173
174
|
def _load_rewrite_dictionary(self, customer_id: str) -> Dict[str, str]:
"""
Load query rewrite dictionary from external file.
Args:
customer_id: Customer identifier
Returns:
Dictionary mapping query terms to rewritten queries
"""
dict_file = self.config_dir / customer_id / "query_rewrite.dict"
if not dict_file.exists():
# Dictionary file is optional, return empty dict if not found
return {}
rewrite_dict = {}
try:
with open(dict_file, 'r', encoding='utf-8') as f:
for line_num, line in enumerate(f, 1):
line = line.strip()
# Skip empty lines and comments
if not line or line.startswith('#'):
continue
# Parse tab-separated format
parts = line.split('\t')
if len(parts) != 2:
print(f"Warning: Invalid format in {dict_file} line {line_num}: {line}")
continue
key, value = parts
rewrite_dict[key.strip()] = value.strip()
except Exception as e:
print(f"Error loading rewrite dictionary from {dict_file}: {e}")
return {}
return rewrite_dict
|
be52af70
tangwang
first commit
|
175
176
177
178
|
def load_customer_config(self, customer_id: str) -> CustomerConfig:
"""
Load customer configuration from YAML file.
|
a77693fe
tangwang
调整配置目录结构
|
179
180
181
182
|
Supports two directory structures:
1. New structure: config/schema/{customer_id}/config.yaml
2. Old structure: config/schema/{customer_id}_config.yaml (for backward compatibility)
|
be52af70
tangwang
first commit
|
183
184
185
186
187
188
189
190
191
192
|
Args:
customer_id: Customer identifier (used to find config file)
Returns:
CustomerConfig object
Raises:
ConfigurationError: If config file not found or invalid
"""
|
a77693fe
tangwang
调整配置目录结构
|
193
194
195
196
197
198
199
|
# Try new directory structure first
config_file = self.config_dir / customer_id / "config.yaml"
# Fall back to old structure if new one doesn't exist
if not config_file.exists():
config_file = self.config_dir / f"{customer_id}_config.yaml"
|
be52af70
tangwang
first commit
|
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
if not config_file.exists():
raise ConfigurationError(f"Configuration file not found: {config_file}")
try:
with open(config_file, 'r', encoding='utf-8') as f:
config_data = yaml.safe_load(f)
except yaml.YAMLError as e:
raise ConfigurationError(f"Invalid YAML in {config_file}: {e}")
return self._parse_config(config_data, customer_id)
def _parse_config(self, config_data: Dict[str, Any], customer_id: str) -> CustomerConfig:
"""Parse configuration dictionary into CustomerConfig object."""
# Parse fields
fields = []
for field_data in config_data.get("fields", []):
fields.append(self._parse_field_config(field_data))
# Parse indexes
indexes = []
for index_data in config_data.get("indexes", []):
indexes.append(self._parse_index_config(index_data))
# Parse query config
query_config_data = config_data.get("query_config", {})
|
a77693fe
tangwang
调整配置目录结构
|
226
227
228
229
|
# Load rewrite dictionary from external file instead of config
rewrite_dictionary = self._load_rewrite_dictionary(customer_id)
|
be52af70
tangwang
first commit
|
230
231
232
233
234
235
|
query_config = QueryConfig(
supported_languages=query_config_data.get("supported_languages", ["zh", "en"]),
default_language=query_config_data.get("default_language", "zh"),
enable_translation=query_config_data.get("enable_translation", True),
enable_text_embedding=query_config_data.get("enable_text_embedding", True),
enable_query_rewrite=query_config_data.get("enable_query_rewrite", True),
|
a77693fe
tangwang
调整配置目录结构
|
236
|
rewrite_dictionary=rewrite_dictionary,
|
be52af70
tangwang
first commit
|
237
238
239
240
241
242
243
244
245
246
247
|
translation_api_key=query_config_data.get("translation_api_key"),
translation_service=query_config_data.get("translation_service", "deepl")
)
# Parse ranking config
ranking_data = config_data.get("ranking", {})
ranking = RankingConfig(
expression=ranking_data.get("expression", "bm25() + 0.2*text_embedding_relevance()"),
description=ranking_data.get("description", "Default BM25 + text embedding ranking")
)
|
a00c3672
tangwang
feat: Function Sc...
|
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
# Parse Function Score configuration
fs_data = config_data.get("function_score", {})
function_score = FunctionScoreConfig(
score_mode=fs_data.get("score_mode", "sum"),
boost_mode=fs_data.get("boost_mode", "multiply"),
functions=fs_data.get("functions", [])
)
# Parse Rerank configuration
rerank_data = config_data.get("rerank", {})
rerank = RerankConfig(
enabled=rerank_data.get("enabled", False),
expression=rerank_data.get("expression", ""),
description=rerank_data.get("description", "")
)
|
be52af70
tangwang
first commit
|
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
# Parse SPU config
spu_data = config_data.get("spu_config", {})
spu_config = SPUConfig(
enabled=spu_data.get("enabled", False),
spu_field=spu_data.get("spu_field"),
inner_hits_size=spu_data.get("inner_hits_size", 3)
)
return CustomerConfig(
customer_id=customer_id,
customer_name=config_data.get("customer_name", customer_id),
mysql_config=config_data.get("mysql_config", {}),
main_table=config_data.get("main_table", "shoplazza_product_sku"),
extension_table=config_data.get("extension_table"),
fields=fields,
indexes=indexes,
query_config=query_config,
ranking=ranking,
|
a00c3672
tangwang
feat: Function Sc...
|
282
283
|
function_score=function_score,
rerank=rerank,
|
be52af70
tangwang
first commit
|
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
|
spu_config=spu_config,
es_index_name=config_data.get("es_index_name", f"search_{customer_id}"),
es_settings=config_data.get("es_settings", {})
)
def _parse_field_config(self, field_data: Dict[str, Any]) -> FieldConfig:
"""Parse field configuration from dictionary."""
name = field_data["name"]
field_type_str = field_data["type"]
# Map field type string to enum
if field_type_str not in FIELD_TYPE_MAP:
raise ConfigurationError(f"Unknown field type: {field_type_str}")
field_type = FIELD_TYPE_MAP[field_type_str]
# Map analyzer string to enum (if provided)
analyzer = None
analyzer_str = field_data.get("analyzer")
if analyzer_str and analyzer_str in ANALYZER_MAP:
analyzer = ANALYZER_MAP[analyzer_str]
search_analyzer = None
search_analyzer_str = field_data.get("search_analyzer")
if search_analyzer_str and search_analyzer_str in ANALYZER_MAP:
search_analyzer = ANALYZER_MAP[search_analyzer_str]
return FieldConfig(
name=name,
field_type=field_type,
source_table=field_data.get("source_table"),
source_column=field_data.get("source_column", name),
analyzer=analyzer,
search_analyzer=search_analyzer,
required=field_data.get("required", False),
multi_language=field_data.get("multi_language", False),
languages=field_data.get("languages"),
boost=field_data.get("boost", 1.0),
store=field_data.get("store", False),
index=field_data.get("index", True),
embedding_dims=field_data.get("embedding_dims", 1024),
embedding_similarity=field_data.get("embedding_similarity", "dot_product"),
nested=field_data.get("nested", False),
nested_properties=field_data.get("nested_properties")
)
def _parse_index_config(self, index_data: Dict[str, Any]) -> IndexConfig:
"""Parse index configuration from dictionary."""
analyzer_str = index_data.get("analyzer", "chinese_ecommerce")
if analyzer_str not in ANALYZER_MAP:
raise ConfigurationError(f"Unknown analyzer: {analyzer_str}")
|
b926f678
tangwang
多语言查询
|
335
336
337
|
# Parse language field mapping if present
language_field_mapping = index_data.get("language_field_mapping")
|
be52af70
tangwang
first commit
|
338
339
340
341
342
343
|
return IndexConfig(
name=index_data["name"],
label=index_data.get("label", index_data["name"]),
fields=index_data["fields"],
analyzer=ANALYZER_MAP[analyzer_str],
boost=index_data.get("boost", 1.0),
|
b926f678
tangwang
多语言查询
|
344
345
|
example=index_data.get("example"),
language_field_mapping=language_field_mapping
|
be52af70
tangwang
first commit
|
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
)
def validate_config(self, config: CustomerConfig) -> List[str]:
"""
Validate customer configuration.
Args:
config: Customer configuration to validate
Returns:
List of validation error messages (empty if valid)
"""
errors = []
# Validate field references in indexes
field_names = {field.name for field in config.fields}
|
b926f678
tangwang
多语言查询
|
362
363
|
field_map = {field.name: field for field in config.fields}
|
be52af70
tangwang
first commit
|
364
|
for index in config.indexes:
|
b926f678
tangwang
多语言查询
|
365
|
# Validate fields in index.fields
|
be52af70
tangwang
first commit
|
366
367
368
|
for field_name in index.fields:
if field_name not in field_names:
errors.append(f"Index '{index.name}' references unknown field '{field_name}'")
|
b926f678
tangwang
多语言查询
|
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
# Validate language_field_mapping if present
if index.language_field_mapping:
for lang, field_list in index.language_field_mapping.items():
if not isinstance(field_list, list):
errors.append(f"Index '{index.name}': language_field_mapping['{lang}'] must be a list")
continue
for field_name in field_list:
# Check if field exists
if field_name not in field_names:
errors.append(
f"Index '{index.name}': language_field_mapping['{lang}'] "
f"references unknown field '{field_name}'"
)
else:
# Check if field is TEXT type (multi-language fields should be text fields)
field = field_map[field_name]
if field.field_type != FieldType.TEXT:
errors.append(
f"Index '{index.name}': language_field_mapping['{lang}'] "
f"field '{field_name}' must be of type TEXT, got {field.field_type.value}"
)
# Verify analyzer is appropriate for the language
# This is a soft check - we just warn if analyzer doesn't match language
if field.analyzer:
analyzer_name = field.analyzer.value.lower()
expected_analyzers = {
'zh': ['chinese', 'index_ansj', 'query_ansj'],
'en': ['english'],
'ru': ['russian'],
'ar': ['arabic'],
'es': ['spanish'],
'ja': ['japanese']
}
if lang in expected_analyzers:
expected = expected_analyzers[lang]
if not any(exp in analyzer_name for exp in expected):
# Warning only, not an error
print(
f"Warning: Index '{index.name}': field '{field_name}' for language '{lang}' "
f"uses analyzer '{analyzer_name}', which may not be optimal for '{lang}'"
)
|
be52af70
tangwang
first commit
|
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
# Validate SPU config
if config.spu_config.enabled:
if not config.spu_config.spu_field:
errors.append("SPU aggregation enabled but no spu_field specified")
elif config.spu_config.spu_field not in field_names:
errors.append(f"SPU field '{config.spu_config.spu_field}' not found in fields")
# Validate embedding fields have proper configuration
for field in config.fields:
if field.field_type in [FieldType.TEXT_EMBEDDING, FieldType.IMAGE_EMBEDDING]:
if field.embedding_dims <= 0:
errors.append(f"Field '{field.name}': embedding_dims must be positive")
if field.embedding_similarity not in ["dot_product", "cosine", "l2_norm"]:
errors.append(f"Field '{field.name}': invalid embedding_similarity")
# Validate MySQL config
if "host" not in config.mysql_config:
errors.append("MySQL configuration missing 'host'")
if "username" not in config.mysql_config:
errors.append("MySQL configuration missing 'username'")
if "password" not in config.mysql_config:
errors.append("MySQL configuration missing 'password'")
if "database" not in config.mysql_config:
errors.append("MySQL configuration missing 'database'")
return errors
def save_config(self, config: CustomerConfig, output_path: Optional[str] = None) -> None:
"""
Save customer configuration to YAML file.
|
a77693fe
tangwang
调整配置目录结构
|
444
445
|
Note: rewrite_dictionary is saved separately to query_rewrite.dict file
|
be52af70
tangwang
first commit
|
446
447
448
|
Args:
config: Configuration to save
|
a77693fe
tangwang
调整配置目录结构
|
449
|
output_path: Optional output path (defaults to new directory structure)
|
be52af70
tangwang
first commit
|
450
451
|
"""
if output_path is None:
|
a77693fe
tangwang
调整配置目录结构
|
452
453
454
455
|
# Use new directory structure by default
customer_dir = self.config_dir / config.customer_id
customer_dir.mkdir(parents=True, exist_ok=True)
output_path = customer_dir / "config.yaml"
|
be52af70
tangwang
first commit
|
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
# Convert config back to dictionary format
config_dict = {
"customer_name": config.customer_name,
"mysql_config": config.mysql_config,
"main_table": config.main_table,
"extension_table": config.extension_table,
"es_index_name": config.es_index_name,
"es_settings": config.es_settings,
"fields": [self._field_to_dict(field) for field in config.fields],
"indexes": [self._index_to_dict(index) for index in config.indexes],
"query_config": {
"supported_languages": config.query_config.supported_languages,
"default_language": config.query_config.default_language,
"enable_translation": config.query_config.enable_translation,
"enable_text_embedding": config.query_config.enable_text_embedding,
"enable_query_rewrite": config.query_config.enable_query_rewrite,
|
a77693fe
tangwang
调整配置目录结构
|
473
|
# rewrite_dictionary is stored in separate file, not in config
|
be52af70
tangwang
first commit
|
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
"translation_api_key": config.query_config.translation_api_key,
"translation_service": config.query_config.translation_service,
},
"ranking": {
"expression": config.ranking.expression,
"description": config.ranking.description
},
"spu_config": {
"enabled": config.spu_config.enabled,
"spu_field": config.spu_config.spu_field,
"inner_hits_size": config.spu_config.inner_hits_size
}
}
with open(output_path, 'w', encoding='utf-8') as f:
yaml.dump(config_dict, f, default_flow_style=False, allow_unicode=True)
|
a77693fe
tangwang
调整配置目录结构
|
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
|
# Save rewrite dictionary to separate file
self._save_rewrite_dictionary(config.customer_id, config.query_config.rewrite_dictionary)
def _save_rewrite_dictionary(self, customer_id: str, rewrite_dict: Dict[str, str]) -> None:
"""
Save rewrite dictionary to external file.
Args:
customer_id: Customer identifier
rewrite_dict: Dictionary to save
"""
customer_dir = self.config_dir / customer_id
customer_dir.mkdir(parents=True, exist_ok=True)
dict_file = customer_dir / "query_rewrite.dict"
with open(dict_file, 'w', encoding='utf-8') as f:
for key, value in rewrite_dict.items():
f.write(f"{key}\t{value}\n")
|
be52af70
tangwang
first commit
|
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
|
def _field_to_dict(self, field: FieldConfig) -> Dict[str, Any]:
"""Convert FieldConfig to dictionary."""
result = {
"name": field.name,
"type": field.field_type.value,
"source_table": field.source_table,
"source_column": field.source_column,
"required": field.required,
"boost": field.boost,
"store": field.store,
"index": field.index,
}
if field.analyzer:
result["analyzer"] = field.analyzer.value
if field.search_analyzer:
result["search_analyzer"] = field.search_analyzer.value
if field.multi_language:
result["multi_language"] = field.multi_language
result["languages"] = field.languages
if field.embedding_dims != 1024:
result["embedding_dims"] = field.embedding_dims
if field.embedding_similarity != "dot_product":
result["embedding_similarity"] = field.embedding_similarity
if field.nested:
result["nested"] = field.nested
result["nested_properties"] = field.nested_properties
return result
def _index_to_dict(self, index: IndexConfig) -> Dict[str, Any]:
"""Convert IndexConfig to dictionary."""
|
b926f678
tangwang
多语言查询
|
542
|
result = {
|
be52af70
tangwang
first commit
|
543
544
545
546
547
548
|
"name": index.name,
"label": index.label,
"fields": index.fields,
"analyzer": index.analyzer.value,
"boost": index.boost,
"example": index.example
|
b926f678
tangwang
多语言查询
|
549
550
551
552
553
554
|
}
if index.language_field_mapping:
result["language_field_mapping"] = index.language_field_mapping
return result
|