gRPC interface documentation

SanQingNiaoApi

SanQingNiaoApi is the API interface of the Three Blue Birds

Method Name	Request Type	Response Type	Description
GetVersion	GetVersionParams	GetVersionReply	GetVersion to get version information Permissions: 1. Any activation status can be called
GetLatestVersion	GetLatestVersionParams	GetLatestVersionReply	GetLatestVersion to get the latest version Permissions: 1. Only the activated state can be called
AdvancedConfigGet	AdvancedConfigGetParams	AdvancedConfigGetReply	AdvancedConfigGet - Get Permissions: 1. Any activation status can be called Illustrate: 1. All configuration items are persisted and stored by the SDK, and no external storage is required
AdvancedConfigSet	AdvancedConfigSetParams	AdvancedConfigSetReply	AdvancedConfigSet - Modify Permissions: 1. Any activation status can be called Illustrate: 1. All configuration items are persisted and stored by the SDK, and no external storage is required
CameraEnum	CameraEnumParams	CameraEnumReply	CameraEnum Camera-Enumeration device Permissions: 1. Any activation status can be called
CameraChange	CameraChangeParams	CameraChangeReply	CameraChange camera-to-device switching Permissions: 1. Any activation status can be called
CameraFrame	CameraFrameParams	CameraFrameReply	CameraFrame Camera-Image frame Permissions: 1. Any activation status can be called
CameraDetectRangeGet	CameraDetectRangeGetParams	CameraDetectRangeGetReply	CameraDetectRangeGet Camera-Recognition Area Get Permissions: 1. Any activation status can be called
CameraDetectRangeSet	CameraDetectRangeSetParams	CameraDetectRangeSetReply	CameraDetectRangeSet Camera-Recognition Area Modification Permissions: 1. Any activation status can be called
DeviceGetInfo	DeviceGetInfoParams	DeviceGetInfoReply	DeviceGetInfo Device - Get information Permissions: 1. Any activation status can be called
DeviceActivate	DeviceActivateParams	DeviceActivateReply	DeviceActivate Device - Activate Permissions: 1. Any activation status can be called
DeviceShopChange	DeviceShopChangeParams	DeviceShopChangeReply	DeviceShopChange Device - Store Modification Permissions: 1. Only the activated state can be called
AiPushWeight	AiPushWeightParams	AiPushWeightReply	AiPushWeight Intelligent Recognition - Push weight information Permissions: 1. Only the activated state can be called
AiImageDetectIgnoreSet	AiImageDetectIgnoreSetParams	AiImageDetectIgnoreSetReply	AiImageDetectIgnoreSet - Image Detection Filtering Settings Permissions: 1. Only the activated state can be called
AiListenResult	AiListenResultParams	AiListenResultReply stream	AiListenResult Intelligent Recognition - Listens for the recognition results Permissions: 1. Only the activated state can be called 2. You can choose one of the AiListenResult and AiRegisterResultCallback interfaces
AiRegisterResultCallback	AiRegisterResultCallbackParams	AiRegisterResultCallbackReply	AiRegisterResultCallback - Callback for registration and recognition results Permissions: 1. Only the activated state can be called 2. You can choose one of the AiListenResult and AiRegisterResultCallback interfaces
AiUnsafeMatching	AiPushWeightParams	AiListenResultReply	AiUnsafeMatching Intelligent Recognition - Non-Security AI Recognition (Strongly Not Recommended) Permissions: 1. Only the activated state can be called Illustrate: 1. Please do not use this interface unless it is a special case, as it cannot guarantee the use effect of the whole life cycle
AiLearning	AiLearningParams	AiLearningReply	AiLearning Permissions: 1. Only the activated state can be called
AiFastLearning	AiFastLearningParams	AiFastLearningReply	AiFastLearning Intelligent Recognition - Fast Learning Permissions: 1. Only the activated state can be called
SkuFeatQueryImage	SkuFeatQueryImageParams	SkuFeatQueryImageReply	SkuFeatQueryImage Product Features - Queries the learned image Permissions: 1. Only the activated state can be called
SkuFeatQuery	SkuFeatQueryParams	SkuFeatQueryReply	SkuFeatQuery Commodity Characteristics - Query feature information Permissions: 1. Only the activated state can be called
SkuFeatRemove	SkuFeatRemoveParams	SkuFeatRemoveReply	SkuFeatRemove Product Characteristics - Removes the specified characteristics of the specified product Permissions: 1. Only the activated state can be called
SkuFeatClear	SkuFeatClearParams	SkuFeatClearReply	SkuFeatClear Product Features - Clears all characteristics of the specified product Permissions: 1. Only the activated state can be called
LearnDataImport	LearnDataImportParams	LearnDataImportReply	LearnDataImport Learning Data - Import Permissions: 1. Only the activated state can be called
LearnDataExport	LearnDataExportParams	LearnDataExportReply	LearnDataExport - Export Permissions: 1. Only the activated state can be called
LearnDataUpload	LearnDataUploadParams	LearnDataUploadReply	LearnDataUpload Learning Data - Upload Permissions: 1. Only the activated state can be called
LearnDataClear	LearnDataClearParams	LearnDataClearReply	LearnDataClear Learning Data - Clear Permissions: 1. Only the activated state can be called
AlgoModelEnum	AlgoModelEnumParams	AlgoModelEnumReply	AlgoModelEnum Algorithm Model-Enumeration Permissions: 1. Only the activated state can be called
AlgoModelChange	AlgoModelChangeParams	AlgoModelChangeReply	AlgoModelChange algorithm model-switching Permissions: 1. Only the activated state can be called
SkuDataImport	SkuDataImportParams	SkuDataImportReply	SkuDataImport Product Data - Import Permissions: 1. Only the activated state can be called
SkuDataDelete	SkuDataDeleteParams	SkuDataDeleteReply	SkuDataDelete Product Data - Delete Permissions: 1. Only the activated state can be called
SkuDataIconMatch	SkuDataIconMatchParams	SkuDataIconMatchReply	SkuDataIconMatch Product Data - Main Image Match Permissions: 1. Only the activated state can be called
AutoSyncGetSelfInfo	AutoSyncGetSelfInfoParams	AutoSyncGetSelfInfoReply	AutoSyncGetSelfInfo - Get native information Permissions: 1. Only the activated state can be called
AutoSyncGetGroupsInfo	AutoSyncGetGroupsInfoParams	AutoSyncGetGroupsInfoReply	AutoSyncGetGroupsInfo - Get group table information Permissions: 1. Only the activated state can be called
AutoSyncRemoveDevice	AutoSyncRemoveDeviceParams	AutoSyncRemoveDeviceReply	AutoSyncRemoveDevice - Remove the device Permissions: 1. Only the activated state can be called
AutoSyncJoinGroup	AutoSyncJoinGroupParams	AutoSyncJoinGroupReply	AutoSyncJoinGroup Auto-sync-join group Permissions: 1. Only the activated state can be called
AutoSyncExitGroup	AutoSyncExitGroupParams	AutoSyncExitGroupReply	AutoSyncExitGroup Auto-sync-exit group Permissions: 1. Only the activated state can be called
AutoSyncSetIntervalTime	AutoSyncSetIntervalTimeParams	AutoSyncSetIntervalTimeReply	AutoSyncSetIntervalTime - Set the interval time Permissions: 1. Only the activated state can be called
AutoSyncUpdateDataSyncRule	AutoSyncUpdateDataSyncRuleParams	AutoSyncUpdateDataSyncRuleReply	AutoSyncUpdateDataSyncRule - Updates the data synchronization rule Permissions: 1. Only the activated state can be called
AutoSyncCreateGroup	AutoSyncCreateGroupParams	AutoSyncCreateGroupReply	AutoSyncCreateGroup - Creates a group Permissions: 1. Only the activated state can be called
AutoSyncUpdateGroupName	AutoSyncUpdateGroupNameParams	AutoSyncUpdateGroupNameReply	AutoSyncUpdateGroupName Auto Sync - Updates the group name Permissions: 1. Only the activated state can be called

