YoYoFoodAi

YoYoAiFood 由由AI餐饮识别服务

Method Name	Request Type	Response Type	Description
Exit	EmptyParams	PublicReply	Exit 应用程序退出注意事项： 1. 该接口不管是否激活均可调用。 2. 该接口无论在任何场景下务必调用使用场景： 1. 用于处理SDK的关联资源回收。 2. 应用程序退出前以阻塞方式调用该接口，并等待该接口返回响应结果。
GetVersion	EmptyParams	GetVersionReply	GetVersion 获取版本信息注意事项： 1. 该接口不管是否激活均可调用。使用场景： 1. 用于检查gRPC的服务状态是否正常。 2. 使用自有服务器管控SDK的升级时，可用于判断版本是否需要升级。 3. 将该信息上传到自有云服务器，可跟踪每台设备使用的SDK版本信息。 4. 返回其他异常状态码时请按需处理业务逻辑。
GetActivateState	EmptyParams	PublicReply	GetActivateState 获取SDK激活状态注意事项： 1. 该接口不管是否激活均可调用。使用场景： 1. 使用SDK前先调用该接口检查激活状态。 2. 返回未激活状态码时请调用Activate接口激活SDK。 3. 返回其他异常状态码时请按需处理业务逻辑。
Activate	ActivateParams	PublicReply	Activate 激活设备注意事项： 1. 该接口不管是否激活均可调用。 2. 允许重复激活。使用场景： 1. 使用SDK前先调用GetActivateState接口检查激活状态。 2. 未激活时请调用该接口激活SDK。 3. 返回其他异常状态码时请按需处理业务逻辑。
GetDeviceInfo	EmptyParams	GetDeviceInfoReply	GetDeviceInfo 获取设备信息注意事项： 1. 该接口不管是否激活均可调用。使用场景： 1. 获取设备SN、获取设备相关配置信息。
ListenAiMatchResult	EmptyParams	ListenAiMatchResultReply stream	ListenAiMatchResult 监听AI识别结果注意事项： 1. 该接口仅激活后可调用。 2. 该接口类似WebSocket，但只允许调用接口时发送一次数据，服务端会返回多次数据。使用场景： 1. 程序启动后调用该接口进行长连接，监听SDK返回的识别结果。
RegisterHttpServer	RegisterHttpServerParams	PublicReply	RegisterHttpServer 注册客户端实现的HTTP服务注意事项： 1. 该接口仅激活后可调用。 2. 该接口仅在HTTP对接方式下使用，实现SDK主动向客户端推送数据的功能，免除长连接烦恼。 3. 全局调用一次即可，SDK内部会缓存在内存中。使用场景： 1. 无法对接ListenAiMatchResult接口，请实现接口：http://winfoodsdk.doc.yoyo.link/api-117803985
AiMatchControl	AiMatchControlParams	PublicReply	AiMatchControl AI识别启动（停止）控制注意事项： 1. 该接口仅激活后可调用。 2. 通过该接口每次启动识别时将会进行一次强制识别。使用场景： 1. 未检测到目标时可通过传入启动标识执行一次强制识别。 2. 收银时可通过传入停止标识以停止目标检测识别。 3. 收银结束后可通过传入启动标识以启动目标检测识别。
AiMark	AiMarkParams	PublicReply	AiMark AI标记学习注意事项： 1. 该接口仅激活后可调用。 2. 不可对未框选的目标进行学习。 3. 该接口依赖于ListenAiMatchResult的识别结果使用场景： 1. 每日菜品做好后售卖前对菜品进行统一学习。 2. 框选的目标无识别结果时，使用该接口对目标进行标记。 3. 标记后的菜品将会自动上架，锁定状态不会变更。
LearnDataFlush	EmptyParams	PublicReply	LearnDataFlush 学习数据保存注意事项： 1. 该接口仅激活后可调用。 2. 将缓存在内存中的学习数据写入到硬盘中，可能会造成磁盘IO瞬时流量大。使用场景： 1. 所有菜品完成统一学习后，退出学习页面时调用该接口保存学习数据。
LearnDataExport	LearnDataExportParams	LearnDataExportReply	LearnDataExport 学习数据导出注意事项： 1. 该接口仅激活后可调用。 2. 学习数据为空时将会导出失败。 3. 该接口导出的学习数据为ZIP压缩包，学习数据过大时可能会占用较多资源。使用场景： 1. 需要备份学习数据时可通过该接口导出。 2. 需要分享学习数据时可通过该接口导出。
LearnDataImport	LearnDataImportParams	PublicReply	LearnDataImport 学习数据导入注意事项： 1. 该接口仅激活后可调用。 2. 学习数据为空时将会导入失败。 3. 该接口导入的学习数据为ZIP压缩包，学习数据过大时可能会占用较多资源。使用场景： 1. 备份学习数据还原时可通过该接口导入。 2. 分享的学习数据可通过该接口导入。
LearnDataClear	EmptyParams	PublicReply	LearnDataClear 学习数据清除注意事项： 1. 该接口仅激活后可调用。使用场景： 1. 需要重新学习全部菜品时，可调用该接口清除已有的学习数据。
PluDataDelete	PluDataDeleteParams	PublicReply	PluDataDelete 商品数据删除注意事项： 1. 该接口仅激活后可调用。 2. 删除商品数据的同时，关联的学习数据也会一起删除。 3. 该接口为批量接口，无数量限制，建议每次数量控制在1万单品以内。使用场景： 1. 某些菜品识别效果不好，需要重新学习时，可调用该接口删除指定商品的数据。
PluDataUpdate	PluDataUpdateParams	PublicReply	PluDataUpdate 商品数据更新注意事项： 1. 该接口仅激活后可调用。 2. 该接口为批量接口，无数量限制，建议每次数量控制在1万单品以内。使用场景： 1. 商品在近期不再销售时，可以下架该商品，以防止误识别输出。 2. 商品为促销品时，可以锁定该商品，以防止误识别输出，锁定商品将无法学习。
PluFeatQuery	PluFeatQueryParams	PluFeatQueryReply	PluFeatQuery 商品特征查询注意事项： 1. 该接口仅激活后可调用。 2. 该接口为批量接口，无数量限制，建议每次数量控制在1万单品以内。 3. 返回的图片数量和特征数量不一定一致，图片仅供有限条件下的学习记录参考。使用场景： 1. 可查询商品的历史学习图片和特征数量，对每一个商品的学习情况有一个直观的了解。
GetMatchArea	EmptyParams	GetMatchAreaReply	GetMatchArea 获取识别区域注意事项： 1. 该接口仅激活后可调用。使用场景： 1. 对有强制要求的场景，如相机拍摄到了超出托盘的区域，可以调用该接口来回显识别区域参数。
SetMatchArea	SetMatchAreaRequest	PublicReply	SetMatchArea 配置识别区域注意事项： 1. 该接口仅激活后可调用。使用场景： 1. 对有强制要求的场景，如相机拍摄到了超出托盘的区域，可以调用该接口来配置识别区域。
GetCameraList	EmptyParams	GetCameraListReply	GetCameraList 获取相机列表【已弃用】： 1. 目前仅支持AI相机，故不再需要调用该接口注意事项： 1. 该接口不管是否激活均可调用。 2. 可能存在无法获取的相机。使用场景： 1. 主机存在多个摄像头时，可通过该接口获取相机列表。 2. 打开指定相机时需要通过该接口获取相机ID。
OpenCamera	OpenCameraParams	PublicReply	OpenCamera 打开指定相机【已弃用】： 1. 目前仅支持AI相机，故不再需要调用该接口注意事项： 1. 该接口不管是否激活均可调用。 2. 可能存在无法打开的相机。使用场景： 1. 主机存在多个摄像头时，可通过该接口打开指定相机。

