Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sync & versions

How file updates reach agents through sync and knowledge versions.

A knowledge base uses files from its datasets. Update a file, then sync it to create a knowledge version. Agents use the latest completed version, so sync provides a controlled way to update their source knowledge.

Open a knowledge base and select Datasets to manage file updates and sync status.

At a glance

Goal
Action
Result

Update knowledge

Upload a new file version, then sync it.

Agents use the updated content after sync completes.

Review changes

Open the knowledge version menu.

See versions and the change that created each one.

Go back to a version

Choose it in the version menu, then Revert.

A new version holds that version's files.

Keep a dataset current

Enable auto sync.

Eligible new files sync automatically.

Publish a version

Select Publish in the header.

The latest version is marked published, after approval if your account requires it.

Resolve an issue

Filter for items needing attention.

Find failed and stale files.

How updates reach agents

File → dataset → sync → knowledge version → agents

A dataset holds source files. Adding or replacing a file does not update a knowledge base immediately. The file remains Ready to sync until you sync it.

A completed sync is live. Publishing is a separate step. It marks a version as published, and it doesn't change which version agents or Try Knowledge answer from. Validate important updates in Try Knowledge, then compare answers with the previous version when needed. See Publish a version.

Before sync

  • A new file version remains outside the knowledge base.

  • Agents continue using the previous knowledge version.

  • You can review the replacement before it becomes active.

After sync

  • Each synced file creates a knowledge version.

  • Agents use the latest completed version.

  • The file status changes to Synced.

Knowledge and file versions

Knowledge versions record how the knowledge base changed. The version history shows the latest version first, including:

  • The file that a sync added.

  • A dataset attachment.

  • The initial knowledge-base version.

Each completed file sync creates a separate knowledge version. Version numbers only increase. Earlier versions remain available for queries in Try Knowledge. To go back to one, see Preview or revert to an earlier version.

To update a file, select ⋮ → Upload new version, then choose the replacement from your computer, Google Drive, OneDrive, SharePoint, or a website. The file retains its name and receives the next file version number. Use Version history to review earlier file versions.

Preview or revert to an earlier version

Open the version dropdown in the header. It lists each version with its age and the change that made it, for example Version 2 (Latest) and Version 1 (Initial Version). Choose an older one.

Preview Version 1 opens and says: "You are about to view Version 1 from 3 Hrs ago. This will temporarily load the selected version. Your current version will remain unchanged. Do you want to continue?"

  • View Version 1 loads the old version read-only. The version select is greyed, and Back to Latest returns you. A version that held no files shows Version 1 held no files.

  • Revert to Version 1 makes that version's files current. It does not replace the latest version. It adds a new version, noted Restored version 1, that holds the chosen version's files, so history is kept. Files that are no longer available are skipped.

Reverting needs edit access to the knowledge base, and it is refused while a sync is running. Retry is not offered while you view an older version.

Publish a version

Publishing marks a knowledge version as published. It applies to the latest version, the one named on the version dropdown, for example v2. A knowledge base counts as a draft until a version is published: its card on MY KNOWLEDGE shows Draft, and Published once any version has been published. Publishing a later version doesn't change the badge.

Select Publish in the header of the knowledge base, next to Try Knowledge. A window titled Publish Knowledge opens.

  • When your account requires approval, it reads Send version v2 for approval? It is marked as published once approved. Confirm, and a Pending Approval message appears: Version v2 has been sent for approval and will be published once approved. The header button changes to Pending Approval. A reviewer approves or rejects the request in Publish Review. After approval the button reads Published. After a rejection it goes back to Publish, and you can submit the version again.

  • When approval is off, the window reads Publish version v2? It goes live straight away.

Why you may not see an approval step. Approval is a separate setting for each kind of publish. If the count for knowledge versions is 0 in your account, Publish takes effect at once and no request is created, even when other kinds, such as design systems or apps, still need review. An administrator changes the count through the API. See How approval works.

Publish is unavailable, with a reason, in these cases:

When
What the button says

The knowledge base has no version yet

Sync this knowledge to create a version before publishing

No file has been synced into it

Sync at least one file into this knowledge before publishing

It is still processing

This knowledge is still processing. Publish once it finishes

Your role can't request a knowledge publish

A message that you don't have access

To publish, you need edit access to the knowledge base and a role with Request knowledge publish. Developer, Governance Manager, Account Admin, and Organisation Admin have it. Approving is a separate capability: see Publish Review.

Sync files

Choose the scope that matches your change:

Select Sync ready files to sync every ready file across the knowledge base. This option is unavailable when no files are ready.

Select Sync N ready on a dataset to sync only that dataset's ready files. Use Re-sync all when no files are ready but the dataset needs syncing again.

Use the dataset menu for targeted actions:

Action
Use it when

Sync all preprocessed files

All processed files in the dataset should be current.

Force re-sync everything

You need to rebuild this dataset's contribution.

Retry failed files only

Only failed files need another attempt.

Upload files to dataset

You have new source material.

Detach dataset

This knowledge base should no longer use the dataset.

Retry failed files only tries failed files again. Qore retries a failing file automatically up to three times. After that it stops, but you can still retry the file by hand, from the dataset menu or from the failed row.

Auto sync

Enable Auto sync from the dataset menu when new files should sync without manual action. Use manual sync for content that requires review before agents use it, such as policies or rate information.

Understand statuses

Dataset status shows whether its files are available to the knowledge base. The status summary tracks attached files, fully synced datasets, ready files, files in progress, and failed files.

Dataset status
Meaning

Not synced

No files from this dataset are in the knowledge base.

Partially synced

Some files are synced and others are not.

Auto sync

New eligible files sync automatically.

Each file has independent discovery and sync statuses.

Discovery status

Status
Meaning

Discoverable

Indexed and searchable.

Preparing for discovery

Being indexed.

Sync status

Status
Action

Ready to sync

Sync the file.

Syncing

Wait for completion.

Synced

No action is needed.

New version available

Sync the newer file version.

Sync failed

Retry the file.

Not eligible

Wait for discovery to finish.

A file can be Discoverable and Ready to sync. It is searchable as a source, but agents do not yet answer from it.

Resolve items needing attention

Items need attention when a file failed or a newer file version is available. Select Review to see those items, or filter by All, Needs attention, Ready to sync, Processing, or Synced. Search by dataset or file name to find a specific item.

For failed processing, retry the file after addressing the source issue. See When processing fails for common causes and retry guidance.

One dataset can support several knowledge bases. Syncing it in one knowledge base does not update the others. Each knowledge base maintains its own sync statuses and knowledge versions.

Last updated

Was this helpful?