Top

sanqingniaopb/message_common.proto

ActivateInfo

ActivateInfo device activation information

Field	Type	Label	Description
activateCode	string		Activation code
activateExpireTime	int64		Activate the expiration time

AlgoModelInfo

AlgoModelInfo algorithm model information

Field	Type	Label	Description
code	uint32		Model code
name	string		The name of the model

AutoSyncDeviceInfo

AutoSyncDeviceInfo automatically synchronizes device information

Field	Type	Label	Description
deviceSN	string		Device SN
hostName	string		host name
systemType	SystemType		System type
algoModel	uint32		Algorithmic models
servicePort	uint32		Service port number
ipAddrList	string	repeated	List of IP addresses
dataSyncRule	AutoSyncDataSyncRule		Data synchronization rules
status	bool		Device status (false: offline, true: online)
latestPullAt	uint64		Learn when the data was last pulled

AutoSyncGroupInfo

AutoSyncGroupInfo automatically synchronizes group information

Field	Type	Label	Description
groupID	string		Group ID
groupName	string		Group name
groupUpdateAt	uint64		The time when the group information is updated
deviceInfoList	AutoSyncDeviceInfo	repeated	A list of devices

CameraInfo

CameraInfo camera information

Field	Type	Label	Description
id	string		Camera ID
name	string		Camera name
usbPath	string		Device USB path
sysPath	string		Device system path
resolutionInfoList	CameraResolutionInfo	repeated	A list of supported resolutions