Top

YuTooAiFoodDefine.proto

ActivateParams

ActivateParams 设备激活【请求体】

Field	Type	Label	Description
cdKey	string		激活码（必填）
shopInfo	ShopBaseInfo		门店信息（选填）

AiMarkParams

AiMarkParams AI标记学习【请求体】

Field	Type	Description
aiMatchID	int64	识别记录ID（必填，ListenAiMatchResultReply中的ID）
targetID	int64	目标ID（必填，TargetInfo中的ID）
plu	PluBaseInfo	商品信息（必填，将指定目标标记为该商品）
mode	AiMarkMode	AI标记学习模式

AiMatchControlParams

AiMatchControlParams AI识别控制【请求体】

Field	Type	Label	Description
mode	AiMatchControlMode		AI识别控制模式
disableForceMatch	bool		启动时是否禁止强制识别

CameraInfo

CameraInfo 相机信息

Field	Type	Label	Description
id	string		相机ID
name	string		相机名称

EmptyParams

EmptyParams 空请求【请求体】

GetCameraListReply

GetCameraListReply 获取相机列表【响应体】

Field	Type	Label	Description
status	PublicReply		响应状态
cameraID	string		当前正在使用的相机ID
cameraList	CameraInfo	repeated	相机列表

GetDeviceInfoReply

