{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-add":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_aisearch_resource_add","summary":"Adds a structured element to an AISearch project. Supported element types include miniapp and product","description":"POST /api/v1/aiSearch/resource/add","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"data":{"type":"string","description":"The information about the structured element that corresponds to the `type` parameter. Pass the value for this parameter in the specified…"},"type":{"type":"string","description":"The type of the structured element"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-delete":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_aisearch_resource_delete","summary":"Delete a structured element from an AISearch project by specifying the resource type and resource ID","description":"DELETE /api/v1/aiSearch/resource/delete","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","resourceId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"type":{"type":"string","description":"Structured element type"},"resourceId":{"type":"string","description":"Structured element resource ID. This is the unique and immutable identifier for the resource in the database"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-get-list":{"get":{"operationId":"cloud_aliyun_energyexpertexternal_aisearch_resource_get_list","summary":"When you query structured resources in AISearch, you must specify a resource type. The supported types are…","description":"GET /api/v1/aiSearch/resource/list","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"}},{"name":"type","in":"query","required":true,"description":"Structured element type","schema":{"type":"string","description":"Structured element type"},"example":"miniapp"},{"name":"resourceIds","in":"query","required":false,"description":"Resources to query. If empty, the API returns all resources of the specified type using paging (JSON-encoded)","schema":{"type":"string","description":"Resources to query. If empty, the API returns all resources of the specified type using paging (JSON-encoded)"}},{"name":"pageSize","in":"query","required":false,"description":"Paging size. Default is 20","schema":{"type":"integer","description":"Paging size. Default is 20"},"example":"20"},{"name":"currentPage","in":"query","required":false,"description":"Paging page number. Starts from 1","schema":{"type":"integer","description":"Paging page number. Starts from 1"},"example":"1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-update":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_aisearch_resource_update","summary":"Updates structured elements in an AISearch project. Supported element types include miniapps (miniapp) and…","description":"POST /api/v1/aiSearch/resource/update","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceId","type"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"data":{"type":"string","description":"Updates the information for the specified resource. Pass the fields to update in this parameter in JSON format. Fields that are not…"},"resourceId":{"type":"string","description":"The resource ID of the structured element. This ID is a unique and immutable identifier for the resource in the database"},"type":{"type":"string","description":"The type of the structured element"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/aisearch-stream":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_aisearch_stream","summary":"The AISearch Q&A interface answers customer questions using structured element information from the database…","description":"POST /api/v1/aiSearch/searchStream","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folderId","question"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"folderId":{"type":"string","description":"Folder ID. The knowledge base retrieval feature searches for Q\\&A content within the current folder and its subfolders"},"message":{"type":"array","description":"List of historical conversation records"},"question":{"type":"string","description":"User question"},"resourceTypeNeeded":{"type":"array","description":"This list supports three enumeration values: \"text\" (for knowledge base retrieval), \"miniapp\" (for miniapp retrieval in structured…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/add-folder":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_add_folder","summary":"Adds a folder and returns an entity that contains basic information about the folder","description":"POST /api/v1/aidoc/folder/add","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folderName","parentFolderId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"folderName":{"type":"string","description":"The name of the folder"},"parentFolderId":{"type":"string","description":"The ID of the parent folder. A value of 0 indicates the root directory"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/analyze-vl-realtime":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_analyze_vl_realtime","summary":"Extracts information from a VL in real time","description":"POST /api/v1/aidoc/document/analyzeVlRealtime","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"fileUrl":{"type":"string","description":"Choose either fileUrl or fileUrlObject. fileUrl: The URL of a single document. The document can have up to 1,000 pages and be up to 100 MB…"},"fileName":{"type":"string","description":"The filename must include the file extension"},"templateId":{"type":"string","description":"The unique ID of the extraction template, which specifies the content to extract from the document. To obtain the ID, log on to the…"},"language":{"type":"string","description":"The unique ID of the extraction template, which specifies the content to extract from the document. To obtain the ID, log on to the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/batch-save-instruction-status":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_batch_save_instruction_status","summary":"Provides feedback on the execution status of policies","description":"POST /api/v1/carbon/hvac/batchSaveInstructionStatus","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["factoryId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"factoryId":{"type":"string","description":"The factory ID"},"pKey":{"type":"string","description":"The source of the call"},"statusList":{"type":"string","description":"The list of instructions"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/batch-update-system-running-plan":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_batch_update_system_running_plan","summary":"Updates the running plans for multiple air conditioner sites in a batch","description":"POST /api/v1/carbon/hvac/batchUpdateSystemRunningPlan","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endTime","factoryId","startTime","systemId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"controlType":{"type":"integer","description":"The control mode, such as automatic or manual"},"dateType":{"type":"integer","description":"The date type, such as weekday or holiday"},"earliestStartupTime":{"type":"string","description":"The earliest startup time"},"endTime":{"type":"string","description":"The end time of the running plan"},"factoryId":{"type":"string","description":"The factory ID"},"latestShutdownTime":{"type":"string","description":"The latest shutdown time"},"maxCarbonDioxide":{"type":"number","description":"The maximum carbon dioxide concentration"},"maxTem":{"type":"number","description":"The maximum target temperature"},"minTem":{"type":"number","description":"The minimum target temperature"},"seasonMode":{"type":"integer","description":"The season mode, such as summer or winter"},"startTime":{"type":"string","description":"The start time of the running plan"},"systemId":{"type":"string","description":"The site ID"},"workingEndTime":{"type":"string","description":"The end time of the target period"},"workingStartTime":{"type":"string","description":"The start time of the target period"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/chat":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_chat","summary":"This API provides a knowledge base service that answers questions about documents in a selected folder,…","description":"POST /api/v2/aidoc/document/chat","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["question","sessionId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"documentIds":{"type":"array","description":"A list of document IDs to use for the Q\\&A. If you use this parameter, the corresponding session must have been created without a folder…"},"question":{"type":"string","description":"The content of the question"},"sessionId":{"type":"string","description":"The Q\\&A session ID. You can get previous sessions by calling the GetChatSessionList API. You can also create a new session by calling the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/chat-stream":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_chat_stream","summary":"This operation performs streaming Q&A on selected documents in a knowledge base, using the conversation…","description":"POST /api/v2/aidoc/document/chat/stream","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["question","sessionId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"documentIds":{"type":"array","description":"A list of document IDs for the Q\\&A. If you specify document IDs, ensure the `sessionId` you provide is not associated with a folder. The…"},"question":{"type":"string","description":"The question or prompt"},"sessionId":{"type":"string","description":"The Q\\&A session ID. Call the `GetChatSessionList` operation to retrieve the IDs of existing sessions. Alternatively, call the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/create-chat-session":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_create_chat_session","summary":"Creates a chat session for knowledge base question answering. Each session maintains its own Q&A history as…","description":"POST /api/v2/aidoc/document/chat/session/create","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folderId","name"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"folderId":{"type":"string","description":"The folder ID. The knowledge base Q\\&A feature retrieves Q\\&A pairs from the specified folder and its subfolders. If you set this…"},"name":{"type":"string","description":"The name of the current session"},"userId":{"type":"string","description":"The unique ID of the user. If not specified, the ID of the account that calls the SDK is used by default"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/delete-document":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_delete_document","summary":"Deletes a parsed file by task ID. Returns true on success, or false on failure","description":"DELETE /api/v1/aidoc/document/delete","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"taskId":{"type":"string","description":"The task ID of the file to delete. You can obtain this ID from the console or from other API operations"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/delete-folder":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_delete_folder","summary":"Deletes a folder. If the operation is successful, a Boolean value of `true` is returned. If the folder does…","description":"DELETE /api/v1/aidoc/folder/delete","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"folderId":{"type":"string","description":"The ID of the folder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/detail-document":{"get":{"operationId":"cloud_aliyun_energyexpertexternal_detail_document","summary":"Retrieves the details of a document by its task ID","description":"GET /api/v1/aidoc/document/detail","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"}},{"name":"taskId","in":"query","required":false,"description":"The task ID. Obtain this ID from the product's user interface or other API operations","schema":{"type":"string","description":"The task ID. Obtain this ID from the product's user interface or other API operations"},"example":"74ec62f4f4e74e5882d4086a40f2b9c6"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/edit-prohibited-devices":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_edit_prohibited_devices","summary":"Edits the list of prohibited devices","description":"POST /api/v1/carbon/hvac/editProhibitedDevices","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["factoryId","hvacDeviceConfigVOList","systemId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"factoryId":{"type":"string","description":"The factory ID"},"hvacDeviceConfigVOList":{"type":"array","description":"The list of device configurations"},"systemId":{"type":"string","description":"The site ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/edit-unfavorable-area-devices":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_edit_unfavorable_area_devices","summary":"Edits devices in unfavorable areas","description":"POST /api/v1/carbon/hvac/editUnfavorableAreaDevices","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["factoryId","hvacDeviceConfigVOList","systemId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"factoryId":{"type":"string","description":"The factory ID"},"hvacDeviceConfigVOList":{"type":"array","description":"The list of device configurations"},"systemId":{"type":"string","description":"The site ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/generate-result":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_generate_result","summary":"Generates a report for a specified carbon footprint","description":"POST /api/v1/carbon/footprint/result/generate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. Set this to \\`1\\` to request a product carbon footprint, or \\`5\\` to request a supply chain carbon footprint"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-area-elec-constitute":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_area_elec_constitute","summary":"Retrieves analytical data for power stations","description":"POST /api/v1/carbon/emission/analysis/elec/area","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"year":{"type":"integer","description":"The year"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-carbon-emission-trend":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_carbon_emission_trend","summary":"Queries the carbon emission trend","description":"POST /api/v1/carbon/emission/analysis/trend","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","trendType","yearList"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The organization code"},"moduleCode":{"type":"string","description":"The module code"},"moduleType":{"type":"integer","description":"The module type"},"trendType":{"type":"integer","description":"The trend type"},"yearList":{"type":"array","description":"The list of inventory years"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-chat-folder-list":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_chat_folder_list","summary":"Retrieves the list of Q&A pair folders","description":"POST /api/v2/aidoc/document/chat/folder/list","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-chat-list":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_chat_list","summary":"Retrieves the Q&A pair history for a session","description":"POST /api/v2/aidoc/document/chat/list","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"currentPage":{"type":"integer","description":"The page number for paging. The value starts from 1"},"pageSize":{"type":"integer","description":"The number of entries per page"},"sessionId":{"type":"string","description":"The ID of the Q\\&A session. This ID is used to track multiple Q\\&A pairs from the same user"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-chat-session-list":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_chat_session_list","summary":"Retrieves a list of a user's Q&A sessions","description":"POST /api/v2/aidoc/document/chat/session/list","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"currentPage":{"type":"integer","description":"The page number for paging. The default value is 1"},"name":{"type":"string","description":"The session name"},"pageSize":{"type":"integer","description":"The number of entries per page. The default value is 10"},"userId":{"type":"string","description":"The unique ID of the user. If this parameter is left empty, the ID of the account that calls the SDK is used by default"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-data-item-list":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_data_item_list","summary":"Retrieves a list of data item details","description":"POST /api/v1/carbon/emission/data/item/list","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-data-quality-analysis":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_data_quality_analysis","summary":"Retrieves the Data Quality Rating (DQR) and Data Quality Indicator (DQI) results","description":"POST /api/v1/carbon/footprint/data/quality/analysis","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","dataQualityEvaluationType","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"dataQualityEvaluationType":{"type":"integer","description":"The type of data quality evaluation. 1 indicates DQI and 2 indicates DQR"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. 1 indicates a product carbon footprint request. 5 indicates a supply chain carbon footprint request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-device-info":{"get":{"operationId":"cloud_aliyun_energyexpertexternal_get_device_info","summary":"Retrieves device information for an activated site","description":"GET /api/external/getDeviceInfo","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"}},{"name":"factoryId","in":"query","required":true,"description":"The site ID","schema":{"type":"string","description":"The site ID"},"example":"pn_95"},{"name":"deviceId","in":"query","required":true,"description":"The device ID","schema":{"type":"string","description":"The device ID"},"example":"pn_69873"},{"name":"ds","in":"query","required":true,"description":"The date string in the YYYY-MM-DD format","schema":{"type":"string","description":"The date string in the YYYY-MM-DD format"},"example":"2022-07-26"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-device-list":{"get":{"operationId":"cloud_aliyun_energyexpertexternal_get_device_list","summary":"Retrieves the list of devices for an activated site","description":"GET /api/external/getDeviceList","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"}},{"name":"factoryId","in":"query","required":true,"description":"The site ID","schema":{"type":"string","description":"The site ID"},"example":"pn_95"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-doc-extraction-result":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_doc_extraction_result","summary":"For Querying Information Extraction Result. The input parameter taskId is obtained from the taskId returned…","description":"POST /api/v2/aidoc/document/getDocExtractionResult","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["taskId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"taskId":{"type":"string","description":"Task ID. taskId is obtained from the SubmitDocExtractionTaskAdvance and SubmitDocExtractionTask interfaces"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-doc-parsing-result":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_doc_parsing_result","summary":"For Querying Document Parsing Results. The input parameter taskId is obtained from the taskId returned by…","description":"POST /api/v2/aidoc/document/getDocParsingResult","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["taskId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"returnFormat":{"type":"string","description":"The document parsing result supports two formats: markdown and json. By default, the result is returned in markdown format"},"taskId":{"type":"string","description":"Task ID. The taskId is obtained from the SubmitDocParsingTaskAdvance or SubmitDocParsingTask interfaces"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-document-analyze-result":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_document_analyze_result","summary":"Important: This API operation is no longer maintained. To obtain extraction results, use the…","description":"POST /api/v1/aidoc/document/getDocumentAnalyzeResult","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jobId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"jobId":{"type":"string","description":"The job ID. This ID specifies the document whose parsing result you want to query. The ID is returned by the API operation that submits a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-elec-constitute":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_elec_constitute","summary":"Retrieves electricity composition analysis data","description":"POST /api/v1/carbon/emission/analysis/elec/constitute","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"year":{"type":"integer","description":"The year"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-elec-trend":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_elec_trend","summary":"Retrieves electricity trend analysis data","description":"POST /api/v1/carbon/emission/analysis/elec/trend","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","yearList"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"yearList":{"type":"array","description":"A list of years"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-emission-source-constitute":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_emission_source_constitute","summary":"Retrieves the composition of emission sources","description":"POST /api/v1/carbon/emission/analysis/constitute","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","moduleType","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"moduleCode":{"type":"string","description":"The module code"},"moduleType":{"type":"integer","description":"The module type"},"year":{"type":"integer","description":"The inventory year"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-emission-summary":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_emission_summary","summary":"Retrieves a carbon emission summary","description":"POST /api/v1/carbon/emission/analysis/summary","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The code of the enterprise"},"moduleCode":{"type":"string","description":"The module code"},"moduleType":{"type":"integer","description":"The module type"},"year":{"type":"integer","description":"The inventory year"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-epd-inventory-constitute":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_epd_inventory_constitute","summary":"Retrieves the detailed results of environmental impact categories","description":"POST /api/v1/carbon/footprint/result/epd/inventory/constitute","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. Set this to 1 for a product carbon footprint request. Set this to 5 for a supply chain carbon footprint request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-epd-summary":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_epd_summary","summary":"Retrieves the total emissions for various environmental impact categories","description":"POST /api/v1/carbon/footprint/result/epd/summary","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. \\`1\\` indicates a product carbon footprint request. \\`5\\` indicates a supply chain carbon footprint request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-footprint-list":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_footprint_list","summary":"Retrieves a list of product carbon footprints","description":"POST /api/v1/carbon/footprint/product/list","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","currentPage","pageSize","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"currentPage":{"type":"integer","description":"The paging parameter. This is the page number. The value starts from 1"},"pageSize":{"type":"integer","description":"The page size"},"productType":{"type":"integer","description":"The product type. A value of 1 indicates a request for a product carbon footprint. A value of 5 indicates a request for a supply chain…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-gas-constitute":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_gas_constitute","summary":"Retrieves a gas composition analysis","description":"POST /api/v1/carbon/emission/analysis/gas/constitute","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","moduleType","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"moduleCode":{"type":"string","description":"The module code"},"moduleType":{"type":"integer","description":"The module type"},"year":{"type":"integer","description":"The year"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-gwp-benchmark-list":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_gwp_benchmark_list","summary":"Retrieves a ranked list of active carbon reduction initiatives","description":"POST /api/v1/carbon/footprint/result/gwp/benchmark/list","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. A value of 1 indicates a product carbon footprint request. A value of 5 indicates a supply chain carbon footprint request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-gwp-benchmark-summary":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_gwp_benchmark_summary","summary":"Retrieves the total proactive carbon reduction","description":"POST /api/v1/carbon/footprint/result/gwp/benchmark/summary","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. A value of \\`1\\` indicates a product carbon footprint request. A value of \\`5\\` indicates a supply chain carbon…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-gwp-inventory-constitute":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_gwp_inventory_constitute","summary":"Retrieves the carbon emission composition analysis for a specified product. The analysis provides a…","description":"POST /api/v1/carbon/footprint/result/gwp/inventory/constitute","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. A value of 1 indicates a request for a product carbon footprint. A value of 5 indicates a request for a supply chain…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-gwp-inventory-summary":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_gwp_inventory_summary","summary":"Retrieves the total carbon footprint of a product and provides details about its top four contributors","description":"POST /api/v1/carbon/footprint/result/gwp/inventory/summary","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. \\`1\\`: product carbon footprint. \\`5\\`: supply chain carbon footprint"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-inventory-list":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_inventory_list","summary":"Retrieves a descending list of emissions for a specified environmental impact (methodType), grouping level…","description":"POST /api/v1/carbon/footprint/result/inventory/list","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","emissionType","group","methodType","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"emissionType":{"type":"string","description":"The emission type. Valid values: \\`footprint\\` and \\`emission\\`. \\`footprint\\`: All inventories are included in the calculation.…"},"group":{"type":"string","description":"The grouping basis. Valid values: \\`resource\\`, \\`process\\`, \\`resourceType\\`, and \\`processType\\`. \\`resource\\`: Groups by inventory.…"},"methodType":{"type":"string","description":"The type of environmental impact. A value of \\`gwp\\` indicates the climate change carbon footprint. For other values, see the \\`type\\`…"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. A value of \\`1\\` indicates a product carbon footprint request. A value of \\`5\\` indicates a supply chain carbon…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-org-and-factory":{"get":{"operationId":"cloud_aliyun_energyexpertexternal_get_org_and_factory","summary":"Queries the organizations and sites that are activated for an account. Sites that are not activated in the…","description":"GET /api/external/getOrgAndFactory","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-org-constitute":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_org_constitute","summary":"Retrieves analytical data for a carbon inventory organization","description":"POST /api/v1/carbon/emission/analysis/org","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","moduleType","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The organization code"},"moduleCode":{"type":"string","description":"The module code"},"moduleType":{"type":"integer","description":"The module type"},"year":{"type":"integer","description":"The year"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-pcr-info":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_pcr_info","summary":"Retrieves the OSS URL of a product carbon footprint PCR report","description":"POST /api/v1/carbon/footprint/result/pcr/detail","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"string","description":"The product ID"},"productType":{"type":"integer","description":"The product type. Specify `1` for product carbon footprint or `5` for supply chain carbon footprint"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-reduction-proposal":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_reduction_proposal","summary":"Retrieves carbon reduction suggestions","description":"POST /api/v1/carbon/footprint/result/reduction/proposal","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","dataQualityEvaluationType","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"dataQualityEvaluationType":{"type":"integer","description":"The data quality evaluation type. A value of 1 indicates Data Quality Indicator (DQI). A value of 2 indicates Data Quality Rating (DQR)"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. A value of 1 indicates a product carbon footprint request. A value of 5 indicates a supply chain carbon footprint request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/get-vlextraction-result":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_get_vlextraction_result","summary":"For Querying Qwen-VL Model Information Extraction Results. The input parameter taskId is obtained from the…","description":"POST /api/v2/aidoc/document/getVLExtractionResult","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["taskId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"taskId":{"type":"string","description":"taskID. The taskId is obtained from the interfaces SubmitVLExtractionTaskAdvance and SubmitVLExtractionTask"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/is-completed":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_is_completed","summary":"Checks the completion status of a report generation task","description":"POST /api/v1/carbon/footprint/result/completed","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","productId","productType"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"productId":{"type":"integer","description":"The product ID"},"productType":{"type":"integer","description":"The product type. Set the value to \\`1\\` to request the carbon footprint of a product. Set the value to \\`5\\` to request the carbon…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/push-device-data":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_push_device_data","summary":"Pushes data from device data points, such as voltage data from an electric meter","description":"POST /api/v1/data/increment/push","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceType","devices"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"deviceType":{"type":"string","description":"The type of the device. For more information, see Device Type Definitions…"},"devices":{"type":"array","description":"A list of devices to push data for"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/push-item-data":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_push_item_data","summary":"This interface is used to push data items","description":"POST /api/v1/carbon/emission/data/item/push","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","items","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"items":{"type":"object","description":"List of data to be pushed"},"year":{"type":"string","description":"The year of the data created"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/recalculate-carbon-emission":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_recalculate_carbon_emission","summary":"Recalculates carbon emissions","description":"POST /api/v1/carbon/emission/data/item/recalculate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","year"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"code":{"type":"string","description":"The enterprise code"},"year":{"type":"string","description":"The inventory year"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/retrieve":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_retrieve","summary":"This API retrieves results for retrieval-augmented generation (RAG) from one or more folder or file IDs. You…","description":"POST /api/v2/aidoc/knowledgebase/retrieve","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"documentIds":{"type":"array","description":"Specify either documentIds or folderIds, but not both"},"folderIds":{"type":"array","description":"Specify either folderIds or documentIds, but not both"},"preRetrieveTopK":{"type":"integer","description":"The number of pre-retrieval results to return. Default: 0"},"query":{"type":"string","description":"The query statement"},"rerankerThreshold":{"type":"number","description":"The reranking score threshold. Results with scores below this threshold are filtered out. Default: 0.0"},"topK":{"type":"integer","description":"The number of top-ranked retrieval results to return. Default: 10"},"useReranker":{"type":"string","description":"Specifies whether to use the reranker. Default: true"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/send-document-ask-question":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_send_document_ask_question","summary":"null null","description":"POST /api/v1/aidoc/document/sendDocumentAskQuestion","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["prompt"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"folderId":{"type":"string","description":"Folder ID, used to specify the range of documents for the query. If it is empty, it indicates that all documents under the default folder…"},"prompt":{"type":"string","description":"The question queried by the user"},"sessionId":{"type":"string","description":"Q\\&A session ID, used to record multiple Q\\&A interactions of the same user. If it is empty, it indicates that sessions are not…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/set-running-plan":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_set_running_plan","summary":"Sets an execution plan","description":"POST /api/v1/carbon/hvac/setRunningPlan","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["factoryId","systemId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"controlType":{"type":"integer","description":"The control mode. For example, automatic or manual"},"dateType":{"type":"integer","description":"The date type. For example, weekday or holiday"},"earliestStartupTime":{"type":"string","description":"The earliest startup time"},"endTime":{"type":"string","description":"The end time of the plan"},"factoryId":{"type":"string","description":"The factory ID"},"latestShutdownTime":{"type":"string","description":"The latest shutdown time"},"maxCarbonDioxide":{"type":"number","description":"The maximum carbon dioxide concentration"},"maxTem":{"type":"number","description":"The maximum target temperature"},"minTem":{"type":"number","description":"The minimum target temperature"},"pKey":{"type":"string","description":"The source of the call"},"seasonMode":{"type":"integer","description":"The season mode. For example, summer or winter"},"startTime":{"type":"string","description":"The start time of the plan"},"statisticsTime":{"type":"string","description":"The date for which to set the single-day execution plan"},"systemId":{"type":"string","description":"The system ID"},"workingEndTime":{"type":"string","description":"The end time of the target period"},"workingStartTime":{"type":"string","description":"The start time of the target period"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/submit-doc-extraction-task":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_submit_doc_extraction_task","summary":"Extracts key information from a document based on a preset key-value template or prompt template. A…","description":"POST /api/v2/aidoc/document/submitDocExtractionTask","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fileName","templateId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"fileUrl":{"type":"string","description":"Choose one of the following parameters: fileUrl or fileUrlObject. fileUrl: The URL of a single document. The document can have a maximum…"},"fileName":{"type":"string","description":"The file name, including the file extension"},"templateId":{"type":"string","description":"The unique ID of the extraction template. This ID specifies the content to extract from the document. To obtain a template ID, log on to…"},"folderId":{"type":"string","description":"The unique ID of the knowledge base folder. Use this parameter to categorize documents or to limit the scope of documents for online Q\\&A…"},"extractType":{"type":"string","enum":["rag","longTextUnderstanding"],"description":"The document extraction type. Supported types include rag and long-text understanding. The default value is rag"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/submit-doc-parsing-task":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_submit_doc_parsing_task","summary":"Parses content, such as text, tables, and images, from a document. A successful call returns a task ID. You…","description":"POST /api/v2/aidoc/document/submitDocParsingTask","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fileName"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"fileUrl":{"type":"string","description":"Specify either \\`fileUrl\\` or \\`fileUrlObject\\`. \\`fileUrl\\`: The URL of the document. The document can be up to 3000 pages and 500 MB in…"},"fileName":{"type":"string","description":"The file name must include the file extension"},"folderId":{"type":"string","description":"The unique ID of the knowledge base folder. Use this ID to manage document classification and control the scope of documents for online…"},"needAnalyzeImg":{"type":"string","description":"Specifies whether to parse the image content in the document"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/submit-document-analyze-job":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_submit_document_analyze_job","summary":"The document parsing operation is used to extract the key content of a document and extract the key-value…","description":"POST /api/v1/aidoc/document/submitDocumentAnalyzeJob","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fileName","templateId"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"fileUrl":{"type":"string","description":"Choose one between fileUrl and fileUrlObject: fileUrl: Use the document URL method for a single document (supports documents with up to…"},"fileName":{"type":"string","description":"The filename must include the file type extension"},"templateId":{"type":"string","description":"The unique extraction template ID is used to specify the key-value pairs to be extracted from the document. You need to log in to the…"},"folderId":{"type":"string","description":"Unique knowledge base folder ID, used for categorizing documents and controlling the scope of online Q\\&A queries. If empty, the document…"},"analysisType":{"type":"string","description":"The default extraction method is \"doc\", with the following optional values: vl: Image processing doc: Long text RAG (Retrieval-Augmented…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/submit-vlextraction-task":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_submit_vlextraction_task","summary":"Extracts key information from documents using KV templates or prompts with the Qwen-VL model, ideal for…","description":"POST /api/v2/aidoc/document/submitVLExtractionTask","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fileName"],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"},"fileUrl":{"type":"string","description":"Choose one of fileUrl or fileUrlObject: fileUrl: Use by providing the document URL, for a single document (supports up to 1000 pages and…"},"fileName":{"type":"string","description":"The filename must include the file type suffix"},"folderId":{"type":"string","description":"Unique knowledge base folder ID, used when you need to categorize documents and control the scope of online Q\\&A queries. The folder ID…"},"templateId":{"type":"string","description":"Unique parsing template ID, used to specify the key-value pairs to be extracted from the document. You need to configure the template on…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-energyexpertexternal/version":{"post":{"operationId":"cloud_aliyun_energyexpertexternal_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://energyexpertexternal.ap-southeast-1.aliyuncs.com","https://energyexpertexternal.cn-hangzhou.aliyuncs.com"],"default":"https://energyexpertexternal.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}