CameraResolutionInfo

CameraResolutionInfo Camera resolution information

Field	Type	Label	Description
width	uint32		Image Width (pixels)
height	uint32		Image height (pixels)
fps	uint32		Image frame rate (frames/sec)

DeviceInfo

DeviceInfo device information

Field	Type	Label	Description
deviceSN	string		Device SN
activateInfo	ActivateInfo		Activation Information
shop	ShopInfo		Store information

PlanePositionInfo

PlanePositionInfo plane coordinate information

Field	Type	Label	Description
x	uint32		X-axis coordinate value
y	uint32		Y-axis coordinate value

ShopInfo

ShopInfo store information

Field	Type	Label	Description
code	string		Store code [no modification allowed]
name	string		The name of the store
scaleAlias	string		Scale number alias
externalCode	string		External store code

SkuFeatImageInfo

SkuFeatImageInfo Product feature image information

Field	Type	Label	Description
id	int64		Identification ID
path	string		The HTTP access path of the image

SkuFeatNumberInfo

SkuFeatNumberInfo Quantity information for product characteristics

Field	Type	Label	Description
sku	SkuInfo		Product information
number	uint64		Number of features

SkuIconInfo

SkuIconInfo product main image information

Field	Type	Label	Description
sku	SkuInfo		Product information
iconList	string	repeated	A list of the main images of the matched products
keywordList	string	repeated	A list of keywords that were matched
preLearningLabel	int32		Matched product pre-learning tags

SkuInfo

SkuInfo listings

Field	Type	Label	Description
code	string		Product unique identifier
name	string		The title of the product
spuCode	string		Product parent code (if spuCode==code or spuCode is empty, the product is a top-level product)

SkuSaleInfo

SkuSaleInfo product sales information

Field	Type	Label	Description
sales	int32		Sales: weight (grams), quantity
priceUnit	int32		Pricing method (0-weight pricing, 1-quantity pricing)
price	int32		Original unit price (min/kg)
salePrice	int32		Sales unit price (min/kg)
amount	int32		Total sales price (min)
barCode	string		Barcodes
priceChangeMode	int32		Whether the price of the product has been changed (0 - no price change, 1 - unit price, 2 - total price)
priceType	int32		Price type (1 - regular price, 2 - temporary price change, 3 - permanent price change, 4 - Tiered price change)

SkuStatusInfo

SkuStatusInfo Listing status information

Field	Type	Label	Description
sku	SkuInfo		Product information
status	SkuStatus		The status of the item

VendorInfo

VendorInfo vendor information

Field	Type	Label	Description
code	string		Authorization code
key	string		Authorization key

VersionDownloadInfo

VersionInfo version download information

Field	Type	Label	Description
versionInfo	VersionInfo		Version information
url	string		Download link

VersionInfo

VersionInfo version information

Field	Type	Label	Description
appType	uint32		The type of application
version	string		Version number
internalVersion	string		Build number

AdvancedConfigKey

AdvancedConfigKey

Name	Number	Description
DetectMode	0	Detection mode (value range: 0 - weight detection, 1 - image detection; Assignment field: uint32Val)
WeightDetectMode	1	Weight detection mode (value range: 0 - after meeting the minimum recognition weight; Assignment field: uint32Val)
WeightDetectMinValue	2	Weight detection minimum trigger weight (unit: grams; Value range: closed interval [1,10000]; Assignment field: uint32Val)
WeightDetectAppendMinValue	3	Weight detection: The minimum trigger weight (unit: grams) is added to the product stack. Value range: closed interval [1,10000]; Assignment field: uint32Val)
WeightDetectStatusJudgment	4	Weight detection status judgment mode (value range: 0-external incoming, 1-internal automatic; Assignment field: uint32Val)
WeightDetectCameraDelay	5	Gravimetric camera photography delay time (unit: milliseconds; Value range: closed interval [0,5000]; Assignment field: uint32Val)
ImageDetectMode	20	Image detection mode (value range: 0-feature similarity; Assignment field: uint32Val)
ImageDetectIgnoreThreshold	21	Image detection ignores the similarity threshold (value range: closed interval [0,1000]; Assignment field: uint32Val)
ImageDetectStableNumber	22	Number of stable statistics of image detection features (value range: closed interval [2,20]; Assignment field: uint32Val)
ImageDetectStableThreshold	23	Stable similarity threshold of image detection features (value range: closed interval [0,1000]; Assignment field: uint32Val)
ImageDetectRepeatThreshold	24	Repeat similarity threshold for image detection features (value range: closed interval [0,1000]; Assignment field: uint32Val)
ImageDetectInterval	25	Image detection interval time (unit: milliseconds; Value range: closed interval [0,5000]; Assignment field: uint32Val)
MaxOutputNum	100	Maximum number of recognition outputs (value range: closed interval [1,10]; Assignment field: uint32Val)
PerformanceMode	101	Inference Engine Processor Usage Mode (Value range: 0-Balanced mode, 1-Performance mode; Assignment field: uint32Val)
PreLearnSwitch	102	Pre-learning switch (value range: true-on, false-off; Assignment field: boolVal)