GetDeviceInfoReply 获取设备信息【响应体】

Field	Type	Description
status	PublicReply	响应状态
sn	string	设备SN
shopCode	string	门店编码
activateInfo	ActivateParams	激活信息
activateExpireDate	uint64	激活过期时间（为0时表示不会过期）
diyLogo	string	自定义LOGO

GetMatchAreaReply

GetMatchAreaReply 获取识别区域【响应体】

Field	Type	Label	Description
status	PublicReply		响应状态
area	MatchAreaInfo		区域信息

GetVersionReply

GetVersionReply 获取版本信息【响应体】

Field	Type	Description
status	PublicReply	响应状态
sdkVer	string	SDK版本号
identifyModelVer	string	识别模型版本号
learningModelVer	string	学习模型版本号
cameraLibVer	string	相机库版本号

LearnDataExportParams

LearnDataExportParams 学习数据导出【请求体】

Field	Type	Label	Description
mode	LearnDataExporMode		学习数据导出模式（必填）
lastExportTime	int64		上一次导出毫秒时间戳（选填，仅模式为NewFeat、NewPlu时需要）

LearnDataExportReply

LearnDataExportReply 学习数据导出【响应体】

Field	Type	Description
status	PublicReply	响应状态
data	bytes	学习数据（zip压缩包）注意：使用HTTP方式对接时，该字段表现为Base64字符串，eg. Base64(zip)
currExportTime	int64	当前导出毫秒时间戳

LearnDataImportParams

LearnDataImportParams 学习数据导入【请求体】

Field	Type	Label	Description
mode	LearnDataImportMode		学习数据导入模式（必填）
data	bytes		学习数据（必填，zip压缩包）注意：使用HTTP方式对接时，该字段表现为Base64字符串，eg. Base64(zip)

ListenAiMatchResultReply

ListenAiMatchResultReply 监听识别结果【响应体】

Field	Type	Label	Description
status	PublicReply		响应状态
id	int64		识别记录ID
image	bytes		识别图片（JPEG格式）注意：使用HTTP方式对接时，该字段表现为Base64字符串，eg. Base64(JPEG)
targetList	TargetInfo	repeated	目标检测列表

MatchAreaInfo

MatchAreaInfo 识别区域信息

