gRPC接口文档

SanQingNiaoApi

SanQingNiaoApi 六小象API接口

Method Name	Request Type	Response Type	Description
GetVersion	GetVersionParams	GetVersionReply	GetVersion 获取版本信息权限： 1.任意激活状态可调用
GetLatestVersion	GetLatestVersionParams	GetLatestVersionReply	GetLatestVersion 获取最新版本权限： 1.仅已激活状态可调用
AdvancedConfigGet	AdvancedConfigGetParams	AdvancedConfigGetReply	AdvancedConfigGet 高级配置-获取权限： 1.任意激活状态可调用说明： 1.所有配置项均由SDK进行持久化储存，外部无需储存
AdvancedConfigSet	AdvancedConfigSetParams	AdvancedConfigSetReply	AdvancedConfigSet 高级配置-修改权限： 1.任意激活状态可调用说明： 1.所有配置项均由SDK进行持久化储存，外部无需储存
CameraEnum	CameraEnumParams	CameraEnumReply	CameraEnum 相机-枚举设备权限： 1.任意激活状态可调用
CameraChange	CameraChangeParams	CameraChangeReply	CameraChange 相机-设备切换权限： 1.任意激活状态可调用
CameraFrame	CameraFrameParams	CameraFrameReply	CameraFrame 相机-图像帧权限： 1.任意激活状态可调用
CameraDetectRangeGet	CameraDetectRangeGetParams	CameraDetectRangeGetReply	CameraDetectRangeGet 相机-识别区域获取权限： 1.任意激活状态可调用
CameraDetectRangeSet	CameraDetectRangeSetParams	CameraDetectRangeSetReply	CameraDetectRangeSet 相机-识别区域修改权限： 1.任意激活状态可调用
DeviceGetInfo	DeviceGetInfoParams	DeviceGetInfoReply	DeviceGetInfo 设备-获取信息权限： 1.任意激活状态可调用说明： 1.状态码ErrPciNetCardDisabled(1000): 需要启用PCI网卡后重启应用 2.状态码ErrNetwork(1004): 需要联网后重启应用 3.状态码ErrDeviceNotActivate(1500): 需要激活或免费试用 4.状态码ErrDeviceActivateExpire(1501): 测试激活码已过期，需要重新激活 5.状态码ErrDeviceSystemTime(1503): 设备系统时间异常，请调整后重启应用
DeviceFreeTrial	DeviceFreeTrialParams	DeviceFreeTrialReply	DeviceFreeTrial 设备-免费试用权限： 1.任意激活状态可调用 2.每台设备仅有一次试用机会 3.使用正式激活码激活后的设备将无法再免费试用说明： 1.在版本`v1.5.0.0+`支持该接口
DeviceActivate	DeviceActivateParams	DeviceActivateReply	DeviceActivate 设备-激活权限： 1.任意激活状态可调用
DeviceShopChange	DeviceShopChangeParams	DeviceShopChangeReply	DeviceShopChange 设备-门店修改权限： 1.仅已激活状态可调用
AiPushWeight	AiPushWeightParams	AiPushWeightReply	AiPushWeight 智能识别-推送重量信息权限： 1.仅已激活状态可调用
AiImageDetectIgnoreSet	AiImageDetectIgnoreSetParams	AiImageDetectIgnoreSetReply	AiImageDetectIgnoreSet 智能识别-图像检测过滤设置权限： 1.仅已激活状态可调用
AiListenResult	AiListenResultParams	AiListenResultReply stream	AiListenResult 智能识别-监听识别结果权限： 1.仅已激活状态可调用 2.AiListenResult 和 AiRegisterResultCallback 接口二选一使用即可
AiRegisterResultCallback	AiRegisterResultCallbackParams	AiRegisterResultCallbackReply	AiRegisterResultCallback 智能识别-注册识别结果回调权限： 1.仅已激活状态可调用 2.AiListenResult 和 AiRegisterResultCallback 接口二选一使用即可
AiUnsafeMatching	AiPushWeightParams	AiListenResultReply	AiUnsafeMatching 智能识别-非安全单次AI识别权限： 1.仅已激活状态可调用说明： 1.使用该接口需要自行实现识别触发逻辑，触发逻辑涉及场景较多，建议使用HTTP回调或gRPC长连接接口
AiLearning	AiLearningParams	AiLearningReply	AiLearning 智能识别-学习权限： 1.仅已激活状态可调用
AiFastLearning	AiFastLearningParams	AiFastLearningReply	AiFastLearning 智能识别-快速学习权限： 1.仅已激活状态可调用
SkuFeatQueryImage	SkuFeatQueryImageParams	SkuFeatQueryImageReply	SkuFeatQueryImage 商品特征-查询已学习的图像权限： 1.仅已激活状态可调用
SkuFeatQuery	SkuFeatQueryParams	SkuFeatQueryReply	SkuFeatQuery 商品特征-查询特征信息权限： 1.仅已激活状态可调用
SkuFeatRemove	SkuFeatRemoveParams	SkuFeatRemoveReply	SkuFeatRemove 商品特征-移除指定商品的指定特征权限： 1.仅已激活状态可调用
SkuFeatClear	SkuFeatClearParams	SkuFeatClearReply	SkuFeatClear 商品特征-清除指定商品的所有特征权限： 1.仅已激活状态可调用
LearnDataImport	LearnDataImportParams	LearnDataImportReply	LearnDataImport 学习数据-导入权限： 1.仅已激活状态可调用
LearnDataExport	LearnDataExportParams	LearnDataExportReply	LearnDataExport 学习数据-导出权限： 1.仅已激活状态可调用
LearnDataUpload	LearnDataUploadParams	LearnDataUploadReply	LearnDataUpload 学习数据-上传权限： 1.仅已激活状态可调用
LearnDataClear	LearnDataClearParams	LearnDataClearReply	LearnDataClear 学习数据-清空权限： 1.仅已激活状态可调用
AlgoModelEnum	AlgoModelEnumParams	AlgoModelEnumReply	AlgoModelEnum 算法模型-枚举权限： 1.仅已激活状态可调用
AlgoModelChange	AlgoModelChangeParams	AlgoModelChangeReply	AlgoModelChange 算法模型-切换权限： 1.仅已激活状态可调用
SkuDataImport	SkuDataImportParams	SkuDataImportReply	SkuDataImport 商品数据-导入权限： 1.仅已激活状态可调用
SkuDataDelete	SkuDataDeleteParams	SkuDataDeleteReply	SkuDataDelete 商品数据-删除权限： 1.仅已激活状态可调用
SkuDataIconMatch	SkuDataIconMatchParams	SkuDataIconMatchReply	SkuDataIconMatch 商品数据-主图匹配权限： 1.仅已激活状态可调用
AutoSyncGetSelfInfo	AutoSyncGetSelfInfoParams	AutoSyncGetSelfInfoReply	AutoSyncGetSelfInfo 自动同步-获取本机信息权限： 1.仅已激活状态可调用
AutoSyncGetGroupsInfo	AutoSyncGetGroupsInfoParams	AutoSyncGetGroupsInfoReply	AutoSyncGetGroupsInfo 自动同步-获取分组表信息权限： 1.仅已激活状态可调用
AutoSyncRemoveDevice	AutoSyncRemoveDeviceParams	AutoSyncRemoveDeviceReply	AutoSyncRemoveDevice 自动同步-移除设备权限： 1.仅已激活状态可调用
AutoSyncJoinGroup	AutoSyncJoinGroupParams	AutoSyncJoinGroupReply	AutoSyncJoinGroup 自动同步-加入分组权限： 1.仅已激活状态可调用
AutoSyncExitGroup	AutoSyncExitGroupParams	AutoSyncExitGroupReply	AutoSyncExitGroup 自动同步-退出分组权限： 1.仅已激活状态可调用
AutoSyncSetIntervalTime	AutoSyncSetIntervalTimeParams	AutoSyncSetIntervalTimeReply	AutoSyncSetIntervalTime 自动同步-设置间隔时间权限： 1.仅已激活状态可调用
AutoSyncUpdateDataSyncRule	AutoSyncUpdateDataSyncRuleParams	AutoSyncUpdateDataSyncRuleReply	AutoSyncUpdateDataSyncRule 自动同步-更新数据同步规则权限： 1.仅已激活状态可调用
AutoSyncCreateGroup	AutoSyncCreateGroupParams	AutoSyncCreateGroupReply	AutoSyncCreateGroup 自动同步-创建分组权限： 1.仅已激活状态可调用
AutoSyncUpdateGroupName	AutoSyncUpdateGroupNameParams	AutoSyncUpdateGroupNameReply	AutoSyncUpdateGroupName 自动同步-更新分组名称权限： 1.仅已激活状态可调用