AutoSyncDataSyncRule

AutoSyncDataSyncRule automatically synchronizes data synchronization rules

Name	Number	Description
AutoSyncDataSyncRuleDisable	0	Automatic Synchronization of Data Synchronization Rules: Disables data synchronization
AutoSyncDataSyncRuleDuplex	1	Automatic Synchronization Data Synchronization Rules: Bidirectional data synchronization
AutoSyncDataSyncRuleOnlySend	2	Auto-sync data synchronization rule: Only send data
AutoSyncDataSyncRuleOnlyReceive	3	Auto-sync data synchronization rules: Receive data only

LearnDataExportMode

LearnDataExportMode to learn the data export mode

Name	Number	Description
LearnDataExportModeFull	0	Full export
LearnDataExportModeIncrSku	1	Incremental export of product dimensions
LearnDataExportModeIncrFeat	2	Feature dimension incremental export

LearnDataImportMode

LearnDataImportMode Learn the data import mode

Name	Number	Description
LearnDataImportModeFull	0	Full import
LearnDataImportModeIncrSku	1	Incremental import of product dimensions
LearnDataImportModeIncrFeat	2	Feature dimension incremental import
LearnDataImportModeStrictFull	3	Full import in strict mode
LearnDataImportModeStrictIncrSku	4	Strict mode product dimension incremental import
LearnDataImportModeStrictIncrFeat	5	Strict mode feature dimension incremental import

LearningMode

LearningMode

Name	Number	Description
LearningModeSearch	0	Use search to learn
LearningModeShortcut	1	Use shortcuts to learn
LearningModeOutput	2	Learn using the output
LearningModeSkip	3	Skip learning

SkuDataImportMode

SkuDataImportMode Product data import mode

Name	Number	Description
SkuDataImportModeIncr	0	Incremental imports
SkuDataImportModeFull	1	Full import

SkuStatus

SkuStatus Status

Name	Number	Description
SkuStatusNone	0	does not exist
SkuStatusNormal	1	normal
SkuStatusTemporaryLock	2	Temporary lock
SkuStatusPermanentLock	3	Permanently locked

SystemType

SystemType

Name	Number	Description
SystemTypeUnknown	0
SystemTypeWindows	1
SystemTypeLinux	2
SystemTypeAndroid	3

VersionUpdateType

VersionUpdateType

Name	Number	Description
VersionUpdateTypeUnknown	0	Unknown
VersionUpdateTypeOptional	1	Optional updates
VersionUpdateTypeQuiet	2	Silent updates
VersionUpdateTypeForce	3	Mandatory updates

WeightStatus

WeightStatus

Name	Number	Description
WeightStatusUnstable	0	instability
WeightStatusStable	1	stable
WeightStatusUnder	2	Underload
WeightStatusOverflow	3	overload
WeightStatusException	4	abnormal

Top

sanqingniaopb/message_params.proto

AdvancedConfigGetParams

AdvancedConfigGetParams - Get

Field	Type	Label	Description
key	AdvancedConfigKey		Configuration item key name【Required】

AdvancedConfigSetParams

AdvancedConfigSetParams Advanced Configuration - Modify

Field	Type	Label	Description
key	AdvancedConfigKey		Configuration item key name【Required】
doubleVal	double		Double-precision floating-point value
floatVal	float		Single-precision floating-point value
int32Val	int32		Signed 32-bit integer values
int64Val	int64		Signed 64-bit integer value
uint32Val	uint32		Unsigned 32-bit integer values
uint64Val	uint64		Unsigned 64-bit integer value
boolVal	bool		Boolean values
stringVal	string		String-type values
bytesVal	bytes		Byte slices/byte arrays

