Page Comparison

The Knowledge base builder tool allows you to build a conversation easily via an intuitive user interface and then use the resulting JSON in the knowledge base Skill. Knowledge Base contains your library of Q&As: questions the user might ask around a given topic and how your Digital Person would answer. Easily build your Q&A base with this tool, then train the NLU and test how it would play out. When you're done, export the Knowledge Base as a JSON file and take it back to DDNA Studio.

Accessing Knowledge Base Builder

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/.

Use your Soul Machines credentials to log into Knowledge Base Builder. The landing page of the Knowledge Base Builder , lists all the Knowledge bases created by users of your organisation. You can either create your conversation from scratch or edit/duplicate existing Knowledge Base.

Creating new knowledge Base

To create your Knowledge Base from scratch, press the + button and enter a name for the Knowledge base. Under each topic you can have multiple related questions and answers.

Adding Content Cards

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:

1. Create a DP answer

2. Click the answer to Edit

3. In the dropdown select a content card you would like to use.

Crawling 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:

1. The "example" is the full URL (both with and without the www).  This is used to match the page the user is visiting

2. The "response" contains (in descending order based on availability)

   1. meta:description

   2. H1 tag text

   3. 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.

Editing existing knowledge Base JSON

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.

1. It needs to be publicly accessible (no login or other steps)

2. It needs to directly serve the .json file as raw text (not formatted to look nice, not served up in a viewer)

Training and Testing your Conversation

Once you have either created a new topic, or modified an existing topic, it will enable the “Train Conversation” button allowing you to then test how the DP might respond to the questions. It is necessary to train the conversation before you can test it. Training the conversation takes between 15 seconds and a minute, depending on the size of your knowledge base. During this time you’ll see the “Training …” button. At any time, you can switch from conversation mode to view the generated JSON using the toggle at the top right-hand corner.

Once the conversation is trained, you can start testing it by sending in questions in the chat window that would simulate what a user might ask. Any cards that are configured in the response will be shown, and the @ShowCards(xxx) command will be stripped from the response to replicate what a user would actually see.

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.