Connectors Reference
Distill information into an easy-to-navigate FAQ.
|
Status: Preview |
Tier: Standard |
Version: 1.0.0 |
|
Name |
Summary |
|
GenerateAnswerOld (string KnowledgeBaseId, GenerateAnswer_Request body) |
Generate answer |
|
Generate answer |
|
|
Download knowledge base |
|
|
Download knowledgebase details |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
Summary: Generate answer
Description: This operation returns the top ranking answer for the given question.
Syntax:
QnAMaker.GenerateAnswerOld (string KnowledgeBaseId, GenerateAnswer_Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
KnowledgeBaseId |
string (Knowledge Base Id) |
This should be fetched from the QnAMaker portal. |
True |
|
|
body |
|
|
True |
Returns:
Summary: Generate answer
Description: This operation returns the top ranking answer for the given question.
Syntax:
QnAMaker.GenerateAnswer (string KnowledgeBaseId, string ServiceHost, string EndpointKey, GenerateAnswer_Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
KnowledgeBaseId |
string (Knowledge Base Id) |
This should be fetched from the QnAMaker portal. |
True |
|
|
ServiceHost |
string (Service Host) |
This should be fetched from the QnAMaker portal. |
True |
|
|
EndpointKey |
string (Endpoint Key) |
This should be fetched from the QnAMaker portal. |
True |
|
|
body |
|
|
True |
Returns:
Summary: Download knowledge base
Description: This operation downloads all the data associated wiht the specified knowledge base.
Syntax:
QnAMaker.DownloadKnowledgeBase (string KnowledgeBaseId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
KnowledgeBaseId |
string (Knowledge Base Id) |
This should be fetched from the QnAMaker portal. |
True |
Returns:
Type:DownloadKnowledgeBase_Response
Description: Response schema for CreateKb operation.
Summary: Download knowledgebase details
Description: Gets details of a specific knowledgebase.
Syntax:
QnAMaker.DownloadKnowledgeBaseOld (string KnowledgeBaseId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
KnowledgeBaseId |
string (Knowledge Base Id) |
This should be fetched from the QnAMaker portal. |
True |
Returns:
Type:DownloadKnowledgeBase_Response
Description: Response schema for CreateKb operation.
Summary:
Description: Response schema for CreateKb operation.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Unique id that identifies a knowledgebase. |
|
hostName |
string
|
URL host name at which the knowledgebase is hosted. |
|
lastAccessedTimestamp |
string
|
Time stamp at which the knowledgebase was last accessed (UTC). |
|
lastChangedTimestamp |
string
|
Time stamp at which the knowledgebase was last modified (UTC). |
|
lastPublishedTimestamp |
string
|
Time stamp at which the knowledgebase was last published (UTC). |
|
name |
string
|
Friendly name of the knowledgebase. |
|
userId |
string
|
User who created / owns the knowledgebase. |
|
urls |
array of (string)
|
URL sources from which Q-A were extracted and added to the knowledgebase. |
|
sources |
array of (string)
|
Custom sources from which Q-A were extracted or explicitly added to the knowledgebase. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
question |
string Question |
Ask a question. |
|
top |
integer(int32) Top |
Number of ranked results you want in the output. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
answers |
array of (AnswersItem) Answers |
List of all answers. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
questions |
array of (string)
|
List of questions. |
|
answer |
string Answer |
Top ranking answer to the question. |
|
score |
number(float) Score |
Relative score of the answer. |
|
id |
number Id |
|
|
source |
string Source |
|