tencent cloud

1. API Description

Domain name for API request: ocr.tencentcloudapi.com.

This API is used to detect and recognize characters in an image. It can recognize Chinese, English, Chinese-English, digits, and special symbols and return the text box positions and characters.

It is suitable for scenarios with a lot of characters in complex layouts and requiring high recognition accuracy, such as examination papers, online images, signboards, and legal documents.

Strengths: compared with general print recognition, it provides higher-precision character recognition services. Its accuracy and recall rate are higher in difficult scenarios such as a large number of characters, long strings of digits, small characters, blurry characters, and tilted text.

This API is not fully available for the time being. For more information, please contact your Tencent Cloud sales rep.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Recognizing general print (high-precision) (debugging tool)

This example shows you how to detect and recognize characters in an image as a whole, where the text box positions and characters are returned.

Input Example

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GeneralAccurateOCR
<Common request parameters>

{
    "ImageUrl": "https://xx/a.jpg"
}

Output Example

{
    "Angel": 359.989990234375,
    "RequestId": "8c8f6a55-b2ef-42f2-864c-e50a83acc2ad",
    "TextDetections": [
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}",
            "Confidence": 99,
            "DetectedText": "\"Good friends, good books,",
            "ItemPolygon": {
                "Height": 29,
                "Width": 306,
                "X": 242,
                "Y": 95
            },
            "Polygon": [
                {
                    "X": 242,
                    "Y": 95
                },
                {
                    "X": 547,
                    "Y": 95
                },
                {
                    "X": 547,
                    "Y": 123
                },
                {
                    "X": 242,
                    "Y": 123
                }
            ],
            "WordCoordPoint": [],
            "Words": []
        },
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}",
            "Confidence": 99,
            "DetectedText": "and a sleepy conscience:",
            "ItemPolygon": {
                "Height": 28,
                "Width": 279,
                "X": 254,
                "Y": 128
            },
            "Polygon": [
                {
                    "X": 254,
                    "Y": 128
                },
                {
                    "X": 532,
                    "Y": 128
                },
                {
                    "X": 532,
                    "Y": 155
                },
                {
                    "X": 254,
                    "Y": 155
                }
            ],
            "WordCoordPoint": [],
            "Words": []
        },
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}",
            "Confidence": 99,
            "DetectedText": "this is the ideal life\"",
            "ItemPolygon": {
                "Height": 27,
                "Width": 219,
                "X": 287,
                "Y": 159
            },
            "Polygon": [
                {
                    "X": 287,
                    "Y": 159
                },
                {
                    "X": 505,
                    "Y": 159
                },
                {
                    "X": 505,
                    "Y": 185
                },
                {
                    "X": 287,
                    "Y": 185
                }
            ],
            "WordCoordPoint": [],
            "Words": []
        },
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}",
            "Confidence": 99,
            "DetectedText": "- Mark Twain",
            "ItemPolygon": {
                "Height": 23,
                "Width": 125,
                "X": 331,
                "Y": 189
            },
            "Polygon": [
                {
                    "X": 331,
                    "Y": 189
                },
                {
                    "X": 455,
                    "Y": 189
                },
                {
                    "X": 455,
                    "Y": 211
                },
                {
                    "X": 331,
                    "Y": 211
                }
            ],
            "WordCoordPoint": [],
            "Words": []
        }
    ]
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.