Pinyin-Corretion

Pinyin Correction

Request Protocol

HTTP

Header

Parameter Name	Type	Description
Authorization	string	Authentication

Request Path:

https://genaiapi.cloudsway.net/v1/ai/{endpoint}/education/pinyin/correct

Request FormData:

Parameter Name	Type	Required	Description
file	file	No	Image file, with a length or width less than 10 pixels or a short edge less than 30 pixels and an aspect ratio greater than 20 considered as an abnormal image and will be rejected; maximum length of the long side: ≤ 4096 pixels; image types: jpg, jpeg, png, bmp
imageUrl	string	No	Image URL, with a length or width less than 10 pixels or a short edge less than 30 pixels and an aspect ratio greater than 20 considered as an abnormal image and will be rejected; maximum length of the long side: ≤ 4096 pixels; image types: jpg, jpeg, png, bmp

One of file or imageUrl must be provided.

Request Example

curl --location 'https://genaiapi.cloudsway.net/v1/ai/{endpoint}/education/pinyin/correct' \
--header 'Authorization: Bearer xxxx' \
--form 'file=@"/a/b.jpg"'

Response Result

Parameter Name	Type	Meaning	Notes
data	object[]	Returned data
right_num	int	Number of correct items
error_num	int	Number of incorrect items
total_num	int	Total number

data Field Description

Parameter Name	Type	Meaning
pose	object	Coordinate information
mark	string	Correction result ("true" or "false")
answer	array	Correct results
prob	float	Confidence level

pose Field Description

Parameter Name	Type	Meaning
poses	object array	Coordinates of the Pinyin character in the image (four points, starting from the top left, clockwise)

poses Field Description

Parameter Name	Type	Meaning
x	int	X coordinate
y	int	Y coordinate

Example

{
    "data": [
        {
            "pose": {
                "poses": [
                    {
                        "x": 62,
                        "y": 417
                    },
                    {
                        "x": 290,
                        "y": 422
                    },
                    {
                        "x": 288,
                        "y": 578
                    },
                    {
                        "x": 62,
                        "y": 573
                    }
                ]
            },
            "mark": "true",
            "answer": [],
            "prob": 0.6748487
        },
        ...
    ],
    "right_num": 40,
    "error_num": 5,
    "total_num": 45
}