Top

sanqingniaopb/message_common.proto

ActivateInfo

ActivateInfo 设备激活信息

Field	Type	Description
activateCode	string	激活码
activateExpireTime	int64	激活过期时间
activateCodeType	ActivateCodeType	激活码类型

AlgoModelInfo

AlgoModelInfo 算法模型信息

Field	Type	Label	Description
code	uint32		模型代号
name	string		模型名称

AutoSyncDeviceInfo

AutoSyncDeviceInfo 自动同步设备信息

Field	Type	Label	Description
deviceSN	string		设备SN
hostName	string		主机名
systemType	SystemType		系统类型
algoModel	uint32		算法模型
servicePort	uint32		服务端口号
ipAddrList	string	repeated	IP地址列表
dataSyncRule	AutoSyncDataSyncRule		数据同步规则
status	bool		设备状态（false:离线, true:在线）
latestPullAt	uint64		学习数据最新拉取时间

AutoSyncGroupInfo

AutoSyncGroupInfo 自动同步分组信息

Field	Type	Label	Description
groupID	string		分组ID
groupName	string		分组名称
groupUpdateAt	uint64		分组信息更新时间
deviceInfoList	AutoSyncDeviceInfo	repeated	设备列表

CameraInfo

CameraInfo 相机信息

Field	Type	Label	Description
id	string		相机ID
name	string		相机名称
usbPath	string		设备USB路径
sysPath	string		设备系统路径
resolutionInfoList	CameraResolutionInfo	repeated	支持的分辨率列表

