注册
文档中心
API调试

功能描述

通用NLP信息抽取

请求URL

https://api.textin.com/ai/service/v1/contents-extract

HTTP请求方法

HTTP POST

请求头说明(Request Header)

请在HTTP请求中添加以下自定义Header。

header 名
x-ti-app-id 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id
x-ti-secret-code 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code

请求体说明(Request Body)

Content-Type: application/json

JSON示例:

{
  "keys": [
    "要抽取的key"
  ],
  "file": "要提取的文件的base64字符串,如果提取纯文本,则直接赋值其文本字符串。",
  "type": "file字段里存放的数据类型,枚举值:word, pdf, image, string"
}

响应体说明(Response Data)

Content-Type: application/json

JSON结构说明如下:

字段名 类型 描述
code integer 错误码,详见“错误码说明”
duration number

单次请求的响应时间(单位为毫秒)

message string

错误信息

version string

服务版本号

result object

特定接口的返回结果

+ pages_count integer

输入数据/文档包含的页面总数

+ keys_count integer

单次请求传入的键名数量

+ item_list array
   ++ key string

用户自定义的单个键名

   ++ value string

从输入数据中提取的键值

   ++ score number

键值对置信度分数

   ++ nonscore number

未匹配到值的分数

   ++ candidates array
    +++ value string
    +++ score number

值属于键的置信度分数

    +++ range string

值在原始输入文本的位置区间,当前仅当输入数据为txt文本时有效

    +++ chars_info array
     ++++ page_index integer
  • 字符所在的页面编号(从1开始)
     ++++ char string
  • 字符的文本内容
     ++++ rotation integer
  • 字符旋转的角度
     ++++ polygons array

字符的空间坐标位置,4个点依次为左下x、左下y、右上x和右上y

+ pages array
   ++ index integer

传入文档的第几页(从0开始)

   ++ angle integer

接口输出文档的角度, 定义人类阅读文字的方向为文档正向放置,用零度表示, 该字段表示对正置文档进行了顺时针若干角度的旋转。

   ++ original_angle integer

接口输入文档的角度,用于记录文档最原始的旋转角度,因为当输入rotate_image时,会将image正置,并令angle=0

   ++ width integer

文档的宽度

   ++ height integer

文档的高度

   ++ image_bytes string

图片的base64字符流

   ++ image_scale number

返回的图片的缩放比例

   ++ image_type string

返回的图片的格式

JSON结构示例

{
    "code": 200,
    "message": "string",
    "version": "v1.0.0",
    "duration": 456.7,
    "result": {
        "pages_count": 5,
        "keys_count": 2,
        "item_list": [
            {
                "key": "合同编号",
                "value": "9012",
                "score": 12.36,
                "nonscore": -3.96,
                "candidates": [
                    {
                        "value": "9012",
                        "score": 0.999,
                        "range": "[0,10]",
                        "chars_info": [
                            {
                                "page_index": 1,
                                "char": "x",
                                "rotation": 0,
                                "polygons": [
                                    0,
                                    50,
                                    50,
                                    0
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "pages": [
            {
                "index": 0,
                "angle": 0,
                "original_angle": 0,
                "width": 595,
                "height": 842,
                "image_bytes": "iVBORw0KGgoAAAANSUhEUgAAA0oAAAJUCAIAAACkE0HlAAAACXBIWXMAAA7EAAAOxAGVKw4bAAByT0lEQVR4nOzdeTxV6",
                "image_scale": 2,
                "image_type": "jpeg"
            }
        ]
    }
}

错误码说明

错误码 描述
40101 x-ti-app-id 或 x-ti-secret-code 为空
40102 x-ti-app-id 或 x-ti-secret-code 无效,验证失败
40103 客户端IP不在白名单
40003 余额不足,请充值后再使用
40004 参数错误,请查看技术文档,检查传参
40007 机器人不存在或未发布
40008 机器人未开通,请至市场开通后重试
40301 图片类型不支持
40302 上传文件大小不符,文件大小不超过 10M
40303 文件类型不支持
40304 图片尺寸不符,图像宽高须介于 20 和 10000(像素)之间
40305 识别文件未上传
30203 基础服务故障,请稍后重试
500 服务器内部错误
体验中心
人工客服
400-6666-582