QnA Maker (Preview)

Distill information into an easy-to-navigate FAQ.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key securestring

API Key

Site URL string

Root site url. If not specified, site url will be defaulted to https://westus.api.cognitive.microsoft.com.

Throttling Limits

Name Calls Renewal Period
API calls per connection120060 seconds

Actions

Download knowledge base [DEPRECATED]

This operation downloads all the data associated wiht the specified knowledge base.

Download knowledgebase details

Gets details of a specific knowledgebase.

Generate answer

This operation returns the top ranking answer for the given question.

Generate answer [DEPRECATED]

This operation returns the top ranking answer for the given question.

Download knowledge base [DEPRECATED]

This operation downloads all the data associated wiht the specified knowledge base.

Parameters

Name Key Required Type Description
Knowledge Base Id
KnowledgeBaseId True string

This should be fetched from the QnAMaker portal.

Returns

Response schema for CreateKb operation.

Download knowledgebase details

Gets details of a specific knowledgebase.

Parameters

Name Key Required Type Description
Knowledge Base Id
KnowledgeBaseId True string

This should be fetched from the QnAMaker portal.

Returns

Response schema for CreateKb operation.

Generate answer

This operation returns the top ranking answer for the given question.

Parameters

Name Key Required Type Description
Knowledge Base Id
KnowledgeBaseId True string

This should be fetched from the QnAMaker portal.

Service Host
ServiceHost True string

This should be fetched from the QnAMaker portal.

Endpoint Key
EndpointKey True string

This should be fetched from the QnAMaker portal.

Question
question True string

Ask a question.

Top
top integer

Number of ranked results you want in the output.

Returns

Generate answer [DEPRECATED]

This operation returns the top ranking answer for the given question.

Parameters

Name Key Required Type Description
Knowledge Base Id
KnowledgeBaseId True string

This should be fetched from the QnAMaker portal.

Question
question True string

Ask a question.

Top
top integer

Number of ranked results you want in the output.

Returns

Definitions

GenerateAnswer_Response

Name Path Type Description
Answers
answers array of object

List of all answers.

questions
answers.questions array of string

List of questions.

Answer
answers.answer string

Top ranking answer to the question.

Score
answers.score float

Relative score of the answer.

Id
answers.id number
Source
answers.source string

DownloadKnowledgeBase_Response

Response schema for CreateKb operation.

Name Path Type Description
id
id string

Unique id that identifies a knowledgebase.

hostName
hostName string

URL host name at which the knowledgebase is hosted.

lastAccessedTimestamp
lastAccessedTimestamp string

Time stamp at which the knowledgebase was last accessed (UTC).

lastChangedTimestamp
lastChangedTimestamp string

Time stamp at which the knowledgebase was last modified (UTC).

lastPublishedTimestamp
lastPublishedTimestamp string

Time stamp at which the knowledgebase was last published (UTC).

name
name string

Friendly name of the knowledgebase.

userId
userId string

User who created / owns the knowledgebase.

urls
urls array of string

URL sources from which Q-A were extracted and added to the knowledgebase.

sources
sources array of string

Custom sources from which Q-A were extracted or explicitly added to the knowledgebase.