API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (energyExpertExternal/2022-09-23) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
carbon emission management
|
API |
Title |
Description |
| Reporting of carbon emission activity data | Reporting of carbon emission activity data | |
| GetDataItemList | GetDataItemList | Retrieves a list of data item details. |
| RecalculateCarbonEmission | RecalculateCarbonEmission | Recalculates carbon emissions. |
| Querying product carbon footprint | Querying product carbon footprint | |
| 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. |
| GetGwpInventorySummary | GetGwpInventorySummary | This operation 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. |
| Querying organization carbon inventory results | Querying 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 | This operation retrieves a gas composition analysis. |
| GetOrgConstitute | GetOrgConstitute | This operation retrieves analytical data for a carbon inventory organization. |
Energy saving and carbon reduction
|
API |
Title |
Description |
| Smart air conditioner control | Smart air conditioner 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. |
| Reporting energy consumption data | Reporting energy consumption data | |
| PushDeviceData | PushDeviceData | This operation 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. |
| 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. |
| 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. This operation 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. |
| CreateChatSession | Create Q\&A Session | You can create separate sessions for different user scenarios. The system automatically uses part of the Q&A history as context for each session to provide more accurate answers. |
| 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. |
| 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. |
| Chat | Document Q\&A | This operation provides a knowledge base service that answers questions based on documents in your selected folders. The service uses the question and answer (Q&A) history from the current session as context. |
| ChatStream | Streaming Document Q\&A | This operation provides a stream-based Question and Answer (Q&A) service for knowledge base documents. The service uses the history of Q&A pairs in a session as context and is limited to documents within the selected folders. |
| Directory Management | Directory Management | |
| AddFolder | AddFolder | Adds a folder and returns an entity that contains basic information about the folder. |
| 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." |
| Document Management | Document Management | |
| DetailDocument | DetailDocument | Retrieves the details of a document by its task ID. |
| DeleteDocument | DeleteDocument | Deletes a parsed file. You can call this operation by passing the task ID of the file that you want to delete. The operation returns true if the deletion is successful, or false otherwise. |
Others
|
API |
Title |
Description |
| AISearchResourceAdd | AISearchResourceAdd | Adds a structured element to an AISearch project. Supported element types include miniapp and product. |
| AISearchResourceDelete | AISearchResourceDelete | Delete a structured element from an AISearch project by specifying the resource type and resource ID. |
| 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. |
| 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. |
| 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. |
| GetPcrInfo | GetPcrInfo | Obtains the oss address of the Product Carbon footprint Report. |
| PushItemData | PushItemData | This interface is used to push data items. |
| SendDocumentAskQuestion | SendDocumentAskQuestion | null null |
| 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. |