功能介绍

识别网络图片中的文字内容，并以json格式返回识别的结构化结果。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。

对于相同板式的图片，可以使用ModelArts Pro服务提供的文字识别套件，零代码搭建出专属的API，详细操作请参见视频指导。

图1 网络图片识别示例图

调试

您可以在API Explorer中调试该接口。

前提条件

在使用网络图片识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见申请服务和认证鉴权章节。

用户首次使用需要先申请开通。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。

URI

POST https://{endpoint}/v2/{project_id}/ocr/web-image

请求参数

响应参数

根据识别的结果，可能有不同的HTTP响应状态码（status code），状态码和响应参数说明如下。

状态码： 200

状态码： 400

请求示例

• “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。

  例如，网络图片识别服务部署在“华南-广州”区域的“endpoint”为“ocr.cn-south-1.myhuaweicloud.com”，请求URL为“https://ocr.cn-south-1.myhuaweicloud.com/v2/{project_id}/ocr/web-image”，“project_id”为项目ID，获取方法请参见获取项目ID。

• 如何获取Token具体操作请参见构造请求。

• 请求示例（方式一：使用图片的base64编码）

  POST https://{endpoint}/v2/{project_id}/ocr/web-image
  Request Header:
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  
  Request Body:  
  {  
      "image":"/9j/4AAQSkZJRgABAgEASABIAAD/..." 
  }

• 请求示例（方式二：使用图片URL）

  POST https://{endpoint}/v2/{project_id}/ocr/web-image
  Request Header:   
  Content-Type: application/json   
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...       
  Request Body:
  {
       "url":"https://BucketName.obs.xxxx.com/ObjectName"
  }

• Python3语言请求代码示例（其他语言参照下列示例编写或使用OCR SDK）

  # encoding:utf-8
  
  import requests
  import base64
  
  url = "https://{endpoint}/v2/{project_id}/ocr/web-image"
  token = "用户获取得到的实际token值"
  headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
  
  imagepath = r'./data/web-image-demo.png'
  with open(imagepath, "rb") as bin_data:
      image_data = bin_data.read()
  image_base64 = base64.b64encode(image_data).decode("utf-8")  # 使用图片的base64编码
  payload = {"image": image_base64} # url与image参数二选一
  response = requests.post(url, headers=headers, json=payload)
  print(response.text)

响应示例

状态码：200

成功响应示例

{ 
  "result": { 
      "words_block_count": 2, 
      "words_block_list": [ 
          { 
              "words": "文字块1", 
              "confidence": 0.9950,
              "location": [ 
                  [13, 476], 
                  [91, 332], 
                  [125, 351], 
                  [48, 494] 
              ] 
          }, 
          { 
              "words": "文字块2", 
              "confidence": 0.9910,
              "location": [ 
                  [13, 476], 
                  [91, 332], 
                  [125, 351], 
                  [48, 494] 
              ] 
          } 
      ],
      "extracted_data": {}
  } 
}

状态码：400

失败响应示例

{
    "error_code": "AIS.0103", 
    "error_msg": "The image size does not meet the requirements." 
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。