文档首页> 文字识别 OCR> API参考> API> 智能文档解析

更新时间：2024-07-11 GMT+08:00

在线调试

CLI示例

查看PDF

智能文档解析

功能介绍

对证件、票据、表单等任意版式文档进行键值对提取、文字识别、以及表格识别等任务，实现进阶高效的自动化结构化返回。

约束与限制

支持中英文及部分中文繁体字。
只支持识别PNG、JPG、JPEG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD格式的图片以及PDF文档，PDF只支持单页识别，可通过pdf_page_number参数指定页码。
图像各边的像素大小在15px到8192px之间。
图像中识别区域有效占比超过80%，保证所有文字及其边缘包含在图像内。
支持图像任意角度的水平旋转。
单页字符数不大于1800，以获得较优的识别效果。
目前不支持复杂背景（如户外自然场景、防伪水印等）和文字扭曲图像的文档解析。
文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

调用方法

请参见如何调用API。

前提条件

在使用之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通服务和认证鉴权章节。

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

URI

POST /v2/{project_id}/ocr/smart-document-recognizer

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，您可以从获取项目ID中获取。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，响应消息头中X-Subject-Token的值即为Token。
Enterprise-Project-Id	否	String	企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。企业项目创建步骤请参见用户指南。说明：创建企业项目后，在传参时，有以下三类场景。携带正确的ID，正常使用OCR服务，账单的企业项目会被分类到企业ID对应的企业项目中。携带格式正确但不存在的ID，正常使用OCR服务，账单的企业项目会显示对应不存在的企业项目ID。不携带ID或格式错误ID（包含特殊字符等），正常使用OCR服务，账单的企业项目会被分类到"default"中。

表3 请求Body参数
参数	是否必选	参数类型	描述
data	否	String	与url二选一。图片或PDF格式，base64编码，要求base64编码后大小不超过10M。图像尺寸不小于15×15像素，最长边不超过8192像素，支持JPG/PNG/BMP/TIFF格式。 PDF以144dpi的分辨率转为图像进行文档解析，需符合上述图像尺寸规定。若PDF有多页，当前仅对第1页进行识别。
url	否	String	与data二选一。图片或PDF的URL路径，目前支持：公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。说明：接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。
kv	否	Boolean	是否进行键值对（key-value）提取。若是，结果会以“kv_result”这一关键字返回。
table	否	Boolean	是否进行表格识别。此处表格特指逻辑表格，通常具有M行N列的形式，且第一行或第一列为表头。若是，结果会以“table_result”这一关键字返回。
layout	否	Boolean	是否进行版面分析。若是，结果会以“layout_result”这一关键字返回。
return_excel	否	Boolean	仅当table为True时有效。是否返回表格转换Microsoft Excel的Base64编码字段。
form	否	Boolean	是否进行有线表单识别。有线表单指关键信息以有线单元格形式进行呈现，例如户口本、机动车发票等。若是，结果会以"form_result"这一关键字返回。
formula	否	Boolean	是否进行公式识别，识别结果为latex序列。若是，结果会以“formula_result”这一关键字返回。当前仅支持文档（例如：论文）中的公式识别，不支持公式切片图像。
kv_map	否	String	需要传入字典的json序列化后字符串，用于对kv_result中的特定key值进行归一化映射。例如，kv_result中包含{"名称"："小明"}的键值对，若传入{"名称"："姓名"}的kv_map，则返回结果为{“姓名”：“小明”}。说明：参数传入示例： "kv_map":"{"名称":"姓名"}"
pdf_page_number	否	Integer	指定PDF页码识别。传入该参数时，则识别指定页码的内容。如果不传该参数，则默认识别第1页。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
result	Array of SmartDocumentRecognizerResult objects	调用成功时返回的结果列表，按页面顺序返回，列表第一项为第一页识别结果，依次类推。调用失败时无此字段。

表5 SmartDocumentRecognizerResult
参数	参数类型	描述
ocr_result	SmartDocumentRecognizerOcrResult object	文字识别结果。
kv_result	SmartDocumentRecognizerKvResult object	键值对提取结果。当输入参数“kv”为“true”时，才返回该参数。
table_result	SmartDocumentRecognizerTableResult object	表格识别结果。当输入参数“table”为“true”时，才返回该参数。
layout_result	SmartDocumentRecognizerLayoutResult object	版面分析结果。当输入参数“layout”为“true”时，才返回该参数。
form_result	SmartDocumentRecognizerFormResult object	有线表单识别结果。当输入参数"form"为true时，才返回该参数。
formula_result	SmartDocumentRecognizerFormulaResult object	公式识别结果。

