Skip to content

Commit 345aaa3

Browse files
committed
acrolinx
1 parent c9d4148 commit 345aaa3

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

articles/ai-services/qnamaker/concepts/best-practices.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -30,26 +30,26 @@ In general, FAQ pages should be stand-alone and not combined with other informat
3030

3131
### Good questions
3232

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.
3434

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.
3636

3737

3838
### Add relevant alternative questions
3939

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.
4141

4242
### Good answers
4343

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.
4545

4646
|Answer|Follow-up prompts|
4747
|--|--|
4848
|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|
4949
|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.|
5050

5151
## 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).
5353

5454
Chit-chat is supported in [many languages](../how-to/chit-chat-knowledge-base.md#language-support).
5555

@@ -67,7 +67,7 @@ Chit-chat is supported for several predefined personalities:
6767
The responses range from formal to informal and irreverent. Select the personality that is closest aligned with the tone you want for your bot.
6868

6969
### 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.
7171

7272
We recommend making the following chit-chat QnAs more specific:
7373

@@ -85,14 +85,14 @@ If you add your own chit-chat QnA pairs, make sure to add metadata so these answ
8585

8686
GenerateAnswer API uses both questions and the answer to search for best answers to a user's query.
8787

88-
### Searching questions only when answer is not relevant
88+
### Searching questions only when answer isn't relevant
8989

9090
Use the [`RankerType=QuestionOnly`](#choosing-ranker-type) if you don't want to search answers.
9191

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.
9393

9494
## 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.
9696

9797
### Choosing a threshold
9898

@@ -102,7 +102,7 @@ The default [confidence score](confidence-score.md) that is used as a threshold
102102
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.
103103

104104
### 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.
106106

107107
|Original query|Alternate queries|Change|
108108
|--|--|--|
@@ -113,14 +113,14 @@ By default, QnA Maker searches through questions and answers. If you want to sea
113113

114114
### Use metadata tags to filter questions and answers
115115

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*.
117117

118118
### Use synonyms
119119

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**.
121121

122122
### 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.
124124

125125
For example, you might have two separate QnAs with the following questions:
126126

@@ -129,14 +129,14 @@ For example, you might have two separate QnAs with the following questions:
129129
|where is the parking *location*|
130130
|where is the ATM *location*|
131131

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.
133133

134134
## 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.
136136

137137
## Active learning
138138

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.
140140

141141
## Next steps
142142

0 commit comments

Comments
 (0)