Manage semantic entries¶
Create, validate, query, update, import, export, or delete semantic entries in a target knowledge base. This page covers semantic entries only; adjacent task pages manage knowledge bases, data sources, and segments.
Prerequisites¶
Prepare credentials that can access the target workspace and the target knowledge base ID. For service endpoints, authentication, and general request formats, see Prepare to call an API.
Before importing, exporting, or modifying entries in bulk, query existing semantic entries and use the result to identify the objects to operate on.
Call sequence¶
First list semantic entries to confirm existing entries in the target knowledge base.
Before creating or importing entries in bulk, use Validate semantic entries to check the content to write.
After validation, create, import, or update entries. Export existing entries when you need to exchange content, or import prepared entries.
Query entries again after completion. Before deletion, confirm the target entries and scope of impact.
API operations¶
Validate and write semantic entries¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Validate semantic entries |
Check content to write before creating, importing, or updating. |
|
Create a semantic entry |
You have prepared a single entry. |
|
Update a semantic entry |
You identified a target entry and need to modify it. |
|
Import semantic entries |
You prepared batch entries and they passed the required checks. |
Query, exchange, and delete semantic entries¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Query semantic entries |
Select, review, or confirm target entries. |
|
Export semantic entries |
Obtain existing entries for backup or migration. |
|
Delete semantic entries |
Confirm impact and conditions on the action page before deletion. |
Confirm the result¶
After creating, importing, or updating, list semantic entries to confirm the target entries. Use the same operation after deletion to confirm whether an entry remains in the result.
Limitations and notes¶
Deletion affects the target semantic entries; importing and updating change existing content. Confirm conditions and results on the relevant action page before proceeding.