diff options
Diffstat (limited to 'data/en_us/energyexpertexternal/2022-09-23')
| -rw-r--r-- | data/en_us/energyexpertexternal/2022-09-23/api-docs.php | 12302 |
1 files changed, 5545 insertions, 6757 deletions
diff --git a/data/en_us/energyexpertexternal/2022-09-23/api-docs.php b/data/en_us/energyexpertexternal/2022-09-23/api-docs.php index 0676fd7..776a384 100644 --- a/data/en_us/energyexpertexternal/2022-09-23/api-docs.php +++ b/data/en_us/energyexpertexternal/2022-09-23/api-docs.php @@ -1,215 +1,155 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'energyExpertExternal', - 'version' => '2022-09-23', - ], + 'info' => ['style' => 'ROA', 'product' => 'energyExpertExternal', 'version' => '2022-09-23'], 'directories' => [ [ - 'id' => 366327, - 'title' => null, + 'children' => ['AISearchResourceDelete', 'AISearchResourceUpdate', 'AISearchStream', 'AISearchResourceGetList', 'AISearchResourceAdd'], 'type' => 'directory', + 'title' => 'AISearch', + ], + [ 'children' => [ [ - 'id' => 366328, - 'title' => null, + 'children' => ['GetDataItemList', 'RecalculateCarbonEmission'], 'type' => 'directory', - 'children' => [ - 'GetDataItemList', - 'PushItemData', - 'RecalculateCarbonEmission', - ], + 'title' => 'Submit carbon emission activity data', ], [ - 'id' => 366332, - 'title' => null, + 'children' => ['GetFootprintList', 'GenerateResult', 'IsCompleted', 'GetPcrInfo', 'GetGwpInventorySummary', 'GetGwpBenchmarkSummary', 'GetEpdSummary', 'GetInventoryList', 'GetGwpBenchmarkList', 'GetGwpInventoryConstitute', 'GetEpdInventoryConstitute', 'GetReductionProposal', 'GetDataQualityAnalysis'], 'type' => 'directory', - 'children' => [ - 'GetFootprintList', - 'GenerateResult', - 'IsCompleted', - 'GetPcrInfo', - 'GetGwpInventorySummary', - 'GetGwpBenchmarkSummary', - 'GetEpdSummary', - 'GetInventoryList', - 'GetGwpBenchmarkList', - 'GetGwpInventoryConstitute', - 'GetEpdInventoryConstitute', - 'GetReductionProposal', - 'GetDataQualityAnalysis', - ], - ], - [ - 'id' => 366346, - 'title' => null, + 'title' => 'Query product carbon footprint results', + ], + [ + 'children' => ['GetEmissionSummary', 'GetEmissionSourceConstitute', 'GetCarbonEmissionTrend', 'GetElecConstitute', 'GetElecTrend', 'GetAreaElecConstitute', 'GetGasConstitute', 'GetOrgConstitute'], 'type' => 'directory', - 'children' => [ - 'GetEmissionSummary', - 'GetEmissionSourceConstitute', - 'GetCarbonEmissionTrend', - 'GetElecConstitute', - 'GetElecTrend', - 'GetAreaElecConstitute', - 'GetGasConstitute', - 'GetOrgConstitute', - ], + 'title' => 'Query organization carbon inventory results', ], ], + 'type' => 'directory', + 'title' => 'Carbon emission management', ], [ - 'id' => 366355, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 366356, - 'title' => null, + 'children' => ['BatchSaveInstructionStatus', 'SetRunningPlan', 'EditUnfavorableAreaDevices', 'EditProhibitedDevices', 'BatchUpdateSystemRunningPlan'], 'type' => 'directory', - 'children' => [ - 'BatchSaveInstructionStatus', - 'SetRunningPlan', - 'EditUnfavorableAreaDevices', - 'EditProhibitedDevices', - 'BatchUpdateSystemRunningPlan', - ], + 'title' => 'Intelligent air conditioning control', ], [ - 'id' => 366362, - 'title' => null, + 'children' => ['PushDeviceData'], 'type' => 'directory', - 'children' => [ - 'PushDeviceData', - ], + 'title' => 'Submit energy consumption data', ], ], + 'type' => 'directory', + 'title' => 'Energy saving and carbon reduction', ], [ - 'id' => 366364, - 'title' => null, + 'children' => ['GetDeviceInfo', 'GetDeviceList', 'GetOrgAndFactory'], 'type' => 'directory', - 'children' => [ - 'GetDeviceInfo', - 'GetDeviceList', - 'GetOrgAndFactory', - ], + 'title' => 'Device management', ], [ - 'id' => 366368, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 366369, - 'title' => null, + 'children' => ['GetDocumentAnalyzeResult', 'SubmitDocumentAnalyzeJob', 'SubmitDocParsingTask', 'GetDocParsingResult'], 'type' => 'directory', - 'children' => [ - 'GetDocumentAnalyzeResult', - 'SubmitDocumentAnalyzeJob', - 'SubmitDocParsingTask', - 'GetDocParsingResult', - ], + 'title' => 'Document parsing', ], [ - 'id' => 366374, - 'title' => null, + 'children' => ['SubmitDocExtractionTask', 'GetDocExtractionResult', 'SubmitVLExtractionTask', 'GetVLExtractionResult', 'AnalyzeVlRealtime'], 'type' => 'directory', - 'children' => [ - 'SubmitDocExtractionTask', - 'GetDocExtractionResult', - 'SubmitVLExtractionTask', - 'GetVLExtractionResult', - 'AnalyzeVlRealtime', - ], + 'title' => 'Information extraction', ], [ - 'id' => 366380, - 'title' => null, + 'children' => ['GetChatFolderList', 'GetChatSessionList', 'GetChatList', 'SendDocumentAskQuestion', 'Chat', 'ChatStream'], 'type' => 'directory', - 'children' => [ - 'GetChatFolderList', - 'CreateChatSession', - 'Retrieve', - 'GetChatSessionList', - 'GetChatList', - 'SendDocumentAskQuestion', - 'Chat', - 'ChatStream', - ], + 'title' => 'Knowledge base Q&A', ], [ - 'id' => 366389, - 'title' => null, + 'children' => ['AddFolder'], 'type' => 'directory', - 'children' => [ - 'AddFolder', - 'DeleteFolder', - ], + 'title' => 'Folder management', ], [ - 'id' => 366392, - 'title' => null, + 'children' => ['DetailDocument'], 'type' => 'directory', - 'children' => [ - 'DetailDocument', - 'DeleteDocument', - ], + 'title' => 'File management', ], ], + 'type' => 'directory', + 'title' => 'AI document processing', + ], + [ + 'children' => ['CreateChatSession', 'DeleteDocument', 'DeleteFolder', 'Retrieve', 'PushItemData'], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ - 'CarbonEmissionElecSummaryItem' => [ - 'title' => '', - 'description' => 'Enterprise Analytics Return Structure.', - 'visibility' => 'Public', + 'AISearchMessageItem' => [ 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'title' => '', - 'description' => 'Carbon Equivalent.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.22', - 'backendName' => 'carbonEmissionData', - ], - 'rawData' => [ - 'title' => '', - 'description' => 'Electricity consumption in Kwh.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - 'backendName' => 'rawData', - ], - 'ratio' => [ - 'title' => '', - 'description' => 'The percentage of electricity consumption. Valid values: 0 to 1.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.22', - 'backendName' => 'ratio', - ], - 'dataUnit' => [ - 'title' => '', - 'description' => 'The price unit.'."\n", - 'visibility' => 'Public', + 'type' => [ + 'description' => 'The content type of the conversation history information.'."\n" + ."\n" + .'- "text" for text records, "miniapp" for Mini Program information records in structured elements, or "product" for product information records in structured elements.'."\n" + ."\n" + .'- If type is "text", enter the combined content of a single conversation round in the content field. Leave the params field empty.'."\n" + ."\n" + .'- If type is "miniapp" or "product", enter the structured information in JSON format in the params field. Leave the content field empty.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp', 'text' => 'text'], 'type' => 'string', - 'example' => 'kg', - 'backendName' => 'dataUnit', - ], - 'name' => [ 'title' => '', - 'description' => 'The enterprise name.'."\n", - 'visibility' => 'Public', + 'example' => 'miniapp', + ], + 'content' => ['description' => '- Combine the user\'s question and the API\'s text response from one conversation round to form part of the conversation context.'."\n" + ."\n" + .'- The recommended format is: user: \\<question>'."\n" + .'aisearch: \\<previous\\_answer>', 'type' => 'string', 'title' => '', 'example' => '"user：How to test my network speed?\\naisearch：To check your network speed, you can use..."'], + 'params' => ['description' => 'The structured information that appears in a single conversation round.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" + .' "miniapp_id": "test_miniapp",'."\n" + .' "title": "testApp",'."\n" + .' "version": "1.0.5",'."\n" + .' "description": "description-mock",'."\n" + .' "slogan": "slogan-mock",'."\n" + .' "icon": "https://img.alicdn.com/test_icon.png",'."\n" + .' "detail_desc": "detail-mock"'."\n" + .'}'], + ], + 'description' => 'Conversation history information.', + 'title' => '', + 'example' => '', + ], + 'AISearchStreamItem' => [ + 'description' => 'The streaming event structure.', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'Streaming data type.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp', 'text' => 'text'], 'type' => 'string', - 'example' => 'xxx', - 'backendName' => 'name', + 'title' => '', + 'example' => 'text', ], + 'content' => ['description' => 'Text content of the streaming output. This field is only displayed when type is text.', 'type' => 'string', 'title' => '', 'example' => '“network problem can be”'], + 'params' => ['description' => 'This field is used to output structured information content in the streaming result. When type is miniapp, structured resources related to mini programs are output; when type is product, structured resources related to products are output. All content is presented in JSON format.', 'type' => 'any', 'title' => '', 'example' => ' [{"type": "miniapp", "score": 0.7404107, "resourceId": "ja9bQZwBg5VwSU7n5Ijs", "miniappId": null, "title": "更新后的智能搜索测试助手", "version": "1.0.5", "description": "这是一个用于测试 AI 搜索功能的演示小程序", "slogan": "搜索即所得", "icon": "https://img.alicdn.com/test_icon.png", "url": null, "detailDescription": "该小程序提供了完整的 AI 搜索链路测试。"}]'], + ], + 'title' => '', + 'example' => '', + ], + 'CarbonEmissionElecSummaryItem' => [ + 'title' => '企业分析返回结构', + 'description' => 'Enterprise Analytics Return Structure.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'carbonEmissionData' => ['title' => '碳排排放当量', 'description' => 'Carbon Equivalent.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.22', 'backendName' => 'carbonEmissionData'], + 'rawData' => ['title' => '用电量', 'description' => 'Electricity consumption in Kwh.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'rawData'], + 'ratio' => ['title' => '用电量占比', 'description' => 'The percentage of electricity consumption. Valid values: 0 to 1.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.22', 'backendName' => 'ratio'], + 'dataUnit' => ['title' => '单位', 'description' => 'The price unit.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg', 'backendName' => 'dataUnit'], + 'name' => ['title' => '企业名称', 'description' => 'The enterprise name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx', 'backendName' => 'name'], ], ], 'ChatDocumentPageNum' => [ @@ -225,24 +165,12 @@ 'description' => 'Related location coordinates, with each location consisting of 4 coordinate points.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Document block location data.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ChatRefDocPostion', - ], + 'items' => ['description' => 'Document block location data.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocPostion'], 'extendType' => 'true', ], 'backendName' => 'pos', ], - 'num' => [ - 'description' => 'Page numbers of related documents.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - 'backendName' => 'num', - ], + 'num' => ['description' => 'Page numbers of related documents.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'backendName' => 'num'], ], ], 'ChatFolderItem' => [ @@ -254,28 +182,11 @@ 'description' => 'Subfolder list.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Subfolder details.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ChatFolderItem', - ], + 'items' => ['description' => 'Subfolder details.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatItem'], 'backendName' => 'subFolders', ], - 'folderName' => [ - 'description' => 'Folder name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default folder', - 'backendName' => 'folderName', - ], - 'folderId' => [ - 'description' => 'Folder ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'aaa', - 'backendName' => 'folderId', - ], + 'folderName' => ['description' => 'Folder name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default folder', 'backendName' => 'folderName'], + 'folderId' => ['description' => 'Folder ID.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'aaa', 'backendName' => 'folderId'], ], ], 'ChatItem' => [ @@ -283,55 +194,19 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'question' => [ - 'description' => 'Question content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'How to use the knowledge base.', - 'backendName' => 'question', - ], - 'answer' => [ - 'description' => 'The content of the answer to the question.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'No related content found.', - 'backendName' => 'answer', - ], - 'createTime' => [ - 'description' => 'Q&A time, in milliseconds timestamp.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1747280158000', - 'backendName' => 'createTime', - ], + 'question' => ['description' => 'Question content.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'How to use the knowledge base.', 'backendName' => 'question'], + 'answer' => ['description' => 'The content of the answer to the question.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'No related content found.', 'backendName' => 'answer'], + 'createTime' => ['description' => 'Q&A time, in milliseconds timestamp.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1747280158000', 'backendName' => 'createTime'], 'refDocList' => [ 'description' => '- List of files related to the Q&A.'."\n" .'- If streaming question answering is used, only the first shard contains data.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Details of files related to the Q&A.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ChatRefDocItem', - ], + 'items' => ['description' => 'Details of files related to the Q&A.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocItem'], 'backendName' => 'refDocList', ], - 'folderName' => [ - 'description' => 'Name of the folder selected for the Q&A.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'deafult folder', - 'backendName' => 'folderName', - ], - 'folderId' => [ - 'description' => 'Folder selected for the Q&A.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '7708fddb-21dc-4403-a4ea-5b94eccce4c3', - 'backendName' => 'folderId', - ], + 'folderName' => ['description' => 'Name of the folder selected for the Q&A.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'deafult folder', 'backendName' => 'folderName'], + 'folderId' => ['description' => 'Folder selected for the Q&A.', 'visibility' => 'Public', 'type' => 'string', 'example' => '7708fddb-21dc-4403-a4ea-5b94eccce4c3', 'backendName' => 'folderId'], ], ], 'ChatRefDocInfo' => [ @@ -339,24 +214,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'pages' => [ - 'description' => 'Total number of pages in the current document.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - 'backendName' => 'answer', - ], + 'pages' => ['description' => 'Total number of pages in the current document.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'backendName' => 'answer'], 'pageListInfo' => [ 'description' => 'Detailed information for each page of the document.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Detailed information for each page.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ChatRefDocPageInfo', - ], + 'items' => ['description' => 'Detailed information for each page.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocPageInfo'], 'backendName' => 'pageListInfo', ], ], @@ -366,59 +229,19 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'docName' => [ - 'description' => 'Document name. If the original file is of types like doc, it will be converted to PDF for easier document location. This file should be used for document location information.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'a.pdf', - 'backendName' => 'docName', - ], - 'sourceType' => [ - 'description' => 'Return file type: \'doc\' for document files, \'web\' for internet information.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'doc', - 'backendName' => 'sourceType', - ], - 'docUrl' => [ - 'description' => 'Document link.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf', - 'backendName' => 'docUrl', - ], - 'docInfo' => [ - 'description' => 'Related document information.', - 'visibility' => 'Public', - 'backendName' => 'docInfo', - '$ref' => '#/components/schemas/ChatRefDocInfo', - ], - 'originDocName' => [ - 'description' => 'Original document name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'a.doc', - 'backendName' => 'originDocName', - ], + 'docName' => ['description' => 'Document name. If the original file is of types like doc, it will be converted to PDF for easier document location. This file should be used for document location information.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'a.pdf', 'backendName' => 'docName'], + 'sourceType' => ['description' => 'Return file type: \'doc\' for document files, \'web\' for internet information.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'doc', 'backendName' => 'sourceType'], + 'docUrl' => ['description' => 'Document link.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf', 'backendName' => 'docUrl'], + 'docInfo' => ['description' => 'Related document information.', 'visibility' => 'Public', 'backendName' => 'docInfo', '$ref' => '#/components/schemas/ChatRefDocInfo'], + 'originDocName' => ['description' => 'Original document name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'a.doc', 'backendName' => 'originDocName'], 'pageNum' => [ 'description' => 'Page number information.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Page information details.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ChatDocumentPageNum', - ], + 'items' => ['description' => 'Page information details.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatDocumentPageNum'], 'backendName' => 'pageNum', ], - 'originDocUrl' => [ - 'description' => 'Original document link.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc', - 'backendName' => 'originDocUrl', - ], + 'originDocUrl' => ['description' => 'Original document link.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc', 'backendName' => 'originDocUrl'], ], ], 'ChatRefDocPageInfo' => [ @@ -426,67 +249,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'imageWidth' => [ - 'description' => 'The width of the page turns to image', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - 'backendName' => 'imageWidth', - ], - 'imageUrl' => [ - 'description' => '- The image URL after the page is converted to an image. '."\n" - .'- Note: The image URL will be inaccessible after 24 hours, so you need to save it promptly.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - 'backendName' => 'imageUrl', - ], - 'pageIdCurDoc' => [ - 'description' => 'The page index in the current document, starting from 0.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'backendName' => 'pageIdCurDoc', - ], - 'angle' => [ - 'description' => 'The rotation angle of the image after the page is converted to an image.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - 'backendName' => 'angle', - ], - 'excelParseResult' => [ - 'description' => 'Reserved, can be unused for now.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'null', - 'backendName' => 'excelParseResult', - ], - 'wordParseResult' => [ - 'description' => 'Reserved, can be unused for now.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'null', - 'backendName' => 'wordParseResult', - ], - 'pdfParseResult' => [ - 'description' => 'Reserved, can be unused for now.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'null', - 'backendName' => 'pdfParseResult', - ], - 'imageHeight' => [ - 'description' => 'The height of the page turns to image.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - 'backendName' => 'imageHeight', - ], + 'imageWidth' => ['description' => 'The width of the page turns to image', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'backendName' => 'imageWidth'], + 'imageUrl' => ['description' => '- The image URL after the page is converted to an image. '."\n" + .'- Note: The image URL will be inaccessible after 24 hours, so you need to save it promptly.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2', 'backendName' => 'imageUrl'], + 'pageIdCurDoc' => ['description' => 'The page index in the current document, starting from 0.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'backendName' => 'pageIdCurDoc'], + 'angle' => ['description' => 'The rotation angle of the image after the page is converted to an image.', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'backendName' => 'angle'], + 'excelParseResult' => ['description' => 'Reserved, can be unused for now.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'null', 'backendName' => 'excelParseResult'], + 'wordParseResult' => ['description' => 'Reserved, can be unused for now.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'null', 'backendName' => 'wordParseResult'], + 'pdfParseResult' => ['description' => 'Reserved, can be unused for now.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'null', 'backendName' => 'pdfParseResult'], + 'imageHeight' => ['description' => 'The height of the page turns to image.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'backendName' => 'imageHeight'], ], ], 'ChatRefDocPageNum' => [ @@ -503,24 +274,12 @@ .'List of location information for related documents.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Location information for related documents.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ChatRefDocPostion', - ], + 'items' => ['description' => 'Location information for related documents.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocPostion'], 'extendType' => 'true', ], 'backendName' => 'pos', ], - 'num' => [ - 'description' => 'Page numbers of content related to Q&A.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - 'backendName' => 'num', - ], + 'num' => ['description' => 'Page numbers of content related to Q&A.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'backendName' => 'num'], ], ], 'ChatRefDocPostion' => [ @@ -528,196 +287,50 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'x' => [ - 'description' => 'The x-coordinate of the layout.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - 'backendName' => 'x', - ], - 'y' => [ - 'description' => 'The y-coordinate of the layout.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86', - 'backendName' => 'y', - ], + 'x' => ['description' => 'The x-coordinate of the layout.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'backendName' => 'x'], + 'y' => ['description' => 'The y-coordinate of the layout.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '86', 'backendName' => 'y'], ], ], 'ChunkItem' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'score' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.4295678', - 'backendName' => 'score', - ], - 'docName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'docName', - ], - 'rerankScore' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5053711', - 'backendName' => 'rerankScore', - ], - 'docId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'b4620821aea92c062d8d19ad793243669cf9ae2b900e6967dee6ee9f3bf5feed', - 'backendName' => 'docId', - ], - 'docUrl' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'jobs/a4123b3f-9287-4c61-b59d-32e40fcb0a31/document/8b24a2e06669427fb3dc9812374d9d1a.pdf', - 'backendName' => 'docUrl', - ], - 'weightedScore' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.47252458', - 'backendName' => 'weightedScore', - ], - 'chunkId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'b0x7,b1x10', - 'backendName' => 'chunkId', - ], - 'chunkContent' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'chunkContent', - ], + 'score' => ['title' => '召回分数', 'description' => 'The recall score.', 'type' => 'number', 'format' => 'float', 'example' => '0.4295678'], + 'docName' => ['title' => '文件名', 'description' => 'The file name.', 'type' => 'string', 'example' => '临时场地协议-APM.pdf'], + 'rerankScore' => ['title' => '重排序分数', 'description' => 'The reranking score.', 'type' => 'number', 'format' => 'float', 'example' => '0.5053711'], + 'docId' => ['title' => '文件hash id', 'description' => 'The hash ID of the file.', 'type' => 'string', 'example' => 'b4620821aea92c062d8d19ad793243669cf9ae2b900e6967dee6ee9f3bf5feed'], + 'docUrl' => ['title' => '文件url', 'description' => 'The URL of the file.', 'type' => 'string', 'example' => 'jobs/a4123b3f-9287-4c61-b59d-32e40fcb0a31/document/8b24a2e06669427fb3dc9812374d9d1a.pdf'], + 'weightedScore' => ['title' => '召回权重', 'description' => 'The recall weight.', 'type' => 'number', 'format' => 'float', 'example' => '0.47252458'], + 'chunkId' => ['title' => '"docElsIds"中的元素用逗号连接的结果', 'description' => 'The result of joining the elements in \\`docElsIds\\` with commas.', 'type' => 'string', 'example' => 'b0x7,b1x10'], + 'chunkContent' => ['title' => 'chunk内容', 'description' => 'The content of the chunk.', 'type' => 'string', 'example' => '\\\\n## 第三条 场地占用费(含物业管理费和市场推广费)\\\\n\\\\n3.2 乙方应于本协议签订后 20 个工作日内或该场地交付乙方的同时(以日期在先者为准),\\\\n向甲方一次性支付该场地四个月的场地占用费。\\\\n\\\\n3.3 乙方应向甲方支付的协议价款(场地占用费、物业管理费、市场推广费及本协议约定的其 他费用)以及实际发生的各种性质的价外费用(根据适用税法的相关规定,价外费用包括 但不限于违约金、赔偿金、代收款项、代垫款项)均为含增值税价格。'], 'docElsIds' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '对应原始文件文件块的uniqueId列表', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'b0x7', - 'extendType' => 'true', - ], - 'backendName' => 'docElsIds', + 'items' => ['description' => 'The unique ID of a chunk from the original file.', 'type' => 'string', 'example' => 'b0x7', 'title' => ''], + 'description' => 'A list of unique IDs for the chunks of the original file.', + 'example' => '', ], ], + 'description' => 'Knowledge base retrieval information.', + 'example' => '', ], 'ConstituteItem' => [ - 'title' => '', + 'title' => '构成分析列表结构', 'description' => 'The item of comstitute analysis list.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enterpriseName' => [ - 'title' => '', - 'description' => 'The name of enterprise.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'EnterpriseA', - 'backendName' => 'enterpriseName', - ], - 'rawData' => [ - 'title' => '', - 'description' => 'Raw data'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - 'backendName' => 'rawData', - ], - 'carbonEmissionData' => [ - 'title' => '', - 'description' => 'Carbon emission', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '3.222', - 'backendName' => 'carbonEmissionData', - ], - 'ratio' => [ - 'title' => '', - 'description' => 'Ratio.example value: 0.5 (i. e. 50%).', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - 'backendName' => 'ratio', - ], - 'nameKey' => [ - 'title' => '', - 'description' => 'The unique identifier of name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'carbonInventory.check.indirect_emissions_from_imported_electricity', - 'backendName' => 'nameKey', - ], - 'name' => [ - 'title' => '', - 'description' => 'The name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Scope 1: Direct GHG emissions', - 'backendName' => 'name', - ], - 'emissionSourceKey' => [ - 'title' => '', - 'description' => 'Unique identification of emission source.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec', - 'backendName' => 'emissionSourceKey', - ], - 'emissionSource' => [ - 'title' => '', - 'description' => 'Emission source'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GEC', - 'backendName' => 'emissionSource', - ], - 'dataUnit' => [ - 'title' => '', - 'description' => 'Data Unit'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'kWh', - 'backendName' => 'dataUnit', - ], + 'enterpriseName' => ['title' => '企业名称', 'description' => 'The name of enterprise.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'EnterpriseA', 'backendName' => 'enterpriseName'], + 'rawData' => ['title' => '原始数据', 'description' => 'Raw data'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'rawData'], + 'carbonEmissionData' => ['title' => '碳排放量', 'description' => 'Carbon emission', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '3.222', 'backendName' => 'carbonEmissionData'], + 'ratio' => ['title' => '所占比例', 'description' => 'Ratio.example value: 0.5 (i. e. 50%).', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'backendName' => 'ratio'], + 'nameKey' => ['title' => '名称唯一标识', 'description' => 'The unique identifier of name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'carbonInventory.check.indirect_emissions_from_imported_electricity', 'backendName' => 'nameKey'], + 'name' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Scope 1: Direct GHG emissions', 'backendName' => 'name'], + 'emissionSourceKey' => ['title' => '排放源唯一标识', 'description' => 'Unique identification of emission source.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec', 'backendName' => 'emissionSourceKey'], + 'emissionSource' => ['title' => '排放源', 'description' => 'Emission source'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'GEC', 'backendName' => 'emissionSource'], + 'dataUnit' => ['title' => '数据单位', 'description' => 'Data Unit'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'kWh', 'backendName' => 'dataUnit'], 'envGasEmissions' => [ - 'title' => '', + 'title' => '气体排放详情列表', 'description' => 'Gas Emissions Detail List.', 'visibility' => 'Public', 'type' => 'array', @@ -725,40 +338,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => '', - 'description' => 'A unique key that identifies the gas type.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'type', - ], - 'name' => [ - 'title' => '', - 'description' => 'Name of gas.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'CO₂', - 'backendName' => 'name', - ], - 'gasEmissionData' => [ - 'title' => '', - 'description' => 'Gas emissions.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '4.33', - 'backendName' => 'gasEmissionData', - ], - 'carbonEmissionData' => [ - 'title' => '', - 'description' => 'Carbon emissions.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - 'backendName' => 'carbonEmissionData', - ], + 'type' => ['title' => '标识气体类型的唯一key', 'description' => 'A unique key that identifies the gas type.', 'visibility' => 'Public', 'type' => 'string', 'example' => '1', 'backendName' => 'type'], + 'name' => ['title' => '气体名称', 'description' => 'Name of gas.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'CO₂', 'backendName' => 'name'], + 'gasEmissionData' => ['title' => '气体碳排放量', 'description' => 'Gas emissions.', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '4.33', 'backendName' => 'gasEmissionData'], + 'carbonEmissionData' => ['title' => 'carbonEmissionData'."\0".' 碳排放量', 'description' => 'Carbon emissions.', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'carbonEmissionData'], ], 'extendType' => 'true', ], @@ -767,16 +350,11 @@ 'itemName' => 'gasEmissionItem', ], 'subConstituteItems' => [ - 'title' => '', + 'title' => '子级详情列表', 'description' => 'The child detail list.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Descent emission List', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ConstituteItem', - ], + 'items' => ['description' => 'Descent emission List', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ConstituteItem'], 'backendName' => 'subConstituteItems', 'itemName' => 'constituteItem', ], @@ -785,762 +363,226 @@ 'ContentItem' => [ 'title' => 'ContentItem', 'description' => 'ContentItem', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'score' => [ - 'title' => '', - 'description' => 'Recall confidence', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.45', - 'backendName' => 'score', - ], - 'type' => [ - 'title' => '', - 'description' => 'Text sources: img, table, para.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'img', - 'backendName' => 'type', - ], + 'score' => ['title' => '召回的置信度', 'description' => 'The confidence level of the retrieval.', 'type' => 'number', 'format' => 'double', 'example' => '0.45', 'visibility' => 'Public', 'backendName' => 'score'], + 'type' => ['title' => '文本来源， img, table, para', 'description' => 'The source of the text. Valid values are img, table, and para.', 'type' => 'string', 'example' => 'img', 'visibility' => 'Public', 'backendName' => 'type'], 'extInfo' => [ - 'title' => '', - 'description' => 'The coordinates of the text are in list format.', - 'visibility' => 'Public', + 'title' => '文本的坐标信息，是list形式', + 'description' => 'The coordinates of the text. This is a list.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'alignment' => [ - 'title' => '', - 'description' => 'Enumeration values for page alignment options: center, left, and right.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'center', - 'backendName' => 'alignment', - ], - 'index' => [ - 'title' => '', - 'description' => 'The index of the layout in the text.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - 'backendName' => 'index', - ], - 'level' => [ - 'title' => '', - 'description' => 'Hierarchy of the layout.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'level', - ], + 'alignment' => ['title' => '版面对齐方式 枚举值：center, left, right', 'description' => 'The alignment of the layout. Valid values are center, left, and right.', 'type' => 'string', 'example' => 'center', 'visibility' => 'Public', 'backendName' => 'alignment'], + 'index' => ['title' => '版面在文本中的序号', 'description' => 'The ordinal number of the layout in the text.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'visibility' => 'Public', 'backendName' => 'index'], + 'level' => ['title' => '版面的层级', 'description' => 'The level of the layout.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'level'], 'pageNum' => [ - 'title' => '', - 'description' => 'Page numbers of the layout, which may include multiple page numbers.', - 'visibility' => 'Public', + 'title' => '版面的页码，可能包含多个页码', + 'description' => 'The page number of the layout. This can include multiple page numbers.', 'type' => 'array', - 'items' => [ - 'description' => 'Page number, default value is 1.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'pageNum', ], 'pos' => [ - 'title' => '', - 'description' => 'Position information of the layout, in list format.', - 'visibility' => 'Public', + 'title' => '版面的位置信息，list', + 'description' => 'The position of the layout. This is a list.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'x' => [ - 'title' => '', - 'description' => 'X coordinate of the layout.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'x', - ], - 'y' => [ - 'title' => '', - 'description' => 'Y coordinate of the layout.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'y', - ], + 'x' => ['title' => 'int 版面的x坐标', 'description' => 'The x-coordinate of the layout.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'x'], + 'y' => ['title' => '版面的y坐标', 'description' => 'The y-coordinate of the layout.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'y'], ], + 'description' => '', + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'extendType' => 'true', ], - 'backendName' => 'pos', - ], - 'subType' => [ - 'title' => '', - 'description' => 'Enumeration values for the layout subtypes: picture, para, none', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'picture', - 'backendName' => 'subType', - ], - 'text' => [ - 'title' => 'text', - 'description' => 'text', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'content', - 'backendName' => 'text', - ], - 'type' => [ - 'title' => '', - 'description' => 'Enumeration values for the layout types: table, figure, text, and none.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'table', - 'backendName' => 'type', - ], - 'uniqueId' => [ - 'title' => '', - 'description' => 'Unique layout ID.', + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '88c712db271443dd4e3697cb9b5dab3a', - 'backendName' => 'uniqueId', + 'backendName' => 'pos', ], + 'subType' => ['title' => '版面的子类型 枚举值：picture, para, none', 'description' => 'The subtype of the layout. Valid values are picture, para, and none.', 'type' => 'string', 'example' => 'picture', 'visibility' => 'Public', 'backendName' => 'subType'], + 'text' => ['title' => 'text', 'description' => 'The text content.', 'type' => 'string', 'example' => '版面内容', 'visibility' => 'Public', 'backendName' => 'text'], + 'type' => ['title' => '版面的类型 枚举值：table, figure, text，none', 'description' => 'The type of the layout. Valid values are table, figure, text, and none.', 'type' => 'string', 'example' => 'table', 'visibility' => 'Public', 'backendName' => 'type'], + 'uniqueId' => ['title' => 'str 唯一的版面id', 'description' => 'The unique ID of the layout.', 'type' => 'string', 'example' => '88c712db271443dd4e3697cb9b5dab3a', 'visibility' => 'Public', 'backendName' => 'uniqueId'], ], + 'description' => '', + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'extendType' => 'true', ], - 'backendName' => 'extInfo', - ], - 'text' => [ - 'title' => '', - 'description' => 'Recall text.', + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'content', - 'backendName' => 'text', + 'backendName' => 'extInfo', ], + 'text' => ['title' => '召回文本', 'description' => 'The retrieved text.', 'type' => 'string', 'example' => '租户是xxx', 'visibility' => 'Public', 'backendName' => 'text'], + ], + 'example' => '', + 'cloudType' => 'public', + 'branchId' => 4123116, + 'branchName' => 'master', + 'paramExtraInfo' => [ + '$.components.schemas.ContentItem.properties.extInfo.items.properties.pageNum.description' => '版面的页码，可能包含多个页码', '$.components.schemas.ContentItem.properties.extInfo.items.properties.text.example' => '版面内容', '$.components.schemas.ContentItem.properties.extInfo.items.properties.uniqueId.description' => 'str 唯一的版面id', '$.components.schemas.ContentItem.properties.extInfo.items.properties.alignment.description' => '版面对齐方式的枚举值：center, left, right', '$.components.schemas.ContentItem.properties.extInfo.items.properties.type.example' => 'table', '$.components.schemas.ContentItem.properties.extInfo.items.properties.level.example' => '2', '$.components.schemas.ContentItem.properties.extInfo.items.properties.alignment.example' => 'center', '$.components.schemas.ContentItem.properties.extInfo.description' => '文本的坐标信息，是list形式。', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pageNum.items.example' => '1', '$.components.schemas.ContentItem.properties.score.description' => '召回的置信度。', + '$.components.schemas.ContentItem.properties.score.example' => '0.45', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.y.description' => '版面的y坐标', '$.components.schemas.ContentItem.properties.extInfo.items.properties.subType.example' => 'picture', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.x.description' => 'int 版面的x坐标', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.description' => '版面的位置信息，list', '$.components.schemas.ContentItem.properties.extInfo.items.properties.type.description' => '版面的类型枚举值：table, figure, text，none', '$.components.schemas.ContentItem.properties.type.example' => 'img', '$.components.schemas.ContentItem.description' => 'ContentItem', '$.components.schemas.ContentItem.properties.extInfo.items.properties.uniqueId.example' => '88c712db271443dd4e3697cb9b5dab3a', '$.components.schemas.ContentItem.properties.extInfo.items.properties.index.example' => '8', + '$.components.schemas.ContentItem.properties.extInfo.items.properties.level.description' => '版面的层级', '$.components.schemas.ContentItem.properties.extInfo.items.properties.text.description' => 'text', '$.components.schemas.ContentItem.properties.type.description' => '文本来源， img, table, para', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.x.example' => '1', '$.components.schemas.ContentItem.properties.extInfo.items.properties.index.description' => '版面在文本中的序号', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.y.example' => '2', '$.components.schemas.ContentItem.properties.text.example' => '租户是xxx', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pageNum.items.description' => '页码，默认值 1。'."\n" + ."\n", '$.components.schemas.ContentItem.properties.text.description' => '召回文本', '$.components.schemas.ContentItem.properties.extInfo.items.properties.subType.description' => '版面的子类型枚举值：picture, para, none', ], + 'visibility' => 'Public', ], 'DocumentDetailItem' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6731', - 'backendName' => 'id', - ], - 'folderId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'adafb91d4e014e2eb4d0a5375b547115', - 'backendName' => 'folderId', - ], - 'folderName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'folderName', - ], - 'jobId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6', - 'backendName' => 'jobId', - ], + 'id' => ['description' => 'Primary key ID of the document.', 'type' => 'integer', 'title' => '', 'example' => '6731', 'format' => 'int64'], + 'folderId' => ['description' => 'Folder ID. Get this value from related APIs or the product frontend interface.', 'type' => 'string', 'title' => '', 'example' => 'adafb91d4e014e2eb4d0a5375b547115'], + 'folderName' => ['description' => 'Folder name.', 'type' => 'string', 'title' => '', 'example' => '123/abc/ 文件夹1'], + 'jobId' => ['description' => 'Parsing or extraction job ID. Get this value from related APIs or the product frontend interface.', 'type' => 'string', 'title' => '', 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6'], 'jobStatus' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Job status.', + 'enumValueTitles' => ['PARSING_IN_PROGRESS' => 'PARSING_IN_PROGRESS', 'PARSING_FAILED' => 'PARSING_FAILED', 'QUEUING' => 'QUEUING', 'PENDING_PARSING' => 'PENDING_PARSING', 'CANCELED' => 'CANCELED', 'SUBMISSION_FAILED' => 'SUBMISSION_FAILED', 'PARSING_COMPLETED' => 'PARSING_COMPLETED'], 'type' => 'string', - 'enumValueTitles' => [ - 'PARSING_IN_PROGRESS' => 'PARSING_IN_PROGRESS', - 'PARSING_FAILED' => 'PARSING_FAILED', - 'QUEUING' => 'QUEUING', - 'PENDING_PARSING' => 'PENDING_PARSING', - 'CANCELED' => 'CANCELED', - 'SUBMISSION_FAILED' => 'SUBMISSION_FAILED', - 'PARSING_COMPLETED' => 'PARSING_COMPLETED', - ], + 'title' => '', 'example' => 'PARSING_COMPLETED', - 'backendName' => 'jobStatus', - ], - 'docName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'docName', - ], - 'originDocName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'originDocName', - ], - 'docUrl' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/docName', - 'backendName' => 'docUrl', - ], - 'originDocUrl' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/originDocName', - 'backendName' => 'originDocUrl', - ], - 'docHash' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '5335c8828ccf735a500ed636590c713a94daf6cdacc90237733035cc5a152afb_1760513801010', - 'backendName' => 'docHash', - ], - 'createTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-09-08T17:04:28.000+08:00', - 'backendName' => 'createTime', - ], - 'updateTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-09-08T17:04:28.000+08:00', - 'backendName' => 'updateTime', ], + 'docName' => ['description' => 'Document name.', 'type' => 'string', 'title' => '', 'example' => '123/abc/ 文档1.pdf'], + 'originDocName' => ['description' => 'Original document name.', 'type' => 'string', 'title' => '', 'example' => '123/abc/ 文档1.pdf/.doc/docx/csv/xlsx/txt'], + 'docUrl' => ['description' => 'Document URL.', 'type' => 'string', 'title' => '', 'example' => 'https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/docName'], + 'originDocUrl' => ['description' => 'Original document URL.', 'type' => 'string', 'title' => '', 'example' => 'https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/originDocName'], + 'docHash' => ['description' => 'Document hash value.', 'type' => 'string', 'title' => '', 'example' => '5335c8828ccf735a500ed636590c713a94daf6cdacc90237733035cc5a152afb_1760513801010'], + 'createTime' => ['description' => 'Creation time (UTC+8).', 'type' => 'string', 'title' => '', 'example' => '2025-09-08T17:04:28.000+08:00', 'format' => 'iso8601'], + 'updateTime' => ['description' => 'Update time (UTC+8).', 'type' => 'string', 'title' => '', 'example' => '2025-09-08T17:04:28.000+08:00', 'format' => 'iso8601'], ], + 'description' => 'Describes key information about a document.', + 'title' => '', + 'example' => '', ], 'EpdInventoryConstituteItem' => [ - 'title' => '', + 'title' => 'epd清单结构体', 'description' => 'epd inventory structure'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'inventoryValuePerProduct' => [ - 'title' => '', - 'description' => 'Activity data per functional unit: only the third level is not empty; the value retains 24 decimal places, indicating the number of activities per functional unit; should be used in conjunction with the inventoryValuePerProductUnit.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.000000000000000000000000', - 'backendName' => 'inventoryValuePerProduct', - ], - 'factorDataset' => [ - 'title' => '', - 'description' => 'The database to which the factorDataset factor belongs. This field is used in conjunction with factorType. If factorType is 1, the data name of the factor is displayed. If factorType is 2,factorId indicates the ID of the referenced product. If factorType is null,factorId is meaningless. This field is a new field. Old data may not have data in this field and is displayed as "/".'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '/', - 'backendName' => 'factorDataset', - ], - 'percent' => [ - 'title' => '', - 'description' => 'The percentage. Four decimal places are retained and 31.4000 is returned to indicate the percentage 31.4%. The first level returns null; The second level returns the current process as a percentage of total emissions; the third level returns the current inventory as a percentage of total emissions.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '31.4000', - 'backendName' => 'percent', - ], - 'inventoryValuePerProductUnit' => [ - 'title' => '', - 'description' => 'Unit of activity data per functional unit. Only the third level is not empty. in the inventory information indicates the unit of activity data per functional unit.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'kg', - 'backendName' => 'inventoryValuePerProductUnit', - ], - 'num' => [ - 'title' => '', - 'description' => 'Category key, please refer to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'num', - ], - 'quantity' => [ - 'title' => '', - 'description' => 'Raw activity data. Only the third level returns a quantity that is not null, indicating a manifest.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.000000000000', - 'backendName' => 'num', - ], - 'resourceType' => [ - 'title' => '', - 'description' => 'The type of the inventory. Only the third level returns non-null, and the third level is the inventory details. This field indicates the resource type name of the inventory. You may refer to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Energy', - 'backendName' => 'resourceType', - ], - 'factorType' => [ - 'title' => '', - 'description' => 'The key of the factor type. Only the third level is not empty. The factorType in the inventory information indicates that the factor source type is selected; the optional values are 1, 2, or null:1: factor library, 2: product library. null indicates that the factor is not selected from the factor library or product library, and the factor is constructed by the user.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'factorType', - ], - 'unit' => [ - 'title' => '', - 'description' => 'The unit of environmental impact result value. This unit is the unit of the environmental impact result value of the corresponding environmental impact category. For example, the unit kg CO2-Eq represent the emission values shown here is kg CO2-Eq.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'kg CO2-Eq', - 'backendName' => 'unit', - ], - 'name' => [ - 'title' => '', - 'description' => 'Returns the name of the current level. The names of different levels have different meanings. The first level returns the environmental impact type. The second level returns the current process name. The third level returns the current inventory name', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'climate change', - 'backendName' => 'name', - ], - 'inventoryId' => [ - 'title' => '', - 'description' => 'manifest id'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'inventoryId', - ], - 'inventoryValue' => [ - 'title' => '', - 'description' => 'The quantity of the inventory. It is not empty only at the third level. The third level is the inventory details. This field indicates the id of the inventory. It should be used in conjunction with the InventoryUnit.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '2.000000000000000000000000', - 'backendName' => 'inventoryValue', - ], - 'factorUnit' => [ - 'title' => '', - 'description' => 'Factor Unit'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'kg CO2-Eq/kg', - 'backendName' => 'factorUnit', - ], - 'inventoryUnit' => [ - 'title' => '', - 'description' => 'Inventory Unit'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 't', - 'backendName' => 'inventoryUnit', - ], - 'state' => [ - 'title' => '', - 'description' => 'The data status. 1 indicates accurate calculation, 2 indicates default data, 3 indicates missing factor, and 0 value is used in other cases.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'state', - ], - 'factor' => [ - 'title' => '', - 'description' => 'The value of the factor. Only the third level is not empty. The factor in the inventory information indicates the factor value of the selected factor. The factor value is kept to four decimal places after the decimal point, and "1.0000" indicates that the factor value is 1. The factor value should be used in combination with factorUnit. If factorUnit is "kg CO2-Eq mg/kg", it means that the carbon emission per 1kg of the list is 1kg CO2-Eq.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1.0000', - 'backendName' => 'factor', - ], - 'carbonEmission' => [ - 'title' => '', - 'description' => 'Emissions are presented with 24 decimal places. It\'s advisable to utilize the truncated version. These emissions encompass all tiers: At the first level, they reflect the product\'s total emissions under the current environmental impact; at the second level, they show the process\'s total emissions; and at the third level, they represent the inventory\'s emissions within the same environmental impact context.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1009.976265540000000000000000000000', - 'backendName' => 'carbonEmission', - ], - 'factorId' => [ - 'title' => '', - 'description' => 'The id of the factor.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1234', - 'backendName' => 'factorId', - ], + 'inventoryValuePerProduct' => ['title' => '每功能单位活动数据', 'description' => 'Activity data per functional unit: only the third level is not empty; the value retains 24 decimal places, indicating the number of activities per functional unit; should be used in conjunction with the inventoryValuePerProductUnit.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.000000000000000000000000', 'backendName' => 'inventoryValuePerProduct'], + 'factorDataset' => ['title' => 'factorDataset 因子所属数据库', 'description' => 'The database to which the factorDataset factor belongs. This field is used in conjunction with factorType. If factorType is 1, the data name of the factor is displayed. If factorType is 2,factorId indicates the ID of the referenced product. If factorType is null,factorId is meaningless. This field is a new field. Old data may not have data in this field and is displayed as "/".'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '/', 'backendName' => 'factorDataset'], + 'percent' => ['title' => '所占比例', 'description' => 'The percentage. Four decimal places are retained and 31.4000 is returned to indicate the percentage 31.4%. The first level returns null; The second level returns the current process as a percentage of total emissions; the third level returns the current inventory as a percentage of total emissions.', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '31.4000', 'backendName' => 'percent'], + 'inventoryValuePerProductUnit' => ['title' => '每功能单位活动数据单位', 'description' => 'Unit of activity data per functional unit. Only the third level is not empty. in the inventory information indicates the unit of activity data per functional unit.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg', 'backendName' => 'inventoryValuePerProductUnit'], + 'num' => ['title' => '类别key', 'description' => 'Category key, please refer to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'num'], + 'quantity' => ['title' => '原始活动数据', 'description' => 'Raw activity data. Only the third level returns a quantity that is not null, indicating a manifest.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.000000000000', 'backendName' => 'num'], + 'resourceType' => ['title' => '清单类型', 'description' => 'The type of the inventory. Only the third level returns non-null, and the third level is the inventory details. This field indicates the resource type name of the inventory. You may refer to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Energy', 'backendName' => 'resourceType'], + 'factorType' => ['title' => 'factorType 因子类型key', 'description' => 'The key of the factor type. Only the third level is not empty. The factorType in the inventory information indicates that the factor source type is selected; the optional values are 1, 2, or null:1: factor library, 2: product library. null indicates that the factor is not selected from the factor library or product library, and the factor is constructed by the user.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'factorType'], + 'unit' => ['title' => '环境影响结果值单位', 'description' => 'The unit of environmental impact result value. This unit is the unit of the environmental impact result value of the corresponding environmental impact category. For example, the unit kg CO2-Eq represent the emission values shown here is kg CO2-Eq.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg CO2-Eq', 'backendName' => 'unit'], + 'name' => ['title' => '名称', 'description' => 'Returns the name of the current level. The names of different levels have different meanings. The first level returns the environmental impact type. The second level returns the current process name. The third level returns the current inventory name', 'visibility' => 'Public', 'type' => 'string', 'example' => 'climate change', 'backendName' => 'name'], + 'inventoryId' => ['title' => '清单id', 'description' => 'manifest id'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'inventoryId'], + 'inventoryValue' => ['title' => '清单数量', 'description' => 'The quantity of the inventory. It is not empty only at the third level. The third level is the inventory details. This field indicates the id of the inventory. It should be used in conjunction with the InventoryUnit.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '2.000000000000000000000000', 'backendName' => 'inventoryValue'], + 'factorUnit' => ['title' => '因子单位', 'description' => 'Factor Unit'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg CO2-Eq/kg', 'backendName' => 'factorUnit'], + 'inventoryUnit' => ['title' => '清单单位', 'description' => 'Inventory Unit'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 't', 'backendName' => 'inventoryUnit'], + 'state' => ['title' => '数据状态', 'description' => 'The data status. 1 indicates accurate calculation, 2 indicates default data, 3 indicates missing factor, and 0 value is used in other cases.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'state'], + 'factor' => ['title' => '因子值', 'description' => 'The value of the factor. Only the third level is not empty. The factor in the inventory information indicates the factor value of the selected factor. The factor value is kept to four decimal places after the decimal point, and "1.0000" indicates that the factor value is 1. The factor value should be used in combination with factorUnit. If factorUnit is "kg CO2-Eq mg/kg", it means that the carbon emission per 1kg of the list is 1kg CO2-Eq.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '1.0000', 'backendName' => 'factor'], + 'carbonEmission' => ['title' => '排放量', 'description' => 'Emissions are presented with 24 decimal places. It\'s advisable to utilize the truncated version. These emissions encompass all tiers: At the first level, they reflect the product\'s total emissions under the current environmental impact; at the second level, they show the process\'s total emissions; and at the third level, they represent the inventory\'s emissions within the same environmental impact context.', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', 'backendName' => 'carbonEmission'], + 'factorId' => ['title' => '因子id', 'description' => 'The id of the factor.', 'visibility' => 'Public', 'type' => 'string', 'example' => '1234', 'backendName' => 'factorId'], 'items' => [ - 'title' => '', + 'title' => '子级列表', 'description' => 'List of children'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The list of children. The third level returns null.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/EpdInventoryConstituteItem', - ], + 'items' => ['description' => 'The list of children. The third level returns null.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/EpdInventoryConstituteItem'], 'backendName' => 'items', ], ], ], 'FolderItem' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'folderId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '4b648f6d11344f258df876cbdc24dc1f', - 'backendName' => 'folderId', - ], - 'folderNum' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'backendName' => 'folderNum', - ], - 'docCount' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'docCount', - ], - 'folderName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“abc” “1234”', - 'backendName' => 'folderName', - ], - 'parentFolderId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"0" ：parent folder is root'."\n" - .'"4b648f6d11344f258df876cbdc24dc1f" ： folderId', - 'backendName' => 'parentFolderId', - ], - 'folderDefault' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'folderDefault', - ], - 'currentLevel' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'currentLevel', - ], - 'syncStatus' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - 'backendName' => 'syncStatus', - ], - 'syncParsingStatus' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - 'backendName' => 'syncParsingStatus', - ], - 'ossDomain' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com ', - 'backendName' => 'ossDomain', - ], - 'ossUpdateBy' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1696462764375572', - 'backendName' => 'ossUpdateBy', - ], - 'taskId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'taskId', - ], - 'resourcePath' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'folder/manual/', - 'backendName' => 'resourcePath', - ], - 'storageType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'storageType', - ], - 'ossPath' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test/', - 'backendName' => 'ossPath', - ], + 'folderId' => ['description' => 'The folder ID returned by the API after successful folder creation.', 'type' => 'string', 'title' => '', 'example' => '4b648f6d11344f258df876cbdc24dc1f'], + 'folderNum' => ['description' => 'Folder sort order.', 'type' => 'integer', 'title' => '', 'example' => '2', 'format' => 'int32'], + 'docCount' => ['description' => 'Number of subfolders in the current folder. For a new folder, this value defaults to 0.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], + 'folderName' => ['description' => 'Folder name defined by the user.', 'type' => 'string', 'title' => '', 'example' => '“abc” “1234”'], + 'parentFolderId' => ['description' => 'ID of the parent folder.', 'type' => 'string', 'title' => '', 'example' => '"0" ：parent folder is root'."\n" + .'"4b648f6d11344f258df876cbdc24dc1f" ： folderId'], + 'folderDefault' => ['description' => '1: default folder. 0: non-default folder. This value defaults to 0 for users.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], + 'currentLevel' => ['description' => 'Current level.', 'type' => 'integer', 'title' => '', 'example' => '1', 'format' => 'int32'], + 'syncStatus' => ['description' => 'OSS sync extraction status: -1 (not set, default), 0 (disabled), 1 (enabled).', 'type' => 'integer', 'title' => '', 'example' => '-1', 'format' => 'int32'], + 'syncParsingStatus' => ['description' => 'OSS sync parsing status: -1 (not set, default), 0 (disabled), 1 (enabled).', 'type' => 'integer', 'title' => '', 'example' => '-1', 'format' => 'int32'], + 'ossDomain' => ['description' => 'OSS bucket address.', 'type' => 'string', 'title' => '', 'example' => 'aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com '], + 'ossUpdateBy' => ['description' => 'OSS operator.', 'type' => 'string', 'title' => '', 'example' => '1696462764375572'], + 'taskId' => ['description' => 'ID of the task that created the folder. 0 indicates manual creation.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int64'], + 'resourcePath' => ['description' => 'External resource path.', 'type' => 'string', 'title' => '', 'example' => 'folder/manual/'], + 'storageType' => ['description' => 'Storage class.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], + 'ossPath' => ['description' => 'OSS path.', 'type' => 'string', 'title' => '', 'example' => 'test/'], 'subFolderList' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FolderItem', - ], - 'backendName' => 'subFolderList', + 'items' => ['description' => 'Subfolder entity.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/FolderItem'], + 'description' => 'List of subfolders. Defaults to empty.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'Describes key information of the folder data structure.', + 'title' => '', + 'example' => '', ], 'GwpInventoryConstitute' => [ - 'title' => '', + 'title' => '温室气体构成', 'description' => 'Composition of greenhouse gases'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'percent' => [ - 'title' => '', - 'description' => 'Percentage of emissions, for example 100.00 means 100.00%.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.00', - 'backendName' => 'percent', - ], - 'resourceType' => [ - 'title' => '', - 'description' => 'Resouce type of inventory.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'resourceType', - ], - 'unit' => [ - 'title' => '', - 'description' => 'Unit', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'kgCO₂e/kg', - 'backendName' => 'unit', - ], - 'carbonEmission' => [ - 'title' => '', - 'description' => 'Emission quantity'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1009.976265540000000000000000000000', - 'backendName' => 'carbonEmission', - ], - 'name' => [ - 'title' => '', - 'description' => 'Name', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Acquisition of Raw Materials', - 'backendName' => 'name', - ], + 'percent' => ['title' => '排放百分比', 'description' => 'Percentage of emissions, for example 100.00 means 100.00%.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '100.00', 'backendName' => 'percent'], + 'resourceType' => ['title' => '清单类型', 'description' => 'Resouce type of inventory.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'resourceType'], + 'unit' => ['title' => '单位', 'description' => 'Unit', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kgCO₂e/kg', 'backendName' => 'unit'], + 'carbonEmission' => ['title' => '排放数量', 'description' => 'Emission quantity'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', 'backendName' => 'carbonEmission'], + 'name' => ['title' => '排放体名称', 'description' => 'Name', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Acquisition of Raw Materials', 'backendName' => 'name'], 'byResourceType' => [ - 'title' => '', + 'title' => '按类型聚合列表', 'description' => 'Grouped by inventory resource type, this data reveals emissions details for each category. It serves the "By type" analysis in the composition breakdown. A nested structure is employed: total carbon emissions are organized first by inventory type, forming a two-level hierarchy, with the innermost level \'byResource\' currently empty.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Aggregates the inventory list by resource type.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/GwpResourceConstitute', - ], + 'items' => ['description' => 'Aggregates the inventory list by resource type.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GwpResourceConstitute'], 'backendName' => 'byResourceType', ], 'items' => [ - 'title' => '', + 'title' => '构成详情列表', 'description' => 'Organized hierarchically, it cascades from high to low: flow-> process-> inventory level. Employed for "By inventory" analysis in compositional breakdowns, the innermost layer of this nested structure is empty.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Show inventory hierarchy.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/GwpInventoryConstitute', - ], + 'items' => ['description' => 'Show inventory hierarchy.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GwpInventoryConstitute'], 'backendName' => 'items', ], ], ], 'GwpResourceConstitute' => [ - 'title' => '', - 'description' => 'Carbon emission structure of gwp inventory.'."\n", + 'title' => '资源构成结构体', + 'description' => 'The structure of carbon emissions for the GWP checklist.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'Name signifies a concept with distinct layers of meaning, where the outermost layer represents the overall carbon emissions.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Energy', - 'backendName' => 'name', - ], - 'unit' => [ - 'title' => '', - 'description' => 'unit of emissions.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'kgCO₂e/Piece(s)', - 'backendName' => 'unit', - ], - 'resourceType' => [ - 'title' => '', - 'description' => 'The type of the inventory. It is meaningful at the inventory layer and can be empty at other layers.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'resourceType', - ], - 'carbonEmission' => [ - 'title' => '', - 'description' => 'The carbon emissions. To ensure accuracy, retain 24 decimal places. We recommend that you intercept the carbon emissions.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1009.976265540000000000000000000000', - 'backendName' => 'carbonEmission', - ], - 'percent' => [ - 'title' => '', - 'description' => 'Percentage of emissions. 98.76 indicates the proportion of 98.76%.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '98.76', - 'backendName' => 'percent', - ], + 'name' => ['title' => '名称', 'description' => 'The name. The meaning of this parameter varies by layer. The outermost layer represents the total carbon emissions.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'Energy'], + 'unit' => ['title' => '单位', 'description' => 'The unit of emissions.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'unit', 'example' => 'kgCO₂e/Piece(s)'], + 'resourceType' => ['title' => '清单类型', 'description' => 'The type of checklist. This parameter applies only to the checklist layer and can be empty for other layers.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'resourceType', 'example' => '1'], + 'carbonEmission' => ['title' => '碳排放当量', 'description' => 'The amount of carbon emissions. To ensure precision, the value is retained to 24 decimal places. Truncate the value before use.', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'backendName' => 'carbonEmission', 'example' => '1009.976265540000000000000000000000'], + 'percent' => ['title' => '排放百分比', 'description' => 'The emission percentage. For example, a value of 98.76 represents 98.76%.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'percent', 'example' => '98.76'], ], ], 'OrgEmission' => [ - 'title' => '', + 'title' => '组织分析返回值结构', 'description' => 'Organization Analysis Return Value Structure'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'The name of the organization.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'EnterpriseZ', - 'backendName' => 'name', - 'itemName' => 'name', - ], - 'nameKey' => [ - 'title' => '', - 'description' => 'Enterprise type'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Z-20240115-4', - 'backendName' => 'nameKey', - ], - 'carbonEmissionData' => [ - 'title' => '', - 'description' => 'Carbon Equivalent'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - 'backendName' => 'carbonEmissionData', - ], - 'weightingCarbonEmissionData' => [ - 'title' => '', - 'description' => 'Calculate carbon emissions by share ratio'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '2.3', - 'backendName' => 'weightingCarbonEmissionData', - ], - 'weightingRatio' => [ - 'title' => '', - 'description' => 'Share ratio Carbon emissions YoY'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.4', - 'backendName' => 'weightingRatio', - ], - 'ratio' => [ - 'title' => '', - 'description' => 'Proportion of carbon emissions'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.2', - 'backendName' => 'ratio', - ], - 'weightingProportion' => [ - 'title' => '', - 'description' => 'Weight ratio'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.3', - 'backendName' => 'weightingProportion', - ], + 'name' => ['title' => '企业名称', 'description' => 'The name of the organization.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'EnterpriseZ', 'backendName' => 'name', 'itemName' => 'name'], + 'nameKey' => ['title' => '企业类型', 'description' => 'Enterprise type'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Z-20240115-4', 'backendName' => 'nameKey'], + 'carbonEmissionData' => ['title' => '碳排放当量', 'description' => 'Carbon Equivalent'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'carbonEmissionData'], + 'weightingCarbonEmissionData' => ['title' => '按股比计算碳排', 'description' => 'Calculate carbon emissions by share ratio'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '2.3', 'backendName' => 'weightingCarbonEmissionData'], + 'weightingRatio' => ['title' => '股比碳排同比', 'description' => 'Share ratio Carbon emissions YoY'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.4', 'backendName' => 'weightingRatio'], + 'ratio' => ['title' => '碳排占比', 'description' => 'Proportion of carbon emissions'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.2', 'backendName' => 'ratio'], + 'weightingProportion' => ['title' => '权重比例', 'description' => 'Weight ratio'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.3', 'backendName' => 'weightingProportion'], 'moduleEmissionList' => [ - 'title' => '', + 'title' => '分模块碳排数据', 'description' => 'Sub-module carbon emission data'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1548,40 +590,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '模块名', - 'description' => 'module name', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Scope 1: Direct GHG emissions', - 'backendName' => 'name', - ], - 'nameKey' => [ - 'title' => '', - 'description' => 'Module key'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', - 'backendName' => 'nameKey', - ], - 'carbonEmissionData' => [ - 'title' => '', - 'description' => 'Carbon emissions'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - 'backendName' => 'carbonEmissionData', - ], - 'ratio' => [ - 'title' => '', - 'description' => 'Proportion of carbon emissions'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.2', - 'backendName' => 'ratio', - ], + 'name' => ['title' => '模块名', 'description' => 'module name', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Scope 1: Direct GHG emissions', 'backendName' => 'name'], + 'nameKey' => ['title' => '模块key', 'description' => 'Module key'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', 'backendName' => 'nameKey'], + 'carbonEmissionData' => ['title' => '碳排量', 'description' => 'Carbon emissions'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'carbonEmissionData'], + 'ratio' => ['title' => '碳排量占比', 'description' => 'Proportion of carbon emissions'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.2', 'backendName' => 'ratio'], ], 'extendType' => 'true', 'description' => 'Module struct.', @@ -1590,16 +602,11 @@ 'itemName' => 'ModuleEmissionItem', ], 'subEmissionItems' => [ - 'title' => '', + 'title' => '子级数据，即组织下的场地数据', 'description' => 'Sub-level data, that is, site data under the organization'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Lower-level enterprise list'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/OrgEmission', - ], + 'items' => ['description' => 'Lower-level enterprise list'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/OrgEmission'], 'backendName' => 'subEmissionItems', 'itemName' => 'SubEmissionItem', ], @@ -1608,29 +615,27 @@ ], ], 'apis' => [ - 'GetDataItemList' => [ - 'summary' => 'This interface is used to obtain the details category of a data item.', - 'path' => '/api/v1/carbon/emission/data/item/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AISearchResourceAdd' => [ + 'summary' => 'Adds a structured element to an AISearch project. Supported element types include miniapp and product.', + 'path' => '/api/v1/aiSearch/resource/add', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -1638,204 +643,358 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', + 'type' => [ + 'description' => 'The type of the structured element.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'mini program'], 'type' => 'string', 'required' => true, - 'example' => 'C-202302-01', - ], + 'example' => 'miniapp', + 'title' => '', + ], + 'data' => ['description' => 'The information about the structured element that corresponds to the `type` parameter. Pass the value for this parameter in the specified JSON format.'."\n" + ."\n" + .'<details>'."\n" + ."\n" + .'<summary>'."\n" + ."\n" + .'If the type is miniapp:'."\n" + ."\n" + .'</summary>'."\n" + ."\n" + .'- miniappId: Required. The unique ID of the miniapp.'."\n" + ."\n" + .'- title: Required. The name of the miniapp.'."\n" + ."\n" + .'- version: Required. The version number.'."\n" + ."\n" + .'- description: Required. A brief description.'."\n" + ."\n" + .'- detailDesc: Optional. A detailed description.'."\n" + ."\n" + .'- slogan: Optional. The slogan.'."\n" + ."\n" + .'- icon: Required. The URL of the icon.'."\n" + ."\n" + .'- url: Required. The URL of the miniapp.'."\n" + ."\n" + .'</details>'."\n" + ."\n" + .'<details>'."\n" + ."\n" + .'<summary>'."\n" + ."\n" + .'If the type is product:'."\n" + ."\n" + .'</summary>'."\n" + ."\n" + .'- title: Required. The name of the product.'."\n" + ."\n" + .'- description: Required. A description of the product.'."\n" + ."\n" + .'- icon: Required. The URL of the product icon.'."\n" + ."\n" + .'- url: Required. The URL of the product.'."\n" + ."\n" + .'- price: Required. The price.'."\n" + ."\n" + .'- extra: Optional. An extension field. An object that consists of any key-value pairs.'."\n" + ."\n" + .'</details>', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "miniapp_id": "test_miniapp",'."\n" + .' "title": "testApp",'."\n" + .' "version": "1.0.5",'."\n" + .' "description": "description-mock",'."\n" + .' "slogan": "slogan-mock",'."\n" + .' "icon": "https://img.alicdn.com/test_icon.png",'."\n" + .' "detail_desc": "detail-mock"'."\n" + .'}', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'], 'data' => [ - 'description' => 'Response parameters.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'unit' => [ - 'description' => 'The data item unit.', - 'type' => 'string', - 'example' => 'kg', - ], - 'period' => [ - 'description' => 'Data filling method, 1: monthly value 2: annual value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'code' => [ - 'description' => 'The identifier of the data item.'."\n", - 'type' => 'string', - 'example' => 'demo_api_code', - ], - 'name' => [ - 'description' => 'The name of the data item.'."\n", - 'type' => 'string', - 'example' => 'name_bbb', - ], + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The type of the structured element. The value of this parameter is the same as the type parameter in the request.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'mini program'], + 'type' => 'string', + 'example' => 'miniapp', + 'title' => '', ], + 'resourceId' => ['description' => 'The ID of the structured element resource. This ID is the unique and immutable identifier of the resource in the database. Use this ID for subsequent modification, deletion, and query operations.', 'type' => 'string', 'example' => 'WzMGQZwB7nQEs3Qk3ajH', 'title' => ''], ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"unit\\": \\"kg\\",\\n \\"period\\": 1,\\n \\"code\\": \\"demo_api_code\\",\\n \\"name\\": \\"锅炉数据\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetDataItemList', - 'description' => '- obtain data item detail list under the current enterprise.', - ], - 'PushItemData' => [ - 'summary' => 'This interface is used to push data items.', - 'path' => '/api/v1/carbon/emission/data/item/push', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AISearchResourceAdd', + 'requestParamsDescription' => 'The type parameter is an enumeration. Only the specified values are supported. If you specify an unsupported value, the API call fails. Additional structured content types will be supported in future releases.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceAdd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"type\\": \\"miniapp\\",\\n \\"resourceId\\": \\"WzMGQZwB7nQEs3Qk3ajH\\"\\n }\\n}","type":"json"}]', + ], + 'AISearchResourceDelete' => [ + 'path' => '/api/v1/aiSearch/resource/delete', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => 'Structured element type', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'], + 'type' => 'string', + 'required' => true, + 'example' => 'miniapp', + 'title' => '', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => ['description' => 'Structured element resource ID. This is the unique and immutable identifier for the resource in the database.', 'type' => 'string', 'required' => true, 'example' => 'WzMGQZwB7nQEs3Qk3ajH', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The request body parameters.'."\n", 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20210223-01', - ], - 'year' => [ - 'description' => 'The year of the data created.', - 'type' => 'string', - 'required' => true, - 'example' => '2024', - ], - 'items' => [ - 'description' => 'List of data to be pushed.', + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'API data identification.<props="intl">For details: [GetDataItemList ](https://www.alibabacloud.com/help/en/energy-expert/developer-reference/api-energyexpertexternal-2022-09-23-getdataitemlist)</props>', - 'type' => 'string', - 'required' => true, - 'example' => 'demo_api_code', - ], - 'month' => [ - 'description' => 'The month.'."\n", + 'type' => [ + 'description' => 'Structured element type. Must match the type request parameter.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'], 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'value' => [ - 'description' => 'The value of the data item.', - 'type' => 'number', - 'format' => 'double', - 'required' => true, - 'example' => '1.11', + 'example' => 'miniapp', + 'title' => '', ], + 'resourceId' => ['description' => 'Structured element resource ID. This is the unique and immutable identifier for the resource in the database.', 'type' => 'string', 'example' => 'WzMGQZwB7nQEs3Qk3ajH', 'title' => ''], ], - 'required' => true, + 'description' => 'Response data', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Response schema', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AISearchResourceDelete', + 'summary' => 'Delete a structured element from an AISearch project by specifying the resource type and resource ID.', + 'requestParamsDescription' => 'The type field is an enumeration. Only the listed values are supported. Using any other value causes the API to fail. Additional structured element types may be added in future releases.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"type\\": \\"miniapp\\",\\n \\"resourceId\\": \\"WzMGQZwB7nQEs3Qk3ajH\\"\\n }\\n}","type":"json"}]', + ], + 'AISearchResourceGetList' => [ + 'path' => '/api/v1/aiSearch/resource/list', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => 'Structured element type', + 'enumValueTitles' => ['product' => 'Product', 'miniapp' => 'Mini Program'], + 'type' => 'string', + 'required' => true, + 'example' => 'miniapp', + 'title' => '', + ], + ], + [ + 'name' => 'resourceIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => ['description' => 'Structured element resource ID. This is the unique and immutable identifier for the resource in the database.', 'type' => 'string', 'required' => false, 'example' => ' '."\n" + .'WzMGQZwB7nQEs3Qk3ajH'."\n", 'title' => ''], + 'description' => 'Resources to query. If empty, the API returns all resources of the specified type using paging.', 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'Paging size. Default is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'currentPage', + 'in' => 'query', + 'schema' => ['description' => 'Paging page number. Starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => 'A8AEC6D9-A359-5169-BD1A-BD848BA60D65'], 'data' => [ - 'description' => 'Whether the data is pushed successfully.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'Total number of resources', 'type' => 'integer', 'format' => 'int64', 'example' => '68', 'title' => ''], + 'currentPage' => ['description' => 'Current page number', 'type' => 'string', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'Paging size', 'type' => 'string', 'example' => '20', 'title' => ''], + 'items' => [ + 'type' => 'array', + 'items' => ['description' => 'Resource details', 'type' => 'any', 'example' => ' {"type":"miniapp","score":0.4571971,"resourceId":"1512004139024243527680","miniappId":"","title":"Electronic Invoice","version":"1.0.0","description":"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.","slogan":"E-Invoice mini-app","icon":"https://gw.alicdn.com/6000000000498-2-tps-200-200.png","url":"https://app-intl.com/release/6592_v1.6.16_poc.zip","detailDescription":null}', 'title' => ''], + 'description' => 'Resource list', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Response data', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Response schema', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AISearchResourceGetList', + 'summary' => 'When you query structured resources in AISearch, you must specify a resource type. The supported types are Mini Program (miniapp) and product. If you provide a resource ID, the query returns the specified resource. If you do not provide a resource ID, the query returns all resources of that type by paging.', + 'requestParamsDescription' => 'The type field is an enumeration. Only the listed values are valid. Using any other value will cause the API call to fail. More structured content types may be added in the future.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'PushItemData', - 'description' => '- This interface is used for individual data item data.'."\n" - .'- Data items can link data to services such as carbon footprints and carbon inventories.'."\n" - .'- Depending on the platform configuration, active data on a yearly and monthly basis is supported.', - ], - 'RecalculateCarbonEmission' => [ - 'summary' => 'Recalculate carbon emissions.', - 'path' => '/api/v1/carbon/emission/data/item/recalculate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceGetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": {\\n \\"total\\": 68,\\n \\"currentPage\\": \\"1\\",\\n \\"pageSize\\": \\"20\\",\\n \\"items\\": [\\n \\" {\\\\\\"type\\\\\\":\\\\\\"miniapp\\\\\\",\\\\\\"score\\\\\\":0.4571971,\\\\\\"resourceId\\\\\\":\\\\\\"1512004139024243527680\\\\\\",\\\\\\"miniappId\\\\\\":\\\\\\"\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Electronic Invoice\\\\\\",\\\\\\"version\\\\\\":\\\\\\"1.0.0\\\\\\",\\\\\\"description\\\\\\":\\\\\\"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.\\\\\\",\\\\\\"slogan\\\\\\":\\\\\\"E-Invoice mini-app\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"https://gw.alicdn.com/6000000000498-2-tps-200-200.png\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://app-intl.com/release/6592_v1.6.16_poc.zip\\\\\\",\\\\\\"detailDescription\\\\\\":null}\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'AISearchResourceUpdate' => [ + 'summary' => 'Updates structured elements in an AISearch project. Supported element types include miniapps (miniapp) and products (product).', + 'path' => '/api/v1/aiSearch/resource/update', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -1843,78 +1002,147 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20240202-01', - ], - 'year' => [ - 'description' => 'Year of inventory.', + 'type' => [ + 'description' => 'The type of the structured element.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'], 'type' => 'string', 'required' => true, - 'example' => '2024', - ], + 'example' => 'miniapp', + 'title' => '', + ], + 'resourceId' => ['description' => 'The resource ID of the structured element. This ID is a unique and immutable identifier for the resource in the database.', 'type' => 'string', 'required' => true, 'example' => 'WzMGQZwB7nQEs3Qk3ajH', 'title' => ''], + 'data' => ['description' => 'Updates the information for the specified resource. Pass the fields to update in this parameter in JSON format. Fields that are not included are not modified.'."\n" + ."\n" + .'<details>'."\n" + ."\n" + .'<summary>'."\n" + ."\n" + .'If the type is miniapp, the following fields can be updated:'."\n" + ."\n" + .'</summary>'."\n" + ."\n" + .'- "miniappId": "The unique ID of the miniapp"'."\n" + ."\n" + .'- "title": "The name of the miniapp"'."\n" + ."\n" + .'- "version": "The version number"'."\n" + ."\n" + .'- "description": "A brief description",'."\n" + ."\n" + .'- "detailDesc": "A detailed description",'."\n" + ."\n" + .'- "slogan": "The slogan"'."\n" + ."\n" + .'- "icon": "The icon URL",'."\n" + ."\n" + .'- "url": "The miniapp URL"'."\n" + ."\n" + .'</details>'."\n" + ."\n" + .'<details>'."\n" + ."\n" + .'<summary>'."\n" + ."\n" + .'If the type is product, the following fields can be updated:'."\n" + ."\n" + .'</summary>'."\n" + ."\n" + .'- "title": "The product name"'."\n" + ."\n" + .'- "description": "The product description",'."\n" + ."\n" + .'- "icon": "The product icon URL",'."\n" + ."\n" + .'- "url": "The product URL",'."\n" + ."\n" + .'- "price": "The price",'."\n" + ."\n" + .'- "extra": "An extension field. This can be any key-value object."'."\n" + ."\n" + .'</details>', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "title": "update title"'."\n" + .' }', 'title' => ''], ], + 'description' => 'Request parameters', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'FDE51A3B-09C0-57E5-96FC-31E85EEFF318'], 'data' => [ - 'description' => 'The returned data. A value of true indicates that the request is successful. A value of false indicates that the request fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The type of the structured element.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'], + 'type' => 'string', + 'example' => 'miniapp', + 'title' => '', + ], + 'resourceId' => ['description' => 'The resource ID of the structured element. This ID is a unique and immutable identifier for the resource in the database.', 'type' => 'string', 'example' => 'WzMGQZwB7nQEs3Qk3ajH', 'title' => ''], + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'RecalculateCarbonEmission', - 'description' => '- After uploading the data items, you need to call this interface to recalculate the carbon inventory data.', - ], - 'GetFootprintList' => [ - 'summary' => 'Get the list of product carbon footprints.', - 'path' => '/api/v1/carbon/footprint/product/list', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AISearchResourceUpdate', + 'requestParamsDescription' => 'The type field is an enumeration that supports only the specified values. If you specify a value outside the allowed range, the API call fails. Additional structured content types will be added as needed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FDE51A3B-09C0-57E5-96FC-31E85EEFF318\\",\\n \\"data\\": {\\n \\"type\\": \\"miniapp\\",\\n \\"resourceId\\": \\"WzMGQZwB7nQEs3Qk3ajH\\"\\n }\\n}","type":"json"}]', + ], + 'AISearchStream' => [ + 'path' => '/api/v1/aiSearch/searchStream', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -1922,38 +1150,38 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters'."\n", 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'currentPage' => [ - 'description' => 'The pagination parameter. The number of the page that starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'pageSize' => [ - 'description' => 'The number of entries returned on each page.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', + 'question' => ['description' => 'User question.', 'type' => 'string', 'required' => true, 'example' => '“my net is slow, what can I do?”', 'title' => ''], + 'message' => [ + 'type' => 'array', + 'items' => ['description' => 'Historical conversation record.', '$ref' => '#/components/schemas/AISearchMessageItem', 'required' => false, 'title' => '', 'example' => ''], + 'description' => 'List of historical conversation records.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'folderId' => ['description' => 'Folder ID. The knowledge base retrieval feature searches for Q\\&A content within the current folder and its subfolders.', 'type' => 'string', 'required' => true, 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd', 'title' => ''], + 'resourceTypeNeeded' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'Retrieval resource type.', + 'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp', 'text' => 'text'], + 'type' => 'string', + 'required' => false, + 'example' => '“text”', + 'title' => '', + ], + 'description' => 'This list supports three enumeration values: "text" (for knowledge base retrieval), "miniapp" (for miniapp retrieval in structured elements), and "product" (for product retrieval in structured elements). If not specified, all three resource types are retrieved by default.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'Request body parameters.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -1962,154 +1190,278 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '06DA2909-7736-5738-AA31-ACD617D828F1', - ], + 'requestId' => ['description' => 'ID of the request', 'type' => 'string', 'title' => '', 'example' => '3F21E33A-42F8-50BC-89DE-DC0B96B967DD'], + 'data' => ['description' => 'Returned data.', '$ref' => '#/components/schemas/AISearchStreamItem', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AISearchStream', + 'summary' => 'The AISearch Q&A interface answers customer questions using structured element information from the database and content retrieved from the knowledge base.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AISearchStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3F21E33A-42F8-50BC-89DE-DC0B96B967DD\\",\\n \\"data\\": {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"“network problem can be”\\",\\n \\"params\\": \\" [{\\\\\\"type\\\\\\": \\\\\\"miniapp\\\\\\", \\\\\\"score\\\\\\": 0.7404107, \\\\\\"resourceId\\\\\\": \\\\\\"ja9bQZwBg5VwSU7n5Ijs\\\\\\", \\\\\\"miniappId\\\\\\": null, \\\\\\"title\\\\\\": \\\\\\"更新后的智能搜索测试助手\\\\\\", \\\\\\"version\\\\\\": \\\\\\"1.0.5\\\\\\", \\\\\\"description\\\\\\": \\\\\\"这是一个用于测试 AI 搜索功能的演示小程序\\\\\\", \\\\\\"slogan\\\\\\": \\\\\\"搜索即所得\\\\\\", \\\\\\"icon\\\\\\": \\\\\\"https://img.alicdn.com/test_icon.png\\\\\\", \\\\\\"url\\\\\\": null, \\\\\\"detailDescription\\\\\\": \\\\\\"该小程序提供了完整的 AI 搜索链路测试。\\\\\\"}]\\"\\n }\\n}","type":"json"}]', + ], + 'AddFolder' => [ + 'summary' => 'Adds a folder and returns an entity that contains basic information about the folder.', + 'path' => '/api/v1/aidoc/folder/add', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'folderName' => ['description' => 'The name of the folder.', 'type' => 'string', 'required' => true, 'example' => '“abc” “1234”', 'title' => ''], + 'parentFolderId' => ['description' => 'The ID of the parent folder. A value of 0 indicates the root directory.', 'type' => 'string', 'required' => true, 'example' => '"0" ：parent folder is root'."\n" + .'"4b648f6d11344f258df876cbdc24dc1f" ： folderId', 'title' => ''], + ], + 'required' => false, + 'description' => 'The request body.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E38E561C-B996-0E19-8DBC-A218AAE17FBA'], + 'data' => ['description' => 'The data structure of the created folder.', '$ref' => '#/components/schemas/FolderItem', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddFolder', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'energy:AddFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E38E561C-B996-0E19-8DBC-A218AAE17FBA\\",\\n \\"data\\": {\\n \\"folderId\\": \\"4b648f6d11344f258df876cbdc24dc1f\\",\\n \\"folderNum\\": 2,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"“abc” “1234”\\",\\n \\"parentFolderId\\": \\"\\\\\\"0\\\\\\" ：parent folder is root\\\\n\\\\\\"4b648f6d11344f258df876cbdc24dc1f\\\\\\" ： folderId\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 1,\\n \\"syncStatus\\": -1,\\n \\"syncParsingStatus\\": -1,\\n \\"ossDomain\\": \\"aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com\\\\t\\",\\n \\"ossUpdateBy\\": \\"1696462764375572\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"folder/manual/\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"test/\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"4b648f6d11344f258df876cbdc24dc1f\\",\\n \\"folderNum\\": 2,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"“abc” “1234”\\",\\n \\"parentFolderId\\": \\"\\\\\\"0\\\\\\" ：parent folder is root\\\\n\\\\\\"4b648f6d11344f258df876cbdc24dc1f\\\\\\" ： folderId\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 1,\\n \\"syncStatus\\": -1,\\n \\"syncParsingStatus\\": -1,\\n \\"ossDomain\\": \\"aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com\\\\t\\",\\n \\"ossUpdateBy\\": \\"1696462764375572\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"folder/manual/\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"test/\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"4b648f6d11344f258df876cbdc24dc1f\\",\\n \\"folderNum\\": 2,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"“abc” “1234”\\",\\n \\"parentFolderId\\": \\"\\\\\\"0\\\\\\" ：parent folder is root\\\\n\\\\\\"4b648f6d11344f258df876cbdc24dc1f\\\\\\" ： folderId\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 1,\\n \\"syncStatus\\": -1,\\n \\"syncParsingStatus\\": -1,\\n \\"ossDomain\\": \\"aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com\\\\t\\",\\n \\"ossUpdateBy\\": \\"1696462764375572\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"folder/manual/\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"test/\\",\\n \\"subFolderList\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'AnalyzeVlRealtime' => [ + 'summary' => 'Extracts information from a VL in real time.', + 'path' => '/api/v1/aidoc/document/analyzeVlRealtime', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'fileUrl', + 'in' => 'query', + 'schema' => ['description' => 'Choose either fileUrl or fileUrlObject.'."\n" + ."\n" + .'- fileUrl: The URL of a single document. The document can have up to 1,000 pages and be up to 100 MB in size.'."\n" + ."\n" + .'- fileUrlObject: The local file to upload when you call the API. The document can have up to 1,000 pages and be up to 100 MB in size.'."\n" + ."\n" + .'> Supported formats:'."\n" + .'>'."\n" + .'> - bmp, jpe, jpg, jpeg, png, tif, tiff, webp, heic', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'fileUrl: https://example.com/example.pdf'."\n" + .'fileUrlObject: FileInputStream generated from a local file', 'title' => ''], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'The filename must include the file extension.', 'type' => 'string', 'required' => false, 'example' => 'test.png', 'title' => ''], + ], + [ + 'name' => 'templateId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the extraction template, which specifies the content to extract from the document. To obtain the ID, log on to the template management page and configure a template.', 'type' => 'string', 'required' => false, 'example' => '572d24k0c95a', 'title' => ''], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the extraction template, which specifies the content to extract from the document. To obtain the ID, log on to the template management page and configure a template.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'currentPage' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'records' => [ - 'description' => 'Product Detail List.', + 'kvListInfo' => [ + 'description' => 'The document extraction results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'An object that contains an extracted key-value pair.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => 'The product ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'name' => [ - 'description' => 'The product name.', - 'type' => 'string', - 'example' => 'Carbon-footprint-demo', - ], - 'authStatus' => [ - 'description' => 'Authentication status enumeration value, please refer to [link](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'amount' => [ - 'description' => 'The amount of the product.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0000000000000000000000000', - ], - 'checkStartTime' => [ - 'description' => 'Calculation start time.', - 'type' => 'string', - 'example' => '2024/01/01', - ], - 'checkEndTime' => [ - 'description' => 'Calculation end time.', - 'type' => 'string', - 'example' => '2024/01/31', - ], - 'createdBy' => [ - 'description' => 'The user who created it.', - 'type' => 'string', - 'example' => 'Energy Expert', - ], - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'example' => 'C-20080808-1', - ], - 'isDemoModel' => [ - 'description' => 'Indicates whether the demo model is a built-in model. A value of 1 indicates a true value and a value of 0 indicates a false value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'lifeCycle' => [ - 'description' => 'The literal expression corresponding to lifeCycleType, `From Cradle to Gate` and `From Cradle to Grave`.', - 'type' => 'string', - 'example' => 'From Cradle to Gate', - ], - 'lifeCycleType' => [ - 'description' => '1 is `From Cradle to Gate`, and 2 is `From Cradle to Grave`.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'type' => [ - 'description' => 'Product category enumeration value, please refer to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', - 'type' => 'string', - 'example' => '158-159', - ], - 'unit' => [ - 'description' => 'Unit enumeration value. Please refer to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', - 'type' => 'string', - 'example' => '1-4', + 'keyName' => ['description' => 'The name of the key.', 'type' => 'string', 'example' => '租户', 'title' => ''], + 'keyValue' => ['description' => 'The value of the key.', 'type' => 'string', 'example' => '阿里云xxx有限公司', 'title' => ''], + 'context' => [ + 'description' => 'The extracted content.', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'Details of the extracted information for the key.', + 'type' => 'array', + 'items' => ['description' => 'Details of the extracted information for the key.', '$ref' => '#/components/schemas/ContentItem', 'example' => 'bhv_trace_info_invalid', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'value' => [ + 'description' => 'Details of the extracted information for the value.', + 'type' => 'array', + 'items' => ['description' => 'Details of the extracted information for the value.', '$ref' => '#/components/schemas/ContentItem', 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'confidence' => [ + 'description' => 'The confidence score.', + 'type' => 'object', + 'properties' => [ + 'keyConfidence' => ['description' => 'The confidence score for the key.', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146', 'title' => ''], + 'valueConfidence' => ['description' => 'The confidence score for the value.', 'type' => 'number', 'format' => 'double', 'example' => '0.9794202852249146', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - 'totalPage' => [ - 'description' => 'Total Pages'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"06DA2909-7736-5738-AA31-ACD617D828F1\\",\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"id\\": 1024,\\n \\"name\\": \\"演示产品\\",\\n \\"authStatus\\": 1,\\n \\"amount\\": 100,\\n \\"checkStartTime\\": \\"2024/01/01\\",\\n \\"checkEndTime\\": \\"2024/01/31\\",\\n \\"createdBy\\": \\"Energy Expert\\",\\n \\"code\\": \\"C-20080808-1\\",\\n \\"isDemoModel\\": 1,\\n \\"lifeCycle\\": \\"从摇篮到大门\\",\\n \\"lifeCycleType\\": 1,\\n \\"type\\": \\"158-159\\",\\n \\"unit\\": \\"1-4\\"\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3\\n }\\n}","type":"json"}]', - 'title' => 'GetFootprintList', - 'description' => 'With user-specified parameters such as enterprise code, current page, and page size, this API returns a list of matching product carbon footprints (or supply chain carbon footprints), including product names and product IDs. The product ID can be used as input parameters in other APIs to get the corresponding product\'s detailed information.', - ], - 'GenerateResult' => [ - 'summary' => 'Generate a report of the specified carbon footprint.', - 'path' => '/api/v1/carbon/footprint/result/generate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"租户\\",\\n \\"keyValue\\": \\"阿里云xxx有限公司\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"content\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"content\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"content\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"content\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'AnalyzeVlRealtime', + 'description' => 'You can upload a document URL to retrieve real-time results from VL.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeVlRealtime'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AnalyzeVlRealtime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchSaveInstructionStatus' => [ + 'summary' => 'Provides feedback on the execution status of policies.', + 'path' => '/api/v1/carbon/hvac/batchSaveInstructionStatus', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertYUWSCO'], ], 'parameters' => [ [ @@ -2117,31 +1469,39 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'factoryId' => ['description' => 'The factory ID.', 'type' => 'string', 'required' => true, 'example' => '***', 'title' => ''], + 'pKey' => ['description' => 'The source of the call.', 'type' => 'string', 'required' => false, 'example' => 'ib', 'title' => ''], + 'statusList' => ['description' => 'The list of instructions.', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "systemId": "system1",'."\n" + .' "strategyId": "10324",'."\n" + .' "controlId": "aaaaa-bbbbbb-cccc",'."\n" + .' "propertyCode": "startUp",'."\n" + .' "propertyValue": "20.1",'."\n" + .' "sendTimestamp": "1000000001",'."\n" + .' "executeTimestamp": "1000000008",'."\n" + .' "status": "Auto-executed",'."\n" + .' "remark": "Execution reason"'."\n" + .' },'."\n" + .' {'."\n" + .' "systemId": "system1",'."\n" + .' "strategyId": "10324",'."\n" + .' "controlId": "aaaaa-bbbbbb-cccc",'."\n" + .' "propertyCode": "startUp",'."\n" + .' "propertyValue": "20.1",'."\n" + .' "sendTimestamp": "1000000001",'."\n" + .' "executeTimestamp": "1000000008",'."\n" + .' "status": "Auto-executed",'."\n" + .' "remark": "Execution reason"'."\n" + .' }'."\n" + .']', 'required' => false, 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2149,54 +1509,66 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The returned data. `true` indicates that the request is successful, `false` indicates that the request fails.', + 'description' => 'The result of the operation.', + 'enumValueTitles' => ['成功' => 'true', '失败' => 'false'], 'type' => 'boolean', 'example' => 'true', + 'title' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'GenerateResult', - 'description' => 'Given a product ID, this API initiates a task to calculate the carbon footprint result for the corresponding product. The task\'s status can be checked using the `IsCompleted` API. Following the generation of results, other result inquiry APIs can be accessed for display content.', - ], - 'IsCompleted' => [ - 'summary' => 'Check if the result generation is complete.', - 'path' => '/api/v1/carbon/footprint/result/completed', - 'methods' => [ - 'post', + 'title' => 'BatchSaveInstructionStatus', + 'changeSet' => [ + ['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSaveInstructionStatus'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:BatchSaveInstructionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'BatchUpdateSystemRunningPlan' => [ + 'path' => '/api/v1/carbon/hvac/batchUpdateSystemRunningPlan', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertXYPXBQ'], ], 'parameters' => [ [ @@ -2204,104 +1576,125 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', + 'factoryId' => ['description' => 'The factory ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '***'], + 'systemId' => ['description' => 'The site ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'system1'], + 'seasonMode' => [ + 'description' => 'The season mode, such as summer or winter.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => ['冬季' => '1', '夏季' => '0'], + 'title' => '', + 'example' => '0', ], - 'productId' => [ - 'description' => 'The product id.', + 'dateType' => [ + 'description' => 'The date type, such as weekday or holiday.', 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => ['工作日' => '0', '节假日' => '1'], + 'title' => '', + 'example' => '0', ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", + 'startTime' => ['description' => 'The start time of the running plan.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-08-21'], + 'endTime' => ['description' => 'The end time of the running plan.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-08-30'], + 'workingStartTime' => ['description' => 'The start time of the target period.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:00:00'], + 'workingEndTime' => ['description' => 'The end time of the target period.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:30:00'], + 'earliestStartupTime' => ['description' => 'The earliest startup time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:00:00'], + 'latestShutdownTime' => ['description' => 'The latest shutdown time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:30:00'], + 'minTem' => ['description' => 'The minimum target temperature.', 'type' => 'number', 'format' => 'double', 'required' => false, 'title' => '', 'example' => '20.1'], + 'maxTem' => ['description' => 'The maximum target temperature.', 'type' => 'number', 'format' => 'double', 'required' => false, 'title' => '', 'example' => '25.3'], + 'maxCarbonDioxide' => ['description' => 'The maximum carbon dioxide concentration.', 'type' => 'number', 'format' => 'double', 'required' => false, 'title' => '', 'example' => '37.1'], + 'controlType' => [ + 'description' => 'The control mode, such as automatic or manual.', 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => ['手动' => '1', '自动' => '0'], + 'title' => '', + 'example' => '0', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'modifiedTime' => [ - 'description' => 'Modified time in milliseconds, e.g. 1711438780000.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1711438780000', - ], - 'taskKey' => [ - 'description' => 'The unique key of this generation task.', - 'type' => 'string', - 'example' => '550c2b7b-f2e0-4176-ab0a-53ea4b355721', - ], - 'taskShortResult' => [ - 'description' => 'Unused temporarily.', - 'type' => 'string', - 'example' => 'null', - ], - 'taskStatus' => [ - 'description' => 'The status of the report generation task. The possible values are `running`, `success`, and `error`, which mean generating, generating succeeded, and generating failed, respectively. If you encounter a result generation failure, check the model, correct the model, and then generate the result again.', - 'type' => 'string', - 'example' => 'running', - ], - ], + 'description' => 'The returned data.', + 'type' => 'boolean', + 'enumValueTitles' => ['成功' => 'true', '失败' => 'false'], + 'title' => '', + 'example' => 'true', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"modifiedTime\\": 1711438780000,\\n \\"taskKey\\": \\"550c2b7b-f2e0-4176-ab0a-53ea4b355721\\",\\n \\"taskShortResult\\": \\"null\\",\\n \\"taskStatus\\": \\"running\\"\\n }\\n}","type":"json"}]', - 'title' => 'IsCompleted', - 'description' => 'This API checks the completion status of generating a report. It should be used before calling other result APIs, as they will only display content once the report generation is complete.', - ], - 'GetPcrInfo' => [ - 'summary' => 'Obtains the oss address of the Product Carbon footprint Report.', - 'path' => '/api/v1/carbon/footprint/result/pcr/detail', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'BatchUpdateSystemRunningPlan', + 'summary' => 'Updates the running plans for multiple air conditioner sites in a batch.', + 'changeSet' => [ + ['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateSystemRunningPlan'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:BatchUpdateSystemRunningPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'Chat' => [ + 'summary' => 'This API provides a knowledge base service that answers questions about documents in a selected folder, using the session\'s chat history as context.', + 'path' => '/api/v2/aidoc/document/chat', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -2309,97 +1702,97 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'string', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'sessionId' => ['description' => '- The Q\\&A session ID.'."\n" + ."\n" + .'- You can get previous sessions by calling the GetChatSessionList API.'."\n" + ."\n" + .'- You can also create a new session by calling the CreateChatSession API.', 'type' => 'string', 'required' => true, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', 'title' => ''], + 'question' => ['description' => 'The content of the question.', 'type' => 'string', 'example' => 'How to obtain knowledge base Q&A documents', 'required' => true, 'title' => ''], + 'documentIds' => [ + 'type' => 'array', + 'items' => ['description' => '- The document ID.'."\n" + ."\n" + .'- You can get this ID from the SaaS console or by calling other APIs in the SDK, such as the DetailDocument API.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3456', 'title' => ''], + 'description' => 'A list of document IDs to use for the Q\\&A.'."\n" + .'><notice>If you use this parameter, the corresponding session must have been created without a folder ID.></notice>', + 'title' => '', + 'example' => '', + 'required' => false, ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82', - ], - 'data' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'description' => 'The timestamp when the report was created. The timestamp is in milliseconds.', - 'type' => 'string', - 'example' => '1709109790532', - ], - 'name' => [ - 'description' => 'Report name', - 'type' => 'string', - 'example' => 'report name', - ], - 'url' => [ - 'description' => 'Download url link.', - 'type' => 'string', - 'example' => 'https://energy.alibabacloud.com', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'Detailed Q\\&A information.', '$ref' => '#/components/schemas/ChatItem', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"createTime\\": \\"1709109790532\\",\\n \\"name\\": \\"面包板-碳足迹报告2024-01-08 18:39:39.docx\\",\\n \\"url\\": \\"https://energy.aliyun.com\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetPcrInfo', - 'description' => 'With the user-specified product ID, this interface retrieves detailed information and download links for previously generated PCR reports. To use it, two conditions must be met: 1) the result has already been generated; 2) the PCR report has been created.', - ], - 'GetGwpInventorySummary' => [ - 'summary' => 'This API is used to obtain the total carbon footprint of a product and the top four types of carbon footprint contribution.', - 'path' => '/api/v1/carbon/footprint/result/gwp/inventory/summary', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"question\\": \\"How to use the knowledge base.\\",\\n \\"answer\\": \\"No related content found.\\",\\n \\"createTime\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"deafult folder\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n}","type":"json"}]', + 'title' => 'Document Q\\&A', + 'description' => '- The API provides a Q\\&A service scoped to the folder selected for the session.'."\n" + ."\n" + .'- You can get the sessionId by calling the GetChatSessionList API.'."\n" + ."\n" + .'- You can also create a new session by calling the CreateChatSession API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:Chat', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ChatStream' => [ + 'summary' => 'This operation performs streaming Q&A on selected documents in a knowledge base, using the conversation history from a specified session as context.', + 'path' => '/api/v2/aidoc/document/chat/stream', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/octet-stream'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -2407,31 +1800,35 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'sessionId' => ['description' => '- The Q\\&A session ID.'."\n" + ."\n" + .'- Call the `GetChatSessionList` operation to retrieve the IDs of existing sessions.'."\n" + ."\n" + .'- Alternatively, call the `CreateChatSession` operation to create a new session.', 'type' => 'string', 'required' => true, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', 'title' => ''], + 'question' => ['description' => 'The question or prompt.', 'type' => 'string', 'example' => 'How to obtain knowledge base Q&A documents', 'required' => true, 'title' => ''], + 'documentIds' => [ + 'type' => 'array', + 'items' => ['description' => '- The document ID.'."\n" + ."\n" + .'- You can obtain the document ID from the SaaS page or by calling other SDK operations, such as `DetailDocument`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3456', 'title' => ''], + 'description' => '- A list of document IDs for the Q\\&A.'."\n" + ."\n\n" + .' ><notice>'."\n" + ."\n" + .' If you specify document IDs, ensure the `sessionId` you provide is not associated with a folder. The session must have been created with an empty folder ID.'."\n" + ."\n" + .' ></notice>', + 'title' => '', + 'example' => '', + 'required' => false, ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2439,102 +1836,65 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of response.', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'object', - 'properties' => [ - 'unit' => [ - 'description' => 'Emission Unit.', - 'type' => 'string', - 'example' => 'tCO₂e/Piece(s)', - ], - 'quantity' => [ - 'description' => 'The emission quantity.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.0100', - ], - 'resultGenerateTime' => [ - 'description' => 'The time when the result was generated, in the millisecond timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1709108026000', - ], - 'items' => [ - 'description' => 'Top 4 types of carbon footprint contribution.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'Inventory resource type name.', - 'type' => 'string', - 'example' => 'Energy', - ], - 'unit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kgCO₂e/Piece(s)', - ], - 'quantity' => [ - 'description' => 'Quantity.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9.9763', - ], - 'percent' => [ - 'description' => 'Percentage.', - 'type' => 'string', - 'example' => '99.01', - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'The details of the Q\\&A exchange.', '$ref' => '#/components/schemas/ChatItem', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"question\\": \\"How to use the knowledge base.\\",\\n \\"answer\\": \\"No related content found.\\",\\n \\"createTime\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"deafult folder\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n}","type":"json"}]', + 'title' => 'Streaming Document Q\\&A', + 'description' => '- This operation answers questions based on the documents scoped to the specified session.'."\n" + ."\n" + .'- Call the `GetChatSessionList` operation to obtain the session ID.'."\n" + ."\n" + .'- Alternatively, call the `CreateChatSession` operation to create a new session.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:ChatStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"tCO₂e/Piece(s)\\",\\n \\"quantity\\": 1.01,\\n \\"resultGenerateTime\\": 1709108026000,\\n \\"items\\": [\\n {\\n \\"name\\": \\"电力清单\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"quantity\\": 9.9763,\\n \\"percent\\": \\"99.01\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetGwpInventorySummary', - 'description' => 'Returns the total carbon footprint data for the user-specified product ID, along with details on the top four contributors to the carbon footprint, helping to understand the overall carbon footprint and its main components.', + 'translator' => 'machine', ], - 'GetGwpBenchmarkSummary' => [ - 'summary' => 'This API is to obtain the total amount of active carbon reduction.', - 'path' => '/api/v1/carbon/footprint/result/gwp/benchmark/summary', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateChatSession' => [ + 'summary' => 'Creates a chat session for knowledge base question answering. Each session maintains its own Q&A history as context to provide more accurate answers.', + 'path' => '/api/v2/aidoc/document/chat/session/create', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -2542,125 +1902,280 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request parameter.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'userId' => ['description' => 'The unique ID of the user. If not specified, the ID of the account that calls the SDK is used by default.', 'type' => 'string', 'required' => false, 'example' => '12344', 'title' => ''], + 'folderId' => ['description' => '- The folder ID. The knowledge base Q\\&A feature retrieves Q\\&A pairs from the specified folder and its subfolders.'."\n" + ."\n" + .' ><notice>'."\n" + ."\n" + .' If you set this parameter to an empty string, Q\\&A is performed based on a custom file list. In this case, you must use the Chat or ChatStream operation and pass a list of file IDs in the request. For more information, see the Chat and ChatStream API documentation.'."\n" + ."\n" + .' ></notice>', 'type' => 'string', 'required' => true, 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd', 'title' => ''], + 'name' => ['description' => 'The name of the current session.', 'type' => 'string', 'required' => true, 'example' => 'analyzer_1744684195', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f'], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data structure.', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => 'Carbon Reduction Contribution Top4 Details.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'Name of carbon reduction details.', - 'type' => 'string', - 'example' => 'Energy-Replacement', - ], - 'percent' => [ - 'description' => 'Percentage of emissions. The value is of the string type. Two decimal places are reserved for numbers. For example, "99.01" indicates the 99.01% of this type of emissions to the total emissions. Note that the returned string itself does not contain a percent sign.', - 'type' => 'string', - 'example' => '99.01', - ], - 'quantity' => [ - 'description' => 'Emission amount is presented with four decimal places. Normally, modeling doesn\'t result in negative values, but users can represent carbon reductions as negatives. The amount, paired with the unit, defines the emissions. Both are dynamically adjusted. If emissions exceed `1000 kgCO₂e/productUnit`, they convert to `tCO₂e/productUnit`. If they fall below `1 kgCO₂e/productUnit`, they convert to `gCO₂e/productUnit`. Otherwise, they stay in `kgCO₂e/productUnit`.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9.9763', - ], - 'unit' => [ - 'description' => 'Unit of emissions. The default value is `kgCO₂e/productUnit.` `productUnit` is the unit selected for the product. The unit value is changed to `tCO₂e/productUnit` or `gCO₂e/productUnit`. For more information, see the remarks in the quantity column.', - 'type' => 'string', - 'example' => 'kgCO₂e/kg', - ], - ], - ], - ], - 'quantity' => [ - 'description' => 'Emission amount is presented with four decimal places. Normally, modeling doesn\'t result in negative values, but users can represent carbon reductions as negatives. The amount, paired with the unit, defines the emissions. Both are dynamically adjusted. If emissions exceed `1000 kgCO₂e/productUnit`, they convert to `tCO₂e/productUnit`. If they fall below `1 kgCO₂e/productUnit`, they convert to `gCO₂e/productUnit`. Otherwise, they stay in `kgCO₂e/productUnit`.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000.0000', - ], - 'unit' => [ - 'description' => 'Unit of emissions. The default value is `kgCO₂e/productUnit.` `productUnit` is the unit selected for the product. The unit value is changed to `tCO₂e/productUnit` or `gCO₂e/productUnit`. For more information, see the remarks in the quantity column.', - 'type' => 'string', - 'example' => 'kgCO₂e/t', - ], + 'sessionId' => ['description' => 'The session ID, which tracks multiple Q\\&A interactions for the same user.', 'type' => 'string', 'example' => '596ac39c-8855-4128-bad7-78aebeff48fc', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": {\\n \\"sessionId\\": \\"596ac39c-8855-4128-bad7-78aebeff48fc\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create Q\\&A Session', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatSession'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:CreateChatSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"原材料\\",\\n \\"percent\\": \\"99.01\\",\\n \\"quantity\\": 9.9763,\\n \\"unit\\": \\"kgCO₂e/kg\\"\\n }\\n ],\\n \\"quantity\\": 1000,\\n \\"unit\\": \\"kgCO₂e/t\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetGwpBenchmarkSummary', - 'description' => 'The API takes a product ID and returns data on the carbon emissions reduction along with a list of the top four contributors to carbon reduction. This info helps understand the total carbon reduction of the product and its main sources.', ], - 'GetEpdSummary' => [ - 'summary' => 'Obtain the total amount of emissions for various environmental impacts.', - 'path' => '/api/v1/carbon/footprint/result/epd/summary', - 'methods' => [ - 'post', + 'DeleteDocument' => [ + 'path' => '/api/v1/aidoc/document/delete', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID of the file to delete. You can obtain this ID from the console or from other API operations.', 'type' => 'string', 'required' => false, 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'Indicates whether the deletion was successful. Valid values: true and false.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDocument', + 'summary' => 'Deletes a parsed file by task ID. Returns true on success, or false on failure.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'energy:DeleteDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": false\\n}","type":"json"}]', + ], + 'DeleteFolder' => [ + 'path' => '/api/v1/aidoc/folder/delete', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'folderId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the folder.', 'type' => 'string', 'required' => false, 'example' => '53c0412ea5c343dcad324137622210b3', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'Returns \\`true\\` if the folder is successfully deleted.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteFolder', + 'summary' => 'Deletes a folder. If the operation is successful, a Boolean value of `true` is returned. If the folder does not exist, a 4xx error is returned with the message "The folder does not exist."', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'energy:DeleteFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": false\\n}","type":"json"}]', + ], + 'DetailDocument' => [ + 'summary' => 'Retrieves the details of a document by its task ID.', + 'path' => '/api/v1/aidoc/document/detail', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID. Obtain this ID from the product\'s user interface or other API operations.', 'type' => 'string', 'required' => false, 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'The data returned.', '$ref' => '#/components/schemas/DocumentDetailItem', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DetailDocument', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'energy:DetailDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"id\\": 6731,\\n \\"folderId\\": \\"adafb91d4e014e2eb4d0a5375b547115\\",\\n \\"folderName\\": \\"123/abc/ 文件夹1\\",\\n \\"jobId\\": \\"74ec62f4f4e74e5882d4086a40f2b9c6\\",\\n \\"jobStatus\\": \\"PARSING_COMPLETED\\",\\n \\"docName\\": \\"123/abc/ 文档1.pdf\\",\\n \\"originDocName\\": \\"123/abc/ 文档1.pdf/.doc/docx/csv/xlsx/txt\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/docName\\",\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/originDocName\\",\\n \\"docHash\\": \\"5335c8828ccf735a500ed636590c713a94daf6cdacc90237733035cc5a152afb_1760513801010\\",\\n \\"createTime\\": \\"2025-09-08T17:04:28.000+08:00\\",\\n \\"updateTime\\": \\"2025-09-08T17:04:28.000+08:00\\"\\n }\\n}","type":"json"}]', + ], + 'EditProhibitedDevices' => [ + 'path' => '/api/v1/carbon/hvac/editProhibitedDevices', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertYUWSCO'], ], 'parameters' => [ [ @@ -2668,184 +2183,343 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'factoryId' => ['description' => 'The factory ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '***'], + 'systemId' => ['description' => 'The site ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'system1'], + 'hvacDeviceConfigVOList' => [ + 'description' => 'The list of device configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The device configuration object.', + 'type' => 'object', + 'properties' => [ + 'deviceName' => ['description' => 'The device name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'name1'], + 'deviceId' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'id1'], + 'deviceType' => [ + 'description' => 'The device type. Enter the number, not the text before the colon.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['空调机组' => '6', '锅炉' => '7', '冷机' => '1', '冷却塔' => '2', '水泵' => '3', '室内环境' => '4'], + 'title' => '', + 'example' => '1', + ], + 'isForbidden' => [ + 'description' => 'Specifies whether to disable the device. Valid values: 1 and 0.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => ['不禁用' => '0', '是禁用' => '1'], + 'title' => '', + 'example' => '1', + ], + 'isUnfavorableArea' => ['description' => 'Specifies whether the device is in an unfavorable area. Valid values: 1 and 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'buildingId' => ['description' => 'The building ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'build_01'], + 'floorId' => ['description' => 'The floor ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'floor_01'], + 'fenceId' => ['description' => 'The fence ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'fence_01'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => 'B91B5559-065A-55C3-8D75-DA218EBFD1DC', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f'], 'data' => [ - 'description' => 'Response parameters'."\n", + 'description' => 'The returned data.', + 'type' => 'boolean', + 'enumValueTitles' => ['成功' => 'true', '失败' => 'false'], + 'title' => '', + 'example' => 'true', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'EditProhibitedDevices', + 'summary' => 'Edits the list of prohibited devices.', + 'requestParamsDescription' => 'The \\`deviceType\\` and \\`isForbidden\\` parameters are required. The \\`isUnfavorableArea\\` parameter is optional. Valid values for \\`deviceType\\` are \\`1\\` (water cooled chiller), \\`2\\` (cooling tower), \\`3\\` (water pump), \\`4\\` (indoor environment), \\`6\\` (air handling unit), and \\`7\\` (boiler). If \\`deviceType\\` is \\`1\\`, \\`2\\`, \\`3\\`, \\`6\\`, or \\`7\\`, the \\`deviceId\\` parameter is required. Do not specify the \\`buildingId\\`, \\`floorId\\`, or \\`fenceId\\` parameters. If \\`deviceType\\` is \\`4\\`, the \\`buildingId\\`, \\`floorId\\`, and \\`fenceId\\` parameters are required. Do not specify the \\`deviceId\\` or \\`deviceName\\` parameters.', + 'changeSet' => [ + ['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditProhibitedDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:EditProhibitedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'EditUnfavorableAreaDevices' => [ + 'path' => '/api/v1/carbon/hvac/editUnfavorableAreaDevices', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertYUWSCO'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'factoryId' => ['description' => 'The factory ID.', 'type' => 'string', 'required' => true, 'example' => '***', 'title' => ''], + 'systemId' => ['description' => 'The site ID.', 'type' => 'string', 'required' => true, 'example' => 'system1', 'title' => ''], + 'hvacDeviceConfigVOList' => [ + 'description' => 'The list of device configurations.', 'type' => 'array', 'items' => [ + 'description' => 'The device configuration object.', 'type' => 'object', 'properties' => [ - 'carbonEmission' => [ - 'description' => 'Emissions. The result is maintained up to 31 decimal places for precise intermediate calculation and subsequently truncated for display. It is advised to pair the emissions figure with the unit of the environmental impact result for a comprehensive understanding.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1009.976265540000000000000000000000', - ], - 'indicator' => [ - 'description' => 'The evaluation index adopted for the environmental impact'."\n", - 'type' => 'string', - 'example' => 'GWP100a', - ], - 'key' => [ - 'description' => 'The category key. The environmental impact category. Currently, a maximum of 19 categories are supported. Enumeration refers to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', - 'type' => 'string', - 'example' => 'gwp', - ], - 'method' => [ - 'description' => 'Calculation method standard'."\n", - 'type' => 'string', - 'example' => 'CML v4.8 2016', - ], - 'name' => [ - 'description' => 'The name of the category.'."\n", + 'deviceName' => ['description' => 'The device name.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + 'deviceId' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'example' => 'id1', 'title' => ''], + 'deviceType' => [ + 'description' => 'The device type. Enter the enumeration value.', + 'enumValueTitles' => ['空调机组' => '6', '锅炉' => '7', '冷机' => '1', '冷却塔' => '2', '水泵' => '3', '室内环境' => '4'], 'type' => 'string', - 'example' => 'climate change', + 'required' => true, + 'example' => '1', + 'title' => '', ], - 'num' => [ - 'description' => 'Category num: the unique serial number of the environmental impact category. A maximum of 19 categories are supported. Enumeration refers to [Carbon Footprint Appendices](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/CarbonFootprintAppendices-en.pdf).', + 'isForbidden' => [ + 'description' => 'Specifies whether the device is disabled. Valid values: 1 and 0.', + 'enumValueTitles' => ['不是禁用设备' => '0', '是禁用设备' => '1'], 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', + 'required' => false, 'example' => '1', + 'title' => '', ], - 'preUnit' => [ - 'description' => 'Environmental impact result Value Unit.', - 'type' => 'string', - 'example' => 'kg CO2-Eq', - ], - 'state' => [ - 'description' => 'The data status. 1 indicates that the calculation is accurate, 2 indicates that the default data is used, and 3 indicates that the missing factor uses the value of 0.'."\n", + 'isUnfavorableArea' => [ + 'description' => 'Specifies whether the device is in an unfavorable area. Valid values: 1 and 0.', + 'enumValueTitles' => ['是不利区' => '1', '不是不利区' => '0'], 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', + 'required' => true, 'example' => '1', + 'title' => '', ], + 'buildingId' => ['description' => 'The building ID.', 'type' => 'string', 'required' => false, 'example' => 'buildingId1', 'title' => ''], + 'floorId' => ['description' => 'The floor ID.', 'type' => 'string', 'required' => false, 'example' => 'floorId2', 'title' => ''], + 'fenceId' => ['description' => 'The fence ID.', 'type' => 'string', 'required' => false, 'example' => 'fenceId1', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B91B5559-065A-55C3-8D75-DA218EBFD1DC\\",\\n \\"data\\": [\\n {\\n \\"carbonEmission\\": 1009.97626554,\\n \\"indicator\\": \\"GWP100a\\",\\n \\"key\\": \\"gwp\\",\\n \\"method\\": \\"CML v4.8 2016\\",\\n \\"name\\": \\"气候变化\\",\\n \\"num\\": 1,\\n \\"preUnit\\": \\"kg CO2-Eq\\",\\n \\"state\\": 1\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetEpdSummary', - 'description' => 'This API takes a product ID from the user and returns the summary of environmental impact generated for the product. This info helps understand the overall emissions for different environmental impact categories of the product.', - ], - 'GetInventoryList' => [ - 'summary' => 'Get the list of emissions in descending order under the specified environmental impact (methodType), specified aggregate level (group), and specified calculation mode (emissionType).', - 'path' => '/api/v1/carbon/footprint/result/inventory/list', - 'methods' => [ - 'post', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => [ + 'description' => 'The returned data.', + 'enumValueTitles' => ['成功' => 'true', '失败' => 'false'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'EditUnfavorableAreaDevices', + 'summary' => 'Edits devices in unfavorable areas.', + 'requestParamsDescription' => 'The deviceType and isUnfavorableArea parameters are required. Do not specify the isForbidden parameter. Valid values for deviceType are 1 (water cooled chiller), 2 (cooling tower), 3 (water pump), 4 (indoor environment), 6 (air conditioning unit), and 7 (boiler). If deviceType is 1, 2, 3, 6, or 7, the deviceId parameter is required. Do not specify the buildingId, floorId, or fenceId parameters. If deviceType is 4, the buildingId, floorId, and fenceId parameters are required. Do not specify the deviceId or deviceName parameters.', + 'changeSet' => [ + ['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => 'Request parameters changed'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditUnfavorableAreaDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:EditUnfavorableAreaDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'GenerateResult' => [ + 'summary' => 'Generates a report for a specified carbon footprint.', + 'path' => '/api/v1/carbon/footprint/result/generate', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. Set this to \\`1\\` to request a product carbon footprint, or \\`5\\` to request a supply chain carbon footprint.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. This is a unique value for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'The returned data. A value of \\`true\\` indicates that the request was successful. A value of \\`false\\` indicates that the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => 'GenerateResult', + 'description' => 'Creates a task to generate a carbon footprint report for a specified product. You can call a query operation to check the status of the task. After the report is generated, you can call other query operations to view the results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GenerateResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetAreaElecConstitute' => [ + 'summary' => 'Retrieves analytical data for power stations.', + 'path' => '/api/v1/carbon/emission/analysis/elec/area', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'methodType' => [ - 'description' => 'The type of the obtained environmental impact: gwp indicates the carbon footprint of climate change. '."\n" - .'<props="intl">[For more information, see the environment impact category enumeration.](https://www.alibabacloud.com/help/en/energy-expert/developer-reference/enumerated-values-of-energy-expert#RhGn7)</props>', - 'type' => 'string', - 'required' => true, - 'example' => 'gwp', - ], - 'emissionType' => [ - 'description' => 'Type of emission'."\n" - ."\n" - .'> Valid values: footprint | emission. Meaning: footprint: all inventories are involved in the calculation; emission: only inventories with positive and zero emissions are involved in the calculation, and negative numbers are not involved in the calculation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'footprint', - ], - 'group' => [ - 'description' => 'Group by'."\n" - ."\n" - .'> Valid values: resource | process | resourceType | processType. Meaning: resource: aggregation by inventory group, process: aggregation by operation group, resourceType: aggregation by inventory type, processType: aggregation by phase group'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'resource', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Z-20240115-2'], + 'year' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '2024'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2853,126 +2527,138 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of response.', + 'description' => 'The response data structure.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'unit' => [ - 'description' => 'Emission Unit: The default value is kgCO₂ /productUnit. productUnit is the unit selected for the product. The unit value is changed to tCO₂ e/productUnit or gCO₂ e/productUnit based on the emission quantity. For more information, see the quantity column.'."\n", - 'type' => 'string', - 'example' => 'kgCO₂e/kg', + 'water' => [ + 'description' => 'Data about hydropower consumption and carbon emissions for each enterprise.', + 'type' => 'array', + 'items' => ['description' => 'The data structure for hydropower consumption and carbon emissions for each enterprise.', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'productUnit' => [ - 'description' => 'Unit of product.', - 'type' => 'string', - 'example' => 'kg', + 'light' => [ + 'description' => 'Data about photovoltaic power consumption and carbon emissions for each enterprise.', + 'type' => 'array', + 'items' => ['description' => 'The data structure for photovoltaic power consumption and carbon emissions for each enterprise.', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'items' => [ - 'description' => 'Inventory detail.', + 'urban' => [ + 'description' => 'Data about grid power consumption and carbon emissions for each enterprise.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'Name '."\n" - ."\n" - .'> The name is related to the request parameters group. Request parameters: resource, return name parameter meaning: list name; request parameters: process, return name parameter meaning: process name; request parameters: resourceType, return name parameter meaning: inventory resource type name; request parameters: processType, return name parameter meaning: flow name.', - 'type' => 'string', - 'example' => 'Energy', - ], - 'carbonEmission' => [ - 'description' => 'Emission quantity: may be positive, negative, or 0. To ensure the calculation accuracy, 24 decimal places are reserved for the calculation process. We recommend that you intercept data based on your business requirements.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1000.000000000000000000000000000000', - ], - 'percent' => [ - 'description' => 'Percentage', - 'type' => 'string', - 'example' => '99.01', - ], - 'processName' => [ - 'description' => 'Process Name: It is only meaningful when the request parameters group is resource.', - 'type' => 'string', - 'example' => 'Process-1', - ], - ], - ], + 'items' => ['description' => 'The data structure for grid power consumption and carbon emissions for each enterprise.', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'wind' => [ + 'description' => 'Data about wind power consumption and carbon emissions for each enterprise.', + 'type' => 'array', + 'items' => ['description' => 'The data structure for wind power consumption and carbon emissions for each enterprise.', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'nuclear' => [ + 'description' => 'Data about nuclear power consumption and carbon emissions for each enterprise.', + 'type' => 'array', + 'items' => ['description' => 'The data structure for nuclear power consumption and carbon emissions for each enterprise.', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'renewing' => [ + 'description' => 'Data about renewable electricity consumption and carbon emissions for each enterprise.', + 'type' => 'array', + 'items' => ['description' => 'The data structure for renewable electricity consumption and carbon emissions for each enterprise.', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'zero' => [ + 'description' => 'Data about zero-carbon electricity consumption and carbon emissions for each enterprise.', + 'type' => 'array', + 'items' => ['description' => 'The data structure for zero-carbon electricity consumption and carbon emissions for each enterprise.', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'code' => ['description' => 'The response code. A value of 200 indicates that the request was successful. Other values indicate that the request failed. For more information about an error, see the msg parameter.', 'type' => 'string', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"productUnit\\": \\"kg\\",\\n \\"items\\": [\\n {\\n \\"name\\": \\"电力\\",\\n \\"carbonEmission\\": 1000,\\n \\"percent\\": \\"99.01\\",\\n \\"processName\\": \\"Process-1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetInventoryList', - 'description' => 'This interface retrieves a descending order list of emissions for a specified product ID, environmental impact method, group level, and calculation method. It\'s used to understand various environmental impact emission scenarios.', - ], - 'GetGwpBenchmarkList' => [ - 'summary' => 'obtain the active carbon reduction ranking list.', - 'path' => '/api/v1/carbon/footprint/result/gwp/benchmark/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"water\\": [\\n {\\n \\"carbonEmissionData\\": 1.22,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.22,\\n \\"dataUnit\\": \\"kg\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 1.22,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.22,\\n \\"dataUnit\\": \\"kg\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 1.22,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.22,\\n \\"dataUnit\\": \\"kg\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"wind\\": [],\\n \\"nuclear\\": [],\\n \\"renewing\\": [],\\n \\"zero\\": []\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'GetAreaElecConstitute', + 'description' => '- Retrieves the lowest-level electricity analysis data.'."\n" + ."\n" + .'- The code parameter specifies the enterprise level for analysis. The analysis is performed on all enterprises at the specified level.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAreaElecConstitute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetAreaElecConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetCarbonEmissionTrend' => [ + 'summary' => 'Queries the carbon emission trend.', + 'path' => '/api/v1/carbon/emission/analysis/trend', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'Request parameters', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'code' => ['description' => 'The organization code.', 'type' => 'string', 'required' => true, 'example' => 'C-20240119-1', 'title' => ''], + 'yearList' => [ + 'description' => 'The list of inventory years.', + 'type' => 'array', + 'items' => ['description' => 'The inventory year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], 'required' => true, - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'moduleType' => ['description' => 'The module type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'moduleCode' => ['description' => 'The module code.', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', 'title' => ''], + 'trendType' => ['description' => 'The trend type.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2980,101 +2666,209 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => 'A8AEC6D9-A359-5169-BD1A-BD848BA60D65', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f'], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'unit' => [ - 'description' => 'unit of emissions. The default value is `kgCO₂e/productUnit`. '."\n" - .'The `productUnit` is the unit selected for the product. The unit value is changed to `tCO₂e/productUnit` or `gCO₂e/productUnit`. For more information, see the remarks in the quantity column.', - 'type' => 'string', - 'example' => 'kgCO₂e/kg', - ], - 'items' => [ - 'description' => 'Active carbon reduction ranking list.', + 'targetEmissionList' => [ + 'description' => 'The list of target emissions.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The target emission data.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'name', - 'type' => 'string', - 'example' => 'new-energy', - ], - 'carbonEmission' => [ - 'description' => 'Inventory emissions. Maintain four decimal places. Unit pertains to a higher-level unit.', - 'type' => 'number', - 'format' => 'double', - 'example' => '-0.2061', - ], - 'percent' => [ - 'description' => 'Unused temporarily.', - 'type' => 'string', - 'example' => 'null', - ], - 'benchmarkName' => [ - 'description' => 'Benchmark name', - 'type' => 'string', - 'example' => 'old-energy ', - ], - 'benchmarkEmission' => [ - 'description' => 'Benchmark emissions. Maintain four decimal places. Unit pertains to a higher-level unit.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0108', + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], + 'items' => [ + 'description' => 'The list of data items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data item.', + 'type' => 'object', + 'properties' => [ + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '20.22', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'activeReduction' => [ - 'description' => '`activeReduction=benchmarkEmission-carbonEmission` Generally, baseline emissions are greater than inventory emissions. Maintain four decimal places. Unit pertains to a higher-level unit.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.2169', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'actualEmissionList' => [ + 'description' => 'The list of actual emissions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The actual emission data.', + 'type' => 'object', + 'properties' => [ + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], + 'items' => [ + 'description' => 'The list of data items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data item.', + 'type' => 'object', + 'properties' => [ + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '20.22', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": {\\n \\"targetEmissionList\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"items\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"month\\": 10,\\n \\"carbonEmissionData\\": 20.22\\n }\\n ]\\n }\\n ],\\n \\"actualEmissionList\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"items\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"month\\": 11,\\n \\"carbonEmissionData\\": 20.22\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetCarbonEmissionTrend', + 'description' => 'Queries the carbon emissions of an organization for each month within a specified year. The results are returned in a list that shows the carbon emission trend over time. The following parameters are required:'."\n" + ."\n" + .'- The unique identifier of the organization'."\n" + ."\n" + .'- The year for the carbon emission statistics'."\n" + ."\n" + .'- The type of the statistics module'."\n" + ."\n" + .'- The required trend type', + 'changeSet' => [ + ['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCarbonEmissionTrend'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetCarbonEmissionTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": {\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"items\\": [\\n {\\n \\"name\\": \\"PVC废料回收\\",\\n \\"carbonEmission\\": -0.2061,\\n \\"percent\\": \\"暂为null\\",\\n \\"benchmarkName\\": \\"PVC废料焚烧\\",\\n \\"benchmarkEmission\\": 0.0108,\\n \\"activeReduction\\": 0.2169\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetGwpBenchmarkList', - 'description' => 'This interface returns a list of proactive carbon reduction information given product ID. It\'s used to understand the carbon reduction efforts at various levels of the product.', ], - 'GetGwpInventoryConstitute' => [ - 'summary' => 'Used to obtain the carbon emission composition analysis of a specified product. Carbon emission composition analysis includes two analysis dimensions: inventory and type. In the rendering effect, including a hierarchical list and pie chart.', - 'path' => '/api/v1/carbon/footprint/result/gwp/inventory/constitute', - 'methods' => [ - 'post', + 'GetChatFolderList' => [ + 'summary' => 'Retrieves the list of Q&A pair folders.', + 'path' => '/api/v2/aidoc/document/chat/folder/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '影响性能', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A8AEC6D9-A359-5169-BD1A-BD848BA60D65'], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => ['description' => 'The details of the folder.', '$ref' => '#/components/schemas/ChatFolderItem', 'title' => '', 'example' => 'true'], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Q\\&A folder List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatFolderList'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetChatFolderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": [\\n {\\n \\"subFolders\\": [\\n {\\n \\"question\\": \\"How to use the knowledge base.\\",\\n \\"answer\\": \\"No related content found.\\",\\n \\"createTime\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"deafult folder\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n ],\\n \\"folderName\\": \\"default folder\\",\\n \\"folderId\\": \\"aaa\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetChatList' => [ + 'path' => '/api/v2/aidoc/document/chat/list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -3082,31 +2876,16 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'sessionId' => ['description' => 'The ID of the Q\\&A session. This ID is used to track multiple Q\\&A pairs from the same user.', 'type' => 'string', 'required' => true, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', 'title' => ''], + 'currentPage' => ['description' => 'The page number for paging. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3114,85 +2893,87 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '06DA2909-7736-5738-AA31-ACD617D828F1', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data structure.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'This is not used for displaying', - ], - 'unit' => [ - 'description' => 'Emission Unit.', - 'type' => 'string', - 'example' => 'kgCO₂e/t', - ], - 'carbonEmission' => [ - 'description' => 'Emission quantity: may be positive, negative, or 0. To ensure the calculation accuracy, 24 decimal places are reserved for the calculation process. We recommend that you intercept data based on your business requirements.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1009.976265540000000000000000000000', - ], - 'byResourceType' => [ - 'description' => 'Aggregated by resource type of an inventory.', - 'type' => 'array', - 'items' => [ - 'description' => 'Used for "by type" analysis in composition analysis. This is a nested structure, total carbon emissions-> sorted by inventory type, a total of two layers, the last level byResource is empty.', - '$ref' => '#/components/schemas/GwpInventoryConstitute', - ], - ], - 'items' => [ - 'description' => 'Organized by hierarchy from high to low, according to the flow-> process-> inventory hierarchy.', + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '21', 'title' => ''], + 'totalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'currentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'chatList' => [ + 'description' => 'The list of Q\\&A pairs.', 'type' => 'array', - 'items' => [ - 'description' => 'Used for "by inventory" analysis in composition analysis. Is a nested structure, according to the link-> operation-> list level, the last level items is empty'."\n" - .'.', - '$ref' => '#/components/schemas/GwpInventoryConstitute', - ], + 'items' => ['description' => 'The details of a Q\\&A pair.', '$ref' => '#/components/schemas/ChatItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"06DA2909-7736-5738-AA31-ACD617D828F1\\",\\n \\"data\\": {\\n \\"name\\": \\"总碳排放量\\",\\n \\"unit\\": \\"kgCO₂e/t\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"byResourceType\\": [\\n {\\n \\"percent\\": 0,\\n \\"resourceType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"name\\": \\"\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"unit\\": \\"\\",\\n \\"resourceType\\": 0,\\n \\"carbonEmission\\": 0,\\n \\"percent\\": \\"\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 0,\\n \\"resourceType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"name\\": \\"\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"unit\\": \\"\\",\\n \\"resourceType\\": 0,\\n \\"carbonEmission\\": 0,\\n \\"percent\\": \\"\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 0,\\n \\"resourceType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"name\\": \\"\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"unit\\": \\"\\",\\n \\"resourceType\\": 0,\\n \\"carbonEmission\\": 0,\\n \\"percent\\": \\"\\"\\n }\\n ],\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"items\\": []\\n }\\n}","type":"json"}]', - 'title' => 'GetGwpInventoryConstitute', - 'description' => 'Used to obtain the carbon emission composition analysis of a specified product. Carbon emission composition analysis includes two analysis dimensions: inventory and type. In the rendering effect, including a hierarchical list and pie chart.', - ], - 'GetEpdInventoryConstitute' => [ - 'summary' => 'Gets the result details of the environmental impact category.', - 'path' => '/api/v1/carbon/footprint/result/epd/inventory/constitute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Q\\\\\\&A List', + 'summary' => 'Retrieves the Q&A pair history for a session.', + 'description' => '- Retrieves the Q\\&A pair history for a session based on the session ID.'."\n" + ."\n" + .'- You can call the GetChatSessionList operation to obtain the session ID.'."\n" + ."\n" + .'- You can also call the CreateChatSession operation to create a new session.', + 'changeSet' => [ + ['createdAt' => '2025-06-18T03:15:16.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetChatList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"chatList\\": [\\n {\\n \\"question\\": \\"How to use the knowledge base.\\",\\n \\"answer\\": \\"No related content found.\\",\\n \\"createTime\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"deafult folder\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetChatSessionList' => [ + 'summary' => 'Retrieves a list of a user\'s Q&A sessions.', + 'path' => '/api/v2/aidoc/document/chat/session/list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -3200,31 +2981,17 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => ['description' => 'The session name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'oklabs'], + 'userId' => ['description' => 'The unique ID of the user. If this parameter is left empty, the ID of the account that calls the SDK is used by default.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '12222'], + 'currentPage' => ['description' => 'The page number for paging. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'The number of entries per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'title' => '', 'example' => '10'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3232,197 +2999,186 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response.', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"], 'data' => [ - 'description' => 'List of environmental impact results.', - 'type' => 'array', - 'items' => [ - 'description' => 'Environmental impact result Item.', - '$ref' => '#/components/schemas/EpdInventoryConstituteItem', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'sessionList' => [ + 'description' => 'The list of sessions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sessionId' => ['description' => 'The ID of the Q\\&A session. This ID is used to track multiple Q\\&A pairs for the same user.', 'type' => 'string', 'title' => '', 'example' => '5c748ef9-3f23-4b5a-916f-966c0d2c6dcd'], + 'name' => ['description' => 'The session name.', 'type' => 'string', 'title' => '', 'example' => 'student_app_spelling'], + 'userId' => ['description' => 'The user ID for the current session.', 'type' => 'string', 'title' => '', 'example' => '12222'], + 'folderId' => ['description' => 'The ID of the folder. This specifies the scope of documents for the query.', 'type' => 'string', 'title' => '', 'example' => '3493370b-4884-47dd-95ed-49038769af53'], + 'createTime' => ['description' => 'The timestamp when the session was created. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2025-01-01T14:45:17Z'], + 'updateTime' => ['description' => 'The timestamp of the last update. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2024-12-30T02:05:03Z'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '21'], + 'totalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3'], + 'currentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"inventoryValuePerProduct\\": 0,\\n \\"factorDataset\\": \\"\\",\\n \\"percent\\": 0,\\n \\"inventoryValuePerProductUnit\\": \\"\\",\\n \\"num\\": 0,\\n \\"quantity\\": 0,\\n \\"resourceType\\": \\"\\",\\n \\"factorType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"inventoryId\\": 0,\\n \\"inventoryValue\\": 0,\\n \\"factorUnit\\": \\"\\",\\n \\"inventoryUnit\\": \\"\\",\\n \\"state\\": 0,\\n \\"factor\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"factorId\\": \\"\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 0,\\n \\"factorDataset\\": \\"\\",\\n \\"percent\\": 0,\\n \\"inventoryValuePerProductUnit\\": \\"\\",\\n \\"num\\": 0,\\n \\"quantity\\": 0,\\n \\"resourceType\\": \\"\\",\\n \\"factorType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"inventoryId\\": 0,\\n \\"inventoryValue\\": 0,\\n \\"factorUnit\\": \\"\\",\\n \\"inventoryUnit\\": \\"\\",\\n \\"state\\": 0,\\n \\"factor\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"factorId\\": \\"\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 0,\\n \\"factorDataset\\": \\"\\",\\n \\"percent\\": 0,\\n \\"inventoryValuePerProductUnit\\": \\"\\",\\n \\"num\\": 0,\\n \\"quantity\\": 0,\\n \\"resourceType\\": \\"\\",\\n \\"factorType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"inventoryId\\": 0,\\n \\"inventoryValue\\": 0,\\n \\"factorUnit\\": \\"\\",\\n \\"inventoryUnit\\": \\"\\",\\n \\"state\\": 0,\\n \\"factor\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"factorId\\": \\"\\",\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetEpdInventoryConstitute', - 'description' => 'This API returns the emission amounts for various environmental impact categories at different levels for the given product ID. It helps understand the emission quantities for different environmental impact categories and inventories of the product.', - ], - 'GetReductionProposal' => [ - 'summary' => 'Get carbon reduction recommendations.', - 'path' => '/api/v1/carbon/footprint/result/reduction/proposal', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Document Session List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetChatSessionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"sessionList\\": [\\n {\\n \\"sessionId\\": \\"5c748ef9-3f23-4b5a-916f-966c0d2c6dcd\\",\\n \\"name\\": \\"student_app_spelling\\",\\n \\"userId\\": \\"12222\\",\\n \\"folderId\\": \\"3493370b-4884-47dd-95ed-49038769af53\\",\\n \\"createTime\\": 0,\\n \\"updateTime\\": 0\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10\\n }\\n}","type":"json"}]', + ], + 'GetDataItemList' => [ + 'summary' => 'Retrieves a list of data item details.', + 'path' => '/api/v1/carbon/emission/data/item/list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'dataQualityEvaluationType' => [ - 'title' => '数据质量评估类型。1是DQI，2是DQR。', - 'description' => 'The type of the data quality evaluation. 1 is DQI and 2 is DQR.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-202302-01', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'reduction' => [ - 'title' => '主动减碳建议', - 'description' => 'Proactive carbon reduction recommendations and advice.', - 'type' => 'string', - 'example' => 'Reduce one-drop usage', - ], - 'reductionEvaluation' => [ - 'title' => '主动减碳评估', - 'description' => 'Active carbon reduction assessment.', - 'type' => 'string', - 'example' => 'Trying Energy Expert for a more detailed assessment.', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kg', 'title' => ''], + 'period' => ['description' => 'The data entry method. A value of 1 indicates a monthly value. A value of 2 indicates a yearly value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'code' => ['description' => 'The API data identifier.', 'type' => 'string', 'example' => 'demo_api_code', 'title' => ''], + 'name' => ['description' => 'The name of the data item.', 'type' => 'string', 'example' => 'Boiler data', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"reduction\\": \\"主动减碳建议的文本\\",\\n \\"reductionEvaluation\\": \\"主动减碳评估的文本\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetReductionProposal', - 'description' => 'This API returns carbon reduction proposals based on the product ID. It\'s useful for understanding optimization tips to reduce the carbon emissions associated with a product.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"unit\\": \\"kg\\",\\n \\"period\\": 1,\\n \\"code\\": \\"demo_api_code\\",\\n \\"name\\": \\"Boiler data\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetDataItemList', + 'description' => '- Retrieves a list of data item details for the current enterprise.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataItemList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDataItemList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', ], 'GetDataQualityAnalysis' => [ - 'summary' => 'Obtain the data quality evaluation results DQR and DQI.', + 'summary' => 'Retrieves the Data Quality Rating (DQR) and Data Quality Indicator (DQI) results.', 'path' => '/api/v1/carbon/footprint/data/quality/analysis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20080808-1', - ], - 'dataQualityEvaluationType' => [ - 'description' => 'Data quality assessment type: 1 is DQI and 2 is DQR.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'productId' => [ - 'description' => 'The product id.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1024', - ], - 'productType' => [ - 'description' => 'Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'dataQualityEvaluationType' => ['description' => 'The type of data quality evaluation. 1 indicates DQI and 2 indicates DQR.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. 1 indicates a product carbon footprint request. 5 indicates a supply chain carbon footprint request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3431,188 +3187,401 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.'."\n", - 'type' => 'string', - 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. This value is unique for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'dataQuality' => [ - 'description' => 'Score of each inventory.', + 'description' => 'The scores for each checklist.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'inventory' => [ - 'description' => 'Inventory name', - 'type' => 'string', - 'example' => 'energy', - ], + 'inventory' => ['description' => 'The name of the checklist.', 'type' => 'string', 'example' => 'Process-1/Checklist-1', 'title' => ''], 'score' => [ - 'description' => 'Score. The distribution ranges from 1 to 5. A value closer to 1 indicates better data quality.'."\n", + 'description' => 'The score. The value ranges from 1 to 5. A value closer to 1 indicates better data quality.', 'type' => 'object', 'properties' => [ - 'g1' => [ - 'description' => 'Data quality evaluation indicator 1: activity data credibility.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'g2' => [ - 'description' => 'Data quality evaluation indicator 2: data factor reliability.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'g3' => [ - 'description' => 'Data quality evaluation indicator 3: time representativeness.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'g4' => [ - 'description' => 'Data quality evaluation indicator 4: geographic representativeness.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], + 'g1' => ['description' => 'Data quality evaluation indicator 1: Reliability of activity data.', 'type' => 'number', 'format' => 'double', 'example' => '3', 'title' => ''], + 'g2' => ['description' => 'Data quality evaluation indicator 2: Reliability of factor data.', 'type' => 'number', 'format' => 'double', 'example' => '3', 'title' => ''], + 'g3' => ['description' => 'Data quality evaluation indicator 3: Temporal representativeness.', 'type' => 'number', 'format' => 'double', 'example' => '3', 'title' => ''], + 'g4' => ['description' => 'Data quality evaluation indicator 4: Geographical representativeness.', 'type' => 'number', 'format' => 'double', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'dataQualityResult' => [ - 'description' => 'Data quality result.', + 'description' => 'The indicator score.', 'type' => 'object', 'properties' => [ - 'data_quality_score' => [ - 'description' => 'The score. This parameter is applicable to DQR results. The distribution ranges from 1 to 5. A value closer to 1 indicates better data quality. The number of valid digits is kept to four decimal places.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2345', - ], - 'g1' => [ - 'description' => 'Data quality evaluation indicator 1: activity data credibility.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2345', - ], - 'g2' => [ - 'description' => 'Data quality evaluation indicator 2: data factor reliability.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2345', - ], - 'g3' => [ - 'description' => 'Data quality evaluation indicator 3: time representativeness.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2345', - ], - 'g4' => [ - 'description' => 'Data quality evaluation indicator 4: geographic representativeness.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2345', - ], + 'data_quality_score' => ['description' => 'The score. This applies to DQR results. The value ranges from 1 to 5. A value closer to 1 indicates better data quality. The value is accurate to four decimal places.', 'type' => 'number', 'format' => 'double', 'example' => '1.2345', 'title' => ''], + 'g1' => ['description' => 'Data quality evaluation indicator 1: Reliability of activity data.', 'type' => 'number', 'format' => 'double', 'example' => '1.2345', 'title' => ''], + 'g2' => ['description' => 'Data quality evaluation indicator 2: Reliability of factor data.', 'type' => 'number', 'format' => 'double', 'example' => '1.2345', 'title' => ''], + 'g3' => ['description' => 'Data quality evaluation indicator 3: Temporal representativeness.', 'type' => 'number', 'format' => 'double', 'example' => '1.2345', 'title' => ''], + 'g4' => ['description' => 'Data quality evaluation indicator 4: Geographical representativeness.', 'type' => 'number', 'format' => 'double', 'example' => '1.2345', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'sensitivityList' => [ - 'description' => 'Sensitivity analysis list', + 'description' => 'The sensitivity analysis list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => 'Inventory id', - 'type' => 'string', - 'example' => '1', - ], - 'inventory' => [ - 'description' => 'Name of the inventory item.', - 'type' => 'string', - 'example' => 'energy', - ], + 'id' => ['description' => 'The ID of the checklist item.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'inventory' => ['description' => 'The name of the checklist item.', 'type' => 'string', 'example' => 'Inventory 1', 'title' => ''], 'reductionList' => [ - 'description' => 'List of emission reduction measures.', + 'description' => 'The list of emission reduction measures.', 'type' => 'array', - 'items' => [ - 'description' => 'Emission reduction measures for inventory item.', - 'type' => 'string', - 'example' => 'Use new energy', - ], - ], - 'sensitivity' => [ - 'description' => 'Sensitivity percentage.', - 'type' => 'number', - 'format' => 'double', - 'example' => '91.7', + 'items' => ['description' => 'The emission reduction measures for the checklist item.', 'type' => 'string', 'example' => '措施1', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'sensitivity' => ['description' => 'The sensitivity percentage.', 'type' => 'number', 'format' => 'double', 'example' => '91.7', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'uncertainty' => [ - 'description' => 'Uncertainty value. The model\'s overall percentage uncertainty results. "10.00%" symbolizes a 10.00% uncertainty, indicating that the carbon footprint lies within ±10.00%. This is derived from a weighted aggregation of individual inventory uncertainties.', - 'type' => 'string', - 'example' => '10.00', - ], + 'uncertainty' => ['description' => 'The uncertainty value. This is the overall uncertainty percentage of the model. For example, a value of "10.00" indicates 10.00% uncertainty, which means the carbon footprint result is within a ±10.00% range. The value is a weighted aggregate of the uncertainty contributions from individual checklists.', 'type' => 'string', 'example' => '10.00', 'title' => ''], 'uncertaintyValues' => [ - 'description' => 'Uncertainty list'."\n", + 'description' => 'The list of uncertainty values.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'inventory' => [ - 'description' => 'The name of the inventory. Format: process name / inventory name.', - 'type' => 'string', - 'example' => 'process-1/inventory-1', - ], - 'uncertaintyContribution' => [ - 'description' => 'Inventory uncertainty absolute contribution size. The impact of the quality of each inventory data on the carbon footprint results in the modeling process, when the uncertain contribution of a list is large, please improve its data quality as much as possible to improve the accuracy of carbon footprint analysis. The meaning of "1.4964" is not determined to contribute 1.4964 kgCO₂ e/unit, where unit is the unit of the product.'."\n", - 'type' => 'string', - 'example' => '1.4964', - ], + 'inventory' => ['description' => 'The name of the checklist. The format is: Procedure Name/Checklist Name.', 'type' => 'string', 'example' => '工序-1/清单-1', 'title' => ''], + 'uncertaintyContribution' => ['description' => 'The absolute uncertainty contribution from the checklist. This value shows how the data quality of each checklist affects the final carbon footprint result. If a checklist has a large uncertainty contribution, improve its data quality to make the analysis more accurate. For example, a value of "1.4964" means the contribution is 1.4964 kgCO₂e/unit, where \\`unit\\` is the product\'s unit.', 'type' => 'string', 'example' => '1.4964', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"dataQuality\\": [\\n {\\n \\"inventory\\": \\"工序-1/清单-1\\",\\n \\"score\\": {\\n \\"g1\\": 3,\\n \\"g2\\": 3,\\n \\"g3\\": 3,\\n \\"g4\\": 3\\n }\\n }\\n ],\\n \\"dataQualityResult\\": {\\n \\"data_quality_score\\": 1.2345,\\n \\"g1\\": 1.2345,\\n \\"g2\\": 1.2345,\\n \\"g3\\": 1.2345,\\n \\"g4\\": 1.2345\\n },\\n \\"sensitivityList\\": [\\n {\\n \\"id\\": \\"1\\",\\n \\"inventory\\": \\"清单1\\",\\n \\"reductionList\\": [\\n \\"措施1\\"\\n ],\\n \\"sensitivity\\": 91.7\\n }\\n ],\\n \\"uncertainty\\": \\"10.00\\",\\n \\"uncertaintyValues\\": [\\n {\\n \\"inventory\\": \\"工序-1/清单-1\\",\\n \\"uncertaintyContribution\\": \\"1.4964\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"dataQuality\\": [\\n {\\n \\"inventory\\": \\"Process-1/Checklist-1\\",\\n \\"score\\": {\\n \\"g1\\": 3,\\n \\"g2\\": 3,\\n \\"g3\\": 3,\\n \\"g4\\": 3\\n }\\n }\\n ],\\n \\"dataQualityResult\\": {\\n \\"data_quality_score\\": 1.2345,\\n \\"g1\\": 1.2345,\\n \\"g2\\": 1.2345,\\n \\"g3\\": 1.2345,\\n \\"g4\\": 1.2345\\n },\\n \\"sensitivityList\\": [\\n {\\n \\"id\\": \\"1\\",\\n \\"inventory\\": \\"Inventory 1\\",\\n \\"reductionList\\": [\\n \\"措施1\\"\\n ],\\n \\"sensitivity\\": 91.7\\n }\\n ],\\n \\"uncertainty\\": \\"10.00\\",\\n \\"uncertaintyValues\\": [\\n {\\n \\"inventory\\": \\"工序-1/清单-1\\",\\n \\"uncertaintyContribution\\": \\"1.4964\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'GetDataQualityAnalysis', - 'description' => 'This API returns the data quality evaluation results based on the user-provided product ID. It\'s useful for understanding the data quality of the carbon emission factors for each inventory of the product.', + 'description' => 'Returns the data quality evaluation results from a generated results page for a specified product ID. You can use this operation to check the data quality of carbon emission factors for each product checklist.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataQualityAnalysis'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDataQualityAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', ], - 'GetEmissionSummary' => [ - 'summary' => 'Get a summary of carbon emissions.', - 'path' => '/api/v1/carbon/emission/analysis/summary', - 'methods' => [ - 'post', + 'GetDeviceInfo' => [ + 'summary' => 'Retrieves device information for an activated site.', + 'path' => '/api/external/getDeviceInfo', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'factoryId', + 'in' => 'query', + 'schema' => ['description' => 'The site ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pn_95', 'title' => ''], + ], + [ + 'name' => 'deviceId', + 'in' => 'query', + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pn_69873', 'title' => ''], + ], + [ + 'name' => 'ds', + 'in' => 'query', + 'schema' => ['description' => 'The date string in the YYYY-MM-DD format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-07-26', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'code' => ['description' => 'The response code. A value of \\`Success\\` indicates that the request was successful. Other values indicate that the request failed. For more information about the cause of the failure, see the \\`msg\\` parameter.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'deviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'pn_69873', 'title' => ''], + 'deviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'Main transformer #4', 'title' => ''], + 'firstTypeName' => ['description' => 'The level-1 meter type.', 'type' => 'string', 'example' => 'Electric meter', 'title' => ''], + 'secondTypeName' => ['description' => 'The level-2 meter type.', 'type' => 'string', 'example' => 'Gateway meter', 'title' => ''], + 'recordList' => [ + 'description' => 'The list of parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The device information.', + 'type' => 'object', + 'properties' => [ + 'statisticsDate' => ['description' => 'The date of the statistics.', 'type' => 'string', 'example' => '2022-07-26 00:00:00', 'title' => ''], + 'paramName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'Phase A current', 'title' => ''], + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'identifier' => ['description' => 'The device identifier.', 'type' => 'string', 'example' => 'Ia', 'title' => ''], + 'type' => ['description' => 'The type of the data point.', 'type' => 'string', 'example' => 'DOUBLE', 'title' => ''], + 'value' => ['description' => 'The value.', 'type' => 'number', 'format' => 'double', 'example' => '20.00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'invalidParameter', 'errorMessage' => 'Invalid parameter values.', 'description' => 'Request parameters are incorrect. Please check method entry parameters.'], + ], + [ + ['errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', 'description' => 'No permissions to call API operations.'], + ], + 500 => [ + ['errorCode' => 'systemError', 'errorMessage' => 'System error.', 'description' => 'System error.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"Main transformer #4\\",\\n \\"firstTypeName\\": \\"Electric meter\\",\\n \\"secondTypeName\\": \\"Gateway meter\\",\\n \\"recordList\\": [\\n {\\n \\"statisticsDate\\": \\"2022-07-26 00:00:00\\",\\n \\"paramName\\": \\"Phase A current\\",\\n \\"unit\\": \\"A\\",\\n \\"identifier\\": \\"Ia\\",\\n \\"type\\": \\"DOUBLE\\",\\n \\"value\\": 20\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetDeviceInfo', + 'description' => '- Queries device parameters using the device ID. If the device ID is valid, the operation returns device information. Otherwise, a null value is returned.'."\n" + ."\n" + .'- Queries data for a single device on a specific day. If no data exists, a null value is returned.'."\n" + ."\n" + .'- Supports only the endpoint in the China (Hangzhou) region: `energyexpertexternal.cn-hangzhou.aliyuncs.com`'."\n" + ."\n" + .'- To use this API, your account must be added to the whitelist. To do this, <props="china">[contact us](https://energy.aliyun.com/ifa/web/defaultLoginPage?adapter=aliyun#/consult?source=%E8%83%BD%E8%80%97%E5%AE%9D%E7%99%BB%E5%BD%95%E9%A1%B5%EF%BC%88WEB%EF%BC%89)</props>'."\n" + .' <props="intl">[contact us](https://energy.alibabacloud.com/common?adapter=aliyun\\&lang=en-US#/home/en)</props>.', + 'changeSet' => [ + ['createdAt' => '2023-04-17T06:13:23.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'energy:GetDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'GetDeviceList' => [ + 'summary' => 'Retrieves the list of devices for an activated site.', + 'path' => '/api/external/getDeviceList', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'factoryId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The site ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pn_95', 'title' => ''], + ], ], - 'operationType' => 'readAndWrite', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'factoryId' => ['description' => 'The site ID.', 'type' => 'string', 'example' => 'pn_95', 'title' => ''], + 'deviceList' => [ + 'description' => 'The list of devices.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of devices.', + 'type' => 'object', + 'properties' => [ + 'deviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'pn_69873', 'title' => ''], + 'deviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'Main transformer #4', 'title' => ''], + 'firstTypeName' => ['description' => 'The primary meter type.', 'type' => 'string', 'example' => 'Electric meter', 'title' => ''], + 'secondTypeName' => ['description' => 'The secondary meter type.', 'type' => 'string', 'example' => 'Gateway meter', 'title' => ''], + 'parentDevice' => ['description' => 'The parent device.', 'type' => 'string', 'example' => 'pn_6987', 'title' => ''], + 'info' => [ + 'description' => 'The device information.', + 'type' => 'object', + 'properties' => [ + 'magnification' => ['description' => 'The magnification ratio.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'pressure' => ['description' => 'Indicates high or low voltage.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'pt' => ['description' => 'The voltage transformation ratio.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'ct' => ['description' => 'The current transformation ratio.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'constKva' => ['description' => 'The rated capacity, in kVA.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'invalidParameter', 'errorMessage' => 'Invalid parameter values.', 'description' => 'Request parameters are incorrect. Please check method entry parameters.'], + ], + [ + ['errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', 'description' => 'No permissions to call API operations.'], + ], + 500 => [ + ['errorCode' => 'systemError', 'errorMessage' => 'System error.', 'description' => 'System error.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"deviceList\\": [\\n {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"Main transformer #4\\",\\n \\"firstTypeName\\": \\"Electric meter\\",\\n \\"secondTypeName\\": \\"Gateway meter\\",\\n \\"parentDevice\\": \\"pn_6987\\",\\n \\"info\\": {\\n \\"magnification\\": 80,\\n \\"pressure\\": 0,\\n \\"pt\\": 80,\\n \\"ct\\": 1,\\n \\"constKva\\": 100\\n }\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n },\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'GetDeviceList', + 'description' => '- Queries the data collection devices at a site. If the request is successful, the operation returns device information. Otherwise, the operation returns an empty value.'."\n" + ."\n" + .'- Excludes virtual meters from the results.'."\n" + ."\n" + .'- Currently, only the `energyexpertexternal.cn-hangzhou.aliyuncs.com` endpoint is supported.'."\n" + ."\n" + .'- To call this operation, your service must be added to the whitelist. To add your service to the whitelist, <props="china">[contact us](https://energy.aliyun.com/ifa/web/defaultLoginPage?adapter=aliyun#/consult?source=%E8%83%BD%E8%80%97%E5%AE%9D%E7%99%BB%E5%BD%95%E9%A1%B5%EF%BC%88WEB%EF%BC%89)</props>'."\n" + .' <props="intl">[contact us](https://energy.alibabacloud.com/common?adapter=aliyun\\&lang=en-US#/home/en)</props>.', + 'changeSet' => [ + ['createdAt' => '2023-07-05T09:26:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-17T06:13:23.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'energy:GetDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'GetDocExtractionResult' => [ + 'summary' => 'For Querying Information Extraction Result. The input parameter taskId is obtained from the taskId returned by the interfaces SubmitDocExtractionTaskAdvance or SubmitDocExtractionTask. The query results can reflect one of three statuses: processing, successfully completed, or failed.', + 'path' => '/api/v2/aidoc/document/getDocExtractionResult', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -3620,37 +3589,16 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20240119-1', - ], - 'year' => [ - 'description' => 'Year of inventory.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], - 'moduleType' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'Module type.', - 'example' => '3', - ], - 'moduleCode' => [ - 'description' => 'Module code.', - 'type' => 'string', - 'required' => false, - 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', - ], + 'taskId' => ['description' => '- Task ID.'."\n" + ."\n" + .'- taskId is obtained from the SubmitDocExtractionTaskAdvance and SubmitDocExtractionTask interfaces.', 'type' => 'string', 'required' => true, 'example' => '97693b4c-17a8-4198-aa28-798d3c855577mhrv', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3658,113 +3606,116 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'Details of summarized data', + 'description' => 'Returned data structure.', 'type' => 'object', 'properties' => [ - 'currentPeriodCarbonEmissionData' => [ - 'description' => 'Statistical indicators for this cycle.', - 'type' => 'number', - 'format' => 'double', - 'example' => '276.4', - ], - 'lastPeriodCarbonEmissionData' => [ - 'description' => 'Last period statistical indicators.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9.40100', - ], - 'totalCarbonEmissionData' => [ - 'description' => 'Total carbon emissions.', - 'type' => 'number', - 'format' => 'double', - 'example' => '276.46', - ], - 'carbonSaveConversion' => [ - 'description' => 'Carbon emissions reduction.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'ratio' => [ - 'description' => 'Year-on-year.', - 'type' => 'number', - 'format' => 'double', - 'example' => '28.410', - ], - 'actualEmissionRatio' => [ - 'description' => 'Percentage of scheduled.', - 'type' => 'number', - 'format' => 'double', - 'example' => '2.7657', - ], - 'weightingCarbonEmissionData' => [ - 'description' => 'Calculate carbon emissions by share ratio'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '248.81400', - ], - 'lastPeriodWeightingCarbonEmissionData' => [ - 'description' => 'Calculation of carbon emissions based on shareholding ratio in the last cycle.', - 'type' => 'number', - 'format' => 'double', - 'example' => '8.4609', - ], - 'weightingRatio' => [ - 'description' => 'Year-on-year of weighting ratio carbon emissions.', - 'type' => 'number', - 'format' => 'double', - 'example' => '28.4102', - ], - 'isWeighting' => [ - 'description' => 'Whether to show the weighting ratio carbon emission.', - 'type' => 'boolean', - 'example' => 'true', + 'kvListInfo' => [ + 'description' => 'Details of document extraction results', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of document extraction results', + 'type' => 'object', + 'properties' => [ + 'keyName' => ['description' => 'Field key name', 'type' => 'string', 'example' => 'Tenant', 'title' => ''], + 'keyValue' => ['description' => 'Field key value', 'type' => 'string', 'example' => 'Alibaba Cloud XXX Co., Ltd.', 'title' => ''], + 'context' => [ + 'description' => 'Recalled content', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'Details of key recall information', + 'type' => 'array', + 'items' => ['description' => 'Details of key recall information', '$ref' => '#/components/schemas/ContentItem', 'example' => 'bhv_trace_info_invalid', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'value' => [ + 'description' => 'Details of value recall information', + 'type' => 'array', + 'items' => ['description' => 'Details of value recall information', '$ref' => '#/components/schemas/ContentItem', 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'confidence' => [ + 'description' => 'Confidence level', + 'type' => 'object', + 'properties' => [ + 'keyConfidence' => ['description' => 'Key confidence level', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146', 'title' => ''], + 'valueConfidence' => ['description' => 'value confidence level', 'type' => 'number', 'format' => 'double', 'example' => '0.9794202852249146', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"currentPeriodCarbonEmissionData\\": 276.4,\\n \\"lastPeriodCarbonEmissionData\\": 9.401,\\n \\"totalCarbonEmissionData\\": 276.46,\\n \\"carbonSaveConversion\\": 0,\\n \\"ratio\\": 28.41,\\n \\"actualEmissionRatio\\": 2.7657,\\n \\"weightingCarbonEmissionData\\": 248.814,\\n \\"lastPeriodWeightingCarbonEmissionData\\": 8.4609,\\n \\"weightingRatio\\": 28.4102,\\n \\"isWeighting\\": true\\n },\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', - 'title' => 'GetEmissionSummary', - ], - 'GetEmissionSourceConstitute' => [ - 'summary' => 'Obtain the emission source composition.', - 'path' => '/api/v1/carbon/emission/analysis/constitute', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"Tenant\\",\\n \\"keyValue\\": \\"Alibaba Cloud XXX Co., Ltd.\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve RAG and Long Text Understanding Document Extraction Results', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocExtractionResult'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDocExtractionResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'GetDocParsingResult' => [ + 'path' => '/api/v2/aidoc/document/getDocParsingResult', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -3772,37 +3723,27 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters for the operation.'."\n", + 'description' => 'Request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20240119-1', - ], - 'year' => [ - 'description' => 'Year of inventory.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], - 'moduleType' => [ - 'description' => 'Module type.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], - 'moduleCode' => [ - 'description' => 'Module code.', + 'taskId' => ['description' => '- Task ID.'."\n" + ."\n" + .'- The taskId is obtained from the SubmitDocParsingTaskAdvance or SubmitDocParsingTask interfaces.', 'type' => 'string', 'required' => true, 'example' => '2c22388d-e2ed-44fe-99e6-99922f15e7bb', 'title' => ''], + 'returnFormat' => [ + 'description' => '- The document parsing result supports two formats: markdown and json.'."\n" + ."\n" + .'- By default, the result is returned in markdown format.', 'type' => 'string', + 'example' => 'md', + 'default' => 'md', + 'enum' => ['md', 'json'], 'required' => false, - 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3810,106 +3751,78 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of response.', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'Response parameters'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of comstitute analysis.', - '$ref' => '#/components/schemas/ConstituteItem', + 'description' => 'Returned result.', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => '- The parsed content of the document.'."\n" + ."\n" + .'- The format (markdown or json) is determined by the returnFormat parameter. For specific format details, refer to: [json return structure](https://www.alibabacloud.com/help/en/energy-expert/developer-reference/interface-attached-information#b644b6255cojj)', 'type' => 'string', 'example' => '{\\"doc_info\\":{\\"languages\\":[\\"zh\\",\\"en\\"],\\"doc_type\\":\\"pdf\\",\\"pdf_toc\\":[{\\"title\\":\\"封面\\",\\"level\\":0,\\"page\\":0}],\\"pages\\":366,\\"page_list\\":[{\\"imageWidth\\":596,\\"imageHeight\\":842,\\"pageIdAllDocs\\":0,\\"fileIndex\\":0,\\"pageIdCurDoc\\":0,\\"angle\\":0}],\\"doc_data\\":[{\\"uniqueId\\":\\"about_us_para\\",\\"page_num\\":\\"01\\",\\"index\\":\\"xxx\\",\\"name\\":\\"xxx\\",\\"type\\":\\"xxxx\\",\\"subType\\":\\"xxx\\",\\"text\\":\\"xxx\\",\\"before_text\\":\\"xxx\\",\\"after_text\\":\\"xxx\\",\\"extInfo\\":[{\\"uniqueId\\":\\"b0x1x0\\",\\"pos\\":[{\\"x\\":229,\\"y\\":208},{\\"x\\":421,\\"y\\":208},{\\"x\\":421,\\"y\\":242},{\\"x\\":229,\\"y\\":242}],\\"text\\":\\"Kurt Götze\\",\\"type\\":\\"Text\\",\\"subType\\":\\"Text\\",\\"pageNum\\":[0],\\"index\\":0}]}]}}', 'title' => ''], ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Document Parsing Result', + 'summary' => 'For Querying Document Parsing Results. The input parameter taskId is obtained from the taskId returned by the interfaces SubmitDocParsingTaskAdvance or SubmitDocParsingTask. The query results can be one of three statuses: processing, successful, or failed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocParsingResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDocParsingResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"enterpriseName\\": \\"\\",\\n \\"rawData\\": 0,\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0,\\n \\"nameKey\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"emissionSourceKey\\": \\"\\",\\n \\"emissionSource\\": \\"\\",\\n \\"dataUnit\\": \\"\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"gasEmissionData\\": 0,\\n \\"carbonEmissionData\\": 0\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"\\",\\n \\"rawData\\": 0,\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0,\\n \\"nameKey\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"emissionSourceKey\\": \\"\\",\\n \\"emissionSource\\": \\"\\",\\n \\"dataUnit\\": \\"\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"gasEmissionData\\": 0,\\n \\"carbonEmissionData\\": 0\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"\\",\\n \\"rawData\\": 0,\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0,\\n \\"nameKey\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"emissionSourceKey\\": \\"\\",\\n \\"emissionSource\\": \\"\\",\\n \\"dataUnit\\": \\"\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"gasEmissionData\\": 0,\\n \\"carbonEmissionData\\": 0\\n }\\n ],\\n \\"subConstituteItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', - 'title' => 'GetEmissionSourceConstitute', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"content\\": \\"{\\\\\\\\\\\\\\"doc_info\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"languages\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"zh\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"doc_type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pdf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pdf_toc\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"封面\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"page\\\\\\\\\\\\\\":0}],\\\\\\\\\\\\\\"pages\\\\\\\\\\\\\\":366,\\\\\\\\\\\\\\"page_list\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"imageWidth\\\\\\\\\\\\\\":596,\\\\\\\\\\\\\\"imageHeight\\\\\\\\\\\\\\":842,\\\\\\\\\\\\\\"pageIdAllDocs\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"fileIndex\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"pageIdCurDoc\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"angle\\\\\\\\\\\\\\":0}],\\\\\\\\\\\\\\"doc_data\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"about_us_para\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"page_num\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"before_text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"after_text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"extInfo\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"b0x1x0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pos\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":229,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":208},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":421,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":208},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":421,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":242},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":229,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":242}],\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Kurt Götze\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pageNum\\\\\\\\\\\\\\":[0],\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":0}]}]}}\\"\\n }\\n}","type":"json"}]', ], - 'GetCarbonEmissionTrend' => [ - 'summary' => 'Get trends in carbon emissions.', - 'path' => '/api/v1/carbon/emission/analysis/trend', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDocumentAnalyzeResult' => [ + 'summary' => 'Important: This API operation is no longer maintained. To obtain extraction results, use the getDocExtractionResult or GetVLExtractionResult operation.', + 'path' => '/api/v1/aidoc/document/getDocumentAnalyzeResult', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20240119-1', - ], - 'yearList' => [ - 'description' => 'The list of inventory year.', - 'type' => 'array', - 'items' => [ - 'description' => 'Year of inventory.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], - 'required' => true, - ], - 'moduleType' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'Module type.', - 'example' => '3', - ], - 'moduleCode' => [ - 'description' => 'Module code.', - 'type' => 'string', - 'required' => false, - 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', - ], - 'trendType' => [ - 'description' => 'Trend Type.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'jobId' => ['description' => 'The job ID. This ID specifies the document whose parsing result you want to query. The ID is returned by the API operation that submits a document for parsing.', 'type' => 'string', 'required' => true, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -3917,163 +3830,124 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response.', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request.', - 'type' => 'string', - 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'targetEmissionList' => [ - 'description' => 'Target Emission List.', + 'kvListInfo' => [ + 'description' => 'The document parsing results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of the document parsing results.', 'type' => 'object', 'properties' => [ - 'year' => [ - 'description' => 'The year.', - 'type' => 'string', - 'example' => '2024', - ], - 'items' => [ - 'description' => 'Data item list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data item', - 'type' => 'object', - 'properties' => [ - 'year' => [ - 'description' => 'The year.', - 'type' => 'string', - 'example' => '2024', - ], - 'month' => [ - 'description' => 'The month.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions.', - 'type' => 'number', - 'format' => 'double', - 'example' => '20.22', - ], + 'keyName' => ['description' => 'The name of the key field.', 'type' => 'string', 'example' => 'Tenant', 'title' => ''], + 'keyValue' => ['description' => 'The value of the key field.', 'type' => 'string', 'example' => 'Alibaba Cloud XXX Co., Ltd.', 'title' => ''], + 'context' => [ + 'description' => 'The retrieved content.', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'The retrieved information for the key.', + 'type' => 'array', + 'items' => ['description' => 'The details of the retrieved information for the key.', '$ref' => '#/components/schemas/ContentItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - ], - 'actualEmissionList' => [ - 'description' => 'Actual emission list.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'year' => [ - 'description' => 'The year.', - 'type' => 'string', - 'example' => '2024', - ], - 'items' => [ - 'description' => 'Data item list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data item.', - 'type' => 'object', - 'properties' => [ - 'year' => [ - 'description' => 'The year.', - 'type' => 'string', - 'example' => '2024', - ], - 'month' => [ - 'description' => 'The month.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions.', - 'type' => 'number', - 'format' => 'double', - 'example' => '20.22', + 'value' => [ + 'description' => 'The retrieved information for the value.', + 'type' => 'array', + 'items' => ['description' => 'The details of the retrieved information for the value.', '$ref' => '#/components/schemas/ContentItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'confidence' => [ + 'description' => 'The confidence level.', + 'type' => 'object', + 'properties' => [ + 'keyConfidence' => ['description' => 'The confidence level for the key.', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146', 'title' => ''], + 'valueConfidence' => ['description' => 'The confidence level for the value.', 'type' => 'number', 'format' => 'double', 'example' => '0.9794202852249146', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"Tenant\\",\\n \\"keyValue\\": \\"Alibaba Cloud XXX Co., Ltd.\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetDocumentAnalyzeResult', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentAnalyzeResult'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": {\\n \\"targetEmissionList\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"items\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"month\\": 10,\\n \\"carbonEmissionData\\": 20.22\\n }\\n ]\\n }\\n ],\\n \\"actualEmissionList\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"items\\": [\\n {\\n \\"year\\": \\"2024\\",\\n \\"month\\": 11,\\n \\"carbonEmissionData\\": 20.22\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetCarbonEmissionTrend', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDocumentAnalyzeResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', ], 'GetElecConstitute' => [ - 'summary' => 'This interface is used to obtain power composition analysis data.', + 'summary' => 'Retrieves electricity composition analysis data.', 'path' => '/api/v1/carbon/emission/analysis/elec/constitute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20240202-01', - ], - 'year' => [ - 'description' => 'Year.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20240202-01', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4081,357 +3955,184 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'water' => [ - 'description' => 'Hydropower consumption and carbon emission data of each enterprise.', + 'description' => 'Hydropower.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emission.', - 'type' => 'number', - 'format' => 'double', - 'example' => '2.1', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.4', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'water', - ], - 'nameKey' => [ - 'description' => 'The unique identifier of name.', - 'type' => 'string', - 'example' => 'carbonInventory.check.water_electricity', - ], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '2.1', 'title' => ''], + 'rawData' => ['description' => 'The electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'title' => ''], + 'ratio' => ['description' => 'The percentage of the total monthly electricity consumption. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.4', 'title' => ''], + 'dataUnit' => ['description' => 'The unit of measurement.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Hydropower', 'title' => ''], + 'nameKey' => ['description' => 'The identifier for the name.', 'type' => 'string', 'example' => 'carbonInventory.check.water_electricity', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'light' => [ - 'description' => 'Photoelectric power consumption and carbon emission data of each enterprise.', + 'description' => 'Photovoltaic power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emission.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.2', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'light', - ], - 'nameKey' => [ - 'description' => 'The unique identifier of name.', - 'type' => 'string', - 'example' => 'carbonInventory.check.light_electricity', - ], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'title' => ''], + 'rawData' => ['description' => 'The electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'title' => ''], + 'ratio' => ['description' => 'The percentage of the total monthly electricity consumption. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.2', 'title' => ''], + 'dataUnit' => ['description' => 'The unit of measurement.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Solar power', 'title' => ''], + 'nameKey' => ['description' => 'The code for the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.light_electricity', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'urban' => [ - 'description' => 'Data on mains power electricity consumption and carbon emission of each enterprise.', + 'description' => 'Grid power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emission.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.4', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'urban', - ], - 'nameKey' => [ - 'description' => 'The unique identifier of name.', - 'type' => 'string', - 'example' => 'carbonInventory.check.urban_electricity', - ], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'title' => ''], + 'rawData' => ['description' => 'The electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'title' => ''], + 'ratio' => ['description' => 'The percentage of the total monthly electricity consumption. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.4', 'title' => ''], + 'dataUnit' => ['description' => 'The unit of measurement.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Grid power', 'title' => ''], + 'nameKey' => ['description' => 'The code for the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.urban_electricity', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'wind' => [ - 'description' => 'Wind power consumption and carbon emission data of each enterprise.', + 'description' => 'Wind power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emission.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.1', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.3', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'wind', - ], - 'nameKey' => [ - 'description' => 'The unique identifier of name.', - 'type' => 'string', - 'example' => 'carbonInventory.check.wind_electricity', - ], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'title' => ''], + 'rawData' => ['description' => 'The electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '1.1', 'title' => ''], + 'ratio' => ['description' => 'The percentage of the total monthly electricity consumption. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.3', 'title' => ''], + 'dataUnit' => ['description' => 'The unit of measurement.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Wind power', 'title' => ''], + 'nameKey' => ['description' => 'The code for the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.wind_electricity', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'nuclear' => [ - 'description' => 'Data on nuclear power consumption and carbon emissions at each enterprise.', + 'description' => 'Nuclear power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emission.', - 'type' => 'number', - 'format' => 'double', - 'example' => '2.3', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.6', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'nuclear', - ], - 'nameKey' => [ - 'description' => 'The unique identifier of name.', - 'type' => 'string', - 'example' => 'carbonInventory.check.nuclear_electricity', - ], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '2.3', 'title' => ''], + 'rawData' => ['description' => 'The electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => ''], + 'ratio' => ['description' => 'The percentage of the total monthly electricity consumption. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.6', 'title' => ''], + 'dataUnit' => ['description' => 'The unit of measurement.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Nuclear power', 'title' => ''], + 'nameKey' => ['description' => 'The code for the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.nuclear_electricity', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'renewing' => [ - 'description' => 'Data on renewable electricity consumption and carbon emissions at each enterprise.', + 'description' => 'Renewable energy power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emission.', - 'type' => 'number', - 'format' => 'double', - 'example' => '2.3', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '4.3', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.44', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'renewing', - ], - 'nameKey' => [ - 'description' => 'The unique identifier of name.', - 'type' => 'string', - 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.keZaiShengZiYuan', - ], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '2.3', 'title' => ''], + 'rawData' => ['description' => 'The electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '4.3', 'title' => ''], + 'ratio' => ['description' => 'The percentage of the total monthly electricity consumption. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.44', 'title' => ''], + 'dataUnit' => ['description' => 'The unit of measurement.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Renewable energy power', 'title' => ''], + 'nameKey' => ['description' => 'The code for the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.keZaiShengZiYuan', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'zero' => [ - 'description' => 'Data of zero electricity consumption and carbon emission of each enterprise.', + 'description' => 'Zero-carbon electricity.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emission.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '444.3', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.33', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'The name.', - 'type' => 'string', - 'example' => 'zero', - ], - 'nameKey' => [ - 'description' => 'The unique identifier of name.', - 'type' => 'string', - 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi', - ], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'title' => ''], + 'rawData' => ['description' => 'The electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '444.3', 'title' => ''], + 'ratio' => ['description' => 'The percentage of the total monthly electricity consumption. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.33', 'title' => ''], + 'dataUnit' => ['description' => 'The unit of measurement.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Zero electricity', 'title' => ''], + 'nameKey' => ['description' => 'The code for the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. A unique value is generated for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"water\\": {\\n \\"carbonEmissionData\\": 2.1,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.4,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"水电\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\"\\n },\\n \\"light\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.2,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"光电\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\"\\n },\\n \\"urban\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.4,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"市电\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\"\\n },\\n \\"wind\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.1,\\n \\"ratio\\": 0.3,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"风电\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\"\\n },\\n \\"nuclear\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 2,\\n \\"ratio\\": 0.6,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"核电\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\"\\n },\\n \\"renewing\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 4.3,\\n \\"ratio\\": 0.44,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"可再生能源电力\\\\n\\\\n\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.keZaiShengZiYuan\\"\\n },\\n \\"zero\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 444.3,\\n \\"ratio\\": 0.33,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"零电\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\"\\n }\\n },\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"water\\": {\\n \\"carbonEmissionData\\": 2.1,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.4,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Hydropower\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\"\\n },\\n \\"light\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.2,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Solar power\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\"\\n },\\n \\"urban\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.4,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Grid power\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\"\\n },\\n \\"wind\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.1,\\n \\"ratio\\": 0.3,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Wind power\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\"\\n },\\n \\"nuclear\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 2,\\n \\"ratio\\": 0.6,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Nuclear power\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\"\\n },\\n \\"renewing\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 4.3,\\n \\"ratio\\": 0.44,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Renewable energy power\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.keZaiShengZiYuan\\"\\n },\\n \\"zero\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 444.3,\\n \\"ratio\\": 0.33,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Zero electricity\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\"\\n }\\n },\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', 'title' => 'GetElecConstitute', + 'description' => '本接口的返回值是某组织不同电力类型的能源产生的碳排量。 接口需要传入的参数为：'."\n" + .'- 企业的唯一标识符'."\n" + .'- 碳排统计年份', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecConstitute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetElecConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', ], 'GetElecTrend' => [ - 'summary' => 'This interface is used to obtain power trend analysis data.', + 'summary' => 'Retrieves electricity trend analysis data.', 'path' => '/api/v1/carbon/emission/analysis/elec/trend', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20240115-3', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20240115-3', 'title' => ''], 'yearList' => [ - 'description' => 'List of years.', + 'description' => 'A list of years.', 'type' => 'array', - 'items' => [ - 'description' => 'Year'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2023', - ], + 'items' => ['description' => 'Year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2023', 'title' => ''], 'required' => true, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4439,462 +4140,235 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The struct returned.'."\n", + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'water' => [ - 'description' => 'Monthly data on electricity consumption and carbon emissions for hydropower.', + 'description' => 'The monthly electricity consumption and carbon emission data for hydropower.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data struct for monthly electricity consumption and carbon emissions of hydropower.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e. 50%).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'Power Type Name'."\n", - 'type' => 'string', - 'example' => 'Hydro power', - ], - 'nameKey' => [ - 'description' => 'Power Type Code'."\n", - 'type' => 'string', - 'example' => 'carbonInventory.check.water_electricity', - ], - 'month' => [ - 'description' => 'Month'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'string', - 'example' => '2024', - ], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'rawData' => ['description' => 'Electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The ratio of the electricity consumption to the total electricity consumption for the month. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + 'dataUnit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Hydropower', 'title' => ''], + 'nameKey' => ['description' => 'The code of the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.water_electricity', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'light' => [ - 'description' => 'Photoelectricity monthly electricity consumption and carbon emissions and other data.'."\n", + 'description' => 'The monthly electricity consumption and carbon emission data for photovoltaic power.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data struct for monthly electricity consumption and carbon emissions of photovoltaic power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e. 50%).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'dataUnit' => [ - 'description' => 'The unit.', - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'Power type name.', - 'type' => 'string', - 'example' => 'Solar Power', - ], - 'nameKey' => [ - 'description' => 'Power Type Code'."\n", - 'type' => 'string', - 'example' => 'carbonInventory.check.light_electricity', - ], - 'month' => [ - 'description' => 'Month'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'string', - 'example' => '2024', - ], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'rawData' => ['description' => 'Electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The ratio of the electricity consumption to the total electricity consumption for the month. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + 'dataUnit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Solar power', 'title' => ''], + 'nameKey' => ['description' => 'The code of the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.light_electricity', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'urban' => [ - 'description' => 'Data such as monthly electricity consumption and carbon emissions from the mains.', + 'description' => 'The monthly electricity consumption and carbon emission data for grid power.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data struct for monthly electricity consumption and carbon emissions of grid power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e. 50%).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'dataUnit' => [ - 'description' => 'The price unit.'."\n", - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'Power Type Name'."\n", - 'type' => 'string', - 'example' => 'Grid power', - ], - 'nameKey' => [ - 'description' => 'Power Type Code'."\n", - 'type' => 'string', - 'example' => 'carbonInventory.check.urban_electricity', - ], - 'month' => [ - 'description' => 'Month'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'string', - 'example' => '2024', - ], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'rawData' => ['description' => 'Electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The ratio of the electricity consumption to the total electricity consumption for the month. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + 'dataUnit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Grid power', 'title' => ''], + 'nameKey' => ['description' => 'The code of the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.urban_electricity', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'wind' => [ - 'description' => 'Monthly wind power consumption and carbon emission data'."\n", + 'description' => 'The monthly electricity consumption and carbon emission data for wind power.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data struct for monthly electricity consumption and carbon emissions of wind power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'dataUnit' => [ - 'description' => 'The price unit.'."\n", - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'Power Type Name'."\n", - 'type' => 'string', - 'example' => 'Wind power', - ], - 'nameKey' => [ - 'description' => 'Power Type Code'."\n", - 'type' => 'string', - 'example' => 'carbonInventory.check.wind_electricity', - ], - 'month' => [ - 'description' => 'Month'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'string', - 'example' => '2024', - ], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'rawData' => ['description' => 'Electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The ratio of the electricity consumption to the total electricity consumption for the month. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + 'dataUnit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Wind power', 'title' => ''], + 'nameKey' => ['description' => 'The code of the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.wind_electricity', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'nuclear' => [ - 'description' => 'Monthly electricity consumption and carbon emissions data for nuclear power'."\n", + 'description' => 'The monthly electricity consumption and carbon emission data for nuclear power.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data struct for monthly electricity consumption and carbon emissions of nuclear power.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'dataUnit' => [ - 'description' => 'The price unit.'."\n", - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'Power Type Name'."\n", - 'type' => 'string', - 'example' => 'Nuclear power', - ], - 'nameKey' => [ - 'description' => 'Power Type Code'."\n", - 'type' => 'string', - 'example' => 'carbonInventory.check.nuclear_electricity', - ], - 'month' => [ - 'description' => 'Month'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'string', - 'example' => '2024', - ], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'rawData' => ['description' => 'Electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The ratio of the electricity consumption to the total electricity consumption for the month. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + 'dataUnit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Nuclear power', 'title' => ''], + 'nameKey' => ['description' => 'The code of the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.check.nuclear_electricity', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'renewing' => [ - 'description' => 'Monthly data on renewable electricity consumption and carbon emissions'."\n", + 'description' => 'The monthly electricity consumption and carbon emission data for renewable electricity.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data struct for monthly electricity consumption and carbon emissions of renewable electricity.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'dataUnit' => [ - 'description' => 'The price unit.'."\n", - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'Power Type Name'."\n", - 'type' => 'string', - 'example' => 'Renewable electricity', - ], - 'nameKey' => [ - 'description' => 'Power Type Code'."\n", - 'type' => 'string', - 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi', - ], - 'month' => [ - 'description' => 'Month'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'string', - 'example' => '2024', - ], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'rawData' => ['description' => 'Electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The ratio of the electricity consumption to the total electricity consumption for the month. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + 'dataUnit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Renewable electricity', 'title' => ''], + 'nameKey' => ['description' => 'The code of the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'zero' => [ - 'description' => 'Zero electricity monthly electricity consumption and carbon emissions and other data.'."\n", + 'description' => 'The monthly electricity consumption and carbon emission data for zero-carbon electricity.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data struct for monthly electricity consumption and carbon emissions of zero-carbon electricity.', 'type' => 'object', 'properties' => [ - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'rawData' => [ - 'description' => 'Electricity consumption'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of electricity consumption to all electricity consumption in the month: example value: 0.5 (i. e., 50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'dataUnit' => [ - 'description' => 'The price unit.'."\n", - 'type' => 'string', - 'example' => 'kWh', - ], - 'name' => [ - 'description' => 'Power Type Name'."\n", - 'type' => 'string', - 'example' => 'Zero carbon electricity', - ], - 'nameKey' => [ - 'description' => 'Power Type Code'."\n", - 'type' => 'string', - 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi', - ], - 'month' => [ - 'description' => 'Month'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'string', - 'example' => '2024', - ], + 'carbonEmissionData' => ['description' => 'The carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'rawData' => ['description' => 'Electricity consumption.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The ratio of the electricity consumption to the total electricity consumption for the month. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + 'dataUnit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kWh', 'title' => ''], + 'name' => ['description' => 'The name of the electricity type.', 'type' => 'string', 'example' => 'Zero electricity', 'title' => ''], + 'nameKey' => ['description' => 'The code of the electricity type.', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi', 'title' => ''], + 'month' => ['description' => 'The month.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'string', 'example' => '2024', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'code' => [ - 'description' => 'The code returned for the request. A value of Success indicates that the request was successful. Other values indicate that the request failed. You can troubleshoot the error by viewing the error message returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'code' => ['description' => 'The response code. A value of \\`200\\` indicates that the request was successful. Other values indicate that the request failed. For more information, see the \\`msg\\` parameter.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"water\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"水电\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"光电\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"市电\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"wind\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"风电\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"nuclear\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"核电\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"renewing\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"可再生电\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"zero\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"零电\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"water\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Hydropower\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Solar power\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Grid power\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"wind\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Wind power\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"nuclear\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Nuclear power\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"renewing\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Renewable electricity\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"zero\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Zero electricity\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'GetElecTrend', - ], - 'GetAreaElecConstitute' => [ - 'summary' => 'This interface is used to obtain electrical constitute analysis data.', - 'path' => '/api/v1/carbon/emission/analysis/elec/area', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'description' => '1. The API returns a list. Each element in the list contains emission data for a specific type of electricity.'."\n" + ."\n" + .'2. Each emission list contains the following elements: the year and month of the emission, the electricity consumption and its unit, the corresponding carbon emissions, and the ratio of this consumption to the total electricity consumption for that month.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecTrend'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetElecTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'GetEmissionSourceConstitute' => [ + 'path' => '/api/v1/carbon/emission/analysis/constitute', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'Z-20240115-2', - ], - 'year' => [ - 'description' => 'Year.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20240119-1', 'title' => ''], + 'year' => ['description' => 'The inventory year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], + 'moduleType' => ['description' => 'The module type.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], + 'moduleCode' => ['description' => 'The module code.', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4902,153 +4376,86 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The struct returned.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], 'data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'water' => [ - 'description' => 'Hydropower consumption and carbon emission data of each enterprise.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data structures of hydropower consumption and carbon emission at each enterprise.', - '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', - ], - ], - 'light' => [ - 'description' => 'Photoelectric power consumption and carbon emission data of each enterprise.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data structures such as photovoltaic power consumption and carbon emission at each enterprise.', - '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', - ], - ], - 'urban' => [ - 'description' => 'Data on mains electricity consumption and carbon emission of each enterprise.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data structures such as mains electricity consumption and carbon emission at each enterprise.', - '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', - ], - ], - 'wind' => [ - 'description' => 'Wind power consumption and carbon emission data of each enterprise.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data structures such as wind power consumption and carbon emission at each enterprise.', - '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', - ], - ], - 'nuclear' => [ - 'description' => 'Data on nuclear power consumption and carbon emissions at each enterprise.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data such as electricity consumption for nuclear power and carbon emissions at each enterprise.', - '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', - ], - ], - 'renewing' => [ - 'description' => 'Data on renewable electricity consumption and carbon emissions at each enterprise.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data such as renewable electricity and carbon emissions at each enterprise.', - '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', - ], - ], - 'zero' => [ - 'description' => 'Data of zero electricity consumption and carbon emission of each enterprise.', - 'type' => 'array', - 'items' => [ - 'description' => 'Data structures such as zero electricity consumption and carbon emission of each enterprise.', - '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem', - ], - ], - ], - ], - 'code' => [ - 'description' => 'The code returned for the request. A value of Success indicates that the request was successful. Other values indicate that the request failed. You can troubleshoot the error by viewing the error message returned.'."\n", - 'type' => 'string', - 'example' => '200', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => ['description' => 'A list of composition analysis details.', '$ref' => '#/components/schemas/ConstituteItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetEmissionSourceConstitute', + 'summary' => 'Retrieves the composition of emission sources.', + 'description' => 'Returns the carbon emission details for an organization across various emission source types and facilities. The data is structured as a three-level tree. To call this operation, provide the following parameters:'."\n" + ."\n" + .'- The unique identifier of the enterprise.'."\n" + ."\n" + .'- The year for which carbon emissions are calculated.'."\n" + ."\n" + .'- The type of statistical module.', + 'changeSet' => [ + ['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSourceConstitute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEmissionSourceConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"water\\": [\\n {\\n \\"carbonEmissionData\\": 0,\\n \\"rawData\\": 0,\\n \\"ratio\\": 0,\\n \\"dataUnit\\": \\"\\",\\n \\"name\\": \\"\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 0,\\n \\"rawData\\": 0,\\n \\"ratio\\": 0,\\n \\"dataUnit\\": \\"\\",\\n \\"name\\": \\"\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 0,\\n \\"rawData\\": 0,\\n \\"ratio\\": 0,\\n \\"dataUnit\\": \\"\\",\\n \\"name\\": \\"\\"\\n }\\n ],\\n \\"wind\\": [],\\n \\"nuclear\\": [],\\n \\"renewing\\": [],\\n \\"zero\\": []\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'GetAreaElecConstitute', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"enterpriseName\\": \\"EnterpriseA\\",\\n \\"rawData\\": 1.2,\\n \\"carbonEmissionData\\": 3.222,\\n \\"ratio\\": 0.5,\\n \\"nameKey\\": \\"carbonInventory.check.indirect_emissions_from_imported_electricity\\",\\n \\"name\\": \\"Scope 1: Direct GHG emissions\\",\\n \\"emissionSourceKey\\": \\"carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec\\",\\n \\"emissionSource\\": \\"GEC\\",\\n \\"dataUnit\\": \\"kWh\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"1\\",\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 4.33,\\n \\"carbonEmissionData\\": 1.2\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"EnterpriseA\\",\\n \\"rawData\\": 1.2,\\n \\"carbonEmissionData\\": 3.222,\\n \\"ratio\\": 0.5,\\n \\"nameKey\\": \\"carbonInventory.check.indirect_emissions_from_imported_electricity\\",\\n \\"name\\": \\"Scope 1: Direct GHG emissions\\",\\n \\"emissionSourceKey\\": \\"carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec\\",\\n \\"emissionSource\\": \\"GEC\\",\\n \\"dataUnit\\": \\"kWh\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"1\\",\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 4.33,\\n \\"carbonEmissionData\\": 1.2\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"EnterpriseA\\",\\n \\"rawData\\": 1.2,\\n \\"carbonEmissionData\\": 3.222,\\n \\"ratio\\": 0.5,\\n \\"nameKey\\": \\"carbonInventory.check.indirect_emissions_from_imported_electricity\\",\\n \\"name\\": \\"Scope 1: Direct GHG emissions\\",\\n \\"emissionSourceKey\\": \\"carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec\\",\\n \\"emissionSource\\": \\"GEC\\",\\n \\"dataUnit\\": \\"kWh\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"1\\",\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 4.33,\\n \\"carbonEmissionData\\": 1.2\\n }\\n ],\\n \\"subConstituteItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', ], - 'GetGasConstitute' => [ - 'summary' => 'This interface is used to obtain gas composition analysis.', - 'path' => '/api/v1/carbon/emission/analysis/gas/constitute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetEmissionSummary' => [ + 'summary' => 'Retrieves a carbon emission summary.', + 'path' => '/api/v1/carbon/emission/analysis/summary', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'C-20240115-3', - ], - 'year' => [ - 'description' => 'Year'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], - 'moduleType' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'description' => 'Module type.', - 'example' => '3', - ], - 'moduleCode' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'Module code.', - 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', - ], + 'code' => ['description' => 'The code of the enterprise.', 'type' => 'string', 'required' => true, 'example' => 'C-20240119-1', 'title' => ''], + 'year' => ['description' => 'The inventory year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], + 'moduleType' => ['description' => 'The module type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'moduleCode' => ['description' => 'The module code.', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -5056,125 +4463,95 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The struct returned.'."\n", + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n", - ], 'data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'Gas Type'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'name' => [ - 'description' => 'Name of gas'."\n", - 'type' => 'string', - 'example' => 'CO₂', - ], - 'gasEmissionData' => [ - 'description' => 'Gas emissions'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'carbonEmissionData' => [ - 'description' => 'Carbon emissions', - 'type' => 'number', - 'format' => 'double', - 'example' => '3.14', - ], - 'ratio' => [ - 'description' => 'Proportion of carbon emissions. Example value: 0.5 (50%)'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - ], + 'description' => 'The details of the summary.', + 'type' => 'object', + 'properties' => [ + 'currentPeriodCarbonEmissionData' => ['description' => 'The statistical metric for the current period.', 'type' => 'number', 'format' => 'double', 'example' => '276.4', 'title' => ''], + 'lastPeriodCarbonEmissionData' => ['description' => 'The statistical metric for the previous period.', 'type' => 'number', 'format' => 'double', 'example' => '9.40100', 'title' => ''], + 'totalCarbonEmissionData' => ['description' => 'The total emissions from energy consumption.', 'type' => 'number', 'format' => 'double', 'example' => '276.46', 'title' => ''], + 'carbonSaveConversion' => ['description' => 'The reduced carbon emissions.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'ratio' => ['description' => 'The year-over-year (YoY) change for the current period.', 'type' => 'number', 'format' => 'double', 'example' => '28.410', 'title' => ''], + 'actualEmissionRatio' => ['description' => 'The percentage of recorded emissions.', 'type' => 'number', 'format' => 'double', 'example' => '2.7657', 'title' => ''], + 'weightingCarbonEmissionData' => ['description' => 'The carbon emissions calculated based on the equity ratio.', 'type' => 'number', 'format' => 'double', 'example' => '248.81400', 'title' => ''], + 'lastPeriodWeightingCarbonEmissionData' => ['description' => 'The carbon emissions of the previous period calculated based on the equity ratio.', 'type' => 'number', 'format' => 'double', 'example' => '8.4609', 'title' => ''], + 'weightingRatio' => ['description' => 'The YoY change in carbon emissions based on the equity ratio.', 'type' => 'number', 'format' => 'double', 'example' => '28.4102', 'title' => ''], + 'isWeighting' => ['description' => 'Indicates whether to show carbon emissions based on the equity ratio.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"currentPeriodCarbonEmissionData\\": 276.4,\\n \\"lastPeriodCarbonEmissionData\\": 9.401,\\n \\"totalCarbonEmissionData\\": 276.46,\\n \\"carbonSaveConversion\\": 0,\\n \\"ratio\\": 28.41,\\n \\"actualEmissionRatio\\": 2.7657,\\n \\"weightingCarbonEmissionData\\": 248.814,\\n \\"lastPeriodWeightingCarbonEmissionData\\": 8.4609,\\n \\"weightingRatio\\": 28.4102,\\n \\"isWeighting\\": true\\n },\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', + 'title' => 'GetEmissionSummary', + 'description' => 'Returns the summary of carbon emission metrics for an organization. The following parameters are required:'."\n" + ."\n" + .'- The unique identifier of the organization'."\n" + ."\n" + .'- The year of the statistics'."\n" + ."\n" + .'- The type of the statistical module', + 'changeSet' => [ + ['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSummary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEmissionSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": [\\n {\\n \\"type\\": 1,\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 3.14,\\n \\"carbonEmissionData\\": 3.14,\\n \\"ratio\\": 0.5\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetGasConstitute', ], - 'GetOrgConstitute' => [ - 'summary' => 'This interface is used to obtain carbon inventory organization analysis data.', - 'path' => '/api/v1/carbon/emission/analysis/org', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetEpdInventoryConstitute' => [ + 'summary' => 'Retrieves the detailed results of environmental impact categories.', + 'path' => '/api/v1/carbon/footprint/result/epd/inventory/constitute', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The enterprise code.', - 'type' => 'string', - 'required' => true, - 'example' => 'Z-20240115-2', - ], - 'year' => [ - 'description' => 'Year.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], - 'moduleCode' => [ - 'description' => 'Module code.', - 'type' => 'string', - 'required' => false, - 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions'."\n", - ], - 'moduleType' => [ - 'description' => 'Module type.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'C-20080808-1'], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1024'], + 'productType' => ['description' => 'The product type. Set this to 1 for a product carbon footprint request. Set this to 5 for a supply chain carbon footprint request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -5182,444 +4559,278 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The struct returned.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. This value is unique for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The data returned.'."\n", - '$ref' => '#/components/schemas/OrgEmission', + 'description' => 'A list of environmental impact results.', + 'type' => 'array', + 'items' => ['description' => 'An environmental impact result item.', '$ref' => '#/components/schemas/EpdInventoryConstituteItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"inventoryValuePerProduct\\": 1,\\n \\"factorDataset\\": \\"/\\",\\n \\"percent\\": 31.4,\\n \\"inventoryValuePerProductUnit\\": \\"kg\\",\\n \\"num\\": 1,\\n \\"quantity\\": 1,\\n \\"resourceType\\": \\"Energy\\",\\n \\"factorType\\": 1,\\n \\"unit\\": \\"kg CO2-Eq\\",\\n \\"name\\": \\"climate change\\",\\n \\"inventoryId\\": 1,\\n \\"inventoryValue\\": 2,\\n \\"factorUnit\\": \\"kg CO2-Eq/kg\\",\\n \\"inventoryUnit\\": \\"t\\",\\n \\"state\\": 1,\\n \\"factor\\": \\"1.0000\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"factorId\\": \\"1234\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 1,\\n \\"factorDataset\\": \\"/\\",\\n \\"percent\\": 31.4,\\n \\"inventoryValuePerProductUnit\\": \\"kg\\",\\n \\"num\\": 1,\\n \\"quantity\\": 1,\\n \\"resourceType\\": \\"Energy\\",\\n \\"factorType\\": 1,\\n \\"unit\\": \\"kg CO2-Eq\\",\\n \\"name\\": \\"climate change\\",\\n \\"inventoryId\\": 1,\\n \\"inventoryValue\\": 2,\\n \\"factorUnit\\": \\"kg CO2-Eq/kg\\",\\n \\"inventoryUnit\\": \\"t\\",\\n \\"state\\": 1,\\n \\"factor\\": \\"1.0000\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"factorId\\": \\"1234\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 1,\\n \\"factorDataset\\": \\"/\\",\\n \\"percent\\": 31.4,\\n \\"inventoryValuePerProductUnit\\": \\"kg\\",\\n \\"num\\": 1,\\n \\"quantity\\": 1,\\n \\"resourceType\\": \\"Energy\\",\\n \\"factorType\\": 1,\\n \\"unit\\": \\"kg CO2-Eq\\",\\n \\"name\\": \\"climate change\\",\\n \\"inventoryId\\": 1,\\n \\"inventoryValue\\": 2,\\n \\"factorUnit\\": \\"kg CO2-Eq/kg\\",\\n \\"inventoryUnit\\": \\"t\\",\\n \\"state\\": 1,\\n \\"factor\\": \\"1.0000\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"factorId\\": \\"1234\\",\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetEpdInventoryConstitute', + 'description' => 'This API returns emission amounts for a product, broken down by environmental impact type and level. The data is sourced from the results page. You can use this API to retrieve the emission quantity for each checklist item.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdInventoryConstitute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEpdInventoryConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"weightingCarbonEmissionData\\": 0,\\n \\"weightingRatio\\": 0,\\n \\"ratio\\": 0,\\n \\"weightingProportion\\": 0,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"weightingCarbonEmissionData\\": 0,\\n \\"weightingRatio\\": 0,\\n \\"ratio\\": 0,\\n \\"weightingProportion\\": 0,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"weightingCarbonEmissionData\\": 0,\\n \\"weightingRatio\\": 0,\\n \\"ratio\\": 0,\\n \\"weightingProportion\\": 0,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0\\n }\\n ],\\n \\"subEmissionItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetOrgConstitute', ], - 'BatchSaveInstructionStatus' => [ - 'summary' => '策略执行状态反馈', - 'path' => '/api/v1/carbon/hvac/batchSaveInstructionStatus', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetEpdSummary' => [ + 'summary' => 'Retrieves the total emissions for various environmental impact categories.', + 'path' => '/api/v1/carbon/footprint/result/epd/summary', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertYUWSCO', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'factoryId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***', - ], - 'pKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ib', - ], - 'statusList' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. \\`1\\` indicates a product carbon footprint request. \\`5\\` indicates a supply chain carbon footprint request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. This value is unique for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'B91B5559-065A-55C3-8D75-DA218EBFD1DC'], 'data' => [ - 'description' => 'true', - 'type' => 'boolean', - 'enumValueTitles' => [ - '成功' => 'true', - '失败' => 'false', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'carbonEmission' => ['description' => 'The emission amount. The result is returned with 31 decimal places to ensure calculation accuracy. Truncate this value for display. Use the emission amount with its corresponding unit.', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', 'title' => ''], + 'indicator' => ['description' => 'The evaluation indicator for the environmental impact.', 'type' => 'string', 'example' => 'GWP100a', 'title' => ''], + 'key' => ['description' => 'The category key for the environmental impact category. Up to 19 categories are supported. For more information, see the [appendix](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'string', 'example' => 'gwp', 'title' => ''], + 'method' => ['description' => 'The standard for the calculation method.', 'type' => 'string', 'example' => 'CML v4.8 2016', 'title' => ''], + 'name' => ['description' => 'The name of the category.', 'type' => 'string', 'example' => 'Climate change', 'title' => ''], + 'num' => ['description' => 'The category number. This is the unique ordinal number for the environmental impact category. Up to 19 categories are supported. For more information, see the [appendix](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'preUnit' => ['description' => 'The unit of the environmental impact result.', 'type' => 'string', 'example' => 'kg CO2-Eq', 'title' => ''], + 'state' => ['description' => 'The status of the data. \\`1\\` indicates an accurate calculation. \\`2\\` indicates that default data was used. \\`3\\` indicates that a factor was missing and a value of 0 was used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B91B5559-065A-55C3-8D75-DA218EBFD1DC\\",\\n \\"data\\": [\\n {\\n \\"carbonEmission\\": 1009.97626554,\\n \\"indicator\\": \\"GWP100a\\",\\n \\"key\\": \\"gwp\\",\\n \\"method\\": \\"CML v4.8 2016\\",\\n \\"name\\": \\"Climate change\\",\\n \\"num\\": 1,\\n \\"preUnit\\": \\"kg CO2-Eq\\",\\n \\"state\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetEpdSummary', + 'description' => 'Retrieves the total emissions for a product across various environmental impact categories. The product is identified by its ID. The operation returns the totals from the generated results page.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdSummary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEpdSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'BatchSaveInstructionStatus', + 'translator' => 'machine', ], - 'SetRunningPlan' => [ - 'summary' => '设置运行计划', - 'path' => '/api/v1/carbon/hvac/setRunningPlan', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetFootprintList' => [ + 'summary' => 'Retrieves a list of product carbon footprints.', + 'path' => '/api/v1/carbon/footprint/product/list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertXYPXBQ', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'factoryId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***', - ], - 'systemId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'system1', - ], - 'pKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ib', - ], - 'seasonMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '冬季' => '1', - '夏季' => '0', - ], - 'example' => '0', - ], - 'dateType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '工作日' => '0', - '节假日' => '1', - ], - 'example' => '0', - ], - 'startTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-07-20', - ], - 'endTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-07-21', - ], - 'statisticsTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-07-31', - ], - 'workingStartTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:00:00', - ], - 'workingEndTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:30:00', - ], - 'earliestStartupTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:00:00', - ], - 'latestShutdownTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:30:00', - ], - 'minTem' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.1', - ], - 'maxTem' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '3.1', - ], - 'maxCarbonDioxide' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.1', - ], - 'controlType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '手动' => '1', - '自动' => '0', - ], - 'example' => '0', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'currentPage' => ['description' => 'The paging parameter. This is the page number. The value starts from 1.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], + 'productType' => ['description' => 'The product type. A value of 1 indicates a request for a product carbon footprint. A value of 5 indicates a request for a supply chain carbon footprint.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique ID. This helps with troubleshooting.', 'type' => 'string', 'example' => '06DA2909-7736-5738-AA31-ACD617D828F1'], 'data' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - '成功' => 'true', - '失败' => 'false', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'currentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'records' => [ + 'description' => 'A list of product details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The product information struct.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'name' => ['description' => 'The product name.', 'type' => 'string', 'example' => 'Demo product', 'title' => ''], + 'authStatus' => ['description' => 'The enumeration value for the certification status. For more information, see [the appendix](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'amount' => ['description' => 'The product quantity.', 'type' => 'number', 'format' => 'double', 'example' => '100.0000000000000000000000000', 'title' => ''], + 'checkStartTime' => ['description' => 'The start time of the calculation.', 'type' => 'string', 'example' => '2024/01/01', 'title' => ''], + 'checkEndTime' => ['description' => 'The end time of the calculation.', 'type' => 'string', 'example' => '2024/01/31', 'title' => ''], + 'createdBy' => ['description' => 'The creator.', 'type' => 'string', 'example' => 'Energy Expert', 'title' => ''], + 'code' => ['description' => 'The code of the enterprise to which the product belongs.', 'type' => 'string', 'example' => 'C-20080808-1', 'title' => ''], + 'isDemoModel' => ['description' => 'Indicates whether the model is a demo model. A value of 1 means yes. A value of 0 means no. A true value indicates a system-built demo model.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'lifeCycle' => ['description' => 'The text description that corresponds to the lifeCycleType. The value can be `cradle-to-gate` or `cradle-to-grave`.', 'type' => 'string', 'example' => '从摇篮到大门', 'title' => ''], + 'lifeCycleType' => ['description' => 'A value of 1 indicates cradle-to-gate. A value of 2 indicates cradle-to-grave.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'type' => ['description' => 'The enumeration value for the product category. For more information, see [the appendix](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'string', 'example' => '158-159', 'title' => ''], + 'unit' => ['description' => 'The enumeration value for the unit. For more information, see [the appendix](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'string', 'example' => '1-4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '21', 'title' => ''], + 'totalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"06DA2909-7736-5738-AA31-ACD617D828F1\\",\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"id\\": 1024,\\n \\"name\\": \\"Demo product\\",\\n \\"authStatus\\": 1,\\n \\"amount\\": 100,\\n \\"checkStartTime\\": \\"2024/01/01\\",\\n \\"checkEndTime\\": \\"2024/01/31\\",\\n \\"createdBy\\": \\"Energy Expert\\",\\n \\"code\\": \\"C-20080808-1\\",\\n \\"isDemoModel\\": 1,\\n \\"lifeCycle\\": \\"从摇篮到大门\\",\\n \\"lifeCycleType\\": 1,\\n \\"type\\": \\"158-159\\",\\n \\"unit\\": \\"1-4\\"\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3\\n }\\n}","type":"json"}]', + 'title' => 'GetFootprintList', + 'description' => 'Returns a list of product or supply chain carbon footprints that match the specified criteria. You can specify parameters such as the enterprise code, page number, and page size. The returned list includes information such as the product name and product ID. The product ID is used as an input parameter in other API operations to retrieve the results for the corresponding product.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFootprintList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetFootprintList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'SetRunningPlan', + 'translator' => 'manual', ], - 'EditUnfavorableAreaDevices' => [ - 'summary' => '编辑不利区设备', - 'path' => '/api/v1/carbon/hvac/editUnfavorableAreaDevices', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetGasConstitute' => [ + 'summary' => 'Retrieves a gas composition analysis.', + 'path' => '/api/v1/carbon/emission/analysis/gas/constitute', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertYUWSCO', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'factoryId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***', - ], - 'systemId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'system1', - ], - 'hvacDeviceConfigVOList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'deviceName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'name1', - ], - 'deviceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id1', - ], - 'deviceType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - '空调机组' => '6', - '锅炉' => '7', - '冷机' => '1', - '冷却塔' => '2', - '水泵' => '3', - '室内环境' => '4', - ], - 'example' => '1', - ], - 'isForbidden' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '不是禁用设备' => '0', - '是禁用设备' => '1', - ], - 'example' => '1', - ], - 'isUnfavorableArea' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - '是不利区' => '1', - '不是不利区' => '0', - ], - 'example' => '1', - ], - 'buildingId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'buildingId1', - ], - 'floorId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'floorId2', - ], - 'fenceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fenceId1', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20240115-3', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], + 'moduleType' => ['description' => 'The module type.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], + 'moduleCode' => ['description' => 'The module code.', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -5627,165 +4838,90 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"], 'data' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - '成功' => 'true', - '失败' => 'false', + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response data structure.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The gas type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'name' => ['description' => 'The gas name.', 'type' => 'string', 'example' => 'CO₂', 'title' => ''], + 'gasEmissionData' => ['description' => 'The amount of gas emissions.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'carbonEmissionData' => ['description' => 'The carbon emission equivalent.', 'type' => 'number', 'format' => 'double', 'example' => '3.14', 'title' => ''], + 'ratio' => ['description' => 'The carbon emission ratio. For example, a value of 0.5 indicates 50%.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetGasConstitute', + 'changeSet' => [ + ['createdAt' => '2024-06-12T01:57:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'EditUnfavorableAreaDevices', - ], - 'EditProhibitedDevices' => [ - 'summary' => '编辑禁用设备', - 'path' => '/api/v1/carbon/hvac/editProhibitedDevices', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGasConstitute'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGasConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": [\\n {\\n \\"type\\": 1,\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 3.14,\\n \\"carbonEmissionData\\": 3.14,\\n \\"ratio\\": 0.5\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetGwpBenchmarkList' => [ + 'summary' => 'Retrieves a ranked list of active carbon reduction initiatives.', + 'path' => '/api/v1/carbon/footprint/result/gwp/benchmark/list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertYUWSCO', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'factoryId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***', - ], - 'systemId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'system1', - ], - 'hvacDeviceConfigVOList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'deviceName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'name1', - ], - 'deviceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id1', - ], - 'deviceType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - '空调机组' => '6', - '锅炉' => '7', - '冷机' => '1', - '冷却塔' => '2', - '水泵' => '3', - '室内环境' => '4', - ], - 'example' => '1', - ], - 'isForbidden' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - '不禁用' => '0', - '是禁用' => '1', - ], - 'example' => '1', - ], - 'isUnfavorableArea' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'buildingId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'build_01', - ], - 'floorId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'floor_01', - ], - 'fenceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fence_01', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. A value of 1 indicates a product carbon footprint request. A value of 5 indicates a supply chain carbon footprint request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -5793,314 +4929,196 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'A8AEC6D9-A359-5169-BD1A-BD848BA60D65'], 'data' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - '成功' => 'true', - '失败' => 'false', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'unit' => ['description' => 'The unit of emissions. The default value is kgCO₂e/productUnit, where \\`productUnit\\` is the unit selected for the product. The unit automatically adjusts to tCO₂e/productUnit or gCO₂e/productUnit based on the emission quantity.', 'type' => 'string', 'example' => 'kgCO₂e/kg', 'title' => ''], + 'items' => [ + 'description' => 'The ranking list of active carbon reduction initiatives.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the carbon reduction project.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the inventory item.', 'type' => 'string', 'example' => 'PVC waste recycling', 'title' => ''], + 'carbonEmission' => ['description' => 'The emissions of the inventory item. The value is accurate to four decimal places. The unit is specified by the \\`unit\\` parameter at the parent level.', 'type' => 'number', 'format' => 'double', 'example' => '-0.2061', 'title' => ''], + 'percent' => ['description' => 'This parameter is not in use.', 'type' => 'string', 'example' => '暂为null', 'title' => ''], + 'benchmarkName' => ['description' => 'The name of the baseline.', 'type' => 'string', 'example' => 'PVC waste incineration', 'title' => ''], + 'benchmarkEmission' => ['description' => 'The baseline emissions associated with the inventory item. The value is accurate to four decimal places. The unit is specified by the \\`unit\\` parameter at the parent level.', 'type' => 'number', 'format' => 'double', 'example' => '0.0108', 'title' => ''], + 'activeReduction' => ['description' => 'The active carbon reduction amount. This value is calculated by subtracting the inventory item\'s emissions from the baseline emissions. Typically, the baseline emissions are greater than the inventory item\'s emissions. The value is accurate to four decimal places. The unit is specified by the \\`unit\\` parameter at the parent level.', 'type' => 'number', 'format' => 'double', 'example' => '0.2169', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": {\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"items\\": [\\n {\\n \\"name\\": \\"PVC waste recycling\\",\\n \\"carbonEmission\\": -0.2061,\\n \\"percent\\": \\"暂为null\\",\\n \\"benchmarkName\\": \\"PVC waste incineration\\",\\n \\"benchmarkEmission\\": 0.0108,\\n \\"activeReduction\\": 0.2169\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetGwpBenchmarkList', + 'description' => 'Returns a paginated list of active carbon reduction amounts for a specified product. You can use this operation to understand the active carbon reduction amounts at each product level.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpBenchmarkList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'EditProhibitedDevices', + 'translator' => 'machine', ], - 'BatchUpdateSystemRunningPlan' => [ - 'summary' => '批量设置空调站点运行计划', - 'path' => '/api/v1/carbon/hvac/batchUpdateSystemRunningPlan', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetGwpBenchmarkSummary' => [ + 'summary' => 'Retrieves the total proactive carbon reduction.', + 'path' => '/api/v1/carbon/footprint/result/gwp/benchmark/summary', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertXYPXBQ', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'factoryId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***', - ], - 'systemId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'system1', - ], - 'seasonMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '冬季' => '1', - '夏季' => '0', - ], - 'example' => '0', - ], - 'dateType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '工作日' => '0', - '节假日' => '1', - ], - 'example' => '0', - ], - 'startTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2024-08-21', - ], - 'endTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2024-08-30', - ], - 'workingStartTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:00:00', - ], - 'workingEndTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:30:00', - ], - 'earliestStartupTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:00:00', - ], - 'latestShutdownTime' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '05:30:00', - ], - 'minTem' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '20.1', - ], - 'maxTem' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '25.3', - ], - 'maxCarbonDioxide' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '37.1', - ], - 'controlType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '手动' => '1', - '自动' => '0', - ], - 'example' => '0', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. A value of \\`1\\` indicates a product carbon footprint request. A value of \\`5\\` indicates a supply chain carbon footprint request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique ID for troubleshooting.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - '成功' => 'true', - '失败' => 'false', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'Details of the top four contributors to carbon reduction.', + 'type' => 'array', + 'items' => [ + 'description' => 'Item details.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the carbon reduction detail.', 'type' => 'string', 'example' => 'Raw materials', 'title' => ''], + 'percent' => ['description' => 'The emission percentage. This is a string with two decimal places. For example, a value of \\`99.01\\` indicates that this category accounts for 99.01% of the total emissions. Note that the returned string does not include the percent sign (%).', 'type' => 'string', 'example' => '99.01', 'title' => ''], + 'quantity' => ['description' => 'The emission quantity, with a precision of four decimal places. This value is typically not negative, but you can construct a negative value for proactive carbon reduction. The \\`quantity\\` and \\`unit\\` parameters are adaptive and together represent the emission amount. The unit automatically adjusts based on the quantity. If the emission amount is greater than 1000 kgCO₂e/productUnit, the unit is converted to tCO₂e/productUnit. If the amount is less than 1 kgCO₂e/productUnit, the unit is converted to gCO₂e/productUnit. Otherwise, the unit remains kgCO₂e/productUnit.', 'type' => 'integer', 'format' => 'int64', 'example' => '9.9763', 'title' => ''], + 'unit' => ['description' => 'The emission unit. The default is kgCO₂e/productUnit, where \\`productUnit\\` is the unit selected for the product. The \\`unit\\` adaptively changes to tCO₂e/productUnit or gCO₂e/productUnit based on the \\`quantity\\`. For more information about the conversion rules, see the description of the \\`quantity\\` parameter.', 'type' => 'string', 'example' => 'kgCO₂e/kg', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'quantity' => ['description' => 'The emission quantity, with a precision of four decimal places. This value is typically not negative, but you can construct a negative value for proactive carbon reduction. The \\`quantity\\` and \\`unit\\` parameters are adaptive and together represent the emission amount. The unit automatically adjusts based on the quantity. If the emission amount is greater than 1000 kgCO₂e/productUnit, the unit is converted to tCO₂e/productUnit. If the amount is less than 1 kgCO₂e/productUnit, the unit is converted to gCO₂e/productUnit. Otherwise, the unit remains kgCO₂e/productUnit.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000.0000', 'title' => ''], + 'unit' => ['description' => 'The emission unit. The default is kgCO₂e/productUnit, where \\`productUnit\\` is the unit selected for the product. The \\`unit\\` adaptively changes to tCO₂e/productUnit or gCO₂e/productUnit based on the \\`quantity\\`. For more information about the conversion rules, see the description of the \\`quantity\\` parameter.', 'type' => 'string', 'example' => 'kgCO₂e/t', 'title' => ''], ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"Raw materials\\",\\n \\"percent\\": \\"99.01\\",\\n \\"quantity\\": 9.9763,\\n \\"unit\\": \\"kgCO₂e/kg\\"\\n }\\n ],\\n \\"quantity\\": 1000,\\n \\"unit\\": \\"kgCO₂e/t\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetGwpBenchmarkSummary', + 'description' => 'Returns the proactive carbon reduction data from the generated results page for a specific product ID. It also provides details about the top four contributors to carbon reduction. You can use this operation to understand the total proactive carbon reduction for a product and its main sources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkSummary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpBenchmarkSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - 'title' => 'BatchUpdateSystemRunningPlan', + 'translator' => 'machine', ], - 'PushDeviceData' => [ - 'summary' => 'This interface is used to push device measuring point data, such as power meter voltage and other data.', - 'path' => '/api/v1/data/increment/push', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetGwpInventoryConstitute' => [ + 'summary' => 'Retrieves the carbon emission composition analysis for a specified product. The analysis provides a breakdown across two dimensions: by checklist and by type. The results are rendered as a hierarchical list and a pie chart.', + 'path' => '/api/v1/carbon/footprint/result/gwp/inventory/constitute', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Request parameters.', 'type' => 'object', 'properties' => [ - 'deviceType' => [ - 'description' => 'The type of the device. [View device type definitions](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/Deviceappendixes-en.pdf)', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'devices' => [ - 'description' => 'List of devices to which data is pushed.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'deviceId' => [ - 'description' => 'If the deviceType parameter is set to 12, 13, or 17, you must set the system_id parameter. The field name is still device_id. If the deviceType parameter is set to 15 or 16, no Other situations will be transmitted.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'device_code_xxx', - ], - 'recordTime' => [ - 'description' => 'Data generation time of measuring point.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-09-08 18:40:00', - ], - 'data' => [ - 'description' => 'Measuring point information To avoid accuracy problems, the measurement point data is uniformly transmitted to the string. The function of missing required fields cannot be used normally. Some functions may be affected due to the lack of recommend fields. For details, please refer to the notes of equipment measuring points in the appendix. [Reference Point Definition](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/Deviceappendixes-en.pdf'."\n" - .')', - 'type' => 'object', - 'required' => true, - 'example' => '{'."\n" - .' "dp_imp": "329.0",'."\n" - .' "F": "148.0",'."\n" - .' "eq_imp": "363.0",'."\n" - .' "Ep_imp_1": "128.0",'."\n" - .' "Ep_imp_2": "157.0",'."\n" - .' "Ua": "226.0",'."\n" - .' "Ub": "285.0",'."\n" - .' "Ep_imp": "325.0",'."\n" - .' "Uc": "342.0",'."\n" - .' "Ep_imp_3": "109.0",'."\n" - .' "Ep_imp_4": "94.0",'."\n" - .' "P": "514.0",'."\n" - .' "Pa": "443.0",'."\n" - .' "Q": "265.0",'."\n" - .' "dp_exp": "261.0",'."\n" - .' "eq_exp": "399.0",'."\n" - .' "COSQ": "223.0",'."\n" - .' "Ia": "240.0",'."\n" - .' "Ib": "216.0",'."\n" - .' "Ic": "229.0",'."\n" - .' "Ep_exp": "115.0",'."\n" - .' "VdisPer": "120.0"'."\n" - .' }', - ], - ], - 'required' => true, - ], - 'required' => true, - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. A value of 1 indicates a request for a product carbon footprint. A value of 5 indicates a request for a supply chain carbon footprint.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6108,88 +5126,96 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The struct returned.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique value. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '06DA2909-7736-5738-AA31-ACD617D828F1'], 'data' => [ - 'description' => 'Whether the data is pushed successfully. Success is returned.'."\n", - 'type' => 'string', - 'example' => 'success', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The meaning of the current hierarchical structure.', 'type' => 'string', 'example' => 'Total carbon emissions', 'title' => ''], + 'unit' => ['description' => 'The emissions unit.', 'type' => 'string', 'example' => 'kgCO₂e/t', 'title' => ''], + 'carbonEmission' => ['description' => 'The amount of emissions. The value can be positive, negative, or 0. To ensure calculation accuracy, the calculation process retains 24 decimal places. For ease of display and use, truncate the value as needed.', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', 'title' => ''], + 'byResourceType' => [ + 'description' => 'Aggregated by type. This includes the emission details for each type.', + 'type' => 'array', + 'items' => ['description' => 'Used for the \'by type\' analysis. This is a two-level nested structure. The top level is Total Carbon Emissions, which is then sorted by checklist type. The byResourceType parameter at the lowest level is empty.', '$ref' => '#/components/schemas/GwpInventoryConstitute', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'items' => [ + 'description' => 'Organized in a hierarchical structure from the highest level to the lowest level: stage, procedure, and then checklist.', + 'type' => 'array', + 'items' => ['description' => 'Used for the \'by checklist\' analysis. This is a nested structure organized by stage, procedure, and checklist level. The items parameter at the lowest level is empty.', '$ref' => '#/components/schemas/GwpInventoryConstitute', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"06DA2909-7736-5738-AA31-ACD617D828F1\\",\\n \\"data\\": {\\n \\"name\\": \\"Total carbon emissions\\",\\n \\"unit\\": \\"kgCO₂e/t\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"byResourceType\\": [\\n {\\n \\"percent\\": 100,\\n \\"resourceType\\": 1,\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"name\\": \\"Acquisition of Raw Materials\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"Energy\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"resourceType\\": 1,\\n \\"carbonEmission\\": 1009.97626554,\\n \\"percent\\": \\"98.76\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 100,\\n \\"resourceType\\": 1,\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"name\\": \\"Acquisition of Raw Materials\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"Energy\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"resourceType\\": 1,\\n \\"carbonEmission\\": 1009.97626554,\\n \\"percent\\": \\"98.76\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 100,\\n \\"resourceType\\": 1,\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"name\\": \\"Acquisition of Raw Materials\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"Energy\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"resourceType\\": 1,\\n \\"carbonEmission\\": 1009.97626554,\\n \\"percent\\": \\"98.76\\"\\n }\\n ],\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"items\\": []\\n }\\n}","type":"json"}]', + 'title' => 'GetGwpInventoryConstitute', + 'description' => 'Retrieves the carbon emission composition analysis for a specified product. The analysis provides a breakdown across two dimensions: by checklist and by type. The results are rendered as a hierarchical list and a pie chart.', + 'changeSet' => [ + ['createdAt' => '2024-04-01T08:43:56.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'PushDeviceData', - ], - 'GetDeviceInfo' => [ - 'summary' => 'Queries the information about a device at a site that is activated by using an Alibaba Cloud account.', - 'path' => '/api/external/getDeviceInfo', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventoryConstitute'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpInventoryConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'GetGwpInventorySummary' => [ + 'summary' => 'Retrieves the total carbon footprint of a product and provides details about its top four contributors.', + 'path' => '/api/v1/carbon/footprint/result/gwp/inventory/summary', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'factoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pn_95', - ], - ], - [ - 'name' => 'deviceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the device.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pn_69873', - ], - ], - [ - 'name' => 'ds', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The time string in the YYYY-mm-dd format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-07-26', + 'description' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. \\`1\\`: product carbon footprint. \\`5\\`: supply chain carbon footprint.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6197,167 +5223,106 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'httpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'code' => [ - 'description' => 'The code returned for the request. A value of Success indicates that the request was successful. Other values indicate that the request failed. You can troubleshoot the error by viewing the error message returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'deviceId' => [ - 'description' => 'The ID of the device.'."\n", - 'type' => 'string', - 'example' => 'pn_69873', - ], - 'deviceName' => [ - 'description' => 'The name of the device.'."\n", - 'type' => 'string', - 'example' => 'Main transformer 4#'."\n", - ], - 'firstTypeName' => [ - 'description' => 'The level 1 meter type.'."\n", - 'type' => 'string', - 'example' => 'Electric meter'."\n", - ], - 'secondTypeName' => [ - 'description' => 'The level 2 meter type.'."\n", - 'type' => 'string', - 'example' => 'Gateway meter'."\n", - ], - 'recordList' => [ - 'description' => 'The device parameters.'."\n", + 'unit' => ['description' => 'The unit of emissions.', 'type' => 'string', 'example' => 'tCO₂e/Piece(s)', 'title' => ''], + 'quantity' => ['description' => 'The quantity.', 'type' => 'number', 'format' => 'double', 'example' => '1.0100', 'title' => ''], + 'resultGenerateTime' => ['description' => 'The time when the result was generated. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1709108026000', 'title' => ''], + 'items' => [ + 'description' => 'Details of the top four contributors to the carbon footprint.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the device.'."\n", 'type' => 'object', 'properties' => [ - 'statisticsDate' => [ - 'description' => 'The date on which the statistics were collected.'."\n", - 'type' => 'string', - 'example' => '2022-07-26 00:00:00', - ], - 'paramName' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'Phase A current'."\n", - ], - 'unit' => [ - 'description' => 'The unit of the parameter value.'."\n", - 'type' => 'string', - 'example' => 'A', - ], - 'identifier' => [ - 'description' => 'The device identifier.'."\n", - 'type' => 'string', - 'example' => 'Ia', - ], - 'type' => [ - 'description' => 'The type of the measuring point.'."\n", - 'type' => 'string', - 'example' => 'DOUBLE', - ], - 'value' => [ - 'description' => 'The value of the measuring point.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '20.00', - ], + 'name' => ['description' => 'The name of the inventory type.', 'type' => 'string', 'example' => 'Electricity inventory', 'title' => ''], + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'kgCO₂e/Piece(s)', 'title' => ''], + 'quantity' => ['description' => 'The quantity.', 'type' => 'number', 'format' => 'double', 'example' => '9.9763', 'title' => ''], + 'percent' => ['description' => 'The percentage.', 'type' => 'string', 'example' => '99.01', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'invalidParameter', - 'errorMessage' => 'Invalid parameter values.', - ], - ], - [ - [ - 'errorCode' => 'notAuthorized', - 'errorMessage' => 'No permissions to call API operations.', - ], - ], - 500 => [ - [ - 'errorCode' => 'systemError', - 'errorMessage' => 'System error.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"tCO₂e/Piece(s)\\",\\n \\"quantity\\": 1.01,\\n \\"resultGenerateTime\\": 1709108026000,\\n \\"items\\": [\\n {\\n \\"name\\": \\"Electricity inventory\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"quantity\\": 9.9763,\\n \\"percent\\": \\"99.01\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetGwpInventorySummary', + 'description' => 'Retrieves the total carbon footprint for a specified product ID. It also provides details about the top four contributors to the carbon footprint. You can use this operation to understand the total carbon footprint of a product and identify its main sources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventorySummary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpInventorySummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"主变4#\\",\\n \\"firstTypeName\\": \\"电表\\",\\n \\"secondTypeName\\": \\"关口表\\",\\n \\"recordList\\": [\\n {\\n \\"statisticsDate\\": \\"2022-07-26 00:00:00\\",\\n \\"paramName\\": \\"A相电流\\",\\n \\"unit\\": \\"A\\",\\n \\"identifier\\": \\"Ia\\",\\n \\"type\\": \\"DOUBLE\\",\\n \\"value\\": 20\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDeviceInfo', - 'description' => '* You can call this operation to query the parameters of a data collection device based on the device ID. If the verification is passed, the device parameters are returned. If the verification fails, a null value is returned.'."\n" - .'* You can query the parameters of a single device by day. If data of the device does not exist, a null value is returned.'."\n" - .'- By current, endpoint only supports Hangzhou: `energyexpertexternal.cn-hangzhou.aliyuncs.com`.'."\n" - .'- To use this API, you need to be added to the whitelist. Please contact us through <props="china">[official website](https://energy.aliyun.com/ifa/web/defaultLoginPage?adapter=aliyun#/consult?source=%E8%83%BD%E8%80%97%E5%AE%9D%E7%99%BB%E5%BD%95%E9%A1%B5%EF%BC%88WEB%EF%BC%89)</props> '."\n" - .'<props="intl">[official website](https://energy.alibabacloud.com/common?adapter=aliyun&lang=en-US#/home/en)</props> to apply for whitelist activation.', + 'translator' => 'machine', ], - 'GetDeviceList' => [ - 'summary' => 'Queries the devices of a site that is activated by using an Alibaba Cloud account.', - 'path' => '/api/external/getDeviceList', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetInventoryList' => [ + 'summary' => 'Retrieves a descending list of emissions for a specified environmental impact (methodType), grouping level (group), and calculation method (emissionType).', + 'path' => '/api/v1/carbon/footprint/result/inventory/list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'factoryId', - 'in' => 'query', - 'allowEmptyValue' => false, + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the site.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pn_95', + 'description' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. A value of \\`1\\` indicates a product carbon footprint request. A value of \\`5\\` indicates a supply chain carbon footprint request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'methodType' => ['description' => 'The type of environmental impact. A value of \\`gwp\\` indicates the climate change carbon footprint. For other values, see the \\`type\\` value in the enumeration list. For more information, see [the appendix](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'string', 'required' => true, 'example' => 'gwp', 'title' => ''], + 'emissionType' => ['description' => 'The emission type.'."\n" + ."\n" + .'> Valid values: \\`footprint\\` and \\`emission\\`. \\`footprint\\`: All inventories are included in the calculation. \\`emission\\`: Only inventories with positive or zero emissions are included. Negative values are excluded.', 'type' => 'string', 'required' => true, 'example' => 'footprint', 'title' => ''], + 'group' => ['description' => 'The grouping basis.'."\n" + ."\n" + .'> Valid values: \\`resource\\`, \\`process\\`, \\`resourceType\\`, and \\`processType\\`. \\`resource\\`: Groups by inventory. \\`process\\`: Groups by process. \\`resourceType\\`: Groups by inventory type. \\`processType\\`: Groups by stage.', 'type' => 'string', 'required' => true, 'example' => 'resource', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6365,339 +5330,209 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. This value is unique for each request and helps with troubleshooting.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'factoryId' => [ - 'description' => 'The ID of the site.'."\n", - 'type' => 'string', - 'example' => 'pn_95', - ], - 'deviceList' => [ - 'description' => 'The devices.'."\n", + 'unit' => ['description' => 'The unit of emissions. The default is \\`kgCO₂e/productUnit\\`, where \\`productUnit\\` is the unit of the product. The \\`unit\\` automatically adjusts to \\`tCO₂e/productUnit\\` or \\`gCO₂e/productUnit\\` based on the emission quantity. For details about the conversion rules, see the \\`carbonEmission\\` parameter.', 'type' => 'string', 'example' => 'kgCO₂e/kg', 'title' => ''], + 'productUnit' => ['description' => 'The unit of the product.', 'type' => 'string', 'example' => 'kg', 'title' => ''], + 'items' => [ + 'description' => 'The details of the emission list.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the device.'."\n", 'type' => 'object', 'properties' => [ - 'deviceId' => [ - 'description' => 'The device ID.'."\n", - 'type' => 'string', - 'example' => 'pn_69873', - ], - 'deviceName' => [ - 'description' => 'The device name.'."\n", - 'type' => 'string', - 'example' => 'Main transformer 4#'."\n", - ], - 'firstTypeName' => [ - 'description' => 'The level 1 meter type.'."\n", - 'type' => 'string', - 'example' => 'Electric meter'."\n", - ], - 'secondTypeName' => [ - 'description' => 'The level 2 meter type.'."\n", - 'type' => 'string', - 'example' => 'Gateway meter'."\n", - ], - 'parentDevice' => [ - 'description' => 'The ID of the parent device.'."\n", - 'type' => 'string', - 'example' => 'pn_6987', - ], - 'info' => [ - 'description' => 'The device information.'."\n", - 'type' => 'object', - 'properties' => [ - 'magnification' => [ - 'description' => 'The magnification ratio.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'pressure' => [ - 'description' => 'The high and low voltage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'pt' => [ - 'description' => 'The transformation ratio of voltage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'ct' => [ - 'description' => 'The transformation ratio of current.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'constKva' => [ - 'description' => 'The rated capacity.'."\n" - .'Unit is kVA.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], + 'name' => ['description' => 'The name.'."\n" + ."\n" + .'> The meaning of this parameter depends on the \\`group\\` request parameter. If \\`group\\` is \\`resource\\`, \\`name\\` is the inventory name. If \\`group\\` is \\`process\\`, \\`name\\` is the process name. If \\`group\\` is \\`resourceType\\`, \\`name\\` is the inventory type name. If \\`group\\` is \\`processType\\`, \\`name\\` is the stage name.', 'type' => 'string', 'example' => 'Electricity', 'title' => ''], + 'carbonEmission' => ['description' => 'The emission quantity. The value can be positive, negative, or zero. To ensure accuracy, the calculation retains 24 decimal places. For display and use, truncate the value as needed.', 'type' => 'number', 'format' => 'double', 'example' => '1000.000000000000000000000000000000', 'title' => ''], + 'percent' => ['description' => 'The percentage.', 'type' => 'string', 'example' => '99.01', 'title' => ''], + 'processName' => ['description' => 'The process name. This parameter is valid only when the \\`group\\` request parameter is set to \\`resource\\`.', 'type' => 'string', 'example' => 'Process-1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'httpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'code' => [ - 'description' => 'The code returned for the request.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'title' => '', + 'example' => '', ], ], - ], - 'httpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'invalidParameter', - 'errorMessage' => 'Invalid parameter values.', - ], - ], - [ - [ - 'errorCode' => 'notAuthorized', - 'errorMessage' => 'No permissions to call API operations.', - ], - ], - 500 => [ - [ - 'errorCode' => 'systemError', - 'errorMessage' => 'System error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"productUnit\\": \\"kg\\",\\n \\"items\\": [\\n {\\n \\"name\\": \\"Electricity\\",\\n \\"carbonEmission\\": 1000,\\n \\"percent\\": \\"99.01\\",\\n \\"processName\\": \\"Process-1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetInventoryList', + 'description' => 'This API retrieves a descending list of emissions for a specified product ID, environmental impact (methodType), grouping level (group), and calculation method (emissionType). You can use this API to understand the emissions associated with various environmental impacts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInventoryList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetInventoryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"deviceList\\": [\\n {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"主变4#\\",\\n \\"firstTypeName\\": \\"电表\\",\\n \\"secondTypeName\\": \\"关口表\\",\\n \\"parentDevice\\": \\"pn_6987\\",\\n \\"info\\": {\\n \\"magnification\\": 80,\\n \\"pressure\\": 0,\\n \\"pt\\": 80,\\n \\"ct\\": 1,\\n \\"constKva\\": 100\\n }\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n },\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]', - 'title' => 'GetDeviceList', - 'description' => '* You can query the information about data collection devices of a site based on the ID of the site. If the verification is passed, the information about the devices of the site is returned. If the verification fails, a null value is returned.'."\n" - .'* Virtual meters at the site are not returned.'."\n" - .'- By current, endpoint only supports Hangzhou: `energyexpertexternal.cn-hangzhou.aliyuncs.com`.'."\n" - .'- To use this API, you need to be added to the whitelist. Please contact us through <props="china">[official website](https://energy.aliyun.com/ifa/web/defaultLoginPage?adapter=aliyun#/consult?source=%E8%83%BD%E8%80%97%E5%AE%9D%E7%99%BB%E5%BD%95%E9%A1%B5%EF%BC%88WEB%EF%BC%89)</props> '."\n" - .'<props="intl">[official website](https://energy.alibabacloud.com/common?adapter=aliyun&lang=en-US#/home/en)</props> to apply for whitelist activation.', + 'translator' => 'machine', ], 'GetOrgAndFactory' => [ - 'summary' => 'Queries the organizations and sites that are activated by using an Alibaba Cloud account. You cannot call this operation to query the organizations or sites that have not been activated in the console.', + 'summary' => 'Queries the organizations and sites that are activated for an account. Sites that are not activated in the console are excluded from the response.', 'path' => '/api/external/getOrgAndFactory', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'data'."\n", + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The results of the operation.', 'type' => 'object', 'properties' => [ - 'aliyunPk' => [ - 'description' => 'The Alibaba Cloud account ID.'."\n", - 'type' => 'string', - 'example' => '1319617584664960', - ], - 'organizationId' => [ - 'description' => 'The enterprise ID.'."\n", - 'type' => 'string', - 'example' => '6265f42XXXX2fec150', - ], - 'organizationName' => [ - 'description' => 'The enterprise name.'."\n", - 'type' => 'string', - 'example' => 'Ledi Industrial Park'."\n", - ], + 'aliyunPk' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1319XXXXXX64960', 'title' => ''], + 'organizationId' => ['description' => 'The ID of the organization.', 'type' => 'string', 'example' => '6265f42XXXX2fec150', 'title' => ''], + 'organizationName' => ['description' => 'The name of the organization.', 'type' => 'string', 'example' => 'Ledi Industrial Park', 'title' => ''], 'factoryList' => [ - 'description' => 'The sites.'."\n", + 'description' => 'The list of site information.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the site.'."\n", + 'description' => 'List of information', 'type' => 'object', 'properties' => [ - 'factoryId' => [ - 'description' => 'The site ID.'."\n", - 'type' => 'string', - 'example' => 'pn_95', - ], - 'factoryName' => [ - 'description' => 'The site name.'."\n", - 'type' => 'string', - 'example' => 'Ledi Industrial Park 1'."\n", - ], + 'factoryId' => ['description' => 'The ID of the site.', 'type' => 'string', 'example' => 'pn_95', 'title' => ''], + 'factoryName' => ['description' => 'The name of the site.', 'type' => 'string', 'example' => 'Ledi Industrial Park 1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'httpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'code' => [ - 'description' => 'The code returned for the request.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'httpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'invalidParameter', - 'errorMessage' => 'Invalid parameter values.', - ], + ['errorCode' => 'invalidParameter', 'errorMessage' => 'Invalid parameter values.', 'description' => 'Request parameters are incorrect. Please check method entry parameters.'], ], [ - [ - 'errorCode' => 'notAuthorized', - 'errorMessage' => 'No permissions to call API operations.', - ], + ['errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', 'description' => 'No permissions to call API operations.'], ], 500 => [ - [ - 'errorCode' => 'systemError', - 'errorMessage' => 'System error.', - ], + ['errorCode' => 'systemError', 'errorMessage' => 'System error.', 'description' => 'System error.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"aliyunPk\\": \\"1319XXXXXX64960\\",\\n \\"organizationId\\": \\"6265f42XXXX2fec150\\",\\n \\"organizationName\\": \\"乐迪工业园\\",\\n \\"factoryList\\": [\\n {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"factoryName\\": \\"乐迪工业园1\\"\\n }\\n ]\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"aliyunPk\\": \\"1319XXXXXX64960\\",\\n \\"organizationId\\": \\"6265f42XXXX2fec150\\",\\n \\"organizationName\\": \\"Ledi Industrial Park\\",\\n \\"factoryList\\": [\\n {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"factoryName\\": \\"Ledi Industrial Park 1\\"\\n }\\n ]\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]', 'title' => 'GetOrgAndFactory', - 'description' => '* If an activated site exists, the information about the site and the organization to which the site belongs is returned. If no activated site exists, null is returned.'."\n" - .'- By current, endpoint only supports Hangzhou: `energyexpertexternal.cn-hangzhou.aliyuncs.com`.'."\n" - .'- To use this API, you need to be added to the whitelist. Please contact us through <props="china">[official website](https://energy.aliyun.com/ifa/web/defaultLoginPage?adapter=aliyun#/consult?source=%E8%83%BD%E8%80%97%E5%AE%9D%E7%99%BB%E5%BD%95%E9%A1%B5%EF%BC%88WEB%EF%BC%89)</props> '."\n" - .'<props="intl">[official website](https://energy.alibabacloud.com/common?adapter=aliyun&lang=en-US#/home/en)</props> to apply for whitelist activation.', - 'requestParamsDescription' => 'You can call this operation to query the information about organizations and sites that are activated by using the current Alibaba Cloud account without the need to specify request parameters.'."\n", - 'responseParamsDescription' => '* The information about organizations is returned.'."\n" - .'* The IDs and names of sites are returned.'."\n", - ], - 'GetDocumentAnalyzeResult' => [ - 'summary' => 'null null', - 'path' => '/api/v1/aidoc/document/getDocumentAnalyzeResult', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'description' => '- The operation returns information about the organizations and sites if activated sites exist. Otherwise, the operation returns an empty value.'."\n" + ."\n" + .'- The only supported endpoint is `energyexpertexternal.cn-hangzhou.aliyuncs.com` for the China (Hangzhou) region.'."\n" + ."\n" + .'- To use this API operation, you must be added to the whitelist. To request access, <props="china">[contact us](https://energy.aliyun.com/ifa/web/defaultLoginPage?adapter=aliyun#/consult?source=%E8%83%BD%E8%80%97%E5%AE%9D%E7%99%BB%E5%BD%95%E9%A1%B5%EF%BC%88WEB%EF%BC%89)</props> or <props="intl">[contact us](https://energy.alibabacloud.com/common?adapter=aliyun\\&lang=en-US#/home/en)</props>.', + 'requestParamsDescription' => 'Has no request parameters. It directly queries information about activated sites associated with the account.', + 'changeSet' => [ + ['createdAt' => '2023-07-07T08:50:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-17T06:13:23.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgAndFactory'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'energy:GetOrgAndFactory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'GetOrgConstitute' => [ + 'summary' => 'Retrieves analytical data for a carbon inventory organization.', + 'path' => '/api/v1/carbon/emission/analysis/org', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request Parameters', + 'description' => 'The parameters in the request body.', 'type' => 'object', 'properties' => [ - 'jobId' => [ - 'description' => 'Job ID, specifying which document\'s parsing result to query. This is a return parameter from the \'Submit Document Parsing Job\' interface.', - 'type' => 'string', - 'required' => true, - 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', - ], + 'code' => ['description' => 'The organization code.', 'type' => 'string', 'required' => true, 'example' => 'Z-20240115-2', 'title' => ''], + 'year' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], + 'moduleCode' => ['description' => 'The module code.', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions'."\n", 'title' => ''], + 'moduleType' => ['description' => 'The module type.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6705,632 +5540,231 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => 'Returned Data', - 'type' => 'object', - 'properties' => [ - 'kvListInfo' => [ - 'description' => 'Document Parsing Result', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of Document Parsing Result', - 'type' => 'object', - 'properties' => [ - 'keyName' => [ - 'description' => 'Field Key Name', - 'type' => 'string', - 'example' => 'Tenant', - ], - 'keyValue' => [ - 'description' => 'Field Key Value', - 'type' => 'string', - 'example' => 'Aliyun XXX Co., Ltd.', - ], - 'context' => [ - 'description' => 'Recalled Content', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Key Recall Information', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of Key Recall Information', - '$ref' => '#/components/schemas/ContentItem', - ], - ], - 'value' => [ - 'description' => 'Value Recall Information', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of Value Recall Information', - '$ref' => '#/components/schemas/ContentItem', - ], - ], - 'confidence' => [ - 'description' => 'Confidence', - 'type' => 'object', - 'properties' => [ - 'keyConfidence' => [ - 'description' => 'Confidence of Key', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9994202852249146', - ], - 'valueConfidence' => [ - 'description' => 'Confidence of Value', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9794202852249146', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'The response data.', '$ref' => '#/components/schemas/OrgEmission', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"name\\": \\"EnterpriseZ\\",\\n \\"nameKey\\": \\"Z-20240115-4\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"weightingCarbonEmissionData\\": 2.3,\\n \\"weightingRatio\\": 0.4,\\n \\"ratio\\": 0.2,\\n \\"weightingProportion\\": 0.3,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"Scope 1: Direct GHG emissions\\",\\n \\"nameKey\\": \\"carbonInventory.check.scope_1_direct_ghg_emissions\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"ratio\\": 0.2\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"EnterpriseZ\\",\\n \\"nameKey\\": \\"Z-20240115-4\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"weightingCarbonEmissionData\\": 2.3,\\n \\"weightingRatio\\": 0.4,\\n \\"ratio\\": 0.2,\\n \\"weightingProportion\\": 0.3,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"Scope 1: Direct GHG emissions\\",\\n \\"nameKey\\": \\"carbonInventory.check.scope_1_direct_ghg_emissions\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"ratio\\": 0.2\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"EnterpriseZ\\",\\n \\"nameKey\\": \\"Z-20240115-4\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"weightingCarbonEmissionData\\": 2.3,\\n \\"weightingRatio\\": 0.4,\\n \\"ratio\\": 0.2,\\n \\"weightingProportion\\": 0.3,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"Scope 1: Direct GHG emissions\\",\\n \\"nameKey\\": \\"carbonInventory.check.scope_1_direct_ghg_emissions\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"ratio\\": 0.2\\n }\\n ],\\n \\"subEmissionItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetOrgConstitute', + 'description' => '1. The code parameter is the unique code for an organization.'."\n" + ."\n" + .'2. Retrieves data for the organization specified by the code.'."\n" + ."\n" + .'3. It also recursively retrieves data for all child organizations.'."\n" + ."\n" + .'4. The data for child organizations is returned in the subEmissionItems field.'."\n" + ."\n" + .'5. The recursion continues until an organization has no child organizations.', + 'changeSet' => [ + ['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgConstitute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetOrgConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"租户\\",\\n \\"keyValue\\": \\"阿里云xxx有限公司\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDocumentAnalyzeResult', - 'translator' => 'machine', ], - 'SubmitDocumentAnalyzeJob' => [ - 'summary' => 'The document parsing operation is used to extract the key content of a document and extract the key-value information from the document based on the preset key-value template. The document parsing operation is an asynchronous operation. You need to call the asynchronous submission service for document parsing and then call the GetDocumentAnalyzeResult operation to perform result polling. The asynchronous submission service supports two methods: local files and URL files. Call the SubmitDocumentAnalyzeJob operation to upload URL files. Call the SubmitDocumentAnalyzeJobAdvance operation to upload local files.', - 'path' => '/api/v1/aidoc/document/submitDocumentAnalyzeJob', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetPcrInfo' => [ + 'summary' => 'Retrieves the OSS URL of a product carbon footprint PCR report.', + 'path' => '/api/v1/carbon/footprint/result/pcr/detail', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'fileUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'Choose one between fileUrl and fileUrlObject:'."\n" - ."\n" - .'- fileUrl: Use the document URL method for a single document (supports documents with up to 1000 pages and within 100MB).'."\n" - ."\n" - .'- fileUrlObject: Use when calling the API via local file upload, for a single document (supports documents with up to 1000 pages and '."\n" - .'within 100MB).'."\n" - ."\n" - .'> Relationship between file parsing methods and supported document types. '."\n" - .'>- Long Text RAG: Supports pdf, doc/docx, and up to 1000 pages'."\n" - .'>- Image Processing: Supports pdf, jpg, jpeg, png, bmp'."\n" - .'>- Long Text Understanding: Supports pdf, doc/docx, xls/xlsx', - 'type' => 'string', - 'required' => false, - 'example' => 'https://example.com/example.pdf', - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'fileName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The filename must include the file type extension.', - 'type' => 'string', - 'required' => true, - 'example' => 'example.pdf', - ], - ], - [ - 'name' => 'templateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique extraction template ID is used to specify the key-value pairs to be extracted from the document. You need to log in to the template management page to configure the template and obtain the corresponding template ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'templateCode', - ], - ], - [ - 'name' => 'folderId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Unique knowledge base folder ID, used for categorizing documents and controlling the scope of online Q&A queries. If empty, the document will be uploaded to the tenant\'s root directory.', - 'type' => 'string', - 'required' => true, - 'example' => 'folderCode', - ], - ], - [ - 'name' => 'analysisType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The default extraction method is "doc", with the following optional values:'."\n" - ."\n" - .'- vl: Image processing'."\n" - .'- doc: Long text RAG (Retrieval-Augmented Generation)'."\n" - .'- docUnderstanding: Long text comprehension'."\n" - .'- recommender: Recommendation type', - 'type' => 'string', - 'required' => true, - 'example' => 'doc', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82', - ], - 'data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'jobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'adkc-kk2k41-kk2ol-222424', - ], - ], - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'string', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. Specify `1` for product carbon footprint or `5` for supply chain carbon footprint.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"jobId\\": \\"bfce2248-1546-4298-8bcf-70ac26e69646\\"\\n }\\n}","type":"json"}]', - 'title' => 'SubmitDocumentAnalyzeJob', - 'translator' => 'machine', - ], - 'SubmitDocParsingTask' => [ - 'summary' => 'Parses text, tables, images, and more from documents. After execution, a taskId is returned for retrieving document parsing results via GetDocParsingResult.'."\n" - .'Supports:'."\n" - .'URL Upload: SubmitDocParsingTask'."\n" - .'Local File Upload: SubmitDocParsingTaskAdvance', - 'path' => '/api/v2/aidoc/document/submitDocParsingTask', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '避免任务过多影响性能', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'fileUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'Choose one of fileUrl or fileUrlObject:'."\n" - ."\n" - .'- fileUrl: Use by providing the document URL, for a single document (supports up to 1000 pages and 100MB in size)'."\n" - ."\n" - .'- fileUrlObject: Use when calling the interface with local file upload, for a single document (supports up to 1000 pages and 100 MB in size)'."\n" - ."\n" - .'> The relationship between file parsing methods and supported document types'."\n" - .'> - Long Text RAG: Supports pdf, doc/docx, supports up to 1000 pages'."\n" - .'> - Image Processing: Supports pdf, jpg, jpeg, png, bmp'."\n" - .'> - Long Text Understanding: Supports pdf, doc/docx, xls/xlsx', - 'type' => 'string', 'required' => false, - 'example' => 'fileUrl：https://example.com/example.pdf'."\n" - .'fileUrlObject：FileInputStream generated from a local file', - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'fileName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The filename must include the file type extension.', - 'type' => 'string', - 'required' => true, - 'example' => 'example.pdf', - ], - ], - [ - 'name' => 'folderId', - 'in' => 'query', - 'schema' => [ - 'description' => '- Unique knowledge base folder ID, used when categorizing documents and controlling the scope of documents for online Q&A queries.'."\n" - .'- The folder ID needs to be obtained from the Intelligent Document Console after logging in.', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxxx', - ], - ], - [ - 'name' => 'needAnalyzeImg', - 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to parse image content within the document.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n", - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID. Use this ID for troubleshooting.', 'type' => 'string', 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'], 'data' => [ - 'description' => 'Return result.', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => 'TaskID', - 'type' => 'string', - 'example' => 'ae9d07be-1a11-4d30-be75-cc962b98279c', - ], + 'createTime' => ['description' => 'The creation timestamp of the report, in milliseconds.', 'type' => 'string', 'example' => '1709109790532', 'title' => ''], + 'name' => ['description' => 'The report name.', 'type' => 'string', 'example' => 'Carbon footprint report 2024-01-08.docx', 'title' => ''], + 'url' => ['description' => 'The report URL.', 'type' => 'string', 'example' => 'https://energy.aliyun.com', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"createTime\\": \\"1709109790532\\",\\n \\"name\\": \\"Carbon footprint report 2024-01-08.docx\\",\\n \\"url\\": \\"https://energy.aliyun.com\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetPcrInfo', + 'description' => 'This operation retrieves the details and download link of a generated PCR report for a specified product ID. Before calling this operation, ensure that a results page and PCR report are available for the product.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPcrInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetPcrInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"taskId\\": \\"ae9d07be-1a11-4d30-be75-cc962b98279c\\"\\n }\\n}","type":"json"}]', - 'title' => 'Asynchronously Submit Document Parsing Task', 'translator' => 'machine', ], - 'GetDocParsingResult' => [ - 'summary' => 'For Querying Document Parsing Results.'."\n" - .'The input parameter taskId is obtained from the taskId returned by the interfaces SubmitDocParsingTaskAdvance or SubmitDocParsingTask.'."\n" - .'The query results can be one of three statuses: processing, successful, or failed.', - 'path' => '/api/v2/aidoc/document/getDocParsingResult', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetReductionProposal' => [ + 'summary' => 'Retrieves carbon reduction suggestions.', + 'path' => '/api/v1/carbon/footprint/result/reduction/proposal', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '影响性能', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '- Task ID.'."\n" - .'- The taskId is obtained from the SubmitDocParsingTaskAdvance or SubmitDocParsingTask interfaces.', - 'type' => 'string', - 'required' => true, - 'example' => '2c22388d-e2ed-44fe-99e6-99922f15e7bb', - ], - 'returnFormat' => [ - 'description' => '- The document parsing result supports two formats: markdown and json.'."\n" - .'- By default, the result is returned in markdown format.', - 'type' => 'string', - 'required' => false, - 'example' => 'md', - 'default' => 'md', - 'enum' => [ - 'md', - 'json', - ], - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1', 'title' => ''], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024', 'title' => ''], + 'productType' => ['description' => 'The product type. A value of 1 indicates a product carbon footprint request. A value of 5 indicates a supply chain carbon footprint request.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'dataQualityEvaluationType' => ['description' => 'The data quality evaluation type. A value of 1 indicates Data Quality Indicator (DQI). A value of 2 indicates Data Quality Rating (DQR).', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'Returned result.', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '- The parsed content of the document.'."\n" - .'- The format (markdown or json) is determined by the returnFormat parameter. For specific format details, refer to: [json return structure](https://www.alibabacloud.com/help/en/energy-expert/developer-reference/interface-attached-information#b644b6255cojj)', - 'type' => 'string', - 'example' => '{\\"doc_info\\":{\\"languages\\":[\\"zh\\",\\"en\\"],\\"doc_type\\":\\"pdf\\",\\"pdf_toc\\":[{\\"title\\":\\"封面\\",\\"level\\":0,\\"page\\":0}],\\"pages\\":366,\\"page_list\\":[{\\"imageWidth\\":596,\\"imageHeight\\":842,\\"pageIdAllDocs\\":0,\\"fileIndex\\":0,\\"pageIdCurDoc\\":0,\\"angle\\":0}],\\"doc_data\\":[{\\"uniqueId\\":\\"about_us_para\\",\\"page_num\\":\\"01\\",\\"index\\":\\"xxx\\",\\"name\\":\\"xxx\\",\\"type\\":\\"xxxx\\",\\"subType\\":\\"xxx\\",\\"text\\":\\"xxx\\",\\"before_text\\":\\"xxx\\",\\"after_text\\":\\"xxx\\",\\"extInfo\\":[{\\"uniqueId\\":\\"b0x1x0\\",\\"pos\\":[{\\"x\\":229,\\"y\\":208},{\\"x\\":421,\\"y\\":208},{\\"x\\":421,\\"y\\":242},{\\"x\\":229,\\"y\\":242}],\\"text\\":\\"Kurt Götze\\",\\"type\\":\\"Text\\",\\"subType\\":\\"Text\\",\\"pageNum\\":[0],\\"index\\":0}]}]}}', - ], + 'reduction' => ['description' => 'The proactive carbon reduction suggestions.', 'type' => 'string', 'example' => 'Reduce one-drop usage', 'title' => ''], + 'reductionEvaluation' => ['description' => 'The proactive carbon reduction evaluation.', 'type' => 'string', 'example' => 'Trying Energy Expert for a more detailed assessment.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"content\\": \\"{\\\\\\\\\\\\\\"doc_info\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"languages\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"zh\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"doc_type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pdf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pdf_toc\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"封面\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"page\\\\\\\\\\\\\\":0}],\\\\\\\\\\\\\\"pages\\\\\\\\\\\\\\":366,\\\\\\\\\\\\\\"page_list\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"imageWidth\\\\\\\\\\\\\\":596,\\\\\\\\\\\\\\"imageHeight\\\\\\\\\\\\\\":842,\\\\\\\\\\\\\\"pageIdAllDocs\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"fileIndex\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"pageIdCurDoc\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"angle\\\\\\\\\\\\\\":0}],\\\\\\\\\\\\\\"doc_data\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"about_us_para\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"page_num\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"before_text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"after_text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"extInfo\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"b0x1x0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pos\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":229,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":208},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":421,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":208},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":421,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":242},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":229,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":242}],\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Kurt Götze\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pageNum\\\\\\\\\\\\\\":[0],\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":0}]}]}}\\"\\n }\\n}","type":"json"}]', - 'title' => 'Get Document Parsing Result', - 'translator' => 'machine', - ], - 'SubmitDocExtractionTask' => [ - 'summary' => 'Extracts key information from documents using user-defined Key-Value or prompt templates. A taskId is returned upon successful execution for retrieving extraction results via GetDocExtractionResult.'."\n" - .'Supports:'."\n" - .'URL Upload: SubmitDocExtractionTask'."\n" - .'Local File Upload: SubmitDocExtractionTask', - 'path' => '/api/v2/aidoc/document/submitDocExtractionTask', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '避免任务过多影响性能', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'fileUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'Choose one of fileUrl or fileUrlObject:'."\n" - ."\n" - .'- fileUrl: Use by providing the document URL, for a single document (supports up to 1000 pages, 100MB in size)'."\n" - ."\n" - .'- fileUrlObject: Use when calling the interface with local file upload, for a single document (supports up to 1000 pages, 100 MB in size)'."\n" - ."\n" - .'> The relationship between file extraction methods and supported document types'."\n" - .'> - Long text RAG: Supports pdf, doc/docx, xlsx, csv, txt, up to 1000 pages'."\n" - .'> - Image processing: Supports pdf, jpg, jpeg, png, bmp, jpe, tif, tiff, webp, heic'."\n" - .'> - Long text understanding: Supports doc/docx, xlsx, pdf, csv, txt', - 'type' => 'string', - 'required' => false, - 'example' => 'fileUrl：https://example.com/example.pdf'."\n" - .'fileUrlObject：FileInputStream generated from a local file', - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'fileName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The filename must include the file type extension.', - 'type' => 'string', - 'required' => true, - 'example' => 'example.pdf', - ], - ], - [ - 'name' => 'templateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'A unique extraction template ID used to specify the content to be extracted from the document. You need to log in to the template management page to configure the template and obtain the corresponding template ID.', - 'type' => 'string', - 'required' => true, - 'example' => '572d24k0c95a', - ], - ], - [ - 'name' => 'folderId', - 'in' => 'query', - 'schema' => [ - 'description' => '- A unique knowledge base folder ID, used when you need to categorize documents and control the scope of documents for online Q&A queries.'."\n" - .'- The folder ID needs to be obtained by logging into the intelligent document console.', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxx', - ], - ], - [ - 'name' => 'extractType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Document extraction type:'."\n" - .'Supports rag and long text understanding types, default is rag.', - 'type' => 'string', - 'required' => false, - 'example' => 'rag', - 'default' => 'rag', - 'enum' => [ - 'rag', - 'longTextUnderstanding', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => 'Returned data', - 'type' => 'object', - 'properties' => [ - 'taskId' => [ - 'description' => 'Task ID.', - 'type' => 'string', - 'example' => '864773ec-d35b-4c36-8871-52d07fbe806d', - ], - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"reduction\\": \\"Reduce one-drop usage\\",\\n \\"reductionEvaluation\\": \\"Trying Energy Expert for a more detailed assessment.\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetReductionProposal', + 'description' => 'Returns carbon reduction suggestions for a specified product ID. The suggestions are retrieved from the generated results page. You can use this operation to obtain optimization suggestions for product carbon emissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReductionProposal'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetReductionProposal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"taskId\\": \\"864773ec-d35b-4c36-8871-52d07fbe806d\\"\\n }\\n}","type":"json"}]', - 'title' => 'Asynchronously Submit RAG and Long Text Understanding Information Extraction Tasks', 'translator' => 'machine', ], - 'GetDocExtractionResult' => [ - 'summary' => 'For Querying Information Extraction Result.'."\n" - .'The input parameter taskId is obtained from the taskId returned by the interfaces SubmitDocExtractionTaskAdvance or SubmitDocExtractionTask.'."\n" - .'The query results can reflect one of three statuses: processing, successfully completed, or failed.', - 'path' => '/api/v2/aidoc/document/getDocExtractionResult', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetVLExtractionResult' => [ + 'summary' => 'For Querying Qwen-VL Model Information Extraction Results. The input parameter taskId is obtained from the taskId returned by the interfaces SubmitVLExtractionTask or SubmitVLExtractionTaskAdvance. The query results can be in one of three statuses: processing, successfully completed, or failed.', + 'path' => '/api/v2/aidoc/document/getVLExtractionResult', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], 'autoTest' => false, 'notSupportAutoTestReason' => '影响性能', 'tenantRelevance' => 'publicInformation', @@ -7341,18 +5775,16 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request body parameters.', + 'description' => 'Request parameters', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '- Task ID.'."\n" - .'- taskId is obtained from the SubmitDocExtractionTaskAdvance and SubmitDocExtractionTask interfaces.', - 'type' => 'string', - 'required' => true, - 'example' => '97693b4c-17a8-4198-aa28-798d3c855577mhrv', - ], + 'taskId' => ['description' => '- taskID.'."\n" + ."\n" + .'- The taskId is obtained from the interfaces SubmitVLExtractionTaskAdvance and SubmitVLExtractionTask.', 'type' => 'string', 'required' => true, 'example' => '864773ec-d35b-4c36-8871-52d07fbe806d'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -7363,274 +5795,242 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'Returned data structure.', + 'description' => 'Returned Data', 'type' => 'object', 'properties' => [ 'kvListInfo' => [ - 'description' => 'Details of document extraction results', + 'description' => 'Document Parsing Result', 'type' => 'array', 'items' => [ - 'description' => 'Details of document extraction results', + 'description' => 'Details of Document Parsing Result', 'type' => 'object', 'properties' => [ - 'keyName' => [ - 'description' => 'Field key name', - 'type' => 'string', - 'example' => 'Tenant', - ], - 'keyValue' => [ - 'description' => 'Field key value', - 'type' => 'string', - 'example' => 'Alibaba Cloud XXX Co., Ltd.', - ], + 'keyName' => ['description' => 'Field Key name', 'type' => 'string', 'example' => 'Tenant', 'title' => ''], + 'keyValue' => ['description' => 'Field key value', 'type' => 'string', 'example' => 'Alibaba Cloud XXX Co., Ltd.', 'title' => ''], 'context' => [ - 'description' => 'Recalled content', + 'description' => 'Recall content', 'type' => 'object', 'properties' => [ 'key' => [ - 'description' => 'Details of key recall information', + 'description' => 'Key recall information details', 'type' => 'array', - 'items' => [ - 'description' => 'Details of key recall information', - 'example' => 'bhv_trace_info_invalid', - '$ref' => '#/components/schemas/ContentItem', - ], + 'items' => ['description' => 'Details of Key Recall Information', '$ref' => '#/components/schemas/ContentItem', 'example' => 'bhv_trace_info_invalid', 'title' => ''], + 'title' => '', + 'example' => '', ], 'value' => [ - 'description' => 'Details of value recall information', + 'description' => 'Value Recall Information', 'type' => 'array', - 'items' => [ - 'description' => 'Details of value recall information', - 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', - '$ref' => '#/components/schemas/ContentItem', - ], + 'items' => ['description' => 'Details of Value Recall Information', '$ref' => '#/components/schemas/ContentItem', 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'confidence' => [ - 'description' => 'Confidence level', + 'description' => 'Confidence', 'type' => 'object', 'properties' => [ - 'keyConfidence' => [ - 'description' => 'Key confidence level', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9994202852249146', - ], - 'valueConfidence' => [ - 'description' => 'value confidence level', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9794202852249146', - ], + 'keyConfidence' => ['description' => 'Confidence of Key', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146', 'title' => ''], + 'valueConfidence' => ['description' => 'Confidence of Value', 'type' => 'number', 'format' => 'double', 'example' => '0.9794202852249146', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"租户\\",\\n \\"keyValue\\": \\"阿里云xxx有限公司\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'Retrieve RAG and Long Text Understanding Document Extraction Results', - 'translator' => 'machine', - ], - 'SubmitVLExtractionTask' => [ - 'summary' => 'Extracts key information from documents using KV templates or prompts with the Qwen-VL model, ideal for image extraction. '."\n" - .'Supports:'."\n" - .'URL Upload: SubmitVLExtractionTask.'."\n" - .'Local File Upload: SubmitVLExtractionTaskAdvance', - 'path' => '/api/v2/aidoc/document/submitVLExtractionTask', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"Tenant\\",\\n \\"keyValue\\": \\"Alibaba Cloud XXX Co., Ltd.\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Get VL Extraction Result', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVLExtractionResult'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetVLExtractionResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'IsCompleted' => [ + 'summary' => 'Checks the completion status of a report generation task.', + 'path' => '/api/v1/carbon/footprint/result/completed', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '避免任务过多影响性能', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'fileUrl', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Choose one of fileUrl or fileUrlObject:'."\n" - ."\n" - .'- fileUrl: Use by providing the document URL, for a single document (supports up to 1000 pages and 100MB in size)'."\n" - ."\n" - .'- fileUrlObject: Use when calling the interface with local file upload, for a single document (supports up to 1000 pages and 100 MB in size)'."\n" - ."\n" - .'> The relationship between file parsing methods and supported document types'."\n" - .'> - Long Text RAG: Supports pdf, doc/docx, up to 1000 pages'."\n" - .'> - Image Processing: Supports pdf, jpg, jpeg, png, bmp'."\n" - .'> - Long Text Understanding: Supports pdf, doc/docx, xls/xlsx', - 'type' => 'string', + 'description' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'C-20080808-1'], + 'productId' => ['description' => 'The product ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1024'], + 'productType' => ['description' => 'The product type. Set the value to \\`1\\` to request the carbon footprint of a product. Set the value to \\`5\\` to request the carbon footprint of a supply chain.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], + ], 'required' => false, - 'example' => 'fileUrl：https://example.com/example.pdf'."\n" - .'fileUrlObject：本地文件生成的FileInputStream', - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'fileName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The filename must include the file type suffix.', - 'type' => 'string', - 'required' => true, - 'example' => 'example.pdf', - ], - ], - [ - 'name' => 'folderId', - 'in' => 'query', - 'schema' => [ - 'description' => '- Unique knowledge base folder ID, used when you need to categorize documents and control the scope of online Q&A queries.'."\n" - .'- The folder ID needs to be obtained from the intelligent document console after logging in.', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxxx', - ], - ], - [ - 'name' => 'templateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Unique parsing template ID, used to specify the key-value pairs to be extracted from the document. You need to configure the template on the template management page and then obtain the corresponding template ID.', - 'type' => 'string', - 'required' => true, - 'example' => '572d24k0c95a', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. Each request has a unique ID that you can use to troubleshoot issues.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'Returned data structure.', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => 'Task ID.', - 'type' => 'string', - 'example' => '411ce93a-7eb5-40cf-836a-53c32f097663', - ], + 'modifiedTime' => ['description' => 'The time when the status was last updated. This is a UNIX timestamp in milliseconds. Example: 1711438780000.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1711438780000'], + 'taskKey' => ['description' => 'The unique key of the generation task.', 'type' => 'string', 'title' => '', 'example' => '550c2b7b-f2e0-4176-ab0a-53ea4b355721'], + 'taskShortResult' => ['description' => 'This parameter is not in use. The value is empty.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'taskStatus' => ['description' => 'The status of the report generation task. Valid values: \\`running\\` (the report is being generated), \\`success\\` (the report is generated), and \\`error\\` (the report failed to be generated). If the task fails, check and correct the model, and then generate the report again.', 'type' => 'string', 'title' => '', 'example' => 'running'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'IsCompleted', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IsCompleted'], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:IsCompleted', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"taskId\\": \\"411ce93a-7eb5-40cf-836a-53c32f097663\\"\\n }\\n}","type":"json"}]', - 'title' => 'Asynchronously Submit VL Information Extraction Task', - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"modifiedTime\\": 1711438780000,\\n \\"taskKey\\": \\"550c2b7b-f2e0-4176-ab0a-53ea4b355721\\",\\n \\"taskShortResult\\": \\"null\\",\\n \\"taskStatus\\": \\"running\\"\\n }\\n}","type":"json"}]', ], - 'GetVLExtractionResult' => [ - 'summary' => 'For Querying Qwen-VL Model Information Extraction Results.'."\n" - .'The input parameter taskId is obtained from the taskId returned by the interfaces SubmitVLExtractionTask or SubmitVLExtractionTaskAdvance.'."\n" - .'The query results can be in one of three statuses: processing, successfully completed, or failed.', - 'path' => '/api/v2/aidoc/document/getVLExtractionResult', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'PushDeviceData' => [ + 'summary' => 'Pushes data from device data points, such as voltage data from an electric meter.', + 'path' => '/api/v1/data/increment/push', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '影响性能', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '- taskID.'."\n" - ."\n" - .'- The taskId is obtained from the interfaces SubmitVLExtractionTaskAdvance and SubmitVLExtractionTask.', - 'type' => 'string', + 'deviceType' => ['description' => 'The type of the device. For more information, see [Device Type Definitions](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E6%B5%8B%E7%82%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'devices' => [ + 'description' => 'A list of devices to push data for.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'deviceId' => ['description' => 'If deviceType is 12, 13, or 17, pass the system\\_id (the field name remains deviceId). If deviceType is 15 or 16, do not pass this parameter. This parameter is required in all other cases.', 'type' => 'string', 'example' => 'DeviceId-example-id-****', 'required' => true, 'title' => ''], + 'recordTime' => ['description' => 'The time when the data was recorded.', 'type' => 'string', 'required' => true, 'example' => '2021-09-08 18:40:00', 'title' => ''], + 'data' => ['description' => 'The data point information. To avoid precision issues, pass all data point values as strings. The feature does not work if required fields are missing. Some features might be affected if recommended fields are missing. For details, see the device data point remarks in the appendix. For more information, see [Data Point Definitions](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E6%B5%8B%E7%82%B9%E9%99%84%E5%BD%95.pdf).', 'type' => 'object', 'required' => true, 'example' => '{'."\n" + .' "dp_imp": "329.0",'."\n" + .' "F": "148.0",'."\n" + .' "eq_imp": "363.0",'."\n" + .' "Ep_imp_1": "128.0",'."\n" + .' "Ep_imp_2": "157.0",'."\n" + .' "Ua": "226.0",'."\n" + .' "Ub": "285.0",'."\n" + .' "Ep_imp": "325.0",'."\n" + .' "Uc": "342.0",'."\n" + .' "Ep_imp_3": "109.0",'."\n" + .' "Ep_imp_4": "94.0",'."\n" + .' "P": "514.0",'."\n" + .' "Pa": "443.0",'."\n" + .' "Q": "265.0",'."\n" + .' "dp_exp": "261.0",'."\n" + .' "eq_exp": "399.0",'."\n" + .' "COSQ": "223.0",'."\n" + .' "Ia": "240.0",'."\n" + .' "Ib": "216.0",'."\n" + .' "Ic": "229.0",'."\n" + .' "Ep_exp": "115.0",'."\n" + .' "VdisPer": "120.0"'."\n" + .' }', 'title' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '1436b6f5-ddea-4308-9d1c-60939e5d5ea8', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -7638,401 +6038,153 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => 'Returned Data', - 'type' => 'object', - 'properties' => [ - 'kvListInfo' => [ - 'description' => 'Document Parsing Result', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of Document Parsing Result', - 'type' => 'object', - 'properties' => [ - 'keyName' => [ - 'description' => 'Field Key name', - 'type' => 'string', - 'example' => 'Tenant', - ], - 'keyValue' => [ - 'description' => 'Field key value', - 'type' => 'string', - 'example' => 'Alibaba Cloud XXX Co., Ltd.', - ], - 'context' => [ - 'description' => 'Recall content', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Key recall information details', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of Key Recall Information', - 'example' => 'bhv_trace_info_invalid', - '$ref' => '#/components/schemas/ContentItem', - ], - ], - 'value' => [ - 'description' => 'Value Recall Information', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of Value Recall Information', - 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', - '$ref' => '#/components/schemas/ContentItem', - ], - ], - 'confidence' => [ - 'description' => 'Confidence', - 'type' => 'object', - 'properties' => [ - 'keyConfidence' => [ - 'description' => 'Confidence of Key', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9994202852249146', - ], - 'valueConfidence' => [ - 'description' => 'Confidence of Value', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9794202852249146', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'Indicates whether the data was pushed successfully. A value of success indicates a successful push.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"租户\\",\\n \\"keyValue\\": \\"阿里云xxx有限公司\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'Get VL Extraction Result', - ], - 'AnalyzeVlRealtime' => [ - 'summary' => 'Obtains the real-time parsing result of the Qwen VL model.', - 'path' => '/api/v1/aidoc/document/analyzeVlRealtime', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'PushDeviceData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushDeviceData'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:PushDeviceData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'PushItemData' => [ + 'summary' => 'This interface is used to push data items.', + 'path' => '/api/v1/carbon/emission/data/item/push', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'fileUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'Valid values: fileUrl and fileUrlObject.'."\n" - ."\n" - .'* fileUrl: used as a document URL. A single document with not more than 1,000 pages and whose size does not exceed 100 MB is supported.'."\n" - .'* fileUrlObject: used when the operation is called in local file upload mode. A single document with not more than 1,000 pages and whose size does not exceed 100 MB is supported.'."\n" - ."\n" - .'> The relationship between file extraction methods and supported document types'."\n" - .'> - Long text RAG: Supports pdf, doc/docx, xlsx, csv, txt, up to 1000 pages'."\n" - .'> - Image processing: Supports pdf, jpg, jpeg, png, bmp, jpe, tif, tiff, webp, heic'."\n" - .'> - Long text understanding: Supports doc/docx, xlsx, pdf, csv, txt', - 'type' => 'string', - 'required' => false, - 'example' => 'fileUrl: https://example.com/example.pdf fileUrlObject: FileInputStream generated for a local file'."\n", - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'fileName', - 'in' => 'query', - 'schema' => [ - 'description' => '文件名需带文件类型后缀', - 'type' => 'string', - 'required' => false, - 'example' => 'test.png', - ], - ], - [ - 'name' => 'templateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of an extraction template, which is used to specify the content to be extracted from a document. You must log on to the Template Management page to configure the template and then obtain the corresponding template ID.', - 'type' => 'string', - 'required' => false, - 'example' => '572d24k0c95a', - ], - ], - [ - 'name' => 'language', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language, which can be transferred. Valid values:'."\n" - ."\n" - .'* zh-CN (default)'."\n" - .'* en-US'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'The request body parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => 'The returned result.'."\n", + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'example' => 'C-20210223-01', 'title' => ''], + 'year' => ['description' => 'The year of the data created.', 'type' => 'string', 'required' => true, 'example' => '2024', 'title' => ''], + 'items' => [ + 'description' => 'List of data to be pushed.', 'type' => 'object', 'properties' => [ - 'kvListInfo' => [ - 'description' => 'The details of the document extraction result.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the document extraction result.', - 'type' => 'object', - 'properties' => [ - 'keyName' => [ - 'description' => 'The name of the key.'."\n", - 'type' => 'string', - 'example' => 'username', - ], - 'keyValue' => [ - 'description' => 'The value of the key.'."\n", - 'type' => 'string', - 'example' => 'bob', - ], - 'context' => [ - 'description' => 'The recalled content.'."\n", - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'The details of the recalled key information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the recalled key information.'."\n", - 'example' => 'bhv_trace_info_invalid', - '$ref' => '#/components/schemas/ContentItem', - ], - ], - 'value' => [ - 'description' => 'The details of the recalled value information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the recalled value information.'."\n", - 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', - '$ref' => '#/components/schemas/ContentItem', - ], - ], - 'confidence' => [ - 'description' => 'The confidence level.'."\n", - 'type' => 'object', - 'properties' => [ - 'keyConfidence' => [ - 'description' => 'The confidence level of the key.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9994202852249146', - ], - 'valueConfidence' => [ - 'description' => 'The confidence level of the value.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9794202852249146', - ], - ], - ], - ], - ], - ], - ], - ], + 'code' => ['description' => 'API data identification.<props="intl">For details: [GetDataItemList ](https://www.alibabacloud.com/help/en/energy-expert/developer-reference/api-energyexpertexternal-2022-09-23-getdataitemlist)</props>', 'type' => 'string', 'required' => true, 'example' => 'demo_api_code', 'title' => ''], + 'month' => ['description' => 'The month.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'value' => ['description' => 'The value of the data item.', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '1.11', 'title' => ''], ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"kvListInfo\\": [\\n {\\n \\"keyName\\": \\"租户\\",\\n \\"keyValue\\": \\"阿里云xxx有限公司\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'AnalyzeVlRealtime', - 'description' => 'You need to upload a document URL to obtain the real-time parsing result of the Qwen VL model.'."\n", - 'translator' => 'machine', - ], - 'GetChatFolderList' => [ - 'summary' => 'Get Q\\&A folder List', - 'path' => '/api/v2/aidoc/document/chat/folder/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '影响性能', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => 'A8AEC6D9-A359-5169-BD1A-BD848BA60D65', - ], - 'data' => [ - 'description' => 'Returned data', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the folder.', - 'example' => 'true', - '$ref' => '#/components/schemas/ChatFolderItem', - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'Whether the data is pushed successfully.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": [\\n {\\n \\"subFolders\\": [\\n {\\n \\"question\\": \\"\\",\\n \\"answer\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'Get Q\\&A folder List', - 'translator' => 'machine', - ], - 'CreateChatSession' => [ - 'summary' => 'Create Q\\&A Window', - 'path' => '/api/v2/aidoc/document/chat/session/create', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'PushItemData', + 'description' => '- This interface is used for individual data item data.'."\n" + .'- Data items can link data to services such as carbon footprints and carbon inventories.'."\n" + .'- Depending on the platform configuration, active data on a yearly and monthly basis is supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushItemData'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:PushItemData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'RecalculateCarbonEmission' => [ + 'summary' => 'Recalculates carbon emissions.', + 'path' => '/api/v1/carbon/emission/data/item/recalculate', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '影响性能', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request Parameters', + 'description' => 'Request parameters', 'type' => 'object', 'properties' => [ - 'userId' => [ - 'description' => 'The unique identifier of the user. If not provided, the SDK calling account will be used as the user ID by default.', - 'type' => 'string', - 'required' => false, - 'example' => '1233333', - ], - 'folderId' => [ - 'description' => 'Folder ID, to search for Q&A content within the current folder and its subfolders.', - 'type' => 'string', - 'required' => true, - 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd', - ], - 'name' => [ - 'description' => 'Name of the current session.', - 'type' => 'string', - 'required' => true, - 'example' => 'analyzer_1744684195', - ], + 'code' => ['description' => 'The enterprise code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'C-20240202-01'], + 'year' => ['description' => 'The inventory year.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8040,66 +6192,58 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response Schema', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f', - ], - 'data' => [ - 'description' => 'Returned data structure.', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'description' => 'Q&A session ID, used to record multiple Q&A sessions of the same user.', - 'type' => 'string', - 'example' => '596ac39c-8855-4128-bad7-78aebeff48fc', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], + 'data' => ['description' => 'The returned data. \\`true\\` indicates that the request was successful. \\`false\\` indicates that the request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RecalculateCarbonEmission', + 'description' => '- After you upload the data items, you can call this API to recalculate the carbon inventory data.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecalculateCarbonEmission'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:RecalculateCarbonEmission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": {\\n \\"sessionId\\": \\"596ac39c-8855-4128-bad7-78aebeff48fc\\"\\n }\\n}","type":"json"}]', - 'title' => 'Create Q\\&A Session', - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', ], 'Retrieve' => [ - 'summary' => '支持多文件夹ID或文件ID检索的RAG结果获取接口，供客户端自行加工结果并嵌入业务逻辑。', 'path' => '/api/v2/aidoc/knowledgebase/retrieve', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -8109,192 +6253,122 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'query' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '"What\'s the meaning of the file?"', - ], - 'useReranker' => [ - 'title' => '是否需要使用reranker', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'rerankerThreshold' => [ - 'title' => '重排序分数阈值，低于该阈值的结果会被过滤', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.0', - ], - 'topK' => [ - 'title' => '返回召回结果的Top-K条目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'preRetrieveTopK' => [ - 'title' => '返回预召回的召回数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'query' => ['description' => 'The query statement.', 'type' => 'string', 'required' => true, 'example' => '"What\'s the meaning of the file?"', 'title' => ''], + 'useReranker' => ['description' => 'Specifies whether to use the reranker. Default: true.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], + 'rerankerThreshold' => ['description' => 'The reranking score threshold. Results with scores below this threshold are filtered out. Default: 0.0.', 'type' => 'number', 'format' => 'float', 'title' => '', 'required' => false, 'example' => '0.0'], + 'topK' => ['description' => 'The number of top-ranked retrieval results to return. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + 'preRetrieveTopK' => ['description' => 'The number of pre-retrieval results to return. Default: 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], 'documentIds' => [ - 'title' => 'docIds与folderIds必须要传入一个', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3456', - ], + 'items' => ['description' => 'The file ID. You can get the ID from the Software as a Service (SaaS) page or through an SDK operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3456', 'title' => ''], + 'title' => '', + 'description' => 'Specify either documentIds or folderIds, but not both.', 'required' => false, + 'example' => '', ], 'folderIds' => [ - 'title' => 'folderIds与docIds必须要传入一个', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'adafb91d4e014e2eb4d0a5375b547115', - ], + 'items' => ['description' => 'The folder ID. You can get the ID from the SaaS page or through an SDK operation.', 'type' => 'string', 'required' => false, 'example' => 'adafb91d4e014e2eb4d0a5375b547115', 'title' => ''], + 'title' => '', + 'description' => 'Specify either folderIds or documentIds, but not both.', 'required' => false, + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'jobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '76cd1691-daf6-4113-8444-4998a25a5323', - ], + 'jobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '76cd1691-daf6-4113-8444-4998a25a5323', 'title' => ''], 'results' => [ - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/ChunkItem', - ], + 'items' => ['description' => 'A retrieval result.', '$ref' => '#/components/schemas/ChunkItem', 'title' => '', 'example' => ''], + 'description' => 'A list of retrieval results.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"jobId\\": \\"76cd1691-daf6-4113-8444-4998a25a5323\\",\\n \\"results\\": [\\n {\\n \\"score\\": 0,\\n \\"docName\\": \\"\\",\\n \\"rerankScore\\": 0,\\n \\"docId\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"weightedScore\\": 0,\\n \\"chunkId\\": \\"\\",\\n \\"chunkContent\\": \\"\\",\\n \\"docElsIds\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'GetChatSessionList' => [ - 'summary' => 'Get Q\\&A Session List', - 'path' => '/api/v2/aidoc/document/chat/session/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'Retrieve', + 'summary' => 'This API retrieves results for retrieval-augmented generation (RAG) from one or more folder or file IDs. You can then process these results and embed them in your business logic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:Retrieve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"jobId\\": \\"76cd1691-daf6-4113-8444-4998a25a5323\\",\\n \\"results\\": [\\n {\\n \\"score\\": 0.4295678,\\n \\"docName\\": \\"临时场地协议-APM.pdf\\",\\n \\"rerankScore\\": 0.5053711,\\n \\"docId\\": \\"b4620821aea92c062d8d19ad793243669cf9ae2b900e6967dee6ee9f3bf5feed\\",\\n \\"docUrl\\": \\"jobs/a4123b3f-9287-4c61-b59d-32e40fcb0a31/document/8b24a2e06669427fb3dc9812374d9d1a.pdf\\",\\n \\"weightedScore\\": 0.47252458,\\n \\"chunkId\\": \\"b0x7,b1x10\\",\\n \\"chunkContent\\": \\"\\\\\\\\\\\\\\\\n## 第三条 场地占用费(含物业管理费和市场推广费)\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\n3.2 乙方应于本协议签订后 20 个工作日内或该场地交付乙方的同时(以日期在先者为准),\\\\\\\\\\\\\\\\n向甲方一次性支付该场地四个月的场地占用费。\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\n3.3 乙方应向甲方支付的协议价款(场地占用费、物业管理费、市场推广费及本协议约定的其 他费用)以及实际发生的各种性质的价外费用(根据适用税法的相关规定,价外费用包括 但不限于违约金、赔偿金、代收款项、代垫款项)均为含增值税价格。\\",\\n \\"docElsIds\\": [\\n \\"b0x7\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'SendDocumentAskQuestion' => [ + 'summary' => 'null null', + 'path' => '/api/v1/aidoc/document/sendDocumentAskQuestion', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '影响性能', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'Request parameters', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'Session name.', - 'type' => 'string', - 'required' => false, - 'example' => 'oklabs', - ], - 'userId' => [ - 'description' => 'The unique identifier of the user. If not provided, the SDK calling account will be used as the user ID by default.', - 'type' => 'string', - 'required' => false, - 'example' => '12222', - ], - 'currentPage' => [ - 'description' => 'Pagination parameter, page number, default is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - 'pageSize' => [ - 'description' => 'Page size, default is 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], + 'prompt' => ['description' => 'The question queried by the user', 'type' => 'string', 'example' => 'Total carbon emissions in 2023', 'required' => true, 'title' => ''], + 'folderId' => ['description' => 'Folder ID, used to specify the range of documents for the query. If it is empty, it indicates that all documents under the default folder will be queried.', 'type' => 'string', 'required' => false, 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd', 'title' => ''], + 'sessionId' => ['description' => 'Q\\&A session ID, used to record multiple Q\\&A interactions of the same user. If it is empty, it indicates that sessions are not distinguished.', 'type' => 'string', 'required' => false, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8302,129 +6376,73 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Return result.', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n", - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"], 'data' => [ 'description' => 'Returned data', 'type' => 'object', 'properties' => [ - 'sessionList' => [ - 'description' => 'Session list.', + 'answer' => ['description' => 'Q\\&A result', 'type' => 'string', 'example' => 'Carbon emissions in 2023 totaled 4.681 million tons', 'title' => ''], + 'document' => [ + 'description' => 'Documents associated with the answer returned by the query', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'description' => 'Q&A session ID, used to record multiple Q&As of the same user.', - 'type' => 'string', - 'example' => '5c748ef9-3f23-4b5a-916f-966c0d2c6dcd', - ], - 'name' => [ - 'description' => 'Session name', - 'type' => 'string', - 'example' => 'student_app_spelling', - ], - 'userId' => [ - 'description' => 'User ID of the current session.', - 'type' => 'string', - 'example' => '12222', - ], - 'folderId' => [ - 'description' => 'Folder ID, used to specify the scope of documents to be queried.', - 'type' => 'string', - 'example' => '3493370b-4884-47dd-95ed-49038769af53', - ], - 'createTime' => [ - 'description' => 'Report creation timestamp, in milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-01-01T14:45:17Z', - ], - 'updateTime' => [ - 'description' => 'Modification time, in milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2024-12-30T02:05:03Z', - ], - ], - ], - ], - 'total' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - 'totalPage' => [ - 'description' => 'Total number of pages', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'currentPage' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'items' => ['description' => 'Document Details', 'type' => 'string', 'example' => 'https://oss/aa.pdf', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"sessionList\\": [\\n {\\n \\"sessionId\\": \\"5c748ef9-3f23-4b5a-916f-966c0d2c6dcd\\",\\n \\"name\\": \\"student_app_spelling\\",\\n \\"userId\\": \\"12222\\",\\n \\"folderId\\": \\"3493370b-4884-47dd-95ed-49038769af53\\",\\n \\"createTime\\": 0,\\n \\"updateTime\\": 0\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'Get Document Session List', - 'translator' => 'machine', - ], - 'GetChatList' => [ - 'summary' => 'Retrieve the historical documents of a session', - 'path' => '/api/v2/aidoc/document/chat/list', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"answer\\": \\"Carbon emissions in 2023 totaled 4.681 million tons\\",\\n \\"document\\": [\\n \\"https://oss/aa.pdf\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'SendDocumentAskQuestion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDocumentAskQuestion'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SendDocumentAskQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SetRunningPlan' => [ + 'path' => '/api/v1/carbon/hvac/setRunningPlan', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '影响性能', - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREenergyexpertXYPXBQ'], ], 'parameters' => [ [ @@ -8432,33 +6450,53 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request parameters.', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'sessionId' => [ - 'description' => 'Q&A session ID, used to record multiple Q&As for the same user.', - 'type' => 'string', - 'required' => true, - 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', + 'factoryId' => ['description' => 'The factory ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '***'], + 'systemId' => ['description' => 'The system ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'system1'], + 'pKey' => ['description' => 'The source of the call.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ib'], + 'seasonMode' => [ + 'description' => 'The season mode. For example, summer or winter.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => ['冬季' => '1', '夏季' => '0'], + 'title' => '', + 'example' => '0', ], - 'currentPage' => [ - 'description' => 'Pagination parameter, page number, starting from 1.', + 'dateType' => [ + 'description' => 'The date type. For example, weekday or holiday.', 'type' => 'integer', 'format' => 'int32', 'required' => false, - 'example' => '1', - 'default' => '1', + 'enumValueTitles' => ['工作日' => '0', '节假日' => '1'], + 'title' => '', + 'example' => '0', ], - 'pageSize' => [ - 'description' => 'Page size.', + 'startTime' => ['description' => 'The start time of the plan.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2024-07-20'], + 'endTime' => ['description' => 'The end time of the plan.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2024-07-21'], + 'statisticsTime' => ['description' => 'The date for which to set the single-day execution plan.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2024-07-31'], + 'workingStartTime' => ['description' => 'The start time of the target period.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:00:00'], + 'workingEndTime' => ['description' => 'The end time of the target period.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:30:00'], + 'earliestStartupTime' => ['description' => 'The earliest startup time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:00:00'], + 'latestShutdownTime' => ['description' => 'The latest shutdown time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '05:30:00'], + 'minTem' => ['description' => 'The minimum target temperature.', 'type' => 'number', 'format' => 'double', 'required' => false, 'title' => '', 'example' => '2.1'], + 'maxTem' => ['description' => 'The maximum target temperature.', 'type' => 'number', 'format' => 'double', 'required' => false, 'title' => '', 'example' => '3.1'], + 'maxCarbonDioxide' => ['description' => 'The maximum carbon dioxide concentration.', 'type' => 'number', 'format' => 'double', 'required' => false, 'title' => '', 'example' => '2.1'], + 'controlType' => [ + 'description' => 'The control mode. For example, automatic or manual.', 'type' => 'integer', 'format' => 'int32', 'required' => false, - 'example' => '10', - 'default' => '10', + 'enumValueTitles' => ['手动' => '1', '自动' => '0'], + 'title' => '', + 'example' => '0', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8466,120 +6504,118 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Return result.', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n", - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'Returned data structure.', - 'type' => 'object', - 'properties' => [ - 'total' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - 'totalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'currentPage' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'chatList' => [ - 'description' => 'Q&A list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of a round of Q&A.', - '$ref' => '#/components/schemas/ChatItem', - ], - ], - ], + 'description' => 'The returned data.', + 'type' => 'boolean', + 'enumValueTitles' => ['成功' => 'true', '失败' => 'false'], + 'title' => '', + 'example' => 'true', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SetRunningPlan', + 'summary' => 'Sets an execution plan.', + 'changeSet' => [ + ['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"chatList\\": [\\n {\\n \\"question\\": \\"\\",\\n \\"answer\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'Get Q\\\\\\&A List', - 'description' => '- This API retrieves the list of historical documents within a session by passing in the session ID.'."\n" - .'- The sessionId information is obtained through GetChatSessionList.'."\n" - .'- A new session can also be created using the CreateChatSession interface.', - 'translator' => 'machine', - ], - 'SendDocumentAskQuestion' => [ - 'summary' => 'null null', - 'path' => '/api/v1/aidoc/document/sendDocumentAskQuestion', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetRunningPlan'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SetRunningPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'SubmitDocExtractionTask' => [ + 'summary' => 'Extracts key information from a document based on a preset key-value template or prompt template. A successful call returns a task ID. You can then call GetDocExtractionResult to retrieve the extraction results. Asynchronously submits a task for a file specified by a URL. To submit a task for a local file, use the SubmitDocExtractionTaskAdvance operation.', + 'path' => '/api/v2/aidoc/document/submitDocExtractionTask', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '避免任务过多影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'fileUrl', + 'in' => 'query', + 'schema' => ['description' => 'Choose one of the following parameters: fileUrl or fileUrlObject.'."\n" + ."\n" + .'- fileUrl: The URL of a single document. The document can have a maximum of 3,000 pages and a size of up to 500 MB.'."\n" + ."\n" + .'- fileUrlObject: The local file to upload. The document can have a maximum of 3,000 pages and a size of up to 500 MB. This parameter is used when you call the SubmitDocExtractionTaskAdvance operation.'."\n" + ."\n" + .'> The supported document types vary based on the extraction method.'."\n" + .'>'."\n" + .'> - Long-text retrieval-augmented generation (RAG): Supports PDF, DOC, DOCX, XLSX, CSV, and TXT files with a maximum of 3,000 pages.'."\n" + .'>'."\n" + .'> - Image processing: Supports PDF, JPG, JPEG, PNG, BMP, JPE, TIF, TIFF, WEBP, and HEIC files.'."\n" + .'>'."\n" + .'> - Long-text understanding: Supports DOC, DOCX, XLSX, PDF, CSV, and TXT files.', 'type' => 'string', 'example' => 'FileUrl: https://example.com/example.pdf'."\n" + .'fileUrlObject: FileInputStream generated from a local file', 'isFileTransferUrl' => true, 'required' => false, 'title' => ''], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'The file name, including the file extension.', 'type' => 'string', 'required' => true, 'example' => 'example.pdf', 'title' => ''], + ], + [ + 'name' => 'templateId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the extraction template. This ID specifies the content to extract from the document. To obtain a template ID, log on to the template management page and configure a template.', 'type' => 'string', 'required' => true, 'example' => '572d24k0c95a', 'title' => ''], + ], + [ + 'name' => 'folderId', + 'in' => 'query', + 'schema' => ['description' => '- The unique ID of the knowledge base folder. Use this parameter to categorize documents or to limit the scope of documents for online Q\\&A queries.'."\n" + ."\n" + .'- To obtain a folder ID, log on to the Document Mind console.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx', 'title' => ''], + ], + [ + 'name' => 'extractType', + 'in' => 'query', 'schema' => [ - 'description' => 'Request parameters', - 'type' => 'object', - 'properties' => [ - 'prompt' => [ - 'description' => 'The question queried by the user', - 'type' => 'string', - 'required' => true, - 'example' => 'Total carbon emissions in 2023', - ], - 'folderId' => [ - 'description' => 'Folder ID, used to specify the range of documents for the query. If it is empty, it indicates that all documents under the default folder will be queried.', - 'type' => 'string', - 'required' => false, - 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd', - ], - 'sessionId' => [ - 'description' => 'Q&A session ID, used to record multiple Q&A interactions of the same user. If it is empty, it indicates that sessions are not distinguished.', - 'type' => 'string', - 'required' => false, - 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', - ], - ], - 'required' => false, + 'description' => 'The document extraction type. Supported types include rag and long-text understanding. The default value is rag.', + 'type' => 'string', + 'example' => 'rag', + 'default' => 'rag', + 'enum' => ['rag', 'longTextUnderstanding'], + 'required' => true, + 'title' => '', ], ], ], @@ -8587,303 +6623,325 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n", - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => 'Returned data', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'answer' => [ - 'description' => 'Q&A result', - 'type' => 'string', - 'example' => 'Carbon emissions in 2023 totaled 4.681 million tons', - ], - 'document' => [ - 'description' => 'Documents associated with the answer returned by the query', - 'type' => 'array', - 'items' => [ - 'description' => 'Document Details', - 'type' => 'string', - 'example' => 'https://oss/aa.pdf', - ], - ], + 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '864773ec-d35b-4c36-8871-52d07fbe806d', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"answer\\": \\"2023年碳排468.1万吨\\",\\n \\"document\\": [\\n \\"https://oss/aa.pdf\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'SendDocumentAskQuestion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"taskId\\": \\"864773ec-d35b-4c36-8871-52d07fbe806d\\"\\n }\\n}","type":"json"}]', + 'title' => 'Asynchronously Submit RAG and Long Text Understanding Information Extraction Tasks', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocExtractionTask'], + ], + ], + 'ramActions' => [], 'translator' => 'machine', ], - 'Chat' => [ - 'summary' => 'Knowledge Base Q\\&A', - 'path' => '/api/v2/aidoc/document/chat', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SubmitDocParsingTask' => [ + 'summary' => 'Parses content, such as text, tables, and images, from a document. A successful call returns a task ID. You can then call `GetDocParsingResult` to retrieve the parsing results. The `SubmitDocParsingTask` operation asynchronously submits a task for a file URL. The `SubmitDocParsingTaskAdvance` operation asynchronously submits a task for a local file.', + 'path' => '/api/v2/aidoc/document/submitDocParsingTask', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '避免任务过多影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request parameters.', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'description' => '- Q&A session ID.'."\n" - .'- Historical sessions can be retrieved through GetSessionList.'."\n" - .'- A new session can also be created via CreateChatSession.', - 'type' => 'string', - 'required' => true, - 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', - ], - 'question' => [ - 'description' => 'Q&A content.', - 'type' => 'string', - 'required' => true, - 'example' => 'How to access knowledge base Q&A documents.', - ], - 'documentIds' => [ - 'title' => '（可选）传入问答参考的文件id列表。若在创建问答session时已经指定了文件夹，则务必', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], - 'required' => false, - ], + 'name' => 'fileUrl', + 'in' => 'query', + 'schema' => ['description' => 'Specify either \\`fileUrl\\` or \\`fileUrlObject\\`.'."\n" + ."\n" + .'- \\`fileUrl\\`: The URL of the document. The document can be up to 3000 pages and 500 MB in size.'."\n" + ."\n" + .'- \\`fileUrlObject\\`: Use this parameter when you call the operation to upload a local file. The document can be up to 3000 pages and 500 MB in size.'."\n" + ."\n" + .'> Parsing methods and supported document types'."\n" + .'>'."\n" + .'> - Long-text retrieval-augmented generation (RAG): Supports PDF, DOC, and DOCX files up to 3000 pages.'."\n" + .'>'."\n" + .'> - Image processing: Supports PDF, JPG, JPEG, PNG, and BMP files.'."\n" + .'>'."\n" + .'> - Long-text understanding: Supports PDF, DOC, DOCX, XLS, and XLSX files.', 'type' => 'string', 'example' => 'FileUrl: https://example.com/example.pdf'."\n" + .'fileUrlObject: FileInputStream generated from a local file', 'isFileTransferUrl' => true, 'required' => false, 'title' => ''], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'The file name must include the file extension.', 'type' => 'string', 'required' => true, 'example' => 'example.pdf', 'title' => ''], + ], + [ + 'name' => 'folderId', + 'in' => 'query', + 'schema' => ['description' => '- The unique ID of the knowledge base folder. Use this ID to manage document classification and control the scope of documents for online Q\\&A queries.'."\n" + ."\n" + .'- To get the folder ID, log on to the Document Mind console.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx', 'title' => ''], + ], + [ + 'name' => 'needAnalyzeImg', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to parse the image content in the document.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Return result.', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"], 'data' => [ - 'description' => 'Details of the Q&A.', - 'example' => 'true', - '$ref' => '#/components/schemas/ChatItem', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'ae9d07be-1a11-4d30-be75-cc962b98279c', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"question\\": \\"\\",\\n \\"answer\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'Document Q\\&A', - 'description' => '- The interface provides Q&A services within the scope of the selected directory in the session.'."\n" - .'- The sessionId information is obtained through GetChatSessionList.'."\n" - .'- You can also create a new session via the CreateChatSession interface.', - 'translator' => 'machine', - ], - 'ChatStream' => [ - 'summary' => 'Knowledge Base Q\\&A', - 'path' => '/api/v2/aidoc/document/chat/stream', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"taskId\\": \\"ae9d07be-1a11-4d30-be75-cc962b98279c\\"\\n }\\n}","type":"json"}]', + 'title' => 'Asynchronously Submit Document Parsing Task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocParsingTask'], + ], ], - 'schemes' => [ - 'https', - 'sse', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SubmitDocParsingTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitDocumentAnalyzeJob' => [ + 'summary' => 'The document parsing operation is used to extract the key content of a document and extract the key-value information from the document based on the preset key-value template. The document parsing operation is an asynchronous operation. You need to call the asynchronous submission service for document parsing and then call the GetDocumentAnalyzeResult operation to perform result polling. The asynchronous submission service supports two methods: local files and URL files. Call the SubmitDocumentAnalyzeJob operation to upload URL files. Call the SubmitDocumentAnalyzeJobAdvance operation to upload local files.', + 'path' => '/api/v1/aidoc/document/submitDocumentAnalyzeJob', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request Parameters', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'description' => '- Q&A session ID.'."\n" - .'- Historical sessions can be retrieved through GetSessionList.'."\n" - .'- A new session can also be created via CreateChatSession.', - 'type' => 'string', - 'required' => true, - 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', - ], - 'question' => [ - 'description' => 'Q&A content.', - 'type' => 'string', - 'required' => true, - 'example' => 'How to access knowledge base Q&A documents.'."\n", - ], - 'documentIds' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], - 'required' => false, - ], + 'name' => 'fileUrl', + 'in' => 'query', + 'schema' => ['description' => 'Choose one between fileUrl and fileUrlObject:'."\n" + ."\n" + .'- fileUrl: Use the document URL method for a single document (supports documents with up to 1000 pages and within 100MB).'."\n" + ."\n" + .'- fileUrlObject: Use when calling the API via local file upload, for a single document (supports documents with up to 1000 pages and within 100MB).'."\n" + ."\n" + .'> Relationship between file parsing methods and supported document types.'."\n" + .'>'."\n" + .'> - Long Text RAG: Supports pdf, doc/docx, and up to 1000 pages'."\n" + .'>'."\n" + .'> - Image Processing: Supports pdf, jpg, jpeg, png, bmp'."\n" + .'>'."\n" + .'> - Long Text Understanding: Supports pdf, doc/docx, xls/xlsx', 'type' => 'string', 'example' => 'FileUrl: https://example.com/example.pdf'."\n" + .'fileUrlObject: FileInputStream generated from a local file', 'isFileTransferUrl' => true, 'required' => false, 'title' => ''], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'The filename must include the file type extension.', 'type' => 'string', 'required' => true, 'example' => 'example.pdf', 'title' => ''], + ], + [ + 'name' => 'templateId', + 'in' => 'query', + 'schema' => ['description' => 'The unique extraction template ID is used to specify the key-value pairs to be extracted from the document. You need to log in to the template management page to configure the template and obtain the corresponding template ID.', 'type' => 'string', 'required' => true, 'example' => '572d24k0c95a', 'title' => ''], + ], + [ + 'name' => 'folderId', + 'in' => 'query', + 'schema' => ['description' => 'Unique knowledge base folder ID, used for categorizing documents and controlling the scope of online Q\\&A queries. If empty, the document will be uploaded to the tenant\'s root directory.', 'type' => 'string', 'example' => 'Defaultfor Empty', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'analysisType', + 'in' => 'query', + 'schema' => ['description' => 'The default extraction method is "doc", with the following optional values:'."\n" + ."\n" + .'- vl: Image processing'."\n" + ."\n" + .'- doc: Long text RAG (Retrieval-Augmented Generation)'."\n" + ."\n" + .'- docUnderstanding: Long text comprehension'."\n" + ."\n" + .'- recommender: Recommendation type', 'type' => 'string', 'required' => false, 'example' => 'doc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Request parameters.', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'], 'data' => [ - 'description' => 'Q&A content.', - '$ref' => '#/components/schemas/ChatItem', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'jobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"question\\": \\"\\",\\n \\"answer\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'Streaming Document Q\\&A', - 'description' => '- The interface provides Q&A services within the scope of the selected directory in the session.'."\n" - .'- The sessionId information is obtained through GetChatSessionList.'."\n" - .'- You can also create a new session via the CreateChatSession interface.', - 'translator' => 'machine', - ], - 'AddFolder' => [ - 'summary' => '创建文件夹', - 'path' => '/api/v1/aidoc/folder/add', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"jobId\\": \\"bfce2248-1546-4298-8bcf-70ac26e69646\\"\\n }\\n}","type":"json"}]', + 'title' => 'SubmitDocumentAnalyzeJob', + 'changeSet' => [ + ['createdAt' => '2024-10-22T03:15:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-23T07:22:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-14T06:41:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-07T08:02:18.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocumentAnalyzeJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SubmitDocumentAnalyzeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitVLExtractionTask' => [ + 'summary' => 'Extracts key information from documents using KV templates or prompts with the Qwen-VL model, ideal for image extraction. Supports: URL Upload: SubmitVLExtractionTask. Local File Upload: SubmitVLExtractionTaskAdvance', + 'path' => '/api/v2/aidoc/document/submitVLExtractionTask', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '避免任务过多影响性能', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'folderName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '“abc” “1234”', - ], - 'parentFolderId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '"0" ：parent folder is root'."\n" - .'"4b648f6d11344f258df876cbdc24dc1f" ： folderId', - ], - ], - 'required' => false, - ], + 'name' => 'fileUrl', + 'in' => 'query', + 'schema' => ['description' => 'Choose one of fileUrl or fileUrlObject:'."\n" + ."\n" + .'- fileUrl: Use by providing the document URL, for a single document (supports up to 1000 pages and 100MB in size)'."\n" + ."\n" + .'- fileUrlObject: Use when calling the interface with local file upload, for a single document (supports up to 1000 pages and 100 MB in size)'."\n" + ."\n" + .'> The relationship between file parsing methods and supported document types'."\n" + .'>'."\n" + .'> - Long Text RAG: Supports pdf, doc/docx, up to 1000 pages'."\n" + .'>'."\n" + .'> - Image Processing: Supports pdf, jpg, jpeg, png, bmp'."\n" + .'>'."\n" + .'> - Long Text Understanding: Supports pdf, doc/docx, xls/xlsx', 'type' => 'string', 'example' => 'FileUrl: https://example.com/example.pdf'."\n" + .'fileUrlObject: FileInputStream generated from a local file', 'isFileTransferUrl' => true, 'required' => false, 'title' => ''], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'The filename must include the file type suffix.', 'type' => 'string', 'required' => true, 'example' => 'example.pdf', 'title' => ''], + ], + [ + 'name' => 'folderId', + 'in' => 'query', + 'schema' => ['description' => '- Unique knowledge base folder ID, used when you need to categorize documents and control the scope of online Q\\&A queries.'."\n" + ."\n" + .'- The folder ID needs to be obtained from the intelligent document console after logging in.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx', 'title' => ''], + ], + [ + 'name' => 'templateId', + 'in' => 'query', + 'schema' => ['description' => 'Unique parsing template ID, used to specify the key-value pairs to be extracted from the document. You need to configure the template on the template management page and then obtain the corresponding template ID.', 'type' => 'string', 'required' => true, 'example' => '572d24k0c95a', 'title' => ''], ], ], 'responses' => [ @@ -8893,245 +6951,975 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E38E561C-B996-0E19-8DBC-A218AAE17FBA', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/FolderItem', + 'description' => 'Returned data structure.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '411ce93a-7eb5-40cf-836a-53c32f097663', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"taskId\\": \\"411ce93a-7eb5-40cf-836a-53c32f097663\\"\\n }\\n}","type":"json"}]', + 'title' => 'Asynchronously Submit VL Information Extraction Task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitVLExtractionTask'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E38E561C-B996-0E19-8DBC-A218AAE17FBA\\",\\n \\"data\\": {\\n \\"folderId\\": \\"\\",\\n \\"folderNum\\": 0,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"\\",\\n \\"parentFolderId\\": \\"\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 0,\\n \\"syncStatus\\": 0,\\n \\"syncParsingStatus\\": 0,\\n \\"ossDomain\\": \\"\\",\\n \\"ossUpdateBy\\": \\"\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"\\",\\n \\"folderNum\\": 0,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"\\",\\n \\"parentFolderId\\": \\"\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 0,\\n \\"syncStatus\\": 0,\\n \\"syncParsingStatus\\": 0,\\n \\"ossDomain\\": \\"\\",\\n \\"ossUpdateBy\\": \\"\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"\\",\\n \\"folderNum\\": 0,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"\\",\\n \\"parentFolderId\\": \\"\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 0,\\n \\"syncStatus\\": 0,\\n \\"syncParsingStatus\\": 0,\\n \\"ossDomain\\": \\"\\",\\n \\"ossUpdateBy\\": \\"\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"\\",\\n \\"subFolderList\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SubmitVLExtractionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', ], - 'DeleteFolder' => [ - 'summary' => '删除文件夹', - 'path' => '/api/v1/aidoc/folder/delete', - 'methods' => [ - 'delete', + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'energyexpertexternal.ap-southeast-1.aliyuncs.com', 'endpoint' => 'energyexpertexternal.ap-southeast-1.aliyuncs.com', 'vpc' => 'energyexpertexternal-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'energyexpertexternal.cn-hangzhou.aliyuncs.com', 'endpoint' => 'energyexpertexternal.cn-hangzhou.aliyuncs.com', 'vpc' => 'energyexpertexternal-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => '1001', 'message' => 'The code is invalid. Please check if your code is correct.', 'http_code' => 400, 'description' => 'The code is invalid. Please check if your code is correct.'], + ['code' => '11007', 'message' => '无权限查看, 无权限查看参数为 code', 'http_code' => 200, 'description' => 'No permission to view due to argument code'], + ['code' => '30037', 'message' => 'User has no permission', 'http_code' => 400, 'description' => 'User has no permission'], + ['code' => '36704', 'message' => 'Type is wrong', 'http_code' => 400, 'description' => 'Type is wrong'], + ['code' => 'CarbonAmountNotNegative', 'message' => 'Carbon amount not be negative.', 'http_code' => 201, 'description' => 'Carbon amount not be negative.'], + ['code' => 'DataSizeOverLimit', 'message' => 'Data size over limit.', 'http_code' => 201, 'description' => ''], + ['code' => 'invalidParameter', 'message' => 'Invalid parameter values.', 'http_code' => 400, 'description' => 'Request parameters are incorrect. Please check method entry parameters.'], + ['code' => 'LeftVcsNotEnough', 'message' => 'Left vcs not enough.', 'http_code' => 201, 'description' => ''], + ['code' => 'notAuthorized', 'message' => 'No permissions to call API operations.', 'http_code' => 401, 'description' => 'No permissions to call API operations.'], + ['code' => 'NotSupportActionType', 'message' => 'Not support action type.', 'http_code' => 201, 'description' => ''], + ['code' => 'NotSupportPhotovoltaicCountry', 'message' => 'Not support photovoltaic country.', 'http_code' => 201, 'description' => ''], + ['code' => 'Prefix.1001', 'message' => 'The code is invalid. Please check if your code is correct.', 'http_code' => 400, 'description' => 'The code is invalid. Please check if your code is correct.'], + ['code' => 'ServerException', 'message' => 'Server exception, please try again later.', 'http_code' => 500, 'description' => ''], + ['code' => 'systemError', 'message' => 'System error.', 'http_code' => 500, 'description' => 'System error.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitDocumentAnalyzeJob'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2024-10-22T03:15:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitDocumentAnalyzeJob'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2024-09-23T07:22:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitDocumentAnalyzeJob'], + ], + 'createdAt' => '2024-06-14T06:41:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetGasConstitute'], + ], + 'createdAt' => '2024-06-12T01:57:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitDocumentAnalyzeJob'], + ], + 'createdAt' => '2024-06-07T08:02:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetCarbonEmissionTrend'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetEmissionSourceConstitute'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetEmissionSummary'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetGasConstitute'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetOrgConstitute'], + ], + 'createdAt' => '2024-04-03T02:40:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetGwpInventoryConstitute'], + ], + 'createdAt' => '2024-04-01T08:44:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetOrgAndFactory'], + ], + 'createdAt' => '2023-07-07T08:50:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetDeviceList'], + ], + 'createdAt' => '2023-07-05T09:26:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetDeviceInfo'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetDeviceList'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetOrgAndFactory'], + ], + 'createdAt' => '2023-04-17T06:13:27.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocExtractionTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatFolderList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitVLExtractionTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocParsingResult'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocumentAnalyzeJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdInventoryConstitute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocParsingTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatSession'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReductionProposal'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeVlRealtime'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSourceConstitute'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgConstitute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGasConstitute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentAnalyzeResult'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecTrend'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCarbonEmissionTrend'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFootprintList'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateSystemRunningPlan'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditProhibitedDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgAndFactory'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventorySummary'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdSummary'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushItemData'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecalculateCarbonEmission'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateResult'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPcrInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IsCompleted'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventoryConstitute'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetRunningPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInventoryList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAreaElecConstitute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocExtractionResult'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSummary'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkSummary'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditUnfavorableAreaDevices'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataQualityAnalysis'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVLExtractionResult'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSaveInstructionStatus'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDocumentAskQuestion'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushDeviceData'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataItemList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecConstitute'], + ], + ], + 'ram' => [ + 'productCode' => 'EnergyExpertExternal', + 'productName' => 'Energy Expert', + 'ramCodes' => ['energy'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'BatchSaveInstructionStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:BatchSaveInstructionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetAreaElecConstitute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetAreaElecConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetDocumentAnalyzeResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDocumentAnalyzeResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetDeviceList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'energy:GetDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeviceInfo', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'energy:GetDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetElecConstitute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetElecConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AISearchResourceUpdate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetGasConstitute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGasConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'Chat', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:Chat', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EditProhibitedDevices', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:EditProhibitedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetChatList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetChatList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DetailDocument', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'energy:DetailDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFolder', + 'description' => '', 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', + 'ramAction' => [ + 'action' => 'energy:DeleteFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'folderId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '53c0412ea5c343dcad324137622210b3', + [ + 'apiName' => 'AISearchResourceDelete', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => '', - 'type' => 'boolean', - ], - ], + [ + 'apiName' => 'GetDocExtractionResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDocExtractionResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetEmissionSourceConstitute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEmissionSourceConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - ], - 'DetailDocument' => [ - 'summary' => '获取文档detail', - 'path' => '/api/v1/aidoc/document/detail', - 'methods' => [ - 'get', + [ + 'apiName' => 'PushItemData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:PushItemData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'Retrieve', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:Retrieve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SubmitDocumentAnalyzeJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SubmitDocumentAnalyzeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetChatSessionList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetChatSessionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetOrgConstitute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetOrgConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ChatStream', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:ChatStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetGwpInventorySummary', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpInventorySummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetFootprintList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetFootprintList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetVLExtractionResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetVLExtractionResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetOrgAndFactory', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'energy:GetOrgAndFactory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetRunningPlan', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SetRunningPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetGwpBenchmarkSummary', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpBenchmarkSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetPcrInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetPcrInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AISearchResourceGetList', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceGetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6', + [ + 'apiName' => 'SubmitDocExtractionTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SubmitDocExtractionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => '', - 'example' => 'true', - '$ref' => '#/components/schemas/DocumentDetailItem', - ], - ], + [ + 'apiName' => 'GetDataItemList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDataItemList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetInventoryList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetInventoryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"id\\": 0,\\n \\"folderId\\": \\"\\",\\n \\"folderName\\": \\"\\",\\n \\"jobId\\": \\"\\",\\n \\"jobStatus\\": \\"\\",\\n \\"docName\\": \\"\\",\\n \\"originDocName\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"originDocUrl\\": \\"\\",\\n \\"docHash\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"updateTime\\": \\"\\"\\n }\\n}","type":"json"}]', - ], - 'DeleteDocument' => [ - 'summary' => '删除解析过的文件', - 'path' => '/api/v1/aidoc/document/delete', - 'methods' => [ - 'delete', + [ + 'apiName' => 'GetCarbonEmissionTrend', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetCarbonEmissionTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'AISearchResourceAdd', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AISearchResourceAdd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetGwpInventoryConstitute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpInventoryConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'PushDeviceData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:PushDeviceData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'EditUnfavorableAreaDevices', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:EditUnfavorableAreaDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetChatFolderList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetChatFolderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataQualityAnalysis', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDataQualityAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitVLExtractionTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SubmitVLExtractionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetEmissionSummary', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEmissionSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetElecTrend', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetElecTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SendDocumentAskQuestion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SendDocumentAskQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GenerateResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetEpdInventoryConstitute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEpdInventoryConstitute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'IsCompleted', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:IsCompleted', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetEpdSummary', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetEpdSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchUpdateSystemRunningPlan', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:BatchUpdateSystemRunningPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateChatSession', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:CreateChatSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitDocParsingTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:SubmitDocParsingTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AnalyzeVlRealtime', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AnalyzeVlRealtime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDocument', + 'description' => '', 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertK979RQ', + 'ramAction' => [ + 'action' => 'energy:DeleteDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6', + [ + 'apiName' => 'GetGwpBenchmarkList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetGwpBenchmarkList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', - ], - 'data' => [ - 'description' => 'Returns true on success, false otherwise', - 'type' => 'boolean', - ], - ], + [ + 'apiName' => 'GetDocParsingResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetDocParsingResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'AddFolder', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'energy:AddFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AISearchStream', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:AISearchStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RecalculateCarbonEmission', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:RecalculateCarbonEmission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetReductionProposal', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'energy:GetReductionProposal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'energyexpertexternal.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'energyexpertexternal.cn-hangzhou.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |