Connectors Reference

QnA Maker

Distill information into an easy-to-navigate FAQ.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

GenerateAnswer (string KnowledgeBaseId, GenerateAnswer_Request body)

Generate answer

DownloadKnowledgeBase (string KnowledgeBaseId)

Download knowledge base

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

GenerateAnswer_Request

 

GenerateAnswer_Response

 

 

Actions:

GenerateAnswer

Summary: Generate answer

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

 

Syntax:

QnAMaker.GenerateAnswer (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

GenerateAnswer_Request

 

 

True

 

Returns:

          Type:GenerateAnswer_Response

 

DownloadKnowledgeBase

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:string

 


 

GenerateAnswer_Request

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.


 

GenerateAnswer_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

answers

array of (AnswersItem)

Answers

List of all answers.

 

AnswersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

answer

string

Answer

Top ranking answer to the question.

score

number(float)

Score

Relative score of the answer.