Retrieves the generation progress of data semantics for an agent.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AgentName |
string |
Yes |
The name of the agent. |
bakehouse_agent |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Message |
string |
The response message. If the request fails, an error message is returned. |
Data semantics generation task not found. |
| RequestId |
string |
The unique identifier that Alibaba Cloud generates for the request. |
5DAF96FB-A4DF-548C-B8A1-F2A8D2F4**** |
| Data |
object |
The generation progress details. When the initial generation is complete, a full snapshot of the current generation round is returned. When regeneration is complete, the current Metrics, Joins, Examples, and new Text are returned. To discard a regeneration, first call Get to retrieve the current official version, and then call Save with the four types of content unchanged to idempotently clean up temporary results. |
|
| Stage |
string |
The current overall stage. |
GENERATE |
| Progress |
array |
The four-phase stage progress. This parameter may not be returned when the overall generation is complete. |
|
| AgentDataSemanticsStageProgress |
The execution progress of a single generation phase. |
||
| ErrorCode |
string |
The error code returned when the generation task fails. |
DataSemanticsGenerateFailed |
| ErrorMessage |
string |
The error message returned when the generation task fails. |
Failed to generate data semantics. Please retry later. |
| Metrics |
array |
The SQL expression knowledge returned when the generation is complete. A maximum of 100 items can be returned. |
|
|
AgentDataSemanticsMetric |
A single SQL expression knowledge entry. |
||
| Joins |
array |
The data association knowledge returned when the generation is complete. A maximum of 100 items can be returned. |
|
| AgentDataSemanticsJoin |
A single data association knowledge entry. |
||
| Examples |
array |
The SQL example knowledge returned when the generation is complete. A maximum of 50 items can be returned. |
|
| AgentDataSemanticsExample |
A single SQL example knowledge entry. |
||
| Text | AgentDataSemanticsText |
The Markdown text knowledge returned when the generation is complete. |
|
| Code |
string |
The response code of the operation. |
Success |
| Success |
boolean |
Indicates whether the call was successful. |
true |
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | Internal Server Error | |
| 403 | ServiceNotEnable | Service not enable | |
| 403 | EventHouseServiceNotEnable | EventHouse service not enable | |
| 404 | AgentNotFound | Agent not found. | |
| 404 | DataSemanticsGenerationNotExist | Data semantics generation task not found. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.