API overview-Energy Expert(Energy Expert)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (energyExpertExternal/2022-09-23) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

AISearch

API	Title	Description
AISearchResourceDelete	AISearchResourceDelete	Delete a structured element from an AISearch project by specifying the resource type and resource ID.
AISearchResourceUpdate	AISearchResourceUpdate	Updates structured elements in an AISearch project. Supported element types include miniapps (miniapp) and products (product).
AISearchStream	AISearchStream	The AISearch Q&A interface answers customer questions using structured element information from the database and content retrieved from the knowledge base.
AISearchResourceGetList	AISearchResourceGetList	When you query structured resources in AISearch, you must specify a resource type. The supported types are Mini Program (miniapp) and product. If you provide a resource ID, the query returns the specified resource. If you do not provide a resource ID, the query returns all resources of that type by paging.
AISearchResourceAdd	AISearchResourceAdd	Adds a structured element to an AISearch project. Supported element types include miniapp and product.

Carbon emission management

API	Title	Description
Submit carbon emission activity data	Submit carbon emission activity data
GetDataItemList	GetDataItemList	Retrieves a list of data item details.
RecalculateCarbonEmission	RecalculateCarbonEmission	Recalculates carbon emissions.
Query product carbon footprint results	Query product carbon footprint results
GetFootprintList	GetFootprintList	Retrieves a list of product carbon footprints.
GenerateResult	GenerateResult	Generates a report for a specified carbon footprint.
IsCompleted	IsCompleted	Checks the completion status of a report generation task.
GetPcrInfo	GetPcrInfo	Retrieves the OSS URL of a product carbon footprint PCR report.
GetGwpInventorySummary	GetGwpInventorySummary	Retrieves the total carbon footprint of a product and provides details about its top four contributors.
GetGwpBenchmarkSummary	GetGwpBenchmarkSummary	Retrieves the total proactive carbon reduction.
GetEpdSummary	GetEpdSummary	Retrieves the total emissions for various environmental impact categories.
GetInventoryList	GetInventoryList	Retrieves a descending list of emissions for a specified environmental impact (methodType), grouping level (group), and calculation method (emissionType).
GetGwpBenchmarkList	GetGwpBenchmarkList	Retrieves a ranked list of active carbon reduction initiatives.
GetGwpInventoryConstitute	GetGwpInventoryConstitute	Retrieves the carbon emission composition analysis for a specified product. The analysis provides a breakdown across two dimensions: by checklist and by type. The results are rendered as a hierarchical list and a pie chart.
GetEpdInventoryConstitute	GetEpdInventoryConstitute	Retrieves the detailed results of environmental impact categories.
GetReductionProposal	GetReductionProposal	Retrieves carbon reduction suggestions.
GetDataQualityAnalysis	GetDataQualityAnalysis	Retrieves the Data Quality Rating (DQR) and Data Quality Indicator (DQI) results.
Query organization carbon inventory results	Query organization carbon inventory results
GetEmissionSummary	GetEmissionSummary	Retrieves a carbon emission summary.
GetEmissionSourceConstitute	GetEmissionSourceConstitute	Retrieves the composition of emission sources.
GetCarbonEmissionTrend	GetCarbonEmissionTrend	Queries the carbon emission trend.
GetElecConstitute	GetElecConstitute	Retrieves electricity composition analysis data.
GetElecTrend	GetElecTrend	Retrieves electricity trend analysis data.
GetAreaElecConstitute	GetAreaElecConstitute	Retrieves analytical data for power stations.
GetGasConstitute	GetGasConstitute	Retrieves a gas composition analysis.
GetOrgConstitute	GetOrgConstitute	Retrieves analytical data for a carbon inventory organization.

Energy saving and carbon reduction

API	Title	Description
Intelligent air conditioning control	Intelligent air conditioning control
BatchSaveInstructionStatus	BatchSaveInstructionStatus	Provides feedback on the execution status of policies.
SetRunningPlan	SetRunningPlan	Sets an execution plan.
EditUnfavorableAreaDevices	EditUnfavorableAreaDevices	Edits devices in unfavorable areas.
EditProhibitedDevices	EditProhibitedDevices	Edits the list of prohibited devices.
BatchUpdateSystemRunningPlan	BatchUpdateSystemRunningPlan	Updates the running plans for multiple air conditioner sites in a batch.
Submit energy consumption data	Submit energy consumption data
PushDeviceData	PushDeviceData	Pushes data from device data points, such as voltage data from an electric meter.

Device management

API	Title	Description
GetDeviceInfo	GetDeviceInfo	Retrieves device information for an activated site.
GetDeviceList	GetDeviceList	Retrieves the list of devices for an activated site.
GetOrgAndFactory	GetOrgAndFactory	Queries the organizations and sites that are activated for an account. Sites that are not activated in the console are excluded from the response.

