支持的授权项 细粒度策略支持的操作与API相对应，授权项列表说明如下： 权限：自定义策略中授权项定义的内容即为权限。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 授权范围：自定义策略的授权范围，包括 IAM 项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM项目和企业项目的区别。 企业搜索 服务管理控制操作相关的授权项，明细如下表所示。用户调用如下API时，需要获取对应的权限。权限获取请参考 统一身份认证 服务（IAM）的帮助指导。 “√”表示支持，“x”表示暂不支持。 表1 企业搜索服务权限明细 权限描述 授权项（Action） 对应的API IAM项目（Project） 企业项目（Enterprise Project） 上传数据 KooSearch :experience:manage POST /v1/{project_id}/data-collections/{dataCollectionName} √ × 搜索数据 KooSearch:experience:use POST /v1/{project_id}/search/query √ × 查询热搜词 KooSearch:experience:use POST /v1/{project_id}/search/hotword √ × 开通服务 KooSearch:*:* GET /v1/provision/serviceSubscription?scenario=e-commerce √ × 查询服务开通状态 KooSearch:*:* GET /v1/provision/queryServiceStatus √ × 创建搜索配置 KooSearch:experience:manage POST /console-backend/v2/search-config/configs √ × 修改搜索配置 KooSearch:experience:manage PUT /console-backend/v2/search-config/configs √ × 查询搜索配置列表 KooSearch:experience:manage GET /console-backend/v2/search-conf/configs √ × 查询搜索配置详情 KooSearch:experience:manage GET /console-backend/v2/search-config/configs/{config-id} √ × 查询搜索配置模板列表 KooSearch:experience:manage GET /console-backend/v2/search-config/templates/{template-id} √ × 应用搜索配置 KooSearch:experience:manage POST /console-backend/v2/search-config/configs/{config-id}/application √ × 删除搜索配置 KooSearch:experience:manage DELETE /console-backend/v2/search-config/configs/{config-id} √ ×

概述 欢迎使用企业搜索服务（KooSearch），华为云KooSearch是一款全托管的搜索服务，目前为华为内部办公、客户站内搜索等业务提供搜索服务支持。通过内置的行业分词、语义理解、行业排序算法等能力，为客户提供更简单、更准确、更快速的搜索服务。 您可以使用本文档提供的API对企业搜索服务进行相关操作，如上传和搜索。KooSearch服务支持的全部操作请参见API概览。 在调用KooSearch API之前，请确保已经充分了解KooSearch相关概念，详细信息请参见企业搜索服务的《产品介绍》。 父主题： 使用前必读

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 application_id 是 String 应用ID。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 pre_hint_tag 是 String 上次底纹标签。

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : { "query" : "HBase连接池", "hint_tag" : "22" }} 状态码： 400 详见错误码分类。 { "status" : "3014", "message" : "请求参数校验不通过", "data" : null} 状态码： 500 服务器请求失败。 { "status" : "1000", "message" : "服务异常", "data" : null}

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : null} 状态码： 400 详见错误码分类。 { "status" : "9012", "message" : "Unauthorized tenant.", "data" : null} 状态码： 500 服务器请求失败。 { "status" : 1000, "message" : "服务异常", "data" : null}

