Asyntai Knowledge Sync
Your documentation changes every week. Your AI chatbot should know about it the same day.
Asyntai Knowledge Sync adds one task to your Azure Pipelines. On every run it sends your new and changed documentation to the Asyntai knowledge base, so the chatbot on your website answers from the docs you just merged.
What you get
- Answers that match your docs. Merge a change to a page, and the chatbot answers from the new page in the same pipeline run.
- Writers keep their workflow. Docs stay in your repository. Nobody copies pages into a dashboard by hand.
- Only real changes are sent. A file with the same text is left alone, so a run with no doc changes finishes in seconds.
- One chatbot, many repositories. Give each repository its own title prefix, and each pipeline looks after its own pages.
- Clean up on its own. Turn on removal, and a page you delete from the repository leaves the knowledge base too.
- A clear report. Each run adds a summary tab that lists every page it added, updated or left alone.
Set it up
- In Asyntai, open Settings, then API, and copy your API key.
- In Azure DevOps, open your pipeline, press Variables, and add a variable named
ASYNTAI_API_KEY. Paste the key and tick Keep this value secret.
- Add the task to your pipeline:
steps:
- task: AsyntaiKnowledgeSync@1
inputs:
files: |
docs/**/*.md
Run the pipeline. The Asyntai Knowledge Sync tab on the run page shows what was sent.
Several repositories, one chatbot
- task: AsyntaiKnowledgeSync@1
inputs:
files: 'docs/**/*.md'
titlePrefix: 'product-docs/'
prune: true
Check pull requests first
- task: AsyntaiKnowledgeSync@1
condition: eq(variables['Build.Reason'], 'PullRequest')
inputs:
files: 'docs/**/*.md'
dryRun: true
On a pull request build, the task lists the pages it would send and sends nothing.
Settings
| Input |
Default |
What it does |
apiKey |
$(ASYNTAI_API_KEY) |
Your Asyntai API key, from a secret variable. |
files |
docs/**/*.md |
File patterns to send, one per line. Supports *, ? and **. |
titlePrefix |
empty |
Text put in front of every entry title. |
prune |
false |
Remove entries whose file is gone. Needs a title prefix. |
dryRun |
false |
List the changes and send nothing. |
websiteId |
empty |
Which Asyntai website to fill. Empty means the primary website. |
rootDirectory |
$(Build.SourcesDirectory) |
The folder the patterns start from. |
The task also sets the output variables added, updated, unchanged and deleted for later steps.
Requirements
- An Asyntai account on the Starter plan or higher, because the task uses the Asyntai API.
- A Microsoft-hosted or self-hosted agent, version 3.232.1 or later.
Learn more
