Skip to content

Commit 5c38567

Browse files
committed
Merge branch 'master' into add-lda-module
2 parents 6055826 + f985e5b commit 5c38567

File tree

49 files changed

+779
-615
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+779
-615
lines changed

articles/api-management/api-management-howto-ip-addresses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If your API Management service is inside a virtual network, it will have two typ
5959

6060
Public IP addresses are used for internal communication on port `3443` - for managing configuration (for example, through Azure Resource Manager). In the external VNet configuration, they are also used for runtime API traffic. When a request is sent from API Management to a public-facing (Internet-facing) backend, a public IP address will be visible as the origin of the request.
6161

62-
Private virtual IP (VIP) addresses are used to connect from within the network to API Management endpoints - gateways, the developer portal, and the management plane for direct API access. You can use them for setting up DNS records within the network.
62+
Private virtual IP (VIP) addresses, available **only** in the [internal VNet mode](api-management-using-with-internal-vnet.md), are used to connect from within the network to API Management endpoints - gateways, the developer portal, and the management plane for direct API access. You can use them for setting up DNS records within the network.
6363

6464
You will see addresses of both types in the Azure portal and in the response of the API call:
6565

articles/api-management/api-management-transformation-policies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ This topic provides a reference for the following API Management policies. For i
7373
|Name|Description|Required|Default|
7474
|----------|-----------------|--------------|-------------|
7575
|apply|The attribute must be set to one of the following values.<br /><br /> - always - always apply conversion.<br />- content-type-json - convert only if response Content-Type header indicates presence of JSON.|Yes|N/A|
76-
|consider-accept-header|The attribute must be set to one of the following values.<br /><br /> - true - apply conversion if JSON is requested in request Accept header.<br />- false -always apply conversion.|No|true|
76+
|consider-accept-header|The attribute must be set to one of the following values.<br /><br /> - true - apply conversion if XML is requested in request Accept header.<br />- false -always apply conversion.|No|true|
7777
|parse-date|When set to `false` date values are simply copied during transformation|No|true|
7878

7979
### Usage
@@ -118,7 +118,7 @@ This topic provides a reference for the following API Management policies. For i
118118
|----------|-----------------|--------------|-------------|
119119
|kind|The attribute must be set to one of the following values.<br /><br /> - javascript-friendly - the converted JSON has a form friendly to JavaScript developers.<br />- direct - the converted JSON reflects the original XML document's structure.|Yes|N/A|
120120
|apply|The attribute must be set to one of the following values.<br /><br /> - always - convert always.<br />- content-type-xml - convert only if response Content-Type header indicates presence of XML.|Yes|N/A|
121-
|consider-accept-header|The attribute must be set to one of the following values.<br /><br /> - true - apply conversion if XML is requested in request Accept header.<br />- false -always apply conversion.|No|true|
121+
|consider-accept-header|The attribute must be set to one of the following values.<br /><br /> - true - apply conversion if JSON is requested in request Accept header.<br />- false -always apply conversion.|No|true|
122122

