Tasks
Create Or Update 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
required string
articleuuid the uuid of the article to update or create
boolean
upsert 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
string
parent_drivefileuuid the uuid of the folder in which the article should be created
skip sync async
embedding_behavior 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
string
branch the branch to update, if left empty, will update both live and draft.
If the article does not exist, this parameter is ignored
Object
details the details of the article
Show child attributes
string
name the name of the article.
string
description the description of the article
boolean
archived whether the article should be archived
Object
content the content of the article
Show child attributes
string
text the full text of the article, typically in markdown
Object
categorization the categorization of the article
Show child attributes
Object
knowledge_library Show child attributes
string
library the library the article belongs to
Default: _org
string
room the room the article belongs to
Default: _org
string
shelf the shelf the article belongs to.
Object
settings the settings of the article
Show child attributes
Object
snippet the settings for the snippets that will be generated from the article
Show child attributes
Object
chunking the settings for how snippets will be chunked
Show child attributes
Object
methods the methods to use for chunking
Show child attributes
Object
md_headings settings for the md_headings chunking method, this is the default method
Show child attributes
boolean
enabled whether the md_headings chunking method is enabled
number
chunk_size the size of each chunk in tokens, max: 8191
number
chunk_overlap the overlap between chunks in tokens
Object
data Any custom data to be stored with the article
Result
Properties
Object
article the create or updated article
Show child attributes
string
articleuuid the uuid of the article
Object
details the details of the article
Show child attributes
string
name the name of the article
string
description the description of the article
boolean
archived whether the article is archived
Object
branches the branches of the article
Examples
Updating the content and name of an existing article.
Result
Archive an article.
Result