'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'energyExpertExternal', 'version' => '2022-09-23', ], 'directories' => [ [ 'id' => 366327, 'title' => '碳排管理', 'type' => 'directory', 'children' => [ [ 'id' => 366328, 'title' => '报送碳排放活动数据', 'type' => 'directory', 'children' => [ 'GetDataItemList', 'PushItemData', 'RecalculateCarbonEmission', ], ], [ 'id' => 366332, 'title' => '查询产品碳足迹结果', 'type' => 'directory', 'children' => [ 'GetFootprintList', 'GenerateResult', 'IsCompleted', 'GetPcrInfo', 'GetGwpInventorySummary', 'GetGwpBenchmarkSummary', 'GetEpdSummary', 'GetInventoryList', 'GetGwpBenchmarkList', 'GetGwpInventoryConstitute', 'GetEpdInventoryConstitute', 'GetReductionProposal', 'GetDataQualityAnalysis', ], ], [ 'id' => 366346, 'title' => '查询组织碳盘查结果', 'type' => 'directory', 'children' => [ 'GetEmissionSummary', 'GetEmissionSourceConstitute', 'GetCarbonEmissionTrend', 'GetElecConstitute', 'GetElecTrend', 'GetAreaElecConstitute', 'GetGasConstitute', 'GetOrgConstitute', ], ], ], ], [ 'id' => 366355, 'title' => '节能减碳', 'type' => 'directory', 'children' => [ [ 'id' => 366356, 'title' => '空调智控', 'type' => 'directory', 'children' => [ 'BatchSaveInstructionStatus', 'SetRunningPlan', 'EditUnfavorableAreaDevices', 'EditProhibitedDevices', 'BatchUpdateSystemRunningPlan', ], ], [ 'id' => 366362, 'title' => '报送能耗数据', 'type' => 'directory', 'children' => [ 'PushDeviceData', ], ], ], ], [ 'id' => 366364, 'title' => '设备管理', 'type' => 'directory', 'children' => [ 'GetDeviceInfo', 'GetDeviceList', 'GetOrgAndFactory', ], ], [ 'id' => 366368, 'title' => 'AI文档处理', 'type' => 'directory', 'children' => [ [ 'id' => 366369, 'title' => '文档解析', 'type' => 'directory', 'children' => [ 'GetDocumentAnalyzeResult', 'SubmitDocumentAnalyzeJob', 'SubmitDocParsingTask', 'GetDocParsingResult', ], ], [ 'id' => 366374, 'title' => '信息抽取', 'type' => 'directory', 'children' => [ 'SubmitDocExtractionTask', 'GetDocExtractionResult', 'SubmitVLExtractionTask', 'GetVLExtractionResult', 'AnalyzeVlRealtime', ], ], [ 'id' => 366380, 'title' => '知识库问答', 'type' => 'directory', 'children' => [ 'GetChatFolderList', 'CreateChatSession', 'Retrieve', 'GetChatSessionList', 'GetChatList', 'SendDocumentAskQuestion', 'Chat', 'ChatStream', ], ], [ 'id' => 366389, 'title' => '目录管理', 'type' => 'directory', 'children' => [ 'AddFolder', 'DeleteFolder', ], ], [ 'id' => 366392, 'title' => '文件管理', 'type' => 'directory', 'children' => [ 'DetailDocument', 'DeleteDocument', ], ], ], ], ], 'components' => [ 'schemas' => [ 'CarbonEmissionElecSummaryItem' => [ 'title' => '企业分析返回结构', 'description' => '企业分析返回结构', 'type' => 'object', 'properties' => [ 'carbonEmissionData' => [ 'title' => '碳排排放当量', 'description' => '碳排放当量。', 'type' => 'number', 'format' => 'double', 'example' => '1.22', ], 'rawData' => [ 'title' => '用电量', 'description' => '用电量，单位Kwh。', 'type' => 'number', 'format' => 'double', 'example' => '1.2', ], 'ratio' => [ 'title' => '用电量占比', 'description' => '用电量占比，取值范围0~1。', 'type' => 'number', 'format' => 'double', 'example' => '0.22', ], 'dataUnit' => [ 'title' => '单位', 'description' => '单位', 'type' => 'string', 'example' => 'kg', ], 'name' => [ 'title' => '企业名称', 'description' => '企业名称。', 'type' => 'string', 'example' => 'xxx', ], ], ], 'ChatDocumentPageNum' => [ 'description' => '问答相关内容在文档的位置信息。', 'type' => 'object', 'properties' => [ 'pos' => [ 'description' => '文档的位置信息。', 'type' => 'array', 'items' => [ 'description' => '相关位置坐标，每个位置为4个坐标点。', 'type' => 'array', 'items' => [ 'description' => '文档块位置数据', '$ref' => '#/components/schemas/ChatRefDocPostion', ], ], ], 'num' => [ 'description' => '相关文档页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], ], ], 'ChatFolderItem' => [ 'description' => '文档目录列表。', 'type' => 'object', 'properties' => [ 'subFolders' => [ 'description' => '子文件夹列表。', 'type' => 'array', 'items' => [ 'description' => '子文件夹详情。', '$ref' => '#/components/schemas/ChatItem', ], ], 'folderName' => [ 'description' => '文件夹名称。', 'type' => 'string', 'example' => '默认文件夹。', ], 'folderId' => [ 'description' => '文件夹ID。', 'type' => 'string', 'example' => 'aaa', ], ], ], 'ChatItem' => [ 'description' => '问答详情。', 'type' => 'object', 'properties' => [ 'question' => [ 'description' => '提问内容。', 'type' => 'string', 'example' => '如何使用知识库。', ], 'answer' => [ 'description' => '提问的回答内容。', 'type' => 'string', 'example' => '未找到相关内容', ], 'createTime' => [ 'description' => '问答时间，毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1747280158000', ], 'refDocList' => [ 'description' => '- 与问答相关的文件列表。'."\n" .'- 如果使用流式问答，只有第一个分片有数据。', 'type' => 'array', 'items' => [ 'description' => '问答相关文件详情。', '$ref' => '#/components/schemas/ChatRefDocItem', ], ], 'folderName' => [ 'description' => '问答选择的文件夹名称。', 'type' => 'string', 'example' => '默认文件夹', ], 'folderId' => [ 'description' => '问答选择的文件夹。', 'type' => 'string', 'example' => '7708fddb-21dc-4403-a4ea-5b94eccce4c3', ], ], ], 'ChatRefDocInfo' => [ 'description' => '页面文档信息。', 'type' => 'object', 'properties' => [ 'pages' => [ 'description' => '当前文档总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '23', ], 'pageListInfo' => [ 'description' => '文件每页具体信息。', 'type' => 'array', 'items' => [ 'description' => '每页具体信息。', '$ref' => '#/components/schemas/ChatRefDocPageInfo', ], ], ], ], 'ChatRefDocItem' => [ 'description' => '相关文档信息。', 'type' => 'object', 'properties' => [ 'docName' => [ 'description' => '文档名称，如果原始文件是doc等类型会转换为pdf，方便文档定位，对文档定位信息需要使用此文件。', 'type' => 'string', 'example' => 'a.pdf', ], 'sourceType' => [ 'description' => '返回文件类型，"doc": 文件类型； "web"：互联网信息。', 'type' => 'string', 'example' => 'doc', ], 'docUrl' => [ 'description' => '文档链接。', 'type' => 'string', 'example' => 'https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf', ], 'docInfo' => [ 'description' => '相关文档信息。', '$ref' => '#/components/schemas/ChatRefDocInfo', ], 'originDocName' => [ 'description' => '原始文件名。', 'type' => 'string', 'example' => 'a.doc', ], 'pageNum' => [ 'description' => '页码信息。', 'type' => 'array', 'items' => [ 'description' => '页面信息详情。', '$ref' => '#/components/schemas/ChatDocumentPageNum', ], ], 'originDocUrl' => [ 'description' => '原始文档链接。', 'type' => 'string', 'example' => 'https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc', ], ], ], 'ChatRefDocPageInfo' => [ 'description' => '文件每页具体信息。', 'type' => 'object', 'properties' => [ 'imageWidth' => [ 'description' => '页面转图的宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '23', ], 'imageUrl' => [ 'description' => '- 页面转图片后的图片URL。'."\n" .'- 注意：图片url超过24小时后将无法获取到图片，需要及时另存。', 'type' => 'string', 'example' => '2', ], 'pageIdCurDoc' => [ 'description' => '页面在当前文档的页索引，从0开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'angle' => [ 'description' => '页面转图片后的图片的旋转角度。', 'type' => 'number', 'format' => 'double', 'example' => '0.0', ], 'excelParseResult' => [ 'description' => '预留，暂可不用。', 'type' => 'string', 'example' => 'null', ], 'wordParseResult' => [ 'description' => '预留，暂可不用。', 'type' => 'string', 'example' => 'null', ], 'pdfParseResult' => [ 'description' => '预留，暂可不用。', 'type' => 'string', 'example' => 'null', ], 'imageHeight' => [ 'description' => '页面转图的高。', 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], ], ], 'ChatRefDocPageNum' => [ 'description' => '相关文档页数信息。', 'type' => 'object', 'properties' => [ 'pos' => [ 'description' => '相关文档位置信息列表。', 'type' => 'array', 'items' => [ 'description' => '相关文档位置信息列表。', 'type' => 'array', 'items' => [ 'description' => '相关文档位置信息。', '$ref' => '#/components/schemas/ChatRefDocPostion', ], ], ], 'num' => [ 'description' => '问答相关内容的页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], ], ], 'ChatRefDocPostion' => [ 'description' => '文档坐标。', 'type' => 'object', 'properties' => [ 'x' => [ 'description' => '版面的x坐标。', 'type' => 'integer', 'format' => 'int32', 'example' => '22', ], 'y' => [ 'description' => '版面的y坐标。', 'type' => 'integer', 'format' => 'int32', 'example' => '86', ], ], ], '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' => '构成分析列表结构', 'type' => 'object', 'properties' => [ 'enterpriseName' => [ 'title' => '企业名称', 'description' => '企业名称', 'type' => 'string', 'example' => '企业1', ], 'rawData' => [ 'title' => '原始数据', 'description' => '原始数据', 'type' => 'number', 'format' => 'double', 'example' => '1.2', ], 'carbonEmissionData' => [ 'title' => '碳排放量', 'description' => '碳排放量', 'type' => 'number', 'format' => 'double', 'example' => '3.222', ], 'ratio' => [ 'title' => '所占比例', 'description' => '所占比例', 'type' => 'number', 'format' => 'double', 'example' => '0.5', ], 'nameKey' => [ 'title' => '名称唯一标识', 'description' => '名称唯一标识', 'type' => 'string', 'example' => 'carbonInventory.check.indirect_emissions_from_imported_electricity', ], 'name' => [ 'title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => '电力', ], 'emissionSourceKey' => [ 'title' => '排放源唯一标识', 'description' => '排放源唯一标识', 'type' => 'string', 'example' => 'carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec', ], 'emissionSource' => [ 'title' => '排放源', 'description' => '排放源', 'type' => 'string', 'example' => 'GEC', ], 'dataUnit' => [ 'title' => '数据单位', 'description' => '数据单位', 'type' => 'string', 'example' => 'kWh', ], 'envGasEmissions' => [ 'title' => '气体排放详情列表', 'description' => '气体排放详情列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '标识气体类型的唯一key', 'description' => '标识气体类型的唯一key', 'type' => 'string', 'example' => '1', ], 'name' => [ 'title' => '气体名称', 'description' => '气体名称', 'type' => 'string', 'example' => 'CO₂', ], 'gasEmissionData' => [ 'title' => '气体碳排放量', 'description' => '气体碳排放量', 'type' => 'number', 'format' => 'double', 'example' => '4.33', ], 'carbonEmissionData' => [ 'title' => 'carbonEmissionData'."\0".' 碳排放量', 'description' => '碳排放量', 'type' => 'number', 'format' => 'double', 'example' => '1.2', ], ], ], 'required' => false, ], 'subConstituteItems' => [ 'title' => '子级详情列表', 'description' => '子级详情列表', 'type' => 'array', 'items' => [ 'description' => '下降排放列表', '$ref' => '#/components/schemas/ConstituteItem', ], ], ], ], 'ContentItem' => [ 'title' => 'ContentItem', 'description' => 'ContentItem', 'type' => 'object', 'properties' => [ 'score' => [ 'title' => '召回的置信度', 'description' => '召回的置信度。', 'type' => 'number', 'format' => 'double', 'example' => '0.45', ], 'type' => [ 'title' => '文本来源， img, table, para', 'description' => '文本来源， img, table, para', 'type' => 'string', 'example' => 'img', ], 'extInfo' => [ 'title' => '文本的坐标信息，是list形式', 'description' => '文本的坐标信息，是list形式。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'alignment' => [ 'title' => '版面对齐方式 枚举值：center, left, right', 'description' => '版面对齐方式的枚举值：center, left, right', 'type' => 'string', 'example' => 'center', ], 'index' => [ 'title' => '版面在文本中的序号', 'description' => '版面在文本中的序号', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'level' => [ 'title' => '版面的层级', 'description' => '版面的层级', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'pageNum' => [ 'title' => '版面的页码，可能包含多个页码', 'description' => '版面的页码，可能包含多个页码', 'type' => 'array', 'items' => [ 'description' => '页码，默认值 1。'."\n" ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], 'pos' => [ 'title' => '版面的位置信息，list', 'description' => '版面的位置信息，list', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'x' => [ 'title' => 'int 版面的x坐标', 'description' => 'int 版面的x坐标', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'y' => [ 'title' => '版面的y坐标', 'description' => '版面的y坐标', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], ], ], 'subType' => [ 'title' => '版面的子类型 枚举值：picture, para, none', 'description' => '版面的子类型枚举值：picture, para, none', 'type' => 'string', 'example' => 'picture', ], 'text' => [ 'title' => 'text', 'description' => 'text', 'type' => 'string', 'example' => '版面内容', ], 'type' => [ 'title' => '版面的类型 枚举值：table, figure, text，none', 'description' => '版面的类型枚举值：table, figure, text，none', 'type' => 'string', 'example' => 'table', ], 'uniqueId' => [ 'title' => 'str 唯一的版面id', 'description' => 'str 唯一的版面id', 'type' => 'string', 'example' => '88c712db271443dd4e3697cb9b5dab3a', ], ], ], ], 'text' => [ 'title' => '召回文本', 'description' => '召回文本', 'type' => 'string', 'example' => '租户是xxx', ], ], ], '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清单结构体', 'type' => 'object', 'properties' => [ 'inventoryValuePerProduct' => [ 'title' => '每功能单位活动数据', 'description' => '每功能单位活动数据：只第三级不为空；数值保留24位小数，表示每功能单位活动数量；应当与inventoryValuePerProductUnit联合使用。', 'type' => 'number', 'format' => 'double', 'example' => '1.000000000000000000000000', ], 'factorDataset' => [ 'title' => 'factorDataset 因子所属数据库', 'description' => 'factorDataset 因子所属数据库。该字段与factorType联合使用，当factorType为1，这里显示因子归属的数据名称；当factorType为2，factorId表示所引用产品id；当factorType为null，factorId无意义。此字段为新增字段，老数据可能没有此字段数据，显示为"/"。', 'type' => 'string', 'example' => '/', ], 'percent' => [ 'title' => '所占比例', 'description' => '所占比例，保留四位小数，返回31.4000表示占比31.4%的。第一级返回为null'."\n" .'；第二级返回当前工序占总排放百分比； 第三级返回当前清单占总排放百分比', 'type' => 'number', 'format' => 'double', 'example' => '31.4000', ], 'inventoryValuePerProductUnit' => [ 'title' => '每功能单位活动数据单位', 'description' => '每功能单位活动数据单位。只第三级不为空。在清单信息中的表示每功能单位活动数据单位。', 'type' => 'string', 'example' => 'kg', ], '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)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'quantity' => [ 'title' => '原始活动数据', 'description' => '原始活动数据。只有第三级返回不为null，表示清单数量。', 'type' => 'number', 'format' => 'double', 'example' => '1.000000000000', ], 'resourceType' => [ 'title' => '清单类型', 'description' => '清单类型。只有第三级返回不为null，第三级为清单详情，此字段表示清单的类型名称。', 'type' => 'string', 'example' => '原材料', ], 'factorType' => [ 'title' => 'factorType 因子类型key', 'description' => '因子类型key。只第三级不为空，清单信息中的factorType表示选用因子来源类型；可选值有1、2或者null：1：因子库 ，2：产品库。null表示并非从因子库、产品库选择的因子，因子来源于用户自行构造。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'unit' => [ 'title' => '环境影响结果值单位', 'description' => '环境影响结果值单位。此单位为对应环境影响类别的环境影响结果值单位。比如kg CO2-Eq表示这里显示的排放值的单位是kg CO2-Eq。', 'type' => 'string', 'example' => 'kg CO2-Eq', ], 'name' => [ 'title' => '名称', 'description' => '名称。返回本级的名称，不同级的name含义不同。第一级返回为环境影响类型。第二级返回当前工序名称。第三级返回当前清单名称', 'type' => 'string', 'example' => '清单1', ], 'inventoryId' => [ 'title' => '清单id', 'description' => '清单id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'inventoryValue' => [ 'title' => '清单数量', 'description' => '清单数量。仅在第三级不为空。第三级为清单详情，此字段表示清单的id。应当与inventoryUnit联合使用。', 'type' => 'number', 'format' => 'double', 'example' => '2.000000000000000000000000', ], 'factorUnit' => [ 'title' => '因子单位', 'description' => '因子单位', 'type' => 'string', 'example' => 'kg CO2-Eq/kg', ], 'inventoryUnit' => [ 'title' => '清单单位', 'description' => '清单单位', 'type' => 'string', 'example' => 't', ], 'state' => [ 'title' => '数据状态', 'description' => '数据状态。1表示准确计算，2表示采用默认数据，3表示采用0作为因子值参与计算。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'factor' => [ 'title' => '因子值', 'description' => '因子值。只第三级不为空，清单信息中的factor表示所选因子的因子值。因子值保留小数点后四位小数，"1.0000"表示因子值为1。因子值应当结合factorUnit使用，如factorUnit为"kg CO2-Eq/kg"，那么表示该每1kg该清单碳排放为1kg CO2-Eq。', 'type' => 'string', 'example' => '1.0000', ], 'carbonEmission' => [ 'title' => '排放量', 'description' => '排放量。保留24位小数，建议进行截取部分使用。含义是各层级的排放量：'."\n" .'第一级表示当前环境影响类型下，该产品的总排放量；第二级表示当前环境影响类型下，该工序的总排放量；第三级表示当前环境影响类型下，该清单的总排放量。', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', ], 'factorId' => [ 'title' => '因子id', 'description' => '因子id', 'type' => 'string', 'example' => '1234', ], 'items' => [ 'title' => '子级列表', 'description' => '子级列表', 'type' => 'array', 'items' => [ 'description' => '子级列表。第三级返回为null。', '$ref' => '#/components/schemas/EpdInventoryConstituteItem', ], ], ], ], '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' => '温室气体构成', 'type' => 'object', 'properties' => [ 'percent' => [ 'title' => '排放百分比', 'description' => '排放百分比，例如100.00是指100.00%的意思。', 'type' => 'number', 'format' => 'double', 'example' => '100.00', ], '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)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'unit' => [ 'title' => '单位', 'description' => '单位', 'type' => 'string', 'example' => 'kgCO₂e/kg', ], 'carbonEmission' => [ 'title' => '排放数量', 'description' => '排放数量', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', ], 'name' => [ 'title' => '排放体名称', 'description' => '名称', 'type' => 'string', 'example' => '总碳排放量', ], 'byResourceType' => [ 'title' => '按类型聚合列表', 'description' => '按类型聚合，各中类型的排放详情。用于组成分析中的“按类型”分析。这是一个嵌套结构，总碳排放量->按清单类型排序，共两层，最末级byResource为空。', 'type' => 'array', 'items' => [ 'description' => '按类型聚合列表。按类型聚合，各中类型的排放详情。用于组成分析中的“按类型”分析。这是一个嵌套结构，总碳排放量->按清单类型排序，共两层，最末级byResource为空。', '$ref' => '#/components/schemas/GwpResourceConstitute', ], ], 'items' => [ 'title' => '构成详情列表', 'description' => '按层级从高到低的结构组织，按照环节->工序->清单层级。用于组成分析中的“按清单”分析。这是一个嵌套结构，按照环节->工序->清单层级，最末层级items为空。', 'type' => 'array', 'items' => [ 'description' => '构成详情列表。按层级从高到低的结构组织，按照环节->工序->清单层级。用于组成分析中的“按清单”分析。这是一个嵌套结构，按照环节->工序->清单层级，最末层级items为空。', '$ref' => '#/components/schemas/GwpInventoryConstitute', ], ], ], ], 'GwpResourceConstitute' => [ 'title' => '资源构成结构体', 'description' => 'gwp清单碳排放结构。', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '名称', 'description' => '名称，逐层含义不同，最外层是总碳排放量。', 'type' => 'string', 'example' => '总碳排放量', ], 'unit' => [ 'title' => '单位', 'description' => '排放单位。', 'type' => 'string', 'example' => 'kgCO₂e/Piece(s)', ], 'resourceType' => [ 'title' => '清单类型', 'description' => '清单类型。在清单层有意义，其它层可为空。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'carbonEmission' => [ 'title' => '碳排放当量', 'description' => '碳排放量，为保证精度，保留24位小数，建议截取使用。', 'type' => 'number', 'format' => 'double', 'example' => '1009.976265540000000000000000000000', ], 'percent' => [ 'title' => '排放百分比', 'description' => '排放百分比。98.76的表示98.76%的占比。', 'type' => 'string', 'example' => '98.76', ], ], ], 'OrgEmission' => [ 'title' => '组织分析返回值结构', 'description' => '组织分析返回值结构', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '企业名称', 'description' => '企业名称', 'type' => 'string', 'example' => '企业1', ], 'nameKey' => [ 'title' => '企业类型', 'description' => '企业编码', 'type' => 'string', 'example' => 'Z-20240115-4', ], 'carbonEmissionData' => [ 'title' => '碳排放当量', 'description' => '碳排放当量', 'type' => 'number', 'format' => 'double', 'example' => '1.2', ], 'weightingCarbonEmissionData' => [ 'title' => '按股比计算碳排', 'description' => '按股比计算碳排', 'type' => 'number', 'format' => 'double', 'example' => '2.3', ], 'weightingRatio' => [ 'title' => '股比碳排同比', 'description' => '股比碳排同比', 'type' => 'number', 'format' => 'double', 'example' => '0.4', ], 'ratio' => [ 'title' => '碳排占比', 'description' => '碳排占比', 'type' => 'number', 'format' => 'double', 'example' => '0.2', ], 'weightingProportion' => [ 'title' => '权重比例', 'description' => '权重比例', 'type' => 'number', 'format' => 'double', 'example' => '0.3', ], 'moduleEmissionList' => [ 'title' => '分模块碳排数据', 'description' => '分模块碳排数据', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'title' => '模块名', 'description' => '模块名', 'type' => 'string', 'example' => '范围一：直接排放（企业生产经营过程产生的直接温室气体排放量）', ], 'nameKey' => [ 'title' => '模块key', 'description' => '模块key', 'type' => 'string', 'example' => 'carbonInventory.check.scope_1_direct_ghg_emissions', ], 'carbonEmissionData' => [ 'title' => '碳排量', 'description' => '碳排量', 'type' => 'number', 'format' => 'double', 'example' => '1.2', ], 'ratio' => [ 'title' => '碳排量占比', 'description' => '碳排量占比', 'type' => 'number', 'format' => 'double', 'example' => '0.2', ], ], ], ], 'subEmissionItems' => [ 'title' => '子级数据，即组织下的场地数据', 'description' => '子级数据，即组织下的场地数据', 'type' => 'array', 'items' => [ 'description' => '下级企业列表', '$ref' => '#/components/schemas/OrgEmission', ], ], ], ], ], ], 'apis' => [ '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' => '锅炉数据', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"unit\\": \\"kg\\",\\n \\"period\\": 1,\\n \\"code\\": \\"demo_api_code\\",\\n \\"name\\": \\"锅炉数据\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取数据项详情列表', 'description' => '- 用于获取当前企业下数据项详情列表', ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '推送数据项数据', 'description' => '- 本接口用于推送数据项数据。'."\n" .'- 数据项数据可以关联到碳足迹、碳盘查等服务。'."\n" .'- 根据平台配置，支持按年、按月推送数据。', ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '碳盘查重新计算', 'description' => '- 完成数据项上传后，需要调用此接口对碳盘查数据进行重新计算。', ], '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' => '演示产品', ], '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', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"06DA2909-7736-5738-AA31-ACD617D828F1\\",\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"id\\": 1024,\\n \\"name\\": \\"演示产品\\",\\n \\"authStatus\\": 1,\\n \\"amount\\": 100,\\n \\"checkStartTime\\": \\"2024/01/01\\",\\n \\"checkEndTime\\": \\"2024/01/31\\",\\n \\"createdBy\\": \\"Energy Expert\\",\\n \\"code\\": \\"C-20080808-1\\",\\n \\"isDemoModel\\": 1,\\n \\"lifeCycle\\": \\"从摇篮到大门\\",\\n \\"lifeCycleType\\": 1,\\n \\"type\\": \\"158-159\\",\\n \\"unit\\": \\"1-4\\"\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3\\n }\\n}","type":"json"}]', 'title' => '获取产品碳足迹列表', 'description' => '用户指定企业编码、页码、页长等参数，本接口返回符合条件的产品碳足迹（或者供应链碳足迹）列表，其中包括了产品名称和产品id等信息，产品id在其他接口中会作为入参，以便获取对应的产品的结果信息。', ], '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，本接口产生一个任务，用于生成对应产品的碳足迹结果。任务状态可通过生成报告完成状态查询接口获得。结果生成后，其余结果查询页的显示内容方可调用。', ], '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', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"modifiedTime\\": 1711438780000,\\n \\"taskKey\\": \\"550c2b7b-f2e0-4176-ab0a-53ea4b355721\\",\\n \\"taskShortResult\\": \\"null\\",\\n \\"taskStatus\\": \\"running\\"\\n }\\n}","type":"json"}]', 'title' => '生成报告完成状态查询', ], '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' => '面包板-碳足迹报告2024-01-08 18:39:39.docx', ], 'url' => [ 'description' => '报告url。', 'type' => 'string', 'example' => 'https://energy.aliyun.com', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"createTime\\": \\"1709109790532\\",\\n \\"name\\": \\"面包板-碳足迹报告2024-01-08 18:39:39.docx\\",\\n \\"url\\": \\"https://energy.aliyun.com\\"\\n }\\n}","type":"json"}]', 'title' => '获取产品碳足迹PCR报告OSS地址', 'description' => '用户指定产品id，本接口可以获取已经生成过的PCR报告的详细信息和下载链接。使用本接口有两个前提：1、已经生成了结果页；2、已经生成了PCR报告。', ], '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' => '电力清单', ], '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', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"tCO₂e/Piece(s)\\",\\n \\"quantity\\": 1.01,\\n \\"resultGenerateTime\\": 1709108026000,\\n \\"items\\": [\\n {\\n \\"name\\": \\"电力清单\\",\\n \\"unit\\": \\"kgCO₂e/Piece(s)\\",\\n \\"quantity\\": 9.9763,\\n \\"percent\\": \\"99.01\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取碳足迹总量', 'description' => '用户指产品id，本接口返回获得已经生成结果页中的碳足迹总量数据，以及碳足迹贡献占比的Top4类型详情。可用于了解产品碳足迹总量和主要来源。', ], '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' => '原材料', ], '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', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"原材料\\",\\n \\"percent\\": \\"99.01\\",\\n \\"quantity\\": 9.9763,\\n \\"unit\\": \\"kgCO₂e/kg\\"\\n }\\n ],\\n \\"quantity\\": 1000,\\n \\"unit\\": \\"kgCO₂e/t\\"\\n }\\n}","type":"json"}]', 'title' => '获取主动减碳量总量', 'description' => '用户指产品id，本接口返回获得已经生成结果页中的主动减碳量数据，以及减碳量贡献top4详情。可用于了解产品主动减碳量总量和主要来源。', ], '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' => '气候变化', ], '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', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B91B5559-065A-55C3-8D75-DA218EBFD1DC\\",\\n \\"data\\": [\\n {\\n \\"carbonEmission\\": 1009.97626554,\\n \\"indicator\\": \\"GWP100a\\",\\n \\"key\\": \\"gwp\\",\\n \\"method\\": \\"CML v4.8 2016\\",\\n \\"name\\": \\"气候变化\\",\\n \\"num\\": 1,\\n \\"preUnit\\": \\"kg CO2-Eq\\",\\n \\"state\\": 1\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取各种环境影响排放总量', 'description' => '用户指产品id，本接口返回获得已经生成结果页中的若干环境影响类型的总量。可用于了解产品不同环境影响类型的排放总量。', ], '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' => '电力', ], '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', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"unit\\": \\"kgCO₂e/kg\\",\\n \\"productUnit\\": \\"kg\\",\\n \\"items\\": [\\n {\\n \\"name\\": \\"电力\\",\\n \\"carbonEmission\\": 1000,\\n \\"percent\\": \\"99.01\\",\\n \\"processName\\": \\"Process-1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取排行列表', 'description' => '本接口用于获取指定产品id、指定环境影响（methodType）、指定分组汇总级别（group）、指定计算方式下（emissionType）的排放的降序列表。可用于了解多种环境影响排放情况。', ], '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废料回收', ], 'carbonEmission' => [ 'description' => '清单排放量。保留四位小数。单位为上层unit。', 'type' => 'number', 'format' => 'double', 'example' => '-0.2061', ], 'percent' => [ 'description' => '暂未使用。', 'type' => 'string', 'example' => '暂为null', ], 'benchmarkName' => [ 'description' => '基准线名称。', 'type' => 'string', 'example' => 'PVC废料焚烧', ], '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废料回收\\",\\n \\"carbonEmission\\": -0.2061,\\n \\"percent\\": \\"暂为null\\",\\n \\"benchmarkName\\": \\"PVC废料焚烧\\",\\n \\"benchmarkEmission\\": 0.0108,\\n \\"activeReduction\\": 0.2169\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取主动减碳排行列表', 'description' => '用户指产品id，本接口返回获得已经生成结果页中的主动减碳量列表。可用于了解产品各层级的主动减碳量。', ], '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' => '总碳排放量', ], '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\\": \\"总碳排放量\\",\\n \\"unit\\": \\"kgCO₂e/t\\",\\n \\"carbonEmission\\": 1009.97626554,\\n \\"byResourceType\\": [\\n {\\n \\"percent\\": 0,\\n \\"resourceType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"name\\": \\"\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"unit\\": \\"\\",\\n \\"resourceType\\": 0,\\n \\"carbonEmission\\": 0,\\n \\"percent\\": \\"\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 0,\\n \\"resourceType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"name\\": \\"\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"unit\\": \\"\\",\\n \\"resourceType\\": 0,\\n \\"carbonEmission\\": 0,\\n \\"percent\\": \\"\\"\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"percent\\": 0,\\n \\"resourceType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"name\\": \\"\\",\\n \\"byResourceType\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"unit\\": \\"\\",\\n \\"resourceType\\": 0,\\n \\"carbonEmission\\": 0,\\n \\"percent\\": \\"\\"\\n }\\n ],\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"items\\": []\\n }\\n}","type":"json"}]', 'title' => '获取碳排放构成分析层级图&饼状图', 'description' => '用于获取指定产品的碳排放构成分析。碳排放构成分析包括按清单、按类型两种分析维度。在呈现效果上，包括一个层级列表和饼状图。', ], '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\\": 0,\\n \\"factorDataset\\": \\"\\",\\n \\"percent\\": 0,\\n \\"inventoryValuePerProductUnit\\": \\"\\",\\n \\"num\\": 0,\\n \\"quantity\\": 0,\\n \\"resourceType\\": \\"\\",\\n \\"factorType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"inventoryId\\": 0,\\n \\"inventoryValue\\": 0,\\n \\"factorUnit\\": \\"\\",\\n \\"inventoryUnit\\": \\"\\",\\n \\"state\\": 0,\\n \\"factor\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"factorId\\": \\"\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 0,\\n \\"factorDataset\\": \\"\\",\\n \\"percent\\": 0,\\n \\"inventoryValuePerProductUnit\\": \\"\\",\\n \\"num\\": 0,\\n \\"quantity\\": 0,\\n \\"resourceType\\": \\"\\",\\n \\"factorType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"inventoryId\\": 0,\\n \\"inventoryValue\\": 0,\\n \\"factorUnit\\": \\"\\",\\n \\"inventoryUnit\\": \\"\\",\\n \\"state\\": 0,\\n \\"factor\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"factorId\\": \\"\\",\\n \\"items\\": [\\n {\\n \\"inventoryValuePerProduct\\": 0,\\n \\"factorDataset\\": \\"\\",\\n \\"percent\\": 0,\\n \\"inventoryValuePerProductUnit\\": \\"\\",\\n \\"num\\": 0,\\n \\"quantity\\": 0,\\n \\"resourceType\\": \\"\\",\\n \\"factorType\\": 0,\\n \\"unit\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"inventoryId\\": 0,\\n \\"inventoryValue\\": 0,\\n \\"factorUnit\\": \\"\\",\\n \\"inventoryUnit\\": \\"\\",\\n \\"state\\": 0,\\n \\"factor\\": \\"\\",\\n \\"carbonEmission\\": 0,\\n \\"factorId\\": \\"\\",\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取环境影响类别的结果明细', 'description' => '用户指产品id，本接口返回获得已经生成结果页中的若干环境影响类型的各层级的排放量。可用于了解产品不同环境影响类型下、各清单的排放数量。', ], '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' => '主动减碳建议的文本', ], 'reductionEvaluation' => [ 'title' => '主动减碳评估', 'description' => '主动减碳评估', 'type' => 'string', 'example' => '主动减碳评估的文本', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"reduction\\": \\"主动减碳建议的文本\\",\\n \\"reductionEvaluation\\": \\"主动减碳评估的文本\\"\\n }\\n}","type":"json"}]', 'title' => '获取减碳建议', 'description' => '用户指产品id，本接口返回获得已经生成结果页中的减碳建议。可用于了解针对产品碳排放的优化建议。', ], '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' => '工序-1/清单-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', ], ], ], ], ], ], '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' => '清单1', ], 'reductionList' => [ 'description' => '减排措施列表', 'type' => 'array', 'items' => [ 'description' => '清单项的减排措施', 'type' => 'string', 'example' => '措施1', ], ], 'sensitivity' => [ 'description' => '灵敏度百分比', 'type' => 'number', 'format' => 'double', 'example' => '91.7', ], ], ], ], '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', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4A0AEC56-5C9A-5D47-93DF-7227836FFF82\\",\\n \\"data\\": {\\n \\"dataQuality\\": [\\n {\\n \\"inventory\\": \\"工序-1/清单-1\\",\\n \\"score\\": {\\n \\"g1\\": 3,\\n \\"g2\\": 3,\\n \\"g3\\": 3,\\n \\"g4\\": 3\\n }\\n }\\n ],\\n \\"dataQualityResult\\": {\\n \\"data_quality_score\\": 1.2345,\\n \\"g1\\": 1.2345,\\n \\"g2\\": 1.2345,\\n \\"g3\\": 1.2345,\\n \\"g4\\": 1.2345\\n },\\n \\"sensitivityList\\": [\\n {\\n \\"id\\": \\"1\\",\\n \\"inventory\\": \\"清单1\\",\\n \\"reductionList\\": [\\n \\"措施1\\"\\n ],\\n \\"sensitivity\\": 91.7\\n }\\n ],\\n \\"uncertainty\\": \\"10.00\\",\\n \\"uncertaintyValues\\": [\\n {\\n \\"inventory\\": \\"工序-1/清单-1\\",\\n \\"uncertaintyContribution\\": \\"1.4964\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取数据质量评价结果DQR、DQI', 'description' => '用户指产品id，本接口返回获得已经生成结果页中的数据质量评价结果。可用于了解产品各清单的碳排因子的数据质量。', ], '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" .'- 统计模块类型信息', ], 'GetEmissionSourceConstitute' => [ 'summary' => '获取排放源构成。', '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"enterpriseName\\": \\"\\",\\n \\"rawData\\": 0,\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0,\\n \\"nameKey\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"emissionSourceKey\\": \\"\\",\\n \\"emissionSource\\": \\"\\",\\n \\"dataUnit\\": \\"\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"gasEmissionData\\": 0,\\n \\"carbonEmissionData\\": 0\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"\\",\\n \\"rawData\\": 0,\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0,\\n \\"nameKey\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"emissionSourceKey\\": \\"\\",\\n \\"emissionSource\\": \\"\\",\\n \\"dataUnit\\": \\"\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"gasEmissionData\\": 0,\\n \\"carbonEmissionData\\": 0\\n }\\n ],\\n \\"subConstituteItems\\": [\\n {\\n \\"enterpriseName\\": \\"\\",\\n \\"rawData\\": 0,\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0,\\n \\"nameKey\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"emissionSourceKey\\": \\"\\",\\n \\"emissionSource\\": \\"\\",\\n \\"dataUnit\\": \\"\\",\\n \\"envGasEmissions\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"gasEmissionData\\": 0,\\n \\"carbonEmissionData\\": 0\\n }\\n ],\\n \\"subConstituteItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', 'title' => '获取排放源构成', 'description' => '本接口的返回值是某组织在各个排放源类型及各个排放设施碳排放详情，数据结构是一个三层树形结构。使用本接口需要传入以下参数：'."\n" .'- 企业的唯一标识符'."\n" .'- 碳排统计年份'."\n" .'- 统计模块类型信息', ], '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" .'- 所需的趋势类型', ], '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' => '水电', ], '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' => '光电', ], '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' => '市电', ], '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' => '风电', ], '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' => '核电', ], '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' => '可再生能源电力'."\n" ."\n", ], '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' => '零电', ], '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\\": \\"水电\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\"\\n },\\n \\"light\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.2,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"光电\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\"\\n },\\n \\"urban\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.2,\\n \\"ratio\\": 0.4,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"市电\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\"\\n },\\n \\"wind\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 1.1,\\n \\"ratio\\": 0.3,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"风电\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\"\\n },\\n \\"nuclear\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 2,\\n \\"ratio\\": 0.6,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"核电\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\"\\n },\\n \\"renewing\\": {\\n \\"carbonEmissionData\\": 2.3,\\n \\"rawData\\": 4.3,\\n \\"ratio\\": 0.44,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"可再生能源电力\\\\n\\\\n\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.keZaiShengZiYuan\\"\\n },\\n \\"zero\\": {\\n \\"carbonEmissionData\\": 1.2,\\n \\"rawData\\": 444.3,\\n \\"ratio\\": 0.33,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"零电\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\"\\n }\\n },\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\"\\n}","type":"json"}]', 'title' => '电力构成分析', 'description' => '本接口的返回值是某组织不同电力类型的能源产生的碳排量。 接口需要传入的参数为：'."\n" .'- 企业的唯一标识符'."\n" .'- 碳排统计年份', ], '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' => '水电', ], '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' => '光电', ], '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' => '市电', ], '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' => '风电', ], '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' => '核电', ], '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' => '可再生电', ], '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' => '零电', ], '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\\": \\"水电\\",\\n \\"nameKey\\": \\"carbonInventory.check.water_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"光电\\",\\n \\"nameKey\\": \\"carbonInventory.check.light_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"市电\\",\\n \\"nameKey\\": \\"carbonInventory.check.urban_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"wind\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"风电\\",\\n \\"nameKey\\": \\"carbonInventory.check.wind_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"nuclear\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"核电\\",\\n \\"nameKey\\": \\"carbonInventory.check.nuclear_electricity\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"renewing\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"可再生电\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ],\\n \\"zero\\": [\\n {\\n \\"carbonEmissionData\\": 3.14,\\n \\"rawData\\": 3.14,\\n \\"ratio\\": 0.5,\\n \\"dataUnit\\": \\"kWh\\",\\n \\"name\\": \\"零电\\",\\n \\"nameKey\\": \\"carbonInventory.carbonEmissionAnalysis.components.CarbonDetail.lingTanDianLi\\",\\n \\"month\\": 12,\\n \\"year\\": \\"2024\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '电力趋势分析', 'description' => '1. 本接口返回值是一个列表，该列表的每一个元素是各种类型电力的排放列表。'."\n" .'2. 关于上述各种类型电力的排放列表，其元素包含：排放年份和月份、用电量及其单位、用电量对应的碳排，用电量占该月总用电量比例。', ], '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\\": 0,\\n \\"rawData\\": 0,\\n \\"ratio\\": 0,\\n \\"dataUnit\\": \\"\\",\\n \\"name\\": \\"\\"\\n }\\n ],\\n \\"light\\": [\\n {\\n \\"carbonEmissionData\\": 0,\\n \\"rawData\\": 0,\\n \\"ratio\\": 0,\\n \\"dataUnit\\": \\"\\",\\n \\"name\\": \\"\\"\\n }\\n ],\\n \\"urban\\": [\\n {\\n \\"carbonEmissionData\\": 0,\\n \\"rawData\\": 0,\\n \\"ratio\\": 0,\\n \\"dataUnit\\": \\"\\",\\n \\"name\\": \\"\\"\\n }\\n ],\\n \\"wind\\": [],\\n \\"nuclear\\": [],\\n \\"renewing\\": [],\\n \\"zero\\": []\\n },\\n \\"code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '场站电力分析', 'description' => '- 获取末级电力分析数据。'."\n" .'- 当code选择不同层级企业时，对当前层级下的企业进行分析。', ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": [\\n {\\n \\"type\\": 1,\\n \\"name\\": \\"CO₂\\",\\n \\"gasEmissionData\\": 3.14,\\n \\"carbonEmissionData\\": 3.14,\\n \\"ratio\\": 0.5\\n }\\n ]\\n}","type":"json"}]', 'title' => '气体构成分析', ], '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\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"weightingCarbonEmissionData\\": 0,\\n \\"weightingRatio\\": 0,\\n \\"ratio\\": 0,\\n \\"weightingProportion\\": 0,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"weightingCarbonEmissionData\\": 0,\\n \\"weightingRatio\\": 0,\\n \\"ratio\\": 0,\\n \\"weightingProportion\\": 0,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0\\n }\\n ],\\n \\"subEmissionItems\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"weightingCarbonEmissionData\\": 0,\\n \\"weightingRatio\\": 0,\\n \\"ratio\\": 0,\\n \\"weightingProportion\\": 0,\\n \\"moduleEmissionList\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"nameKey\\": \\"\\",\\n \\"carbonEmissionData\\": 0,\\n \\"ratio\\": 0\\n }\\n ],\\n \\"subEmissionItems\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '碳盘查组织分析', 'description' => '1. 本接口请求参数中的code为企业编码。'."\n" .'2. 本接口获取的是请求参数code对应的企业的数据及其递归子级数据。'."\n" .'3. 关于上述子级数据，其含义是，企业的子级企业的数据。'."\n" .'4. 关于上述子级企业的数据，其包含在企业数据的subEmissionItems字段中。'."\n" .'5. 关于上述的递归，其含义是，一直获取企业的子级数据，直到其没有子级企业为止。', ], '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": "sytem1",'."\n" .' "strategyId": "10324",'."\n" .' "controlId": "aaaaa-bbbbbb-cccc",'."\n" .' "propertyCode": "startUp",'."\n" .' "propertyValue": "20.1",'."\n" .' "sendTimestamp": "1000000001",'."\n" .' "executeTimestamp": "1000000008",'."\n" .' "status": "自动执行",'."\n" .' "remark": "执行原因"'."\n" .' },'."\n" .' {'."\n" .' "systemId": "sytem1",'."\n" .' "strategyId": "10324",'."\n" .' "controlId": "aaaaa-bbbbbb-cccc",'."\n" .' "propertyCode": "startUp",'."\n" .' "propertyValue": "20.1",'."\n" .' "sendTimestamp": "1000000001",'."\n" .' "executeTimestamp": "1000000008",'."\n" .' "status": "自动执行",'."\n" .' "remark": "执行原因"'."\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' => '策略执行状态反馈', ], 'SetRunningPlan' => [ 'summary' => '设置运行计划', 'path' => '/api/v1/carbon/hvac/setRunningPlan', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREenergyexpertXYPXBQ', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ 'factoryId' => [ 'description' => '场站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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '设置运行计划', ], 'EditUnfavorableAreaDevices' => [ 'summary' => '编辑不利区设备', 'path' => '/api/v1/carbon/hvac/editUnfavorableAreaDevices', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREenergyexpertYUWSCO', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ 'factoryId' => [ 'description' => '场站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' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '编辑不利区设备', '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。', ], 'EditProhibitedDevices' => [ 'summary' => '编辑禁用设备', 'path' => '/api/v1/carbon/hvac/editProhibitedDevices', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREenergyexpertYUWSCO', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ 'factoryId' => [ 'description' => '场站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' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bc20a5a-b26b-4c28-922a-7cd10b61f96f\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '编辑禁用设备', '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。', ], 'BatchUpdateSystemRunningPlan' => [ 'summary' => '批量设置空调站点运行计划。', 'path' => '/api/v1/carbon/hvac/batchUpdateSystemRunningPlan', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREenergyexpertXYPXBQ', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求参数。', 'type' => 'object', 'properties' => [ 'factoryId' => [ 'description' => '场站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' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '批量更新空调站点运行计划', ], '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' => '设备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, ], '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' => '推送设备测点数据', ], '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' => '主变4#', ], 'firstTypeName' => [ 'description' => '表计一级类型', 'type' => 'string', 'example' => '电表', ], 'secondTypeName' => [ 'description' => '表计二级类型', 'type' => 'string', 'example' => '关口表', ], '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' => 'A相电流', ], '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.', ], ], [ [ 'errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', ], ], 500 => [ [ 'errorCode' => 'systemError', 'errorMessage' => 'System error.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"主变4#\\",\\n \\"firstTypeName\\": \\"电表\\",\\n \\"secondTypeName\\": \\"关口表\\",\\n \\"recordList\\": [\\n {\\n \\"statisticsDate\\": \\"2022-07-26 00:00:00\\",\\n \\"paramName\\": \\"A相电流\\",\\n \\"unit\\": \\"A\\",\\n \\"identifier\\": \\"Ia\\",\\n \\"type\\": \\"DOUBLE\\",\\n \\"value\\": 20\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取设备数据', '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)进行开通。', ], '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' => '主变4#', ], 'firstTypeName' => [ 'description' => '表计一级类型', 'type' => 'string', 'example' => '电表', ], 'secondTypeName' => [ 'description' => '表计二级类型', 'type' => 'string', 'example' => '关口表', ], '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.', ], ], [ [ 'errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', ], ], 500 => [ [ 'errorCode' => 'systemError', 'errorMessage' => 'System error.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"deviceList\\": [\\n {\\n \\"deviceId\\": \\"pn_69873\\",\\n \\"deviceName\\": \\"主变4#\\",\\n \\"firstTypeName\\": \\"电表\\",\\n \\"secondTypeName\\": \\"关口表\\",\\n \\"parentDevice\\": \\"pn_6987\\",\\n \\"info\\": {\\n \\"magnification\\": 80,\\n \\"pressure\\": 0,\\n \\"pt\\": 80,\\n \\"ct\\": 1,\\n \\"constKva\\": 100\\n }\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n },\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]', 'title' => '获取设备列表', '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)进行开通。', ], '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' => '乐迪工业园', ], 'factoryList' => [ 'description' => '场站信息列表。', 'type' => 'array', 'items' => [ 'description' => '信息列表', 'type' => 'object', 'properties' => [ 'factoryId' => [ 'description' => '场站id', 'type' => 'string', 'example' => 'pn_95', ], 'factoryName' => [ 'description' => '场站名称', 'type' => 'string', 'example' => '乐迪工业园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.', ], ], [ [ 'errorCode' => 'notAuthorized', 'errorMessage' => 'No permissions to call API operations.', ], ], 500 => [ [ 'errorCode' => 'systemError', 'errorMessage' => 'System error.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": [\\n {\\n \\"aliyunPk\\": \\"1319XXXXXX64960\\",\\n \\"organizationId\\": \\"6265f42XXXX2fec150\\",\\n \\"organizationName\\": \\"乐迪工业园\\",\\n \\"factoryList\\": [\\n {\\n \\"factoryId\\": \\"pn_95\\",\\n \\"factoryName\\": \\"乐迪工业园1\\"\\n }\\n ]\\n }\\n ],\\n \\"httpCode\\": 200,\\n \\"code\\": \\"Success\\",\\n \\"success\\": true\\n}","type":"json"}]', 'title' => '获取组织和场站', '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' => '无请求参数，直接查询账号下激活的场站信息。', ], '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' => '租户', ], 'keyValue' => [ 'description' => '字段key值', 'type' => 'string', 'example' => '阿里云xxx有限公司', ], '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\\": \\"租户\\",\\n \\"keyValue\\": \\"阿里云xxx有限公司\\",\\n \\"context\\": {\\n \\"key\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取文档解析结果', ], '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', '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' => '默认为空', ], ], [ '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' => '提交文档解析作业 ', ], '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', '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' => '异步提交文档解析任务', ], 'GetDocParsingResult' => [ 'summary' => '用于文档解析结果查询。'."\n" .'入参taskId来自接口SubmitDocParsingTaskAdvance、SubmitDocParsingTask返回结果中的taskId。'."\n" .'查询结果有处理中、处理成功、处理失败三种情况。', '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"content\\": \\"{\\\\\\\\\\\\\\"doc_info\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"languages\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"zh\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"doc_type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pdf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pdf_toc\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"封面\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"page\\\\\\\\\\\\\\":0}],\\\\\\\\\\\\\\"pages\\\\\\\\\\\\\\":366,\\\\\\\\\\\\\\"page_list\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"imageWidth\\\\\\\\\\\\\\":596,\\\\\\\\\\\\\\"imageHeight\\\\\\\\\\\\\\":842,\\\\\\\\\\\\\\"pageIdAllDocs\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"fileIndex\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"pageIdCurDoc\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"angle\\\\\\\\\\\\\\":0}],\\\\\\\\\\\\\\"doc_data\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"about_us_para\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"page_num\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"before_text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"after_text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"extInfo\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"b0x1x0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pos\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":229,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":208},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":421,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":208},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":421,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":242},{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":229,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":242}],\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Kurt Götze\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pageNum\\\\\\\\\\\\\\":[0],\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":0}]}]}}\\"\\n }\\n}","type":"json"}]', 'title' => '获取文档解析结果', ], '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', '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、长文本理解信息抽取任务', ], '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' => '租户', ], '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\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取RAG、长文本理解文档抽取结果', ], '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', '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信息抽取任务', ], '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' => '租户', ], '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\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取文档VL抽取结果', ], '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\\": \\"\\"\\n }\\n ],\\n \\"value\\": [\\n {\\n \\"score\\": 0.45,\\n \\"type\\": \\"img\\",\\n \\"extInfo\\": [\\n {\\n \\"alignment\\": \\"center\\",\\n \\"index\\": 8,\\n \\"level\\": 2,\\n \\"pageNum\\": [\\n 1\\n ],\\n \\"pos\\": [\\n {\\n \\"x\\": 1,\\n \\"y\\": 2\\n }\\n ],\\n \\"subType\\": \\"picture\\",\\n \\"text\\": \\"版面内容\\",\\n \\"type\\": \\"table\\",\\n \\"uniqueId\\": \\"88c712db271443dd4e3697cb9b5dab3a\\"\\n }\\n ],\\n \\"text\\": \\"\\"\\n }\\n ],\\n \\"confidence\\": {\\n \\"keyConfidence\\": 0.9994202852249146,\\n \\"valueConfidence\\": 0.9794202852249146\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取VL实时解析结果', 'description' => '用户通过上传文档url，获取VL实时返回结果。', ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A8AEC6D9-A359-5169-BD1A-BD848BA60D65\\",\\n \\"data\\": [\\n {\\n \\"subFolders\\": [\\n {\\n \\"question\\": \\"\\",\\n \\"answer\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取问答目录列表', ], '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' => '创建问答会话', ], 'Retrieve' => [ 'summary' => '支持多文件夹ID或文件ID检索的RAG结果获取接口，供客户端自行加工结果并嵌入业务逻辑。', 'path' => '/api/v2/aidoc/knowledgebase/retrieve', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREenergyexpertK979RQ', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求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' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"jobId\\": \\"76cd1691-daf6-4113-8444-4998a25a5323\\",\\n \\"results\\": [\\n {\\n \\"score\\": 0,\\n \\"docName\\": \\"\\",\\n \\"rerankScore\\": 0,\\n \\"docId\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"weightedScore\\": 0,\\n \\"chunkId\\": \\"\\",\\n \\"chunkContent\\": \\"\\",\\n \\"docElsIds\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '检索知识库', ], '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', ], ], ], ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"sessionList\\": [\\n {\\n \\"sessionId\\": \\"5c748ef9-3f23-4b5a-916f-966c0d2c6dcd\\",\\n \\"name\\": \\"student_app_spelling\\",\\n \\"userId\\": \\"12222\\",\\n \\"folderId\\": \\"3493370b-4884-47dd-95ed-49038769af53\\",\\n \\"createTime\\": 0,\\n \\"updateTime\\": 0\\n }\\n ],\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10\\n }\\n}","type":"json"}]', 'title' => '获取文档会话列表', ], 'GetChatList' => [ 'summary' => '获取一个会话的历史问答。', '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\\\n\\",\\n \\"data\\": {\\n \\"total\\": 21,\\n \\"totalPage\\": 3,\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"chatList\\": [\\n {\\n \\"question\\": \\"\\",\\n \\"answer\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '获取问答列表', 'description' => '- 本接口通过传入的会话ID获取会话内的历史文档列表。'."\n" .'- sessionId信息通过GetChatSessionList获取。'."\n" .'- 同时可以通过CreateChatSession接口创建新的会话。', ], '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' => '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' => '2023年碳排468.1万吨', ], '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\\": \\"2023年碳排468.1万吨\\",\\n \\"document\\": [\\n \\"https://oss/aa.pdf\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '在线文档问答', ], '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' => '知识库问答文档如何获取', ], '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\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '文档问答', 'description' => '- 接口在会话选择的目录范围内提供问答服务。'."\n" .'- sessionId信息通过GetChatSessionList获取。'."\n" .'- 同时可以通过CreateChatSession接口创建新的会话。', ], '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' => '知识库问答文档如何获取', ], '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\\": 0,\\n \\"refDocList\\": [\\n {\\n \\"docName\\": \\"\\",\\n \\"sourceType\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"docInfo\\": {\\n \\"pages\\": 0,\\n \\"pageListInfo\\": [\\n {\\n \\"imageWidth\\": 0,\\n \\"imageUrl\\": \\"\\",\\n \\"pageIdCurDoc\\": 0,\\n \\"angle\\": 0,\\n \\"excelParseResult\\": \\"\\",\\n \\"wordParseResult\\": \\"\\",\\n \\"pdfParseResult\\": \\"\\",\\n \\"imageHeight\\": 0\\n }\\n ]\\n },\\n \\"originDocName\\": \\"\\",\\n \\"pageNum\\": [\\n {\\n \\"pos\\": [\\n [\\n {\\n \\"x\\": 0,\\n \\"y\\": 0\\n }\\n ]\\n ],\\n \\"num\\": 0\\n }\\n ],\\n \\"originDocUrl\\": \\"\\"\\n }\\n ],\\n \\"folderName\\": \\"\\",\\n \\"folderId\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '流式问答', 'description' => '- 接口在会话选择的目录范围内提供问答服务。'."\n" .'- sessionId信息通过GetChatSessionList获取。'."\n" .'- 同时可以通过CreateChatSession接口创建新的会话。', ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E38E561C-B996-0E19-8DBC-A218AAE17FBA\\",\\n \\"data\\": {\\n \\"folderId\\": \\"\\",\\n \\"folderNum\\": 0,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"\\",\\n \\"parentFolderId\\": \\"\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 0,\\n \\"syncStatus\\": 0,\\n \\"syncParsingStatus\\": 0,\\n \\"ossDomain\\": \\"\\",\\n \\"ossUpdateBy\\": \\"\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"\\",\\n \\"folderNum\\": 0,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"\\",\\n \\"parentFolderId\\": \\"\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 0,\\n \\"syncStatus\\": 0,\\n \\"syncParsingStatus\\": 0,\\n \\"ossDomain\\": \\"\\",\\n \\"ossUpdateBy\\": \\"\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"\\",\\n \\"subFolderList\\": [\\n {\\n \\"folderId\\": \\"\\",\\n \\"folderNum\\": 0,\\n \\"docCount\\": 0,\\n \\"folderName\\": \\"\\",\\n \\"parentFolderId\\": \\"\\",\\n \\"folderDefault\\": 0,\\n \\"currentLevel\\": 0,\\n \\"syncStatus\\": 0,\\n \\"syncParsingStatus\\": 0,\\n \\"ossDomain\\": \\"\\",\\n \\"ossUpdateBy\\": \\"\\",\\n \\"taskId\\": 0,\\n \\"resourcePath\\": \\"\\",\\n \\"storageType\\": 0,\\n \\"ossPath\\": \\"\\",\\n \\"subFolderList\\": []\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '创建文件夹', ], 'DeleteFolder' => [ 'summary' => '删除文件夹'."\n" .'删除成功则返回布尔值true，若删除不存在的文件夹则产生4xx错误（The folder does not exist.）。', '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '删除文件夹', ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": {\\n \\"id\\": 0,\\n \\"folderId\\": \\"\\",\\n \\"folderName\\": \\"\\",\\n \\"jobId\\": \\"\\",\\n \\"jobStatus\\": \\"\\",\\n \\"docName\\": \\"\\",\\n \\"originDocName\\": \\"\\",\\n \\"docUrl\\": \\"\\",\\n \\"originDocUrl\\": \\"\\",\\n \\"docHash\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"updateTime\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '获取文档信息', ], 'DeleteDocument' => [ 'summary' => '删除解析过的文件'."\n" .'通过传递目标删除文件对应的任务id来调用，删除成功则返回true，否则返回false。', '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"83A5A7DD-8974-5769-952E-590A97BEA34E\\",\\n \\"data\\": true\\n}","type":"json"}]', 'title' => '删除解析过的文件', ], ], 'endpoints' => [ [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'energyexpertexternal.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'energyexpertexternal.cn-hangzhou.aliyuncs.com', ], ], ];