summaryrefslogtreecommitdiff
path: root/data/en_us/dtsai/2026-04-01/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/dtsai/2026-04-01/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/dtsai/2026-04-01/api-docs.php')
-rw-r--r--data/en_us/dtsai/2026-04-01/api-docs.php596
1 files changed, 596 insertions, 0 deletions
diff --git a/data/en_us/dtsai/2026-04-01/api-docs.php b/data/en_us/dtsai/2026-04-01/api-docs.php
new file mode 100644
index 0000000..122276d
--- /dev/null
+++ b/data/en_us/dtsai/2026-04-01/api-docs.php
@@ -0,0 +1,596 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => ['style' => 'RPC', 'product' => 'DtsAI', 'version' => '2026-04-01'],
+ 'directories' => ['CreateDocParserJob', 'DescribeDocParserJobResult', 'DescribeDocParserJobStatus', 'WebFetch', 'WebSearch'],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'CreateDocParserJob' => [
+ 'summary' => 'Creates a document parsing task.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'ApiKey' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREdtsE4ZR2L'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'FileUrl',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The HTTP or HTTPS URL of the file to be parsed.'."\n"
+ .'>The SDKs for various programming languages additionally provide a `CreateDocParserJobAdvance` method that supports passing a local file stream directly (such as InputStream in Java), without the need to upload the file to OSS and construct a FileUrl in advance. When using the Advance method, replace the `FileUrl` parameter (URL string) with the `FileUrlObject` parameter (file stream). All other request parameters remain unchanged. The SDK automatically performs the following operations:'."\n"
+ .'>1. Obtains temporary OSS upload credentials.'."\n"
+ .'>2. Uploads the file stream directly to OSS.'."\n"
+ .'>3. Calls the CreateDocParserJob operation with the generated OSS URL.', 'type' => 'string', 'required' => false, 'isFileTransferUrl' => true, 'example' => 'https://xxx.oss-cn-beijing.aliyuncs.com/document.pdf?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The file name, which must include the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'document.pdf', 'title' => ''],
+ ],
+ [
+ 'name' => 'FileFormat',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The format of the input file. Valid values:'."\n"
+ ."\n"
+ .'- **pdf**: PDF file.'."\n"
+ ."\n"
+ .'- **docx**: Word file in DOCX format.'."\n"
+ ."\n"
+ .'- **doc**: Word file in DOC format.'."\n"
+ ."\n"
+ .'- **pptx**: PPT file in PPTX format.'."\n"
+ ."\n"
+ .'- **ppt**: PPT file in PPT format.'."\n"
+ ."\n"
+ .'- **txt**: plain text file.'."\n"
+ ."\n"
+ .'- **md**: Markdown file.'."\n"
+ ."\n"
+ .'- **png**: PNG image.'."\n"
+ ."\n"
+ .'- **jpg**: JPG image.'."\n"
+ ."\n"
+ .'- **jpeg**: JPEG image.', 'type' => 'string', 'required' => true, 'example' => 'pdf', 'title' => ''],
+ ],
+ [
+ 'name' => 'OutputFormat',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The output format of the parsing result. Valid values:'."\n"
+ ."\n"
+ .'- **markdown**: Markdown format.', 'type' => 'string', 'required' => true, 'example' => 'markdown', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssFileUrl',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The OSS file URL.', 'type' => 'string', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The parameter is not valid.', 'title' => ''],
+ 'JobId' => ['description' => 'The document parsing task ID.', 'type' => 'string', 'example' => 'job_abc123', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a document parsing task',
+ 'description' => '- Region: Only China (Beijing) is supported.'."\n"
+ ."\n"
+ .'- Fees: The service is free of charge during the public preview period.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dtsai:CreateDocParserJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"ErrorMessage\\": \\"The parameter is not valid.\\",\\n \\"JobId\\": \\"job_abc123\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDocParserJobResult' => [
+ 'summary' => 'Retrieves the result of a document parsing task.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'ApiKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdtsE4ZR2L'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The document parsing task ID. You can obtain this ID by calling CreateDocParserJob.', 'type' => 'string', 'required' => true, 'example' => 'job_abc123', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'JobNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified job does not exist.', 'title' => ''],
+ 'Result' => ['description' => 'The document parsing result. The format is determined by the OutputFormat parameter specified in the CreateDocParserJob request.', 'type' => 'string', 'example' => '# Document Title', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve the result of a document parsing task',
+ 'description' => '- Region: Only China (Beijing) is supported.'."\n"
+ ."\n"
+ .'- Fees: Free of charge during the public preview period.'."\n"
+ ."\n"
+ .'- Call DescribeDocParserJobResult to retrieve the parsing result of a document parsing task. Call this operation only after DescribeDocParserJobStatus returns a Status of success. Task results are retained for 72 hours and cannot be retrieved after expiration.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dtsai:DescribeDocParserJobResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"JobNotFound\\",\\n \\"ErrorMessage\\": \\"The specified job does not exist.\\",\\n \\"Result\\": \\"# Document Title\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDocParserJobStatus' => [
+ 'summary' => 'Queries the status of a document parsing task.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'ApiKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdtsE4ZR2L'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the document parsing task. You can obtain the ID by calling CreateDocParserJob.', 'type' => 'string', 'required' => true, 'example' => 'job_abc123', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'JobNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified job does not exist.', 'title' => ''],
+ 'Status' => ['description' => 'The task status. Valid values:'."\n"
+ ."\n"
+ .'- **init**: Created and being prepared.'."\n"
+ ."\n"
+ .'- **pending**: Queued and waiting to be scheduled.'."\n"
+ ."\n"
+ .'- **running**: Being processed and parsed.'."\n"
+ ."\n"
+ .'- **success**: Completed. You can call DescribeDocParserJobResult to obtain the result.'."\n"
+ ."\n"
+ .'- **failed**: Failed. The cause is provided in FailureMessage.'."\n"
+ ."\n"
+ .'- **cancelled**: Canceled.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'FailureMessage' => ['description' => 'The failure cause. This parameter has a value only when Status is failed.', 'type' => 'string', 'example' => 'Failed Message', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query the status of a document parsing task',
+ 'description' => '- Region: Only China (Beijing) is supported.'."\n"
+ ."\n"
+ .'- Fees: The service is free of charge during the public preview period.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dtsai:DescribeDocParserJobStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"JobNotFound\\",\\n \\"ErrorMessage\\": \\"The specified job does not exist.\\",\\n \\"Status\\": \\"running\\",\\n \\"FailureMessage\\": \\"Failed Message\\"\\n}","type":"json"}]',
+ ],
+ 'WebFetch' => [
+ 'summary' => 'Retrieves the content of a web page.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'ApiKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdtsE4ZR2L'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'Url',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The URL of the target web page to crawl.', 'type' => 'string', 'required' => true, 'example' => 'https://xxx/projects/spring-boot', 'title' => ''],
+ ],
+ [
+ 'name' => 'OutputFormat',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The output format. Valid values:'."\n"
+ ."\n"
+ .'- **markdown**: Markdown format.'."\n"
+ ."\n"
+ .'- **html**: HTML format.'."\n"
+ ."\n"
+ .'- **text**: Plain text format.', 'type' => 'string', 'required' => false, 'example' => 'markdown', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ErrorMessage Code', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ErrorMessage Example', 'title' => ''],
+ 'Url' => ['description' => 'The URL of the web page.', 'type' => 'string', 'example' => 'https://xxxx/projects/spring-boot', 'title' => ''],
+ 'UrlType' => ['description' => 'The URL classification result. Valid values:'."\n"
+ .'- **static_html**: Static HTML page.'."\n"
+ .'- **dynamic_js**: Single-page application (SPA) page that requires JavaScript rendering.'."\n"
+ .'- **audio**: Audio file.'."\n"
+ .'- **video**: Video file.'."\n"
+ .'- **document**: Document file (PDF, Word, PPT, or Excel).'."\n"
+ .'- **unknown**: Unrecognizable.', 'type' => 'string', 'example' => 'static_html', 'title' => ''],
+ 'ContentFormat' => ['description' => 'The actual output format. Valid values:'."\n"
+ ."\n"
+ .'- **markdown**: Markdown format.'."\n"
+ ."\n"
+ .'- **html**: HTML format.'."\n"
+ ."\n"
+ .'- **text**: Plain text format.', 'type' => 'string', 'example' => 'markdown', 'title' => ''],
+ 'Title' => ['description' => 'The title of the web page.', 'type' => 'string', 'example' => 'Spring Boot', 'title' => ''],
+ 'Content' => ['description' => 'The content of the web page.', 'type' => 'string', 'example' => 'Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications.', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve web page content',
+ 'description' => '- Region: Only China (Beijing) and Singapore regions are supported.'."\n"
+ .'- Pricing: Free of charge during the public preview period.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dtsai:WebFetch',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"ErrorMessage Code\\",\\n \\"ErrorMessage\\": \\"ErrorMessage Example\\",\\n \\"Url\\": \\"https://xxxx/projects/spring-boot\\",\\n \\"UrlType\\": \\"static_html\\",\\n \\"ContentFormat\\": \\"markdown\\",\\n \\"Title\\": \\"Spring Boot\\",\\n \\"Content\\": \\"Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications.\\"\\n}","type":"json"}]',
+ ],
+ 'WebSearch' => [
+ 'summary' => 'Performs a web search.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'ApiKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdtsE4ZR2L'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The search query statement.', 'type' => 'string', 'required' => true, 'example' => 'Spring Boot', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of results to return. Default value: 10. Valid values: 1 to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58'],
+ 'Query' => ['description' => 'The search query statement.', 'type' => 'string', 'example' => 'Spring Boot', 'title' => ''],
+ 'TotalResults' => ['description' => 'The total number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'SearchResult' => [
+ 'description' => 'The search result list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['description' => 'The title of the web page.', 'type' => 'string', 'example' => 'Spring Boot', 'title' => ''],
+ 'Url' => ['description' => 'The URL of the web page.', 'type' => 'string', 'example' => 'https://xxx/projects/spring-boot', 'title' => ''],
+ 'Snippet' => ['description' => 'The summary of the web page content.', 'type' => 'string', 'example' => 'Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications.', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ErrorMessage Code', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ErrorMessage Example', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Web search',
+ 'description' => '- Region: Only China (Beijing) and Singapore regions are supported.'."\n"
+ ."\n"
+ .'- Fees: Free of charge during the public preview. No fees are charged.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dtsai:WebSearch',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58\\",\\n \\"Query\\": \\"Spring Boot\\",\\n \\"TotalResults\\": 10,\\n \\"SearchResult\\": [\\n {\\n \\"Title\\": \\"Spring Boot\\",\\n \\"Url\\": \\"https://xxx/projects/spring-boot\\",\\n \\"Snippet\\": \\"Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications.\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"ErrorMessage Code\\",\\n \\"ErrorMessage\\": \\"ErrorMessage Example\\"\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dtsai.cn-beijing.aliyuncs.com', 'endpoint' => 'dtsai.cn-beijing.aliyuncs.com', 'vpc' => 'dtsai-vpc.cn-beijing.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [],
+ 'ram' => [
+ 'productCode' => 'DtsAI',
+ 'productName' => 'Data Transmission Service',
+ 'ramCodes' => ['dtsai'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DescribeDocParserJobResult',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ 'ramAction' => [
+ 'action' => 'dtsai:DescribeDocParserJobResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'WebSearch',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ 'ramAction' => [
+ 'action' => 'dtsai:WebSearch',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDocParserJobStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ 'ramAction' => [
+ 'action' => 'dtsai:DescribeDocParserJobStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDocParserJob',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ 'ramAction' => [
+ 'action' => 'dtsai:CreateDocParserJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'WebFetch',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'additionalActions' => [
+ ['action' => 'dtsai:CallWithBearerToken', 'validationType' => 'conditional'],
+ ],
+ 'ramAction' => [
+ 'action' => 'dtsai:WebFetch',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DtsAI', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [],
+ ],
+];