diff options
Diffstat (limited to 'data/en_us/energyexpertexternal/2022-09-23/api-docs.php')
| -rw-r--r-- | data/en_us/energyexpertexternal/2022-09-23/api-docs.php | 9137 |
1 files changed, 9137 insertions, 0 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 new file mode 100644 index 0000000..0676fd7 --- /dev/null +++ b/data/en_us/energyexpertexternal/2022-09-23/api-docs.php @@ -0,0 +1,9137 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'energyExpertExternal', + 'version' => '2022-09-23', + ], + 'directories' => [ + [ + 'id' => 366327, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 366328, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetDataItemList', + 'PushItemData', + 'RecalculateCarbonEmission', + ], + ], + [ + 'id' => 366332, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetFootprintList', + 'GenerateResult', + 'IsCompleted', + 'GetPcrInfo', + 'GetGwpInventorySummary', + 'GetGwpBenchmarkSummary', + 'GetEpdSummary', + 'GetInventoryList', + 'GetGwpBenchmarkList', + 'GetGwpInventoryConstitute', + 'GetEpdInventoryConstitute', + 'GetReductionProposal', + 'GetDataQualityAnalysis', + ], + ], + [ + 'id' => 366346, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetEmissionSummary', + 'GetEmissionSourceConstitute', + 'GetCarbonEmissionTrend', + 'GetElecConstitute', + 'GetElecTrend', + 'GetAreaElecConstitute', + 'GetGasConstitute', + 'GetOrgConstitute', + ], + ], + ], + ], + [ + 'id' => 366355, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 366356, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'BatchSaveInstructionStatus', + 'SetRunningPlan', + 'EditUnfavorableAreaDevices', + 'EditProhibitedDevices', + 'BatchUpdateSystemRunningPlan', + ], + ], + [ + 'id' => 366362, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PushDeviceData', + ], + ], + ], + ], + [ + 'id' => 366364, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetDeviceInfo', + 'GetDeviceList', + 'GetOrgAndFactory', + ], + ], + [ + 'id' => 366368, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 366369, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetDocumentAnalyzeResult', + 'SubmitDocumentAnalyzeJob', + 'SubmitDocParsingTask', + 'GetDocParsingResult', + ], + ], + [ + 'id' => 366374, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SubmitDocExtractionTask', + 'GetDocExtractionResult', + 'SubmitVLExtractionTask', + 'GetVLExtractionResult', + 'AnalyzeVlRealtime', + ], + ], + [ + 'id' => 366380, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetChatFolderList', + 'CreateChatSession', + 'Retrieve', + 'GetChatSessionList', + 'GetChatList', + 'SendDocumentAskQuestion', + 'Chat', + 'ChatStream', + ], + ], + [ + 'id' => 366389, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddFolder', + 'DeleteFolder', + ], + ], + [ + 'id' => 366392, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DetailDocument', + 'DeleteDocument', + ], + ], + ], + ], + ], + 'components' => [ + 'schemas' => [ + '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' => [ + 'description' => 'Location information of Q&A-related content in the document.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'pos' => [ + 'description' => 'Location information of the document.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + 'extendType' => 'true', + ], + 'backendName' => 'pos', + ], + 'num' => [ + 'description' => 'Page numbers of related documents.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + 'backendName' => 'num', + ], + ], + ], + 'ChatFolderItem' => [ + 'description' => 'Document directory list.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'subFolders' => [ + 'description' => 'Subfolder list.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Subfolder details.', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ChatFolderItem', + ], + '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', + ], + ], + ], + 'ChatItem' => [ + 'description' => 'Q&A details.', + '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', + ], + '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', + ], + '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', + ], + ], + ], + 'ChatRefDocInfo' => [ + 'description' => 'Page document information.', + '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', + ], + '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', + ], + 'backendName' => 'pageListInfo', + ], + ], + ], + 'ChatRefDocItem' => [ + 'description' => 'Related document information.', + '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', + ], + 'pageNum' => [ + 'description' => 'Page number information.', + 'visibility' => 'Public', + 'type' => 'array', + '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', + ], + ], + ], + 'ChatRefDocPageInfo' => [ + 'description' => 'Specific information for each page of the document.', + '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', + ], + ], + ], + 'ChatRefDocPageNum' => [ + 'description' => 'Information on the number of pages in related documents.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'pos' => [ + 'description' => 'List of location information for related documents.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'array '."\n" + .'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', + ], + 'extendType' => 'true', + ], + 'backendName' => 'pos', + ], + 'num' => [ + 'description' => 'Page numbers of content related to Q&A.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + 'backendName' => 'num', + ], + ], + ], + 'ChatRefDocPostion' => [ + 'description' => 'Document coordinates.', + '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', + ], + ], + ], + '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', + ], + 'docElsIds' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'b0x7', + 'extendType' => 'true', + ], + 'backendName' => 'docElsIds', + ], + ], + ], + 'ConstituteItem' => [ + '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', + ], + 'envGasEmissions' => [ + 'title' => '', + 'description' => 'Gas Emissions Detail List.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + ], + 'required' => false, + 'backendName' => 'envGasEmissions', + 'itemName' => 'gasEmissionItem', + ], + 'subConstituteItems' => [ + 'title' => '', + 'description' => 'The child detail list.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Descent emission List', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ConstituteItem', + ], + 'backendName' => 'subConstituteItems', + 'itemName' => 'constituteItem', + ], + ], + ], + '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', + ], + 'extInfo' => [ + 'title' => '', + 'description' => 'The coordinates of the text are in list format.', + 'visibility' => 'Public', + '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', + ], + 'pageNum' => [ + 'title' => '', + 'description' => 'Page numbers of the layout, which may include multiple page numbers.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Page number, default value is 1.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'extendType' => 'true', + ], + 'backendName' => 'pageNum', + ], + 'pos' => [ + 'title' => '', + 'description' => 'Position information of the layout, in list format.', + 'visibility' => 'Public', + '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', + ], + ], + '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.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '88c712db271443dd4e3697cb9b5dab3a', + 'backendName' => 'uniqueId', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'extInfo', + ], + 'text' => [ + 'title' => '', + 'description' => 'Recall text.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'content', + 'backendName' => 'text', + ], + ], + ], + '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', + ], + 'jobStatus' => [ + 'description' => '', + 'visibility' => 'Public', + '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', + ], + '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', + ], + ], + ], + 'EpdInventoryConstituteItem' => [ + 'title' => '', + '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', + ], + 'items' => [ + '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', + ], + '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', + ], + 'subFolderList' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/FolderItem', + ], + 'backendName' => 'subFolderList', + ], + ], + ], + 'GwpInventoryConstitute' => [ + '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', + ], + 'byResourceType' => [ + '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', + ], + 'backendName' => 'byResourceType', + ], + 'items' => [ + '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', + ], + 'backendName' => 'items', + ], + ], + ], + 'GwpResourceConstitute' => [ + 'title' => '', + 'description' => 'Carbon emission structure of gwp inventory.'."\n", + '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', + ], + ], + ], + 'OrgEmission' => [ + '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', + ], + 'moduleEmissionList' => [ + 'title' => '', + 'description' => 'Sub-module carbon emission data'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + 'description' => 'Module struct.', + ], + 'backendName' => 'moduleEmissionList', + 'itemName' => 'ModuleEmissionItem', + ], + 'subEmissionItems' => [ + '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', + ], + 'backendName' => 'subEmissionItems', + 'itemName' => 'SubEmissionItem', + ], + ], + ], + ], + ], + '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', + ], + '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.', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => 'The enterprise code.', + 'type' => 'string', + 'required' => true, + 'example' => 'C-202302-01', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => '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.', + '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' => 'string', + 'required' => true, + 'example' => '1', + ], + 'value' => [ + 'description' => 'The value of the data item.', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '1.11', + ], + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'data' => [ + 'description' => 'Whether the data is pushed successfully.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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.', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => 'The enterprise code.', + 'type' => 'string', + 'required' => true, + 'example' => 'C-20240202-01', + ], + 'year' => [ + 'description' => 'Year of inventory.', + 'type' => 'string', + 'required' => true, + 'example' => '2024', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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'."\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', + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'data' => [ + 'description' => 'The response parameters.'."\n", + '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.', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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 data. `true` indicates that the request is successful, `false` indicates that the request fails.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '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' => '', + ], + ], + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"电力清单\\",\\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.', + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '83A5A7DD-8974-5769-952E-590A97BEA34E', + ], + 'data' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => 'B91B5559-065A-55C3-8D75-DA218EBFD1DC', + ], + 'data' => [ + 'description' => 'Response parameters'."\n", + 'type' => 'array', + 'items' => [ + '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", + 'type' => 'string', + 'example' => 'climate change', + ], + '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).', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + '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", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'data' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + 'productUnit' => [ + 'description' => 'Unit of product.', + 'type' => 'string', + 'example' => 'kg', + ], + 'items' => [ + 'description' => 'Inventory detail.', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + 'data' => [ + 'description' => 'The response parameters.'."\n", + '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.', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + 'data' => [ + 'description' => 'The response parameters.'."\n", + '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.', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'data' => [ + 'description' => 'List of environmental impact results.', + 'type' => 'array', + 'items' => [ + 'description' => 'Environmental impact result Item.', + '$ref' => '#/components/schemas/EpdInventoryConstituteItem', + ], + ], + ], + ], + ], + ], + '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', + ], + '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'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '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' => '', + ], + ], + ], + '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.', + ], + 'GetDataQualityAnalysis' => [ + 'summary' => 'Obtain the data quality evaluation results DQR and DQI.', + 'path' => '/api/v1/carbon/footprint/data/quality/analysis', + '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'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'dataQuality' => [ + 'description' => 'Score of each inventory.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'inventory' => [ + 'description' => 'Inventory name', + 'type' => 'string', + 'example' => 'energy', + ], + 'score' => [ + 'description' => 'Score. The distribution ranges from 1 to 5. A value closer to 1 indicates better data quality.'."\n", + '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', + ], + ], + ], + ], + ], + ], + 'dataQualityResult' => [ + 'description' => 'Data quality result.', + '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', + ], + ], + ], + 'sensitivityList' => [ + 'description' => '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', + ], + 'reductionList' => [ + 'description' => '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', + ], + ], + ], + ], + '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', + ], + 'uncertaintyValues' => [ + 'description' => 'Uncertainty list'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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"}]', + '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.', + ], + 'GetEmissionSummary' => [ + 'summary' => 'Get a summary of carbon emissions.', + 'path' => '/api/v1/carbon/emission/analysis/summary', + '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.', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => 'Details of summarized data', + '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', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request.', + 'type' => 'string', + 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', + ], + ], + ], + ], + ], + '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', + ], + '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' => 'The request parameters for the operation.'."\n", + '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.', + 'type' => 'string', + 'required' => false, + 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of response.', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => 'Response parameters'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of comstitute analysis.', + '$ref' => '#/components/schemas/ConstituteItem', + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'GetCarbonEmissionTrend' => [ + 'summary' => 'Get trends in carbon emissions.', + 'path' => '/api/v1/carbon/emission/analysis/trend', + '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'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f', + ], + 'data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'targetEmissionList' => [ + 'description' => 'Target 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' => '10', + ], + 'carbonEmissionData' => [ + 'description' => 'Carbon emissions.', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.22', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'GetElecConstitute' => [ + 'summary' => 'This interface is used to obtain power composition analysis data.', + 'path' => '/api/v1/carbon/emission/analysis/elec/constitute', + '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' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'water' => [ + 'description' => 'Hydropower consumption and carbon emission data of each enterprise.', + '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', + ], + ], + ], + 'light' => [ + 'description' => 'Photoelectric power consumption and carbon emission data of each enterprise.', + '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', + ], + ], + ], + 'urban' => [ + 'description' => 'Data on mains power electricity consumption and carbon emission of each enterprise.', + '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', + ], + ], + ], + 'wind' => [ + 'description' => 'Wind power consumption and carbon emission data of each enterprise.', + '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', + ], + ], + ], + 'nuclear' => [ + 'description' => 'Data on nuclear power consumption and carbon emissions at each enterprise.', + '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', + ], + ], + ], + 'renewing' => [ + 'description' => 'Data on renewable electricity consumption and carbon emissions at each enterprise.', + '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', + ], + ], + ], + 'zero' => [ + 'description' => 'Data of zero electricity consumption and carbon emission of each enterprise.', + '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', + ], + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request.', + 'type' => 'string', + 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetElecConstitute', + ], + 'GetElecTrend' => [ + 'summary' => 'This interface is used to obtain power trend analysis data.', + 'path' => '/api/v1/carbon/emission/analysis/elec/trend', + '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' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => 'The enterprise code.', + 'type' => 'string', + 'required' => true, + 'example' => 'C-20240115-3', + ], + 'yearList' => [ + 'description' => 'List of years.', + 'type' => 'array', + 'items' => [ + 'description' => 'Year'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2023', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The struct returned.'."\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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'water' => [ + 'description' => 'Monthly data on electricity consumption and carbon emissions for hydropower.', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'light' => [ + 'description' => 'Photoelectricity monthly electricity consumption and carbon emissions and other data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'urban' => [ + 'description' => 'Data such as monthly electricity consumption and carbon emissions from the mains.', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'wind' => [ + 'description' => 'Monthly wind power consumption and carbon emission data'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'nuclear' => [ + 'description' => 'Monthly electricity consumption and carbon emissions data for nuclear power'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'renewing' => [ + 'description' => 'Monthly data on renewable electricity consumption and carbon emissions'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'zero' => [ + 'description' => 'Zero electricity monthly electricity consumption and carbon emissions and other data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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"}]', + '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', + ], + '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' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The struct returned.'."\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 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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'GetGasConstitute' => [ + 'summary' => 'This interface is used to obtain gas composition analysis.', + 'path' => '/api/v1/carbon/emission/analysis/gas/constitute', + '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' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The struct returned.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The struct returned.'."\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 data returned.'."\n", + '$ref' => '#/components/schemas/OrgEmission', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => '', + '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' => '', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'true', + 'type' => 'boolean', + 'enumValueTitles' => [ + '成功' => 'true', + '失败' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => 'BatchSaveInstructionStatus', + ], + 'SetRunningPlan' => [ + 'summary' => '设置运行计划', + 'path' => '/api/v1/carbon/hvac/setRunningPlan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREenergyexpertXYPXBQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + '成功' => 'true', + '失败' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => 'SetRunningPlan', + ], + 'EditUnfavorableAreaDevices' => [ + 'summary' => '编辑不利区设备', + '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' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + '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' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + '成功' => 'true', + '失败' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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', + ], + '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' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + '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' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f', + ], + 'data' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + '成功' => 'true', + '失败' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => 'EditProhibitedDevices', + ], + 'BatchUpdateSystemRunningPlan' => [ + 'summary' => '批量设置空调站点运行计划', + 'path' => '/api/v1/carbon/hvac/batchUpdateSystemRunningPlan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREenergyexpertXYPXBQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + '成功' => 'true', + '失败' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => 'BatchUpdateSystemRunningPlan', + ], + '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', + ], + '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' => 'The request parameters.'."\n", + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The struct returned.'."\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' => 'Whether the data is pushed successfully. Success is returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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', + 'schema' => [ + 'description' => 'The time string in the YYYY-mm-dd format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-07-26', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + 'data' => [ + 'description' => 'The data returned.'."\n", + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"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.', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'factoryId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The ID of the site.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pn_95', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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 data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'factoryId' => [ + 'description' => 'The ID of the site.'."\n", + 'type' => 'string', + 'example' => 'pn_95', + ], + 'deviceList' => [ + 'description' => 'The devices.'."\n", + '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', + ], + ], + ], + ], + ], + ], + '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.'."\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', + ], + ], + ], + ], + ], + '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 \\"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.', + ], + '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.', + 'path' => '/api/external/getOrgAndFactory', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response 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' => 'data'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned.'."\n", + '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", + ], + 'factoryList' => [ + 'description' => 'The sites.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the site.'."\n", + '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", + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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 {\\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"}]', + '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', + ], + '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', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + '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 => [ + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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", + ], + 'data' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => 'TaskID', + 'type' => 'string', + 'example' => 'ae9d07be-1a11-4d30-be75-cc962b98279c', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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', + ], + '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' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'Returned result.', + '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}]}]}}', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body 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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'Returned data structure.', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'keyValue' => [ + 'description' => 'Field key value', + 'type' => 'string', + 'example' => 'Alibaba Cloud XXX Co., Ltd.', + ], + 'context' => [ + 'description' => 'Recalled content', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'Details of key recall information', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of key recall information', + 'example' => 'bhv_trace_info_invalid', + '$ref' => '#/components/schemas/ContentItem', + ], + ], + 'value' => [ + 'description' => 'Details of 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 level', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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, 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', + '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', + ], + ], + ], + '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 structure.', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => 'Task ID.', + 'type' => 'string', + 'example' => '411ce93a-7eb5-40cf-836a-53c32f097663', + ], + ], + ], + ], + ], + ], + ], + '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', + 'translator' => 'machine', + ], + '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', + ], + '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' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request parameters', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => '- taskID.'."\n" + ."\n" + .'- The taskId is obtained from the interfaces SubmitVLExtractionTaskAdvance and SubmitVLExtractionTask.', + 'type' => 'string', + 'required' => true, + 'example' => '1436b6f5-ddea-4308-9d1c-60939e5d5ea8', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => '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 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + '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', + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + 'translator' => 'machine', + ], + 'Retrieve' => [ + 'summary' => '支持多文件夹ID或文件ID检索的RAG结果获取接口，供客户端自行加工结果并嵌入业务逻辑。', + 'path' => '/api/v2/aidoc/knowledgebase/retrieve', + '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' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + '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', + ], + 'documentIds' => [ + 'title' => 'docIds与folderIds必须要传入一个', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3456', + ], + 'required' => false, + ], + 'folderIds' => [ + 'title' => 'folderIds与docIds必须要传入一个', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'adafb91d4e014e2eb4d0a5375b547115', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + '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' => '', + 'type' => 'object', + 'properties' => [ + 'jobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '76cd1691-daf6-4113-8444-4998a25a5323', + ], + 'results' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '$ref' => '#/components/schemas/ChunkItem', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + '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.', + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request 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', + ], + 'currentPage' => [ + 'description' => 'Pagination parameter, page number, starting from 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + 'pageSize' => [ + 'description' => 'Page size.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n", + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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', + '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, + ], + ], + ], + '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", + ], + 'data' => [ + 'description' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + 'translator' => 'machine', + ], + 'Chat' => [ + 'summary' => 'Knowledge Base Q\\&A', + 'path' => '/api/v2/aidoc/document/chat', + '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' => true, + 'tenantRelevance' => 'tenant', + ], + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', + ], + 'data' => [ + 'description' => 'Details of the Q&A.', + 'example' => 'true', + '$ref' => '#/components/schemas/ChatItem', + ], + ], + ], + ], + ], + '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' => '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', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => [ + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Request parameters.', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E', + ], + 'data' => [ + 'description' => 'Q&A content.', + '$ref' => '#/components/schemas/ChatItem', + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'E38E561C-B996-0E19-8DBC-A218AAE17FBA', + ], + 'data' => [ + 'description' => '', + '$ref' => '#/components/schemas/FolderItem', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + ], + 'DeleteFolder' => [ + 'summary' => '删除文件夹', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '53c0412ea5c343dcad324137622210b3', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => 'taskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => 'taskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + ], +]; |