事件数据详情 表1 impression曝光 参数 是否必选 参数类型 描述 source_module 是 String 来源页面推荐位，能够详细定位推荐坑位的标识。搜索来源包括：直接搜索、联想词搜索、历史词搜索等（搜索开发需要通过该字段区分搜索行为与推荐行为）。 source_type 是 String 推荐来源页面类型，包括：普通推荐位比如运营场景，运营位来源，首页推荐位，个人中心推荐位，购物车推荐位，收藏页推荐位，详情页推荐位等。 source_id 是 String 来源页面ID。 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 position 是 Integer 商品在列表中的位置信息。 sort 是 String 分类列表页/搜索列表页的排序名称。 query 是 String 搜索的关键词，搜索产生的行为。 当“source_type”为搜索类型时，此处必填。 当“source_type”为非搜索类型时，此处置空。 market_price 否 float 商品原始标价。 goods_price 否 float 商品优惠之后的价格。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 goods_name 否 String 商品名称。 表2 details_page进入详情页 参数 是否必选 参数类型 描述 source_module 是 String 来源页面推荐位，能够详细定位推荐坑位的标识。搜索来源包括：直接搜索、联想词搜索、历史词搜索等（搜索开发需要通过该字段区分搜索行为与推荐行为）。 source_type 是 String 推荐来源页面类型，包括：普通推荐位比如运营场景，运营位来源，首页推荐位，个人中心推荐位，购物车推荐位，收藏页推荐位，详情页推荐位等。 source_id 是 String 来源页面ID。 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 query 是 String 搜索的关键词，搜索产生的行为（source_type为搜索类型时），此处必填，非搜索行为此处置空。 当“source_type”为搜索类型时，此处必填。 当“source_type”为非搜索类型时，此处置空。 position 是 Integer 商品在列表中的位置信息。 sort 是 String 分类列表页/搜索列表页的排序名称。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 goods_price 否 float 商品优惠之后的价格。 market_price 否 float 商品原始标价。 goods_name 否 String 商品名称。 size_or_color_changed_flg 否 boolean 尺寸或者颜色修改标志。 表3 collect收藏 参数 是否必选 参数类型 描述 source_module 是 String 来源页面推荐位，能够详细定位推荐坑位的标识。搜索来源包括：直接搜索、联想词搜索、历史词搜索等（搜索开发需要通过该字段区分搜索行为与推荐行为）。 source_type 是 String 推荐来源页面类型，包括：普通推荐位比如运营场景，运营位来源，首页推荐位，个人中心推荐位，购物车推荐位，收藏页推荐位，详情页推荐位等。 source_id 是 String 来源页面ID。 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 entrance 是 String 收藏入口。 position 是 Integer 商品在列表中的位置信息 query 是 String 搜索的关键词，搜索产生的行为。 当“source_type”为搜索类型时，此处必填。 当“source_type”为非搜索类型时，此处置空。 market_price 否 float 商品原始标价。 goods_price 否 float 商品优惠之后的价格。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 goods_name 否 String 商品名称。 size_or_color_changed_flg 否 boolean 尺寸或者颜色修改标志。 表4 shopping_cart加入购物车 参数 是否必选 参数类型 描述 source_module 是 String 来源页面推荐位，能够详细定位推荐坑位的标识。搜索来源包括：直接搜索、联想词搜索、历史词搜索等（搜索开发需要通过该字段区分搜索行为与推荐行为）。 source_type 是 String 推荐来源页面类型，包括：普通推荐位比如运营场景，运营位来源，首页推荐位，个人中心推荐位，购物车推荐位，收藏页推荐位，详情页推荐位等。 source_id 是 String 来源页面ID。 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 position 是 Integer 商品在列表中的位置信息。 goods_quantity 是 Integer 商品数量。 add_way 是 String 加购方式。 is_success 是 boolean 是否成功。 query 是 String 搜索的关键词，搜索产生的行为。 当“source_type”为搜索类型时，此处必填。 当“source_type”为非搜索类型时，此处置空。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 goods_name 否 String 商品名称。 goods_price 否 float 商品优惠之后的价格。 market_price 否 float 商品原始标价。 size_or_color_changed_flg 否 boolean 尺寸或者颜色修改标志（点击修改尺码或颜色继承下来）。 表5 order下单 参数 是否必选 参数类型 描述 order_id 是 String 订单号（非订单ID）。 is_success 是 boolean 是否成功。 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 goods_quantity 是 String 订单中包含的具体商品的购买数量。 total_price_of_goods 是 float 商品总价。 goods_price 是 String 单商品的实付价格（订单实付金额分摊到每个商品的金额）。 is_use_discount 是 boolean 是否有折扣。 discount_amount 是 float 优惠券金额。 shipping_fee 是 float 订单运费。 order_actual_amount 是 float 订单实付金额。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 original_price 否 String 商品现价。 pay_type 否 String 用户选择的支付方式。 goods_name 否 String 商品名称。 表6 shopping_cart_settlement购物车结算 参数 是否必选 参数类型 描述 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 goods_quantity 是 String 此订单（其实未真正生成订单）中每种商品的购买数量。 is_success 是 boolean 是否成功。 total_price_of_goods 是 float 商品总价。 discount_amount 是 float 优惠券金额。 goods_price 是 String 单商品的实付价格（订单实付金额分摊到每个商品的金额）。 order_actual_amount 是 float 订单实付金额。 shipping_fee 是 float 订单运费。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 original_price 否 String 商品现价。 goods_name 否 String 商品名称。 表7 pay支付 参数 是否必选 参数类型 描述 source_module 是 String 来源页面推荐位，能够详细定位推荐坑位的标识。搜索来源包括：直接搜索，联想词搜索，历史词搜索等（搜索开发需要通过该字段区分搜索行为与推荐行为）。 source_type 是 String 推荐来源页面类型，包括：普通推荐位比如运营场景，运营位来源，首页推荐位，个人中心推荐位，购物车推荐位，收藏页推荐位，详情页推荐位等。 source_id 是 String 来源页面ID。 is_success 是 boolean 是否成功。 is_first_time 是 boolean 是否首次。 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String SPUID（和商品表一致）。 goods_quantity 是 String 此订单（其实未真正生成订单）中每种商品的购买数量。 goods_name 是 String 商品名称。 order_id 是 String 订单号（非订单ID） 。 total_price_of_goods 是 float 商品总价。 is_use_discount 是 boolean 是否有折扣。 discount_amount 是 float 优惠券金额。 shipping_fee 是 float 订单运费。 goods_price 是 String 单商品的实付价格（订单实付金额分摊到每个商品的金额）。 order_actual_amount 是 float 订单实付金额。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 original_price 否 String 商品现价。 pay_type 否 String 用户选择的支付方式。 表8 search搜索 参数 是否必选 参数类型 描述 query 是 String 搜索关键词，若为图片搜索，则填写no keyword。 search_type 否 String 搜索类型，若cp有自定义的搜索类型，可以将normal_search扩展为多个分类。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。注册类型，用户点击注册/登录按钮时进行触发（包括欧盟第三方注册授权页）。 表9 sign_up注册 参数 是否必选 参数类型 描述 content_type 是 String 注册类型，用户点击注册/登录按钮时进行触发（包括欧盟第三方注册授权页）。 sign_up 是 boolean 用户注册是否成功。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 表10 logon登录 参数 是否必选 参数类型 描述 is_success 是 boolean 是否成功。 account_type 否 String 登录方式。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 page_name 否 String 登录行为发生所在的页面名称或页面ID。 表11 assessment评价 参数 是否必选 参数类型 描述 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 evaluate_content 是 String 评价内容。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 表12 view_reviews查看评价 参数 是否必选 参数类型 描述 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 evaluate_content 是 String 评价内容。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 表13 exit_vendor_details退出商详情页 参数 是否必选 参数类型 描述 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 duration 是 String 顶部停留时间、页面停留时间、底部停留时间。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 表14 user_source_channel用户来源渠道 参数 是否必选 参数类型 描述 landingpage_id 是 String 记录用户通过其他渠道跳转登录时的渠道名称。 deeplink_url 是 String deeplink链接。 cp_extra_property 否 String cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 表15 share分享 参数 是否必选 参数类型 描述 sku_id 是 String SKUID（和商品表一致）。 spu_id 是 String SPUID（和商品表一致）。 goods_id 是 String 商品ID（和商品表一致）。 source_module 是 String 来源页面推荐位，能够详细定位推荐坑位的标识。搜索来源包括：直接搜索、联想词搜索、历史词搜索等（搜索开发需要通过该字段区分搜索行为与推荐行为）。 source_type 是 String 推荐来源页面类型，包括：普通推荐位比如运营场景，运营位来源，首页推荐位，个人中心推荐位，购物车推荐位，收藏页推荐位，详情页推荐位等。 source_id 是 String 来源页面ID。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 share_to 否 String 分享到哪里。 表16 quit退出（非APP可不传） 参数 是否必选 参数类型 描述 duration 是 float 用户打开APP到退出APP的间隔时间。 cp_extra_property 否 JsonObject cp扩展字段，cp可在此字段中填充自己的扩展属性；具体key值由cp自己定义，并与搜索推荐侧达成一致。 父主题： 附录