AiFastLearningParams

AiFastLearningParams Intelligent Recognition - Fast Learning

Field	Type	Label	Description
sku	SkuInfo		Target product information [required]

AiImageDetectIgnoreSetParams

AiImageDetectIgnoreSetParams Smart Recognition - Image Detection Filtering Settings

AiLearningParams

AiLearningParams Intelligent Recognition-Learning

Field	Type	Label	Description
id	int64		Identification ID【Required】
sku	SkuInfo		Required Learning Product Information【Required】
learningMode	LearningMode		Study Mode【Required】
skuSaleInfo	SkuSaleInfo		Product sales information [optional]

AiListenResultParams

AiListenResultParams Intelligent Recognition - Listens to the recognition results

AiPushWeightParams

AiPushWeightParams intelligently identifies and pushes weight information

Field	Type	Label	Description
weight	int32		Weight (unit: grams)【Required】
status	WeightStatus		Weight Status【Optional】
forceMatching	bool		Whether or not you want to make a mandatory identification of this weight (optional)
transparentData	string		Transparent data, which will be returned together in the recognition result [optional]

AiRegisterResultCallbackParams

AiRegisterResultCallbackParams - Callback for registration and recognition results

Field	Type	Label	Description
url	string		Callback address【required】

AlgoModelChangeParams

AlgoModelChangeParams Algorithmic Model - Model

Field	Type	Label	Description
code	uint32		Model Code【Required】

AlgoModelEnumParams

AlgoModelEnumParams Algorithm Model - Enum

AutoSyncCreateGroupParams

AutoSyncCreateGroupParams Auto Sync - Create a group

Field	Type	Label	Description
groupName	string		Group Name (up to 20 characters in length) [required]

AutoSyncExitGroupParams

AutoSyncExitGroupParams Auto-sync-exit group

AutoSyncGetGroupsInfoParams

AutoSyncGetGroupsInfoParams Auto Sync - Get group table information

AutoSyncGetSelfInfoParams

AutoSyncGetSelfInfoParams Auto Sync - Get native information

AutoSyncJoinGroupParams

AutoSyncJoinGroupParams Auto-sync-join group

Field	Type	Label	Description
groupID	string		Group ID【Required】
groupName	string		Group Name【Required】

AutoSyncRemoveDeviceParams

AutoSyncRemoveDeviceParams Auto Sync - Remove the device

Field	Type	Label	Description
groupID	string		Group ID (blank will clear all groups)
deviceSN	string		Device SN (Empty will clear the specified group)

AutoSyncSetIntervalTimeParams

AutoSyncSetIntervalTimeParams - Sets the synchronization interval

Field	Type	Label	Description
broadcastInterval	uint32		Broadcast Time Interval (Unit: Seconds)【Required】
dataSyncInterval	uint32		Data Synchronization Interval (Unit: Minutes)【Required】

AutoSyncUpdateDataSyncRuleParams

AutoSyncUpdateDataSyncRuleParams Auto Sync - Updates the data synchronization rule

Field	Type	Label	Description
dataSyncRule	AutoSyncDataSyncRule		Data Synchronization Rules [Required]
dataPullRule	LearnDataExportMode		Data Pull Rules [Required]
dataImportRule	LearnDataImportMode		Data Import Rules [Required]

AutoSyncUpdateGroupNameParams

AutoSyncUpdateGroupNameParams Auto Sync - Update the group name

Field	Type	Label	Description
groupName	string		Group Name (up to 20 characters in length) [required]

CameraChangeParams

CameraChangeParams Camera-toggle

Field	Type	Label	Description
id	string		Camera ID to be used【Required】
resolutionInfo	CameraResolutionInfo		Camera image resolution to be used [required]

CameraDetectRangeGetParams

CameraDetectRangeGetParams Camera-Recognition Area Acquisition

Field	Type	Label	Description
maxRenderWidth	uint32		Maximum Render Width (Unit: Pixels) [Required]
maxRenderHeight	uint32		Maximum Render Height (Unit: Pixel) [Required]

CameraDetectRangeSetParams

CameraDetectRangeSetParams Camera - Recognize Area Modification

Field	Type	Label	Description
renderWidth	uint32		Actual Rendering Width (Unit: Pixel) [Required]
renderHeight	uint32		Actual Render Height (Unit: Pixel) [Required]
dotList	PlanePositionInfo	repeated	List of coordinates of the recognition area (the origin is the upper left corner of the image, and the coordinates are the actual rendered values after conversion) [required]

CameraEnumParams

CameraEnumParams Camera-enumeration