Field	Type	Description
takePhotoInterval	uint32	拍照间隔毫秒（30 ~1000）（必填）
targetDiffTpr	uint32	目标检测检测灵敏度（10 ~1000）（必填）
top	uint32	识别区域顶部距离（必填）
bottom	uint32	识别区域底部距离（必填）
left	uint32	识别区域左部距离（必填）
right	uint32	识别区域右部距离（必填）
crop	bool	是否需要裁剪识别区域（必填）

OpenCameraParams

OpenCameraParams 打开指定相机【请求体】

Field	Type	Label	Description
cameraID	string		相机ID（必填，CameraInfo中的ID）

PluBaseInfo

PluBaseInfo 商品基础信息

Field	Type	Label	Description
code	string		商品唯一编码（必填，最大128个字符）
name	string		商品名称（必填，最大128个字符）

PluDataDeleteParams

PluDataDeleteParams 商品数据删除【请求体】

Field	Type	Label	Description
pluCodeList	string	repeated	商品唯一编码列表（必填）

PluDataUpdateParams

PluDataDeleteParams 商品数据更新【请求体】

Field	Type	Label	Description
pluStatusList	PluStatusInfo	repeated	商品状态信息列表

PluFeatInfo

PluFeatInfo 商品特征信息

Field	Type	Label	Description
featNum	uint64		已学习的特征数量
imagePathList	string	repeated	仅供参考的历史学习图片

PluFeatQueryParams

PluFeatQueryParams 查询商品特征【请求体】

Field	Type	Label	Description
pluCodeList	string	repeated	商品唯一编码列表（必填）

PluFeatQueryReply

PluFeatQueryReply 查询商品特征【响应体】

Field	Type	Label	Description
status	PublicReply		响应状态
data	PluFeatQueryReply.DataEntry	repeated	商品特征信息映射表

PluFeatQueryReply.DataEntry

Field	Type	Label	Description
key	string
value	PluFeatInfo

PluStatusInfo

PluStatusInfo 商品状态信息

Field	Type	Description
plu	PluBaseInfo	商品基础信息
isSale	bool	商品上下架状态
isLock	bool	商品锁定状态

PublicReply

PublicReply 公共响应【响应体】

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

RegisterHttpServerParams

RegisterHttpServerParams 注册客户端实现的HTTP服务【请求体】

Field	Type	Description
host	string	HTTP服务监听IP（选填，默认127.0.0.1）
port	uint32	HTTP服务监听端口（必填，1~60000）
authScheme	string	客户端需要的HTTP服务鉴权类型，Header示例Authorization: $a u t h S c h e m e$ {authToken}（选填）
authToken	string	客户端需要的HTTP服务鉴权Token，Header示例Authorization: $a u t h S c h e m e$ {authToken}（选填）
apiPrefix	string	全局API前缀，将会拼接在实际请求接口前，示例："/yutooai/api"（选填）

SetMatchAreaRequest

SetMatchAreaRequest 设置识别区域【请求体】

Field	Type	Label	Description
area	MatchAreaInfo		区域信息（必填）

ShopBaseInfo

ShopBaseInfo 门店基础信息

Field	Type	Description
name	string	门店名称（选填）
contact	string	门店联系人（选填）
phone	string	联系人电话（选填）

TargetInfo

TargetInfo 目标信息

Field	Type	Label	Description
id	int64		目标ID
x	int32		相对于识别图片左上角的X坐标
y	int32		相对于识别图片左上角的Y坐标
width	int32		目标检测框宽度
height	int32		目标检测框高度
pluList	PluBaseInfo	repeated	目标检测推理结果

AiMarkMode

AiMarkMode AI标记学习模式

Name	Number	Description
Output	0	Output 在输出结果中选中（默认）
Search	1	Search 在搜索结果中选中
Fast	2	Fast 在快捷结果中选中
Study	3	Study 学习模式专用（该模式会保存图片到本地）

AiMatchControlMode

AiMatchControlMode AI识别控制模式

Name	Number	Description
Stop	0	停止识别
Start	1	启动识别

LearnDataExporMode

