-
Notifications
You must be signed in to change notification settings - Fork 16
/
QnAMakerOptions.yml
186 lines (186 loc) · 5.17 KB
/
QnAMakerOptions.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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
### YamlMime:TSType
name: QnAMakerOptions
uid: botbuilder-ai.QnAMakerOptions
package: botbuilder-ai
summary: Additional settings used to configure a `QnAMaker` instance.
fullName: QnAMakerOptions
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: context
uid: botbuilder-ai.QnAMakerOptions.context
package: botbuilder-ai
summary: The context of the previous turn.
fullName: context
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context?: QnARequestContext'
return:
description: ''
type: <xref uid="botbuilder-ai.QnARequestContext" />
- name: enablePreciseAnswer
uid: botbuilder-ai.QnAMakerOptions.enablePreciseAnswer
package: botbuilder-ai
summary: A value indicating user's choice to receive PreciseAnswer or not.
fullName: enablePreciseAnswer
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'enablePreciseAnswer?: boolean'
return:
description: ''
type: boolean
- name: filters
uid: botbuilder-ai.QnAMakerOptions.filters
package: botbuilder-ai
summary: ''
fullName: filters
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'filters?: Filters'
return:
description: ''
type: <xref uid="botbuilder-ai.Filters" />
- name: includeUnstructuredSources
uid: botbuilder-ai.QnAMakerOptions.includeUnstructuredSources
package: botbuilder-ai
summary: >-
includeUnstructuredSources - option to fetch answers from unsrtuctured
sources
fullName: includeUnstructuredSources
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'includeUnstructuredSources?: boolean'
return:
description: ''
type: boolean
- name: isTest
uid: botbuilder-ai.QnAMakerOptions.isTest
package: botbuilder-ai
summary: >-
A value indicating whether to call test or prod environment of
knowledgebase.
fullName: isTest
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'isTest?: boolean'
return:
description: ''
type: boolean
- name: metadataBoost
uid: botbuilder-ai.QnAMakerOptions.metadataBoost
package: botbuilder-ai
summary: (Optional) Metadata related to query.
fullName: metadataBoost
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'metadataBoost?: QnAMakerMetadata[]'
return:
description: ''
type: '<xref uid="botbuilder-ai.QnAMakerMetadata" />[]'
- name: qnaId
uid: botbuilder-ai.QnAMakerOptions.qnaId
package: botbuilder-ai
summary: Id of the current question asked.
fullName: qnaId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'qnaId?: number'
return:
description: ''
type: number
- name: rankerType
uid: botbuilder-ai.QnAMakerOptions.rankerType
package: botbuilder-ai
summary: Ranker types.
fullName: rankerType
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'rankerType?: string'
return:
description: ''
type: string
- name: scoreThreshold
uid: botbuilder-ai.QnAMakerOptions.scoreThreshold
package: botbuilder-ai
summary: >-
(Optional) The minimum score threshold, used to filter returned results.
Values range from score of 0.0 to 1.0.
fullName: scoreThreshold
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'scoreThreshold?: number'
return:
description: ''
type: number
- name: strictFilters
uid: botbuilder-ai.QnAMakerOptions.strictFilters
package: botbuilder-ai
summary: (Optional) Filters used on query.
fullName: strictFilters
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'strictFilters?: QnAMakerMetadata[]'
return:
description: ''
type: '<xref uid="botbuilder-ai.QnAMakerMetadata" />[]'
- name: strictFiltersJoinOperator
uid: botbuilder-ai.QnAMakerOptions.strictFiltersJoinOperator
package: botbuilder-ai
summary: A value indicating choice for Strict Filters Join Operation.
fullName: strictFiltersJoinOperator
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'strictFiltersJoinOperator?: JoinOperator'
return:
description: ''
type: <xref uid="botbuilder-ai.JoinOperator" />
- name: timeout
uid: botbuilder-ai.QnAMakerOptions.timeout
package: botbuilder-ai
summary: (Optional) The time in milliseconds to wait before the request times out.
fullName: timeout
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'timeout?: number'
return:
description: ''
type: number
- name: top
uid: botbuilder-ai.QnAMakerOptions.top
package: botbuilder-ai
summary: (Optional) number of results to return.
fullName: top
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'top?: number'
return:
description: ''
type: number