Tasks
Find In Knowledge Library
Finds text in knowledge library articles using regex search and returns matching passages with context.
Basic usage
Find exact text in your knowledge library articles and return nearby context.
Parameters
branch required string
the branch to search in
query required Object
the query configuration
Show child attributes
text required Object
the text query configuration
Show child attributes
content string
the plain text to search for
pattern string
the regex pattern to search for
filter Object
allows narrowing the search to a subset of articles
Show child attributes
by_article Object
allows filtering by article
Show child attributes
articleuuids string Array.<string>
filter by one or more articleuuids
by_categorization Object
Show child attributes
knowledge_library Object
allows filtering by knowledge library categorization
Show child attributes
enabled boolean
whether to enable the knowledge library filter
libraries string Array.<string> Object.<string, boolean>
libraries to filter by
rooms string Array.<string> Object.<string, boolean>
rooms to filter by
shelves string Array.<string> Object.<string, boolean>
shelves to filter by
return Object
controls what data this task returns
Show child attributes
limit number
the maximum number of matches to return across all articles
Default: 10
per_article_limit number
the maximum number of matches to return per article, defaults to the value of params.return.limit
results_array_key string
the key to use for the results array in the payload
Default: results
item_structure Object.<string, string> string
allows modifying the structure of the returned items using variable substitution
context Object
controls how much surrounding context is returned for each match
Show child attributes
characters_before number
the number of characters to include before the match
Default: 200
characters_after number
the number of characters to include after the match
Default: 200
Result
Properties
Examples
Use query.text.pattern for regex searching; matching is case-insensitive by default.
Result
Narrow grep results to specific article shelves or articleuuids.
Result