CameraFrameParams

CameraFrameParams Camera-Image Frame

DeviceActivateParams

DeviceActivateParams Device - Activated

Field	Type	Label	Description
activateCode	string		Activation Code [Required]
shop	ShopInfo		Store Information【Optional】

DeviceGetInfoParams

DeviceGetInfoParams Device - Get information

DeviceShopChangeParams

DeviceShopChangeParams Device-Store Modification

Field	Type	Label	Description
shopInfo	ShopInfo		Store Information【Required】

GetLatestVersionParams

GetLatestVersionReply to get the latest version

GetVersionParams

GetVersionParams to get the version information

LearnDataClearParams

LearnDataClearParams Learning Data - Cleared

LearnDataExportParams

LearnDataExportParams Learning Data - Export

Field	Type	Label	Description
mode	LearnDataExportMode		Export Mode【Required】
nodeTimestamp	int64		Specify the millisecond timestamp of the time node, only the incremental export is valid [optional]

LearnDataImportParams

LearnDataImportParams Learning Data - Import

Field	Type	Label	Description
mode	LearnDataImportMode		Import Mode【Required】
data	bytes		Learning Data [Required]

LearnDataUploadParams

LearnDataUploadParams Learning Data - Upload

SkuDataDeleteParams

SkuDataDeleteParams Product Data - Delete

Field	Type	Label	Description
skuList	SkuInfo	repeated	Product Data List (required)

SkuDataIconMatchParams

SkuDataIconMatchParams Product Data - Main Image Match

Field	Type	Label	Description
skuList	SkuInfo	repeated	Product Data List (required)

SkuDataImportParams

SkuDataImportParams Product Data - Import

Field	Type	Label	Description
mode	SkuDataImportMode		Product Data Import Mode [Required]
skuList	SkuStatusInfo	repeated	Product Data List (required)

SkuFeatClearParams

SkuFeatClearParams Product Characteristics - Clears all characteristics of the specified product

Field	Type	Label	Description
skuList	SkuInfo	repeated	Product Information [Required]

SkuFeatQueryImageParams

SkuFeatQueryImageParams Product Features - Query Image

Field	Type	Label	Description
sku	SkuInfo		Product Information [Required]

SkuFeatQueryParams

SkuFeatQueryParams Product Characteristics - Query feature information in batches

Field	Type	Label	Description
skuList	SkuInfo	repeated	Product Information [Required]

SkuFeatRemoveParams

SkuFeatRemoveParams Product Features - Removes the specified characteristics of the specified product

Field	Type	Label	Description
sku	SkuInfo		Product Information [Required]
id	int64		Identification ID【Required】

Top

sanqingniaopb/message_reply.proto

AdvancedConfigGetReply

AdvancedConfigGetReply Advanced Config - Get

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	AdvancedConfigGetReply.Data		Response data

AdvancedConfigGetReply.Data

AdvancedConfigGetReply_Data Declare the response data structure

Field	Type	Label	Description
key	AdvancedConfigKey		The key name of the configuration item
doubleVal	double		Double-precision floating-point value
floatVal	float		Single-precision floating-point value
int32Val	int32		Signed 32-bit integer values
int64Val	int64		Signed 64-bit integer value
uint32Val	uint32		Unsigned 32-bit integer values
uint64Val	uint64		Unsigned 64-bit integer value
boolVal	bool		Boolean values
stringVal	string		String-type values
bytesVal	bytes		Byte slices/byte arrays

AdvancedConfigSetReply

AdvancedConfigSetReply Advanced Config - Modify

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AiFastLearningReply

AiFastLearningReply Intelligent Recognition - Fast Learning

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	AiFastLearningReply.Data		Response data

AiFastLearningReply.Data

AiFastLearningReply_Data Declare the response data structure

Field	Type	Label	Description
featImg	SkuFeatImageInfo		Product feature image information

AiImageDetectIgnoreSetReply

AiImageDetectIgnoreSetReply Smart Recognition - Image Detection Filter Settings

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	AiImageDetectIgnoreSetReply.Data		Response data

AiImageDetectIgnoreSetReply.Data

AiImageDetectIgnoreSetReply_Data Declare the response data structure

Field	Type	Label	Description
path	string		The HTTP access path of the image

AiLearningReply

AiLearningReply intelligently recognizes-learns

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AiListenResultReply

AiListenResultReply Intelligent Recognition - Listens for the recognition results

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	AiListenResultReply.Data		Response data

AiListenResultReply.Data

AiListenResultReply_Data Declare the response data structure

