-
Notifications
You must be signed in to change notification settings - Fork 16
/
QnAMakerClient.yml
126 lines (126 loc) · 4.62 KB
/
QnAMakerClient.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
### YamlMime:TSType
name: QnAMakerClient
uid: botbuilder-ai.QnAMakerClient
package: botbuilder-ai
summary: Client to access a QnA Maker knowledge base.
fullName: QnAMakerClient
remarks: ''
isPreview: false
isDeprecated: false
type: interface
methods:
- name: callTrain(FeedbackRecords)
uid: botbuilder-ai.QnAMakerClient.callTrain
package: botbuilder-ai
summary: Send feedback to the knowledge base.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function callTrain(feedbackRecords: FeedbackRecords): Promise<void>'
parameters:
- id: feedbackRecords
type: <xref uid="botbuilder-ai.FeedbackRecords" />
description: |
Feedback records.
return:
description: ''
type: Promise<void>
- name: >-
getAnswers(TurnContext, QnAMakerOptions, Record<string, string>,
Record<string, number>)
uid: botbuilder-ai.QnAMakerClient.getAnswers
package: botbuilder-ai
summary: Generates an answer from the knowledge base.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function getAnswers(turnContext: TurnContext, options?: QnAMakerOptions,
telemetryProperties?: Record<string, string>, telemetryMetrics?:
Record<string, number>): Promise<QnAMakerResult[]>
parameters:
- id: turnContext
type: TurnContext
description: >-
The Turn Context that contains the user question to be queried
against your knowledge base.
- id: options
type: <xref uid="botbuilder-ai.QnAMakerOptions" />
description: >-
The options for the QnA Maker knowledge base. If null, constructor
option is used for this instance.
- id: telemetryProperties
type: 'Record<string, string>'
description: >-
Additional properties to be logged to telemetry with the QnaMessage
event.
- id: telemetryMetrics
type: 'Record<string, number>'
description: >-
Additional metrics to be logged to telemetry with the QnaMessage
event.
return:
description: >-
A list of answers for the user query, sorted in decreasing order of
ranking score.
type: 'Promise<<xref uid="botbuilder-ai.QnAMakerResult" />[]>'
- name: >-
getAnswersRaw(TurnContext, QnAMakerOptions, Record<string, string>,
Record<string, number>)
uid: botbuilder-ai.QnAMakerClient.getAnswersRaw
package: botbuilder-ai
summary: Generates an answer from the knowledge base.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function getAnswersRaw(turnContext: TurnContext, options?:
QnAMakerOptions, telemetryProperties?: Record<string, string>,
telemetryMetrics?: Record<string, number>): Promise<QnAMakerResults>
parameters:
- id: turnContext
type: TurnContext
description: >-
The Turn Context that contains the user question to be queried
against your knowledge base.
- id: options
type: <xref uid="botbuilder-ai.QnAMakerOptions" />
description: >-
The options for the QnA Maker knowledge base. If null, constructor
option is used for this instance.
- id: telemetryProperties
type: 'Record<string, string>'
description: >-
Additional properties to be logged to telemetry with the QnaMessage
event.
- id: telemetryMetrics
type: 'Record<string, number>'
description: >-
Additional metrics to be logged to telemetry with the QnaMessage
event.
return:
description: >-
A list of answers for the user query, sorted in decreasing order of
ranking score.
type: Promise<<xref uid="botbuilder-ai.QnAMakerResults" />>
- name: 'getLowScoreVariation(QnAMakerResult[])'
uid: botbuilder-ai.QnAMakerClient.getLowScoreVariation
package: botbuilder-ai
summary: Filters the ambiguous question for active learning.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function getLowScoreVariation(queryResult: QnAMakerResult[]):
QnAMakerResult[]
parameters:
- id: queryResult
type: '<xref uid="botbuilder-ai.QnAMakerResult" />[]'
description: User query output.
return:
description: Filtered array of ambiguous question.
type: '<xref uid="botbuilder-ai.QnAMakerResult" />[]'