CameraResolutionInfo

CameraResolutionInfo 相机分辨率信息

Field	Type	Description
width	uint32	图像宽度（像素）
height	uint32	图像高度（像素）
fps	uint32	图像帧率（张/秒）
format	string	图像帧格式，支持版本：[v1.5.3.0+]

DeviceInfo

DeviceInfo 设备信息

Field	Type	Description
deviceSN	string	设备SN
activateInfo	ActivateInfo	激活信息
shop	ShopInfo	门店信息

PlanePositionInfo

PlanePositionInfo 平面坐标信息

Field	Type	Label	Description
x	uint32		X轴坐标值
y	uint32		Y轴坐标值

ShopInfo

ShopInfo 门店信息

Field	Type	Description
code	string	门店编码【不允许修改】
name	string	门店名称
scaleAlias	string	秤号别名
externalCode	string	外部门店编码

SkuFeatImageInfo

SkuFeatImageInfo 商品特征图像信息

Field	Type	Label	Description
id	int64		识别ID
path	string		图片HTTP访问路径

SkuFeatNumberInfo

SkuFeatNumberInfo 商品特征数量信息

Field	Type	Label	Description
sku	SkuInfo		商品信息
number	uint64		特征数量

SkuIconInfo

SkuIconInfo 商品主图信息

Field	Type	Label	Description
sku	SkuInfo		商品信息
iconList	string	repeated	匹配到的商品主图列表
keywordList	string	repeated	匹配到的关键字列表
preLearningLabel	int32		匹配到的商品预学习标签

SkuInfo

SkuInfo 商品信息

Field	Type	Description
code	string	商品唯一编码
name	string	商品名称
spuCode	string	商品上级码（spuCode==code 或 spuCode为空时，该商品为顶级商品）

SkuSaleInfo

SkuSaleInfo 商品销售信息

Field	Type	Description
sales	int32	销量：重量（克）、数量
priceUnit	int32	计价方式（0-重量计价，1-数量计价）
price	int32	原始单价（分/Kg）
salePrice	int32	销售单价（分/Kg）
amount	int32	销售总价（分）
barCode	string	条码
priceChangeMode	int32	商品是否改价（0-未改价，1-改单价，2-改总价）
priceType	int32	商品价格类型（1-正常价格，2-临时改价，3-永久改价，4-阶梯变价）

SkuStatusInfo

SkuStatusInfo 商品状态信息

Field	Type	Label	Description
sku	SkuInfo		商品信息
status	SkuStatus		商品状态

VendorInfo

VendorInfo 厂商信息

Field	Type	Label	Description
code	string		授权编码
key	string		授权密钥

VersionDownloadInfo

VersionInfo 版本下载信息

Field	Type	Label	Description
versionInfo	VersionInfo		版本信息
url	string		下载地址

VersionInfo

VersionInfo 版本信息

Field	Type	Description
appType	uint32	应用类型
version	string	版本号
internalVersion	string	内部版本号

ActivateCodeType

ActivateCodeType 激活码类型

Name	Number	Description
ActivateCodeTypeUnknown	0	激活码类型：未知
ActivateCodeTypeTestLimitOffline	1	激活码类型：测试激活码，有使用期限制，有离线时长限制
ActivateCodeTypeTestOnlyOnline	2	激活码类型：测试激活码，有使用期限制，仅允许在线使用
ActivateCodeTypeFormalLimitOffline	100	激活码类型：正式激活码，有离线时长限制
ActivateCodeTypeFormalAllowOffline	101	激活码类型：正式激活码，允许离线使用

AdvancedConfigKey

AdvancedConfigKey 高级配置项键

Name	Number	Description
DetectMode	0	检测模式（取值范围：0-重量检测，1-图像检测；赋值字段：uint32Val）
WeightDetectMode	1	重量检测模式（取值范围：0-满足最小识别重量后；赋值字段：uint32Val）
WeightDetectMinValue	2	重量检测最小触发重量（单位：克；取值范围：闭区间[1,10000]；赋值字段：uint32Val）
WeightDetectAppendMinValue	3	重量检测商品叠加最小触发重量（单位：克；取值范围：闭区间[1,10000]；赋值字段：uint32Val）
WeightDetectStatusJudgment	4	重量检测状态判断模式（取值范围：0-外部传入，1-内部自动；赋值字段：uint32Val）
WeightDetectCameraDelay	5	重量检测相机拍照延迟时间（单位：毫秒；取值范围：闭区间[0,5000]；赋值字段：uint32Val）
ImageDetectMode	20	图像检测模式（取值范围：0-特征相似度；赋值字段：uint32Val）
ImageDetectIgnoreThreshold	21	图像检测忽略相似阈值（取值范围：闭区间[0,1000]；赋值字段：uint32Val）
ImageDetectStableNumber	22	图像检测特征稳定统计次数（取值范围：闭区间[2,20]；赋值字段：uint32Val）
ImageDetectStableThreshold	23	图像检测特征稳定相似阈值（取值范围：闭区间[0,1000]；赋值字段：uint32Val）
ImageDetectRepeatThreshold	24	图像检测特征重复相似阈值（取值范围：闭区间[0,1000]；赋值字段：uint32Val）
ImageDetectInterval	25	图像检测间隔时间（单位：毫秒；取值范围：闭区间[0,5000]；赋值字段：uint32Val）
MaxOutputNum	100	最大识别输出数量（取值范围：闭区间[1,10]；赋值字段：uint32Val）
PerformanceMode	101	推理引擎处理器使用模式（取值范围：0-均衡模式，1-性能模式；赋值字段：uint32Val）
PreLearnSwitch	102	预学习开关（取值范围：true-开启，false-关闭；赋值字段：boolVal）
LiveLearnSwitch	103	实时学习开关（取值范围：true-开启，false-关闭；赋值字段：boolVal）
DemoModeSwitch	104	演示模式开关（取值范围：true-开启，false-关闭；赋值字段：boolVal）
BaizeThreshold	105	白泽算法推荐阈值（取值范围：闭区间[0,3]；赋值字段：floatVal）
BaizeTopOneThreshold	106	白泽算法首位推荐阈值（取值范围：闭区间[0.70,0.85]；赋值字段：floatVal）

