'1.0',
'info' => ['style' => 'ROA', 'product' => 'energyExpertExternal', 'version' => '2022-09-23'],
'directories' => [
[
'children' => ['AISearchResourceDelete', 'AISearchResourceUpdate', 'AISearchStream', 'AISearchResourceGetList', 'AISearchResourceAdd'],
'type' => 'directory',
'title' => 'AISearch',
'id' => 452350,
],
[
'children' => [
[
'children' => ['GetDataItemList', 'PushItemData', 'RecalculateCarbonEmission'],
'type' => 'directory',
'title' => '报送碳排放活动数据',
'id' => 452352,
],
[
'children' => ['GetFootprintList', 'GenerateResult', 'IsCompleted', 'GetPcrInfo', 'GetGwpInventorySummary', 'GetGwpBenchmarkSummary', 'GetEpdSummary', 'GetInventoryList', 'GetGwpBenchmarkList', 'GetGwpInventoryConstitute', 'GetEpdInventoryConstitute', 'GetReductionProposal', 'GetDataQualityAnalysis'],
'type' => 'directory',
'title' => '查询产品碳足迹结果',
'id' => 452353,
],
[
'children' => ['GetEmissionSummary', 'GetEmissionSourceConstitute', 'GetCarbonEmissionTrend', 'GetElecConstitute', 'GetElecTrend', 'GetAreaElecConstitute', 'GetGasConstitute', 'GetOrgConstitute'],
'type' => 'directory',
'title' => '查询组织碳盘查结果',
'id' => 452354,
],
],
'type' => 'directory',
'title' => '碳排管理',
'id' => 452351,
],
[
'children' => [
[
'children' => ['BatchSaveInstructionStatus', 'SetRunningPlan', 'EditUnfavorableAreaDevices', 'EditProhibitedDevices', 'BatchUpdateSystemRunningPlan'],
'type' => 'directory',
'title' => '空调智控',
'id' => 452356,
],
[
'children' => ['PushDeviceData'],
'type' => 'directory',
'title' => '报送能耗数据',
'id' => 452357,
],
],
'type' => 'directory',
'title' => '节能减碳',
'id' => 452355,
],
[
'children' => ['GetDeviceInfo', 'GetDeviceList', 'GetOrgAndFactory'],
'type' => 'directory',
'title' => '设备管理',
'id' => 452358,
],
[
'children' => [
[
'children' => ['GetDocumentAnalyzeResult', 'SubmitDocumentAnalyzeJob', 'SubmitDocParsingTask', 'GetDocParsingResult'],
'type' => 'directory',
'title' => '文档解析',
'id' => 452360,
],
[
'children' => ['SubmitDocExtractionTask', 'GetDocExtractionResult', 'SubmitVLExtractionTask', 'GetVLExtractionResult', 'AnalyzeVlRealtime'],
'type' => 'directory',
'title' => '信息抽取',
'id' => 452361,
],
[
'children' => ['GetChatFolderList', 'GetChatSessionList', 'GetChatList', 'SendDocumentAskQuestion', 'Chat', 'ChatStream'],
'type' => 'directory',
'title' => '知识库问答',
'id' => 452362,
],
[
'children' => ['AddFolder'],
'type' => 'directory',
'title' => '目录管理',
'id' => 452363,
],
[
'children' => ['DetailDocument'],
'type' => 'directory',
'title' => '文件管理',
'id' => 452364,
],
],
'type' => 'directory',
'title' => 'AI文档处理',
'id' => 452359,
],
[
'children' => ['CreateChatSession', 'DeleteDocument', 'DeleteFolder', 'Retrieve'],
'type' => 'directory',
'title' => '其他',
'id' => 452365,
],
],
'components' => [
'schemas' => [
'AISearchMessageItem' => [
'description' => '历史对话信息',
'type' => 'object',
'properties' => [
'type' => [
'description' => '历史对话信息内容类型。'."\n"
.'- “text”（表示文字记录）、“miniapp”（表示结构化元素中的小程序信息记录）以及 “product”（表示结构化元素中的商品信息记录）'."\n"
.'- type为“text”时，仅在content字段中输入拼接的一轮对话内容，params字段保持为空'."\n"
.'- tyep为“miniapp”或“product”时，仅在params字段中输入JSON形式的结构化信息，content字段保持为空',
'type' => 'string',
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp', 'text' => 'text'],
'example' => 'miniapp',
],
'content' => ['description' => '- 一轮对话中用户提出的问题与接口返回的文本内容进行拼接，形成完整的对话上下文中的一部分。'."\n"
.'- 此内容需要用户自行拼接，推荐格式为：'."\n"
.'"user：+问题 +\\naisearch：+ 上一轮的回答"', 'type' => 'string', 'example' => '"user：How to test my network speed?\\naisearch：To check your network speed, you can use..."'],
'params' => ['description' => '记录一轮对话中出现的结构化信息', 'type' => 'any', 'example' => '{'."\n"
.' "miniapp_id": "test_miniapp",'."\n"
.' "title": "testApp",'."\n"
.' "version": "1.0.5",'."\n"
.' "description": "description-mock",'."\n"
.' "slogan": "slogan-mock",'."\n"
.' "icon": "https://img.alicdn.com/test_icon.png",'."\n"
.' "detail_desc": "detail-mock"'."\n"
.'}'],
],
],
'AISearchStreamItem' => [
'description' => '流式事件结构',
'type' => 'object',
'properties' => [
'type' => [
'description' => '流式数据类型。',
'type' => 'string',
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp', 'text' => 'text'],
'example' => 'text',
],
'content' => ['description' => '流式输出的文字内容，本字段仅在type为text时显示输出。', 'type' => 'string', 'example' => '“network problem can be”'],
'params' => ['description' => '该字段用于输出流式结果中的结构化信息内容，当 type 为 miniapp 时，输出小程序相关的结构化资源；当 type 为 product 时，输出商品相关的结构化资源，所有内容均以 JSON 格式呈现。', 'type' => 'any', 'example' => ' [{"type": "miniapp", "score": 0.7404107, "resourceId": "ja9bQZwBg5VwSU7n5Ijs", "miniappId": null, "title": "更新后的智能搜索测试助手", "version": "1.0.5", "description": "这是一个用于测试 AI 搜索功能的演示小程序", "slogan": "搜索即所得", "icon": "https://img.alicdn.com/test_icon.png", "url": null, "detailDescription": "该小程序提供了完整的 AI 搜索链路测试。"}]'],
],
],
'CarbonEmissionElecSummaryItem' => [
'title' => '企业分析返回结构',
'description' => '企业分析返回结构',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['title' => '碳排排放当量', 'description' => '碳排放当量。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.22', 'backendName' => 'carbonEmissionData'],
'rawData' => ['title' => '用电量', 'description' => '用电量，单位Kwh。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'rawData'],
'ratio' => ['title' => '用电量占比', 'description' => '用电量占比，取值范围0~1。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.22', 'backendName' => 'ratio'],
'dataUnit' => ['title' => '单位', 'description' => '单位', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg', 'backendName' => 'dataUnit'],
'name' => ['title' => '企业名称', 'description' => '企业名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx', 'backendName' => 'name'],
],
],
'ChatDocumentPageNum' => [
'description' => '问答相关内容在文档的位置信息。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'pos' => [
'description' => '文档的位置信息。',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '相关位置坐标，每个位置为4个坐标点。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '文档块位置数据', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocPostion'],
'extendType' => 'true',
],
'backendName' => 'pos',
],
'num' => ['description' => '相关文档页码。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'backendName' => 'num'],
],
],
'ChatFolderItem' => [
'description' => '文档目录列表。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'subFolders' => [
'description' => '子文件夹列表。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '子文件夹详情。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatItem'],
'backendName' => 'subFolders',
],
'folderName' => ['description' => '文件夹名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '默认文件夹。', 'backendName' => 'folderName'],
'folderId' => ['description' => '文件夹ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'aaa', 'backendName' => 'folderId'],
],
],
'ChatItem' => [
'description' => '问答详情。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'question' => ['description' => '提问内容。', 'visibility' => 'Public', 'type' => 'string', 'example' => '如何使用知识库。', 'backendName' => 'question'],
'answer' => ['description' => '提问的回答内容。', 'visibility' => 'Public', 'type' => 'string', 'example' => '未找到相关内容', 'backendName' => 'answer'],
'createTime' => ['description' => '问答时间，毫秒时间戳。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1747280158000', 'backendName' => 'createTime'],
'refDocList' => [
'description' => '- 与问答相关的文件列表。'."\n"
.'- 如果使用流式问答，只有第一个分片有数据。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '问答相关文件详情。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocItem'],
'backendName' => 'refDocList',
],
'folderName' => ['description' => '问答选择的文件夹名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '默认文件夹', 'backendName' => 'folderName'],
'folderId' => ['description' => '问答选择的文件夹。', 'visibility' => 'Public', 'type' => 'string', 'example' => '7708fddb-21dc-4403-a4ea-5b94eccce4c3', 'backendName' => 'folderId'],
],
],
'ChatRefDocInfo' => [
'description' => '页面文档信息。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'pages' => ['description' => '当前文档总页数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'backendName' => 'answer'],
'pageListInfo' => [
'description' => '文件每页具体信息。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '每页具体信息。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocPageInfo'],
'backendName' => 'pageListInfo',
],
],
],
'ChatRefDocItem' => [
'description' => '相关文档信息。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'docName' => ['description' => '文档名称，如果原始文件是doc等类型会转换为pdf，方便文档定位，对文档定位信息需要使用此文件。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'a.pdf', 'backendName' => 'docName'],
'sourceType' => ['description' => '返回文件类型，"doc": 文件类型； "web"：互联网信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'doc', 'backendName' => 'sourceType'],
'docUrl' => ['description' => '文档链接。', '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' => '相关文档信息。', 'visibility' => 'Public', 'backendName' => 'docInfo', '$ref' => '#/components/schemas/ChatRefDocInfo'],
'originDocName' => ['description' => '原始文件名。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'a.doc', 'backendName' => 'originDocName'],
'pageNum' => [
'description' => '页码信息。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '页面信息详情。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatDocumentPageNum'],
'backendName' => 'pageNum',
],
'originDocUrl' => ['description' => '原始文档链接。', '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' => '文件每页具体信息。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'imageWidth' => ['description' => '页面转图的宽。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'backendName' => 'imageWidth'],
'imageUrl' => ['description' => '- 页面转图片后的图片URL。'."\n"
.'- 注意：图片url超过24小时后将无法获取到图片，需要及时另存。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2', 'backendName' => 'imageUrl'],
'pageIdCurDoc' => ['description' => '页面在当前文档的页索引，从0开始。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'backendName' => 'pageIdCurDoc'],
'angle' => ['description' => '页面转图片后的图片的旋转角度。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'backendName' => 'angle'],
'excelParseResult' => ['description' => '预留，暂可不用。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'null', 'backendName' => 'excelParseResult'],
'wordParseResult' => ['description' => '预留，暂可不用。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'null', 'backendName' => 'wordParseResult'],
'pdfParseResult' => ['description' => '预留，暂可不用。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'null', 'backendName' => 'pdfParseResult'],
'imageHeight' => ['description' => '页面转图的高。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'backendName' => 'imageHeight'],
],
],
'ChatRefDocPageNum' => [
'description' => '相关文档页数信息。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'pos' => [
'description' => '相关文档位置信息列表。',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '相关文档位置信息列表。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '相关文档位置信息。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ChatRefDocPostion'],
'extendType' => 'true',
],
'backendName' => 'pos',
],
'num' => ['description' => '问答相关内容的页数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'backendName' => 'num'],
],
],
'ChatRefDocPostion' => [
'description' => '文档坐标。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'x' => ['description' => '版面的x坐标。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'backendName' => 'x'],
'y' => ['description' => '版面的y坐标。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '86', 'backendName' => 'y'],
],
],
'ChunkItem' => [
'title' => '',
'description' => '知识库召回信息',
'type' => 'object',
'properties' => [
'score' => ['title' => '召回分数', 'description' => '召回分数', 'type' => 'number', 'format' => 'float', 'example' => '0.4295678'],
'docName' => ['title' => '文件名', 'description' => '文件名', 'type' => 'string', 'example' => '临时场地协议-APM.pdf'],
'rerankScore' => ['title' => '重排序分数', 'description' => '重排序分数', 'type' => 'number', 'format' => 'float', 'example' => '0.5053711'],
'docId' => ['title' => '文件hash id', 'description' => '文件hash id', 'type' => 'string', 'example' => 'b4620821aea92c062d8d19ad793243669cf9ae2b900e6967dee6ee9f3bf5feed'],
'docUrl' => ['title' => '文件url', 'description' => '文件url', 'type' => 'string', 'example' => 'jobs/a4123b3f-9287-4c61-b59d-32e40fcb0a31/document/8b24a2e06669427fb3dc9812374d9d1a.pdf'],
'weightedScore' => ['title' => '召回权重', 'description' => '召回权重', 'type' => 'number', 'format' => 'float', 'example' => '0.47252458'],
'chunkId' => ['title' => '"docElsIds"中的元素用逗号连接的结果', 'description' => '"docElsIds"中的元素用逗号连接的结果', 'type' => 'string', 'example' => 'b0x7,b1x10'],
'chunkContent' => ['title' => 'chunk内容', 'description' => 'chunk内容', 'type' => 'string', 'example' => '\\\\n## 第三条 场地占用费(含物业管理费和市场推广费)\\\\n\\\\n3.2 乙方应于本协议签订后 20 个工作日内或该场地交付乙方的同时(以日期在先者为准),\\\\n向甲方一次性支付该场地四个月的场地占用费。\\\\n\\\\n3.3 乙方应向甲方支付的协议价款(场地占用费、物业管理费、市场推广费及本协议约定的其 他费用)以及实际发生的各种性质的价外费用(根据适用税法的相关规定,价外费用包括 但不限于违约金、赔偿金、代收款项、代垫款项)均为含增值税价格。'],
'docElsIds' => [
'title' => '对应原始文件文件块的uniqueId列表',
'description' => '对应原始文件文件块的uniqueId列表',
'type' => 'array',
'items' => ['description' => '原始文件文件块的uniqueId', 'type' => 'string', 'example' => 'b0x7'],
],
],
],
'ConstituteItem' => [
'title' => '构成分析列表结构',
'description' => '构成分析列表结构',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'enterpriseName' => ['title' => '企业名称', 'description' => '企业名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '企业1', 'backendName' => 'enterpriseName'],
'rawData' => ['title' => '原始数据', 'description' => '原始数据', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'rawData'],
'carbonEmissionData' => ['title' => '碳排放量', 'description' => '碳排放量', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '3.222', 'backendName' => 'carbonEmissionData'],
'ratio' => ['title' => '所占比例', 'description' => '所占比例', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'backendName' => 'ratio'],
'nameKey' => ['title' => '名称唯一标识', 'description' => '名称唯一标识', 'visibility' => 'Public', 'type' => 'string', 'example' => 'carbonInventory.check.indirect_emissions_from_imported_electricity', 'backendName' => 'nameKey'],
'name' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '电力', 'backendName' => 'name'],
'emissionSourceKey' => ['title' => '排放源唯一标识', 'description' => '排放源唯一标识', 'visibility' => 'Public', 'type' => 'string', 'example' => 'carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec', 'backendName' => 'emissionSourceKey'],
'emissionSource' => ['title' => '排放源', 'description' => '排放源', 'visibility' => 'Public', 'type' => 'string', 'example' => 'GEC', 'backendName' => 'emissionSource'],
'dataUnit' => ['title' => '数据单位', 'description' => '数据单位', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kWh', 'backendName' => 'dataUnit'],
'envGasEmissions' => [
'title' => '气体排放详情列表',
'description' => '气体排放详情列表',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'type' => ['title' => '标识气体类型的唯一key', 'description' => '标识气体类型的唯一key', 'visibility' => 'Public', 'type' => 'string', 'example' => '1', 'backendName' => 'type'],
'name' => ['title' => '气体名称', 'description' => '气体名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'CO₂', 'backendName' => 'name'],
'gasEmissionData' => ['title' => '气体碳排放量', 'description' => '气体碳排放量', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '4.33', 'backendName' => 'gasEmissionData'],
'carbonEmissionData' => ['title' => 'carbonEmissionData'."\0".' 碳排放量', 'description' => '碳排放量', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'carbonEmissionData'],
],
'extendType' => 'true',
],
'required' => false,
'backendName' => 'envGasEmissions',
'itemName' => 'gasEmissionItem',
],
'subConstituteItems' => [
'title' => '子级详情列表',
'description' => '子级详情列表',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '下降排放列表', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ConstituteItem'],
'backendName' => 'subConstituteItems',
'itemName' => 'constituteItem',
],
],
],
'ContentItem' => [
'cloudType' => 'public',
'branchId' => 4123116,
'branchName' => 'master',
'paramExtraInfo' => [
'$.components.schemas.ContentItem.properties.extInfo.items.properties.pageNum.description' => '版面的页码，可能包含多个页码', '$.components.schemas.ContentItem.properties.extInfo.items.properties.text.example' => '版面内容', '$.components.schemas.ContentItem.properties.extInfo.items.properties.uniqueId.description' => 'str 唯一的版面id', '$.components.schemas.ContentItem.properties.extInfo.items.properties.alignment.description' => '版面对齐方式的枚举值：center, left, right', '$.components.schemas.ContentItem.properties.extInfo.items.properties.type.example' => 'table', '$.components.schemas.ContentItem.properties.extInfo.items.properties.level.example' => '2', '$.components.schemas.ContentItem.properties.extInfo.items.properties.alignment.example' => 'center', '$.components.schemas.ContentItem.properties.extInfo.description' => '文本的坐标信息，是list形式。', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pageNum.items.example' => '1', '$.components.schemas.ContentItem.properties.score.description' => '召回的置信度。',
'$.components.schemas.ContentItem.properties.score.example' => '0.45', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.y.description' => '版面的y坐标', '$.components.schemas.ContentItem.properties.extInfo.items.properties.subType.example' => 'picture', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.x.description' => 'int 版面的x坐标', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.description' => '版面的位置信息，list', '$.components.schemas.ContentItem.properties.extInfo.items.properties.type.description' => '版面的类型枚举值：table, figure, text，none', '$.components.schemas.ContentItem.properties.type.example' => 'img', '$.components.schemas.ContentItem.description' => 'ContentItem', '$.components.schemas.ContentItem.properties.extInfo.items.properties.uniqueId.example' => '88c712db271443dd4e3697cb9b5dab3a', '$.components.schemas.ContentItem.properties.extInfo.items.properties.index.example' => '8',
'$.components.schemas.ContentItem.properties.extInfo.items.properties.level.description' => '版面的层级', '$.components.schemas.ContentItem.properties.extInfo.items.properties.text.description' => 'text', '$.components.schemas.ContentItem.properties.type.description' => '文本来源， img, table, para', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.x.example' => '1', '$.components.schemas.ContentItem.properties.extInfo.items.properties.index.description' => '版面在文本中的序号', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pos.items.properties.y.example' => '2', '$.components.schemas.ContentItem.properties.text.example' => '租户是xxx', '$.components.schemas.ContentItem.properties.extInfo.items.properties.pageNum.items.description' => '页码，默认值 1。'."\n"
."\n", '$.components.schemas.ContentItem.properties.text.description' => '召回文本', '$.components.schemas.ContentItem.properties.extInfo.items.properties.subType.description' => '版面的子类型枚举值：picture, para, none',
],
'title' => 'ContentItem',
'description' => 'ContentItem',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'score' => ['title' => '召回的置信度', 'description' => '召回的置信度', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.45', 'backendName' => 'score'],
'type' => ['title' => '文本来源， img, table, para', 'description' => '文本来源， img, table, para', 'visibility' => 'Public', 'type' => 'string', 'example' => 'img', 'backendName' => 'type'],
'extInfo' => [
'title' => '文本的坐标信息，是list形式',
'description' => '文本的坐标信息，是list形式',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'alignment' => ['title' => '版面对齐方式 枚举值：center, left, right', 'description' => '版面对齐方式的枚举值：center, left, right', 'visibility' => 'Public', 'type' => 'string', 'example' => 'center', 'backendName' => 'alignment'],
'index' => ['title' => '版面在文本中的序号', 'description' => '版面在文本中的序号', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'backendName' => 'index'],
'level' => ['title' => '版面的层级', 'description' => '版面的层级', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'backendName' => 'level'],
'pageNum' => [
'title' => '版面的页码，可能包含多个页码',
'description' => '版面的页码，可能包含多个页码',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '页码，默认值 1。'."\n"
."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'extendType' => 'true'],
'backendName' => 'pageNum',
],
'pos' => [
'title' => '版面的位置信息，list',
'description' => '版面的位置信息，list',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'x' => ['title' => 'int 版面的x坐标', 'description' => 'int 版面的x坐标', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'x'],
'y' => ['title' => '版面的y坐标', 'description' => '版面的y坐标', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'backendName' => 'y'],
],
'extendType' => 'true',
],
'backendName' => 'pos',
],
'subType' => ['title' => '版面的子类型 枚举值：picture, para, none', 'description' => '版面的子类型枚举值：picture, para, none', 'visibility' => 'Public', 'type' => 'string', 'example' => 'picture', 'backendName' => 'subType'],
'text' => ['title' => 'text', 'description' => 'text', 'visibility' => 'Public', 'type' => 'string', 'example' => '版面内容', 'backendName' => 'text'],
'type' => ['title' => '版面的类型 枚举值：table, figure, text，none', 'description' => '版面的类型枚举值：table, figure, text，none', 'visibility' => 'Public', 'type' => 'string', 'example' => 'table', 'backendName' => 'type'],
'uniqueId' => ['title' => 'str 唯一的版面id', 'description' => 'str 唯一的版面id', 'visibility' => 'Public', 'type' => 'string', 'example' => '88c712db271443dd4e3697cb9b5dab3a', 'backendName' => 'uniqueId'],
],
'extendType' => 'true',
],
'backendName' => 'extInfo',
],
'text' => ['title' => '召回文本', 'description' => '召回文本', 'visibility' => 'Public', 'type' => 'string', 'example' => '租户是xxx', 'backendName' => 'text'],
],
],
'DocumentDetailItem' => [
'description' => '获取文档关键信息描述。',
'type' => 'object',
'properties' => [
'id' => ['description' => '文档主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '6731'],
'folderId' => ['description' => '文件夹ID，可通过其他相关接口或产品前端界面获取', 'type' => 'string', 'example' => 'adafb91d4e014e2eb4d0a5375b547115'],
'folderName' => ['description' => '文件夹名称', 'type' => 'string', 'example' => '123/abc/ 文件夹1'],
'jobId' => ['description' => '解析/抽取任务ID，可通过其他相关接口或产品前端界面获取', 'type' => 'string', 'example' => '74ec62f4f4e74e5882d4086a40f2b9c6'],
'jobStatus' => [
'description' => '任务状态',
'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',
],
'docName' => ['description' => '文档名称', 'type' => 'string', 'example' => '123/abc/ 文档1.pdf'],
'originDocName' => ['description' => '原始文档名', 'type' => 'string', 'example' => '123/abc/ 文档1.pdf/.doc/docx/csv/xlsx/txt'],
'docUrl' => ['description' => '文档链接', 'type' => 'string', 'example' => 'https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/docName'],
'originDocUrl' => ['description' => '原始文档链接', 'type' => 'string', 'example' => 'https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/originDocName'],
'docHash' => ['description' => '文档哈希值', 'type' => 'string', 'example' => '5335c8828ccf735a500ed636590c713a94daf6cdacc90237733035cc5a152afb_1760513801010'],
'createTime' => ['description' => '创建时间（北京时间）', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-09-08T17:04:28.000+08:00'],
'updateTime' => ['description' => '更新时间（北京时间）', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-09-08T17:04:28.000+08:00'],
],
],
'EpdInventoryConstituteItem' => [
'title' => 'epd清单结构体',
'description' => 'epd清单结构体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'inventoryValuePerProduct' => ['title' => '每功能单位活动数据', 'description' => '每功能单位活动数据：只第三级不为空；数值保留24位小数，表示每功能单位活动数量；应当与inventoryValuePerProductUnit联合使用。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.000000000000000000000000', 'backendName' => 'inventoryValuePerProduct'],
'factorDataset' => ['title' => 'factorDataset 因子所属数据库', 'description' => 'factorDataset 因子所属数据库。该字段与factorType联合使用，当factorType为1，这里显示因子归属的数据名称；当factorType为2，factorId表示所引用产品id；当factorType为null，factorId无意义。此字段为新增字段，老数据可能没有此字段数据，显示为"/"。', 'visibility' => 'Public', 'type' => 'string', 'example' => '/', 'backendName' => 'factorDataset'],
'percent' => ['title' => '所占比例', 'description' => '所占比例，保留四位小数，返回31.4000表示占比31.4%的。第一级返回为null'."\n"
.'；第二级返回当前工序占总排放百分比； 第三级返回当前清单占总排放百分比', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '31.4000', 'backendName' => 'percent'],
'inventoryValuePerProductUnit' => ['title' => '每功能单位活动数据单位', 'description' => '每功能单位活动数据单位。只第三级不为空。在清单信息中的表示每功能单位活动数据单位。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg', 'backendName' => 'inventoryValuePerProductUnit'],
'num' => ['title' => '类别key', 'description' => '类别key，[参考附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'num'],
'quantity' => ['title' => '原始活动数据', 'description' => '原始活动数据。只有第三级返回不为null，表示清单数量。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.000000000000', 'backendName' => 'num'],
'resourceType' => ['title' => '清单类型', 'description' => '清单类型。只有第三级返回不为null，第三级为清单详情，此字段表示清单的类型名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '原材料', 'backendName' => 'resourceType'],
'factorType' => ['title' => 'factorType 因子类型key', 'description' => '因子类型key。只第三级不为空，清单信息中的factorType表示选用因子来源类型；可选值有1、2或者null：1：因子库 ，2：产品库。null表示并非从因子库、产品库选择的因子，因子来源于用户自行构造。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'factorType'],
'unit' => ['title' => '环境影响结果值单位', 'description' => '环境影响结果值单位。此单位为对应环境影响类别的环境影响结果值单位。比如kg CO2-Eq表示这里显示的排放值的单位是kg CO2-Eq。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg CO2-Eq', 'backendName' => 'unit'],
'name' => ['title' => '名称', 'description' => '名称。返回本级的名称，不同级的name含义不同。第一级返回为环境影响类型。第二级返回当前工序名称。第三级返回当前清单名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '清单1', 'backendName' => 'name'],
'inventoryId' => ['title' => '清单id', 'description' => '清单id', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'inventoryId'],
'inventoryValue' => ['title' => '清单数量', 'description' => '清单数量。仅在第三级不为空。第三级为清单详情，此字段表示清单的id。应当与inventoryUnit联合使用。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '2.000000000000000000000000', 'backendName' => 'inventoryValue'],
'factorUnit' => ['title' => '因子单位', 'description' => '因子单位', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kg CO2-Eq/kg', 'backendName' => 'factorUnit'],
'inventoryUnit' => ['title' => '清单单位', 'description' => '清单单位', 'visibility' => 'Public', 'type' => 'string', 'example' => 't', 'backendName' => 'inventoryUnit'],
'state' => ['title' => '数据状态', 'description' => '数据状态。1表示准确计算，2表示采用默认数据，3表示采用0作为因子值参与计算。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'state'],
'factor' => ['title' => '因子值', 'description' => '因子值。只第三级不为空，清单信息中的factor表示所选因子的因子值。因子值保留小数点后四位小数，"1.0000"表示因子值为1。因子值应当结合factorUnit使用，如factorUnit为"kg CO2-Eq/kg"，那么表示该每1kg该清单碳排放为1kg CO2-Eq。', 'visibility' => 'Public', 'type' => 'string', 'example' => '1.0000', 'backendName' => 'factor'],
'carbonEmission' => ['title' => '排放量', 'description' => '排放量。保留24位小数，建议进行截取部分使用。含义是各层级的排放量：'."\n"
.'第一级表示当前环境影响类型下，该产品的总排放量；第二级表示当前环境影响类型下，该工序的总排放量；第三级表示当前环境影响类型下，该清单的总排放量。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', 'backendName' => 'carbonEmission'],
'factorId' => ['title' => '因子id', 'description' => '因子id', 'visibility' => 'Public', 'type' => 'string', 'example' => '1234', 'backendName' => 'factorId'],
'items' => [
'title' => '子级列表',
'description' => '子级列表',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '子级列表。第三级返回为null。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/EpdInventoryConstituteItem'],
'backendName' => 'items',
],
],
],
'FolderItem' => [
'description' => '创建的文件夹数据结构关键信息描述',
'type' => 'object',
'properties' => [
'folderId' => ['description' => '文件ID，该值在文件夹成功创建后由接口返回', 'type' => 'string', 'example' => '4b648f6d11344f258df876cbdc24dc1f'],
'folderNum' => ['description' => '目录排序', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'docCount' => ['description' => '当前文件夹子文件夹数量，对一个新文件夹而言此值默认为0', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'folderName' => ['description' => '文件夹名称，用户自拟', 'type' => 'string', 'example' => '“abc” “1234”'],
'parentFolderId' => ['description' => '该文件夹的父文件夹Id', 'type' => 'string', 'example' => '"0" ：parent folder is root'."\n"
.'"4b648f6d11344f258df876cbdc24dc1f" ： folderId'],
'folderDefault' => ['description' => '1:默认文件夹 0:非默文件夹，对于用户来说此值默认为0', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'currentLevel' => ['description' => '当前层级', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'syncStatus' => ['description' => 'oss同步抽取状态，-1未设置（默认），0未开启，1已开启', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'],
'syncParsingStatus' => ['description' => 'oss同步解析状态，-1未设置（默认），0未开启，1已开启', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'],
'ossDomain' => ['description' => 'OSS-bucket地址', 'type' => 'string', 'example' => 'aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com '],
'ossUpdateBy' => ['description' => 'OSS操作人', 'type' => 'string', 'example' => '1696462764375572'],
'taskId' => ['description' => '创建该文件夹的任务ID，0:手动创建', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'resourcePath' => ['description' => '外部资源路径', 'type' => 'string', 'example' => 'folder/manual/'],
'storageType' => ['description' => '存储类型', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ossPath' => ['description' => 'OSS路径', 'type' => 'string', 'example' => 'test/'],
'subFolderList' => [
'description' => '子文件夹序列，默认为空',
'type' => 'array',
'items' => ['description' => '子文件夹实体', '$ref' => '#/components/schemas/FolderItem'],
],
],
],
'GwpInventoryConstitute' => [
'title' => '温室气体构成',
'description' => '温室气体构成',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'percent' => ['title' => '排放百分比', 'description' => '排放百分比，例如100.00是指100.00%的意思。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '100.00', 'backendName' => 'percent'],
'resourceType' => ['title' => '清单类型', 'description' => '清单类型，可能的清单类型值可以参考[附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'resourceType'],
'unit' => ['title' => '单位', 'description' => '单位', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kgCO₂e/kg', 'backendName' => 'unit'],
'carbonEmission' => ['title' => '排放数量', 'description' => '排放数量', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', 'backendName' => 'carbonEmission'],
'name' => ['title' => '排放体名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '总碳排放量', 'backendName' => 'name'],
'byResourceType' => [
'title' => '按类型聚合列表',
'description' => '按类型聚合，各中类型的排放详情。用于组成分析中的“按类型”分析。这是一个嵌套结构，总碳排放量->按清单类型排序，共两层，最末级byResource为空。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '按类型聚合列表。按类型聚合，各中类型的排放详情。用于组成分析中的“按类型”分析。这是一个嵌套结构，总碳排放量->按清单类型排序，共两层，最末级byResource为空。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GwpResourceConstitute'],
'backendName' => 'byResourceType',
],
'items' => [
'title' => '构成详情列表',
'description' => '按层级从高到低的结构组织，按照环节->工序->清单层级。用于组成分析中的“按清单”分析。这是一个嵌套结构，按照环节->工序->清单层级，最末层级items为空。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '构成详情列表。按层级从高到低的结构组织，按照环节->工序->清单层级。用于组成分析中的“按清单”分析。这是一个嵌套结构，按照环节->工序->清单层级，最末层级items为空。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GwpInventoryConstitute'],
'backendName' => 'items',
],
],
],
'GwpResourceConstitute' => [
'title' => '资源构成结构体',
'description' => 'gwp清单碳排放结构。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'name' => ['title' => '名称', 'description' => '名称，逐层含义不同，最外层是总碳排放量。', 'visibility' => 'Public', 'type' => 'string', 'example' => '总碳排放量', 'backendName' => 'name'],
'unit' => ['title' => '单位', 'description' => '排放单位。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kgCO₂e/Piece(s)', 'backendName' => 'unit'],
'resourceType' => ['title' => '清单类型', 'description' => '清单类型。在清单层有意义，其它层可为空。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'resourceType'],
'carbonEmission' => ['title' => '碳排放当量', 'description' => '碳排放量，为保证精度，保留24位小数，建议截取使用。', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', 'backendName' => 'carbonEmission'],
'percent' => ['title' => '排放百分比', 'description' => '排放百分比。98.76的表示98.76%的占比。', 'visibility' => 'Public', 'type' => 'string', 'example' => '98.76', 'backendName' => 'percent'],
],
],
'OrgEmission' => [
'title' => '组织分析返回值结构',
'description' => '组织分析返回值结构',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'name' => ['title' => '企业名称', 'description' => '企业名称', 'visibility' => 'Public', 'type' => 'string', 'example' => '企业1', 'backendName' => 'name', 'itemName' => 'name'],
'nameKey' => ['title' => '企业类型', 'description' => '企业编码', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Z-20240115-4', 'backendName' => 'nameKey'],
'carbonEmissionData' => ['title' => '碳排放当量', 'description' => '碳排放当量', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'carbonEmissionData'],
'weightingCarbonEmissionData' => ['title' => '按股比计算碳排', 'description' => '按股比计算碳排', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '2.3', 'backendName' => 'weightingCarbonEmissionData'],
'weightingRatio' => ['title' => '股比碳排同比', 'description' => '股比碳排同比', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.4', 'backendName' => 'weightingRatio'],
'ratio' => ['title' => '碳排占比', 'description' => '碳排占比', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.2', 'backendName' => 'ratio'],
'weightingProportion' => ['title' => '权重比例', 'description' => '权重比例', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.3', 'backendName' => 'weightingProportion'],
'moduleEmissionList' => [
'title' => '分模块碳排数据',
'description' => '分模块碳排数据',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'name' => ['title' => '模块名', 'description' => '模块名', 'visibility' => 'Public', 'type' => 'string', 'example' => '范围一：直接排放（企业生产经营过程产生的直接温室气体排放量）', 'backendName' => 'name'],
'nameKey' => ['title' => '模块key', 'description' => '模块key', 'visibility' => 'Public', 'type' => 'string', 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', 'backendName' => 'nameKey'],
'carbonEmissionData' => ['title' => '碳排量', 'description' => '碳排量', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.2', 'backendName' => 'carbonEmissionData'],
'ratio' => ['title' => '碳排量占比', 'description' => '碳排量占比', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '0.2', 'backendName' => 'ratio'],
],
'extendType' => 'true',
],
'backendName' => 'moduleEmissionList',
'itemName' => 'ModuleEmissionItem',
],
'subEmissionItems' => [
'title' => '子级数据，即组织下的场地数据',
'description' => '子级数据，即组织下的场地数据',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '下级企业列表', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/OrgEmission'],
'backendName' => 'subEmissionItems',
'itemName' => 'SubEmissionItem',
],
],
],
],
],
'apis' => [
'AISearchResourceAdd' => [
'summary' => '添加AISearch项目中的结构化元素，目前支持的结构化元素类型为【小程序】（miniapp）&【商品】（product）。',
'path' => '/api/v1/aiSearch/resource/add',
'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' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body参数',
'type' => 'object',
'properties' => [
'type' => [
'description' => '结构化元素类型',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'],
'example' => 'miniapp',
],
'data' => ['description' => '与type对应的结构化元素信息，本字段需要按照规定的格式**以JSON形式**传递参数'."\n"
.''."\n"
.'当类型为【小程序】（miniapp）时
'."\n"
."\n"
.'- "miniappId": "必填，小程序唯一标识"'."\n"
.'- "title": 必填，小程序名称"'."\n"
.'- "version": "必填，版本号"'."\n"
.'- "description": "必填，简要描述",'."\n"
.'- "detailDesc": "选填，详细描述",'."\n"
.'- "slogan": "选填，标语"'."\n"
.'- "icon": "必填，图标URL",'."\n"
.'- "url": "必填，小程序链接"'."\n"
.' '."\n"
.''."\n"
.'当类型为【商品】（product）时
'."\n"
."\n"
.' - "title": "必填，商品名称"'."\n"
.'- "description": "必填，商品描述",'."\n"
.'- "icon": "必填，商品图标URL",'."\n"
.'- "url": "必填，商品链接",'."\n"
.'- "price": "必填，价格",'."\n"
.'- "extra": "选填，扩展字段，任意key-value对象"'."\n"
.' ', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
.' "miniapp_id": "test_miniapp",'."\n"
.' "title": "testApp",'."\n"
.' "version": "1.0.5",'."\n"
.' "description": "description-mock",'."\n"
.' "slogan": "slogan-mock",'."\n"
.' "icon": "https://img.alicdn.com/test_icon.png",'."\n"
.' "detail_desc": "detail-mock"'."\n"
.'}'],
],
'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' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '结构化元素类型，与请求入参中的type字段内容一致',
'type' => 'string',
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'],
'example' => 'miniapp',
],
'resourceId' => ['description' => '结构化元素资源ID，是该资源在数据库中唯一且不可变的标识符，用于后续的修改、删除和查询操作', 'type' => 'string', 'example' => 'WzMGQZwB7nQEs3Qk3ajH'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '添加AISearch结构化资源',
'requestParamsDescription' => '字段 type 本质上为枚举类型，仅支持规定的取值范围，超出范围的值将导致接口无法正常工作；后续将根据需求扩展更多结构化内容。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"type\\": \\"miniapp\\",\\n \\"resourceId\\": \\"WzMGQZwB7nQEs3Qk3ajH\\"\\n }\\n}","type":"json"}]',
],
'AISearchResourceDelete' => [
'path' => '/api/v1/aiSearch/resource/delete',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'type',
'in' => 'query',
'schema' => [
'description' => '结构化元素类型',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'],
'example' => 'miniapp',
],
],
[
'name' => 'resourceId',
'in' => 'query',
'schema' => ['description' => '结构化元素资源 ID，是该资源在数据库中唯一且不可变的标识符', 'type' => 'string', 'required' => true, 'example' => 'WzMGQZwB7nQEs3Qk3ajH'],
],
],
'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' => [
'type' => [
'description' => '结构化元素类型，与请求入参中的 type 字段内容一致',
'type' => 'string',
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'],
'example' => 'miniapp',
],
'resourceId' => ['description' => '结构化元素资源 ID，是该资源在数据库中唯一且不可变的标识符', 'type' => 'string', 'example' => 'WzMGQZwB7nQEs3Qk3ajH'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除AISearch结构化资源',
'summary' => '根据资源类型和资源ID，删除AISearch项目中的结构化元素。',
'requestParamsDescription' => '字段 type 本质上为枚举类型，仅支持规定的取值范围，超出范围的值将导致接口无法正常工作；后续将根据需求扩展更多结构化内容。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"type\\": \\"miniapp\\",\\n \\"resourceId\\": \\"WzMGQZwB7nQEs3Qk3ajH\\"\\n }\\n}","type":"json"}]',
],
'AISearchResourceGetList' => [
'path' => '/api/v1/aiSearch/resource/list',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'type',
'in' => 'query',
'schema' => [
'description' => '结构化元素类型',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'],
'example' => 'miniapp',
],
],
[
'name' => 'resourceIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '待查询的资源列表，若为空则按分页方式查询该类型下的全部资源',
'type' => 'array',
'items' => ['description' => '结构化元素资源 ID，是该资源在数据库中唯一且不可变的标识符', 'type' => 'string', 'required' => false, 'example' => ' '."\n"
.'WzMGQZwB7nQEs3Qk3ajH'."\n"],
'required' => false,
],
],
[
'name' => 'pageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'currentPage',
'in' => 'query',
'schema' => ['description' => '分页页码，从1开始', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'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' => '返回结果。',
'type' => 'object',
'properties' => [
'total' => ['description' => '资源总数', 'type' => 'integer', 'format' => 'int64', 'example' => '68'],
'currentPage' => ['description' => '当前页码。', 'type' => 'string', 'example' => '1'],
'pageSize' => ['description' => '分页大小', 'type' => 'string', 'example' => '20'],
'items' => [
'description' => '资源列表',
'type' => 'array',
'items' => ['description' => 'Item详情', 'type' => 'any', 'example' => ' {"type":"miniapp","score":0.4571971,"resourceId":"1512004139024243527680","miniappId":"","title":"Electronic Invoice","version":"1.0.0","description":"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.","slogan":"E-Invoice mini-app","icon":"https://gw.alicdn.com/6000000000498-2-tps-200-200.png","url":"https://app-intl.com/release/6592_v1.6.16_poc.zip","detailDescription":null}'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询AISearch结构化资源',
'summary' => '查询 AISearch 结构化资源时，当前支持的资源类型包括：【小程序】（miniapp）和【商品】（product）。'."\n"
.'资源类型为必填参数；若提供资源 ID，则查询指定资源；若未提供资源 ID，则按分页方式查询该类型下的全部资源。',
'requestParamsDescription' => '字段 type 本质上为枚举类型，仅支持规定的取值范围，超出范围的值将导致接口无法正常工作；后续将根据需求扩展更多结构化内容。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": {\\n \\"total\\": 68,\\n \\"currentPage\\": \\"1\\",\\n \\"pageSize\\": \\"20\\",\\n \\"items\\": [\\n \\" {\\\\\\"type\\\\\\":\\\\\\"miniapp\\\\\\",\\\\\\"score\\\\\\":0.4571971,\\\\\\"resourceId\\\\\\":\\\\\\"1512004139024243527680\\\\\\",\\\\\\"miniappId\\\\\\":\\\\\\"\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Electronic Invoice\\\\\\",\\\\\\"version\\\\\\":\\\\\\"1.0.0\\\\\\",\\\\\\"description\\\\\\":\\\\\\"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.\\\\\\",\\\\\\"slogan\\\\\\":\\\\\\"E-Invoice mini-app\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"https://gw.alicdn.com/6000000000498-2-tps-200-200.png\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://app-intl.com/release/6592_v1.6.16_poc.zip\\\\\\",\\\\\\"detailDescription\\\\\\":null}\\"\\n ]\\n }\\n}","type":"json"}]',
],
'AISearchResourceUpdate' => [
'summary' => '修改AISearch项目中的结构化元素，目前支持的结构化元素类型为【小程序】（miniapp）&【商品】（product）。',
'path' => '/api/v1/aiSearch/resource/update',
'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' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求参数',
'type' => 'object',
'properties' => [
'type' => [
'description' => '结构化元素类型',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'],
'example' => 'miniapp',
],
'resourceId' => ['description' => '结构化元素资源 ID，是该资源在数据库中唯一且不可变的标识符', 'type' => 'string', 'required' => true, 'example' => 'WzMGQZwB7nQEs3Qk3ajH'],
'data' => ['description' => '对指定资源的信息进行更新，本字段需要按照规定的格式以 JSON 形式传递需要更新的字段，未传递的字段则默认不做修改'."\n"
.''."\n"
.'当更新类型为【小程序】（miniapp）时，可更新的字段信息如下
'."\n"
."\n"
.'- "miniappId": "小程序唯一标识"'."\n"
.'- "title": 小程序名称"'."\n"
.'- "version": "版本号"'."\n"
.'- "description": "简要描述",'."\n"
.'- "detailDesc": "详细描述",'."\n"
.'- "slogan": "标语"'."\n"
.'- "icon": "图标URL",'."\n"
.'- "url": "小程序链接"'."\n"
.' '."\n"
.''."\n"
.'当类型为【商品】（product）时，可更新的字段信息如下
'."\n"
."\n"
.' - "title": "商品名称"'."\n"
.'- "description": "商品描述",'."\n"
.'- "icon": "商品图标URL",'."\n"
.'- "url": "商品链接",'."\n"
.'- "price": "价格",'."\n"
.'- "extra": "扩展字段，任意key-value对象"'."\n"
.' ', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
.' "title": "update title"'."\n"
.' }'],
],
'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' => 'FDE51A3B-09C0-57E5-96FC-31E85EEFF318'],
'data' => [
'description' => '请求返回结果。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '结构化元素类型',
'type' => 'string',
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp'],
'example' => 'miniapp',
],
'resourceId' => ['description' => '结构化元素资源 ID，是该资源在数据库中唯一且不可变的标识符', 'type' => 'string', 'example' => 'WzMGQZwB7nQEs3Qk3ajH'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新AISearch结构化资源',
'requestParamsDescription' => '字段 type 本质上为枚举类型，仅支持规定的取值范围，超出范围的值将导致接口无法正常工作；后续将根据需求扩展更多结构化内容。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FDE51A3B-09C0-57E5-96FC-31E85EEFF318\\",\\n \\"data\\": {\\n \\"type\\": \\"miniapp\\",\\n \\"resourceId\\": \\"WzMGQZwB7nQEs3Qk3ajH\\"\\n }\\n}","type":"json"}]',
],
'AISearchStream' => [
'path' => '/api/v1/aiSearch/searchStream',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'question' => ['description' => '用户问题', 'type' => 'string', 'required' => true, 'example' => '“my net is slow, what can I do?”'],
'message' => [
'description' => '历史对话记录list',
'type' => 'array',
'items' => ['description' => '历史对话记录', 'required' => false, '$ref' => '#/components/schemas/AISearchMessageItem'],
'required' => false,
],
'folderId' => ['description' => '文件夹ID，知识库检索功能会在当前文件夹以及子文件夹范围内检索问答内容', 'type' => 'string', 'required' => true, 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd'],
'resourceTypeNeeded' => [
'description' => '当前该列表仅支持填写三个枚举值：“text”（表示知识库检索）、“miniapp”（表示结构化元素中的小程序检索）以及 “product”（表示结构化元素中的商品检索）；若未填写，则默认对三种资源类型进行全部检索。',
'type' => 'array',
'items' => [
'description' => '检索资源类型',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['product' => 'product', 'miniapp' => 'miniapp', 'text' => 'text'],
'example' => '“text”',
],
'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' => '3F21E33A-42F8-50BC-89DE-DC0B96B967DD'],
'data' => ['description' => '返回数据', '$ref' => '#/components/schemas/AISearchStreamItem'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'AISearch检索对话',
'summary' => 'AISearch 问答接口，根据用户在数据库中存储的结构化元素信息以及知识库中的检索内容，生成对客户问题的回答。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3F21E33A-42F8-50BC-89DE-DC0B96B967DD\\",\\n \\"data\\": {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"“network problem can be”\\",\\n \\"params\\": \\" [{\\\\\\"type\\\\\\": \\\\\\"miniapp\\\\\\", \\\\\\"score\\\\\\": 0.7404107, \\\\\\"resourceId\\\\\\": \\\\\\"ja9bQZwBg5VwSU7n5Ijs\\\\\\", \\\\\\"miniappId\\\\\\": null, \\\\\\"title\\\\\\": \\\\\\"更新后的智能搜索测试助手\\\\\\", \\\\\\"version\\\\\\": \\\\\\"1.0.5\\\\\\", \\\\\\"description\\\\\\": \\\\\\"这是一个用于测试 AI 搜索功能的演示小程序\\\\\\", \\\\\\"slogan\\\\\\": \\\\\\"搜索即所得\\\\\\", \\\\\\"icon\\\\\\": \\\\\\"https://img.alicdn.com/test_icon.png\\\\\\", \\\\\\"url\\\\\\": null, \\\\\\"detailDescription\\\\\\": \\\\\\"该小程序提供了完整的 AI 搜索链路测试。\\\\\\"}]\\"\\n }\\n}","type":"json"}]',
],
'AddFolder' => [
'summary' => '创建文件夹'."\n"
.'对用户而言，同一个父目录下不得存在两个同名的文件夹'."\n"
.'创建成功则返回一个实体，包含该文件夹的基本信息',
'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' => '请求Body参数',
'type' => 'object',
'properties' => [
'folderName' => ['description' => '文件夹名称，调用者自拟', 'type' => 'string', 'required' => true, 'example' => '“abc” “1234”'],
'parentFolderId' => ['description' => '该文件夹的父文件夹Id；特别地，“0”代表根目录', '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' => '请求id', 'type' => 'string', 'example' => 'E38E561C-B996-0E19-8DBC-A218AAE17FBA'],
'data' => ['description' => '创建的文件夹数据结构', '$ref' => '#/components/schemas/FolderItem'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建文件夹',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'energy:AddFolder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E38E561C-B996-0E19-8DBC-A218AAE17FBA\\",\\n \\"data\\": {\\n \\"folderId\\": \\"4b648f6d11344f258df876cbdc24dc1f\\",\\n \\"folderNum\\": 2,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"“abc” “1234”\\",\\n \\"parentFolderId\\": \\"\\\\\\"0\\\\\\" ：parent folder is root\\\\n\\\\\\"4b648f6d11344f258df876cbdc24dc1f\\\\\\" ： folderId\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 1,\\n \\"syncStatus\\": -1,\\n \\"syncParsingStatus\\": -1,\\n \\"ossDomain\\": \\"aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com\\\\t\\",\\n \\"ossUpdateBy\\": \\"1696462764375572\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"folder/manual/\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"test/\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"4b648f6d11344f258df876cbdc24dc1f\\",\\n \\"folderNum\\": 2,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"“abc” “1234”\\",\\n \\"parentFolderId\\": \\"\\\\\\"0\\\\\\" ：parent folder is root\\\\n\\\\\\"4b648f6d11344f258df876cbdc24dc1f\\\\\\" ： folderId\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 1,\\n \\"syncStatus\\": -1,\\n \\"syncParsingStatus\\": -1,\\n \\"ossDomain\\": \\"aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com\\\\t\\",\\n \\"ossUpdateBy\\": \\"1696462764375572\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"folder/manual/\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"test/\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"4b648f6d11344f258df876cbdc24dc1f\\",\\n \\"folderNum\\": 2,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"“abc” “1234”\\",\\n \\"parentFolderId\\": \\"\\\\\\"0\\\\\\" ：parent folder is root\\\\n\\\\\\"4b648f6d11344f258df876cbdc24dc1f\\\\\\" ： folderId\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 1,\\n \\"syncStatus\\": -1,\\n \\"syncParsingStatus\\": -1,\\n \\"ossDomain\\": \\"aidoc-energy-api-example.oss-cn-hangzhou.aliyuncs.com\\\\t\\",\\n \\"ossUpdateBy\\": \\"1696462764375572\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"folder/manual/\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"test/\\",\\n \\"subFolderList\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'AnalyzeVlRealtime' => [
'summary' => '实时VL信息抽取',
'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' => 'fileUrl/fileUrlObject二选一：'."\n"
."\n"
.'- fileUrl：以文档URL方式使用，单个文档（支持1000页以内、100MB以内的文档）'."\n"
."\n"
.'- fileUrlObject：以本地文件上传方式调用接口时使用，单个文档（支持1000页以内、100 MB以内的文档）'."\n"
."\n"
.'> 支持格式如下：'."\n"
.'> - bmp, jpe, jpg, jpeg, png, tif, tiff, webp, heic', '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' => '文件名需带文件类型后缀', 'type' => 'string', 'required' => false, 'example' => 'test.png'],
],
[
'name' => 'templateId',
'in' => 'query',
'schema' => ['description' => '唯一的抽取模板ID，用于指定文档要抽取的内容，需登录模板管理页面配置模板后获取对应的模板ID。', 'type' => 'string', 'required' => false, 'example' => '572d24k0c95a'],
],
[
'name' => 'language',
'in' => 'query',
'schema' => ['description' => '语言，可传参数'."\n"
.'- zh-CN：中文（默认）'."\n"
.'- en-US：英语'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'kvListInfo' => [
'description' => '文档抽取结果详情',
'type' => 'array',
'items' => [
'description' => '文档抽取结果详情',
'type' => 'object',
'properties' => [
'keyName' => ['description' => '字段Key名称', 'type' => 'string', 'example' => '租户'],
'keyValue' => ['description' => '字段key值', 'type' => 'string', 'example' => '阿里云xxx有限公司'],
'context' => [
'description' => '召回内容',
'type' => 'object',
'properties' => [
'key' => [
'description' => 'key的召回信息详情',
'type' => 'array',
'items' => ['description' => 'key的召回信息详情', 'example' => 'bhv_trace_info_invalid', '$ref' => '#/components/schemas/ContentItem'],
],
'value' => [
'description' => 'value的召回信息详情',
'type' => 'array',
'items' => ['description' => 'value的召回信息详情', 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', '$ref' => '#/components/schemas/ContentItem'],
],
'confidence' => [
'description' => '置信度',
'type' => 'object',
'properties' => [
'keyConfidence' => ['description' => 'key的置信度', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146'],
'valueConfidence' => ['description' => '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\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取VL实时解析结果',
'description' => '用户通过上传文档url，获取VL实时返回结果。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeVlRealtime'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:AnalyzeVlRealtime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'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' => '场站id', 'type' => 'string', 'required' => true, 'example' => '***'],
'pKey' => ['description' => '调用方来源', 'type' => 'string', 'required' => false, 'example' => 'ib'],
'statusList' => ['description' => '指令列表', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "systemId": "system1",'."\n"
.' "strategyId": "10324",'."\n"
.' "controlId": "aaaaa-bbbbbb-cccc",'."\n"
.' "propertyCode": "startUp",'."\n"
.' "propertyValue": "20.1",'."\n"
.' "sendTimestamp": "1000000001",'."\n"
.' "executeTimestamp": "1000000008",'."\n"
.' "status": "Auto-executed",'."\n"
.' "remark": "Execution reason"'."\n"
.' },'."\n"
.' {'."\n"
.' "systemId": "system1",'."\n"
.' "strategyId": "10324",'."\n"
.' "controlId": "aaaaa-bbbbbb-cccc",'."\n"
.' "propertyCode": "startUp",'."\n"
.' "propertyValue": "20.1",'."\n"
.' "sendTimestamp": "1000000001",'."\n"
.' "executeTimestamp": "1000000008",'."\n"
.' "status": "Auto-executed",'."\n"
.' "remark": "Execution reason"'."\n"
.' }'."\n"
.']'],
],
'required' => false,
],
],
],
'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' => '策略执行状态反馈',
'changeSet' => [
['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSaveInstructionStatus'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:BatchSaveInstructionStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'BatchUpdateSystemRunningPlan' => [
'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' => '场站id', 'type' => 'string', 'required' => true, 'example' => '***'],
'systemId' => ['description' => '站点id', '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' => [],
],
'title' => '批量更新空调站点运行计划',
'summary' => '批量设置空调站点运行计划。',
'changeSet' => [
['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateSystemRunningPlan'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:BatchUpdateSystemRunningPlan',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'Chat' => [
'summary' => '本接口在用户选择的文档目录范围内，结合会话内的历史问答作为上下文，提供基于知识库文档的服务',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'sessionId' => ['description' => '- 问答会话ID。'."\n"
.'- 可以通过GetSessionList获取历史会话。'."\n"
.'- 也可以通过CreateChatSession创建新的会话。', 'type' => 'string', 'required' => true, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646'],
'question' => ['description' => '问答内容。', 'type' => 'string', 'required' => true, 'example' => 'How to obtain knowledge base Q&A documents'],
'documentIds' => [
'title' => '（可选）传入问答参考的文件id列表。若在创建问答session时已经指定了文件夹，则务必',
'description' => '选择文件列表进行问答'."\n"
.'>若用户选择传入此参数，请务必保证同时传入的sessionId在创建时填入的文件夹id为空串>',
'type' => 'array',
'items' => ['description' => '- 文件id'."\n"
.'- 可通过SaaS页面获取或通过sdk中其他相关接口获取（如DetailDocument接口）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3456'],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '问答详情信息。', '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\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"默认文件夹\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n}","type":"json"}]',
'title' => '文档问答',
'description' => '- 接口在会话选择的目录范围内提供问答服务。'."\n"
.'- sessionId信息通过GetChatSessionList获取。'."\n"
.'- 同时可以通过CreateChatSession接口创建新的会话。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:Chat',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ChatStream' => [
'summary' => '本接口在用户选择的文档目录范围内，结合会话内的历史问答作为上下文，提供基于知识库文档的流式问答服务',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'sessionId' => ['description' => '- 问答会话ID。'."\n"
.'- 可以通过GetSessionList获取历史会话。'."\n"
.'- 也可以通过CreateChatSession创建新的会话。', 'type' => 'string', 'required' => true, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646'],
'question' => ['description' => '问答内容。', 'type' => 'string', 'required' => true, 'example' => 'How to obtain knowledge base Q&A documents'],
'documentIds' => [
'description' => '- 选择文件列表进行问答'."\n"
.'>若用户选择传入此参数，请务必保证同时传入的sessionId在创建时填入的文件夹id为空串>',
'type' => 'array',
'items' => ['description' => '- 文件id'."\n"
.'- 可通过SaaS页面获取或通过sdk中其他相关接口获取（如DetailDocument接口）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3456'],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '问答详情信息。', '$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\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"默认文件夹\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n}","type":"json"}]',
'title' => '流式问答',
'description' => '- 接口在会话选择的目录范围内提供问答服务。'."\n"
.'- sessionId信息通过GetChatSessionList获取。'."\n"
.'- 同时可以通过CreateChatSession接口创建新的会话。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:ChatStream',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateChatSession' => [
'summary' => '每个用户可以根据需要创建会话，建议根据用户的使用场景区分不同的会话。'."\n"
.'在每个会话中，系统会自动将部分历史问答作为上下文，从而为最新一轮的问答交互提供更精准的回答。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'userId' => ['description' => '用户的唯一标识，如果不填写默认使用sdk调用账号作为用户ID。', 'type' => 'string', 'required' => false, 'example' => '12344'],
'folderId' => ['description' => '- 文件夹ID，知识库问答功能会在当前文件夹以及子文件夹范围内检索问答内容'."\n"
.'>若填入空字符串则表示根据自定义的文件列表做问答，此时需要配合问答接口（Chat / ChatStream）进行使用，并且必须在问答接口中传入文件id列表（详情请见Chat / ChatStream 接口说明文档），否则无法正常使用>', 'type' => 'string', 'required' => true, 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd'],
'name' => ['description' => '当前会话名称。', 'type' => 'string', 'required' => true, 'example' => 'analyzer_1744684195'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9bc20a5a-b26b-4c28-922a-7cd10b61f96f'],
'data' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'sessionId' => ['description' => '问答会话ID，用于记录同一个用户的多次问答。', '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' => '创建问答会话',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatSession'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:CreateChatSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteDocument' => [
'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' => '任务id，可从产品前端界面或其他接口获取', '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'],
'title' => '删除解析过的文件',
'summary' => '删除解析过的文件'."\n"
.'通过传递目标删除文件对应的任务id来调用，删除成功则返回true，否则返回false',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'energy:DeleteDocument',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'DeleteFolder' => [
'path' => '/api/v1/aidoc/folder/delete',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREenergyexpertK979RQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'folderId',
'in' => 'query',
'schema' => ['description' => '文件夹id', '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' => '请求id', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '成功删除则返回true', 'type' => 'boolean'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除文件夹',
'summary' => '删除文件夹'."\n"
.'删除成功则返回布尔值true，若删除不存在的文件夹则产生4xx错误（The folder does not exist.）',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'energy:DeleteFolder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'DetailDocument' => [
'summary' => '通过任务id获取文档的详细信息。',
'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' => '任务id，可从产品前端界面或其他接口获取', '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'],
'title' => '获取文档信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'energy:DetailDocument',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"id\\": 6731,\\n \\"folderId\\": \\"adafb91d4e014e2eb4d0a5375b547115\\",\\n \\"folderName\\": \\"123/abc/ 文件夹1\\",\\n \\"jobId\\": \\"74ec62f4f4e74e5882d4086a40f2b9c6\\",\\n \\"jobStatus\\": \\"PARSING_COMPLETED\\",\\n \\"docName\\": \\"123/abc/ 文档1.pdf\\",\\n \\"originDocName\\": \\"123/abc/ 文档1.pdf/.doc/docx/csv/xlsx/txt\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/docName\\",\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/originDocName\\",\\n \\"docHash\\": \\"5335c8828ccf735a500ed636590c713a94daf6cdacc90237733035cc5a152afb_1760513801010\\",\\n \\"createTime\\": \\"2025-09-08T17:04:28.000+08:00\\",\\n \\"updateTime\\": \\"2025-09-08T17:04:28.000+08:00\\"\\n }\\n}","type":"json"}]',
],
'EditProhibitedDevices' => [
'path' => '/api/v1/carbon/hvac/editProhibitedDevices',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREenergyexpertYUWSCO'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'factoryId' => ['description' => '场站id', 'type' => 'string', 'required' => true, 'example' => '***'],
'systemId' => ['description' => '站点id', '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' => '设备id', 'type' => 'string', 'required' => false, 'example' => 'id1'],
'deviceType' => [
'description' => '设备类型（请确保输入的是数字，而不是冒号前的文本）。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['空调机组' => '6', '锅炉' => '7', '冷机' => '1', '冷却塔' => '2', '水泵' => '3', '室内环境' => '4'],
'example' => '1',
],
'isForbidden' => [
'description' => '是否禁用：1，0',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => ['不禁用' => '0', '是禁用' => '1'],
'example' => '1',
],
'isUnfavorableArea' => ['description' => '是否不利区：1，0', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'buildingId' => ['description' => '楼栋id', 'type' => 'string', 'required' => false, 'example' => 'build_01'],
'floorId' => ['description' => '楼层id', 'type' => 'string', 'required' => false, 'example' => 'floor_01'],
'fenceId' => ['description' => '围栏id', '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' => [],
],
'title' => '编辑禁用设备',
'summary' => '编辑禁用设备',
'requestParamsDescription' => 'deviceType、isForbidden是必传参数，不需要传isUnfavorableArea。deviceType取值有1（冷机）、2（冷却塔）、3（水泵）、4（室内环境）、6（空调机组）、7（锅炉）。deviceType取数为1，2，3，6，7时，deviceId是必传字段，不需要传入buildingId、floorId和fenceId。deviceType取数为4时，不传deviceId、deviceName，需要传入buildingId、floorId和fenceId。',
'changeSet' => [
['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditProhibitedDevices'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:EditProhibitedDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'EditUnfavorableAreaDevices' => [
'path' => '/api/v1/carbon/hvac/editUnfavorableAreaDevices',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREenergyexpertYUWSCO'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'factoryId' => ['description' => '场站id', 'type' => 'string', 'required' => true, 'example' => '***'],
'systemId' => ['description' => '站点id', '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' => '设备id', 'type' => 'string', 'required' => false, 'example' => 'id1'],
'deviceType' => [
'description' => '设备类型(请输入枚举数值)',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['空调机组' => '6', '锅炉' => '7', '冷机' => '1', '冷却塔' => '2', '水泵' => '3', '室内环境' => '4'],
'example' => '1',
],
'isForbidden' => [
'description' => '是否禁用：1，0',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => ['不是禁用设备' => '0', '是禁用设备' => '1'],
'example' => '1',
],
'isUnfavorableArea' => [
'description' => '是否不利区：1，0',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => ['是不利区' => '1', '不是不利区' => '0'],
'example' => '1',
],
'buildingId' => ['description' => '楼栋id', 'type' => 'string', 'required' => false, 'example' => 'buildingId1'],
'floorId' => ['description' => '楼层id', 'type' => 'string', 'required' => false, 'example' => 'floorId2'],
'fenceId' => ['description' => '围栏id', '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' => [],
],
'title' => '编辑不利区设备',
'summary' => '编辑不利区设备',
'requestParamsDescription' => 'deviceType、isUnfavorableArea是必传参数，不需要传isForbidden。deviceType取值有1（冷机）、2（冷却塔）、3（水泵）、4（室内环境）、6（空调机组）、7（锅炉）。deviceType取数为1，2，3，6，7时，deviceId是必传字段，不需要传入buildingId、floorId和fenceId。deviceType取数为4时，不传deviceId、deviceName，需要传入buildingId、floorId和fenceId。',
'changeSet' => [
['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditUnfavorableAreaDevices'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:EditUnfavorableAreaDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'GenerateResult' => [
'summary' => '生成指定碳足迹的报告。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', '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' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '返回数据，true表示请求成功，false表示请求失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
'title' => '生成碳足迹结果',
'description' => '用户指定产品id，本接口产生一个任务，用于生成对应产品的碳足迹结果。任务状态可通过生成报告完成状态查询接口获得。结果生成后，其余结果查询页的显示内容方可调用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateResult'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GenerateResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetAreaElecConstitute' => [
'summary' => '本接口用于获取电力场站分析数据。',
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业code。', 'type' => 'string', 'required' => true, 'example' => 'Z-20240115-2'],
'year' => ['description' => '年份。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'water' => [
'description' => '各企业的水电用电和碳排等数据。',
'type' => 'array',
'items' => ['description' => '各企业的水电用电和碳排等数据结构体。', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem'],
],
'light' => [
'description' => '各企业的光电用电和碳排等数据。',
'type' => 'array',
'items' => ['description' => '各企业的光电用电和碳排等数据结构体。', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem'],
],
'urban' => [
'description' => '各企业的市电用电和碳排等数据。',
'type' => 'array',
'items' => ['description' => '各企业的市电用电和碳排等数据结构体。', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem'],
],
'wind' => [
'description' => '各企业的风电用电和碳排等数据。',
'type' => 'array',
'items' => ['description' => '各企业的风电用电和碳排等数据结构体。', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem'],
],
'nuclear' => [
'description' => '各企业的核电用电和碳排等数据。',
'type' => 'array',
'items' => ['description' => '各企业的核电用电和碳排等数据用电量。', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem'],
],
'renewing' => [
'description' => '各企业的可再生电用电和碳排等数据。',
'type' => 'array',
'items' => ['description' => '各企业的可再生电用电和碳排等数据用电量。', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem'],
],
'zero' => [
'description' => '各企业的零电用电和碳排等数据。',
'type' => 'array',
'items' => ['description' => '各企业的零电用电和碳排等数据结构体。', '$ref' => '#/components/schemas/CarbonEmissionElecSummaryItem'],
],
],
],
'code' => ['description' => '请求返回 code，Success 代表请求成功，其他情况代表请求不成功，具体错误原因描述可通过 msg 查看。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"water\\": [\\n {\\n \\"carbonEmissionData\\": 1.22,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.22,\\n \\"dataUnit\\": \\"kg\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 1.22,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.22,\\n \\"dataUnit\\": \\"kg\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 1.22,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.22,\\n \\"dataUnit\\": \\"kg\\",\\n \\"name\\": \\"xxx\\"\\n }\\n ],\\n \\"wind\\": [],\\n \\"nuclear\\": [],\\n \\"renewing\\": [],\\n \\"zero\\": []\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]',
'title' => '场站电力分析',
'description' => '- 获取末级电力分析数据。'."\n"
.'- 当code选择不同层级企业时，对当前层级下的企业进行分析。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAreaElecConstitute'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetAreaElecConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetCarbonEmissionTrend' => [
'summary' => '获取碳排放趋势。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业code', 'type' => 'string', 'required' => true, 'example' => 'C-20240119-1'],
'yearList' => [
'description' => '盘查年份列表',
'type' => 'array',
'items' => ['description' => '盘查年份', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
'required' => true,
],
'moduleType' => ['description' => '模块类型', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'moduleCode' => ['description' => '模块代码', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions'],
'trendType' => ['description' => '趋势类型', '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' => '返回数据',
'type' => 'object',
'properties' => [
'targetEmissionList' => [
'description' => '目标排放列表',
'type' => 'array',
'items' => [
'description' => '目标排放值',
'type' => 'object',
'properties' => [
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
'items' => [
'description' => '数据项列表',
'type' => 'array',
'items' => [
'description' => '数据项',
'type' => 'object',
'properties' => [
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'carbonEmissionData' => ['description' => '碳排放量', 'type' => 'number', 'format' => 'double', 'example' => '20.22'],
],
],
],
],
],
],
'actualEmissionList' => [
'description' => '实际排放列表',
'type' => 'array',
'items' => [
'description' => '实际排放值',
'type' => 'object',
'properties' => [
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
'items' => [
'description' => '数据项列表',
'type' => 'array',
'items' => [
'description' => '数据项',
'type' => 'object',
'properties' => [
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'carbonEmissionData' => ['description' => '碳排放量', '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' => '获取碳排趋势',
'description' => '本接口的返回值是某组织的在不同月份的碳排列表，可以反映该组织的碳排随时间的变化趋势。使用本接口需要传入以下参数：'."\n"
.'- 企业的唯一标识符'."\n"
.'- 碳排统计年份'."\n"
.'- 统计模块类型信息'."\n"
.'- 所需的趋势类型',
'changeSet' => [
['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCarbonEmissionTrend'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetCarbonEmissionTrend',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetChatFolderList' => [
'summary' => '获取问答目录列表',
'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' => '返回结果。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A8AEC6D9-A359-5169-BD1A-BD848BA60D65'],
'data' => [
'description' => '返回数据',
'type' => 'array',
'items' => ['description' => '目录的详细信息。', 'example' => 'true', '$ref' => '#/components/schemas/ChatFolderItem'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取问答目录列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatFolderList'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetChatFolderList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": [\\n {\\n \\"subFolders\\": [\\n {\\n \\"question\\": \\"如何使用知识库。\\",\\n \\"answer\\": \\"未找到相关内容\\",\\n \\"createTime\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"默认文件夹\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n ],\\n \\"folderName\\": \\"默认文件夹。\\",\\n \\"folderId\\": \\"aaa\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetChatList' => [
'path' => '/api/v2/aidoc/document/chat/list',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'sessionId' => ['description' => '问答会话ID，用于记录同一个用户的多次问答。', 'type' => 'string', 'required' => true, 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646'],
'currentPage' => ['description' => '分页参数，页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"],
'data' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '21'],
'totalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'currentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'chatList' => [
'description' => '问答列表。',
'type' => 'array',
'items' => ['description' => '一轮问答详情信息。', '$ref' => '#/components/schemas/ChatItem'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取问答列表',
'summary' => '获取一个会话的历史问答。',
'description' => '- 本接口通过传入的会话ID获取会话内的历史文档列表。'."\n"
.'- sessionId信息通过GetChatSessionList获取。'."\n"
.'- 同时可以通过CreateChatSession接口创建新的会话。',
'changeSet' => [
['createdAt' => '2025-06-18T03:15:16.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatList'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetChatList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"chatList\\": [\\n {\\n \\"question\\": \\"如何使用知识库。\\",\\n \\"answer\\": \\"未找到相关内容\\",\\n \\"createTime\\": 1747280158000,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"a.pdf\\",\\n \\"sourceType\\": \\"doc\\",\\n \\"docUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf\\",\\n \\"docInfo\\": {\\n \\"pages\\": 23,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 23,\\n \\"imageUrl\\": \\"2\\",\\n \\"pageIdCurDoc\\": 2,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"null\\",\\n \\"wordParseResult\\": \\"null\\",\\n \\"pdfParseResult\\": \\"null\\",\\n \\"imageHeight\\": 22\\n }\\n ]\\n },\\n \\"originDocName\\": \\"a.doc\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 22,\\n \\"y\\": 86\\n }\\n ]\\n ],\\n \\"num\\": 12\\n }\\n ],\\n \\"originDocUrl\\": \\"https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc\\"\\n }\\n ],\\n \\"folderName\\": \\"默认文件夹\\",\\n \\"folderId\\": \\"7708fddb-21dc-4403-a4ea-5b94eccce4c3\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetChatSessionList' => [
'summary' => '获取用户问答会话列表。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'name' => ['description' => '会话名称。', 'type' => 'string', 'required' => false, 'example' => 'oklabs'],
'userId' => ['description' => '用户的唯一标识，如果不填写默认使用sdk调用账号作为用户ID。', 'type' => 'string', 'required' => false, 'example' => '12222'],
'currentPage' => ['description' => '分页参数，页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
'pageSize' => ['description' => '分页大小，默认10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"],
'data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'sessionList' => [
'description' => '会话列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'sessionId' => ['description' => '问答会话ID，用于记录同一个用户的多次问答。', 'type' => 'string', 'example' => '5c748ef9-3f23-4b5a-916f-966c0d2c6dcd'],
'name' => ['description' => '会话名称', 'type' => 'string', 'example' => 'student_app_spelling'],
'userId' => ['description' => '当前会话的用户ID。', 'type' => 'string', 'example' => '12222'],
'folderId' => ['description' => '文件夹ID，用于指定查询的文档范围。', 'type' => 'string', 'example' => '3493370b-4884-47dd-95ed-49038769af53'],
'createTime' => ['description' => '报告创建时间戳，格式为毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-01-01T14:45:17Z'],
'updateTime' => ['description' => '修改时间，格式为毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-12-30T02:05:03Z'],
],
'description' => '',
],
],
'total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '21'],
'totalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'currentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取文档会话列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetChatSessionList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"sessionList\\": [\\n {\\n \\"sessionId\\": \\"5c748ef9-3f23-4b5a-916f-966c0d2c6dcd\\",\\n \\"name\\": \\"student_app_spelling\\",\\n \\"userId\\": \\"12222\\",\\n \\"folderId\\": \\"3493370b-4884-47dd-95ed-49038769af53\\",\\n \\"createTime\\": 0,\\n \\"updateTime\\": 0\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10\\n }\\n}","type":"json"}]',
],
'GetDataItemList' => [
'summary' => '本接口用于获取数据项详情列表。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码', 'type' => 'string', 'required' => true, 'example' => 'C-202302-01'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'unit' => ['description' => '单位', 'type' => 'string', 'example' => 'kg'],
'period' => ['description' => '数据填报方式，'."\n"
.'1：月度值 2：年度值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'code' => ['description' => 'API数据标识。', 'type' => 'string', 'example' => 'demo_api_code'],
'name' => ['description' => '数据项名称。', 'type' => 'string', 'example' => 'Boiler data'],
],
'description' => '',
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"unit\\": \\"kg\\",\\n \\"period\\": 1,\\n \\"code\\": \\"demo_api_code\\",\\n \\"name\\": \\"Boiler data\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取数据项详情列表',
'description' => '- 用于获取当前企业下数据项详情列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataItemList'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDataItemList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDataQualityAnalysis' => [
'summary' => '获取数据质量评价结果DQR、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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'dataQualityEvaluationType' => ['description' => '数据质量评估类型：1是DQI、2是DQR。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'dataQuality' => [
'description' => '各清单的得分。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'inventory' => ['description' => '清单名称。', 'type' => 'string', 'example' => 'Process-1/Checklist-1'],
'score' => [
'description' => '得分。分布范围1~5，越接近1表示数据质量越好。',
'type' => 'object',
'properties' => [
'g1' => ['description' => '数据质量评价指标1：活动数据可信度', 'type' => 'number', 'format' => 'double', 'example' => '3'],
'g2' => ['description' => '数据质量评价指标2：因子数据可信度', 'type' => 'number', 'format' => 'double', 'example' => '3'],
'g3' => ['description' => '数据质量评价指标3：时间代表性', 'type' => 'number', 'format' => 'double', 'example' => '3'],
'g4' => ['description' => '数据质量评价指标4：地理代表性', 'type' => 'number', 'format' => 'double', 'example' => '3'],
],
],
],
'description' => '',
],
],
'dataQualityResult' => [
'description' => '指标得分',
'type' => 'object',
'properties' => [
'data_quality_score' => ['description' => '评分。适用于DQR结果，分布范围1~5，越接近1表示数据质量越好，有效位数保留小数点后4位。', 'type' => 'number', 'format' => 'double', 'example' => '1.2345'],
'g1' => ['description' => '数据质量评价指标1：活动数据可信度', 'type' => 'number', 'format' => 'double', 'example' => '1.2345'],
'g2' => ['description' => '数据质量评价指标2：因子数据可信度', 'type' => 'number', 'format' => 'double', 'example' => '1.2345'],
'g3' => ['description' => '数据质量评价指标3：时间代表性', 'type' => 'number', 'format' => 'double', 'example' => '1.2345'],
'g4' => ['description' => '数据质量评价指标4：地理代表性', 'type' => 'number', 'format' => 'double', 'example' => '1.2345'],
],
],
'sensitivityList' => [
'description' => '敏感度分析列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'id' => ['description' => '清单项id', 'type' => 'string', 'example' => '1'],
'inventory' => ['description' => '清单项的名称', 'type' => 'string', 'example' => 'Inventory 1'],
'reductionList' => [
'description' => '减排措施列表',
'type' => 'array',
'items' => ['description' => '清单项的减排措施', 'type' => 'string', 'example' => '措施1'],
],
'sensitivity' => ['description' => '灵敏度百分比', 'type' => 'number', 'format' => 'double', 'example' => '91.7'],
],
'description' => '',
],
],
'uncertainty' => ['description' => '不确定性值。模型整体不确定性百分比结果，"10.00"表示10.00%的不确定性，代表碳足迹结果在±10.00%的范围。由单一清单的不确定性贡献加权叠加得到。', 'type' => 'string', 'example' => '10.00'],
'uncertaintyValues' => [
'description' => '不确定性列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'inventory' => ['description' => '清单名称。格式为：工序名/清单名。', 'type' => 'string', 'example' => '工序-1/清单-1'],
'uncertaintyContribution' => ['description' => '清单的不确定性绝对贡献大小。建模过程中的各清单数据质量对碳足迹结果的影响，当某个清单的不确定贡献大时，请尽可能提高它的数据质量以提升碳足迹分析准确度。 "1.4964"的含义是不确定贡献了1.4964 kgCO₂e/unit，其中unit为产品的单位。', 'type' => 'string', 'example' => '1.4964'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"dataQuality\\": [\\n {\\n \\"inventory\\": \\"Process-1/Checklist-1\\",\\n \\"score\\": {\\n \\"g1\\": 3,\\n \\"g2\\": 3,\\n \\"g3\\": 3,\\n \\"g4\\": 3\\n }\\n }\\n ],\\n \\"dataQualityResult\\": {\\n \\"data_quality_score\\": 1.2345,\\n \\"g1\\": 1.2345,\\n \\"g2\\": 1.2345,\\n \\"g3\\": 1.2345,\\n \\"g4\\": 1.2345\\n },\\n \\"sensitivityList\\": [\\n {\\n \\"id\\": \\"1\\",\\n \\"inventory\\": \\"Inventory 1\\",\\n \\"reductionList\\": [\\n \\"措施1\\"\\n ],\\n \\"sensitivity\\": 91.7\\n }\\n ],\\n \\"uncertainty\\": \\"10.00\\",\\n \\"uncertaintyValues\\": [\\n {\\n \\"inventory\\": \\"工序-1/清单-1\\",\\n \\"uncertaintyContribution\\": \\"1.4964\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取数据质量评价结果DQR、DQI',
'description' => '用户指产品id，本接口返回获得已经生成结果页中的数据质量评价结果。可用于了解产品各清单的碳排因子的数据质量。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataQualityAnalysis'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDataQualityAnalysis',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDeviceInfo' => [
'summary' => '查询账号激活场站的设备信息。',
'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' => '场站id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pn_95'],
],
[
'name' => 'deviceId',
'in' => 'query',
'schema' => ['description' => '设备id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pn_69873'],
],
[
'name' => 'ds',
'in' => 'query',
'schema' => ['description' => '时间字符串，时间格式为YYYY-mm-dd', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-07-26'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'code' => ['description' => '请求返回 code，Success 代表请求成功，其他情况代表请求不成功，具体错误原因描述可通过 msg 查看。'."\n"
."\n", 'type' => 'string', 'example' => 'Success'],
'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'data' => [
'description' => '返回信息',
'type' => 'object',
'properties' => [
'deviceId' => ['description' => '设备id', 'type' => 'string', 'example' => 'pn_69873'],
'deviceName' => ['description' => '设备名称', 'type' => 'string', 'example' => 'Main transformer #4'],
'firstTypeName' => ['description' => '表计一级类型', 'type' => 'string', 'example' => 'Electric meter'],
'secondTypeName' => ['description' => '表计二级类型', 'type' => 'string', 'example' => 'Gateway meter'],
'recordList' => [
'description' => '参数列表',
'type' => 'array',
'items' => [
'description' => '设备信息',
'type' => 'object',
'properties' => [
'statisticsDate' => ['description' => '统计日期', 'type' => 'string', 'example' => '2022-07-26 00:00:00'],
'paramName' => ['description' => '参数名称', 'type' => 'string', 'example' => 'Phase A current'],
'unit' => ['description' => '单位', 'type' => 'string', 'example' => 'A'],
'identifier' => ['description' => '设备标识符', 'type' => 'string', 'example' => 'Ia'],
'type' => ['description' => '测点类型', 'type' => 'string', 'example' => 'DOUBLE'],
'value' => ['description' => '数值', 'type' => 'number', 'format' => 'double', 'example' => '20.00'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'invalidParameter', 'errorMessage' => 'Invalid parameter values.', 'description' => '请求参数错误，请检查方法入参'],
],
[
['errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', 'description' => '该账号没有API调用权限'],
],
500 => [
['errorCode' => 'systemError', 'errorMessage' => 'System error.', 'description' => '系统错误'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"Main transformer #4\\",\\n \\"firstTypeName\\": \\"Electric meter\\",\\n \\"secondTypeName\\": \\"Gateway meter\\",\\n \\"recordList\\": [\\n {\\n \\"statisticsDate\\": \\"2022-07-26 00:00:00\\",\\n \\"paramName\\": \\"Phase A current\\",\\n \\"unit\\": \\"A\\",\\n \\"identifier\\": \\"Ia\\",\\n \\"type\\": \\"DOUBLE\\",\\n \\"value\\": 20\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取设备数据',
'description' => '- 通过采集终端设备id，查询设备参数，如果是通过校验，可以查询接口信息，如果不是，返回空值。'."\n"
.'- 需要按天维度的时间，及对单个设备进行查询。如果数据不存在，则返回空值。'."\n"
.'- 目前接入点仅支持杭州`energyexpertexternal.cn-hangzhou.aliyuncs.com`'."\n"
.'- 使用该接口需要先开通白名单，请通过官网[联系我们](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) '."\n"
.'[联系我们](https://energy.alibabacloud.com/common?adapter=aliyun&lang=en-US#/home/en)进行开通。',
'changeSet' => [
['createdAt' => '2023-04-17T06:13:23.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceInfo'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'energy:GetDeviceInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDeviceList' => [
'summary' => '查询账号激活场站的设备列表。',
'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' => '场站id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pn_95'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'factoryId' => ['description' => '场站id', 'type' => 'string', 'example' => 'pn_95'],
'deviceList' => [
'description' => '设备列表',
'type' => 'array',
'items' => [
'description' => '设备列表',
'type' => 'object',
'properties' => [
'deviceId' => ['description' => '设备id', 'type' => 'string', 'example' => 'pn_69873'],
'deviceName' => ['description' => '设备名称', 'type' => 'string', 'example' => 'Main transformer #4'],
'firstTypeName' => ['description' => '表计一级类型', 'type' => 'string', 'example' => 'Electric meter'],
'secondTypeName' => ['description' => '表计二级类型', 'type' => 'string', 'example' => 'Gateway meter'],
'parentDevice' => ['description' => '上级设备', 'type' => 'string', 'example' => 'pn_6987'],
'info' => [
'description' => '设备信息',
'type' => 'object',
'properties' => [
'magnification' => ['description' => '倍率', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'pressure' => ['description' => '高低压', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'pt' => ['description' => '电压变比值', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'ct' => ['description' => '电流变比值', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'constKva' => ['description' => '额定容量。单位：kVA', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
],
'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'Success'],
'success' => ['description' => '表示实际请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'Success'],
'success' => ['description' => '表示实际请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'invalidParameter', 'errorMessage' => 'Invalid parameter values.', 'description' => '请求参数错误，请检查方法入参'],
],
[
['errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', 'description' => '该账号没有API调用权限'],
],
500 => [
['errorCode' => 'systemError', 'errorMessage' => 'System error.', 'description' => '系统错误'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"deviceList\\": [\\n {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"Main transformer #4\\",\\n \\"firstTypeName\\": \\"Electric meter\\",\\n \\"secondTypeName\\": \\"Gateway meter\\",\\n \\"parentDevice\\": \\"pn_6987\\",\\n \\"info\\": {\\n \\"magnification\\": 80,\\n \\"pressure\\": 0,\\n \\"pt\\": 80,\\n \\"ct\\": 1,\\n \\"constKva\\": 100\\n }\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n },\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]',
'title' => '获取设备列表',
'description' => '- 通过场站，查询采集终端设备，如果是通过校验，可以查询接口信息，如果不是，返回空值。'."\n"
.'- 如果场站虚拟表存在，则过滤掉虚拟表。'."\n"
.'- 目前接入点仅支持杭州`energyexpertexternal.cn-hangzhou.aliyuncs.com`'."\n"
.'- 使用该接口需要先开通白名单，请通过官网[联系我们](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) '."\n"
.'[联系我们](https://energy.alibabacloud.com/common?adapter=aliyun&lang=en-US#/home/en)进行开通。',
'changeSet' => [
['createdAt' => '2023-07-05T09:26:07.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-17T06:13:23.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceList'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'energy:GetDeviceList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDocExtractionResult' => [
'summary' => '用于文档信息抽取结果查询。'."\n"
.'入参taskId来自接口SubmitDocExtractionTaskAdvance、SubmitDocExtractionTask返回结果中taskId。'."\n"
.'查询结果有处理中、处理成功、处理失败三种状态。',
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '- 任务ID。'."\n"
.'- taskId从SubmitDocExtractionTaskAdvance、SubmitDocExtractionTask接口获取。', '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' => '返回数据结构。',
'type' => 'object',
'properties' => [
'kvListInfo' => [
'description' => '文档解析结果详情',
'type' => 'array',
'items' => [
'description' => '文档解析结果详情',
'type' => 'object',
'properties' => [
'keyName' => ['description' => '字段Key名称', 'type' => 'string', 'example' => 'Tenant'],
'keyValue' => ['description' => '字段key值', 'type' => 'string', 'example' => 'Alibaba Cloud XXX Co., Ltd.'],
'context' => [
'description' => '召回内容',
'type' => 'object',
'properties' => [
'key' => [
'description' => 'key的召回信息详情',
'type' => 'array',
'items' => ['description' => 'key的召回信息详情', 'example' => 'bhv_trace_info_invalid', '$ref' => '#/components/schemas/ContentItem'],
],
'value' => [
'description' => 'value的召回信息详情',
'type' => 'array',
'items' => ['description' => 'value的召回信息详情', 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', '$ref' => '#/components/schemas/ContentItem'],
],
'confidence' => [
'description' => '置信度',
'type' => 'object',
'properties' => [
'keyConfidence' => ['description' => 'key的置信度', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146'],
'valueConfidence' => ['description' => '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\\": \\"Tenant\\",\\n \\"keyValue\\": \\"Alibaba Cloud XXX Co., Ltd.\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取RAG、长文本理解文档抽取结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocExtractionResult'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDocExtractionResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDocParsingResult' => [
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '- 任务ID。'."\n"
.'- taskId从SubmitDocParsingTaskAdvance、SubmitDocParsingTask接口获取。', 'type' => 'string', 'required' => true, 'example' => '2c22388d-e2ed-44fe-99e6-99922f15e7bb'],
'returnFormat' => [
'description' => '- 文件解析结果支持markdown、json两种方式。'."\n"
.' - 默认返回markdown格式。',
'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' => '返回结果。',
'type' => 'object',
'properties' => [
'content' => ['description' => '- 文件解析返回的解析内容。'."\n"
.'- 根据请求参数returnFormat返回，markdown格式或者json格式数据。具体格式参考：[json返回结构](https://help.aliyun.com/zh/energy-expert/developer-reference/content)[json返回结构](https://www.alibabacloud.com/help/zh/energy-expert/developer-reference/api-energyexpertexternal-2022-09-23-getdocparsingresult)', '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'],
'title' => '获取文档解析结果',
'summary' => '用于文档解析结果查询。'."\n"
.'入参taskId来自接口SubmitDocParsingTaskAdvance、SubmitDocParsingTask返回结果中的taskId。'."\n"
.'查询结果有处理中、处理成功、处理失败三种情况。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocParsingResult'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDocParsingResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'GetDocumentAnalyzeResult' => [
'summary' => '【重要】该接口不再维护，请使用getDocExtractionResult、GetVLExtractionResult获取抽取结果。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'jobId' => ['description' => '作业ID，指定要查询哪一个文档的解析结果。通过”提交文档解析作业“接口提交文档的返回参数。', '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' => '请求ID', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'kvListInfo' => [
'description' => '文档解析结果',
'type' => 'array',
'items' => [
'description' => '文档解析结果详情',
'type' => 'object',
'properties' => [
'keyName' => ['description' => '字段Key名称', 'type' => 'string', 'example' => 'Tenant'],
'keyValue' => ['description' => '字段key值', 'type' => 'string', 'example' => 'Alibaba Cloud XXX Co., Ltd.'],
'context' => [
'description' => '召回内容',
'type' => 'object',
'properties' => [
'key' => [
'description' => 'key的召回信息',
'type' => 'array',
'items' => ['description' => 'key的召回信息详情', '$ref' => '#/components/schemas/ContentItem'],
],
'value' => [
'description' => 'value的召回信息',
'type' => 'array',
'items' => ['description' => 'value的召回信息详情', '$ref' => '#/components/schemas/ContentItem'],
],
'confidence' => [
'description' => '置信度',
'type' => 'object',
'properties' => [
'keyConfidence' => ['description' => 'key的置信度', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146'],
'valueConfidence' => ['description' => '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\\": \\"Tenant\\",\\n \\"keyValue\\": \\"Alibaba Cloud XXX Co., Ltd.\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取文档解析结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentAnalyzeResult'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDocumentAnalyzeResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetElecConstitute' => [
'summary' => '本接口用于获取电力构成分析数据。',
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码', 'type' => 'string', 'required' => true, 'example' => 'C-20240202-01'],
'year' => ['description' => '年份', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'water' => [
'description' => '水电。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '2.1'],
'rawData' => ['description' => '用电量', 'type' => 'number', 'format' => 'double', 'example' => '1.2'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）', 'type' => 'number', 'format' => 'double', 'example' => '0.4'],
'dataUnit' => ['description' => '单位', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Hydropower'],
'nameKey' => ['description' => '名称标识', 'type' => 'string', 'example' => 'carbonInventory.check.water_electricity'],
],
],
'light' => [
'description' => '光电',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '1.2'],
'rawData' => ['description' => '用电量', 'type' => 'number', 'format' => 'double', 'example' => '1.2'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）', 'type' => 'number', 'format' => 'double', 'example' => '0.2'],
'dataUnit' => ['description' => '单位', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Solar power'],
'nameKey' => ['description' => '电力类型编码', 'type' => 'string', 'example' => 'carbonInventory.check.light_electricity'],
],
],
'urban' => [
'description' => '市电',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '1.2'],
'rawData' => ['description' => '用电量', 'type' => 'number', 'format' => 'double', 'example' => '1.2'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）', 'type' => 'number', 'format' => 'double', 'example' => '0.4'],
'dataUnit' => ['description' => '单位', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称', 'type' => 'string', 'example' => 'Grid power'],
'nameKey' => ['description' => '电力类型编码', 'type' => 'string', 'example' => 'carbonInventory.check.urban_electricity'],
],
],
'wind' => [
'description' => '风电',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '1.2'],
'rawData' => ['description' => '用电量', 'type' => 'number', 'format' => 'double', 'example' => '1.1'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）', 'type' => 'number', 'format' => 'double', 'example' => '0.3'],
'dataUnit' => ['description' => '单位', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称', 'type' => 'string', 'example' => 'Wind power'],
'nameKey' => ['description' => '电力类型编码', 'type' => 'string', 'example' => 'carbonInventory.check.wind_electricity'],
],
],
'nuclear' => [
'description' => '核电',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '2.3'],
'rawData' => ['description' => '用电量', 'type' => 'number', 'format' => 'double', 'example' => '2'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）', 'type' => 'number', 'format' => 'double', 'example' => '0.6'],
'dataUnit' => ['description' => '单位', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称', 'type' => 'string', 'example' => 'Nuclear power'],
'nameKey' => ['description' => '电力类型编码', 'type' => 'string', 'example' => 'carbonInventory.check.nuclear_electricity'],
],
],
'renewing' => [
'description' => '零碳电力',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '2.3'],
'rawData' => ['description' => '用电量', 'type' => 'number', 'format' => 'double', 'example' => '4.3'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）', 'type' => 'number', 'format' => 'double', 'example' => '0.44'],
'dataUnit' => ['description' => '单位', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称', 'type' => 'string', 'example' => 'Renewable energy power'],
'nameKey' => ['description' => '电力类型编码', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.keZaiShengZiYuan'],
],
],
'zero' => [
'description' => '零电',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '1.2'],
'rawData' => ['description' => '用电量', 'type' => 'number', 'format' => 'double', 'example' => '444.3'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）', 'type' => 'number', 'format' => 'double', 'example' => '0.33'],
'dataUnit' => ['description' => '单位', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称', 'type' => 'string', 'example' => 'Zero electricity'],
'nameKey' => ['description' => '电力类型编码', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi'],
],
],
],
],
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', '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\\": \\"Hydropower\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\"\\n },\\n \\"light\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.2,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Solar power\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\"\\n },\\n \\"urban\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.4,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Grid power\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\"\\n },\\n \\"wind\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.1,\\n \\"ratio\\": 0.3,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Wind power\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\"\\n },\\n \\"nuclear\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 2,\\n \\"ratio\\": 0.6,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Nuclear power\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\"\\n },\\n \\"renewing\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 4.3,\\n \\"ratio\\": 0.44,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Renewable energy power\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.keZaiShengZiYuan\\"\\n },\\n \\"zero\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 444.3,\\n \\"ratio\\": 0.33,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Zero electricity\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\"\\n }\\n },\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]',
'title' => '电力构成分析',
'description' => '本接口的返回值是某组织不同电力类型的能源产生的碳排量。 接口需要传入的参数为：'."\n"
.'- 企业的唯一标识符'."\n"
.'- 碳排统计年份',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecConstitute'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetElecConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetElecTrend' => [
'summary' => '本接口用于获取电力趋势分析数据。',
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业code。', 'type' => 'string', 'required' => true, 'example' => 'C-20240115-3'],
'yearList' => [
'description' => '年份列表。',
'type' => 'array',
'items' => ['description' => '年份。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2023'],
'required' => true,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'water' => [
'description' => '水电逐月用电和碳排等数据。',
'type' => 'array',
'items' => [
'description' => '水电逐月用电和碳排等数据结构体。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'rawData' => ['description' => '用电量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'dataUnit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Hydropower'],
'nameKey' => ['description' => '电力类型编码。', 'type' => 'string', 'example' => 'carbonInventory.check.water_electricity'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
],
],
],
'light' => [
'description' => '光电逐月用电和碳排等数据。',
'type' => 'array',
'items' => [
'description' => '光电逐月用电和碳排等数据结构体。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'rawData' => ['description' => '用电量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'dataUnit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Solar power'],
'nameKey' => ['description' => '电力类型编码。', 'type' => 'string', 'example' => 'carbonInventory.check.light_electricity'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
],
],
],
'urban' => [
'description' => '市电逐月用电和碳排等数据。',
'type' => 'array',
'items' => [
'description' => '市电逐月用电和碳排等数据结构体。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'rawData' => ['description' => '用电量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'dataUnit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Grid power'],
'nameKey' => ['description' => '电力类型编码。', 'type' => 'string', 'example' => 'carbonInventory.check.urban_electricity'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
],
],
],
'wind' => [
'description' => '风电逐月用电和碳排等数据。',
'type' => 'array',
'items' => [
'description' => '风电逐月用电和碳排等数据结构体。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'rawData' => ['description' => '用电量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'dataUnit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Wind power'],
'nameKey' => ['description' => '电力类型编码。', 'type' => 'string', 'example' => 'carbonInventory.check.wind_electricity'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
],
],
],
'nuclear' => [
'description' => '核电逐月用电和碳排等数据。',
'type' => 'array',
'items' => [
'description' => '核电逐月用电和碳排等数据结构体。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'rawData' => ['description' => '用电量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'dataUnit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Nuclear power'],
'nameKey' => ['description' => '电力类型编码。', 'type' => 'string', 'example' => 'carbonInventory.check.nuclear_electricity'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
],
],
],
'renewing' => [
'description' => '可再生电逐月用电和碳排等数据。',
'type' => 'array',
'items' => [
'description' => '可再生电逐月用电和碳排等数据结构体。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'rawData' => ['description' => '用电量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'dataUnit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Renewable electricity'],
'nameKey' => ['description' => '电力类型编码。', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
],
],
],
'zero' => [
'description' => '零电逐月用电和碳排等数据。',
'type' => 'array',
'items' => [
'description' => '零电逐月用电和碳排等数据结构体。',
'type' => 'object',
'properties' => [
'carbonEmissionData' => ['description' => '碳排量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'rawData' => ['description' => '用电量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '用电量占当月所有用电量的比例：示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'dataUnit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kWh'],
'name' => ['description' => '电力类型名称。', 'type' => 'string', 'example' => 'Zero electricity'],
'nameKey' => ['description' => '电力类型编码。', 'type' => 'string', 'example' => 'carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi'],
'month' => ['description' => '月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'year' => ['description' => '年份。', 'type' => 'string', 'example' => '2024'],
],
],
],
],
],
'code' => ['description' => '请求返回 code，Success 代表请求成功，其他情况代表请求不成功，具体错误原因描述可通过 msg 查看。', '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\\": \\"Hydropower\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Solar power\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Grid power\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"wind\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Wind power\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"nuclear\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Nuclear power\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"renewing\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Renewable electricity\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"zero\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"Zero electricity\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]',
'title' => '电力趋势分析',
'description' => '1. 本接口返回值是一个列表，该列表的每一个元素是各种类型电力的排放列表。'."\n"
.'2. 关于上述各种类型电力的排放列表，其元素包含：排放年份和月份、用电量及其单位、用电量对应的碳排，用电量占该月总用电量比例。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecTrend'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetElecTrend',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetEmissionSourceConstitute' => [
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业code', 'type' => 'string', 'required' => true, 'example' => 'C-20240119-1'],
'year' => ['description' => '盘查年份', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
'moduleType' => ['description' => '模块类型', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'],
'moduleCode' => ['description' => '模块代码', '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' => '返回数据',
'type' => 'array',
'items' => ['description' => '构成分析详情列表', '$ref' => '#/components/schemas/ConstituteItem'],
],
'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取排放源构成',
'summary' => '获取排放源构成。',
'description' => '本接口的返回值是某组织在各个排放源类型及各个排放设施碳排放详情，数据结构是一个三层树形结构。使用本接口需要传入以下参数：'."\n"
.'- 企业的唯一标识符'."\n"
.'- 碳排统计年份'."\n"
.'- 统计模块类型信息',
'changeSet' => [
['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSourceConstitute'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEmissionSourceConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"enterpriseName\\": \\"企业1\\",\\n \\"rawData\\": 1.2,\\n \\"carbonEmissionData\\": 3.222,\\n \\"ratio\\": 0.5,\\n \\"nameKey\\": \\"carbonInventory.check.indirect_emissions_from_imported_electricity\\",\\n \\"name\\": \\"电力\\",\\n \\"emissionSourceKey\\": \\"carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec\\",\\n \\"emissionSource\\": \\"GEC\\",\\n \\"dataUnit\\": \\"kWh\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"1\\",\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 4.33,\\n \\"carbonEmissionData\\": 1.2\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"企业1\\",\\n \\"rawData\\": 1.2,\\n \\"carbonEmissionData\\": 3.222,\\n \\"ratio\\": 0.5,\\n \\"nameKey\\": \\"carbonInventory.check.indirect_emissions_from_imported_electricity\\",\\n \\"name\\": \\"电力\\",\\n \\"emissionSourceKey\\": \\"carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec\\",\\n \\"emissionSource\\": \\"GEC\\",\\n \\"dataUnit\\": \\"kWh\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"1\\",\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 4.33,\\n \\"carbonEmissionData\\": 1.2\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"企业1\\",\\n \\"rawData\\": 1.2,\\n \\"carbonEmissionData\\": 3.222,\\n \\"ratio\\": 0.5,\\n \\"nameKey\\": \\"carbonInventory.check.indirect_emissions_from_imported_electricity\\",\\n \\"name\\": \\"电力\\",\\n \\"emissionSourceKey\\": \\"carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec\\",\\n \\"emissionSource\\": \\"GEC\\",\\n \\"dataUnit\\": \\"kWh\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"1\\",\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 4.33,\\n \\"carbonEmissionData\\": 1.2\\n }\\n ],\\n \\"subConstituteItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]',
],
'GetEmissionSummary' => [
'summary' => '获取碳排汇总。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业code', 'type' => 'string', 'required' => true, 'example' => 'C-20240119-1'],
'year' => ['description' => '盘查年份', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
'moduleType' => ['description' => '模块类型', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'moduleCode' => ['description' => '模块代码', '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' => '汇总详情数据',
'type' => 'object',
'properties' => [
'currentPeriodCarbonEmissionData' => ['description' => '本周期统计指标', 'type' => 'number', 'format' => 'double', 'example' => '276.4'],
'lastPeriodCarbonEmissionData' => ['description' => '上周期统计指标', 'type' => 'number', 'format' => 'double', 'example' => '9.40100'],
'totalCarbonEmissionData' => ['description' => '总用能排放量', 'type' => 'number', 'format' => 'double', 'example' => '276.46'],
'carbonSaveConversion' => ['description' => '碳减排放量', 'type' => 'number', 'format' => 'double', 'example' => '0.0'],
'ratio' => ['description' => '本周期同比', 'type' => 'number', 'format' => 'double', 'example' => '28.410'],
'actualEmissionRatio' => ['description' => '已排占比', 'type' => 'number', 'format' => 'double', 'example' => '2.7657'],
'weightingCarbonEmissionData' => ['description' => '按股比计算碳排', 'type' => 'number', 'format' => 'double', 'example' => '248.81400'],
'lastPeriodWeightingCarbonEmissionData' => ['description' => '上周期按股比计算碳排', 'type' => 'number', 'format' => 'double', 'example' => '8.4609'],
'weightingRatio' => ['description' => '股比碳排同比', 'type' => 'number', 'format' => 'double', 'example' => '28.4102'],
'isWeighting' => ['description' => '是否展示股比碳排', 'type' => 'boolean', 'example' => 'true'],
],
],
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', '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' => '获取碳排汇总',
'description' => '本接口的返回值是某组织的各个碳排汇总指标的结果值。'."\n"
.'接口需要传入的参数为：'."\n"
.'- 企业的唯一标识符'."\n"
.'- 碳排统计年份'."\n"
.'- 统计模块类型信息',
'changeSet' => [
['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSummary'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEmissionSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetEpdInventoryConstitute' => [
'summary' => '获取环境影响类别的结果明细。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '环境影响结果列表。',
'type' => 'array',
'items' => ['description' => '环境影响结果项。', '$ref' => '#/components/schemas/EpdInventoryConstituteItem'],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"inventoryValuePerProduct\\": 1,\\n \\"factorDataset\\": \\"/\\",\\n \\"percent\\": 31.4,\\n \\"inventoryValuePerProductUnit\\": \\"kg\\",\\n \\"num\\": 1,\\n \\"quantity\\": 1,\\n \\"resourceType\\": \\"原材料\\",\\n \\"factorType\\": 1,\\n \\"unit\\": \\"kg CO2-Eq\\",\\n \\"name\\": \\"清单1\\",\\n \\"inventoryId\\": 1,\\n \\"inventoryValue\\": 2,\\n \\"factorUnit\\": \\"kg CO2-Eq/kg\\",\\n \\"inventoryUnit\\": \\"t\\",\\n \\"state\\": 1,\\n \\"factor\\": \\"1.0000\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"factorId\\": \\"1234\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 1,\\n \\"factorDataset\\": \\"/\\",\\n \\"percent\\": 31.4,\\n \\"inventoryValuePerProductUnit\\": \\"kg\\",\\n \\"num\\": 1,\\n \\"quantity\\": 1,\\n \\"resourceType\\": \\"原材料\\",\\n \\"factorType\\": 1,\\n \\"unit\\": \\"kg CO2-Eq\\",\\n \\"name\\": \\"清单1\\",\\n \\"inventoryId\\": 1,\\n \\"inventoryValue\\": 2,\\n \\"factorUnit\\": \\"kg CO2-Eq/kg\\",\\n \\"inventoryUnit\\": \\"t\\",\\n \\"state\\": 1,\\n \\"factor\\": \\"1.0000\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"factorId\\": \\"1234\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 1,\\n \\"factorDataset\\": \\"/\\",\\n \\"percent\\": 31.4,\\n \\"inventoryValuePerProductUnit\\": \\"kg\\",\\n \\"num\\": 1,\\n \\"quantity\\": 1,\\n \\"resourceType\\": \\"原材料\\",\\n \\"factorType\\": 1,\\n \\"unit\\": \\"kg CO2-Eq\\",\\n \\"name\\": \\"清单1\\",\\n \\"inventoryId\\": 1,\\n \\"inventoryValue\\": 2,\\n \\"factorUnit\\": \\"kg CO2-Eq/kg\\",\\n \\"inventoryUnit\\": \\"t\\",\\n \\"state\\": 1,\\n \\"factor\\": \\"1.0000\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"factorId\\": \\"1234\\",\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取环境影响类别的结果明细',
'description' => '用户指产品id，本接口返回获得已经生成结果页中的若干环境影响类型的各层级的排放量。可用于了解产品不同环境影响类型下、各清单的排放数量。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdInventoryConstitute'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEpdInventoryConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetEpdSummary' => [
'summary' => '获取各种环境影响排放总量。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => 'B91B5559-065A-55C3-8D75-DA218EBFD1DC'],
'data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'carbonEmission' => ['description' => '排放量。为了保证中间过程的计算精度，结果值保留31位小数，推荐进行截取显示。排放量应配合环境影响结果值单位使用。', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000'],
'indicator' => ['description' => '该环境影响采用的评价指标。', 'type' => 'string', 'example' => 'GWP100a'],
'key' => ['description' => '类别key。环境影响类别，目前最多支持19类，[参考附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'type' => 'string', 'example' => 'gwp'],
'method' => ['description' => '计算方法标准。', 'type' => 'string', 'example' => 'CML v4.8 2016'],
'name' => ['description' => '类别名称。', 'type' => 'string', 'example' => 'Climate change'],
'num' => ['description' => '类别num，环境影响类别唯一序号，目前最多支持19类，[参考附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'preUnit' => ['description' => '环境影响结果值单位。', 'type' => 'string', 'example' => 'kg CO2-Eq'],
'state' => ['description' => '数据状态。1表示准确计算，2表示采用默认数据，3表示缺少因子采用0值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'description' => '',
],
],
],
'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\\": \\"Climate change\\",\\n \\"num\\": 1,\\n \\"preUnit\\": \\"kg CO2-Eq\\",\\n \\"state\\": 1\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取各种环境影响排放总量',
'description' => '用户指产品id，本接口返回获得已经生成结果页中的若干环境影响类型的总量。可用于了解产品不同环境影响类型的排放总量。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdSummary'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEpdSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetFootprintList' => [
'summary' => '获取产品碳足迹列表。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'currentPage' => ['description' => '分页参数，页码，从1开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '06DA2909-7736-5738-AA31-ACD617D828F1'],
'data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'currentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'records' => [
'description' => '产品详情列表',
'type' => 'array',
'items' => [
'description' => '产品信息结构体',
'type' => 'object',
'properties' => [
'id' => ['description' => '产品id', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'],
'name' => ['description' => '产品名称', 'type' => 'string', 'example' => 'Demo product'],
'authStatus' => ['description' => '认证状态枚举值，[参考附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'amount' => ['description' => '产品数量', 'type' => 'number', 'format' => 'double', 'example' => '100.0000000000000000000000000'],
'checkStartTime' => ['description' => '计算开始时间', 'type' => 'string', 'example' => '2024/01/01'],
'checkEndTime' => ['description' => '计算结束时间', 'type' => 'string', 'example' => '2024/01/31'],
'createdBy' => ['description' => '创建者', 'type' => 'string', 'example' => 'Energy Expert'],
'code' => ['description' => '所属企业编码', 'type' => 'string', 'example' => 'C-20080808-1'],
'isDemoModel' => ['description' => '是否是展示模型，1为真值，0为假值，真值表示系统内置的演示模型', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'lifeCycle' => ['description' => '与lifeCycleType对应的文字表述，`从摇篮到大门`或者`从摇篮到坟墓`。', 'type' => 'string', 'example' => '从摇篮到大门'],
'lifeCycleType' => ['description' => '1是从摇篮到大门，2是从摇篮到坟墓。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'type' => ['description' => '产品分类枚举值，[参考附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'type' => 'string', 'example' => '158-159'],
'unit' => ['description' => '单位枚举值，[参考附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'type' => 'string', 'example' => '1-4'],
],
],
],
'total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '21'],
'totalPage' => ['description' => '总页数', '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\\": \\"Demo product\\",\\n \\"authStatus\\": 1,\\n \\"amount\\": 100,\\n \\"checkStartTime\\": \\"2024/01/01\\",\\n \\"checkEndTime\\": \\"2024/01/31\\",\\n \\"createdBy\\": \\"Energy Expert\\",\\n \\"code\\": \\"C-20080808-1\\",\\n \\"isDemoModel\\": 1,\\n \\"lifeCycle\\": \\"从摇篮到大门\\",\\n \\"lifeCycleType\\": 1,\\n \\"type\\": \\"158-159\\",\\n \\"unit\\": \\"1-4\\"\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3\\n }\\n}","type":"json"}]',
'title' => '获取产品碳足迹列表',
'description' => '用户指定企业编码、页码、页长等参数，本接口返回符合条件的产品碳足迹（或者供应链碳足迹）列表，其中包括了产品名称和产品id等信息，产品id在其他接口中会作为入参，以便获取对应的产品的结果信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFootprintList'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetFootprintList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetGasConstitute' => [
'summary' => '本接口用于获取气体构成分析。',
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业code', 'type' => 'string', 'required' => true, 'example' => 'C-20240115-3'],
'year' => ['description' => '年份', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
'moduleType' => ['description' => '模块类型', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'],
'moduleCode' => ['description' => '模块编码', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions'."\n"],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"],
'data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'type' => ['description' => '气体类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'name' => ['description' => '气体名称。', 'type' => 'string', 'example' => 'CO₂'],
'gasEmissionData' => ['description' => '气体排放量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'carbonEmissionData' => ['description' => '碳排放当量。', 'type' => 'number', 'format' => 'double', 'example' => '3.14'],
'ratio' => ['description' => '碳排占比，示例值：0.5（即占50%）。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '气体构成分析',
'changeSet' => [
['createdAt' => '2024-06-12T01:57:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGasConstitute'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGasConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": [\\n {\\n \\"type\\": 1,\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 3.14,\\n \\"carbonEmissionData\\": 3.14,\\n \\"ratio\\": 0.5\\n }\\n ]\\n}","type":"json"}]',
],
'GetGwpBenchmarkList' => [
'summary' => '获取主动减碳排行列表。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', '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' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => 'A8AEC6D9-A359-5169-BD1A-BD848BA60D65'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'unit' => ['description' => '排放单位。默认为kgCO₂e/productUnit，productUnit为产品选择的单位。随着排放数量quantity的大小不同，unit会自适应转变为tCO₂e/productUnit或者gCO₂e/productUnit，具体转换规则见quantity栏的备注。', 'type' => 'string', 'example' => 'kgCO₂e/kg'],
'items' => [
'description' => '主动减碳排行列表。',
'type' => 'array',
'items' => [
'description' => '减碳项目详情。',
'type' => 'object',
'properties' => [
'name' => ['description' => '清单名称。', 'type' => 'string', 'example' => 'PVC waste recycling'],
'carbonEmission' => ['description' => '清单排放量。保留四位小数。单位为上层unit。', 'type' => 'number', 'format' => 'double', 'example' => '-0.2061'],
'percent' => ['description' => '暂未使用。', 'type' => 'string', 'example' => '暂为null'],
'benchmarkName' => ['description' => '基准线名称。', 'type' => 'string', 'example' => 'PVC waste incineration'],
'benchmarkEmission' => ['description' => '清单所关联的基准线排放量。保留四位小数。单位为上层unit。', 'type' => 'number', 'format' => 'double', 'example' => '0.0108'],
'activeReduction' => ['description' => '主动减排量=基准线排放量-清单排放量。一般地，基准线排放量大于清单排放量。保留四位小数。 单位为上层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 waste recycling\\",\\n \\"carbonEmission\\": -0.2061,\\n \\"percent\\": \\"暂为null\\",\\n \\"benchmarkName\\": \\"PVC waste incineration\\",\\n \\"benchmarkEmission\\": 0.0108,\\n \\"activeReduction\\": 0.2169\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取主动减碳排行列表',
'description' => '用户指产品id，本接口返回获得已经生成结果页中的主动减碳量列表。可用于了解产品各层级的主动减碳量。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkList'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpBenchmarkList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetGwpBenchmarkSummary' => [
'summary' => '获取主动减碳量总量。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'items' => [
'description' => '减碳量贡献top4详情。',
'type' => 'array',
'items' => [
'description' => 'Item详情。',
'type' => 'object',
'properties' => [
'name' => ['description' => '减碳详情的名称。', 'type' => 'string', 'example' => 'Raw materials'],
'percent' => ['description' => '排放百分比。字符串类型，数字保留两位小数。例如 "99.01"表示该类排放占总排放的99.01%，需要注意返回的字符串中本身不含百分号。', 'type' => 'string', 'example' => '99.01'],
'quantity' => ['description' => '排放数量。数值保留四位小数，一般地，建模下该值不会出现负数，但是用户可以构造出主动减碳量为负数的值。quantity和unit共同构成排放量，quantity和unit会自适应。当排放量大于1000kgCO₂e/productUnit时，那么quantity和unit会转换为以tCO₂e/productUnit单位的数值；当排放量小于1kgCO₂e/productUnit时，那么quantity和unit会转换为以gCO₂e/productUnit单位的数值；其他情况下，quantity保持unit为kgCO₂e/productUnit的数值。', 'type' => 'integer', 'format' => 'int64', 'example' => '9.9763'],
'unit' => ['description' => '排放单位。默认为kgCO₂e/productUnit，productUnit为产品选择的单位。随着排放数量quantity的大小不同，unit会自适应转变为tCO₂e/productUnit或者gCO₂e/productUnit，具体转换规则见quantity栏的备注。', 'type' => 'string', 'example' => 'kgCO₂e/kg'],
],
],
],
'quantity' => ['description' => '排放数量。数值保留四位小数，一般地，建模下该值不会出现负数，但是用户可以构造出主动减碳量为负数的值。quantity和unit共同构成排放量，quantity和unit会自适应。当排放量大于1000kgCO₂e/productUnit时，那么quantity和unit会转换为以tCO₂e/productUnit单位的数值；当排放量小于1kgCO₂e/productUnit时，那么quantity和unit会转换为以gCO₂e/productUnit单位的数值；其他情况下，quantity保持unit为kgCO₂e/productUnit的数值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000.0000'],
'unit' => ['description' => '排放单位。默认为kgCO₂e/productUnit，productUnit为产品选择的单位。随着排放数量quantity的大小不同，unit会自适应转变为tCO₂e/productUnit或者gCO₂e/productUnit，具体转换规则见quantity栏的备注。', 'type' => 'string', 'example' => 'kgCO₂e/t'],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"Raw materials\\",\\n \\"percent\\": \\"99.01\\",\\n \\"quantity\\": 9.9763,\\n \\"unit\\": \\"kgCO₂e/kg\\"\\n }\\n ],\\n \\"quantity\\": 1000,\\n \\"unit\\": \\"kgCO₂e/t\\"\\n }\\n}","type":"json"}]',
'title' => '获取主动减碳量总量',
'description' => '用户指产品id，本接口返回获得已经生成结果页中的主动减碳量数据，以及减碳量贡献top4详情。可用于了解产品主动减碳量总量和主要来源。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkSummary'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpBenchmarkSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetGwpInventoryConstitute' => [
'summary' => '用于获取指定产品的碳排放构成分析。碳排放构成分析包括按清单、按类型两种分析维度。在呈现效果上，包括一个层级列表和饼状图。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', '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' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '06DA2909-7736-5738-AA31-ACD617D828F1'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'name' => ['description' => '当前层级结构含义。', 'type' => 'string', 'example' => 'Total carbon emissions'],
'unit' => ['description' => '排放单位。', 'type' => 'string', 'example' => 'kgCO₂e/t'],
'carbonEmission' => ['description' => '排放数量：可能为正数、负数、0。为保证计算精度，计算过程保留24位小数，为方便显示和使用，建议根据业务需要进行截取。', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000'],
'byResourceType' => [
'description' => '按类型聚合，各种类型的排放详情',
'type' => 'array',
'items' => ['description' => '用于组成分析中的“按类型”分析。这是一个嵌套结构，总碳排放量->按清单类型排序，共两层，最末级byResourceType为空。', '$ref' => '#/components/schemas/GwpInventoryConstitute'],
],
'items' => [
'description' => '按层级从高到低的结构组织，按照环节->工序->清单层级。',
'type' => 'array',
'items' => ['description' => '用于组成分析中的“按清单”分析。是一个嵌套结构，按照环节->工序->清单层级，最末层级items为空。', '$ref' => '#/components/schemas/GwpInventoryConstitute'],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"06DA2909-7736-5738-AA31-ACD617D828F1\\",\\n \\"data\\": {\\n \\"name\\": \\"Total carbon emissions\\",\\n \\"unit\\": \\"kgCO₂e/t\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"byResourceType\\": [\\n {\\n \\"percent\\": 100,\\n \\"resourceType\\": 1,\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"name\\": \\"总碳排放量\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"总碳排放量\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"resourceType\\": 1,\\n \\"carbonEmission\\": 1009.97626554,\\n \\"percent\\": \\"98.76\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 100,\\n \\"resourceType\\": 1,\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"name\\": \\"总碳排放量\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"总碳排放量\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"resourceType\\": 1,\\n \\"carbonEmission\\": 1009.97626554,\\n \\"percent\\": \\"98.76\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 100,\\n \\"resourceType\\": 1,\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"name\\": \\"总碳排放量\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"总碳排放量\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"resourceType\\": 1,\\n \\"carbonEmission\\": 1009.97626554,\\n \\"percent\\": \\"98.76\\"\\n }\\n ],\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"items\\": []\\n }\\n}","type":"json"}]',
'title' => '获取碳排放构成分析层级图&饼状图',
'description' => '用于获取指定产品的碳排放构成分析。碳排放构成分析包括按清单、按类型两种分析维度。在呈现效果上，包括一个层级列表和饼状图。',
'changeSet' => [
['createdAt' => '2024-04-01T08:43:56.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventoryConstitute'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpInventoryConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetGwpInventorySummary' => [
'summary' => '本接口用于获得产品碳足迹总量，以及碳足迹贡献占比的Top4类型详情。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', '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' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'unit' => ['description' => '排放单位。', 'type' => 'string', 'example' => 'tCO₂e/Piece(s)'],
'quantity' => ['description' => '数量。', 'type' => 'number', 'format' => 'double', 'example' => '1.0100'],
'resultGenerateTime' => ['description' => '计算结果生成时间，格式为毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1709108026000'],
'items' => [
'description' => '碳足迹贡献占比的Top4类型详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'name' => ['description' => '清单类型名。', 'type' => 'string', 'example' => 'Electricity inventory'],
'unit' => ['description' => '单位。', 'type' => 'string', 'example' => 'kgCO₂e/Piece(s)'],
'quantity' => ['description' => '数量。', 'type' => 'number', 'format' => 'double', 'example' => '9.9763'],
'percent' => ['description' => '所占百分比。', 'type' => 'string', 'example' => '99.01'],
],
'description' => '',
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"tCO₂e/Piece(s)\\",\\n \\"quantity\\": 1.01,\\n \\"resultGenerateTime\\": 1709108026000,\\n \\"items\\": [\\n {\\n \\"name\\": \\"Electricity inventory\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"quantity\\": 9.9763,\\n \\"percent\\": \\"99.01\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取碳足迹总量',
'description' => '用户指产品id，本接口返回获得已经生成结果页中的碳足迹总量数据，以及碳足迹贡献占比的Top4类型详情。可用于了解产品碳足迹总量和主要来源。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventorySummary'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpInventorySummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetInventoryList' => [
'summary' => '用于获取指定环境影响（methodType）、指定分组汇总级别（group）、指定计算方式下（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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
'methodType' => ['description' => '获取的环境影响类型：gwp为气候变化碳足迹，其他请见枚举值的type值，[参考附录](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E7%A2%B3%E8%B6%B3%E8%BF%B9%E9%99%84%E5%BD%95.pdf)。', 'type' => 'string', 'required' => true, 'example' => 'gwp'],
'emissionType' => ['description' => '排放类型'."\n"
.'> 可选值有：footprint | emission。含义：footprint：所有的清单都参与计算；emission：只有排放为正数和零的清单参与计算，负数不参与计算。', 'type' => 'string', 'required' => true, 'example' => 'footprint'],
'group' => ['description' => '分组依据'."\n"
."\n"
.'> 可选值有：resource | process | resourceType | processType。含义：resource：按清单分组聚合，process：按工序分组聚合，resourceType：按清单类型分组聚合，processType：按环节分组聚合。', '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' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'unit' => ['description' => '排放单位：默认为kgCO₂e/productUnit，productUnit为产品选择的单位。随着排放数量quantity的大小不同，unit会自适应转变为tCO₂e/productUnit或者gCO₂e/productUnit，具体转换规则见quantity栏。', 'type' => 'string', 'example' => 'kgCO₂e/kg'],
'productUnit' => ['description' => '产品的单位。', 'type' => 'string', 'example' => 'kg'],
'items' => [
'description' => '排放列表详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'name' => ['description' => '名称'."\n"
.'> 与请求参数group有关。请求参数为：resource，返回name参数含义为：清单名称；请求参数为：process，返回name参数含义为：工序名称；请求参数为：resourceType，返回name参数含义为：清单类型名称；请求参数为：processType，返回name参数含义为：环节名称。', 'type' => 'string', 'example' => 'Electricity'],
'carbonEmission' => ['description' => '排放数量：可能为正数、负数、0。为保证计算精度，计算过程保留24位小数，为方便显示和使用，建议根据业务需要进行截取。', 'type' => 'number', 'format' => 'double', 'example' => '1000.000000000000000000000000000000'],
'percent' => ['description' => '百分比。', 'type' => 'string', 'example' => '99.01'],
'processName' => ['description' => '工序名称：仅对于请求参数group为resource时候有意义，其他时候无意义。', 'type' => 'string', 'example' => 'Process-1'],
],
'description' => '',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"productUnit\\": \\"kg\\",\\n \\"items\\": [\\n {\\n \\"name\\": \\"Electricity\\",\\n \\"carbonEmission\\": 1000,\\n \\"percent\\": \\"99.01\\",\\n \\"processName\\": \\"Process-1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取排行列表',
'description' => '本接口用于获取指定产品id、指定环境影响（methodType）、指定分组汇总级别（group）、指定计算方式下（emissionType）的排放的降序列表。可用于了解多种环境影响排放情况。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInventoryList'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetInventoryList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetOrgAndFactory' => [
'summary' => "\0".'查询账号激活的相关组织和场站，需注意的是未在控制台进行激活的场站不会被查询到。',
'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' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回信息',
'type' => 'array',
'items' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'aliyunPk' => ['description' => '阿里云账号ID', 'type' => 'string', 'example' => '1319XXXXXX64960'],
'organizationId' => ['description' => '企业ID', 'type' => 'string', 'example' => '6265f42XXXX2fec150'],
'organizationName' => ['description' => '企业名称', 'type' => 'string', 'example' => 'Ledi Industrial Park'],
'factoryList' => [
'description' => '场站信息列表。',
'type' => 'array',
'items' => [
'description' => '信息列表',
'type' => 'object',
'properties' => [
'factoryId' => ['description' => '场站id', 'type' => 'string', 'example' => 'pn_95'],
'factoryName' => ['description' => '场站名称', 'type' => 'string', 'example' => 'Ledi Industrial Park 1'],
],
],
],
],
],
],
'httpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'code' => ['description' => '返回码。', 'type' => 'string', 'example' => 'Success'],
'success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'invalidParameter', 'errorMessage' => 'Invalid parameter values.', 'description' => '请求参数错误，请检查方法入参'],
],
[
['errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', 'description' => '该账号没有API调用权限'],
],
500 => [
['errorCode' => 'systemError', 'errorMessage' => 'System error.', 'description' => '系统错误'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"aliyunPk\\": \\"1319XXXXXX64960\\",\\n \\"organizationId\\": \\"6265f42XXXX2fec150\\",\\n \\"organizationName\\": \\"Ledi Industrial Park\\",\\n \\"factoryList\\": [\\n {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"factoryName\\": \\"Ledi Industrial Park 1\\"\\n }\\n ]\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]',
'title' => '获取组织和场站',
'description' => '- 如果客户有激活的场站，返回查询组织以及场站信息。如果没有激活的场站，则返回空值。'."\n"
.'- 目前接入点仅支持杭州`energyexpertexternal.cn-hangzhou.aliyuncs.com`'."\n"
.'- 使用该接口需要先开通白名单，请通过官网[联系我们](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) '."\n"
.'[联系我们](https://energy.alibabacloud.com/common?adapter=aliyun&lang=en-US#/home/en)进行开通。',
'requestParamsDescription' => '无请求参数，直接查询账号下激活的场站信息。',
'changeSet' => [
['createdAt' => '2023-07-07T08:50:10.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-17T06:13:23.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgAndFactory'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'energy:GetOrgAndFactory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetOrgConstitute' => [
'summary' => '本接口用于获取碳盘查组织分析数据。',
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业code。', 'type' => 'string', 'required' => true, 'example' => 'Z-20240115-2'],
'year' => ['description' => '年份。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
'moduleCode' => ['description' => '模块编码。', 'type' => 'string', 'required' => false, 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions'."\n"],
'moduleType' => ['description' => '模块类型。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '返回数据。', '$ref' => '#/components/schemas/OrgEmission'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"name\\": \\"企业1\\",\\n \\"nameKey\\": \\"Z-20240115-4\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"weightingCarbonEmissionData\\": 2.3,\\n \\"weightingRatio\\": 0.4,\\n \\"ratio\\": 0.2,\\n \\"weightingProportion\\": 0.3,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"范围一：直接排放（企业生产经营过程产生的直接温室气体排放量）\\",\\n \\"nameKey\\": \\"carbonInventory.check.scope_1_direct_ghg_emissions\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"ratio\\": 0.2\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"企业1\\",\\n \\"nameKey\\": \\"Z-20240115-4\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"weightingCarbonEmissionData\\": 2.3,\\n \\"weightingRatio\\": 0.4,\\n \\"ratio\\": 0.2,\\n \\"weightingProportion\\": 0.3,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"范围一：直接排放（企业生产经营过程产生的直接温室气体排放量）\\",\\n \\"nameKey\\": \\"carbonInventory.check.scope_1_direct_ghg_emissions\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"ratio\\": 0.2\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"企业1\\",\\n \\"nameKey\\": \\"Z-20240115-4\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"weightingCarbonEmissionData\\": 2.3,\\n \\"weightingRatio\\": 0.4,\\n \\"ratio\\": 0.2,\\n \\"weightingProportion\\": 0.3,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"范围一：直接排放（企业生产经营过程产生的直接温室气体排放量）\\",\\n \\"nameKey\\": \\"carbonInventory.check.scope_1_direct_ghg_emissions\\",\\n \\"carbonEmissionData\\": 1.2,\\n \\"ratio\\": 0.2\\n }\\n ],\\n \\"subEmissionItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '碳盘查组织分析',
'description' => '1. 本接口请求参数中的code为企业编码。'."\n"
.'2. 本接口获取的是请求参数code对应的企业的数据及其递归子级数据。'."\n"
.'3. 关于上述子级数据，其含义是，企业的子级企业的数据。'."\n"
.'4. 关于上述子级企业的数据，其包含在企业数据的subEmissionItems字段中。'."\n"
.'5. 关于上述的递归，其含义是，一直获取企业的子级数据，直到其没有子级企业为止。',
'changeSet' => [
['createdAt' => '2024-04-03T02:40:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgConstitute'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetOrgConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetPcrInfo' => [
'summary' => '获取产品碳足迹PCR报告OSS地址。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'string', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'createTime' => ['description' => '报告创建时间戳，格式为毫秒时间戳。', 'type' => 'string', 'example' => '1709109790532'],
'name' => ['description' => '报告名称。', 'type' => 'string', 'example' => 'Carbon footprint report 2024-01-08.docx'],
'url' => ['description' => '报告url。', 'type' => 'string', 'example' => 'https://energy.aliyun.com'],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"createTime\\": \\"1709109790532\\",\\n \\"name\\": \\"Carbon footprint report 2024-01-08.docx\\",\\n \\"url\\": \\"https://energy.aliyun.com\\"\\n }\\n}","type":"json"}]',
'title' => '获取产品碳足迹PCR报告OSS地址',
'description' => '用户指定产品id，本接口可以获取已经生成过的PCR报告的详细信息和下载链接。使用本接口有两个前提：1、已经生成了结果页；2、已经生成了PCR报告。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPcrInfo'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetPcrInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetReductionProposal' => [
'summary' => '获取减碳建议。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
'dataQualityEvaluationType' => ['title' => '数据质量评估类型。1是DQI，2是DQR。', 'description' => '数据质量评估类型。1是DQI，2是DQR。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'reduction' => ['title' => '主动减碳建议', 'description' => '主动减碳建议', 'type' => 'string', 'example' => 'Reduce one-drop usage'],
'reductionEvaluation' => ['title' => '主动减碳评估', 'description' => '主动减碳评估', '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\\": \\"Reduce one-drop usage\\",\\n \\"reductionEvaluation\\": \\"Trying Energy Expert for a more detailed assessment.\\"\\n }\\n}","type":"json"}]',
'title' => '获取减碳建议',
'description' => '用户指产品id，本接口返回获得已经生成结果页中的减碳建议。可用于了解针对产品碳排放的优化建议。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReductionProposal'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetReductionProposal',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetVLExtractionResult' => [
'summary' => '用于获取Qwen-VL模型执行信息抽取的结果。'."\n"
.'入参taskId来自SubmitVLExtractionTask、SubmitVLExtractionTaskAdvance返回结果中的taskId。'."\n"
.'查询结果有处理中、处理成功、处理失败三种情况。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '- 任务ID。'."\n"
.'- taskId从SubmitVLExtractionTaskAdvance、SubmitVLExtractionTask接口获取。', 'type' => 'string', 'required' => true, 'example' => '864773ec-d35b-4c36-8871-52d07fbe806d'."\n"],
],
'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' => [
'kvListInfo' => [
'description' => '文档解析结果详情',
'type' => 'array',
'items' => [
'description' => '文档解析结果详情',
'type' => 'object',
'properties' => [
'keyName' => ['description' => '字段Key名称', 'type' => 'string', 'example' => 'Tenant'],
'keyValue' => ['description' => '字段key值', 'type' => 'string', 'example' => 'Alibaba Cloud XXX Co., Ltd.'],
'context' => [
'description' => '召回内容',
'type' => 'object',
'properties' => [
'key' => [
'description' => 'key的召回信息详情',
'type' => 'array',
'items' => ['description' => 'key的召回信息详情', 'example' => 'bhv_trace_info_invalid', '$ref' => '#/components/schemas/ContentItem'],
],
'value' => [
'description' => 'value的召回信息详情',
'type' => 'array',
'items' => ['description' => 'value的召回信息详情', 'example' => '[{\'Id\': \'st-265b3d6a-91765\', \'Name\': \'Sheet3\'}, {\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}, {\'Id\': \'st-26383f2c-38267\', \'Name\': \'Sheet2\'}]', '$ref' => '#/components/schemas/ContentItem'],
],
'confidence' => [
'description' => '置信度',
'type' => 'object',
'properties' => [
'keyConfidence' => ['description' => 'key的置信度', 'type' => 'number', 'format' => 'double', 'example' => '0.9994202852249146'],
'valueConfidence' => ['description' => '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\\": \\"Tenant\\",\\n \\"keyValue\\": \\"Alibaba Cloud XXX Co., Ltd.\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"租户是xxx\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取文档VL抽取结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVLExtractionResult'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetVLExtractionResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'IsCompleted' => [
'summary' => '生成报告完成状态查询。',
'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' => '请求参数。',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码。', 'type' => 'string', 'required' => true, 'example' => 'C-20080808-1'],
'productId' => ['description' => '产品id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'],
'productType' => ['description' => '产品类型：1表示请求产品碳足迹，5表示请求供应链碳足迹。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'modifiedTime' => ['description' => '状态更新时间，毫秒时间戳，例如：1711438780000。', 'type' => 'integer', 'format' => 'int64', 'example' => '1711438780000'],
'taskKey' => ['description' => '本次生成任务的唯一键。', 'type' => 'string', 'example' => '550c2b7b-f2e0-4176-ab0a-53ea4b355721'],
'taskShortResult' => ['description' => '暂未使用，为空。', 'type' => 'string', 'example' => 'null'],
'taskStatus' => ['description' => '生成报告任务状态：可能值为running、success、error，含义分别为生成中、生成成功、生成失败。如果遇到结果生成失败，请检查模型并修正模型，而后再次生成结果页。', 'type' => 'string', 'example' => 'running'],
],
],
],
'description' => '',
],
],
],
'title' => '生成报告完成状态查询',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IsCompleted'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:IsCompleted',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'PushDeviceData' => [
'summary' => '本接口用于推送设备测点数据，例如推送电能表电压等数据。',
'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' => '请求体参数。',
'type' => 'object',
'properties' => [
'deviceType' => ['description' => '设备类型。'."\n"
.'[查看设备类型定义](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E6%B5%8B%E7%82%B9%E9%99%84%E5%BD%95.pdf)', 'type' => 'string', 'required' => true, 'example' => '1'],
'devices' => [
'description' => '推送数据的设备列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'deviceId' => ['description' => 'deviceType为12、13、17需要传system_id（字段名称仍为device_id)'."\n"
.'deviceType为15、16不传'."\n"
.'其他情况必传。', 'type' => 'string', 'required' => true, 'example' => 'DeviceId-example-id-****'],
'recordTime' => ['description' => '测点数据产生时间。', 'type' => 'string', 'required' => true, 'example' => '2021-09-08 18:40:00'],
'data' => ['description' => '测点信息'."\n"
.'避免精度问题，测点数据统一传字符串'."\n"
.'缺少必填字段功能无法正常使用'."\n"
.'缺少推荐字段，部分功能可能会收到影响，具体影响详见附录中的设备测点备注'."\n"
.'[参考测点定义](https://carbon-doc.oss-cn-hangzhou.aliyuncs.com/%E6%B5%8B%E7%82%B9%E9%99%84%E5%BD%95.pdf)', 'type' => 'object', 'required' => true, 'example' => '{'."\n"
.' "dp_imp": "329.0",'."\n"
.' "F": "148.0",'."\n"
.' "eq_imp": "363.0",'."\n"
.' "Ep_imp_1": "128.0",'."\n"
.' "Ep_imp_2": "157.0",'."\n"
.' "Ua": "226.0",'."\n"
.' "Ub": "285.0",'."\n"
.' "Ep_imp": "325.0",'."\n"
.' "Uc": "342.0",'."\n"
.' "Ep_imp_3": "109.0",'."\n"
.' "Ep_imp_4": "94.0",'."\n"
.' "P": "514.0",'."\n"
.' "Pa": "443.0",'."\n"
.' "Q": "265.0",'."\n"
.' "dp_exp": "261.0",'."\n"
.' "eq_exp": "399.0",'."\n"
.' "COSQ": "223.0",'."\n"
.' "Ia": "240.0",'."\n"
.' "Ib": "216.0",'."\n"
.' "Ic": "229.0",'."\n"
.' "Ep_exp": "115.0",'."\n"
.' "VdisPer": "120.0"'."\n"
.' }'],
],
'required' => true,
'description' => '',
],
'required' => true,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '数据是否推送成功。'."\n"
.' 成功返回success。', 'type' => 'string', 'example' => 'success'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": \\"success\\"\\n}","type":"json"}]',
'title' => '推送设备测点数据',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushDeviceData'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:PushDeviceData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'PushItemData' => [
'summary' => '推送数据项数据。',
'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' => '请求体参数',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码', 'type' => 'string', 'required' => true, 'example' => 'C-20210223-01'],
'year' => ['description' => '年份。', 'type' => 'string', 'required' => true, 'example' => '2024'],
'items' => [
'description' => '推送数据列表。',
'type' => 'object',
'properties' => [
'code' => ['description' => 'API数据标识。字段获取详见[GetDataItemList](https://help.aliyun.com/zh/energy-expert/developer-reference/api-energyexpertexternal-2022-09-23-getdataitemlist)。'."\n"
.'[GetDataItemList](https://www.alibabacloud.com/help/zh/energy-expert/developer-reference/api-energyexpertexternal-2022-09-23-getdataitemlist)。', 'type' => 'string', 'required' => true, 'example' => 'demo_api_code'],
'month' => ['description' => '月份。', 'type' => 'string', 'required' => true, 'example' => '1'],
'value' => ['description' => '数据项数据数值。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '1.11'],
],
'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。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '数据是否推送成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '推送数据项数据',
'description' => '- 本接口用于推送数据项数据。'."\n"
.'- 数据项数据可以关联到碳足迹、碳盘查等服务。'."\n"
.'- 根据平台配置，支持按年、按月推送数据。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushItemData'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:PushItemData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'RecalculateCarbonEmission' => [
'summary' => '重新计算碳排放。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'code' => ['description' => '企业编码', 'type' => 'string', 'required' => true, 'example' => 'C-20240202-01'],
'year' => ['description' => '盘查年份', 'type' => 'string', 'required' => true, 'example' => '2024'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => ['description' => '返回数据，true表示请求成功，false表示请求失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '碳盘查重新计算',
'description' => '- 完成数据项上传后，需要调用此接口对碳盘查数据进行重新计算。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecalculateCarbonEmission'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:RecalculateCarbonEmission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'Retrieve' => [
'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' => '请求Body',
'type' => 'object',
'properties' => [
'query' => ['description' => '用户输入查询语句', 'type' => 'string', 'required' => true, 'example' => '"What\'s the meaning of the file?"'],
'useReranker' => ['title' => '是否需要使用reranker', 'description' => '是否需要使用reranker（默认true）', 'type' => 'boolean', 'required' => false],
'rerankerThreshold' => ['title' => '重排序分数阈值，低于该阈值的结果会被过滤', 'description' => '重排序分数阈值，低于该阈值的结果会被过滤（默认0.0）', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.0'],
'topK' => ['title' => '返回召回结果的Top-K条目', 'description' => '返回召回结果的Top-K条目（默认10）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
'preRetrieveTopK' => ['title' => '返回预召回的召回数', 'description' => '返回预召回的召回数（默认0）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'documentIds' => [
'title' => 'docIds与folderIds必须要传入一个',
'description' => 'docIds与folderIds必须选择且仅选择其一传入',
'type' => 'array',
'items' => ['description' => '文件id，可通过SaaS页面或sdk中接口获取', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3456'],
'required' => false,
],
'folderIds' => [
'title' => 'folderIds与docIds必须要传入一个',
'description' => 'folderIds与docIds必须选择且仅选择其一传入',
'type' => 'array',
'items' => ['description' => '文件夹id，可通过SaaS页面或sdk中接口获取', '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' => '任务id', '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' => [],
],
'title' => '检索知识库',
'summary' => '支持多文件夹ID或文件ID检索的RAG结果获取接口，供客户端自行加工结果并嵌入业务逻辑。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"jobId\\": \\"76cd1691-daf6-4113-8444-4998a25a5323\\",\\n \\"results\\": [\\n {\\n \\"score\\": 0.4295678,\\n \\"docName\\": \\"临时场地协议-APM.pdf\\",\\n \\"rerankScore\\": 0.5053711,\\n \\"docId\\": \\"b4620821aea92c062d8d19ad793243669cf9ae2b900e6967dee6ee9f3bf5feed\\",\\n \\"docUrl\\": \\"jobs/a4123b3f-9287-4c61-b59d-32e40fcb0a31/document/8b24a2e06669427fb3dc9812374d9d1a.pdf\\",\\n \\"weightedScore\\": 0.47252458,\\n \\"chunkId\\": \\"b0x7,b1x10\\",\\n \\"chunkContent\\": \\"\\\\\\\\\\\\\\\\n## 第三条 场地占用费(含物业管理费和市场推广费)\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\n3.2 乙方应于本协议签订后 20 个工作日内或该场地交付乙方的同时(以日期在先者为准),\\\\\\\\\\\\\\\\n向甲方一次性支付该场地四个月的场地占用费。\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\n3.3 乙方应向甲方支付的协议价款(场地占用费、物业管理费、市场推广费及本协议约定的其 他费用)以及实际发生的各种性质的价外费用(根据适用税法的相关规定,价外费用包括 但不限于违约金、赔偿金、代收款项、代垫款项)均为含增值税价格。\\",\\n \\"docElsIds\\": [\\n \\"b0x7\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'SendDocumentAskQuestion' => [
'summary' => '【重要】该接口不再维护，请使用Chat接口替代。',
'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' => '请求参数',
'type' => 'object',
'properties' => [
'prompt' => ['description' => '用户查询的问题', 'type' => 'string', 'required' => true, 'example' => 'Total carbon emissions in 2023'],
'folderId' => ['description' => '文件夹ID，用于指定查询的文档范围。为空时表示查询默认文件夹下的所有文档。', 'type' => 'string', 'required' => false, 'example' => '1a851c4a-1d65-11ef-99a7-ssfsfdd'],
'sessionId' => ['description' => '问答会话ID，用于记录同一个用户的多次问答。为空时表示不区分会话。', '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' => '请求ID', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"],
'data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'answer' => ['description' => '问答结果', 'type' => 'string', 'example' => 'Carbon emissions in 2023 totaled 4.681 million tons'],
'document' => [
'description' => '对应query返回的回答关联的文档',
'type' => 'array',
'items' => ['description' => '文档详情', '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\\": \\"Carbon emissions in 2023 totaled 4.681 million tons\\",\\n \\"document\\": [\\n \\"https://oss/aa.pdf\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => '在线文档问答',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDocumentAskQuestion'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SendDocumentAskQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'SetRunningPlan' => [
'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' => '场站id', 'type' => 'string', 'required' => true, 'example' => '***'],
'systemId' => ['description' => '站点id', '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'],
'title' => '设置运行计划',
'summary' => '设置运行计划',
'changeSet' => [
['createdAt' => '2025-02-12T03:32:23.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetRunningPlan'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SetRunningPlan',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'SubmitDocExtractionTask' => [
'summary' => '用于从文档中提取关键信息，它根据用户预设的Key-Value模板或提示词模板进行信息抽取。'."\n"
.'调用成功后返回taskId，后续调用GetDocExtractionResult获取信息抽取结果。'."\n"
.'支持本地文件和URL文件两种方式：'."\n"
.'URL上传的异步提交服务接口为：SubmitDocExtractionTask接口。'."\n"
.'本地文件上传的异步提交服务接口为：SubmitDocExtractionTaskAdvance接口。',
'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' => 'fileUrl/fileUrlObject二选一：'."\n"
."\n"
.'- fileUrl：以文档URL方式使用，单个文档（支持3000页以内、500MB以内的文档）'."\n"
."\n"
.'- fileUrlObject：以本地文件上传方式调用接口时使用，单个文档（支持3000页以内、500MB以内的文档）'."\n"
."\n"
.'> 文档抽取方式与支持上传的文档类型的关系'."\n"
.'> - 长文本RAG：支持pdf, doc/docx, xlsx, csv, txt，支持3000页'."\n"
.'> - 图片处理：支持pdf, jpg, jpeg, png, bmp, jpe, tif, tiff, webp, heic'."\n"
.'> - 长文本理解：支持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' => '文件名需带文件类型后缀', 'type' => 'string', 'required' => true, 'example' => 'example.pdf'],
],
[
'name' => 'templateId',
'in' => 'query',
'schema' => ['description' => '唯一的抽取模板ID，用于指定文档要抽取的内容，需登录模板管理页面配置模板后获取对应的模板ID。', 'type' => 'string', 'required' => true, 'example' => '572d24k0c95a'],
],
[
'name' => 'folderId',
'in' => 'query',
'schema' => ['description' => '- 唯一的知识库文件夹ID，当需要对文档进行分类管理、控制在线问答查询的文档范围时使用。'."\n"
.'- 文件夹ID需要登录文档智能控制台获取。', 'type' => 'string', 'required' => true, 'example' => 'xxxxx'],
],
[
'name' => 'extractType',
'in' => 'query',
'schema' => [
'description' => '文档抽取类型：'."\n"
.'支持rag、长文本理解类型，默认rag',
'type' => 'string',
'required' => true,
'example' => 'rag',
'enum' => ['rag', 'longTextUnderstanding'],
'default' => 'rag',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '任务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' => '异步提交RAG、长文本理解信息抽取任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocExtractionTask'],
],
],
'ramActions' => [],
],
'SubmitDocParsingTask' => [
'summary' => '用于解析文档中的文字、表格、图片等内容。'."\n"
.'调用成功后返回taskId，后续调用GetDocParsingResult获取文档解析结果。'."\n"
.'支持本地文件和URL文件两种方式：'."\n"
.' URL上传的异步提交任务接口为：SubmitDocParsingTask接口。'."\n"
.' 本地文件上传的异步提交任务接口为：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' => 'fileUrl/fileUrlObject二选一：'."\n"
."\n"
.'- fileUrl：以文档URL方式使用，单个文档（支持3000页以内、500MB以内的文档）'."\n"
."\n"
.'- fileUrlObject：以本地文件上传方式调用接口时使用，单个文档（支持3000页以内、500MB以内的文档）'."\n"
."\n"
.'> 文件解析方式与支持上传的文档类型的关系'."\n"
.'> - 长文本RAG：支持pdf、doc/docx，支持3000页'."\n"
.'> - 图片处理：支持pdf、jpg、jpeg、png、bmp'."\n"
.'> - 长文本理解：支持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' => '文件名需带文件类型后缀', 'type' => 'string', 'required' => true, 'example' => 'example.pdf'],
],
[
'name' => 'folderId',
'in' => 'query',
'schema' => ['description' => '- 唯一的知识库文件夹ID，当需要对文档进行分类管理、控制在线问答查询的文档范围时使用。'."\n"
.'- 文件夹ID需要登录文档智能控制台获取。', 'type' => 'string', 'required' => true, 'example' => 'xxxxx'],
],
[
'name' => 'needAnalyzeImg',
'in' => 'query',
'schema' => ['description' => '是否解析文档中的图片内容。', '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' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'."\n"],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '任务ID。', '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' => '异步提交文档解析任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocParsingTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SubmitDocParsingTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'SubmitDocumentAnalyzeJob' => [
'summary' => '【重要】该接口不再维护，请使用以下接口：'."\n"
.'文档解析使用submitDocParsingTask。'."\n"
.'文档抽取使用SubmitVLExtractionTask、SubmitDocExtractionTask。',
'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' => 'fileUrl/fileUrlObject二选一：'."\n"
."\n"
.'- fileUrl：以文档URL方式使用，单个文档（支持1000页以内、100MB以内的文档）'."\n"
."\n"
.'- fileUrlObject：以本地文件上传方式调用接口时使用，单个文档（支持1000页以内、100 MB以内的文档）'."\n"
."\n"
.'> 文件解析方式与支持上传的文档类型的关系'."\n"
.'> - 长文本RAG：支持pdf、doc/docx，支持1000页'."\n"
.'> - 图片处理：支持pdf、jpg、jpeg、png、bmp'."\n"
.'> - 长文本理解：支持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' => '文件名需带文件类型后缀', 'type' => 'string', 'required' => true, 'example' => 'example.pdf'],
],
[
'name' => 'templateId',
'in' => 'query',
'schema' => ['description' => '唯一的解析模板ID，用于指定文档要抽取的key-value，需登录模板管理页面配置模板后获取对应的模板ID。', 'type' => 'string', 'required' => true, 'example' => '572d24k0c95a'],
],
[
'name' => 'folderId',
'in' => 'query',
'schema' => ['description' => '唯一的知识库文件夹ID，当需要对文档进行分类管理、控制在线问答查询的文档范围时使用。为空时表示将文档上传到租户的根目录。', 'type' => 'string', 'required' => false, 'example' => 'Defaultfor Empty'],
],
[
'name' => 'analysisType',
'in' => 'query',
'schema' => ['description' => '解析方式默认doc，可选值如下：'."\n"
.'- vl：图片处理'."\n"
.'- doc：长文本rag'."\n"
.'- docUnderstanding：长文本理解'."\n"
.'- recommender：推荐类型', 'type' => 'string', 'required' => false, 'example' => 'doc'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '4A0AEC56-5C9A-5D47-93DF-7227836FFF82'],
'data' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'jobId' => ['description' => '作业ID，用于调用”获取文档解析结果“接口的请求参数。', 'type' => 'string', 'example' => 'bfce2248-1546-4298-8bcf-70ac26e69646'],
],
],
],
],
],
],
'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' => '提交文档解析作业 ',
'changeSet' => [
['createdAt' => '2024-10-22T03:15:08.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-09-23T07:22:41.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-14T06:41:15.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-07T08:02:18.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocumentAnalyzeJob'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SubmitDocumentAnalyzeJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'SubmitVLExtractionTask' => [
'summary' => '用于从文档中提取关键信息，它根据用户预设的Key-Value模板或提示词模板进行信息抽取。VL信息抽取接口采用Qwen-VL模型，特别适用于从图片中提取信息。'."\n"
.'调用成功后返回taskId，后续调用GetVLExtractionResult获取信息抽取结果。'."\n"
.'支持本地文件和URL文件两种方式：'."\n"
.'URL上传的异步提交服务接口为：SubmitVLExtractionTask接口。'."\n"
.'本地文件上传的异步提交服务接口为：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' => 'fileUrl/fileUrlObject二选一：'."\n"
."\n"
.'- fileUrl：以文档URL方式使用，单个文档（支持1000页以内、100MB以内的文档）'."\n"
."\n"
.'- fileUrlObject：以本地文件上传方式调用接口时使用，单个文档（支持1000页以内、100 MB以内的文档）'."\n"
."\n"
.'> 文件解析方式与支持上传的文档类型的关系'."\n"
.'> - 长文本RAG：支持pdf、doc/docx，支持1000页'."\n"
.'> - 图片处理：支持pdf、jpg、jpeg、png、bmp'."\n"
.'> - 长文本理解：支持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' => '文件名需带文件类型后缀', 'type' => 'string', 'required' => true, 'example' => 'example.pdf'],
],
[
'name' => 'folderId',
'in' => 'query',
'schema' => ['description' => '- 唯一的知识库文件夹ID，当需要对文档进行分类管理、控制在线问答查询的文档范围时使用。'."\n"
.'- 文件夹ID需要登录文档智能控制台获取。', 'type' => 'string', 'required' => true, 'example' => 'xxxxx'],
],
[
'name' => 'templateId',
'in' => 'query',
'schema' => ['description' => '唯一的解析模板ID，用于指定文档要抽取的key-value，需登录模板管理页面配置模板后获取对应的模板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' => '请求ID。', 'type' => 'string', 'example' => '83A5A7DD-8974-5769-952E-590A97BEA34E'],
'data' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '任务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' => '异步提交VL信息抽取任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitVLExtractionTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SubmitVLExtractionTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'energyexpertexternal.ap-southeast-1.aliyuncs.com', 'endpoint' => 'energyexpertexternal.ap-southeast-1.aliyuncs.com', 'vpc' => 'energyexpertexternal-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'energyexpertexternal.cn-hangzhou.aliyuncs.com', 'endpoint' => 'energyexpertexternal.cn-hangzhou.aliyuncs.com', 'vpc' => 'energyexpertexternal-vpc.cn-hangzhou.aliyuncs.com'],
],
'errorCodes' => [
['code' => '1001', 'message' => 'The code is invalid. Please check if your code is correct.', 'http_code' => 400, 'description' => 'code无效。请检查您的code是否正确。'],
['code' => '11007', 'message' => '无权限查看, 无权限查看参数为 code', 'http_code' => 200, 'description' => '无权限查看, 无权限查看参数为 code'],
['code' => '30037', 'message' => 'User has no permission', 'http_code' => 400, 'description' => '用户无权限'],
['code' => '36704', 'message' => 'Type is wrong', 'http_code' => 400, 'description' => 'Type类型错误'],
['code' => 'CarbonAmountNotNegative', 'message' => 'Carbon amount not be negative.', 'http_code' => 201, 'description' => '核销数据不能存在负数'],
['code' => 'DataSizeOverLimit', 'message' => 'Data size over limit.', 'http_code' => 201, 'description' => '数据体大小超过限制'],
['code' => 'invalidParameter', 'message' => 'Invalid parameter values.', 'http_code' => 400, 'description' => '请求参数错误，请检查方法入参'],
['code' => 'LeftVcsNotEnough', 'message' => 'Left vcs not enough.', 'http_code' => 201, 'description' => '剩余vcs不足'],
['code' => 'notAuthorized', 'message' => 'No permissions to call API operations.', 'http_code' => 401, 'description' => '该账号没有API调用权限'],
['code' => 'NotSupportActionType', 'message' => 'Not support action type.', 'http_code' => 201, 'description' => '该行为类型暂不支持'],
['code' => 'NotSupportPhotovoltaicCountry', 'message' => 'Not support photovoltaic country.', 'http_code' => 201, 'description' => '该国家暂不支持光伏因子转换'],
['code' => 'Prefix.1001', 'message' => 'The code is invalid. Please check if your code is correct.', 'http_code' => 400, 'description' => 'code无效。请检查您的code是否正确。'],
['code' => 'ServerException', 'message' => 'Server exception, please try again later.', 'http_code' => 500, 'description' => '服务异常，请稍后重试'],
['code' => 'systemError', 'message' => 'System error.', 'http_code' => 500, 'description' => '系统错误'],
],
'changeSet' => [
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'SubmitDocumentAnalyzeJob'],
],
'createdAt' => '2024-10-22T03:15:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'SubmitDocumentAnalyzeJob'],
],
'createdAt' => '2024-09-23T07:22:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'SubmitDocumentAnalyzeJob'],
],
'createdAt' => '2024-06-14T06:41:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetGasConstitute'],
],
'createdAt' => '2024-06-12T01:57:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'SubmitDocumentAnalyzeJob'],
],
'createdAt' => '2024-06-07T08:02:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetCarbonEmissionTrend'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetEmissionSourceConstitute'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetEmissionSummary'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetGasConstitute'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetOrgConstitute'],
],
'createdAt' => '2024-04-03T02:40:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetGwpInventoryConstitute'],
],
'createdAt' => '2024-04-01T08:44:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetOrgAndFactory'],
],
'createdAt' => '2023-07-07T08:50:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetDeviceList'],
],
'createdAt' => '2023-07-05T09:26:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更、响应参数发生变更', 'api' => 'GetDeviceInfo'],
['description' => '错误码发生变更、响应参数发生变更', 'api' => 'GetDeviceList'],
['description' => '错误码发生变更、响应参数发生变更', 'api' => 'GetOrgAndFactory'],
],
'createdAt' => '2023-04-17T06:13:27.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatList'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocExtractionTask'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatFolderList'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitVLExtractionTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceList'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocParsingResult'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocumentAnalyzeJob'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdInventoryConstitute'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDocParsingTask'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatSession'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReductionProposal'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeVlRealtime'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSourceConstitute'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceInfo'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgConstitute'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGasConstitute'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentAnalyzeResult'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecTrend'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCarbonEmissionTrend'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFootprintList'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Chat'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateSystemRunningPlan'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditProhibitedDevices'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrgAndFactory'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventorySummary'],
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEpdSummary'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushItemData'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecalculateCarbonEmission'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateResult'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPcrInfo'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IsCompleted'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpInventoryConstitute'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetRunningPlan'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInventoryList'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAreaElecConstitute'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocExtractionResult'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmissionSummary'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkSummary'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGwpBenchmarkList'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditUnfavorableAreaDevices'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataQualityAnalysis'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVLExtractionResult'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSaveInstructionStatus'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDocumentAskQuestion'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushDeviceData'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataItemList'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElecConstitute'],
],
],
'ram' => [
'productCode' => 'EnergyExpertExternal',
'productName' => '能耗宝',
'ramCodes' => ['energy'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'BatchSaveInstructionStatus',
'description' => '策略执行状态反馈',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:BatchSaveInstructionStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAreaElecConstitute',
'description' => '场站电力分析',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetAreaElecConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDocumentAnalyzeResult',
'description' => '获取文档解析结果',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDocumentAnalyzeResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDeviceList',
'description' => '获取设备列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'energy:GetDeviceList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDeviceInfo',
'description' => '获取设备数据',
'operationType' => 'list',
'ramAction' => [
'action' => 'energy:GetDeviceInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetElecConstitute',
'description' => '电力构成分析',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetElecConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AISearchResourceUpdate',
'description' => '更新AISearch结构化资源',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:AISearchResourceUpdate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetGasConstitute',
'description' => '气体构成分析',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGasConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'Chat',
'description' => '文档问答',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:Chat',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'EditProhibitedDevices',
'description' => '编辑禁用设备',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:EditProhibitedDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetChatList',
'description' => '获取问答列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetChatList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DetailDocument',
'description' => '获取文档信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'energy:DetailDocument',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteFolder',
'description' => '删除文件夹',
'operationType' => 'delete',
'ramAction' => [
'action' => 'energy:DeleteFolder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AISearchResourceDelete',
'description' => '删除AISearch结构化资源',
'operationType' => 'delete',
'ramAction' => [
'action' => 'energy:AISearchResourceDelete',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDocExtractionResult',
'description' => '获取RAG、长文本理解文档抽取结果',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDocExtractionResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetEmissionSourceConstitute',
'description' => '获取排放源构成',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEmissionSourceConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'PushItemData',
'description' => '推送数据项数据',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:PushItemData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'Retrieve',
'description' => '检索知识库',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:Retrieve',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitDocumentAnalyzeJob',
'description' => '提交文档解析作业 ',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SubmitDocumentAnalyzeJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetChatSessionList',
'description' => '获取文档会话列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetChatSessionList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetOrgConstitute',
'description' => '碳盘查组织分析',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetOrgConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ChatStream',
'description' => '流式问答',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:ChatStream',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetGwpInventorySummary',
'description' => '获取碳足迹总量',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpInventorySummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFootprintList',
'description' => '获取产品碳足迹列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetFootprintList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetVLExtractionResult',
'description' => '获取文档VL抽取结果',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetVLExtractionResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetOrgAndFactory',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'energy:GetOrgAndFactory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetRunningPlan',
'description' => '设置运行计划',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SetRunningPlan',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetGwpBenchmarkSummary',
'description' => '获取主动减碳量总量',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpBenchmarkSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPcrInfo',
'description' => '获取产品碳足迹PCR报告OSS地址',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetPcrInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AISearchResourceGetList',
'description' => '查询AISearch结构化资源',
'operationType' => 'get',
'ramAction' => [
'action' => 'energy:AISearchResourceGetList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitDocExtractionTask',
'description' => '异步提交RAG、长文本理解信息抽取任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SubmitDocExtractionTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataItemList',
'description' => '获取数据项详情列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDataItemList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInventoryList',
'description' => '获取排行列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetInventoryList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCarbonEmissionTrend',
'description' => '获取碳排趋势',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetCarbonEmissionTrend',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AISearchResourceAdd',
'description' => '添加AISearch结构化资源',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:AISearchResourceAdd',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetGwpInventoryConstitute',
'description' => '获取碳排放构成分析层级图&饼状图',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpInventoryConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'PushDeviceData',
'description' => '推送设备测点数据',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:PushDeviceData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'EditUnfavorableAreaDevices',
'description' => '编辑不利区设备',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:EditUnfavorableAreaDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetChatFolderList',
'description' => '获取问答目录列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetChatFolderList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityAnalysis',
'description' => '获取数据质量评价结果DQR、DQI',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDataQualityAnalysis',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitVLExtractionTask',
'description' => '异步提交VL信息抽取任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SubmitVLExtractionTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetEmissionSummary',
'description' => '获取碳排汇总',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEmissionSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetElecTrend',
'description' => '电力趋势分析',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetElecTrend',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SendDocumentAskQuestion',
'description' => '在线文档问答',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SendDocumentAskQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GenerateResult',
'description' => '生成碳足迹结果',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GenerateResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetEpdInventoryConstitute',
'description' => '获取环境影响类别的结果明细',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEpdInventoryConstitute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'IsCompleted',
'description' => '生成报告完成状态查询',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:IsCompleted',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetEpdSummary',
'description' => '获取各种环境影响排放总量',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetEpdSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchUpdateSystemRunningPlan',
'description' => '批量更新空调站点运行计划',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:BatchUpdateSystemRunningPlan',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateChatSession',
'description' => '创建问答会话',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:CreateChatSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitDocParsingTask',
'description' => '异步提交文档解析任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:SubmitDocParsingTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AnalyzeVlRealtime',
'description' => '获取VL实时解析结果',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:AnalyzeVlRealtime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDocument',
'description' => '删除解析过的文件',
'operationType' => 'delete',
'ramAction' => [
'action' => 'energy:DeleteDocument',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetGwpBenchmarkList',
'description' => '获取主动减碳排行列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetGwpBenchmarkList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDocParsingResult',
'description' => '获取文档解析结果',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetDocParsingResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddFolder',
'description' => '创建文件夹',
'operationType' => 'create',
'ramAction' => [
'action' => 'energy:AddFolder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AISearchStream',
'description' => 'AISearch检索对话',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:AISearchStream',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RecalculateCarbonEmission',
'description' => '碳盘查重新计算',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:RecalculateCarbonEmission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetReductionProposal',
'description' => '获取减碳建议',
'operationType' => 'none',
'ramAction' => [
'action' => 'energy:GetReductionProposal',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EnergyExpertExternal', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];