LearnDataExporMode 学习数据导出模式

Name	Number	Description
AllExport	0	全量导出
NewFeatExport	1	导出指定时间后的新特征
NewPluExport	2	导出指定时间后的新商品

LearnDataImportMode

LearnDataImportMode 学习数据导入模式

Name	Number	Description
AllImport	0	全量导入（历史数据将会全部被删除）
NewPluImport	1	新商品导入（商品存在：忽略；商品不存在：新增商品并导入全部特征）
NewFeatImport	2	新特征合并（商品存在：追加新特征；商品不存在：新增商品并导入全部特征）

StatusCode

StatusCode 状态码枚举

Name	Number	Description
ErrUnknown	0	未知异常
Success	1	正常
ErrParams	2	参数异常
ErrNotSupport	3	不支持的操作
ErrNetwork	4	网络异常
ErrSystemTime	5	系统时间异常
ErrCamera	6	相机异常
ErrSetMatchArea	7	配置识别区域异常
ErrMachineCodeNotFound	1000	机器码异常
ErrMachinePCINotFound	1001	PCI网卡被禁用
ErrMachineGetVersion	1002	机器库版本信息异常
ErrNotActivate	1500	激活状态异常-未激活
ErrActivateFailed	1501	激活状态异常-激活失败
ErrActivateExpired	1502	激活状态异常-激活码已过期
ErrActivateFrozen	1503	激活状态异常-激活码已冻结
ErrActivateUnknown	1504	激活状态异常-未知异常
ErrIdentifyModelNotLoad	2000	识别模型未加载
ErrIdentifyModelNotInit	2001	识别模型未初始化
ErrIdentifyModelProcess	2002	识别模型识别出错
ErrIdentifyModelParams	2003	识别模型传入参数错误
ErrIdentifyModelMemory	2004	识别模型内存错误
ErrIdentifyModelData	2005	识别模型数据错误
ErrIdentifyModelCallLogic	2006	识别模型调用流程错误
ErrIdentifyModelFile	2007	识别模型文件错误
ErrIdentifyModelKeyEmpty	2008	识别模型键不存在错误
ErrLearnModelNotLoad	2500	学习模型未加载
ErrLearnModelNotInit	2501	学习模型未初始化
ErrLearnModelParams	2502	学习模型传入参数错误
ErrLearnModelMemory	2503	学习模型内存错误
ErrLearnModelData	2504	学习模型数据错误
ErrLearnModelFile	2505	学习模型文件错误
ErrLearnModelFileEmpty	2506	学习模型文件为空错误
ErrLearnModeDataExportNotSupport	2507	学习模型数据导出模式不支持
ErrLearnModeDataImportNotSupport	2508	学习模型数据导入模式不支持
ErrAiMatchRecordNotFound	3000	AI识别-记录不存在
ErrAiMatchTargetNotFound	3001	AI识别-目标不存在

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)

YoYoAiFood 由由AI餐饮识别服务#

YuTooAiFoodDefine.proto#

ActivateParams#

AiMarkParams#

AiMatchControlParams#

CameraInfo#

EmptyParams#

GetCameraListReply#

GetDeviceInfoReply#

GetMatchAreaReply#

GetVersionReply#

LearnDataExportParams#

LearnDataExportReply#

LearnDataImportParams#

ListenAiMatchResultReply#

MatchAreaInfo#

OpenCameraParams#

PluBaseInfo#

PluDataDeleteParams#

PluDataUpdateParams#

PluFeatInfo#

PluFeatQueryParams#

PluFeatQueryReply#

PluFeatQueryReply.DataEntry#

PluStatusInfo#

PublicReply#

RegisterHttpServerParams#

SetMatchAreaRequest#

ShopBaseInfo#

TargetInfo#

AiMarkMode#

AiMatchControlMode#

LearnDataExporMode#

LearnDataImportMode#

StatusCode#

Scalar Value Types#