AutoSyncDataSyncRule

AutoSyncDataSyncRule 自动同步数据同步规则

Name	Number	Description
AutoSyncDataSyncRuleDisable	0	自动同步数据同步规则: 禁用数据同步
AutoSyncDataSyncRuleDuplex	1	自动同步数据同步规则: 双向数据同步
AutoSyncDataSyncRuleOnlySend	2	自动同步数据同步规则: 仅发送数据
AutoSyncDataSyncRuleOnlyReceive	3	自动同步数据同步规则: 仅接收数据

LearnDataExportMode

LearnDataExportMode 学习数据导出模式

Name	Number	Description
LearnDataExportModeFull	0	全量导出
LearnDataExportModeIncrSku	1	商品维度增量导出
LearnDataExportModeIncrFeat	2	特征维度增量导出

LearnDataImportMode

LearnDataImportMode 学习数据导入模式

Name	Number	Description
LearnDataImportModeFull	0	全量导入
LearnDataImportModeIncrSku	1	商品维度增量导入
LearnDataImportModeIncrFeat	2	特征维度增量导入
LearnDataImportModeStrictFull	3	严格模式全量导入
LearnDataImportModeStrictIncrSku	4	严格模式商品维度增量导入
LearnDataImportModeStrictIncrFeat	5	严格模式特征维度增量导入

LearningMode

LearningMode 学习模式

Name	Number	Description
LearningModeSearch	0	使用搜索方式学习
LearningModeShortcut	1	使用快捷方式学习
LearningModeOutput	2	使用输出结果学习
LearningModeSkip	3	跳过学习

SkuDataImportMode

SkuDataImportMode 商品数据导入模式

Name	Number	Description
SkuDataImportModeIncr	0	增量导入
SkuDataImportModeFull	1	全量导入

SkuStatus

SkuStatus 商品状态

Name	Number	Description
SkuStatusNone	0	不存在
SkuStatusNormal	1	正常
SkuStatusTemporaryLock	2	临时锁定
SkuStatusPermanentLock	3	永久锁定

SystemType

SystemType 系统类型

Name	Number	Description
SystemTypeUnknown	0
SystemTypeWindows	1
SystemTypeLinux	2
SystemTypeAndroid	3

VersionUpdateType

VersionUpdateType 版本更新类型

Name	Number	Description
VersionUpdateTypeUnknown	0	未知
VersionUpdateTypeOptional	1	可选更新
VersionUpdateTypeQuiet	2	静默更新
VersionUpdateTypeForce	3	强制更新

WeightStatus

WeightStatus 重量状态

Name	Number	Description
WeightStatusUnstable	0	不稳定
WeightStatusStable	1	稳定
WeightStatusUnder	2	欠载
WeightStatusOverflow	3	超载
WeightStatusException	4	异常

Top

sanqingniaopb/message_params.proto

AdvancedConfigGetParams

AdvancedConfigGetParams 高级配置-获取

Field	Type	Label	Description
key	AdvancedConfigKey		配置项键名【必填】

AdvancedConfigSetParams

AdvancedConfigSetParams 高级配置-修改

Field	Type	Description
key	AdvancedConfigKey	配置项键名【必填】
doubleVal	double	双精度浮点型值
floatVal	float	单精度浮点型值
int32Val	int32	有符号32位整型值
int64Val	int64	有符号64位整型值
uint32Val	uint32	无符号32位整型值
uint64Val	uint64	无符号64位整型值
boolVal	bool	布尔型值
stringVal	string	字符串型值
bytesVal	bytes	字节切片/字节数组型值

AiFastLearningParams

AiFastLearningParams 智能识别-快速学习

Field	Type	Label	Description
sku	SkuInfo		目标商品信息【必填】

AiImageDetectIgnoreSetParams