请求示例 办公场景下搜索文档。 https://koosearch.myhuaweicloud.com/v1/{project_id}/search/query{ "query" : "黄金时代", "pagination" : { "page" : 1, "hitsPerPage" : 10 }} 搜索商品。 https://koosearch.myhuaweicloud.com/v1/{project_id}/search/query{ "query" : "电动剃须", "filters" : [ { "attribute" : "onlineFlag", "opt" : "=", "values" : [ "true" ] } ], "sort" : [ { "attribute" : "goodsPrice", "order" : "desc" } ], "requestTags" : { "requestId" : null }, "pagination" : { "page" : 1, "hitsPerPage" : 10 }} 站内搜索场景下搜索结构化数据。 https://koosearch.myhuaweicloud.com/v1/{project_id}/search/query { "query" : "对象", "filters" : [ { "attribute" : "id", "opt" : "=", "values" : [ "code-127351510-8" ] } ], "configId" : "c84a5a858e0a487caef8b7397933b453", "sort" : [ { "attribute" : "view", "order" : "asc" }, { "attribute" : "update_time", "order" : "desc" } ], "pagination" : { "page" : 1 }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 application_id 是 String 应用ID。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 query 是 String 根据当前输入的字符，提供补全和提示功能。 最小长度：1 最大长度：255 size 是 Integer 返回的补全词和提示词数量。 最小值：1 最大值：255 缺省值：10

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : { "totalHits" : 2, "hits" : [ { "suggestion" : "10", "count" : 1 }, { "suggestion" : "1", "count" : 1 } ] }} 状态码： 400 详见错误码分类。 { "status" : "3014", "message" : "请求参数校验不通过", "data" : null} 状态码： 500 服务器请求失败。 { "status" : "1000", "message" : "服务异常", "data" : null}

