Skip to main content
Feedback

Asset states reference

note

Knowledge Hub is an Early Access release. Refer to the Early Access disclaimer for details.

This topic is a single reference for all state values across Repositories, Knowledge Bases, and Sources. Use it to understand what each state means and which transitions are allowed.

Repository states

StateIngestionRetrievalKnowledge Bases affectedTransition to
EnabledRuns on scheduleServedActiveDisabled
DisabledPausedNot servedAll Knowledge Bases pausedEnabled
caution

Deleting a repository permanently removes it and all Knowledge Bases and Sources within it. This action cannot be undone.

Archiving is not currently supported for repositories; Delete is the only way to permanently remove one.

Knowledge Base states

StateIngestionRetrievalTransition to
DraftCan run (Sources can be added and enabled)Not servedEnabled (using Publish)
EnabledRuns on scheduleServedNone currently. Use Delete to remove the Knowledge Base.
note

You currently cannot disable or archive a Knowledge Base. However, when available, disabling a Knowledge Base will not change the state of its Sources but will halt ingestion runs.

A Knowledge Base in Draft state cannot serve retrieval queries even if ingestion has run. You must publish it to make it available to agents. Refer to Publishing Knowledge Base.

Source states

StateIngestionData retainedTransition to
DraftNot started. Enabling required.No data yetEnabled (using Enable)
EnabledRuns on configured scheduleYesDisabled
DisabledPausedYesEnabled

Archiving is not currently supported for Sources; Remove is the only way to permanently delete one.

State dependency rules

The following rules govern how parent state affects child state:

  • A Knowledge Base cannot serve retrieval if the parent Repository is Disabled.
  • Deleting a Repository permanently removes all Knowledge Bases and Sources within it.
  • Deleting a Knowledge Base permanently removes all Sources within it.
  • Disabling a Repository does not permanently affect Knowledge Base or Source states. Re-enabling the Repository restores the previous state.

Allowed actions by state

Repository

ActionAvailable in state
Create Knowledge BaseEnabled
DisableEnabled
EnableDisabled
DeleteEnabled, Disabled

Knowledge Base

ActionAvailable in state
Add SourceDraft, Enabled
PublishDraft (requires at least one Enabled Source)
DeleteDraft, Enabled

Source

ActionAvailable in state
EnableDraft, Disabled
Run nowEnabled
EditDraft, Enabled
DisableEnabled
RemoveAny
On this Page