AI document processing

API	Title	Description
Document parsing	Document parsing
GetDocumentAnalyzeResult	GetDocumentAnalyzeResult	Important: This API operation is no longer maintained. To obtain extraction results, use the getDocExtractionResult or GetVLExtractionResult operation.
SubmitDocumentAnalyzeJob	SubmitDocumentAnalyzeJob	The document parsing operation is used to extract the key content of a document and extract the key-value information from the document based on the preset key-value template. The document parsing operation is an asynchronous operation. You need to call the asynchronous submission service for document parsing and then call the GetDocumentAnalyzeResult operation to perform result polling. The asynchronous submission service supports two methods: local files and URL files. Call the SubmitDocumentAnalyzeJob operation to upload URL files. Call the SubmitDocumentAnalyzeJobAdvance operation to upload local files.
SubmitDocParsingTask	Asynchronously Submit Document Parsing Task	Parses content, such as text, tables, and images, from a document. A successful call returns a task ID. You can then call `GetDocParsingResult` to retrieve the parsing results. The `SubmitDocParsingTask` operation asynchronously submits a task for a file URL. The `SubmitDocParsingTaskAdvance` operation asynchronously submits a task for a local file.
GetDocParsingResult	Get Document Parsing Result	For Querying Document Parsing Results. The input parameter taskId is obtained from the taskId returned by the interfaces SubmitDocParsingTaskAdvance or SubmitDocParsingTask. The query results can be one of three statuses: processing, successful, or failed.
Information extraction	Information extraction
SubmitDocExtractionTask	Asynchronously Submit RAG and Long Text Understanding Information Extraction Tasks	Extracts key information from a document based on a preset key-value template or prompt template. A successful call returns a task ID. You can then call GetDocExtractionResult to retrieve the extraction results. Asynchronously submits a task for a file specified by a URL. To submit a task for a local file, use the SubmitDocExtractionTaskAdvance operation.
GetDocExtractionResult	Retrieve RAG and Long Text Understanding Document Extraction Results	For Querying Information Extraction Result. The input parameter taskId is obtained from the taskId returned by the interfaces SubmitDocExtractionTaskAdvance or SubmitDocExtractionTask. The query results can reflect one of three statuses: processing, successfully completed, or failed.
SubmitVLExtractionTask	Asynchronously Submit VL Information Extraction Task	Extracts key information from documents using KV templates or prompts with the Qwen-VL model, ideal for image extraction. Supports: URL Upload: SubmitVLExtractionTask. Local File Upload: SubmitVLExtractionTaskAdvance
GetVLExtractionResult	Get VL Extraction Result	For Querying Qwen-VL Model Information Extraction Results. The input parameter taskId is obtained from the taskId returned by the interfaces SubmitVLExtractionTask or SubmitVLExtractionTaskAdvance. The query results can be in one of three statuses: processing, successfully completed, or failed.
AnalyzeVlRealtime	AnalyzeVlRealtime	Extracts information from a VL in real time.
Knowledge base Q&A	Knowledge base Q&A
GetChatFolderList	Get Q\&A folder List	Retrieves the list of Q&A pair folders.
GetChatSessionList	Get Document Session List	Retrieves a list of a user's Q&A sessions.
GetChatList	Get Q\\\&A List	Retrieves the Q&A pair history for a session.
SendDocumentAskQuestion	SendDocumentAskQuestion	null null
Chat	Document Q\&A	This API provides a knowledge base service that answers questions about documents in a selected folder, using the session's chat history as context.
ChatStream	Streaming Document Q\&A	This operation performs streaming Q&A on selected documents in a knowledge base, using the conversation history from a specified session as context.
Folder management	Folder management
AddFolder	AddFolder	Adds a folder and returns an entity that contains basic information about the folder.
File management	File management
DetailDocument	DetailDocument	Retrieves the details of a document by its task ID.

Others

API	Title	Description
CreateChatSession	Create Q\&A Session	Creates a chat session for knowledge base question answering. Each session maintains its own Q&A history as context to provide more accurate answers.
DeleteDocument	DeleteDocument	Deletes a parsed file by task ID. Returns true on success, or false on failure.
DeleteFolder	DeleteFolder	Deletes a folder. If the operation is successful, a Boolean value of `true` is returned. If the folder does not exist, a 4xx error is returned with the message "The folder does not exist."
Retrieve	Retrieve	This API retrieves results for retrieval-augmented generation (RAG) from one or more folder or file IDs. You can then process these results and embed them in your business logic.
PushItemData	PushItemData	This interface is used to push data items.