修订记录 发布日期 修订记录 2023-05-19 第四次公测发布。 修改如下章节： API概览 上传数据，新增站内搜索actiondata模型相关内容，修改dynamicField、records、gender、evtType、create_time、update_time参数描述，修改records、goodsDesc、isLogin、high_quality参数类型，修改对应的请求示例。 更新数据，修改dynamicField、records、create_time、update_time参数描述，修改records、high_quality参数类型。 搜索数据集，新增requestId参数，修改opt、hitsPerPage参数描述，修改对应的响应示例。 查询热搜词，修改功能介绍，新增requestId、query、count参数，修改hitsPerPage参数描述，修改hotwords参数类型，修改对应的响应示例。 新增如下章节： 自动补全提示 热搜底纹 2023-04-12 第三次公测发布。 修改如下章节： 上传数据，“Itdata结构化信息”新增author、dynamicField、quality_score、is_original参数，修改high_quality参数的类型及描述，修改title、description、body、index_hot_word为可选项，修改title描述。 搜索数据集，新增configId参数，修改filters、sort、opt、attribute、order、values的描述信息，修改站内搜索请求示例。 新增如下章节： 更新数据 删除数据 2023-03-01 第二次公测发布。 修改如下章节： 概述，修改概念及操作示例。 API概览，新增搜索数据集的方法。 构造请求，修改请求消息体。 返回结果，修改状态码的编号范围。 上传数据，新增办公搜索、站内搜索。 搜索数据集，新增办公搜索、站内搜索。 权限和授权项，新增搜索配置的操作权限。 获取应用ID，修改获取位置。 2022-09-30 第一次公测发布。

