API概览

本产品(energyExpertExternal/2022-09-23)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

碳排管理

API

标题

API概述

报送碳排放活动数据 报送碳排放活动数据
GetDataItemList 获取数据项详情列表 本接口用于获取数据项详情列表。
PushItemData 推送数据项数据 推送数据项数据。
RecalculateCarbonEmission 碳盘查重新计算 重新计算碳排放。
查询产品碳足迹结果 查询产品碳足迹结果
GetFootprintList 获取产品碳足迹列表 获取产品碳足迹列表。
GenerateResult 生成碳足迹结果 生成指定碳足迹的报告。
IsCompleted 生成报告完成状态查询 生成报告完成状态查询。
GetPcrInfo 获取产品碳足迹PCR报告OSS地址 获取产品碳足迹PCR报告OSS地址。
GetGwpInventorySummary 获取碳足迹总量 本接口用于获得产品碳足迹总量,以及碳足迹贡献占比的Top4类型详情。
GetGwpBenchmarkSummary 获取主动减碳量总量 获取主动减碳量总量。
GetEpdSummary 获取各种环境影响排放总量 获取各种环境影响排放总量。
GetInventoryList 获取排行列表 用于获取指定环境影响(methodType)、指定分组汇总级别(group)、指定计算方式下(emissionType)的降序排放列表。
GetGwpBenchmarkList 获取主动减碳排行列表 获取主动减碳排行列表。
GetGwpInventoryConstitute 获取碳排放构成分析层级图&饼状图 用于获取指定产品的碳排放构成分析。碳排放构成分析包括按清单、按类型两种分析维度。在呈现效果上,包括一个层级列表和饼状图。
GetEpdInventoryConstitute 获取环境影响类别的结果明细 获取环境影响类别的结果明细。
GetReductionProposal 获取减碳建议 获取减碳建议。
GetDataQualityAnalysis 获取数据质量评价结果DQR、DQI 获取数据质量评价结果DQR、DQI。
查询组织碳盘查结果 查询组织碳盘查结果
GetEmissionSummary 获取碳排汇总 获取碳排汇总。
GetEmissionSourceConstitute 获取排放源构成 获取排放源构成。
GetCarbonEmissionTrend 获取碳排趋势 获取碳排放趋势。
GetElecConstitute 电力构成分析 本接口用于获取电力构成分析数据。
GetElecTrend 电力趋势分析 本接口用于获取电力趋势分析数据。
GetAreaElecConstitute 场站电力分析 本接口用于获取电力场站分析数据。
GetGasConstitute 气体构成分析 本接口用于获取气体构成分析。
GetOrgConstitute 碳盘查组织分析 本接口用于获取碳盘查组织分析数据。

节能减碳

API

标题

API概述

空调智控 空调智控
BatchSaveInstructionStatus 策略执行状态反馈 策略执行状态反馈
SetRunningPlan 设置运行计划 设置运行计划
EditUnfavorableAreaDevices 编辑不利区设备 编辑不利区设备
EditProhibitedDevices 编辑禁用设备 编辑禁用设备
BatchUpdateSystemRunningPlan 批量更新空调站点运行计划 批量设置空调站点运行计划。
报送能耗数据 报送能耗数据
PushDeviceData 推送设备测点数据 本接口用于推送设备测点数据,例如推送电能表电压等数据。

设备管理

API

标题

API概述

GetOrgAndFactory 获取组织和场站 查询账号激活的相关组织和场站。需注意的是未在控制台进行激活的场站不会被查询到。
GetDeviceList 获取设备列表 查询账号激活场站的设备列表。
GetDeviceInfo 获取设备数据 查询账号激活场站的设备信息。

AI文档处理

API

标题

API概述

