How to Configure Questions And Answers

 

About Questions And Answers

The Questions and Answers component contains 3 main parts:

  • Entity to Filter mappings
  • Intent to Base Query mappings
  • Conversation responses settings (in order):
    • Featured Results
    • NLQ Q&A
    • Conversation Topics

The Questions And Answers page is located under the SmartHub Administration page at: http(s)://<smarthub-web-app-url>/_admin.

Storage Settings

The conversation responses are saved in an Elastic index, and the HTML templates/adaptive cards templates used inside a conversation are physically saved on disk.

To configure the Elastic settings, follow the next steps:

  1. Navigate to the General Settings page. It is located under ADMINISTRATION section of the SmartHub Administration page.
  2. In the Storage Settings section click Edit.
  3. Enter the information for your Indexes and Elastic Server settings.


Bot Templates

To configure where the templates are saved, enter the path in the BotTemplatesPath variable from web.config file found in the SmartHub root directory.

The default location for the bot templates is the BotTemplates folder.

Copy 
<add key="BotTemplatesPath" value="~/BotTemplates" />

Entity-to-Filter Mappings

This section contains the mappings between SmartHub filters/refiners and NLQ Service application entities.

  • An entity from the NLQ Service application must have a connection to a refiner from SmartHub.

  • To access Entity-to-Filter mappings, select Questions And Answers from the navigation menu on the left side of the page.

  • Select the settings sprocket to access the drop-down menu that contains Entity-to-Filter mappings.


Note: The managed property used as a filter (refiner) must be searchable and queryable.

  1. Click the "Click to view the query used to get the refiners" link at the top of the page
  2. A sub-section opens with the query run in the search center to get the managed properties. The administrator can change it.
  3. The administrator must choose an Entity and a Filter.
  4. Click the Add Mapping.
  5. Enter your code.
  6. After all changes are made, click Save.

Intent to Base Query Mappings

This section contains the mappings between the following:

  • Intents from the NLQ service application
  • A query

Mappings Used in This Case

After the NLQ service detects the intent of the question and that the user follows the conversation steps, SmartHub returns the results based on the user choice and the query associated with the intent.

Example

Based on the code in the image below, the following query is run in the Search Center:

customer AND "DisplayAuthor":"Administrator".



Export Questions and Answers Entries

This section describes how to export the indexed Questions And Answers to a .csv file.

This applies to ALL types of Q&A entries:

  • Conversation Entries
  • NLQ Q&A
  • Featured Results

To use:

  1. Click on "Conversation Topics" and select the type of conversation you want to export:
    • Conversation Topics
    • Question and Answers
    • Featured Results
  2. Click the sprocket icon.
  3. Click Export <conversation type>.


  4. File Name: The name of the .csv file.
    1. By default, the file name will be "SH Bot *type of conversation to be exported* *current date and time*" 
    2. For example, for Featured Results, the default file name will be SH Bot Featured Results *current date time*.csv
  5. Enter the desired file name (or leave default) and click Export.
  6. A .csv file with the desired name is downloaded:

The newly downloaded .csv file contains all properties of the exported type:

Import Questions And Answers Entries

This section describes how to import a .csv file containing Questions And Answers of a specific type and adds them to the Elastic index.

This applies to ALL types Q&A entries:

  • Conversation Entries
  • Questions and Answers
  • Featured Results

To use:

  1. Click on "Conversation Topics" and select the type of conversation you want to import:
    • Conversation Topics
    • Question and Answers
    • Featured Results
  2. Click the sprocket icon.
  3. Click Import <conversation type>.


  4. Click Choose File and select the .csv file containing the conversations that you want to import.
  5. Click Import. The .csv contents are translated to the appropriate Conversation Type and added to the Elastic index

Note: All items in the .csv file you want to import must be of the same type.

For example, if you want to import Featured Results, all items in the .csv file must be of type "Featured Results".

The imported CSV file has the following format:

  • 1st row: Property names
  • 2nd row onward: Property values

Delete Question And Answer Entries

This feature enables you to delete all items of a certain type from the Elastic Index.

This applies to ALL types Q&A entries:

  • Conversation Entries
  • Questions and Answers
  • Featured Results

To use:

  1. Click on "Conversation Topics" and select the type of conversation you want to delete:
    • Conversation Topics
    • Question and Answers
    • Featured Results
  2. Click the sprocket icon.
  3. Click Delete <conversation type>.
  4. On the Delete Conversation Topics confirmation page, select one of the following:
  • Cancel - You are returned to the "Questions And Answers" page and no items are deleted
  • Delete - All items of the selected type will be deleted from the Elastic Index

Conversation Response Settings

