Skip to content

Commit eac4909

Browse files
v-albemiv-albemi
authored
Merge pull request #105148 from diberry/diberry/0221-qna-faq
[Cogsvcs] QnA - collapsing FAQ
2 parents 220711b + c77f969 commit eac4909

File tree

1 file changed

+134
-34
lines changed

1 file changed

+134
-34
lines changed

‎articles/cognitive-services/QnAMaker/troubleshooting.md

Lines changed: 134 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
11
---
22
title: Troubleshooting - QnA Maker
3-
titleSuffix: Azure Cognitive Services
43
description: The curated list of the most frequently asked questions regarding the QnA Maker service will help you adopt the service faster and with better results.
5-
services: cognitive-services
6-
author: diberry
7-
manager: nitinme
8-
ms.service: cognitive-services
9-
ms.subservice: qna-maker
104
ms.topic: article
11-
ms.date: 01/28/2020
5+
ms.date: 02/21/2020
126
ms.author: diberry
13-
ms.custom: seodec18
147
---
158
# Troubleshooting for QnA Maker
169

1710
The curated list of the most frequently asked questions regarding the QnA Maker service will help you adopt the service faster and with better results.
1811

1912
<a name="how-to-get-the-qnamaker-service-hostname"></a>
2013

21-
## How to get the QnAMaker service endpoint
14+
<details>
15+
<summary><b>How to get the QnAMaker service endpoint</b></summary>
2216

17+
**Answer**:
2318
QnAMaker service endpoint is useful for debugging purposes when you contact QnAMaker Support or UserVoice. The endpoint is a URL in this form: https://your-resource-name.azurewebsites.net.
2419

