在线推理接口说明

FATE在线推理接口文档

一、接口描述

FATE-Serving的在线推理功能，需要通过Guest和Host双方对模型数据样本进行联合预测，入口则是Guest方提供的inference接口。

二、请求地址

请求路径：http://{ip}:{port}/federation/{version}/inference

{ip}:{port} 为Guest方serving-proxy的地址，依据实际部署架构而定

三、请求类型

• POST
• content-application/json

四、请求内容

• 请求头（Request Header）

参数名	是否必填	类型	描述
serviceId	是	string	FATE-Flow 绑定发布模型时的 serviceId，训练完成模型后命令行操作

• 请求体（Request Body）

参数名	是否必填	类型	描述
head	是	json object	系统所需参数
body	否	json object	模型预测需要用到的数据，一般是包括ID，比如手机号、设备号等

请求示例

{
  "head": {
    "serviceId": "111111111"
  },
  "body": {
    "featureData": {
      "x0": 1.88669,
      "x1": -1.359293,
      "x2": 2.303601,
      "x3": 2.00137,
      "x4": 1.307686
    },
    "sendToRemoteFeatureData": {
      "phone_num": "122222222"
    }
  }
}

head中填入系统参数，featureData中为模型所需特征数据，不会传递给Host方，只有sendToRemoteFeatureData中的才会传递给Host方，一般sendToRemoteFeatureData需要包含host方用于匹配样本的id，例如设备号或者手机号

五、响应内容

字段名	类型	描述
retcode	int	错误码，0 表示请求成功
retmsg	string	错误提示信息
data	json object	预测结果
flag	int	保留字段

{
  "flag":0,
  "data":
  	{
      "prob":0.30684422824464636,
      "guestInputDataHitRate:{}":0.0,
      "guestModelWeightHitRate:{}":0.0,
      "retcode":0
    },
  "retmsg":"success",
  "retcode":0
}