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/cognitive-services/QnAMaker/Concepts/best-practices.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ The [knowledge base development lifecycle](../Concepts/development-lifecycle-kno
19
19
20
20
## Extraction
21
21
22
-
The QnA Maker service is continually improving the algorithms that extract QnAs from content and expanding the list of supported file and HTML formats. Follow the [guidelines](../Concepts/data-sources-supported.md) for data extraction based on your document type.
22
+
The QnA Maker service is continually improving the algorithms that extract QnAs from content and expanding the list of supported file and HTML formats. Follow the [guidelines](../Concepts/content-types.md) for data extraction based on your document type.
23
23
24
24
In general, FAQ pages should be stand-alone and not combined with other information. Product manuals should have clear headings and preferably an index page.
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/How-To/add-sharepoint-datasources.md
+32-32Lines changed: 32 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,34 +14,34 @@ ms.author: diberry
14
14
15
15
# Add a secured SharePoint data source to your knowledge base
16
16
17
-
Add secured SharePoint data sources to your knowledge base to enrich the knowledge base with questions and answers that may be secured with Active Directory.
17
+
Add secured SharePoint data sources to your knowledge base to enrich the knowledge base with questions and answers that may be secured with Active Directory.
18
18
19
-
When you add a secured SharePoint document to your knowledge base, as the QnA Maker manager, you must request Active Directory permission for QnA Maker. Once this permission is given from the Active Directory manager to QnA Maker for access to SharePoint, it doesn't have to be given again. Each subsequent document addition to the knowledge base will not need authorization if it is in the same SharePoint resource.
19
+
When you add a secured SharePoint document to your knowledge base, as the QnA Maker manager, you must request Active Directory permission for QnA Maker. Once this permission is given from the Active Directory manager to QnA Maker for access to SharePoint, it doesn't have to be given again. Each subsequent document addition to the knowledge base will not need authorization if it is in the same SharePoint resource.
20
20
21
21
If the QnA Maker knowledge base manager is not the Active Directory manager, you will need to communicate with the Active Directory manager to finish this process.
22
22
23
23
## Add supported file types to knowledge base
24
24
25
-
You can add all QnA Maker-supported [file types](../Concepts/data-sources-supported.md) from a SharePoint site to your knowledge base. You may have to grant [permissions](#permissions) if the file resource is secured.
25
+
You can add all QnA Maker-supported [file types](../Concepts/content-types.md) from a SharePoint site to your knowledge base. You may have to grant [permissions](#permissions) if the file resource is secured.
26
26
27
27
1. From the library with the SharePoint site, select the file's ellipsis menu, `...`.
28
28
1. Copy the file's URL.
29
29
30
30

31
31
32
-
1. In the QnA Maker portal, on the **Settings** page, [add the URL](edit-knowledge-base.md#add-datasource) to the knowledge base.
32
+
1. In the QnA Maker portal, on the **Settings** page, [add the URL](edit-knowledge-base.md#add-datasource) to the knowledge base.
33
33
34
34
### Images with SharePoint files
35
35
36
36
If files include images, those are not extracted. You can add the image, from the QnA Maker portal, after the file is extracted into QnA pairs.
37
37
38
-
Add the image with the following markdown syntax:
38
+
Add the image with the following markdown syntax:
39
39
40
40
```markdown
41
41

42
42
```
43
43
44
-
The text in the square brackets, `[]`, explains the image. The URL in the parentheses, `()`, is the direct link to the image.
44
+
The text in the square brackets, `[]`, explains the image. The URL in the parentheses, `()`, is the direct link to the image.
45
45
46
46
When you test the QnA pair in the interactive test panel, in the QnA Maker portal, the image is displayed, instead of the markdown text. This validates the image can be publicly retrieved from your client-application.
47
47
@@ -52,39 +52,39 @@ Granting permissions happens when a secured file from a SharePoint server is add
52
52
* no additional steps - the person adding the file has all the permissions needed.
53
53
* steps by both [knowledge base manager](#knowledge-base-manager-add-sharepoint-data-source-in-qna-maker-portal) and [Active Directory manager](#active-directory-manager-grant-file-read-access-to-qna-maker).
54
54
55
-
See the steps listed below.
55
+
See the steps listed below.
56
56
57
57
### Knowledge base manager: add SharePoint data source in QnA Maker portal
58
58
59
59
When the **QnA Maker manager** adds a secured SharePoint document to a knowledge base, the knowledge base manager initiates a request for permission that the Active Directory manager needs to complete.
60
60
61
-
The request begins with a pop-up to authenticate to an Active Directory account.
61
+
The request begins with a pop-up to authenticate to an Active Directory account.
62
62
63
63

64
64
65
-
Once the QnA Maker manager selects the account, the Azure Active Directory administrator will receive a notice that they need to allow the QnA Maker app (not the QnA Maker manager) access to the SharePoint resource. The Azure Active Directory manager will need to do this for every SharePoint resource, but not every document in that resource.
65
+
Once the QnA Maker manager selects the account, the Azure Active Directory administrator will receive a notice that they need to allow the QnA Maker app (not the QnA Maker manager) access to the SharePoint resource. The Azure Active Directory manager will need to do this for every SharePoint resource, but not every document in that resource.
66
66
67
67
### Active directory manager: grant file read access to QnA Maker
68
68
69
-
The Active Directory manager (not the QnA Maker manager) needs to grant access to QnA Maker to access the SharePoint resource by selecting [this link](https://login.microsoftonline.com/common/oauth2/v2.0/authorize?response_type=id_token&scope=Files.Read%20Files.Read.All%20Sites.Read.All%20User.Read%20User.ReadBasic.All%20profile%20openid%20email&client_id=c2c11949-e9bb-4035-bda8-59542eb907a6&redirect_uri=https%3A%2F%2Fwww.qnamaker.ai%3A%2FCreate&state=68) to authorize the QnA Maker Portal SharePoint enterprise app to have file read permissions.
69
+
The Active Directory manager (not the QnA Maker manager) needs to grant access to QnA Maker to access the SharePoint resource by selecting [this link](https://login.microsoftonline.com/common/oauth2/v2.0/authorize?response_type=id_token&scope=Files.Read%20Files.Read.All%20Sites.Read.All%20User.Read%20User.ReadBasic.All%20profile%20openid%20email&client_id=c2c11949-e9bb-4035-bda8-59542eb907a6&redirect_uri=https%3A%2F%2Fwww.qnamaker.ai%3A%2FCreate&state=68) to authorize the QnA Maker Portal SharePoint enterprise app to have file read permissions.
70
70
71
71

72
72
73
73
<!--
74
-
The Active Directory manager must grant QnA Maker access either by application name, `QnAMakerPortalSharePoint`, or by application ID, `c2c11949-e9bb-4035-bda8-59542eb907a6`.
74
+
The Active Directory manager must grant QnA Maker access either by application name, `QnAMakerPortalSharePoint`, or by application ID, `c2c11949-e9bb-4035-bda8-59542eb907a6`.
75
75
-->
76
76
<!--
77
-
### Grant access from the interactive pop-up window
77
+
### Grant access from the interactive pop-up window
78
78
79
-
The Active Directory manager will get a pop-up window requesting permissions to the `QnAMakerPortalSharePoint` app. The pop-up window includes the QnA Maker Manager email address that initiated the request, an `App Info` link to learn more about **QnAMakerPortalSharePoint**, and a list of permissions requested. Select **Accept** to provide those permissions.
79
+
The Active Directory manager will get a pop-up window requesting permissions to the `QnAMakerPortalSharePoint` app. The pop-up window includes the QnA Maker Manager email address that initiated the request, an `App Info` link to learn more about **QnAMakerPortalSharePoint**, and a list of permissions requested. Select **Accept** to provide those permissions.
80
80
81
81

82
82
-->
83
83
<!--
84
84
85
85
### Grant access from the App Registrations list
86
86
87
-
1. The Active Directory manager signs in to the Azure portal and opens **[App registrations list](https://ms.portal.azure.com/#blade/Microsoft_AAD_IAM/ApplicationsListBlade)**.
87
+
1. The Active Directory manager signs in to the Azure portal and opens **[App registrations list](https://ms.portal.azure.com/#blade/Microsoft_AAD_IAM/ApplicationsListBlade)**.
88
88
89
89
1. Search for and select the **QnAMakerPortalSharePoint** app. Change the second filter box from **My apps** to **All apps**. The app information will open on the right side.
90
90
@@ -94,52 +94,52 @@ The Active Directory manager will get a pop-up window requesting permissions to
94
94
95
95
[](../media/add-sharepoint-datasources/select-settings-for-qna-maker-app-registration.png#lightbox)
96
96
97
-
1. Under **API access**, select **Required permissions**.
97
+
1. Under **API access**, select **Required permissions**.
98
98
99
99

100
100
101
-
1. Do not change any settings in the **Enable Access** window. Select **Grant Permission**.
101
+
1. Do not change any settings in the **Enable Access** window. Select **Grant Permission**.
### Grant access from the Azure Active Directory admin center
110
110
111
-
1. The Active Directory manager signs in to the Azure portal and opens **[Enterprise applications](https://aad.portal.azure.com/#blade/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/AllApps)**.
111
+
1. The Active Directory manager signs in to the Azure portal and opens **[Enterprise applications](https://aad.portal.azure.com/#blade/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/AllApps)**.
112
112
113
-
1. Search for `QnAMakerPortalSharePoint` the select the QnA Maker app.
113
+
1. Search for `QnAMakerPortalSharePoint` the select the QnA Maker app.
114
114
115
115
[](../media/add-sharepoint-datasources/search-enterprise-apps-for-qna-maker.png#lightbox)
116
116
117
-
1. Under **Security**, go to **Permissions**. Select **Grant admin consent for Organization**.
117
+
1. Under **Security**, go to **Permissions**. Select **Grant admin consent for Organization**.
118
118
119
119
[](../media/add-sharepoint-datasources/grant-aad-permissions-to-enterprise-app.png#lightbox)
120
120
121
-
1. Select a Sign-On account with permissions to grant permissions for the Active Directory.
121
+
1. Select a Sign-On account with permissions to grant permissions for the Active Directory.
122
+
122
123
123
124
124
-
125
125
<!--
126
126
127
127
## Add SharePoint data source with APIs
128
128
129
-
You need to get the SharePoint file's URI before adding it to QnA Maker.
129
+
You need to get the SharePoint file's URI before adding it to QnA Maker.
130
130
131
131
## Get SharePoint File URI
132
132
133
133
Use the following steps to transform the SharePoint URL into a sharing token.
134
134
135
-
1. Encode the URL using [base64](https://en.wikipedia.org/wiki/Base64).
135
+
1. Encode the URL using [base64](https://en.wikipedia.org/wiki/Base64).
136
136
137
-
1. Convert the base64-encoded result to an unpadded base64url format with the following character changes.
137
+
1. Convert the base64-encoded result to an unpadded base64url format with the following character changes.
138
138
139
-
* Remove the equal character, `=` from the end of the value.
140
-
* Replace `/` with `_`.
141
-
* Replace `+` with `-`.
142
-
* Append `u!` to be beginning of the string.
139
+
* Remove the equal character, `=` from the end of the value.
140
+
* Replace `/` with `_`.
141
+
* Replace `+` with `-`.
142
+
* Append `u!` to be beginning of the string.
143
143
144
144
1. Sign in to Graph explorer and run the following query, where `sharedURL` is ...:
145
145
@@ -174,9 +174,9 @@ Use the **@microsoft.graph.downloadUrl** from the previous section as the `fileu
174
174
175
175
## Remove QnA Maker app from SharePoint authorization
176
176
177
-
1. Use the steps in the previous section to find the Qna Maker app in the Active Directory admin center.
178
-
1. When you select the **QnAMakerPortalSharePoint**, select **Overview**.
179
-
1. Select **Delete** to remove permissions.
177
+
1. Use the steps in the previous section to find the Qna Maker app in the Active Directory admin center.
178
+
1. When you select the **QnAMakerPortalSharePoint**, select **Overview**.
0 commit comments