Manage segments and processing tasks¶
Create, update, enable, switch, or delete segments in knowledge-base data sources, and query, reconcile, and reprocess data-processing tasks. This page does not add data sources or maintain semantic entries.
Prerequisites¶
Prepare credentials that can access the target workspace and IDs for the target knowledge base and data source. For service endpoints, authentication, and general request formats, see Prepare to call an API.
Before starting, confirm that the data source was added to the knowledge base. The specific input needed for segments, versions, and processing tasks is defined by the corresponding action pages.
Call sequence¶
First list data-processing tasks to understand processing tasks for the target data source.
To maintain content manually, create, import, or update segments, and retain segment or version IDs.
Use enable, disable, or switch-current-version actions to make a target segment version the currently usable version.
To reprocess data, submit a reconcile or re-vectorize action, then list processing tasks again to confirm the result.
API operations¶
Manage segments and versions¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Create a segment |
You identified the data source and segment content. |
|
Import initial segments |
Import a set of initial segments. |
|
Update a segment |
You have a target segment ID and need to modify content or configuration. |
|
Enable or disable a segment |
Change whether a segment participates in current use. |
|
Switch the current segment version |
Specify the segment version currently in use. |
|
Delete a segment |
Confirm impact and conditions on the action page before deletion. |
Process and reprocess data¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Query data-processing tasks |
View processing tasks and confirm later results. |
|
Reconcile data-processing tasks |
Reconcile processing tasks for a target data source. |
|
Re-vectorize data |
Re-vectorize the target data source. |
Confirm the result¶
After submitting a reconcile or re-vectorize action, use List data-processing tasks to view the target task. After segment changes, use the result instructions on the corresponding action page to confirm the current version and enabled state.
Limitations and notes¶
Deleting or disabling a segment, or switching the current version, changes segment results used later. Confirm impact and conditions on the corresponding action page before proceeding.