diff options
Diffstat (limited to 'data/zh_cn/documentparseservice/2026-04-14')
| -rw-r--r-- | data/zh_cn/documentparseservice/2026-04-14/api-docs.php | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/data/zh_cn/documentparseservice/2026-04-14/api-docs.php b/data/zh_cn/documentparseservice/2026-04-14/api-docs.php new file mode 100644 index 0000000..32ad1ae --- /dev/null +++ b/data/zh_cn/documentparseservice/2026-04-14/api-docs.php @@ -0,0 +1,114 @@ +<?php return [ + 'version' => '1.0', + 'info' => ['style' => 'RPC', 'product' => 'DocumentParseService', 'version' => '2026-04-14'], + 'directories' => ['DocumentParseOnlineApi'], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DocumentParseOnlineApi' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '表类型，枚举值：`X2I`：U2I 召回或 I2I 召回；`Vector`：向量召回；`Ramdom`：随机召回'."\n", + 'description' => '枚举值及含义如下：'."\n" + ."\n" + .'0：json带bbox+content'."\n" + ."\n" + .'1：json带bbox'."\n" + ."\n" + .'2：markdown', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => ['json 带 bbox+content', 'json 带 bbox', 'markdown'], + 'example' => '0', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => ['title' => '下载地址。', 'description' => '需要解析的文档图片链接（要求是公网可访问的链接）。', 'type' => 'string', 'required' => false, 'example' => 'https://maas-multimodal.oss-cn-hangzhou.aliyuncs.com/yuhui%2Ftmp%2Fsample500%2Ftmp%2F01e67f7c18d739a47f09d6c6b4a3d478_35.jpg?OSSAccessKeyId=LTAI5tGFE7dDsowkX8eWZMEe&Expires=1779229955&Signature=8sjYEYUHOsqCV11hC2MN%2Bs%2BguSI%3D'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '输出参数定义', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Http 请求RequestId', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'], + 'Code' => ['title' => '错误码 ，正常调用时，不会返回该参数。', 'description' => '错误码 ，正常调用时，不会返回该参数。', 'type' => 'string', 'example' => '200'], + 'Success' => ['title' => '是否调用成功：true：调用成功。 false：调用失败。', 'description' => '是否调用成功：true：调用成功。 false：调用失败。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '错误信息，正常调用时，不会返回该参数。', 'description' => '错误信息，正常调用时，不会返回该参数。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'title' => '标注结果，是一个JSON格式的文本。', + 'description' => '标注结果，是一个JSON格式的文本。', + 'type' => 'object', + 'properties' => [ + 'Content' => ['title' => '内容', 'description' => '解析结果', 'type' => 'string', 'example' => '<img src=\\"images/bbox_1_0_118_158.jpg\\" />\\n\\nSichuan Normal University\\n\\n## ➔ 性质\\n\\n性质一：还原性\\n\\n常温下与氧立即反应生成 $NO_{2}$:\\n\\n$$ 2NO+O_{2}\\\\rightarrow2NO_{2}\\\\ ( 红棕色 ) $$\\n\\n《无机化学》- 氢磷砷\\n\\nCollege of Chemistry & Materials Science'], + 'Usage' => [ + 'title' => '本次请求的 Token 消耗信息。', + 'description' => '本次请求的 Token 消耗信息。', + 'type' => 'object', + 'properties' => [ + 'TotalTokens' => ['title' => '消耗的总 Token 数。', 'description' => '消耗的总 Token 数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1753'], + 'InputTokens' => ['title' => '输入token数', 'description' => '输入token数', 'type' => 'integer', 'format' => 'int32', 'example' => '1657'], + 'OutputTokens' => ['title' => '输出token数', 'description' => '输出token数', 'type' => 'integer', 'format' => 'int32', 'example' => '96'], + ], + ], + 'RequestId' => ['title' => '请求 ID', 'description' => '请求 ID', 'type' => 'string', 'example' => '604d486c-5cdb-9261-a23b-f2f08149fece'], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => '101', 'errorMessage' => 'IMAGE_SIZE_ERROR.', 'description' => ''], + ['errorCode' => '102', 'errorMessage' => 'IMAGE_FILE_SIZE_ERROR.', 'description' => ''], + ['errorCode' => '103', 'errorMessage' => 'IMAGE_URL_ERROR.', 'description' => ''], + ['errorCode' => '104', 'errorMessage' => 'IMAGE_FORM_ERROR.', 'description' => ''], + ['errorCode' => '105', 'errorMessage' => 'IMAGE_BASE64_ERROR.', 'description' => ''], + ['errorCode' => '400', 'errorMessage' => 'invalid parameter.', 'description' => ''], + ['errorCode' => '402', 'errorMessage' => 'not authorized.', 'description' => ''], + ['errorCode' => '429', 'errorMessage' => 'RATE_LIMIT_ERROR.', 'description' => ''], + ['errorCode' => '500', 'errorMessage' => 'The service is temporarily unavailable.', 'description' => ''], + ['errorCode' => '630', 'errorMessage' => 'INPUT_IMAGE_NUMBER_EXCEED.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '文档智能解析', + 'summary' => '智能文档解析产品，支持提取图片中的文字并按照自然阅读顺序进行格式化输出，同时支持boundingbox和内容的输出，输出格式支持json和markdown。', + 'description' => '如需访问该API服务，先访问 [https://common-buy.aliyun.com/?commodityCode=agent_documentocr_public_cn](https://common-buy.aliyun.com/?commodityCode=agent_documentocr_public_cn) 链接进行服务开通。', + 'requestParamsDescription' => '无', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1AD60F1-BAC7-546B-9533-E7AD02B16E3F\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Content\\": \\"<img src=\\\\\\\\\\\\\\"images/bbox_1_0_118_158.jpg\\\\\\\\\\\\\\" />\\\\\\\\n\\\\\\\\nSichuan Normal University\\\\\\\\n\\\\\\\\n## ➔ 性质\\\\\\\\n\\\\\\\\n性质一：还原性\\\\\\\\n\\\\\\\\n常温下与氧立即反应生成 $NO_{2}$:\\\\\\\\n\\\\\\\\n$$ 2NO+O_{2}\\\\\\\\\\\\\\\\rightarrow2NO_{2}\\\\\\\\\\\\\\\\ ( 红棕色 ) $$\\\\\\\\n\\\\\\\\n《无机化学》- 氢磷砷\\\\\\\\n\\\\\\\\nCollege of Chemistry & Materials Science\\",\\n \\"Usage\\": {\\n \\"TotalTokens\\": 1753,\\n \\"InputTokens\\": 1657,\\n \\"OutputTokens\\": 96\\n },\\n \\"RequestId\\": \\"604d486c-5cdb-9261-a23b-f2f08149fece\\"\\n }\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'documentparseservice.cn-hangzhou.aliyuncs.com', 'endpoint' => 'documentparseservice.cn-hangzhou.aliyuncs.com', 'vpc' => 'documentparseservice-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], +]; |