Tasks
Update Knowledge Library Article
Adds or updates an article in the knowledge library
Libraries, rooms and shelves are used to categorize articles in the knowledge library, and will be automatically created if they do not exist.
Basic usage
Create a new knowledge library article on the demo shelf.
Parameters
articleuuid required string
the uuid of the article to update or create
upsert boolean
should a new article be created if an article with the provided uuid does not exist.
The task will fail if the article does not exist and upsert is false
Default: true
parent_drivefileuuid string
the uuid of the folder in which the article should be created
embedding_behavior skip sync async
Embedding/vectorizing behavior:
skip- skip the vectorization and embedding stepsync- wait for embedding to completeasync- embed but dont wait for it to finish
Default: sync
branch string
the branch to update, if left empty, will update both live and draft.
If the article does not exist, this parameter is ignored
details Object
the details of the article
Show child attributes
name string
the name of the article.
description string
the description of the article
archived boolean
whether the article should be archived
source Object
the source of the article
content Object
the content of the article
Show child attributes
text string
the full text of the article, typically in markdown
merge_strategy 'overwrite' 'prepend' 'append'
how the new content should be merged with the existing content. - 'overwrite' (default) to replace the existing content - 'append' to add to the end - 'prepend' to add to the beginning
Default: overwrite
categorization Object
the categorization of the article
Show child attributes
knowledge_library Object
Show child attributes
library string
the library the article belongs to
Default: _org
room string
the room the article belongs to
Default: _org
shelf string
the shelf the article belongs to.
settings Object
the settings of the article
Show child attributes
chunking Object
the settings for how the article will be chunked
Show child attributes
chunk_size Object
the size of each chunk in tokens, max: 8191
data Object
Any custom data to be stored with the article
Result
Properties
article Object
the create or updated article
Show child attributes
articleuuid string
the uuid of the article
details Object
the details of the article
Show child attributes
name string
the name of the article
description string
the description of the article
archived boolean
whether the article is archived
branches Object
the branches of the article
Examples
Updating the content and name of an existing article.
Result
Archive an article.
Result