表6 SmartDocumentRecognizerOcrResult
参数	参数类型	描述
direction	Float	图片朝向。
words_block_count	Integer	识别文字块数目。
words_block_list	Array of SmartDocumentRecognizerWordsBlockList objects	识别文字块列表，输出顺序从左到右，先上后下。

表7 SmartDocumentRecognizerWordsBlockList
参数	参数类型	描述
words	String	文字块识别结果。
location	Array<Array<Integer>>	文字块的区域位置信息，列表形式，包含文字区域四个顶点的二维坐标（x,y）;坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。
confidence	Float	文字块识别结果的置信度。

表8 SmartDocumentRecognizerKvResult
参数	参数类型	描述
kv_block_count	Integer	模型识别到的键值对数量。
kv_block_list	Array of SmartDocumentRecognizerKVBlock objects	键值对识别结果列表。

表9 SmartDocumentRecognizerKVBlock
参数	参数类型	描述
key	String	key-value对（键值对）中的key，例如“姓名：小明”中的“姓名”
value	String	key-value对（键值对）中的value，例如“姓名：小明”中的“小明”
words_block_count	Integer	该键值对中所包含的文本框数量。
words_block_list	Array of SmartDocumentRecognizerKVWordsBlock objects	文本框识别结果列表。

**表10** SmartDocumentRecognizerKVWordsBlock
参数	参数类型	描述
words	String	文字块识别结果。
location	Array<Array<Integer>>	文字块的区域位置信息，列表形式，包含文字区域四个顶点的二维坐标（x,y）;坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。
type	String	类型。

**表11** SmartDocumentRecognizerTableResult
参数	参数类型	描述
table_count	Integer	模型识别到的表格数量。
table_list	Array of SmartDocumentRecognizerTableBlock objects	表格识别结果列表。

**表12** SmartDocumentRecognizerLayoutResult
参数	参数类型	描述
layout_block_count	Integer	模型识别到的文档版面区域数量。
layout_block_list	Array of SmartDocumentRecognizerLayoutBlock objects	文档版面区域识别结果列表。

**表13** SmartDocumentRecognizerLayoutBlock
参数	参数类型	描述
location	Array<Array<Integer>>	文字块的区域位置信息，列表形式，包含文字区域四个顶点的二维坐标（x,y）;坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。
type	String	文档区域类别，包含text、title、sub_title、image、image_caption、form、table、table_caption、header、footer、page_number、reference、formula、stamp、directory共15个类别。
text	String	文档区域文字内容。对于表格与图像，不返回其中的文字内容。
words_ids	Array of integers	文字识别结果索引列表，表示ocr_result的words_block_list中哪些文本框位于该文档区域内。
table_id	Integer	仅当type为"table"且入参table为True时返回该字段，表示当前逻辑表格区域对应table_result中哪一项识别结果。
form_id	Integer	仅当type为"form"且入参form为True时返回该字段，表示当前有线表单区域对应form_result中哪一项识别结果。

**表14** SmartDocumentRecognizerFormResult
参数	参数类型	描述
form_count	Integer	模型识别到的有线表单数量。
form_list	Array of SmartDocumentRecognizerTableBlock objects	有线表单识别结果列表。

**表15** SmartDocumentRecognizerTableBlock
参数	参数类型	描述
location	Array<Array<Integer>>	当前表格的位置信息，列表形式，分别表示文字块4个顶点的x, y坐标；坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。
words_block_count	Integer	表格中所包含的单元格数量。
words_block_list	Array of SmartDocumentRecognizerTableWordsBlock objects	单元格识别结果列表。
excel	String	表格识别结果的base64编码，仅当return_excel为True时返回该字段。对返回的excel编码可用base64.b64decode解码并保存为.xlsx文件。

**表16** SmartDocumentRecognizerTableWordsBlock
参数	参数类型	描述
words	String	单元格内的文字识别结果。
rows	Array of integers	文字块占用的行信息，编号从0开始，列表形式，数据类型为Integer。
columns	Array of integers	文字块占用的列信息，编号从0开始，列表形式，数据类型为Integer。

