DescribeCustomOcrTemplate-AI Guardrails(AI Guardrails)-阿里云帮助中心

Queries custom OCR templates of a user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-greenweb:DescribeCustomOcrTemplate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Ids	string	No	The data ID.	["1605"]

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	24
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
OcrTemplateList	array<object>	The list of OCR templates.
	array<object>	The list of OCR templates.
Status	integer	The template status. Valid values: 1: enabled 0: disabled.	1
Name	string	The template name.	xx
ImgUrl	string	The image URL.	https://aligreen-shanghai.oss-cn-shanghai.aliyuncs.com/x/custom_ocr_template/1546886714089278/9e188bfa-b0e9-42a0.jpg
Id	integer	The primary key ID.	1750
ReferArea	array<object>	The reference fields.
	object	The reference fields.
Y	integer	Y coordinate of the top-left corner of the text box	4
Name	string	Text box name	referKey1
Width	integer	Width of the text box	220
Height	integer	Height of the text box	229
X	integer	X coordinate of the top-left corner of the text box	12
RecognizeArea	array<object>	The recognition fields.
	object	The recognition fields.
Y	integer	Y coordinate of the top-left corner of the text box	10
Name	string	Text box name	referKey2
Width	integer	Width of the text box	100
Height	integer	Height of the text box	100
X	integer	X coordinate of the top-left corner of the text box	55

Examples

Success response

JSON format

{
  "TotalCount": 24,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "OcrTemplateList": [
    {
      "Status": 1,
      "Name": "xx",
      "ImgUrl": "https://aligreen-shanghai.oss-cn-shanghai.aliyuncs.com/x/custom_ocr_template/1546886714089278/9e188bfa-b0e9-42a0.jpg",
      "Id": 1750,
      "ReferArea": [
        {
          "Y": 4,
          "Name": "referKey1",
          "Width": 220,
          "Height": 229,
          "X": 12
        }
      ],
      "RecognizeArea": [
        {
          "Y": 10,
          "Name": "referKey2",
          "Width": 100,
          "Height": 100,
          "X": 55
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.