全部产品
阿里云办公

数据格式

更新时间:2018-11-30 10:40:10

数据格式说明

图片格式说明

目前图片支持如下格式:

  • Windows bitmaps - *.bmp
  • JPEG 文件 - .jpeg, .jpg, *.jpe
  • JPEG 2000 文件 - *.jp2
  • Portable Network Graphics - *.png
  • Portable image format - .pbm, .pgm, *.ppm
  • TIFF 文件 - .tiff, .tif

请求字符串格式说明

各识别服务API使用方法大相径庭,参数均通过http请求的body传输,格式以json字符串封装,json字段因服务而异。各服务的返回结果同样以json字符串形式保存,输入输出的具体信息请参考各项服务API说明文档。

上传参数

服务所需的参数通过http POST请求的body上传,以json字符串格式封装,而每个参数又有两个json字段,dataType和dataValue,形式如下:

  1. {
  2. param :{
  3. "dataType": xxx # int类型
  4. "dataValue": xxx #根据dataType定类型
  5. }
  6. }

dataType的定义如下,用户可以根据具体的数字,把dataValue转换成对应的格式存储。

Bool = 1;

Int32 = 10

Int64 = 20;

Float = 30;

Double = 40;

String = 50;

DateTime = 60;

上传请求的body示例如下:

  1. "inputs": [
  2. {
  3. "image": {
  4. "dataType": 50,
  5. "dataValue": "base64_image_string" #图片以base64编码的string
  6. },
  7. "configure": {
  8. "dataType": 50,
  9. "dataValue": "{
  10. \"arg1\" : \"arg1_value\",
  11. \"arg2\" : \"arg2_value\"
  12. }"
  13. } #[可选参数]
  14. }
  15. ]

输入参数是json字符串信息,关键词inputs对应一个json数组,里面可以存放多个json object,每个json object包含单个识别请求所需的参数,服务支持多机并发访问,因此可以一次上传多组参数进行识别。每一组参数则又有两个字段构成:

参数名称 参数类型 是否可选 描述 默认值
image string dataType为50(字符串), dataValue是base64编码后的图像数据 空字符串
configure string dataType为50(字符串), dataValue是json格式字符串,其中的具体参数字段根据不同的识别服务而定,参见API介绍 空字符串

结果解析

返回结果以json字符串格式封装,存储在以outputs为关键词对应的的数组中。 如果inputs为关键词的数组中包含多个请求参数,那么对应的outputs对应的数组中也包含同样个数的json object。每个json object有3个字段:

  • outputLabel: 所用识别服务的名称
  • outputMulti: 暂时未使用,为{}
  • outputValue: json字符串,其中dataType 50表示数据类型为字符串,dataValue为对应的输出结果字符串,该字符串为json字符串格式,需要重新使用json解析获取每个字段的结果,其中具体的json字 段由不同的识别服务决定,可以参考API介绍页面。
  1. {
  2. "outputs": [
  3. {
  4. "outputLabel": "service_name",
  5. "outputMulti": {},
  6. "outputValue": {
  7. "dataType": 50,
  8. "dataValue": "{
  9. \"outputinfo1\" : \"output1\",
  10. \"outputinfo2\" : \"output2\"
  11. }"
  12. }
  13. }
  14. ]
  15. }