123123
### Usage
124124
This policy can be used in the following policy [sections](https://azure.microsoft.com/documentation/articles/api-management-howto-policies/#sections) and [scopes](https://azure.microsoft.com/documentation/articles/api-management-howto-policies/#scopes).

articles/cognitive-services/QnAMaker/Concepts/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ QnA Maker allows users to [collaborate](../How-to/collaborate-knowledge-base.md)
134134

135135
## Active learning
136136

137-
[Active learning](../How-to/improve-knowledge-base.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#accept-an-active-learning-suggestion-in-the-knowledge-base)** then review and accept or reject those suggestions.
137+
[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#accept-an-active-learning-suggestion-in-the-knowledge-base)** then review and accept or reject those suggestions.
138138

139139
## Next steps
140140

articles/cognitive-services/QnAMaker/How-To/add-sharepoint-datasources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can add all QnA Maker-supported [file types](../Concepts/content-types.md) f
2727

2828
![Get the SharePoint file URL by selecting the file's ellipsis menu then copying the URL.](../media/add-sharepoint-datasources/get-sharepoint-file-url.png)
2929

30-
1. In the QnA Maker portal, on the **Settings** page, [add the URL](edit-knowledge-base.md#add-datasource) to the knowledge base.
30+
1. In the QnA Maker portal, on the **Settings** page, [add the URL](manage-knowledge-bases.md#edit-knowledge-base) to the knowledge base.
3131

3232
### Images with SharePoint files
3333

Lines changed: 31 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,68 @@
11
---
22
title: Edit a knowledge base - QnA Maker
3-
titleSuffix: Azure Cognitive Services
4-
description: QnA Maker allows you to manage the content of your knowledge base by providing an easy-to-use editing experience.
5-
services: cognitive-services
6-
author: diberry
7-
manager: nitinme
8-
ms.service: cognitive-services
9-
ms.subservice: qna-maker
3+
description: QnA Maker allows you to manage the content of your knowledge base by providing an easy-to-use editing experience.
104
ms.topic: conceptual
11-
ms.date: 11/21/2019
12-
ms.author: diberry
13-
ms.custom: seodec18
5+
ms.date: 03/16/2020
146
---
15-
# Edit a knowledge base in QnA Maker
7+
8+
# Edit QnA sets in your knowledge base
169

1710
QnA Maker allows you to manage the content of your knowledge base by providing an easy-to-use editing experience.
1811

19-
<a name="add-datasource"></a>
12+
QnA sets are added from a datasource, such as a file or URL, or added as an editorial source. An editorial source indicates the QnA set was added in the QnA portal manually. All QnA sets are available for editing.
13+
14+
## Add an editorial QnA set
15+
1. Sign in to the [QnA portal](https://www.qnamaker.ai/), then select the knowledge base to add the QnA set to.
16+
1. On the **EDIT** page of the knowledge base, select **Add QnA set** to add a new QnA set.
2017

21-
## Edit your knowledge base content
18+
1. In the new QnA set row, add the required **Question** and **Answer** fields. The other fields are optional. All fields can be changed at any time.
2219

23-
1. Select **My knowledge bases** in the top navigation bar.
20+
1. Optionally, add **alternate phrasing**. Alternate phrasing is any form of the question that is significantly different from the original question but should provide the same answer.
2421

25-
You can see all the services you created or shared with you sorted in the descending order of the **last modified** date.
22+
When your knowledge base is published, and you have active learning turned on, QnA Maker collects alternate phrasing choices for you to accept. These choices are selected in order to increase the prediction accuracy.
2623

27-
![My Knowledge Bases](../media/qnamaker-how-to-edit-kb/my-kbs.png)
24+
1. Optionally, add **metadata**. To view metadata, select **View options** in the context menu. Metadata provides filters to the answers that the client application, such as a chat bot, provides.
2825

29-
1. Select a particular knowledge base to make edits to it.
30-
31-
1. Select **Settings**. Here you can edit mandatory field Service Name.
32-
33-
|Goal|Action|
34-
|--|--|
35-
|Add URL|You can add new URLs to add new FAQ content to Knowledge base by clicking **Manage knowledge base -> '+ Add URL'** link.|
36-
|Delete URL|You can delete existing URLs by selecting the delete icon, the trash can.|
37-
|Refresh content|If you want your knowledge base to crawl the latest content of existing URLs, select the **Refresh** checkbox. This will update the knowledge base with latest URL content once. This is not setting a regular schedule of updates.|
38-
|Add file|You can add a supported file document to be part of a knowledge base, by selecting **Manage knowledge base**, then selecting **+ Add File**|
39-
|Import|You can also import any existing knowledge base by selecting **Import Knowledge base** button. |
40-
|Update|Updating of knowledge base depends on **management pricing tier** used while creating QnA Maker service associated with your knowledge base. You can also update the management tier from Azure portal if required.
26+
1. Optionally, add **follow-up prompts**. Follow-up prompts provide additional conversation paths to the client application to present to the user.
4127

42-
1. Once you are done making changes to the knowledge base, select **Save and train** in the top right corner of the page in order to persist the changes.
28+
1. Select **Save and train** to see predictions including the new QnA set.
4329

44-
![Save and Train](../media/qnamaker-how-to-edit-kb/save-and-train.png)
30+
## Edit a QnA set
4531

46-
>[!CAUTION]
47-
>If you leave the page before selecting **Save and train**, all changes will be lost.
32+
Any field in any QnA set can be edited, regardless of the original data source. Some fields may not be visible due to your current **View Options** settings, found in the context tool bar.
4833

49-
## Add a QnA pair
34+
## Delete a QnA set
5035

51-
On the **EDIT** page, select **Add QnA pair** to add a new row to the knowledge base table.
36+
To delete a QnA, click the **delete** icon on the far right of the QnA row. This is a permanent operation. It can't be undone. Consider exporting your KB from the **Publish** page before deleting sets.
5237

53-
![Add QnA pair](../media/qnamaker-how-to-edit-kb/add-qnapair.png)
38+
![Delete QnA set](../media/qnamaker-how-to-edit-kb/delete-qnapair.png)
5439

55-
## Delete a QnA pair
40+
## Find the QnA set ID
5641

57-
To delete a QnA, click the **delete** icon on the far right of the QnA row. This is a permanent operation. It can't be undone. Consider exporting your KB from the **Publish** page before deleting pairs.
42+
If you need to find the QnA set ID, you can find it in two places:
5843

59-
![Delete QnA pair](../media/qnamaker-how-to-edit-kb/delete-qnapair.png)
44+
* Hover on the delete icon on the QnA set row you are interested in. The hover text includes the QnA set ID.
45+
* Export the knowledge base. Each QnA set in the knowledge base includes the QnA set ID.
6046

6147
## Add alternate questions
6248

63-
Add alternate questions to an existing QnA pair to improve the likelihood of a match to a user query.
49+
Add alternate questions to an existing QnA set to improve the likelihood of a match to a user query.
6450

6551
![Add Alternate Questions](../media/qnamaker-how-to-edit-kb/add-alternate-question.png)
6652

6753
## Add metadata
6854

69-
Add metadata pairs by first selecting **View options**, then selecting **Show metadata**. This displays the metadata column. Next, select the **+** sign to add a metadata pair. This pair consists of one key and one value.
70-
71-
![Add Metadata](../media/qnamaker-how-to-edit-kb/add-metadata.png)
72-
73-
> [!TIP]
74-
> Make sure to periodically Save and train the knowledge base after making edits to avoid losing changes.
75-
76-
## Manage large knowledge bases
77-
78-
* **Data source groups**: The QnAs are grouped by the data source from which they were extracted. You can expand or collapse the data source.
79-
80-
![Use the QnA Maker data source bar to collapse and expand data source questions and answers](../media/qnamaker-how-to-edit-kb/data-source-grouping.png)
55+
Add metadata sets by first selecting **View options**, then selecting **Show metadata**. This displays the metadata column. Next, select the **+** sign to add a metadata set. This set consists of one key and one value.
8156

82-
* **Search knowledge base**: You can search the knowledge base by typing in the text box at the top of the Knowledge Base table. Click enter to search on the question, answer, or metadata content. Click on the X icon to remove the search filter.
57+
## Save changes to the QnA sets
8358

84-
![Use the QnA Maker search box above the questions and answers to reduce the view to only filter-matching items](../media/qnamaker-how-to-edit-kb/search-paginate-group.png)
59+
Periodically select **Save and train** after making edits to avoid losing changes.
8560

86-
* **Pagination**: Quickly move through data sources to manage large knowledge bases
87-
88-
![Use the QnA Maker pagination features above the questions and answers to move through pages of questions and answers](../media/qnamaker-how-to-edit-kb/pagination.png)
89-
90-
## Delete knowledge bases
91-
92-
Deleting a knowledge base (KB) is a permanent operation. It can't be undone. Before deleting a knowledge base, you should export the knowledge base from the **Settings** page of the QnA Maker portal.
93-
94-
If you share your KB with [collaborators](collaborate-knowledge-base.md) then delete it, everyone loses access to the KB.
95-
96-
## Delete Azure resources
97-
98-
If you delete any of the Azure resources used for your QnA Maker knowledge bases, the knowledge bases will no longer function. Before deleting any resources, make sure you export your knowledge bases from the **Settings** page.
61+
![Add Metadata](../media/qnamaker-how-to-edit-kb/add-metadata.png)
9962

10063
## Next steps
10164

10265
> [!div class="nextstepaction"]
10366
> [Collaborate on a knowledge base](./collaborate-knowledge-base.md)
67+
68+
* [Manage Azure resources used by QnA Maker](set-up-qnamaker-service-azure.md)

articles/cognitive-services/QnAMaker/How-To/improve-knowledge-base.md

Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,23 @@
11
---
22
title: Improve knowledge base - QnA Maker
3-
titleSuffix: Azure Cognitive Services
43
description: Improve the quality of your knowledge base with active learning. Review, accept or reject, add without removing or changing existing questions.
5-
author: diberry
6-
manager: nitinme
7-
services: cognitive-services
8-
ms.service: cognitive-services
9-
ms.subservice: qna-maker
104
ms.topic: conceptual
11-
ms.date: 02/27/2020
12-
ms.author: diberry
5+
ms.date: 03/16/2020
136
---
147

15-
# Use active learning to improve your knowledge base
168

17-
[Active learning](../Concepts/active-learning-suggestions.md) allows you to improve the quality of your knowledge base by suggesting alternative questions, based on user-submissions, to your question and answer pair. You review those suggestions, either adding them to existing questions or rejecting them.
9+
# Accept active learning suggested questions in the knowledge base
1810

19-
Your knowledge base doesn't change automatically. In order for any change to take effect, you must accept the suggestions. These suggestions add questions but don't change or remove existing questions.
2011

12+
<a name="accept-an-active-learning-suggestion-in-the-knowledge-base"></a>
2113

22-
## Upgrade your runtime version to use active learning
23-
24-
Active Learning is supported in runtime version 4.4.0 and above. If your knowledge base was created on an earlier version, [upgrade your runtime](set-up-qnamaker-service-azure.md#get-the-latest-runtime-updates) to use this feature.
25-
26-
## Turn on active learning to see suggestions
27-
28-
Active learning is off by default. Turn it on to see suggested questions. After you turn on active learning, you need to send information from the client app to QnA Maker. For more information, see [Architectural flow for using GenerateAnswer and Train APIs from a bot](#architectural-flow-for-using-generateanswer-and-train-apis-from-a-bot).
29-
30-
1. Select **Publish** to publish the knowledge base. Active learning queries are collected from the GenerateAnswer API prediction endpoint only. The queries to the Test pane in the QnA Maker portal do not impact active learning.
31-
32-
1. To turn active learning on in the QnA Maker portal, go to the top-right corner, select your **Name**, go to [**Service Settings**](https://www.qnamaker.ai/UserSettings).
33-
34-
![Turn on active learning's suggested question alternatives from the Service settings page. Select your user name in the top-right menu, then select Service Settings.](../media/improve-knowledge-base/Endpoint-Keys.png)
35-
36-
37-
1. Find the QnA Maker service then toggle **Active Learning**.
38-
39-
> [!div class="mx-imgBorder"]
40-
> [![On the Service settings page, toggle on Active Learning feature. If you are not able to toggle the feature, you may need to upgrade your service.](../media/improve-knowledge-base/turn-active-learning-on-at-service-setting.png)](../media/improve-knowledge-base/turn-active-learning-on-at-service-setting.png#lightbox)
41-
42-
> [!Note]
43-
> The exact version on the preceding image is shown as an example only. Your version may be different.
14+
Active Learning alters the Knowledge Base or Search Service after you approve the suggestion, then save and train. If you approve the suggestion it will be added as an alternate question.
4415

45-
Once **Active Learning** is enabled, the knowledge base suggests new questions at regular intervals based on user-submitted questions. You can disable **Active Learning** by toggling the setting again.
16+
## Turn on active learning
4617

47-
## Accept an active learning suggestion in the knowledge base
18+
In order to see suggested questions, you must [turn on active learning](use-active-learning.md) for your QnA Maker resource.
4819

49-
Active Learning alters the Knowledge Base or Search Service after you approve the suggestion, then save and train. If you approve the suggestion it will be added as an alternate question.
20+
## View suggested questions
5021

5122
1. In order to see the suggested questions, on the **Edit** knowledge base page, select **View Options**, then select **Show active learning suggestions**.
5223

@@ -105,7 +76,7 @@ When the client application (such as a chat bot) receives the response, the top
10576
"questions": [
10677
"Wi-Fi Direct Status Indicator"
10778
],
108-
"answer": "**Wi-Fi Direct Status Indicator**\n\nStatus bar icons indicate your current Wi-Fi Direct connection status: \n\nWhen your device is connected to another device using Wi-Fi Direct, '$ \n\n+ + ' Wi-Fi Direct is displayed in the Status bar.",
79+
"answer": "**Wi-Fi Direct Status Indicator**\n\nStatus bar icons indicate your current Wi-Fi Direct connection status: \n\nWhen your device is connected to another device using Wi-Fi Direct, '$ \n\n+ *+ ' Wi-Fi Direct is displayed in the Status bar.",
10980
"score": 74.21,
11081
"id": 607,
11182
"source": "Bugbash KB.pdf",

0 commit comments

Comments
 (0)