When SmartHub receives a natural language query, it attempts to find a match, progressively, for:

  1. Featured Results
    1. If no match is found, SmartHub calls the NLQ provider and based on the identified entity and intents, SmartHub tries to find a match for:
  2. NLQ Q&A
    1. If no Q&A match is found:
  3. Conversation
    1. A match for a conversation (which consists of one or more conversation topics).
    2. If no conversation step match is found, the bot does not have a relevant suggestion.

How to Configure Featured Results

Use the following instructions to configure a Featured Results.

  1. On the Questions And Answers page, click Conversation Topics.
  2. Select Featured Results.


  3. Click the "+" icon next to the "Featured Results" text at the top left of the screen.
  4. Start date: the date on which the featured result begins.
  5. Expiration date: the date the featured result expires.
  6. Name (at top of screen): Choose a relevant name for the Featured Result.
  7. Priority:
    1. Choose the priority of feature results in case that, there are multiple "Feature Results" with the same query term.
    2. Based on the priority configured, "Featured Results" is returned in search results.
  8. "When the user searches for"
    1. Add query terms here.
    2. There two types of query terms:
      1. Regular strings. For example: priority, case, version
      2. Regex strings Pattern for regex matching.
        1. For example: ([A-Z])\w+
  9. "query comes from these sources"
    • Add results source IDs.
    • This field will contain a list with results source IDs of the user's query
    • "ALL" is the default value.
      • It means that all results source IDs will be considered as valid.
  10. Choose the response method:
    • "answer"  - "HTML response": What the bot tells the user before the results are listed.
    • "search for" - "Query To Run template":
      • Generates the query made to SmartHub if a match is found for this item (hover over the icon to see which fields can be used inside the template).
      • Choose a results source ID used to run the query and display results.
        • The default value is "Current Source Id" which represents the result source id of the query made by user.
      • Choose the template from the last field:
        • Regular results
        • Cards
        • Carousel
      • For cards or carousel display mode choose.
        • n results - the top n results will be listed in SmartHub search page.
        • Adaptive Cards JSON - The JSON template used to render the bot results.

Answer Display Mode

Regular Results Display Mode

Cards/carousel display mode

How to Configure NLQ Q&A

Use the following instructions to configure a Question and Answer.

  1. On the Questions And Answers page, click on Conversation Topics.
  2. Select NLQ Q&A.


  3. Click the "+" icon next to the "NLQ Q&A" label at the top left of the screen.
  4. Choose a relevant name for the NLQ Q&A.
  5. Choose the NLQ Service intents that matches this Q&A.
  6. Choose the response method:
    • "answer"  - "HTML response":
      • This specifies what the bot tells the user before the results will be listed.
    • "search for" - "Query To Run json object": 
      • Generates the query to be executed by SmartHub if a match is found for this item. You can click on this query to open the query builder panel.


  7. On the left side, you can see the most common properties that can be altered in the query. The JSON query on the right side will be updated based on your input.
    1. Choose whether you want to pick up specific metadata from your results or the entire results set.
      1. metadata: Choose which metadata field to extract from results


    2. Choose the template from the last field:
      1. regular results
      2. cards
      3. carousel
    3. To use a "cards" or "carousel" display mode choose:
      1. Display text: The text to be displayed on top of the card or carousel
      2. Adaptive Cards JSON: The JSON template used to render the bot results

Regular Results Display Mode

Cards/carousel Display Mode


How to Configure "Conversation Topics"

Use the following instructions to configure a Conversation Topic.

  1. On the Questions And Answers page, click on Conversation Topics.


  2. Click the "+" button.
  3. Choose a relevant name for the Conversation Topic.
  4. Choose the NLQ Service intents that match this Conversation Topic.
  5. Choose the filter mapped to the NLQ Service entity.
    1. This is the filter for which SmartHub suggests refinement after the associated NLQ Service entity is recognized.
    2. The entity is populated automatically based on the mappings.
  6. Bot reply template: Generates a short message displayed by the bot before showing the recommended values.
  7. Choose how many filter values should be recommended by bot.
  8. Choose recommended filter values.
    1. These values are suggested by the bot.

How to Use Bot Templates

Note: Bot Templates are available for "Questions and Answers" and  "Featured Results"

Creating a new template:

  1. Populate the Template name field. If the field is empty the new template will use the same name as the conversation item.
  2. Populate the template field.
  3. Save the conversation item.
  4. The template is created. 
    1. It is available to use for other templates.

Selecting an existing template with the "Chose a file " button:

  • A pop-up will open showing you all the available templates.

  • Selecting a template populates the Template Name and the template fields.

  • Modifying the template and then saving the conversation item updates the selected template. 

    Note: The changes are visible in all the conversations that use that template.

  • Modifying the template name and saving will create a new template with the specified name.