2520
1. Go to your QnAMaker service (resource group) in the [Azure portal](https://portal.azure.com)
@@ -34,40 +29,72 @@ QnAMaker service endpoint is useful for debugging purposes when you contact QnAM
3429

3530
![QnAMaker endpoint](./media/qnamaker-how-to-troubleshoot/qnamaker-azure-gethostname.png)
3631

32+
</details>
33+
3734
## Manage the knowledge base
3835

39-
### I accidentally deleted a part of my QnA Maker, what should I do?
36+
<details>
37+
<summary><b>I accidentally deleted a part of my QnA Maker, what should I do?</b></summary>
4038

39+
**Answer**:
4140
Do not delete any of the Azure services created along with the QnA Maker resource such as Search or Web App. These are necessary for QnA Maker to work, if you delete one, QnA Maker will stop working correctly.
4241

4342
All deletes are permanent, including question and answer pairs, files, URLs, custom questions and answers, knowledge bases, or Azure resources. Make sure you export your knowledge base from the **Settings** page before deleting any part of your knowledge base.
4443

45-
### Why is my URL(s)/file(s) not extracting question-answer pairs?
44+
</details>
45+
46+
<details>
47+
<summary><b>Why is my URL(s)/file(s) not extracting question-answer pairs?</b></summary>
4648

49+
**Answer**:
4750
It's possible that QnA Maker can't auto-extract some question-and-answer (QnA) content from valid FAQ URLs. In such cases, you can paste the QnA content in a .txt file and see if the tool can ingest it. Alternately, you can editorially add content to your knowledge base through the [QnA Maker portal](https://qnamaker.ai).
4851

49-
### How large a knowledge base can I create?
52+
</details>
5053

54+
<details>
55+
<summary><b>How large a knowledge base can I create?</b></summary>
56+
57+
**Answer**:
5158
The size of the knowledge base depends on the SKU of Azure search you choose when creating the QnA Maker service. Read [here](./Tutorials/choosing-capacity-qnamaker-deployment.md) for more details.
5259

53-
### Why can't I see anything in the drop-down when I try to create a new knowledge base?
60+
</details>
61+
62+
<details>
63+
<summary><b>Why can't I see anything in the drop-down when I try to create a new knowledge base?</b></summary>
5464

65+
**Answer**:
5566
You haven't created any QnA Maker services in Azure yet. Read [here](./How-To/set-up-qnamaker-service-azure.md) to learn how to do that.
5667

57-
### How do I share a knowledge base with others?
68+
</details>
5869

70+
<details>
71+
<summary><b>How do I share a knowledge base with others?</b></summary>
72+
73+
**Answer**:
5974
Sharing works at the level of a QnA Maker service, that is, all knowledge bases in the service will be shared. Read [here](./How-To/collaborate-knowledge-base.md) how to collaborate on a knowledge base.
6075

61-
### Can you share a knowledge base with a contributor that is not in the same AAD tenant, to modify a knowledge base?
76+
</details>
77+
78+
<details>
79+
<summary><b>Can you share a knowledge base with a contributor that is not in the same AAD tenant, to modify a knowledge base?</b></summary>
6280

81+
**Answer**:
6382
Sharing is based on Azure role-based access control (RBAC). If you can share _any_ resource in Azure with another user, you can also share QnA Maker.
6483

65-
### If you have an App Service Plan with 5 QnAMaker knowledge bases. Can you assign read/write rights to 5 different users so each of them can access only 1 QnAMaker knowledge base?
84+
</details>
6685

86+
<details>
87+
<summary><b>If you have an App Service Plan with 5 QnAMaker knowledge bases. Can you assign read/write rights to 5 different users so each of them can access only 1 QnAMaker knowledge base?</b></summary>
88+
89+
**Answer**:
6790
You can share an entire QnAMaker service, not individual knowledge bases.
6891

69-
### How can I change the default message when no good match is found?
92+
</details>
93+
94+
<details>
95+
<summary><b>How can I change the default message when no good match is found?</b></summary>
7096

97+
**Answer**:
7198
The default message is part of the settings in your App service.
7299
- Go to your App service resource in the Azure portal
73100

@@ -80,15 +107,29 @@ The default message is part of the settings in your App service.
80107

81108
![qnamaker appservice restart](./media/qnamaker-faq/qnamaker-appservice-restart.png)
82109

83-
### Why is my SharePoint link not getting extracted?
84110

111+
</details>
112+
113+
<details>
114+
<summary><b>Why is my SharePoint link not getting extracted?</b></summary>
115+
116+
**Answer**:
85117
See [Data source locations](./Concepts/knowledge-base.md#data-source-locations) for more information.
86118

87-
### The updates that I made to my knowledge base are not reflected on publish. Why not?
119+
</details>
88120

121+
<details>
122+
<summary><b>The updates that I made to my knowledge base are not reflected on publish. Why not?</b></summary>
123+
124+
**Answer**:
89125
Every edit operation, whether in a table update, test, or setting, needs to be saved before it can be published. Be sure to click the **Save and train** button after every edit operation.
90126

91-
### Does the knowledge base support rich data or multimedia?
127+
</details>
128+
129+
<details>
130+
<summary><b>Does the knowledge base support rich data or multimedia?</b></summary>
131+
132+
**Answer**:
92133

93134
#### Multimedia auto-extraction for files and URLs
94135

@@ -98,40 +139,73 @@ Every edit operation, whether in a table update, test, or setting, needs to be s
98139
#### Answer text in markdown
99140
Once QnA sets are in the knowledge base, you can edit an answer's markdown text to include links to media available from public URLs.
100141

101-
### Does QnA Maker support non-English languages?
102142

143+
</details>
144+
145+
<details>
146+
<summary><b>Does QnA Maker support non-English languages?</b></summary>
147+
148+
**Answer**:
103149
See more details about [supported languages](./Overview/languages-supported.md).
104150

105151
If you have content from multiple languages, be sure to create a separate service for each language.
106152

153+
</details>
154+
107155
## Manage service
108156

109-
### When should I restart my app service?
157+
<details>
158+
<summary><b>When should I restart my app service?</b></summary>
110159

160+
**Answer**:
111161
Refresh your app service when the caution icon is next to the version value for the knowledge base in the **Endpoint keys** table on the **User Settings** [page](https://www.qnamaker.ai/UserSettings).
112162

113-
### I deleted my existing Search service. How can I fix this?
163+
</details>
164+
165+
<details>
166+
<summary><b>I deleted my existing Search service. How can I fix this?</b></summary>
114167

168+
**Answer**:
115169
If you delete an Azure Cognitive Search index, the operation is final and the index cannot be recovered.
116170

117-
### I deleted my `testkb` index in my Search service. How can I fix this?
171+
</details>
118172

173+
<details>
174+
<summary><b>I deleted my `testkb` index in my Search service. How can I fix this?</b></summary>
175+
176+
**Answer**:
119177
Your old data can't be recovered. Create a new QnA Maker resource and create your knowledge base again.
120178

121-
### When should I refresh my endpoint keys?
179+
</details>
180+
181+
<details>
182+
<summary><b>When should I refresh my endpoint keys?</b></summary>
122183

184+
**Answer**:
123185
Refresh your endpoint keys if you suspect that they have been compromised.
124186

125-
### Can I use the same Azure Cognitive Search resource for knowledge bases using multiple languages?
187+
</details>
126188

189+
<details>
190+
<summary><b>Can I use the same Azure Cognitive Search resource for knowledge bases using multiple languages?</b></summary>
191+
192+
**Answer**:
127193
To use multiple language and multiple knowledge bases, the user has to create an QnA Maker resource for each language. This will create a separate Azure search service per language. Mixing different language knowledge bases in a single Azure search service will result in degraded relevance of results.
128194

129-
### How can I change the name of the Azure Cognitive Search resource used by QnA Maker?
195+
</details>
196+
197+
<details>
198+
<summary><b>How can I change the name of the Azure Cognitive Search resource used by QnA Maker?</b></summary>
130199

200+
**Answer**:
131201
The name of the Azure Cognitive Search resource is the QnA Maker resource name with some random letters appended at the end. This makes it hard to distinguish between multiple Search resources for QnA Maker. Create a separate search service (naming it the way you would like to) and connect it to your QnA Service. The steps are similar to the steps you need to do to [upgrade an Azure search](How-To/set-up-qnamaker-service-azure.md#upgrade-the-azure-cognitive-search-service).
132202

133-
### When QnA Maker returns `Runtime core is not initialized,` how do I fix it?
203+
</details>
204+
205+
<details>
206+
<summary><b>When QnA Maker returns `Runtime core is not initialized,` how do I fix it?</b></summary>
134207

208+
**Answer**:
135209
The disk space for your app service might be full. Steps to fix your disk space:
136210

137211
1. In the [Azure portal](https://portal.azure.com), select your QnA Maker's App service, then stop the service.
@@ -149,19 +223,30 @@ The disk space for your app service might be full. Steps to fix your disk space:
149223
1. Start the App service.
150224
1. Access your knowledge base to verify it works now.
151225

226+
</details>
152227

153228
## Integrate with other services including Bots
154229

155-
### Do I need to use Bot Framework in order to use QnA Maker?
230+
<details>
231+
<summary><b>Do I need to use Bot Framework in order to use QnA Maker?</b></summary>
156232

233+
**Answer**:
157234
No, you do not need to use the [Bot Framework](https://github.com/Microsoft/botbuilder-dotnet) with QnA Maker. However, QnA Maker is offered as one of several templates in [Azure Bot Service](https://docs.microsoft.com/azure/bot-service/?view=azure-bot-service-4.0). Bot Service enables rapid intelligent bot development through Microsoft Bot Framework, and it runs in a server-less environment.
158235

159-
### How can I create a new bot with QnA Maker?
236+
</details>
160237

238+
<details>
239+
<summary><b>How can I create a new bot with QnA Maker?</b></summary>
240+
241+
**Answer**:
161242
Follow the instructions in [this](./Tutorials/create-qna-bot.md) documentation to create your Bot with Azure Bot Service.
162243

163-
### How do I use a different knowledge base with an existing Azure bot service?
244+
</details>
245+
246+
<details>
247+
<summary><b>How do I use a different knowledge base with an existing Azure bot service?</b></summary>
164248

249+
**Answer**:
165250
You need to have the following information about your knowledge base:
166251

167252
* Knowledge base ID.
@@ -172,19 +257,34 @@ With this information, go to your bot's app service in the Azure portal. Under *
172257

173258
The knowledge base's endpoint key is labeled `QnAAuthkey` in the ABS service.
174259

175-
### Can two or more client applications share a knowledge base?
260+
</details>
176261

262+
<details>
263+
<summary><b>Can two or more client applications share a knowledge base?</b></summary>
264+
265+
**Answer**:
177266
Yes, the knowledge base can be queried from any number of clients. If the response from the knowledge base appears to be slow or time out, consider upgrading the service tier for the app service associated with the knowledge base.
178267

179-
### How do I embed the QnA Maker service in my website?
268+
</details>
269+
270+
<details>
271+
<summary><b>How do I embed the QnA Maker service in my website?</b></summary>
180272

273+
**Answer**:
181274
Follow these steps to embed the QnA Maker service as a web-chat control in your website:
182275

183276
1. Create your FAQ bot by following the instructions [here](./Tutorials/create-qna-bot.md).
184277
2. Enable the web chat by following the steps [here](https://docs.microsoft.com/azure/bot-service/bot-service-channel-connect-webchat)
185278

279+
</details>
280+
186281
## Data storage
187282

188-
### What data is stored and where is it stored?
283+
<details>
284+
<summary><b>What data is stored and where is it stored?</b></summary>
285+
286+
**Answer**:
189287

190288
When you create your QnA Maker service, you selected an Azure region. Your knowledge bases and log files are stored in this region.
289+
290+
</details>

0 commit comments

Comments
 (0)