Versions Compared

Version Old Version 4 New Version 5
Changes made by

Bharathi Manohar

Bharathi Manohar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article will explain the Cognitive Search component and how to configure the component in the Experience Designer.

Table of Content Zone
Table of Contents

Cognitive Search

When the virtual assistant doesn’t understand what is being asked, relevant search results can be used to help the user. This can be achieved using the Cognitive Search feature.

Cognitive Search Results are displayed on an Adaptive Card. All styling should be handled via the Adaptive Card. The Cognitive Search is available only for the Chatbot and not for the Voice skills.

...

\uD83D\uDCD8 Steps to configure the Cognitive Search feature

  1. The Cognitive Search can be implemented using the Cognitive Search node in the Experience Designer

  2. The Cognitive Search node can be found in the left pane of the Experience Designer under the Orbita section

  3. The Cognitive Search node takes the following parameters as input

    1. msg.cognitiveSearch.subscriptionKey

    2. msg.cognitiveSearch.customConfigId

    3. msg.cognitiveSearch.query

    4. msg.cognitiveSearch.count

    5. msg.cognitiveSearch.offset

  4. The inputs can be configured in a function node like below

    Image Removed

    Function node code snippet:

    Code Block
    languagejs
    msg.cognitiveSearch = {
    subscriptionKey: "5axxxxxxxxxxxxxxxxxxxx2f47d",
    customConfigId: "789xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb",
    count: 3,
    offset: 0,
  query: "Who is the cto of orbita?"
}

  5. We get the msg object as output from the Cognitive Search node.

Input Parameters

Property

Description

msg.cognitiveSearch.subscriptionKey

This is the custom subsciption key of the Cognitive Search. Please contact support@orbita.ai

msg.cognitiveSearch.customConfigId

This is the custom key of the Cognitive Search. Please contact support@orbita.ai

msg.cognitiveSearch.query

This is the search query for which we will get the results in the output of the Cognitve Search node

For Example the query can be “Who is the CTO of Valley Health?”

msg.cognitiveSearch.count

This determines the number of search results to be displayed initially.

For Example if the search result has 10 records and the count is 3, the first 3 results will be shown with a load more button.

msg.cognitiveSearch.offset

This count defines the number of records to be skipped.

For Example if the search results has 10 records and the offset value is 2, the first 2 records will be skipped and the remaining 8 results will be available in the output

...

Please connect these Experience Designer nodes to your Bot flow.

...