AiImageDetectIgnoreSetParams 智能识别-图像检测过滤设置

AiLearningParams

AiLearningParams 智能识别-学习

Field	Type	Description
id	int64	识别ID【必填】
sku	SkuInfo	需要的学习商品信息【必填】
learningMode	LearningMode	学习模式【必填】
skuSaleInfo	SkuSaleInfo	商品销售信息【选填】

AiListenResultParams

AiListenResultParams 智能识别-监听识别结果

AiPushWeightParams

AiPushWeightParams 智能识别-推送重量信息

Field	Type	Description
weight	int32	重量（单位：克）【必填】
status	WeightStatus	重量状态【选填】
forceMatching	bool	是否期望对该重量进行一次强制识别【选填】
transparentData	string	透传数据，该数据会在识别结果中一同返回出来【选填】

AiRegisterResultCallbackParams

AiRegisterResultCallbackParams 智能识别-注册识别结果回调

Field	Type	Label	Description
url	string		回调地址【必填】

AlgoModelChangeParams

AlgoModelChangeParams 算法模型-模型

Field	Type	Label	Description
code	uint32		模型代号【必填】

AlgoModelEnumParams

AlgoModelEnumParams 算法模型-枚举

AutoSyncCreateGroupParams

AutoSyncCreateGroupParams 自动同步-创建分组

Field	Type	Label	Description
groupName	string		分组名称（长度不超过20个字符）【必填】

AutoSyncExitGroupParams

AutoSyncExitGroupParams 自动同步-退出分组

AutoSyncGetGroupsInfoParams

AutoSyncGetGroupsInfoParams 自动同步-获取分组表信息

AutoSyncGetSelfInfoParams

AutoSyncGetSelfInfoParams 自动同步-获取本机信息

AutoSyncJoinGroupParams

AutoSyncJoinGroupParams 自动同步-加入分组

Field	Type	Label	Description
groupID	string		分组ID【必填】
groupName	string		分组名称【必填】

AutoSyncRemoveDeviceParams

AutoSyncRemoveDeviceParams 自动同步-移除设备

Field	Type	Label	Description
groupID	string		分组ID（为空将清空所有分组）
deviceSN	string		设备SN（为空将清空指定分组）

AutoSyncSetIntervalTimeParams

AutoSyncSetIntervalTimeParams 自动同步-设置同步时间间隔

Field	Type	Label	Description
broadcastInterval	uint32		广播时间间隔(单位: 秒钟)【必填】
dataSyncInterval	uint32		数据同步时间间隔(单位: 分钟)【必填】

AutoSyncUpdateDataSyncRuleParams

AutoSyncUpdateDataSyncRuleParams 自动同步-更新数据同步规则

Field	Type	Description
dataSyncRule	AutoSyncDataSyncRule	数据同步规则【必填】
dataPullRule	LearnDataExportMode	数据拉取规则【必填】
dataImportRule	LearnDataImportMode	数据导入规则【必填】

AutoSyncUpdateGroupNameParams

AutoSyncUpdateGroupNameParams 自动同步-更新分组名称

Field	Type	Label	Description
groupName	string		分组名称（长度不超过20个字符）【必填】

CameraChangeParams

CameraChangeParams 相机-切换

Field	Type	Label	Description
id	string		要使用的相机ID【必填】
resolutionInfo	CameraResolutionInfo		要使用的相机图像分辨率【必填】

CameraDetectRangeGetParams

CameraDetectRangeGetParams 相机-识别区域获取

Field	Type	Label	Description
maxRenderWidth	uint32		最大渲染宽度（单位：像素）【必填】
maxRenderHeight	uint32		最大渲染高度（单位：像素）【必填】

CameraDetectRangeSetParams

CameraDetectRangeSetParams 相机-识别区域修改

Field	Type	Label	Description
renderWidth	uint32		实际渲染宽度（单位：像素）【必填】
renderHeight	uint32		实际渲染高度（单位：像素）【必填】
dotList	PlanePositionInfo	repeated	识别区域坐标列表（原点为图像左上角，坐标均为换算后的实际渲染值）【必填】

CameraEnumParams

CameraEnumParams 相机-枚举

CameraFrameParams

CameraFrameParams 相机-图像帧

DeviceActivateParams

DeviceActivateParams 设备-激活

Field	Type	Label	Description
activateCode	string		激活码【必填】
shop	ShopInfo		门店信息【选填】

DeviceFreeTrialParams

DeviceGetInfoParams

DeviceGetInfoParams 设备-获取信息

DeviceShopChangeParams

DeviceShopChangeParams 设备-门店修改

Field	Type	Label	Description
shopInfo	ShopInfo		门店信息【必填】

GetLatestVersionParams

GetLatestVersionReply 获取最新版本

GetVersionParams

GetVersionParams 获取版本信息

LearnDataClearParams

LearnDataClearParams 学习数据-清空

LearnDataExportParams

LearnDataExportParams 学习数据-导出

Field	Type	Label	Description
mode	LearnDataExportMode		导出模式【必填】
nodeTimestamp	int64		指定时间节点毫秒时间戳，仅增量导出有效【选填】