请求示例 站内搜索场景结构化数据上传。示例中开启了动态字段，将dynamicField参数指定为true，可以添加新字段“delete_time”（时间类型，格式：yyyy-MM-ddTHH:mm:ss.SSSZ）和“weight”（double类型）。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/itdata { "records" : [ { "id" : "blog-100623122", "type" : "blog", "title" : "获取对象操作", "description" : "1.通过 id 获取对象 var $cr=$('#cr');//jQuery对象 var cr=document.getElementById('cr');//DOM对象 2.通过 name 获取对象 Js代码 : $(\"div[id]\") ...", "body" : "1.通过 id 获取对象 var $cr=$('#cr');//jQuery对象 var cr=document.getElementById('cr');//DOM对象 2.通过 name 获取对象 Js代码 : $(\"div[id]\") 选择所有含有id属性的div元素 $(\"input[name='newsletter']\") 选择所有的name属性等于'newsletter'的input元素 $(\"input[name!='newsletter']\") 选择所有的name属性不等于'newsletter'的input元素 $(\"input[name^='news']\") 选择所有的name属性以'news'开头的input元素 $(\"input[name$='news']\") 选择所有的name属性以'news'结尾的input元素 $(\"input[name*='man']\") 选择所有的name属性包含'news'的input元素 $(\"input[id][name$='man']\") 可以使用多个属性进行联合选择，该选择器是得到所有的含有id属性并且那么属性以man结尾的元素 3. 4.判断checkbox 是否选中 方法一： if ($(\"#checkbox-id\").get(0).checked) { // do something } 方法二： if($('#checkbox-id').is(':checked')) { // do something } 方法三： if ($('#checkbox-id').attr('checked')) { // do something } function checkInfo(){ $(\"input[name='org3.otherValues']\").each( function(){ if($(this).get(0).checked){ return true; } }); var org3_ids=$(\"#org3_ids\").val(); if(org3_ids!=''){ return true; } 参考资料： http://blog.csdn.net/a1943206465/article/details/54893091 转载于:https://my.oschina.net/ruanjun/blog/1488931", "author" : "Micah Lee", "create_time" : "2017-07-26T14:28:00.000+0800", "update_time" : "2019-09-08T11:23:18.000+0800", "delete_time" : "2023-04-06T12:20:36.000+0800", "tags" : "获取对象,jQuery", "index_hot_word" : "jQuery,Js,获取对象", "pic" : "www.img.com/js.png", "price" : 1, "high_quality" : "1", "free" : 1, "likes" : 2, "view" : 26, "comment" : 1, "collections" : 3, "focus" : 4, "reports" : 2, "fans" : 2, "stemp_count" : 1, "posts_count" : 2, "weight" : 0.8 } ], "dynamicField" : true} 用户基础信息导入。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/userdata{ "records" : [ { "userId" : "0000350019", "age" : "25", "gender" : "male" }, { "userId" : "0000350015", "age" : "27", "gender" : "female" } ], "requestId" : "1c4789a9520397387b271f7266b92c11", "timestamp" : "1613757496"} 用户事件上报。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/eventdata{ "records" : [ { "deviceId" : "12cd7cf2-da74-4182-afb7-6c90cc41393a_ys", "evtOccurTime" : "1661485148", "os" : "Android", "deviceProdName" : "pro20", "brandName" : "adorawe", "evtProperty" : [ { "goodsName" : "2022夏季新款短袖T恤男潮流纯棉宽松上衣学生简约男rty", "sourceModule" : "Home_guessYouLike", "query" : "短袖", "position" : "", "spuId" : "992230" } ], "appName" : "banggood", "deviceName" : "rm3597", "carrier" : "CMCC", "platformType" : "Android", "deviceBrand" : "HUAWEI", "userId" : "16723065", "appVer" : "7.2.0", "evtType" : "search", "networkType" : "5G", "appId" : "7.2.1", "isLogin" : "1" } ], "requestId" : "", "timestamp" : "1661485248"} 办公场景文档信息上传。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/docdata{ "records" : [ { "docAttachName" : "黄金时代", "docAttachId" : "f32923312eda4f07aa33bea3d1ccb8a9", "docUrl" : "/path/book", "docPageInfo" : [ { "attachPageNo" : "第1页", "attachPageNoNew" : 1, "attachDirTitle" : "这东西无比重要", "attachParagraph" : [ "当然，我对此有不同的意见，在我看来，这东西无比重要，就如我之存在本身。天色微微向晚，天上飘着懒洋洋的云彩。下半截沉在黑暗里，上半截仍浮在阳光中。" ] }, { "attachPageNo" : "第2页", "attachPageNoNew" : 2, "attachDirTitle" : "半明半暗的云", "attachParagraph" : [ "那一天我二十一岁，在我一生的黄金时代。我有好多奢望。我想爱，想吃，还想在一瞬间变成天上半明半暗的云。", "后来我才知道，生活就是个缓慢受锤的过程，人一天天老下去，奢望也一天天消失，最后变得像挨了锤的牛一样。" ] }, { "attachPageNo" : "第3页", "attachPageNoNew" : 3, "attachDirTitle" : "锤不了我", "attachParagraph" : [ "可是我过二十一岁生日时没有预见到这一点。我觉得自己会永远生猛下去，什么也锤不了我。", "那天晚上我请陈清扬来吃鱼，所以应该在下午把鱼弄到手。到下午五点多钟我才想起到戽鱼的现场去看看。还没走进那条小河岔，两个累颇族孩子就从里面一路打出来，烂泥横飞，我身上也挨了好几块，直到我拎住他们的耳朵，他们才罢手。" ] } ] } ]} 商品信息导入。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/itemdata{ "records" : [ { "spuId" : "1615411", "spuName" : "price_type", "skuId" : "POA6228532", "skuName" : "POA6228533", "goodsId" : "1715166_POA7260552_EN", "countrySite" : "CN", "firstClass" : "first_class", "firstClassId" : "3580", "secondClass" : "secondClass", "secondClassId" : "358001", "thirdClass" : "thirdClass", "thirdClassId" : "35800101", "minClass" : "minClass", "minClassId" : "35800101", "goodsName" : "雪花秀人参水", "goodsDesc" : "专注于肌肤护理", "productBrand" : "欧莱雅", "priceType" : 1, "activityType" : 1, "goodsPrice" : 1280, "marketPrice" : 1900, "goodsDcn" : 0, "goodsLink" : "https://www.xxxx/ru/unknow-0/p-1615588.html", "imageLink" : "https://www.xxxx/ru/unknow-0/p-1615588.html", "goodsStock" : 1000, "onlineFlag" : true, "shippingWeight" : 1, "size" : "16px", "color" : "Blue", "gender" : "female", "commentCnt" : 50, "score" : 99.9 }, { "spuId" : "1615411", "spuName" : "price_type", "skuId" : "POA6228532", "skuName" : "POA6228533", "goodsId" : "1715166_POA7260552_EN", "countrySite" : "CN", "firstClass" : "first_class", "firstClassId" : "3580", "secondClass" : "secondClass", "secondClassId" : "358001", "thirdClass" : "thirdClass", "thirdClassId" : "35800101", "minClass" : "minClass", "minClassId" : "35800101", "goodsName" : "飞利浦电动剃须刀S1008", "goodsDesc" : "科技创造美好生活，专注男性洁面护理", "productBrand" : "飞利浦", "priceType" : 1, "activityType" : 1, "goodsPrice" : 1280, "marketPrice" : 1900, "goodsDcn" : 0, "goodsLink" : "https://www.xxxx/ru/unknow-0/p-1615588.html", "imageLink" : "https://www.xxxx/ru/unknow-0/p-1615588.html", "goodsStock" : 1000, "onlineFlag" : true, "shippingWeight" : 1, "size" : "16px", "color" : "Blue", "gender" : "female", "commentCnt" : 50, "score" : 99.9 } ], "requestId" : "156155448", "timestamp" : "47474747786"} 订单数据导入。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/orderdata{ "records" : [ { "orderId" : "13541", "userId" : "1357861322", "shopId" : "yf-125037", "goodsId" : "WZWS13452013_en", "skuId" : "WZWS13452013", "spuId" : "881120" }, { "orderId" : "13542", "userId" : "1357861323", "shopId" : "yf-125038", "goodsId" : "WZWS13452014_en", "skuId" : "WZWS13452014", "spuId" : "881121" }, { "orderId" : "13543", "userId" : "1357861324", "shopId" : "yf-125039", "goodsId" : "WZWS13452015_en", "skuId" : "WZWS13452015", "spuId" : "881122" }, { "orderId" : "13544", "userId" : "1357861325", "shopId" : "yf-125040", "goodsId" : "WZWS13452016_en", "skuId" : "WZWS13452016", "spuId" : "881123" } ], "requestId" : "", "timestamp" : "1661485248"} 用户行为数据上传（userAction为click_hotword）。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/actiondata{ "records" : [ { "userAction" : "click_hotword", "time" : 1682576212, "requestId" : "35de280109e14fb6a062db965ac4a266", "position" : 1, "hotword" : "hello" } ]} 用户行为数据上传（userAction为非click_hotword）。 https://koosearch.myhuaweicloud.com/v1/{project_id}/data-collections/actiondata{ "records" : [ { "userAction" : "exposure", "time" : 1682576212, "requestId" : "35de280109e14fb6a062db965ac4a266", "position" : 1, "docId" : "blog-9999999" } ]}

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : null} 状态码： 400 详见错误码分类。 { "status" : "2013", "message" : "数据上报类型不支持", "data" : null} 状态码： 500 服务器请求失败。 { "status" : 1000, "message" : "服务异常", "data" : null}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 最小长度：0 最大长度：20 application_id 是 String 应用ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 requestId 否 String 请求唯一编号，仅适用于电商搜索。 timestamp 否 String 请求时间戳，仅适用于电商搜索。 格式：unix时间戳 示例：“1676274550” dynamicField 否 Boolean 是否开启动态字段，默认值为false，仅适用于站内搜索。 true：开启动态字段。如果上传或更新数据中有新增字段，系统会根据新增字段的值创建合适类型的字段（目前支持"yyyy-MM-ddTHH:mm:ss.SSSZ"格式的时间、long、double、string类型）。 说明： 新增的字段不会用于搜索匹配，只能用于过滤和排序。 false：关闭动态字段。上传或更新数据中不允许存在新增字段。 records 是 Array one of object: userdata itemdata eventdata orderdata docdata itdata actiondata 上传数据集。 表4 userdata 参数 是否必选 参数类型 描述 userId 是 String 用户唯一标识。 age 是 Integer 年龄。 gender 是 String 性别。 枚举值： male female 表5 itemdata 参数 是否必选 参数类型 描述 spuId 否 String 商品信息聚合的最小单位，和事件数据详情的spu_id需保持一致。 spuName 否 String SPU名称。 skuId 否 String SKUID。 skuName 否 String SKU名称。 goodsId 否 String 商品ID。 firstClass 否 String 一级分类。 firstClassId 否 String 一级分类编号。 secondClass 否 String 二级分类。 secondClassId 否 String 二级分类编号。 thirdClass 否 String 三级分类。 thirdClassId 否 String 三级分类编号。 minClass 否 String 最小分类。 minClassId 否 String 最小分类编号。 goodsName 否 String 商品名称。 goodsDesc 否 Array of strings 商品描述。 productBrand 否 String 商品所属品牌。 priceType 否 Integer 价格类型。 activityType 否 Integer 商品活动类型。 goodsPrice 否 Float 商品优惠之后的价格。 marketPrice 否 Float 商品原始价格。 goodsDcn 否 Float 商品折扣。 goodsLink 否 String 商品链接。 imageLink 否 String 图片链接。 goodsStock 否 Integer 商品库存。 onlineFlag 否 Boolean 在架状态。 shippingWeight 否 Float 物品重量。 size 否 String 尺寸。 color 否 String 颜色。 gender 否 String 商品适用性别。 commentCnt 否 Integer 评论数。 score 否 Float 评分。 表6 eventdata 参数 是否必选 参数类型 描述 evtType 否 String 事件类型数据详情。 枚举值： impression：曝光 details_page：进入详情页 collect：收藏 shopping_cart：加入购物车 order：下单 shopping_cart_settlement：购物车结算 pay：支付 search：搜索 sign_up：注册 logon：登录 assessment：评价 view_reviews：查看评价 exit_vendor_details：退出商详情 user_source_channel：用户来源渠道 share：分享 quit：退出（非APP可不传） evtOccurTime 否 String 事件发生时间戳。 evtProperty 否 Object 为事件数据详情，填evtType字段对应的行为类型的数据，如evtType为搜索，则必填query，选填search_type和cp_extra_property，用json数组返回。 recommendId 否 String 请求华为搜索接口返回ID。 recommendInfo 否 String 推荐返回信息。 brandName 否 String 品牌站名称。 isLogin 否 Boolean 是否登录。 userId 否 String 用户编号。 visitorId 否 String 游客编号。 os 否 String 操作系统。 platformType 否 String 平台类型。 appId 否 String 应用编号。 appName 否 String 应用名称。 appVer 否 String 应用版本。 deviceId 否 String 设备ID。 deviceBrand 否 String 设备品牌。 deviceName 否 String 设备型号。 deviceProdName 否 String 设备产品名。 packageName 否 String 应用包名。 romVer 否 String ROM版本。 isFirstDay 否 Boolean 是否首次启动App。 carrier 否 String 运营商。 networkType 否 String 网络类型。 表7 orderdata 参数 是否必选 参数类型 描述 orderId 否 String 订单号（非订单ID）。 userId 否 String 用户的唯一编号。 goodsId 否 String 商品ID。 skuId 否 String SKUID（和商品表一致）。 spuId 否 String SPUID（和商品表一致）。 表8 docdata 参数 是否必选 参数类型 描述 docAttachId 是 String 文档ID。 docAttachName 是 String 文档名称。 docUrl 否 String 文档URL。 docPageInfo 否 Array of DocPageInfo objects 文档页面信息。 表9 DocPageInfo 参数 是否必选 参数类型 描述 attachDirTitle 否 String 文档页面小标题。 attachPageNo 否 String 文档原始页码。 attachPageNoNew 否 Long 文档页码（排序可用）。 attachParagraph 否 Array of strings 文档页面片段内容。 表10 itdata 参数 是否必选 参数类型 描述 id 是 String 主键。 type 否 String 资源类型。例如：博客、论坛、问答等。 title 否 String 标题。在“上传数据”时为必填项，在“更新数据”时为选填项。 description 否 String 描述。 body 否 String 内容。 author 否 String 作者。 create_time 否 String 创建时间，格式："yyyy-MM-ddTHH:mm:ss.SSSZ"。 update_time 否 String 更新时间，格式："yyyy-MM-ddTHH:mm:ss.SSSZ"。 tags 否 String 标签。 index_hot_word 否 String 索引热词。针对该资源，需要建立强关联索引词。 pic 否 String 图片。 price 否 Float 资源单价。 high_quality 否 Integer 标记：是否是优质资源。 0：否 1：是 free 否 Integer 是否免费。 0：收费 1：免费 likes 否 Integer 点赞数。 view 否 Integer 阅读数。 comment 否 Integer 评论数。 collections 否 Integer 收藏数。 focus 否 Integer 关注数。 reports 否 Integer 转发数。 fans 否 Integer 粉丝数。 stemp_count 否 Integer 踩数。 posts_count 否 Integer 回复数。 quality_score 否 Integer 质量分。 is_original 否 Integer 是否原创。 0：未知 1：原创 2：非原创 表11 actiondata 参数 是否必选 参数类型 描述 userAction 是 String 用户行为数据详情。 枚举值： click_hotword：点击热搜词 click：点击搜索结果 exposure：曝光搜索结果 upvote：点赞 downvote：点踩 collect：收藏 share：分享、转发 comment：评论 time 是 Long 时间。 UNIX时间戳（UTC时间）。 最小值：0 requestId 是 String 请求ID。填写搜索数据集/查询热搜词接口返回的requestId。 position 是 Integer 位置。计算方式：（page-1）*hitsPerPage + 在当前页的位置。 docId 否 String 文档ID。 当userAction字段值为非"click_hotword"时，文档ID必填。 hotword 否 String 热搜词。 当userAction字段值为"click_hotword"时，热搜词必填。

