Delete semantic entries¶
Delete a semantic entry in the knowledge base.
DELETE $CLOUDSIGMA_API_BASE/semantic-models/{model_id}/entries/{entry_id}
Before you call this API¶
Configure the regional API endpoint and authentication, and select the target workspace.
First query the semantic entry to obtain the entry ID to be deleted.
Set the operation-specific values used in the request:
$MODEL_ID: Knowledge Base ID.$ENTRY_ID: ID of the semantic entry to delete.
Request¶
curl -X DELETE "$CLOUDSIGMA_API_BASE/semantic-models/$MODEL_ID/entries/$ENTRY_ID" \
-H "X-API-Key: $CLOUDSIGMA_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
Path parameters
Parameters |
Type |
Description |
|---|---|---|
|
integer |
Knowledge base ID. |
|
integer |
ID of the semantic entry to delete. |
Successful response¶
Returns 200 on success. After deletion, the verification interface should be called to confirm that the remaining definitions are still valid.
{
"code": "OK",
"msg": "OK",
"data": {
"deleted": true
}
}
The response fields are as follows.
Field |
Type |
Description |
|---|---|---|
|
string |
|
|
string |
|
|
boolean |
|
Error response¶
{
"code": "ErrNotFound",
"msg": "resource not found",
"data": null
}
Common HTTP errors¶
HTTP status code |
error code |
Common causes |
Recommended actions |
|---|---|---|---|
|
|
|
Use the integer ID from the response. |
|
|
The API Key is invalid or has expired. |
Check API Key. |
|
|
The caller does not have delete permission. |
Check workspace and object authorization. |
|
|
The knowledge base or entry does not exist or is not visible to the current caller. |
Reconfirm ID. |
|
|
The service failed to delete the entry. |
Keep the desensitized response information and try again. |
Follow-up operations¶
Verify semantic entries confirms that the remaining definitions are still valid.