LearnDataImportParams

LearnDataImportParams 学习数据-导入

Field	Type	Label	Description
mode	LearnDataImportMode		导入模式【必填】
data	bytes		学习数据【必填】

LearnDataUploadParams

LearnDataUploadParams 学习数据-上传

SkuDataDeleteParams

SkuDataDeleteParams 商品数据-删除

Field	Type	Label	Description
skuList	SkuInfo	repeated	商品数据列表【必填】

SkuDataIconMatchParams

SkuDataIconMatchParams 商品数据-主图匹配

Field	Type	Label	Description
skuList	SkuInfo	repeated	商品数据列表【必填】

SkuDataImportParams

SkuDataImportParams 商品数据-导入

Field	Type	Label	Description
mode	SkuDataImportMode		商品数据导入模式【必填】
skuList	SkuStatusInfo	repeated	商品数据列表【必填】

SkuFeatClearParams

SkuFeatClearParams 商品特征-清除指定商品的所有特征

Field	Type	Label	Description
skuList	SkuInfo	repeated	商品信息【必填】

SkuFeatQueryImageParams

SkuFeatQueryImageParams 商品特征-查询图像

Field	Type	Label	Description
sku	SkuInfo		商品信息【必填】

SkuFeatQueryParams

SkuFeatQueryParams 商品特征-批量查询特征信息

Field	Type	Label	Description
skuList	SkuInfo	repeated	商品信息【必填】

SkuFeatRemoveParams

SkuFeatRemoveParams 商品特征-移除指定商品的指定特征

Field	Type	Label	Description
sku	SkuInfo		商品信息【必填】
id	int64		识别ID【必填】

Top

sanqingniaopb/message_reply.proto

AdvancedConfigGetReply

AdvancedConfigGetReply 高级配置-获取

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	AdvancedConfigGetReply.Data	响应数据

AdvancedConfigGetReply.Data

AdvancedConfigGetReply_Data 声明响应数据结构

Field	Type	Description
key	AdvancedConfigKey	配置项键名
doubleVal	double	双精度浮点型值
floatVal	float	单精度浮点型值
int32Val	int32	有符号32位整型值
int64Val	int64	有符号64位整型值
uint32Val	uint32	无符号32位整型值
uint64Val	uint64	无符号64位整型值
boolVal	bool	布尔型值
stringVal	string	字符串型值
bytesVal	bytes	字节切片/字节数组型值

AdvancedConfigSetReply

AdvancedConfigSetReply 高级配置-修改

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AiFastLearningReply

AiFastLearningReply 智能识别-快速学习

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	AiFastLearningReply.Data	响应数据

AiFastLearningReply.Data

AiFastLearningReply_Data 声明响应数据结构

Field	Type	Label	Description
featImg	SkuFeatImageInfo		商品特征图像信息

AiImageDetectIgnoreSetReply

AiImageDetectIgnoreSetReply 智能识别-图像检测过滤设置

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	AiImageDetectIgnoreSetReply.Data	响应数据

AiImageDetectIgnoreSetReply.Data

AiImageDetectIgnoreSetReply_Data 声明响应数据结构

Field	Type	Label	Description
path	string		图片HTTP访问路径

AiLearningReply

AiLearningReply 智能识别-学习

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AiListenResultReply

AiListenResultReply 智能识别-监听识别结果

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	AiListenResultReply.Data	响应数据

AiListenResultReply.Data

AiListenResultReply_Data 声明响应数据结构

Field	Type	Label	Description
id	int64		识别ID
skuList	SkuInfo	repeated	识别结果列表
transparentData	string		透传数据，该数据来源于重量推送接口

AiPushWeightReply

AiPushWeightReply 智能识别-推送重量信息

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AiRegisterResultCallbackReply

AiRegisterResultCallbackReply 智能识别-注册识别结果回调

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AlgoModelChangeReply

AlgoModelChangeReply 算法模型-切换

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AlgoModelEnumReply

AlgoModelEnumReply 算法模型-枚举

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	AlgoModelEnumReply.Data	响应数据

AlgoModelEnumReply.Data

AlgoModelEnumReply_Data 声明响应数据结构

Field	Type	Label	Description
modelList	AlgoModelInfo	repeated	模型列表
model	AlgoModelInfo		当前使用的模型

AutoSyncCreateGroupReply

AutoSyncCreateGroupParams 自动同步-创建分组

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AutoSyncExitGroupReply

AutoSyncExitGroupParams 自动同步-退出分组

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AutoSyncGetGroupsInfoReply

AutoSyncGetGroupsInfoParams 自动同步-获取分组表信息

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	AutoSyncGetGroupsInfoReply.Data	响应数据

AutoSyncGetGroupsInfoReply.Data

AutoSyncGetGroupsInfoReply_Data 声明响应数据结构

Field	Type	Label	Description
groups	AutoSyncGroupInfo	repeated	分组表

AutoSyncGetSelfInfoReply

AutoSyncGetSelfInfoParams 自动同步-获取本机信息

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	AutoSyncGetSelfInfoReply.Data	响应数据

AutoSyncGetSelfInfoReply.Data

