-
Notifications
You must be signed in to change notification settings - Fork 180
/
QnAMakerModels.CreateKbDTO.yml
145 lines (141 loc) · 4.53 KB
/
QnAMakerModels.CreateKbDTO.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
### YamlMime:TSType
name: CreateKbDTO
uid: '@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO'
package: '@azure/cognitiveservices-qnamaker'
summary: Post body schema for CreateKb operation.
fullName: CreateKbDTO
remarks: ''
isDeprecated: false
type: interface
properties:
- name: defaultAnswer
uid: '@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.defaultAnswer'
package: '@azure/cognitiveservices-qnamaker'
summary: Default answer sent to user if no good match is found in the KB.
fullName: defaultAnswer
remarks: ''
isDeprecated: false
syntax:
content: 'defaultAnswer?: string'
return:
description: ''
type: string
- name: defaultAnswerUsedForExtraction
uid: >-
@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.defaultAnswerUsedForExtraction
package: '@azure/cognitiveservices-qnamaker'
summary: >-
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.
fullName: defaultAnswerUsedForExtraction
remarks: ''
isDeprecated: false
syntax:
content: 'defaultAnswerUsedForExtraction?: string'
return:
description: ''
type: string
- name: enableHierarchicalExtraction
uid: >-
@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.enableHierarchicalExtraction
package: '@azure/cognitiveservices-qnamaker'
summary: >-
Enable hierarchical extraction of Q-A from files and urls. Value to be
considered False if
this field is not present.
fullName: enableHierarchicalExtraction
remarks: ''
isDeprecated: false
syntax:
content: 'enableHierarchicalExtraction?: boolean'
return:
description: ''
type: boolean
- name: enableMultipleLanguages
uid: >-
@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.enableMultipleLanguages
package: '@azure/cognitiveservices-qnamaker'
summary: >-
Set to true to enable creating KBs in different languages for the same
resource.
fullName: enableMultipleLanguages
remarks: ''
isDeprecated: false
syntax:
content: 'enableMultipleLanguages?: boolean'
return:
description: ''
type: boolean
- name: files
uid: '@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.files'
package: '@azure/cognitiveservices-qnamaker'
summary: List of files from which to Extract Q-A.
fullName: files
remarks: ''
isDeprecated: false
syntax:
content: 'files?: FileDTO[]'
return:
description: ''
type: >-
<xref uid="@azure/cognitiveservices-qnamaker.QnAMakerModels.FileDTO"
/>[]
- name: language
uid: '@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.language'
package: '@azure/cognitiveservices-qnamaker'
summary: >-
Language of the knowledgebase. Please find the list of supported languages
<a
href="https://aka.ms/qnamaker-languages#languages-supported"
target="_blank">here</a>.
fullName: language
remarks: ''
isDeprecated: false
syntax:
content: 'language?: string'
return:
description: ''
type: string
- name: name
uid: '@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.name'
package: '@azure/cognitiveservices-qnamaker'
summary: Friendly name for the knowledgebase.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: qnaList
uid: '@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.qnaList'
package: '@azure/cognitiveservices-qnamaker'
summary: >-
List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are
assigned by the service and
should be omitted.
fullName: qnaList
remarks: ''
isDeprecated: false
syntax:
content: 'qnaList?: QnADTO[]'
return:
description: ''
type: >-
<xref uid="@azure/cognitiveservices-qnamaker.QnAMakerModels.QnADTO"
/>[]
- name: urls
uid: '@azure/cognitiveservices-qnamaker.QnAMakerModels.CreateKbDTO.urls'
package: '@azure/cognitiveservices-qnamaker'
summary: List of URLs to be used for extracting Q-A.
fullName: urls
remarks: ''
isDeprecated: false
syntax:
content: 'urls?: string[]'
return:
description: ''
type: string[]