**表17** SmartDocumentRecognizerFormulaResult
参数	参数类型	描述
formula_count	Integer	数学公式数量。
formula_list	Array of SmartDocumentRecognizerFormulaBlock objects	数学公式识别结果列表。

**表18** SmartDocumentRecognizerFormulaBlock
参数	参数类型	描述
formula	String	数学公式识别结果，以latex字符串表示。
location	Array<Array<Integer>>	数学公式位置信息，列表形式，分别表示4个顶点的x, y坐标；坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。

状态码： 400

**表19** 响应Body参数
参数	参数类型	描述
error_code	String	调用失败时的错误码，具体请参见错误码。调用成功时不返回此字段。
error_msg	String	调用失败时的错误信息。调用成功时无此字段。

请求示例

“endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。
例如，智能文档解析部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/smart-document-recognizer”，“project_id”为项目ID，获取方法请参见获取项目ID
如何获取Token请参见认证鉴权。

传入文档图片的base64编码进行文字识别

POST https://{endpoint}/v2/{project_id}/ocr/smart-document-recognizer 
  
 { 
   "data" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." 
 }

传入文档图片的url进行文字识别

POST https://{endpoint}/v2/{project_id}/ocr/smart-document-recognizer 
  
 { 
   "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" 
 }

响应示例

状态码： 200

成功响应示例

{
  "result" : [ {
    "formula_result" : {
      "formula_count" : 1,
      "formula_list" : [ {
        "formula" : "\\\\int _ { L } \\\\left ( 2 x y ^ { 3 } - y ^ { 2 } \\\\cos x \\\\right ) \\\\mathrm { d } x + \\\\left ( 1 - 2 y \\\\sin x + 3 x ^ { 2 } y ^ { 2 } \\\\right ) \\\\mathrm { d } y",
        "location" : [ [ 171, 919 ], [ 950, 919 ], [ 950, 967 ], [ 171, 967 ] ]
      } ]
    }
  }, {
    "layout_result" : {
      "layout_block_count" : 19,
      "layout_block_list" : [ {
        "location" : [ [ 1165, 368 ], [ 2031, 368 ], [ 2031, 465 ], [ 1165, 465 ] ],
        "type" : "title",
        "text" : "黑龙江增值税专用发票",
        "words_ids" : [ 0 ]
      }, {
        "location" : [ [ 15, 19 ], [ 1078, 19 ], [ 1078, 637 ], [ 15, 637 ] ],
        "type" : "form",
        "text" : "xxxx",
        "words_ids" : [ 2, 3, 4 ],
        "form_id" : 0
      }, {
        "location" : [ [ 18, 180 ], [ 1077, 180 ], [ 1077, 636 ], [ 18, 636 ] ],
        "type" : "table",
        "text" : "xxxx",
        "words_ids" : [ 0, 1, 2 ],
        "table_id" : 0
      } ]
    }
  }, {
    "form_result" : {
      "form_count" : 1,
      "form_list" : [ {
        "location" : [ [ 15, 19 ], [ 1074, 19 ], [ 1074, 636 ], [ 15, 636 ] ],
        "words_block_count" : 24,
        "words_block_list" : [ {
          "words" : "xxx",
          "rows" : [ 0 ],
          "columns" : [ 0, 1, 2 ]
        }, {
          "words" : "xxxx",
          "rows" : [ 1 ],
          "columns" : [ 0, 1, 2 ]
        } ],
        "excel" : "UEsDBBQAAAAIAAAAIQBhXUk6TwEAAI8EAAATAAAAW0NvbnRlbnRfVHlwZX..."
      } ]
    }
  }, {
    "table_result" : {
      "table_count" : 1,
      "table_list" : [ {
        "words_block_count" : 24,
        "words_block_list" : [ {
          "words" : "货物或应税劳务、服务名称",
          "rows" : [ 0 ],
          "columns" : [ 0 ]
        }, {
          "words" : "规格型号",
          "rows" : [ 0 ],
          "columns" : [ 1 ]
        } ],
        "excel" : "xxxx",
        "location" : [ [ 275, 967 ], [ 2919, 967 ], [ 2919, 1177 ], [ 275, 1177 ] ]
      } ]
    }
  }, {
    "kv_result" : {
      "kv_block_count" : 25,
      "kv_block_list" : [ {
        "key" : "开票日期",
        "value" : "2017年08月31日",
        "words_block_count" : 2,
        "words_block_list" : [ {
          "words" : "开票日期",
          "location" : [ [ 2241, 589 ], [ 2480, 592 ], [ 2480, 646 ], [ 2241, 643 ] ],
          "type" : "key"
        }, {
          "words" : "2017年08月31日",
          "location" : [ [ 2479, 591 ], [ 2850, 595 ], [ 2850, 649 ], [ 2479, 645 ] ],
          "type" : "value"
        } ]
      } ]
    }
  }, {
    "ocr_result" : {
      "direction" : 0.4767,
      "words_block_count" : 67,
      "words_block_list" : [ {
        "words" : "黑龙江增值税专用发票",
        "location" : [ [ 430, 100 ], [ 874, 99 ], [ 874, 139 ], [ 430, 141 ] ],
        "confidence" : 0.9552
      } ]
    }
  } ]
}

