1. Tasks
  2. Update Articles

Tasks

Update Articles

Executes a bulk update on articles in your knowledge library.

Will update all articles that match filter with the update object.

WARNING

This will not trigger embedding/syncing of the articles to the vector database.
You will have to trigger the embedding/syncing of the articles separately if needed.

Bulk archiving articles will however remove them from the vector database.

Basic usage

Archive all articles whose draft branch are on the demo shelf.

loading...

Parameters

filter
required
Object

filter to match documents to update


update
required
Object

update operations to perform

Show child attributes
set
required
Object

$set operations to perform. Only fields inside the details and branches paths are allowed


dry_run
boolean

if true, the task will not be executed, but will return the count of documents that would be updated


Result

loading...

Properties

modified_count
number

the number of documents that were modified


matched_count
number

the number of documents that matched the filter


debug
Object

debug information, only returned if dry_run is true

Show child attributes
filter
Object

the final filter that was used

update
Object

the final update object that was used


Examples

Do a dry_run (preview) of changing all demo shelf articles to the new_shelf

loading...

Result

loading...