文档解析 文档解析
SubmitDocParsingTask 异步提交文档解析任务 用于解析文档中的文字、表格、图片等内容。 调用成功后返回taskId,后续调用GetDocParsingResult获取文档解析结果。 支持本地文件和URL文件两种方式: URL上传的异步提交任务接口为:SubmitDocParsingTask接口。 本地文件上传的异步提交任务接口为:SubmitDocParsingTaskAdvance接口。
GetDocParsingResult 获取文档解析结果 用于文档解析结果查询。 入参taskId来自接口SubmitDocParsingTaskAdvance、SubmitDocParsingTask返回结果中的taskId。 查询结果有处理中、处理成功、处理失败三种情况。
信息抽取 信息抽取
SubmitDocExtractionTask 异步提交RAG、长文本理解信息抽取任务 用于从文档中提取关键信息,它根据用户预设的Key-Value模板或提示词模板进行信息抽取。 调用成功后返回taskId,后续调用GetDocExtractionResult获取信息抽取结果。 支持本地文件和URL文件两种方式: URL上传的异步提交服务接口为:SubmitDocExtractionTask接口。 本地文件上传的异步提交服务接口为:SubmitDocExtractionTaskAdvance接口。
GetDocExtractionResult 获取RAG、长文本理解文档抽取结果 用于文档信息抽取结果查询。 入参taskId来自接口SubmitDocExtractionTaskAdvance、SubmitDocExtractionTask返回结果中taskId。 查询结果有处理中、处理成功、处理失败三种状态。
SubmitVLExtractionTask 异步提交VL信息抽取任务 用于从文档中提取关键信息,它根据用户预设的Key-Value模板或提示词模板进行信息抽取。VL信息抽取接口采用Qwen-VL模型,特别适用于从图片中提取信息。 调用成功后返回taskId,后续调用GetVLExtractionResult获取信息抽取结果。 支持本地文件和URL文件两种方式: URL上传的异步提交服务接口为:SubmitVLExtractionTask接口。 本地文件上传的异步提交服务接口为:SubmitVLExtractionTaskAdvance接口。
GetVLExtractionResult 获取文档VL抽取结果 用于获取Qwen-VL模型执行信息抽取的结果。 入参taskId来自SubmitVLExtractionTask、SubmitVLExtractionTaskAdvance返回结果中的taskId。 查询结果有处理中、处理成功、处理失败三种情况。
AnalyzeVlRealtime 获取VL实时解析结果 实时VL信息抽取
知识库问答 知识库问答
GetChatFolderList 获取问答目录列表 获取问答目录列表
CreateChatSession 创建问答会话 每个用户可以根据需要创建会话,建议根据用户的使用场景区分不同的会话。 在每个会话中,系统会自动将部分历史问答作为上下文,从而为最新一轮的问答交互提供更精准的回答。
GetChatSessionList 获取文档会话列表 获取用户问答会话列表。
GetChatList 获取问答列表 获取一个会话的历史问答。
Chat 文档问答 本接口在用户选择的文档目录范围内,结合会话内的历史问答作为上下文,提供基于知识库文档的服务。
ChatStream 流式问答 本接口在用户选择的文档目录范围内,结合会话内的历史问答作为上下文,提供基于知识库文档的流式问答服务。
目录管理 目录管理
AddFolder 创建文件夹 创建文件夹 对用户而言,同一个父目录下不得存在两个同名的文件夹 创建成功则返回一个实体,包含该文件夹的基本信息
DeleteFolder 删除文件夹 删除文件夹 删除成功则返回布尔值true,若删除不存在的文件夹则产生4xx错误(The folder does not exist.)
文件管理 文件管理
DeleteDocument 删除解析过的文件 删除解析过的文件 通过传递目标删除文件对应的任务id来调用,删除成功则返回true,否则返回false

其他

API

标题

API概述

GetDocumentAnalyzeResult 获取文档解析结果 【重要】该接口不再维护,请使用getDocExtractionResult、GetVLExtractionResult获取抽取结果。
SubmitDocumentAnalyzeJob 提交文档解析作业 【重要】该接口不再维护,请使用以下接口: 文档解析使用submitDocParsingTask。 文档抽取使用SubmitVLExtractionTask、SubmitDocExtractionTask。
SendDocumentAskQuestion 在线文档问答 【重要】该接口不再维护,请使用Chat接口替代。