bert协议服务

# bert协议Web API文档

## **1、请求地址**

------------------------

默认请求地址如下：https://xingchen.cn-huabei-2.xf-yun.com/v1/private/serverceID

备注：serverceID不同服务而定，例如xf5ed701a，微调平台发布服务后会自动生成。 具体查询地址微调主页-服务管控-serverceid

## **2、接口鉴权**

------------------------

参照通用鉴权方式 详见如下地址-鉴权说明章节 [http鉴权使用说明](https://docs.iflyaicloud.com/doc/287/)

## **3、请求协议**

------------------------

###  **3.1请求协议示例**

请求参数

```
{
	"header": {
		"app_id": "123456",
		"uid": "123456",
		"did": "123456",
		"imei": "123456",
		"imsi": "123456",
		"mac": "123456",
		"net_type": "wifi",
		"net_isp": "CMCC",
		"status": 3,
		"request_id": null,
		"res_id": ""
	},
	"parameter": {
		"cls": {
			"score": {
				"encoding": "utf8",
				"compress": "raw",
				"format": "json"
			}
		}
	},
	"payload": {
		"messages": {
		"encoding": "utf8",
		"compress": "raw",
		"format": "json",
		"status": 3,
		"text": ""
		}
	}
}

```

字段解释如下：

| 字段      | 含义         | 类型   | 说明                                                         |
| --------- | ------------ | ------ | ------------------------------------------------------------ |
| header    | 协议头部     | Object | 协议头部，用于描述平台特性的参数。                           |
| parameter | 能力参数     | Object | AI 特性参数，用于控制 AI 引擎特性的开关。                    |
| cls       | 服务别名     | Object |                                                              |
| score     | 响应数据控制 | Object | 数据格式预期，用于描述返回结果的编码等相关约束，不同的数据类型，约束维度亦不相同，此 object 与响应结果存在对应关系。 |
| payload   | 输入数据段   | Object | 数据段，携带请求的数据。                                     |
| messages  | 输入数据     | Object | 输入数据                                                     |

Payload中messages-text示例：

```
{"messages":[{"content": "Java 写一个计时器", "role": "user", "index":0}]}

```

###  **3.2请求参数及含义说明**

**header部分**

| 字段        | 含义                                                         | 类型   | 说明                    | 是否必传 |
| ----------- | ------------------------------------------------------------ | ------ | ----------------------- | -------- |
| app\_id     | 在平台申请的app id信息，[点击申请 (opens new window)](https://in.iflyaicloud.com/console/home) | string | "maxLength":50          | 是       |
| uid         | 请求用户服务返回的uid，用户及设备级别个性化功能依赖此参数    | string | "maxLength":50          | 否       |
| did         | 请求方确保唯一的设备标志，设备级别个性化功能依赖此参数       | string | "maxLength":50          | 否       |
| imei        | 设备imei信息                                                 | string | "maxLength":50          | 否       |
| imsi        | 设备imsi信息                                                 | string | "maxLength":50          | 否       |
| mac         | 设备mac信息                                                  | string | "maxLength":50          | 否       |
| net\_type   | 网络类型，可选值为wifi、2G、3G、4G、5G                       | string | wifi、2G、3G、4G、5G    | 否       |
| net\_isp    | 运营商信息，可选值为CMCC、CUCC、CTCC、other                  | string | CMCC、CUCC、CTCC、other | 否       |
| request\_id | 客户端请求的会话唯一标识                                     | string | "maxLength":64          | 否       |
| res\_id     | 个性化资源ID                                                 | string | "maxLength":1024        | 否       |
| status      | 请求状态，可选值为：3-一次传完                               | int    | 3                       | 是       |

**score部分**

| 字段     | 含义         | 数据类型 | 取值范围          | 默认值 | 说明           | 必填 |
| -------- | ------------ | -------- | ----------------- | ------ | -------------- | ---- |
| encoding | 文本编码     | string   | utf8, gb2312, gbk | utf8   | 取值范围可枚举 | 否   |
| compress | 文本压缩格式 | string   | raw, gzip         | raw    | 取值范围可枚举 | 否   |
| format   | 文本格式     | string   | plain, json, xml  | json   | 取值范围可枚举 | 否   |

**messages部分**

| 字段     | 含义         | 数据类型 | 取值范围                       | 默认值 | 说明                         | 必填 |
| -------- | ------------ | -------- | ------------------------------ | ------ | ---------------------------- | ---- |
| encoding | 文本编码     | string   | utf8, gb2312, gbk              | utf8   | 取值范围可枚举               | 否   |
| compress | 文本压缩格式 | string   | raw, gzip                      | raw    | 取值范围可枚举               | 否   |
| format   | 文本格式     | string   | plain, json, xml               | json   | 取值范围可枚举               | 否   |
| status   | 数据状态     | int      | 3:一次性传完                   | 3      | 取值范围为：3（一次传完）    | 否   |
| text     | 文本数据     | string   | 最小尺寸:1B, 最大尺寸:1048576B |        | 需base64编码，文本大小：0-1M | 是   |

###  **3.3请求数据及含义说明**

**示例：**

```
{
	"messages": [
		{
			"content": null,
			"role": null
		}
	]
}

```

**解析：**

| 字段     | 含义     | 数据类型 | 取值范围                       | 默认值 | 说明 |
| -------- | -------- | -------- | ------------------------------ | ------ | ---- |
| messages | 消息     | array    | \--                            | \[\]   | \--  |
| content  | 文本内容 | string   | `字符长度1 ~ 4069000的字符串`  | \--    | \--  |
| role     | 角色     | string   | `user: 用户` `assistant: 助手` | \--    | \--  |

## **4、响应协议**

------------------------

###  **4.1响应协议示例**

```
{
	"header": {
		"code": 0,
		"message": "success",
		"sid": "ase000704fa@dx16ade44e4d87a1c802"
	},
	"payload": {
		"score": {
			"encoding": "utf8",
			"compress": "raw",
			"format": "json",
			"text": ""
		}
	}
}

```

| 字段    | 含义       | 类型   | 说明                             |
| ------- | ---------- | ------ | -------------------------------- |
| header  | 协议头部   | Object | 协议头部，用于描述平台特性的参数 |
| payload | 响应数据块 | Object | 数据段，携带响应的数据。         |
| score   | 响应数据块 | Object | 输出数据，如下                   |

###  **4.2响应参数及含义说明**

| 字段    | 含义                            | 类型   | 是否必选 |
| ------- | ------------------------------- | ------ | -------- |
| code    | 返回码，0表示成功，其它表示异常 | int    | 是       |
| message | 错误描述                        | string | 是       |
| sid     | 本次会话的id                    | string | 是       |

| 字段     | 含义         | 数据类型 | 取值范围                       | 默认值 | 说明                         | 必填 |
| -------- | ------------ | -------- | ------------------------------ | ------ | ---------------------------- | ---- |
| encoding | 文本编码     | string   | utf8, gb2312, gbk              | utf8   | 取值范围可枚举               | 否   |
| compress | 文本压缩格式 | string   | raw, gzip                      | raw    | 取值范围可枚举               | 否   |
| format   | 文本格式     | string   | plain, json, xml               | json   | 取值范围可枚举               | 否   |
| text     | 文本数据     | string   | 最小尺寸:1B, 最大尺寸:1048576B |        | 需base64编码，文本大小：0-1M | 是   |

###  **4.3响应数据及含义说明**

**示例：**

```
{
	"category_scores": {
		"A分类": null,
		"B分类": null,
		"C分类": null,
		"D分类": null,
	}
}

```

备注：其中A分类、B分类、C分类、D分类根据训练集中分类结果来定，每个训练集不同，分类结果不同

| 字段             | 含义     | 数据类型 | 取值范围           | 默认值 | 说明 |
| ---------------- | -------- | -------- | ------------------ | ------ | ---- |
| category\_scores | 分类得分 | object   | \--                | \--    | \--  |
| A分类            |          | float    | `min: -1 ~ max: 1` | \--    | \--  |
| B分类            |          | float    | `min: -1 ~ max: 1` | \--    | \--  |
| C分类            |          | float    | `min: -1 ~ max: 1` | \--    | \--  |
| D分类            |          | float    | `min: -1 ~ max: 1` | \--    | \--  |