功能介绍 该接口用于KooSearch数据上传，可根据系统支持的模型上传数据，如电商行业userdata、itemdata、eventdata、orderdata模型，办公场景docdata模型，站内搜索itdata、actiondata模型。 userdata：用户信息，是指消费者信息。电商用户上传此类数据可以根据年龄段和性别做个性化推荐及数据分析。 itemdata：商品信息，是指物料信息。电商用户将自己的商品进行上传，最终用户可以通过搜索查看到有哪些具体的商品以及商品的详细情况。 eventdata：事件信息，是指用户在应用上的行为信息，如用户搜索、点击、收藏、加购、下单、支付等，根据这些数据对用户做个性化推荐及数据分析。 orderdata：订单信息，用户对商品下的订单数据信息，用于统计分析商品销量及用户喜好，提升点击到支付的转化。 docdata：文档数据，用户在办公场景下，上传文档内容。 itdata：IT领域结构化数据，用户在站内搜索场景下根据数据模型字段上传结构化数据。 actiondata：用户行为数据，支持站内场景，根据站内用户行为数据对用户行为进行统计分析。

URI POST /v1/{project_id}/data-collections/{dataCollectionName} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 dataCollectionName 是 String 系统支持电商行业模型、办公场景、站内场景。 枚举值： userdata itemdata eventdata orderdata docdata itdata actiondata