Tasks
Update Articles
Executes a bulk update on articles in your knowledge library.
Will update all articles that match filter
with the update
object.
- See updateMany documentation for more information.
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.
Parameters
required Object
filter filter to match documents to update
required Object
update update operations to perform
Show child attributes
required Object
set $set operations to perform. Only fields inside the details
and branches
paths are allowed
boolean
dry_run if true, the task will not be executed, but will return the count of documents that would be updated
Result
Properties
number
modified_count the number of documents that were modified
number
matched_count the number of documents that matched the filter
Object
debug debug information, only returned if dry_run
is true
Show child attributes
Object
filter the final filter that was used
Object
update the final update object that was used
Examples
Do a dry_run (preview) of changing all demo
shelf articles to the new_shelf
Result