CreateKbDTO interface

  • Reference
Package:
@azure/cognitiveservices-qnamaker

Post body schema for CreateKb operation.

Properties

defaultAnswer

Default answer sent to user if no good match is found in the KB.
defaultAnswerUsedForExtraction

Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.
enableHierarchicalExtraction

Enable hierarchical extraction of Q-A from files and urls. Value to be considered False if this field is not present.
enableMultipleLanguages

Set to true to enable creating KBs in different languages for the same resource.
files

List of files from which to Extract Q-A.
language

Language of the knowledgebase. Please find the list of supported languages here.
name

Friendly name for the knowledgebase.
qnaList

List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.
urls

List of URLs to be used for extracting Q-A.

Property Details

defaultAnswer

Default answer sent to user if no good match is found in the KB.

defaultAnswer?: string

Property Value

string

defaultAnswerUsedForExtraction

Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.

defaultAnswerUsedForExtraction?: string

Property Value

string

enableHierarchicalExtraction

Enable hierarchical extraction of Q-A from files and urls. Value to be considered False if this field is not present.

enableHierarchicalExtraction?: boolean

Property Value

boolean

enableMultipleLanguages

Set to true to enable creating KBs in different languages for the same resource.

enableMultipleLanguages?: boolean

Property Value

boolean

files

List of files from which to Extract Q-A.

files?: FileDTO[]

Property Value

FileDTO[]

language

Language of the knowledgebase. Please find the list of supported languages here.

language?: string

Property Value

string

name

Friendly name for the knowledgebase.

name: string

Property Value

string

qnaList

List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.

qnaList?: QnADTO[]

Property Value

QnADTO[]

urls

List of URLs to be used for extracting Q-A.

urls?: string[]

Property Value

string[]