Field	Type	Label	Description
id	int64		Identification ID
skuList	SkuInfo	repeated	Identify the list of results
transparentData	string		Transparent transmission data, which comes from the weight push interface

AiPushWeightReply

AiPushWeightReply intelligently identifies and pushes weight information

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AiRegisterResultCallbackReply

AiRegisterResultCallbackReply - Registers a callback for the recognition result

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AlgoModelChangeReply

AlgoModelChangeReply algorithmic model-switch

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AlgoModelEnumReply

AlgoModelEnumReply Algorithm Model - Enum

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	AlgoModelEnumReply.Data		Response data

AlgoModelEnumReply.Data

AlgoModelEnumReply_Data Declare the response data structure

Field	Type	Label	Description
modelList	AlgoModelInfo	repeated	List of models
model	AlgoModelInfo		The model currently in use

AutoSyncCreateGroupReply

AutoSyncCreateGroupParams Auto Sync - Create a group

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AutoSyncExitGroupReply

AutoSyncExitGroupParams Auto-sync-exit group

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AutoSyncGetGroupsInfoReply

AutoSyncGetGroupsInfoParams Auto Sync - Get group table information

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	AutoSyncGetGroupsInfoReply.Data		Response data

AutoSyncGetGroupsInfoReply.Data

AutoSyncGetGroupsInfoReply_Data Declare the response data structure

Field	Type	Label	Description
groups	AutoSyncGroupInfo	repeated	Grouping tables

AutoSyncGetSelfInfoReply

AutoSyncGetSelfInfoParams Auto Sync - Get native information

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	AutoSyncGetSelfInfoReply.Data		Response data

AutoSyncGetSelfInfoReply.Data

AutoSyncGetSelfInfoReply_Data Declare the response data structure

Field	Type	Label	Description
deviceSN	string		Native SN
hostName	string		The host name of the machine
systemType	SystemType		Native system type
algoModelCode	uint32		The code name of the algorithm model used by the machine
groupID	string		The ID of the group to which the unit belongs
groupName	string		The name of the group to which the unit belongs
dataSyncRule	AutoSyncDataSyncRule		Native data synchronization rules
dataPullRule	LearnDataExportMode		Native data pull rules
dataImportRule	LearnDataImportMode		Native data import rules
groupUpdateAt	uint64		The last update time of the grouping information (millisecond timestamp)
broadcastInterval	uint32		Native Broadcast Time Interval (seconds)
pullInterval	uint32		Local Data Pull Interval (min)

AutoSyncJoinGroupReply

AutoSyncJoinGroupParams Auto-sync-join group

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AutoSyncRemoveDeviceReply

AutoSyncRemoveDeviceParams Auto Sync - Remove the device

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AutoSyncSetIntervalTimeReply

AutoSyncSetIntervalTimeParams - Sets the synchronization interval

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AutoSyncUpdateDataSyncRuleReply

AutoSyncUpdateDataSyncRuleParams Auto Sync - Updates the data synchronization rule

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

AutoSyncUpdateGroupNameReply

AutoSyncUpdateGroupNameParams Auto Sync - Update the group name

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

CameraChangeReply

CameraChangeReply Camera-toggle

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

CameraDetectRangeGetReply

CameraDetectRangeGetReply Camera-Identify Area Acquisition

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	CameraDetectRangeGetReply.Data		Response data

CameraDetectRangeGetReply.Data

CameraDetectRangeGetReply_Data Declare the response data structure

Field	Type	Label	Description
renderWidth	uint32		Actual Render Width (in pixels)
renderHeight	uint32		Actual Render Height (in pixels)
dotList	PlanePositionInfo	repeated	List of coordinates of the recognition area (the origin is the upper left corner of the image, and the coordinates are the actual rendered values after conversion)

CameraDetectRangeSetReply

CameraDetectRangeSetReply Camera - Recognize area modifications

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

CameraEnumReply

CameraEnumReply camera-enumeration

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	CameraEnumReply.Data		Response data

CameraEnumReply.Data

CameraEnumReply_Data Declare the response data structure

Field	Type	Label	Description
cameraList	CameraInfo	repeated	List of cameras
id	string		The ID of the camera currently in use
resolutionInfo	CameraResolutionInfo		The camera image resolution currently in use

CameraFrameReply

CameraFrameReply Camera-Image Frame

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	CameraFrameReply.Data		Response data

CameraFrameReply.Data

CameraFrameReply_Data Declare the response data structure

Field	Type	Label	Description
imageData	bytes		Image data
imageWidth	uint32		Image original width
imageHeight	uint32		Image original height

DeviceActivateReply

