Skip to content

Commit 45ffdd4

Browse files
authored
Merge pull request #178332 from mrbullwinkle/mrb_11_2_2021_updates_003
[Cognitive Services] Q&A troubleshooting
2 parents 00bb4a6 + f0528bc commit 45ffdd4

File tree

2 files changed

+190
-0
lines changed

2 files changed

+190
-0
lines changed
Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
---
2+
title: Troubleshooting - question answering
3+
description: The curated list of the most frequently asked questions regarding question answering will help you adopt the feature faster and with better results.
4+
ms.service: cognitive-services
5+
ms.subservice: language-service
6+
author: mrbullwinkle
7+
ms.author: mbullwin
8+
ms.topic: troubleshooting
9+
ms.date: 11/02/2021
10+
---
11+
12+
# Troubleshooting for question answering
13+
14+
The curated list of the most frequently asked questions regarding question answering will help you adopt the feature faster and with better results.
15+
16+
## Manage predictions
17+
18+
<details>
19+
<summary><b>How can I improve the throughput performance for query predictions?</b></summary>
20+
21+
**Answer**:
22+
Throughput performance issues indicate you need to scale up your Cognitive Search. Consider adding a replica to your Cognitive Search to improve performance.
23+
24+
Learn more about [pricing tiers](../Concepts/azure-resources.md).
25+
</details>
26+
27+
## Manage your project
28+
29+
<details>
30+
<summary><b>Why is my URL(s)/file(s) not extracting question-answer pairs?</b></summary>
31+
32+
**Answer**:
33+
It's possible that question answering 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 project/knowledge base through the [Language Studio portal](https://language.azure.com).
34+
35+
</details>
36+
37+
<details>
38+
<summary><b>How large a knowledge base can I create?</b></summary>
39+
40+
**Answer**:
41+
The size of the knowledge base depends on the SKU of Azure search you choose when creating the QnA Maker service. Read [here](../concepts/azure-resources.md) for more details.
42+
43+
</details>
44+
45+
<details>
46+
<summary><b>How do I share a knowledge base with others?</b></summary>
47+
48+
**Answer**:
49+
Sharing works at the level of the language resource, that is, all knowledge bases associated a language resource can be shared.
50+
</details>
51+
52+
<details>
53+
<summary><b>Can you share a knowledge base with a contributor that is not in the same Azure Active Directory tenant, to modify a knowledge base?</b></summary>
54+
55+
**Answer**:
56+
Sharing is based on Azure role-based access control (Azure Role-base access control). If you can share _any_ resource in Azure with another user, you can also share question answering.
57+
58+
</details>
59+
60+
<details>
61+
<summary><b>Can you assign read/write rights to 5 different users so each of them can access only 1 question answering knowledge base?</b></summary>
62+
63+
**Answer**:
64+
You can share an entire language resource, not individual knowledge bases.
65+
66+
</details>
67+
68+
<details>
69+
<summary><b>The updates that I made to my knowledge base are not reflected in production. Why not?</b></summary>
70+
71+
**Answer**:
72+
Every edit operation, whether in a table update, test, or setting, needs to be saved before it can be deployed. Be sure to select **Save** after making changes and then re-deploy your project for those changes to be reflected in production.
73+
74+
</details>
75+
76+
<details>
77+
<summary><b>Does the knowledge base support rich data or multimedia?</b></summary>
78+
79+
**Answer**:
80+
81+
#### Multimedia auto-extraction for files and URLs
82+
83+
* URLS - limited HTML-to-Markdown conversion capability.
84+
* Files - not supported
85+
86+
#### Answer text in markdown
87+
88+
Once QnA pairs are in the knowledge base, you can edit an answer's markdown text to include links to media available from public URLs.
89+
90+
</details>
91+
92+
<details>
93+
<summary><b>Does question answering support non-English languages?</b></summary>
94+
95+
**Answer**:
96+
See more details about [supported languages](../language-support.md).
97+
98+
If you have content from multiple languages, be sure to create a separate project for each language.
99+
100+
</details>
101+
102+
## Manage service
103+
104+
<details>
105+
<summary><b>I deleted my existing Search service. How can I fix this?</b></summary>
106+
107+
**Answer**:
108+
If you delete an Azure Cognitive Search index, the operation is final and the index cannot be recovered.
109+
110+
</details>
111+
112+
<details>
113+
<summary><b>I deleted my `testkbv2` index in my Search service. How can I fix this?</b></summary>
114+
115+
**Answer**:
116+
In case you deleted the `testkbv2` index in your Search service, you can restore the data from the last published KB. Use the recovery tool [RestoreTestKBIndex](https://github.com/pchoudhari/QnAMakerBackupRestore/tree/master/RestoreTestKBFromProd) available on GitHub.
117+
118+
</details>
119+
120+
<details>
121+
<summary><b>Can I use the same Azure Cognitive Search resource for knowledge bases using multiple languages?</b></summary>
122+
123+
**Answer**:
124+
To use multiple language and multiple knowledge bases, the user has to create a project for each language and the first project created for the language resource has to select the option **I want to select the language when I create a project in this resource**. This will create a separate Azure search service per language.
125+
126+
</details>
127+
128+
## Integrate with other services including Bots
129+
130+
<details>
131+
<summary><b>Do I need to use Bot Framework in order to use question answering?</b></summary>
132+
133+
**Answer**:
134+
No, you do not need to use the [Bot Framework](https://github.com/Microsoft/botbuilder-dotnet) with question answering. However, Question answering is offered as one of several templates in [Azure Bot Service](/azure/bot-service/). Bot Service enables rapid intelligent bot development through Microsoft Bot Framework, and it runs in a server-less environment.
135+
136+
</details>
137+
138+
<details>
139+
<summary><b>How can I create a new bot with question answering?</b></summary>
140+
141+
**Answer**:
142+
Follow the instructions in [this](../tutorials/bot-service.md) documentation to create your Bot with Azure Bot Service.
143+
144+
</details>
145+
146+
<details>
147+
<summary><b>How do I use a different knowledge base with an existing Azure bot service?</b></summary>
148+
149+
**Answer**:
150+
You need to have the following information about your knowledge base:
151+
152+
* Knowledge base ID.
153+
* Knowledge base's published endpoint custom subdomain name, known as `host`, found on **Settings** page after you publish.
154+
* Knowledge base's published endpoint key - found on **Settings** page after you publish.
155+
156+
With this information, go to your bot's app service in the Azure portal. Under **Settings -> Configuration -> Application settings**, change those values.
157+
158+
The knowledge base's endpoint key is labeled `QnAAuthkey` in the ABS service.
159+
160+
</details>
161+
162+
<details>
163+
<summary><b>Can two or more client applications share a knowledge base?</b></summary>
164+
165+
**Answer**:
166+
Yes, the knowledge base can be queried from any number of clients.
167+
168+
</details>
169+
170+
<details>
171+
<summary><b>How do I embed question answering in my website?</b></summary>
172+
173+
**Answer**:
174+
Follow these steps to embed the question answering service as a web-chat control in your website:
175+
176+
1. Create your FAQ bot by following the instructions [here](../tutorials/bot-service.md).
177+
2. Enable the web chat by following the steps [here](../tutorials/bot-service.md#integrate-the-bot-with-channels)
178+
179+
## Data storage
180+
181+
<details>
182+
<summary><b>What data is stored and where is it stored?</b></summary>
183+
184+
**Answer**:
185+
186+
When you create your language resource for question answering, you selected an Azure region. Your knowledge bases and log files are stored in this region.
187+
188+
</details>

articles/cognitive-services/language-service/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,8 @@ items:
509509
href: ../qnamaker/how-to/query-knowledge-base-with-metadata.md?context=/azure/cognitive-services/language-service/context/context
510510
- name: Network isolation and private endpoints
511511
href: question-answering/how-to/network-isolation.md
512+
- name: Troubleshooting
513+
href: question-answering/how-to/troubleshooting.md
512514
- name: Concepts
513515
items:
514516
- name: Resource planning

0 commit comments

Comments
 (0)