Compartilhar via

QnA Maker

  • Reference

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 China regions
Power Automate Standard All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://www.qnamaker.ai/

Known Issues and Limitations

The QnA Maker connector only supports API QnA Maker 4.0 version.

Creating a connection

The connector supports the following authentication types:
Api Key ApiKey All regions Shareable
Default [DEPRECATED] This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. All regions Not shareable

Api Key

Auth ID: keyBasedAuth

Applicable: All regions

ApiKey

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name Type Description Required
Account Key securestring Cognitive Services Account Key True
Site URL string Root site url (Example: https://westus.api.cognitive.microsoft.com)

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring API Key True
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 connection 1200 60 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.
Download knowledgebase details (V2)

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]

Operation ID:
DownloadKnowledgeBase

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.

Body
DownloadKnowledgeBase_Response

Download knowledgebase details

Operation ID:
DownloadKnowledgeBaseOld

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.

Body
DownloadKnowledgeBase_Response

Download knowledgebase details (V2)

Operation ID:
DownloadKnowledgeBaseOldV2

Gets details of a specific knowledgebase.

Parameters

Name Key Required Type Description
Resource Subdomain or Region
 subdomainName True string

Azure subdomain or geographic region (e.g. westus)
Knowledge Base Id
 KnowledgeBaseId True string

This should be fetched from the QnAMaker portal.

Returns

Response schema for CreateKb operation.

Body
DownloadKnowledgeBase_Response

Generate answer

Operation ID:
GenerateAnswer

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

Body
GenerateAnswer_Response

Generate answer [DEPRECATED]

Operation ID:
GenerateAnswerOld

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

Body
GenerateAnswer_Response

Definitions

GenerateAnswer_Response

Name Path Type Description
Answers
 answers array of object

List of all answers.
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.