DeviceActivateReply Device - Activate

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	DeviceActivateReply.Data		Response data

DeviceActivateReply.Data

DeviceActivateReply_Data Declare the response data structure

Field	Type	Label	Description
deviceInfo	DeviceInfo		Device information

DeviceGetInfoReply

DeviceGetInfoReply Device - Get information

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	DeviceGetInfoReply.Data		Response data

DeviceGetInfoReply.Data

DeviceGetInfoReply_Data Declare the response data structure

Field	Type	Label	Description
deviceInfo	DeviceInfo		Device information

DeviceShopChangeReply

DeviceShopChangeReply Device-Store Modification

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

GetLatestVersionReply

GetLatestVersionReply to get the latest version

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	GetLatestVersionReply.Data		Response data

GetLatestVersionReply.Data

GetLatestVersionReply_Data Declare the response data structure

Field	Type	Label	Description
updateType	VersionUpdateType		The type of version update
updateContent	string		Updated content
versionList	VersionDownloadInfo	repeated	List of versions

GetVersionReply

GetVersionReply to get version information

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	GetVersionReply.Data		Response data

GetVersionReply.Data

GetVersionReply_Data Declare the response data structure

Field	Type	Label	Description
versionList	VersionInfo	repeated	List of version information

LearnDataClearReply

LearnDataClearReply Learning Data - Empty

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

LearnDataExportReply

LearnDataExportReply Learning Data - Export

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	LearnDataExportReply.Data		Response data

LearnDataExportReply.Data

LearnDataExportReply_Data Declare the response data structure

Field	Type	Label	Description
successCount	int64		The number of successful exports
nodeTimestamp	int64		The time node of this export
data	bytes		Learning data

LearnDataImportReply

LearnDataImportReply Learning Data - Import

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	LearnDataImportReply.Data		Response data

LearnDataImportReply.Data

LearnDataImportReply_Data Declare the response data structure

Field	Type	Label	Description
successCount	int64		The number of successful imports

LearnDataUploadReply

LearnDataUploadReply Learning Data - Upload

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

SkuDataDeleteReply

SkuDataDeleteReply Product Data - Delete

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

SkuDataIconMatchReply

SkuDataIconMatchReply Product Data - Main Image Match

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	SkuDataIconMatchReply.Data		Response data

SkuDataIconMatchReply.Data

SkuDataIconMatchReply_Data Declare the response data structure

Field	Type	Label	Description
downloadUrlPrefix	string		ICON download path prefix
skuIconList	SkuIconInfo	repeated	List of product ICON information

SkuDataImportReply

SkuDataImportReply Product Data - Import

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

SkuFeatClearReply

SkuFeatClearReply Product Features - Clears all characteristics of the specified product

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

SkuFeatQueryImageReply

SkuFeatQueryImageReply Product Features - Query Image

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	SkuFeatQueryImageReply.Data		Response data

SkuFeatQueryImageReply.Data

SkuFeatQueryImageReply_Data Declare the response data structure

Field	Type	Label	Description
featImgList	SkuFeatImageInfo	repeated	A list of product feature images

SkuFeatQueryReply

SkuFeatQueryReply Product Characteristics - Query feature information in batches

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason
data	SkuFeatQueryReply.Data		Response data

SkuFeatQueryReply.Data

SkuFeatQueryReply_Data Declare the response data structure

Field	Type	Label	Description
featNumList	SkuFeatNumberInfo	repeated	A list of the number of product features

SkuFeatRemoveReply

SkuFeatRemoveReply Product Features - Removes the specified characteristics of the specified product

Field	Type	Label	Description
code	StatusCode		Status code
msg	string		Status reason

StatusCode

StatusCode status code definition

Name	Number	Description
ErrUnknow	0	Unknown anomaly
Success	1	succeed
ErrPciNetCardDisabled	1000	The PCI NIC of the device has been disabled
ErrCamera	1001	The device camera is abnormal
ErrImageDecode	1002	Image decoding failed
ErrImageEncode	1003	Image encoding failed
ErrNetwork	1004	The network is abnormal
ErrCloudServer	1005	The ECS is abnormal
ErrInputParam	1006	The input parameter is abnormal
ErrExportLearnDataEmpty	1007	The exported learning data is empty
ErrDeviceNotActivate	1500	The device is not activated
ErrDeviceActivateExpire	1501	The device activation status has expired
ErrDeviceSystemTime	1503	The system time of the device is abnormal
ErrErLangShenAlgo	2000	Erlang God's algorithm is abnormal
ErrBaiZeAlgo	2500	Bai Ze's algorithm is abnormal

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)