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 in the following 20 languages: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, Thai, and Arabic. Mixed characters in English and each supported language can be recognized together.

It can recognize printed text in paper documents, online images, ads, signboards, menus, video titles, profile photos, etc.

Strengths: it can automatically recognize the text language, return the text box coordinate information, and automatically rotate tilted text to the upright direction.

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 (debugging tool)

This example shows you how to recognize characters in multiple scenarios in any layout.

Input Example

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

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

Output Example

{
    "Angel": 359.989990234375,
    "Language": "zh",
    "PdfPageSize": 0,
    "RequestId": "0d82dc94-2fc0-43ce-b4db-9a8450ba99e0",
    "TextDetections": [
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}",
            "Confidence": 100,
            "DetectedText": "\"Good friends, good books,",
            "ItemPolygon": {
                "Height": 27,
                "Width": 305,
                "X": 241,
                "Y": 93
            },
            "Polygon": [
                {
                    "X": 241,
                    "Y": 93
                },
                {
                    "X": 546,
                    "Y": 95
                },
                {
                    "X": 546,
                    "Y": 122
                },
                {
                    "X": 241,
                    "Y": 121
                }
            ],
            "WordCoordPoint": [],
            "Words": []
        },
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}",
            "Confidence": 100,
            "DetectedText": "and a sleepy conscience:",
            "ItemPolygon": {
                "Height": 29,
                "Width": 279,
                "X": 254,
                "Y": 123
            },
            "Polygon": [
                {
                    "X": 254,
                    "Y": 123
                },
                {
                    "X": 533,
                    "Y": 128
                },
                {
                    "X": 533,
                    "Y": 157
                },
                {
                    "X": 254,
                    "Y": 152
                }
            ],
            "WordCoordPoint": [],
            "Words": []
        },
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}",
            "Confidence": 100,
            "DetectedText": "this is the ideal life\"",
            "ItemPolygon": {
                "Height": 26,
                "Width": 218,
                "X": 286,
                "Y": 157
            },
            "Polygon": [
                {
                    "X": 286,
                    "Y": 157
                },
                {
                    "X": 504,
                    "Y": 157
                },
                {
                    "X": 504,
                    "Y": 183
                },
                {
                    "X": 286,
                    "Y": 183
                }
            ],
            "WordCoordPoint": [],
            "Words": []
        },
        {
            "AdvancedInfo": "{\"Parag\":{\"ParagNo\":2}}",
            "Confidence": 100,
            "DetectedText": "- Mark Twain",
            "ItemPolygon": {
                "Height": 21,
                "Width": 120,
                "X": 334,
                "Y": 188
            },
            "Polygon": [
                {
                    "X": 334,
                    "Y": 188
                },
                {
                    "X": 454,
                    "Y": 188
                },
                {
                    "X": 454,
                    "Y": 209
                },
                {
                    "X": 334,
                    "Y": 209
                }
            ],
            "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.