Visual Transformer

## 图像分类能力接口协议

注意：文中的\<service-id\>表示需要修改成自己训练后的服务ID，不带尖括号

#### 接口地址

```
https://xingchen.cn-huabei-2.xf-yun.com/v1/private/<service-id>
```

#### 请求协议

```
{
    "header": {
        "app_id": "123456",
        "uid": "",
        "did": "",
        "imei": "",
        "imsi": "",
        "mac": "",
        "net_type": "wifi",
        "net_isp": "CMCC",
        "status": 3,
        "request_id": null,
        "res_id": ""
    },
    "parameter": {
        "<service-id>": {
            "atp_patch_id": "0",
            "result": {
                "encoding": "utf8",
                "compress": "raw",
                "format": "plain"
            }
        }
    },
    "payload": {
        "image": {
            "encoding": "jpg",
            "image": "",
            "status": 3
        }
    }
}
```

#### 协议**结构说明**

### 请求参数

#### 平台参数

#### 服务特性参数

**响应数据参数**

result 段的参数（默认返回）

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

#### 请求数据

image

| 字段     | 含义     | 数据类型 | 取值范围                                             | 默认值 | 说明                      | 必填 |
| :------- | :------- | :------- | :--------------------------------------------------- | :----- | :------------------------ | :--- |
| encoding | 图像编码 | string   | jpg:jpg格式, jpeg:jpeg格式, png:png格式, bmp:bmp格式 | jpg    | 图像编码                  | 否   |
| image    | 图像数据 | string   | 最小尺寸:0B, 最大尺寸:10485760B                      |        | 图像数据，base64          | 是   |
| status   | 数据状态 | int      | 3:一次性传完                                         | 3      | 取值范围为：3（一次传完） | 否   |

## 响应

### 响应协议示例

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

**协议结构说明**

### 响应参数

####  平台参数

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

#### 响应数据参数

result（默认返回）

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