Overview
The Knowledge base builder tool allows you to build a conversation easily via an intuitive user interface and then using the resulting JSON in the knowledge base Skill. You can access the KnowledgeBase Conversation Builder from the left navigation menu of the Knowledge Base Skill or access it directly from https://knowledgebase-ui.prod.soulmachines.cloud/ .
From the landing page of the Knowledge Base Builder, you can either create your conversation from scratch or update/edit your existing Knowledge Base json file.
Creating new knowledge Base
Knowledge Base contains your library of Q&As: questions the user might ask around a given topic and how your Digital Person would answer. Start creating your base from scratch.
Easily build your Q&A base with this tool, then train the NLU and test how it would play out. When you're done, collect the Knowledge Base as a JSON file and take it back to DDNA Studio.
Note: The data doesn’t save, so make sure to collect the knowledge base before refreshing or changing pages.
Field | Description |
|---|---|
Topic Name | Used as a unique identifier for each JSON object. (i.e. WhatIsSoulMachines) |
User Question | List of strings that contain examples of different utterances from the end user (i.e. "what is soul machines", "tell me about soul machines", "who is soul machines", "who are soul machines", "what are soul machines", "what is soul machine", "who is soul machine", "who are soul machine" ) |
DP Answer | List of responses the Digital Person should use to answer that question. If more than one value is found for a given topic, the skill will randomly pick one of the responses to reply with. (i.e. |
In order to enhance the responses with media or links you can add content cards to the DP Answers. Available content cards are Image(s), video, link, list, and markdown. To add content cards:
Create a DP answer
Click the answer to Edit
In the dropdown select a content card you would like to use.
Crawl your website
You can build your Q&As by crawling your website. This option scans your website and creates an index of all the pages with a list of user questions and DP answers along with a KB JSON file. As the user navigates the site, KnowledgeBase will match on the URL of the page to greet them with a page-specific response. You can then review your knowledge base and add any additional topics, customise DP answers or add content cards.
The output of the crawl has the following:
The "example" is the full URL (both with and without the www). This is used to match the page the user is visiting
The "response" contains (in descending order based on availability)
meta:description
H1 tag text
Page Title
The website crawl option does not produce production-ready output, but rather serves are a good starting point when building a tailored conversation.
Important:
The webcrawler honors the robots.txt for a given site, so if they disallow crawlers, we will not be able to generate an index for them
The crawler is most appropriate for small to medium websites (under 500 pages). Large sites (https://homedepot.com for example) will take hours to index and the resulting file will be so large it will be unusable. The https://soulmachines.com site contains about 450 pages and takes 00:02:15 to index
Editing existing knowledge Base
If you already have an existing knowledge base, you can either upload it via a link Or paste the JSON directly:
The JSON file must be in its raw form or hosted on any static site.
It needs to be publicly accessible (no login or other steps)
It needs to directly serve the .json file as raw text (not formatted to look nice, not served up in a viewer)
Collecting Knowledge Base
Once you’re ready to export your knowledge base and take it back to DDNA studio, select Collect Knowledge Base. You can copy the current knowledge base to clipboard, or you can download the JSON file locally.
In the Knowledge Base Skills configuration use the copied JSON and click Apply Changes.
Contents