-
Notifications
You must be signed in to change notification settings - Fork 16
/
QnACardBuilder.yml
90 lines (90 loc) · 3.25 KB
/
QnACardBuilder.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
### YamlMime:TSType
name: QnACardBuilder
uid: botbuilder-ai.QnACardBuilder
package: botbuilder-ai
summary: >-
Provides methods to create activities containing hero cards for showing active
learning or multi-turn prompt options for the QnAMakerDialog.
fullName: QnACardBuilder
remarks: ''
isPreview: false
isDeprecated: false
type: class
methods:
- name: 'getQnAAnswerCard(QnAMakerResult, boolean)'
uid: botbuilder-ai.QnACardBuilder.getQnAAnswerCard
package: botbuilder-ai
summary: >-
Returns an [activity](xref:botframework-schema.Activity) with answer text
and a hero card attachment, containing buttons for multi turn prompts.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function getQnAAnswerCard(result: QnAMakerResult,
displayPreciseAnswerOnly: boolean): Partial<Activity>
parameters:
- id: result
type: <xref uid="botbuilder-ai.QnAMakerResult" />
description: >-
QnAMaker result containing the answer text and multi turn prompts to
be displayed.
- id: displayPreciseAnswerOnly
type: boolean
description: >-
whether to display PreciseAnswer Only or along with source Answer
text. .
return:
description: Activity representing the prompts as a card
type: Partial<Activity>
- name: getQnAPromptsCard(QnAMakerResult)
uid: botbuilder-ai.QnACardBuilder.getQnAPromptsCard
package: botbuilder-ai
summary: >-
Returns an [activity](xref:botframework-schema.Activity) with answer text
and a hero card attachment, containing buttons for multi turn prompts.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function getQnAPromptsCard(result: QnAMakerResult):
Partial<Activity>
parameters:
- id: result
type: <xref uid="botbuilder-ai.QnAMakerResult" />
description: >-
QnAMaker result containing the answer text and multi turn prompts to
be displayed.
return:
description: Activity representing the prompts as a card
type: Partial<Activity>
- name: 'getSuggestionsCard(string[], string, string)'
uid: botbuilder-ai.QnACardBuilder.getSuggestionsCard
package: botbuilder-ai
summary: >-
Returns an [activity](xref:botframework-schema.Activity) with a hero card
attachment, containing buttons for active learning suggestions.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function getSuggestionsCard(suggestionsList: string[], cardTitle:
string, cardNoMatchText: string): Partial<Activity>
parameters:
- id: suggestionsList
type: 'string[]'
description: List of suggestions to be displayed on hero card.
- id: cardTitle
type: string
description: Title of the hero card.
- id: cardNoMatchText
type: string
description: >-
Text for button to be added to card to allow user to select 'no
match'.
return:
description: Activity representing the suggestions as a card
type: Partial<Activity>