状态码： 400

失败响应示例

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

SDK代码示例

SDK代码示例如下。

使用SDK前建议将SDK更新至最新版，防止本地旧版SDK无法使用最新的OCR功能。

传入文档图片的base64编码进行文字识别

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
import com.huaweicloud.sdk.ocr.v1.*;
import com.huaweicloud.sdk.ocr.v1.model.*;


public class RecognizeSmartDocumentRecognizerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OcrClient client = OcrClient.newBuilder()
                .withCredential(auth)
                .withRegion(OcrRegion.valueOf("<YOUR REGION>"))
                .build();
        RecognizeSmartDocumentRecognizerRequest request = new RecognizeSmartDocumentRecognizerRequest();
        SmartDocumentRecognizerRequestBody body = new SmartDocumentRecognizerRequestBody();
        body.withData("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...");
        request.withBody(body);
        try {
            RecognizeSmartDocumentRecognizerResponse response = client.recognizeSmartDocumentRecognizer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

传入文档图片的url进行文字识别

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
import com.huaweicloud.sdk.ocr.v1.*;
import com.huaweicloud.sdk.ocr.v1.model.*;


public class RecognizeSmartDocumentRecognizerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OcrClient client = OcrClient.newBuilder()
                .withCredential(auth)
                .withRegion(OcrRegion.valueOf("<YOUR REGION>"))
                .build();
        RecognizeSmartDocumentRecognizerRequest request = new RecognizeSmartDocumentRecognizerRequest();
        SmartDocumentRecognizerRequestBody body = new SmartDocumentRecognizerRequestBody();
        body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName");
        request.withBody(body);
        try {
            RecognizeSmartDocumentRecognizerResponse response = client.recognizeSmartDocumentRecognizer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

传入文档图片的base64编码进行文字识别

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkocr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = OcrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OcrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizeSmartDocumentRecognizerRequest()
        request.body = SmartDocumentRecognizerRequestBody(
            data="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
        )
        response = client.recognize_smart_document_recognizer(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

传入文档图片的url进行文字识别

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkocr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = OcrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OcrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizeSmartDocumentRecognizerRequest()
        request.body = SmartDocumentRecognizerRequestBody(
            url="https://BucketName.obs.myhuaweicloud.com/ObjectName"
        )
        response = client.recognize_smart_document_recognizer(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

传入文档图片的base64编码进行文字识别

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := ocr.NewOcrClient(
        ocr.OcrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizeSmartDocumentRecognizerRequest{}
	dataSmartDocumentRecognizerRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
	request.Body = &model.SmartDocumentRecognizerRequestBody{
		Data: &dataSmartDocumentRecognizerRequestBody,
	}
	response, err := client.RecognizeSmartDocumentRecognizer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

传入文档图片的url进行文字识别

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := ocr.NewOcrClient(
        ocr.OcrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizeSmartDocumentRecognizerRequest{}
	urlSmartDocumentRecognizerRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName"
	request.Body = &model.SmartDocumentRecognizerRequestBody{
		Url: &urlSmartDocumentRecognizerRequestBody,
	}
	response, err := client.RecognizeSmartDocumentRecognizer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	成功响应示例
400	失败响应示例

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： API

上一篇：API

下一篇：通用表格识别

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

智能文档解析

功能介绍

约束与限制

调用方法

前提条件

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线