Saves 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 |
| Metrics |
array |
No |
The SQL expression knowledge. If this parameter is specified, the current content is saved. If this parameter is not specified, the existing content is cleared. A maximum of 100 entries are supported, and the maximum size of each knowledge category is 16 KB. |
|
|
AgentDataSemanticsMetric |
No |
A single SQL expression knowledge entry. |
||
| Joins |
array |
No |
The data association knowledge. If this parameter is specified, the current content is saved. If this parameter is not specified, the existing content is cleared. A maximum of 100 entries are supported, and the maximum size of each knowledge category is 16 KB. |
|
| AgentDataSemanticsJoin |
No |
A single data association knowledge entry. |
||
| Examples |
array |
No |
The SQL example knowledge. If this parameter is specified, the current content is saved. If this parameter is not specified, the existing content is cleared. A maximum of 50 entries are supported, and the maximum size of each knowledge category is 16 KB. |
|
| AgentDataSemanticsExample |
No |
A single SQL example knowledge entry. |
||
| Text |
AgentDataSemanticsText |
No |
The text knowledge in Markdown format. If this parameter is specified, the current content is saved. If this parameter is not specified, the existing content is cleared. The maximum size of each knowledge category is 16 KB. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Message |
string |
The response message. If the call fails, an error message is returned. |
Invalid data semantics request. |
| RequestId |
string |
The unique identifier that Alibaba Cloud generates for the request. |
5DAF96FB-A4DF-548C-B8A1-F2A8D2F4**** |
| Data |
object |
The update result. If the save is successful, an empty object is returned with no additional business fields. If none of the four knowledge categories are specified, the target state is all four categories empty: if a non-empty current version exists, an all-empty version is published. If the current version is already all empty or no current version exists, the operation succeeds idempotently and the current round of pending generation results is finalized. |
{} |
| Code |
string |
The response code of the operation. |
Success |
| Success |
boolean |
Indicates whether the call is successful. |
true |
Examples
Success response
JSON format
{
"Message": "Invalid data semantics request.",
"RequestId": "5DAF96FB-A4DF-548C-B8A1-F2A8D2F4****",
"Data": {},
"Code": "Success",
"Success": true
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | Invalid data semantics request. | |
| 500 | InternalError | Internal Server Error | |
| 403 | ServiceNotEnable | Service not enable | |
| 403 | EventHouseServiceNotEnable | EventHouse service not enable | |
| 404 | AgentNotFound | Agent not found. | |
| 409 | DataSemanticsGenerationRunning | Data semantics generation task is already running. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.