From ddc4abd12d7ea853fb51daa584f785542398be4f Mon Sep 17 00:00:00 2001 From: tangwang Date: Fri, 14 Nov 2025 17:15:59 +0800 Subject: [PATCH] 文档完善 --- docs/索引字段说明.md | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------------------------------------------ 1 file changed, 56 insertions(+), 54 deletions(-) diff --git a/docs/索引字段说明.md b/docs/索引字段说明.md index d9840cb..2f2ab35 100644 --- a/docs/索引字段说明.md +++ b/docs/索引字段说明.md @@ -128,48 +128,50 @@ ### 基础字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|------| -| tenant_id | KEYWORD | 是 | 精确匹配 | SPU表 | tenant_id | BIGINT | 租户ID，用于多租户隔离 | -| product_id | KEYWORD | 是 | 精确匹配 | SPU表 | id | BIGINT | 商品ID（SPU ID） | -| handle | KEYWORD | 是 | 精确匹配 | SPU表 | handle | VARCHAR(255) | 商品URL handle | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-------------|------| +| tenant_id | KEYWORD | 是 | SPU表 | tenant_id | BIGINT | BIGINT转字符串 | 租户ID，用于多租户隔离 | +| product_id | KEYWORD | 是 | SPU表 | id | BIGINT | BIGINT转字符串 | 商品ID（SPU ID） | +| handle | KEYWORD | 是 | SPU表 | handle | VARCHAR(255) | | 商品URL handle | + +数据预处理列留空表示该字段无需额外处理。 ### 文本搜索字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | Boost权重 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|-----------|------| -| title | TEXT | 是 | english | SPU表 | title | VARCHAR(512) | 3.0 | 商品标题，权重最高 | -| brief | TEXT | 是 | english | SPU表 | brief | VARCHAR(512) | 1.5 | 商品简介 | -| description | TEXT | 是 | english | SPU表 | description | TEXT | 1.0 | 商品详细描述 | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | Boost权重 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-----------|-------------|------| +| title | TEXT | 是 | SPU表 | title | VARCHAR(512) | 3.0 | | 商品标题，权重最高 | +| brief | TEXT | 是 | SPU表 | brief | VARCHAR(512) | 1.5 | | 商品简介 | +| description | TEXT | 是 | SPU表 | description | TEXT | 1.0 | | 商品详细描述 | ### SEO字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | Boost权重 | 是否返回 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|-----------|---------|------| -| seo_title | TEXT | 是 | english | SPU表 | seo_title | VARCHAR(512) | 2.0 | 否 | SEO标题，用于提升相关性 | -| seo_description | TEXT | 是 | english | SPU表 | seo_description | TEXT | 1.5 | 否 | SEO描述 | -| seo_keywords | HKText | 是 | english（模糊）+keyword（精确） | SPU表 | seo_keywords | VARCHAR(1024) | 2.0 | 否 | SEO关键词，支持模糊匹配+精确过滤 | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | Boost权重 | 是否返回 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-----------|---------|-------------|------| +| seo_title | TEXT | 是 | SPU表 | seo_title | VARCHAR(512) | 2.0 | 否 | | SEO标题，用于提升相关性 | +| seo_description | TEXT | 是 | SPU表 | seo_description | TEXT | 1.5 | 否 | | SEO描述 | +| seo_keywords | HKText | 是 | SPU表 | seo_keywords | VARCHAR(1024) | 2.0 | 否 | 按逗号分割为list，去除空白项 | SEO关键词，支持模糊匹配+精确过滤 | ### 分类和标签字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | Boost权重 | 是否返回 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|-----------|---------|------| -| vendor | TEXT | 是 | english | SPU表 | vendor | VARCHAR(255) | 1.5 | 是 | 供应商/品牌（文本搜索） | -| vendor_keyword | HKText | 是 | 模糊+精确 | SPU表 | vendor | VARCHAR(255) | - | 否 | 供应商/品牌（HKText类型，keyword子字段用于过滤） | -| product_type | TEXT | 是 | english | SPU表 | category | VARCHAR(255) | 1.5 | 是 | 商品类型（文本搜索） | -| product_type_keyword | HKText | 是 | 模糊+精确 | SPU表 | category | VARCHAR(255) | - | 否 | 商品类型（HKText类型） | -| tags | HKText | 是 | 模糊+精确 | SPU表 | tags | VARCHAR(1024) | 1.0 | 是 | 标签（HKText类型，支持搜索+过滤） | -| tags_keyword | HKText | 是 | 模糊+精确 | SPU表 | tags | VARCHAR(1024) | - | 否 | 标签keyword别名（HKText类型） | -| category | TEXT | 是 | english | SPU表 | category | VARCHAR(255) | 1.5 | 是 | 类目（文本搜索） | -| category_keyword | HKText | 是 | 模糊+精确 | SPU表 | category | VARCHAR(255) | - | 否 | 类目（HKText类型） | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | Boost权重 | 是否返回 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-----------|---------|-------------|------| +| vendor | TEXT | 是 | SPU表 | vendor | VARCHAR(255) | 1.5 | 是 | | 供应商/品牌（文本搜索） | +| vendor_keyword | HKText | 是 | SPU表 | vendor | VARCHAR(255) | - | 否 | 按逗号分割为list，去除空白项 | 供应商/品牌（HKText类型，keyword子字段用于过滤） | +| product_type | TEXT | 是 | SPU表 | category | VARCHAR(255) | 1.5 | 是 | | 商品类型（文本搜索） | +| product_type_keyword | HKText | 是 | SPU表 | category | VARCHAR(255) | - | 否 | 按逗号分割为list，去除空白项 | 商品类型（HKText类型） | +| tags | HKText | 是 | SPU表 | tags | VARCHAR(1024) | 1.0 | 是 | | 标签（HKText类型，支持搜索+过滤） | +| tags_keyword | HKText | 是 | SPU表 | tags | VARCHAR(1024) | - | 否 | 按逗号分割为list，去除空白项 | 标签keyword别名（HKText类型） | +| category | TEXT | 是 | SPU表 | category | VARCHAR(255) | 1.5 | 是 | | 类目（文本搜索） | +| category_keyword | HKText | 是 | SPU表 | category | VARCHAR(255) | - | 否 | 按逗号分割为list，去除空白项 | 类目（HKText类型） | ### 价格字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|------| -| min_price | FLOAT | 是 | 数值范围 | SKU表（聚合计算） | price | DECIMAL(10,2) | 最低价格（从所有SKU中取最小值） | -| max_price | FLOAT | 是 | 数值范围 | SKU表（聚合计算） | price | DECIMAL(10,2) | 最高价格（从所有SKU中取最大值） | -| compare_at_price | FLOAT | 是 | 数值范围 | SKU表（聚合计算） | compare_at_price | DECIMAL(10,2) | 原价（从所有SKU中取最大值） | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-------------|------| +| min_price | FLOAT | 是 | SKU表（聚合计算） | price | DECIMAL(10,2) | 聚合所有SKU最小值并转FLOAT | 最低价格（从所有SKU中取最小值） | +| max_price | FLOAT | 是 | SKU表（聚合计算） | price | DECIMAL(10,2) | 聚合所有SKU最大值并转FLOAT | 最高价格（从所有SKU中取最大值） | +| compare_at_price | FLOAT | 是 | SKU表（聚合计算） | compare_at_price | DECIMAL(10,2) | 聚合所有SKU最大值并转FLOAT | 原价（从所有SKU中取最大值） | **价格计算逻辑**： - `min_price`: 取该SPU下所有SKU的price字段的最小值 @@ -178,15 +180,15 @@ ### 图片字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|------| -| image_url | KEYWORD | 否 | 不索引 | SPU表 | image_src | VARCHAR(500) | 商品主图URL，仅用于展示 | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-------------|------| +| image_url | KEYWORD | 否 | SPU表 | image_src | VARCHAR(500) | 补全协议/域名，确保绝对URL | 商品主图URL，仅用于展示 | ### 文本嵌入字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|------| -| title_embedding | TEXT_EMBEDDING | 是 | 向量相似度（dot_product） | 计算生成 | title | VARCHAR(512) | 标题的文本向量（1024维），用于语义搜索 | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-------------|------| +| title_embedding | TEXT_EMBEDDING | 是 | 计算生成 | title | VARCHAR(512) | BGE-M3模型生成1024维向量 | 标题的文本向量（1024维），用于语义搜索 | **说明**： - 向量维度：1024 @@ -195,30 +197,30 @@ ### 时间字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | 是否返回 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|---------|------| -| create_time | DATE | 是 | 日期范围 | SPU表 | create_time | DATETIME | 是 | 创建时间 | -| update_time | DATE | 是 | 日期范围 | SPU表 | update_time | DATETIME | 是 | 更新时间 | -| shoplazza_created_at | DATE | 是 | 日期范围 | SPU表 | shoplazza_created_at | DATETIME | 否 | 店匠系统创建时间 | -| shoplazza_updated_at | DATE | 是 | 日期范围 | SPU表 | shoplazza_updated_at | DATETIME | 否 | 店匠系统更新时间 | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | 是否返回 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|---------|-------------|------| +| create_time | DATE | 是 | SPU表 | create_time | DATETIME | 是 | 转换为UTC ISO8601字符串 | 创建时间 | +| update_time | DATE | 是 | SPU表 | update_time | DATETIME | 是 | 转换为UTC ISO8601字符串 | 更新时间 | +| shoplazza_created_at | DATE | 是 | SPU表 | shoplazza_created_at | DATETIME | 否 | 转换为UTC ISO8601字符串 | 店匠系统创建时间 | +| shoplazza_updated_at | DATE | 是 | SPU表 | shoplazza_updated_at | DATETIME | 否 | 转换为UTC ISO8601字符串 | 店匠系统更新时间 | ### 嵌套Variants字段（SKU级别） -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|------| -| variants | JSON (nested) | 是 | 嵌套对象 | SKU表 | - | - | 商品变体数组（嵌套结构） | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-------------|------| +| variants | JSON (nested) | 是 | SKU表 | - | - | 汇总同SPU下SKU记录，构建nested数组 | 商品变体数组（嵌套结构） | #### Variants子字段 -| 索引字段名 | ES字段类型 | 是否索引 | 索引方式 | 数据来源表 | 表中字段名 | 表中字段类型 | 说明 | -|-----------|-----------|---------|---------|-----------|-----------|-------------|------| -| variants.variant_id | keyword | 是 | 精确匹配 | SKU表 | id | BIGINT | 变体ID（SKU ID） | -| variants.title | text | 是 | english | SKU表 | title | VARCHAR(500) | 变体标题 | -| variants.price | float | 是 | 数值范围 | SKU表 | price | DECIMAL(10,2) | 变体价格 | -| variants.compare_at_price | float | 是 | 数值范围 | SKU表 | compare_at_price | DECIMAL(10,2) | 变体原价 | -| variants.sku | keyword | 是 | 精确匹配 | SKU表 | sku | VARCHAR(100) | SKU编码 | -| variants.stock | long | 是 | 数值范围 | SKU表 | inventory_quantity | INT(11) | 库存数量 | -| variants.options | object | 是 | 对象 | SKU表 | option1/option2/option3 | VARCHAR(255) | 选项（颜色、尺寸等） | +| 索引字段名 | ES字段类型 | 是否索引 | 数据来源表 | 表中字段名 | 表中字段类型 | 数据预处理 | 说明 | +|-----------|-----------|---------|-----------|-----------|-------------|-------------|------| +| variants.variant_id | keyword | 是 | SKU表 | id | BIGINT | BIGINT转字符串 | 变体ID（SKU ID） | +| variants.title | text | 是 | SKU表 | title | VARCHAR(500) | | 变体标题 | +| variants.price | float | 是 | SKU表 | price | DECIMAL(10,2) | DECIMAL转FLOAT | 变体价格 | +| variants.compare_at_price | float | 是 | SKU表 | compare_at_price | DECIMAL(10,2) | DECIMAL转FLOAT | 变体原价 | +| variants.sku | keyword | 是 | SKU表 | sku | VARCHAR(100) | | SKU编码 | +| variants.stock | long | 是 | SKU表 | inventory_quantity | INT(11) | INT转LONG | 库存数量 | +| variants.options | object | 是 | SKU表 | option1/option2/option3 | VARCHAR(255) | 合并option1/2/3并去除空值 | 选项（颜色、尺寸等） | **Variants结构说明**： - `variants` 是一个嵌套对象数组，每个元素代表一个SKU -- libgit2 0.21.2