Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

QnA Maker / Generate Answer

Operation Information

Hornbill iBridge integration to ask a question of a QnA Maker bot.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Azure QnA Maker.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Azure QnA Maker in the Type pick list;
  • Give the Azure QnA Maker KeySafe key a Title (this is the name / identifier for the Azure QnA Maker account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Endpoint string The Endpoint for your QnA Maker Host.
Knowledgebase ID string The ID for your QnA Maker Knowledgebase.
Endpoint Key string The key to use to make QnA Maker requests.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Azure QnA Maker account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Question question string The question to ask the bot No None provided
QnA ID qnaId number QnA ID to return - overrides Question No None provided
Previous Question Context context string Previous Question Context, as a JSON string No None provided
Score Threshold scoreThreshold number Threshold for answers returned based on score No None provided
User ID userId string Unique identifier for the user No None provided

Output Parameters

Display Name ID Type Description
Status status string Status of the integration call, can be ok or fail
Answer Content answer string The highest scoring Answer returned by the bot[
Answer ID id number The ID of the returned Answer
Answer Score score number The score of the Answer
Context context string Question Context JSON string
In This Document