AutoSyncGetSelfInfoReply_Data 声明响应数据结构

Field	Type	Description
deviceSN	string	本机SN
hostName	string	本机主机名
systemType	SystemType	本机系统类型
algoModelCode	uint32	本机使用的算法模型代号
groupID	string	本机所属分组ID
groupName	string	本机所属分组名称
dataSyncRule	AutoSyncDataSyncRule	本机数据同步规则
dataPullRule	LearnDataExportMode	本机数据拉取规则
dataImportRule	LearnDataImportMode	本机数据导入规则
groupUpdateAt	uint64	分组信息最新更新时间(毫秒时间戳)
broadcastInterval	uint32	本机广播时间间隔（秒）
pullInterval	uint32	本机数据拉取间隔（分）

AutoSyncJoinGroupReply

AutoSyncJoinGroupParams 自动同步-加入分组

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AutoSyncRemoveDeviceReply

AutoSyncRemoveDeviceParams 自动同步-移除设备

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AutoSyncSetIntervalTimeReply

AutoSyncSetIntervalTimeParams 自动同步-设置同步时间间隔

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AutoSyncUpdateDataSyncRuleReply

AutoSyncUpdateDataSyncRuleParams 自动同步-更新数据同步规则

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

AutoSyncUpdateGroupNameReply

AutoSyncUpdateGroupNameParams 自动同步-更新分组名称

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

CameraChangeReply

CameraChangeReply 相机-切换

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

CameraDetectRangeGetReply

CameraDetectRangeGetReply 相机-识别区域获取

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	CameraDetectRangeGetReply.Data	响应数据

CameraDetectRangeGetReply.Data

CameraDetectRangeGetReply_Data 声明响应数据结构

Field	Type	Label	Description
renderWidth	uint32		实际渲染宽度（单位：像素）
renderHeight	uint32		实际渲染高度（单位：像素）
dotList	PlanePositionInfo	repeated	识别区域坐标列表（原点为图像左上角，坐标均为换算后的实际渲染值）

CameraDetectRangeSetReply

CameraDetectRangeSetReply 相机-识别区域修改

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

CameraEnumReply

CameraEnumReply 相机-枚举

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	CameraEnumReply.Data	响应数据

CameraEnumReply.Data

CameraEnumReply_Data 声明响应数据结构

Field	Type	Label	Description
cameraList	CameraInfo	repeated	相机列表
id	string		当前使用的相机ID
resolutionInfo	CameraResolutionInfo		当前使用的相机图像分辨率

CameraFrameReply

CameraFrameReply 相机-图像帧

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	CameraFrameReply.Data	响应数据

CameraFrameReply.Data

CameraFrameReply_Data 声明响应数据结构

Field	Type	Description
imageData	bytes	图像数据
imageWidth	uint32	图像原始宽度
imageHeight	uint32	图像原始高度

DeviceActivateReply

DeviceActivateReply 设备-激活

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	DeviceActivateReply.Data	响应数据

DeviceActivateReply.Data

DeviceActivateReply_Data 声明响应数据结构

Field	Type	Label	Description
deviceInfo	DeviceInfo		设备信息

DeviceFreeTrialReply

DeviceFreeTrialReply 设备-免费试用

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

DeviceGetInfoReply

DeviceGetInfoReply 设备-获取信息

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	DeviceGetInfoReply.Data	响应数据

DeviceGetInfoReply.Data

DeviceGetInfoReply_Data 声明响应数据结构

Field	Type	Label	Description
deviceInfo	DeviceInfo		设备信息

DeviceShopChangeReply

DeviceShopChangeReply 设备-门店修改

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

GetLatestVersionReply

GetLatestVersionReply 获取最新版本

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	GetLatestVersionReply.Data	响应数据

GetLatestVersionReply.Data

GetLatestVersionReply_Data 声明响应数据结构

Field	Type	Label	Description
updateType	VersionUpdateType		版本更新类型
updateContent	string		更新内容
versionList	VersionDownloadInfo	repeated	版本列表

GetVersionReply

GetVersionReply 获取版本信息

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	GetVersionReply.Data	响应数据

GetVersionReply.Data

GetVersionReply_Data 声明响应数据结构

Field	Type	Label	Description
versionList	VersionInfo	repeated	版本信息列表

LearnDataClearReply

LearnDataClearReply 学习数据-清空

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

LearnDataExportReply

LearnDataExportReply 学习数据-导出

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	LearnDataExportReply.Data	响应数据

LearnDataExportReply.Data

LearnDataExportReply_Data 声明响应数据结构

Field	Type	Description
successCount	int64	成功导出数量
nodeTimestamp	int64	本次导出的时间节点
data	bytes	学习数据

LearnDataImportReply

LearnDataImportReply 学习数据-导入

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	LearnDataImportReply.Data	响应数据

LearnDataImportReply.Data

LearnDataImportReply_Data 声明响应数据结构

Field	Type	Label	Description
successCount	int64		成功导入数量

LearnDataUploadReply

LearnDataUploadReply 学习数据-上传

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

SkuDataDeleteReply

