You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/qnamaker/concepts/best-practices.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,26 +30,26 @@ In general, FAQ pages should be stand-alone and not combined with other informat
30
30
31
31
### Good questions
32
32
33
-
The best questions are simple. Consider the key word or phrase for each question then create a simple question for that key word or phrase.
33
+
The best questions are simple. Consider the key word or phrase for each question then create a basic question for that key word or phrase.
34
34
35
-
Add as many alternate questions as you need but keep the alterations simple. Adding more words or phrasings that are not part of the main goal of the question does not help QnA Maker find a match.
35
+
Add as many alternate questions as you need but keep the alterations simple. Adding more words or phrasings that aren't part of the main goal of the question doesn't help QnA Maker find a match.
36
36
37
37
38
38
### Add relevant alternative questions
39
39
40
-
Your user may enter questions with either a conversational style of text, `How do I add a toner cartridge to my printer?` or a keyword search such as `toner cartridge`. The knowledge base should have both styles of questions in order to correctly return the best answer. If you aren't sure what keywords a customer is entering, use Application Insights data to analyze queries.
40
+
Your user may enter questions with either a conversational style of text, `How do I add a toner cartridge to my printer?` or, a keyword search such as `toner cartridge`. The knowledge base should have both styles of questions in order to correctly return the best answer. If you aren't sure what keywords a customer is entering, use Application Insights data to analyze queries.
41
41
42
42
### Good answers
43
43
44
-
The best answers are simple answers but not too simple. Do not use answers such as `yes` and `no`. If your answer should link to other sources or provide a rich experience with media and links, use [metadata tagging](../how-to/edit-knowledge-base.md#add-metadata) to distinguish between answers, then [submit the query](../how-to/metadata-generateanswer-usage.md#generateanswer-request-configuration) with metadata tags in the `strictFilters` property to get the correct answer version.
44
+
The best answers are simple answers but not too simple. Don't use answers such as `yes` and `no`. If your answer should link to other sources or provide a rich experience with media and links, use [metadata tagging](../how-to/edit-knowledge-base.md#add-metadata) to distinguish between answers, then [submit the query](../how-to/metadata-generateanswer-usage.md#generateanswer-request-configuration) with metadata tags in the `strictFilters` property to get the correct answer version.
45
45
46
46
|Answer|Follow-up prompts|
47
47
|--|--|
48
48
|Power down the Surface laptop with the power button on the keyboard.|* Key-combinations to sleep, shut down, and restart.<br>* How to hard-boot a Surface laptop<br>* How to change the BIOS for a Surface laptop<br>* Differences between sleep, shut down and restart|
49
49
|Customer service is available via phone, Skype, and text message 24 hours a day.|* Contact information for sales.<br> * Office and store locations and hours for an in-person visit.<br> * Accessories for a Surface laptop.|
50
50
51
51
## Chit-Chat
52
-
Add chit-chat to your bot, to make your bot more conversational and engaging, with low effort. You can easily add chit-chat data sets from pre-defined personalities when creating your KB, and change them at any time. Learn how to [add chit-chat to your KB](../how-to/chit-chat-knowledge-base.md).
52
+
Add chit-chat to your bot, to make your bot more conversational and engaging, with low effort. You can easily add chit-chat data sets from predefined personalities when creating your KB, and change them at any time. Learn how to [add chit-chat to your KB](../how-to/chit-chat-knowledge-base.md).
53
53
54
54
Chit-chat is supported in [many languages](../how-to/chit-chat-knowledge-base.md#language-support).
55
55
@@ -67,7 +67,7 @@ Chit-chat is supported for several predefined personalities:
67
67
The responses range from formal to informal and irreverent. Select the personality that is closest aligned with the tone you want for your bot.
68
68
69
69
### Edit bot-specific questions
70
-
There are some bot-specific questions that are part of the chit-chat data set, and have been filled in with generic answers. Change these answers to best reflect your bot details.
70
+
There are some bot-specific questions that are part of the chit-chat data set, and are filled in with generic answers. Change these answers to best reflect your bot details.
71
71
72
72
We recommend making the following chit-chat QnAs more specific:
73
73
@@ -85,14 +85,14 @@ If you add your own chit-chat QnA pairs, make sure to add metadata so these answ
85
85
86
86
GenerateAnswer API uses both questions and the answer to search for best answers to a user's query.
87
87
88
-
### Searching questions only when answer is not relevant
88
+
### Searching questions only when answer isn't relevant
89
89
90
90
Use the [`RankerType=QuestionOnly`](#choosing-ranker-type) if you don't want to search answers.
91
91
92
-
An example of this, is when the knowledge base is a catalog of acronyms as questions with their full form as the answer. The value of the answer will not help to search for the appropriate answer.
92
+
An example is when the knowledge base is a catalog of acronyms as questions with their full form as the answer. The value of the answer doesn't help find the appropriate answer.
93
93
94
94
## Ranking/Scoring
95
-
Make sure you are making the best use of the ranking features QnA Maker supports. Doing so will improve the likelihood that a given user query is answered with an appropriate response.
95
+
Make sure you're making the best use of the ranking features QnA Maker supports. Doing so improves the likelihood that a given user query is answered with an appropriate response.
96
96
97
97
### Choosing a threshold
98
98
@@ -102,7 +102,7 @@ The default [confidence score](confidence-score.md) that is used as a threshold
102
102
By default, QnA Maker searches through questions and answers. If you want to search through questions only, to generate an answer, use the `RankerType=QuestionOnly` in the POST body of the GenerateAnswer request.
103
103
104
104
### Add alternate questions
105
-
[Alternate questions](../how-to/edit-knowledge-base.md) improve the likelihood of a match with a user query. Alternate questions are useful when there are multiple ways in which the same question may be asked. This can include changes in the sentence structure and word-style.
105
+
[Alternate questions](../how-to/edit-knowledge-base.md) improve the likelihood of a match with a user query. Alternate questions are useful when there are multiple ways in which the same question may be asked. This approach can include changes in the sentence structure and word-style.
106
106
107
107
|Original query|Alternate queries|Change|
108
108
|--|--|--|
@@ -113,14 +113,14 @@ By default, QnA Maker searches through questions and answers. If you want to sea
113
113
114
114
### Use metadata tags to filter questions and answers
115
115
116
-
[Metadata](../how-to/edit-knowledge-base.md) adds the ability for a client application to know it should not take all answers but instead to narrow down the results of a user query based on metadata tags. The knowledge base answer can differ based on the metadata tag, even if the query is the same. For example, *"where is parking located"* can have a different answer if the location of the restaurant branch is different - that is, the metadata is *Location: Seattle* versus *Location: Redmond*.
116
+
[Metadata](../how-to/edit-knowledge-base.md) adds the ability for a client application to know it shouldn't take all answers but instead to narrow down the results of a user query based on metadata tags. The knowledge base answer can differ based on the metadata tag, even if the query is the same. For example, *where is parking located* can have a different answer if the location of the restaurant branch is different - that is, the metadata is *Location: Seattle* versus *Location: Redmond*.
117
117
118
118
### Use synonyms
119
119
120
-
While there is some support for synonyms in the English language, use case-insensitive word alterations via the [Alterations API](/rest/api/qnamaker/alterations/replace) to add synonyms to keywords that take different forms. Synonyms are added at the QnA Maker service-level and **shared by all knowledge bases in the service**.
120
+
While there's some support for synonyms in the English language, use case-insensitive word alterations via the [Alterations API](/rest/api/qnamaker/alterations/replace) to add synonyms to keywords that take different forms. Synonyms are added at the QnA Maker service-level and **shared by all knowledge bases in the service**.
121
121
122
122
### Use distinct words to differentiate questions
123
-
QnA Maker's ranking algorithm, that matches a user query with a question in the knowledge base, works best if each question addresses a different need. Repetition of the same word set between questions reduces the likelihood that the right answer is chosen for a given user query with those words.
123
+
QnA Maker's ranking algorithm that matches a user query with a question in the knowledge base works best if each question addresses a different need. Repetition of the same word set between questions reduces the likelihood that the right answer is chosen for a given user query with those words.
124
124
125
125
For example, you might have two separate QnAs with the following questions:
126
126
@@ -129,14 +129,14 @@ For example, you might have two separate QnAs with the following questions:
129
129
|where is the parking *location*|
130
130
|where is the ATM *location*|
131
131
132
-
Since these two QnAs are phrased with very similar words, this similarity could cause very similar scores for many user queries that are phrased like *"where is the `<x>` location"*. Instead, try to clearly differentiate with queries like *"where is the parking lot"* and *"where is the ATM"*, by avoiding words like "location" that could be in many questions in your KB.
132
+
Since these two QnAs are phrased with similar words, this similarity could cause similar scores for many user queries that are phrased like *where is the `<x>` location*. Instead, try to clearly differentiate with queries like *where is the parking lot* and *where is the ATM*, by avoiding words like "location" that could be in many questions in your KB.
133
133
134
134
## Collaborate
135
-
QnA Maker allows users to collaborate on a knowledge base. Users need access to the Azure AI QnA Maker resource group in order to access the knowledge bases. Some organizations may want to outsource the knowledge base editing and maintenance, and still be able to protect access to their Azure resources. This editor-approver model is done by setting up two identical [QnA Maker services](../How-to/set-up-qnamaker-service-azure.md) in different subscriptions and selecting one for the edit-testing cycle. Once testing is finished, the knowledge base contents are transferred with an [import-export](../tutorials/export-knowledge-base.md) process to the QnA Maker service of the approver that will finally publish the knowledge base and update the endpoint.
135
+
QnA Maker allows users to collaborate on a knowledge base. Users need access to the Azure AI QnA Maker resource group in order to access the knowledge bases. Some organizations may want to outsource the knowledge base editing and maintenance, and still be able to protect access to their Azure resources. This editor-approver model is done by setting up two identical [QnA Maker services](../How-to/set-up-qnamaker-service-azure.md) in different subscriptions and selecting one for the edit-testing cycle. Once testing is finished, the knowledge base contents are transferred with an [import-export](../tutorials/export-knowledge-base.md) process to the QnA Maker service of the approver that finally publishes the knowledge base and update the endpoint.
136
136
137
137
## Active learning
138
138
139
-
[Active learning](../How-to/use-active-learning.md) does the best job of suggesting alternative questions when it has a wide range of quality and quantity of user-based queries. It is important to allow client-applications' user queries to participate in the active learning feedback loop without censorship. Once questions are suggested in the QnA Maker portal, you can **[filter by suggestions](../how-to/improve-knowledge-base.md)** then review and accept or reject those suggestions.
139
+
[Active learning](../How-to/use-active-learning.md) does the best job of suggesting alternative questions when it has a wide range of quality and quantity of user-based queries. It's important to allow client-applications' user queries to participate in the active learning feedback loop without censorship. Once questions are suggested in the QnA Maker portal, you can **[filter by suggestions](../how-to/improve-knowledge-base.md)** then review and accept or reject those suggestions.
0 commit comments