企业搜索服务 KooSearch-上传数据:请求参数

时间：2023-11-01 16:16:26

表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	上传数据集。

表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	网络类型。

表8 docdata
参数	是否必选	参数类型	描述
docAttachId	是	String	文档ID。
docAttachName	是	String	文档名称。
docUrl	否	String	文档URL。
docPageInfo	否	Array of DocPageInfo objects	文档页面信息。

**表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"时，热搜词必填。