SkuDataDeleteReply 商品数据-删除

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

SkuDataIconMatchReply

SkuDataIconMatchReply 商品数据-主图匹配

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	SkuDataIconMatchReply.Data	响应数据

SkuDataIconMatchReply.Data

SkuDataIconMatchReply_Data 声明响应数据结构

Field	Type	Label	Description
downloadUrlPrefix	string		ICON下载路径前缀
skuIconList	SkuIconInfo	repeated	商品ICON信息列表

SkuDataImportReply

SkuDataImportReply 商品数据-导入

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

SkuFeatClearReply

SkuFeatClearReply 商品特征-清除指定商品的所有特征

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

SkuFeatQueryImageReply

SkuFeatQueryImageReply 商品特征-查询图像

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	SkuFeatQueryImageReply.Data	响应数据

SkuFeatQueryImageReply.Data

SkuFeatQueryImageReply_Data 声明响应数据结构

Field	Type	Label	Description
featImgList	SkuFeatImageInfo	repeated	商品特征图像列表

SkuFeatQueryReply

SkuFeatQueryReply 商品特征-批量查询特征信息

Field	Type	Description
code	StatusCode	状态码
msg	string	状态描述
data	SkuFeatQueryReply.Data	响应数据

SkuFeatQueryReply.Data

SkuFeatQueryReply_Data 声明响应数据结构

Field	Type	Label	Description
featNumList	SkuFeatNumberInfo	repeated	商品特征数量列表

SkuFeatRemoveReply

SkuFeatRemoveReply 商品特征-移除指定商品的指定特征

Field	Type	Label	Description
code	StatusCode		状态码
msg	string		状态描述

StatusCode

StatusCode 状态码定义

Name	Number	Description
ErrUnknow	0	未知异常
Success	1	成功
ErrPciNetCardDisabled	1000	设备PCI网卡已被禁用
ErrCamera	1001	设备相机异常
ErrImageDecode	1002	图像解码失败
ErrImageEncode	1003	图像编码失败
ErrNetwork	1004	网络异常，请联网
ErrCloudServer	1005	云服务器异常
ErrInputParam	1006	输入参数异常
ErrExportLearnDataEmpty	1007	导出学习数据为空
ErrDeviceNotActivate	1500	设备未激活
ErrDeviceActivateExpire	1501	设备激活状态已过期
ErrDeviceSystemTime	1503	设备系统时间异常
ErrDeviceRepeatFreeTrial	1504	设备禁止重复试用
ErrErLangShenAlgo	2000	二郎神算法异常
ErrBaiZeAlgo	2500	白泽算法异常

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)

SanQingNiaoApi#

sanqingniaopb/message_common.proto#

ActivateInfo#

AlgoModelInfo#

AutoSyncDeviceInfo#

AutoSyncGroupInfo#

CameraInfo#

CameraResolutionInfo#

DeviceInfo#

PlanePositionInfo#

ShopInfo#

SkuFeatImageInfo#

SkuFeatNumberInfo#

SkuIconInfo#

SkuInfo#

SkuSaleInfo#

SkuStatusInfo#

VendorInfo#

VersionDownloadInfo#

VersionInfo#

ActivateCodeType#

AdvancedConfigKey#

AutoSyncDataSyncRule#

LearnDataExportMode#

LearnDataImportMode#

LearningMode#

SkuDataImportMode#

SkuStatus#

SystemType#

VersionUpdateType#

WeightStatus#

sanqingniaopb/message_params.proto#

AdvancedConfigGetParams#

AdvancedConfigSetParams#

AiFastLearningParams#

AiImageDetectIgnoreSetParams#

AiLearningParams#

AiListenResultParams#

AiPushWeightParams#

AiRegisterResultCallbackParams#

AlgoModelChangeParams#

AlgoModelEnumParams#

AutoSyncCreateGroupParams#

AutoSyncExitGroupParams#

AutoSyncGetGroupsInfoParams#

AutoSyncGetSelfInfoParams#

AutoSyncJoinGroupParams#

AutoSyncRemoveDeviceParams#

AutoSyncSetIntervalTimeParams#

AutoSyncUpdateDataSyncRuleParams#

AutoSyncUpdateGroupNameParams#

CameraChangeParams#

CameraDetectRangeGetParams#

CameraDetectRangeSetParams#

CameraEnumParams#

CameraFrameParams#

DeviceActivateParams#

DeviceFreeTrialParams#

DeviceGetInfoParams#

DeviceShopChangeParams#

GetLatestVersionParams#

GetVersionParams#

LearnDataClearParams#

LearnDataExportParams#

LearnDataImportParams#

LearnDataUploadParams#

SkuDataDeleteParams#

SkuDataIconMatchParams#

SkuDataImportParams#

SkuFeatClearParams#

SkuFeatQueryImageParams#

SkuFeatQueryParams#

SkuFeatRemoveParams#

sanqingniaopb/message_reply.proto#

AdvancedConfigGetReply#

AdvancedConfigGetReply.Data#

AdvancedConfigSetReply#

AiFastLearningReply#

AiFastLearningReply.Data#