The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Asyntai Knowledge Sync

View this plugin on the Plugins site

asyntaiKnowledgeSync: Asyntai Knowledge Sync

Sends documentation files from the workspace to the knowledge base of your Asyntai AI chatbot. Run it after the checkout, so the chatbot on your website answers from the current docs.

A new file becomes a new entry, a changed file replaces its entry, and an unchanged file is skipped. The entry title is the file path, with the title prefix in front.

  • credentialsId : String
    A Secret text credential that holds your Asyntai API key. Create the key in your Asyntai dashboard under Settings → API. The API needs the Starter plan or higher.
  • apiUrl : String (optional)
    Base address of the Asyntai API. Leave the default, https://asyntai.com.
  • dryRun : boolean (optional)
    Report what would change and send nothing. Useful on pull request builds.
  • excludes : String (optional)
    Files to leave out, as Ant-style patterns. For example docs/drafts/**. Version control folders such as .git are always left out.
  • files : String (optional)
    Which files to send, as Ant-style patterns relative to the root folder. Put one pattern on each line, or separate them with commas. ** matches any number of folders, so docs/**/*.md also matches docs/intro.md. The default is docs/**/*.md.
  • prune : boolean (optional)
    Delete knowledge base entries whose file no longer exists. Only entries whose title starts with the title prefix are touched, so this option needs a title prefix.
  • rootDirectory : String (optional)
    The folder the file patterns start from, relative to the workspace. Leave it empty to use the workspace. Entry titles are paths relative to this folder.
  • titlePrefix : String (optional)
    Text put in front of every entry title. Use it when several repositories feed one chatbot, for example handbook/. It is also required for the delete option, so the step only touches entries it created.
  • websiteId : String (optional)
    Which Asyntai website to fill. Leave it empty to use the primary website of the account.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.