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/ai-services/language-service/question-answering/how-to/export-import-refresh.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ ms.topic: how-to
7
7
author: laujan
8
8
ms.author: lajanuar
9
9
recommendations: false
10
-
ms.date: 06/21/2025
10
+
ms.date: 08/07/2025
11
11
---
12
12
# Export-import-refresh in custom question answering
13
13
@@ -19,7 +19,7 @@ You might want to create a copy of your custom question answering project or rel
19
19
20
20
## Prerequisites
21
21
22
-
*If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/cognitive-services/) before you begin.
22
+
*An Azure subscription. You can [create one for free](https://azure.microsoft.com/free/cognitive-services/) before you begin.
23
23
* A [language resource](https://aka.ms/create-language-resource) with the custom question answering feature enabled. Remember your Microsoft Entra ID, Subscription, language resource name you selected when you created the resource.
24
24
25
25
## Export a project
@@ -28,9 +28,9 @@ You might want to create a copy of your custom question answering project or rel
28
28
29
29
2. Scroll down to the **Answer questions** section and select **Open custom question answering**.
30
30
31
-
3. Select the project you wish to export > Select **Export** > You’ll have the option to export as an **Excel** or **TSV** file.
31
+
3. Select the project you wish to export > Select **Export** > You can export the project as an **Excel** or **TSV** file.
32
32
33
-
4. You’ll be prompted to save your exported file locally as a zip file.
33
+
4. You're prompted to save your exported file locally as a zip file.
34
34
35
35
### Export a project programmatically
36
36
@@ -46,9 +46,9 @@ To automate the export process, use the [export functionality of the authoring A
46
46
47
47
4. Select Choose File and browse to the local zipped copy of your project that you exported previously.
48
48
49
-
5. Provide a unique name for the project you’re importing.
49
+
5. Provide a unique name for the project you're importing.
50
50
51
-
6. Remember that a project that has only been imported still needs to be deployed/published if you want it to be live.
51
+
6. Remember that a project that is only imported still needs to be deployed/published if you want it to be live.
52
52
53
53
### Import a project programmatically
54
54
@@ -62,7 +62,7 @@ To automate the import process, use the [import functionality of the authoring A
62
62
63
63
3. Select the project that contains the source you want to refresh > select manage sources.
64
64
65
-
4. We recommend having a backup of your project/question answer pairs prior to running each refresh so that you can always roll-back if needed.
65
+
4. We recommend having a backup of your project/question answer pairs before running each refresh so that you can always rollback if needed.
66
66
67
67
5. Select a URL-based source to refresh > Select **Refresh URL**.
68
68
6. Only one URL can be refreshed at a time.
@@ -75,7 +75,7 @@ The update sources example in the [Authoring API docs](./authoring.md#update-sou
75
75
76
76
|Variable name | Value |
77
77
|--------------------------|-------------|
78
-
|`ENDPOINT`| This value can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. Alternatively you can find the value in **Language Studio** > **question answering** > **Deploy project** > **Get prediction URL**. An example endpoint is: `https://southcentralus.api.cognitive.microsoft.com/`. If this was your endpoint in the following code sample, you would only need to add the region-specific portion of `southcentral` as the rest of the endpoint path is already present.|
78
+
|`ENDPOINT`| This value can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. Alternatively you can find the value in **Language Studio** > **question answering** > **Deploy project** > **Get prediction URL**. An example endpoint is: `https://southcentralus.cognitiveservices.azure.com/` and you only need to add the region-specific portion of `southcentral`. The endpoint path is already present.|
79
79
|`API-KEY`| This value can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. You can use either Key1 or Key2. Always having two valid keys allows for secure key rotation with zero downtime. Alternatively you can find the value in **Language Studio** > **question answering** > **Deploy project** > **Get prediction URL**. The key value is part of the sample request.|
80
80
|`PROJECT-NAME`| The name of project where you would like to update sources.|
It’s also possible to export/import a specific project of question and answers rather than the entire custom question answering project.
98
+
It's also possible to export/import a specific project of question and answers rather than the entire custom question answering project.
99
99
100
100
1. Sign in to the [Language Studio](https://language.azure.com/) with your Azure credentials.
101
101
@@ -105,16 +105,16 @@ It’s also possible to export/import a specific project of question and answers
105
105
106
106
4. Select **Edit project**.
107
107
108
-
5. To the right of show columns are `...` an ellipsis button. > Select the `...` > a dropdown will reveal the option to export/import questions and answers.
108
+
5. To the right of show columns are `...` an ellipsis button. > Select the `...` > a dropdown reveals the option to export/import questions and answers.
109
109
110
-
Depending on the size of your web browser, you may experience the UI differently. Smaller browsers will see two separate ellipsis buttons.
110
+
Depending on the size of your web browser, you may experience the UI differently. Smaller browsers see two separate ellipsis buttons.
111
111
112
112
> [!div class="mx-imgBorder"]
113
113
> 
114
114
115
115
## Import questions and answers
116
116
117
-
It’s also possible to export/import a specific project of question and answers rather than the entire custom question answering project.
117
+
It's also possible to export/import a specific project of question and answers rather than the entire custom question answering project.
118
118
119
119
1. Sign in to the [Language Studio](https://language.azure.com/) with your Azure credentials.
120
120
@@ -124,9 +124,9 @@ It’s also possible to export/import a specific project of question and answers
124
124
125
125
4. Select **Edit project**.
126
126
127
-
5. To the right of show columns are `...` an ellipsis button. > Select the `...` > a dropdown will reveal the option to export/import questions and answers.
127
+
5. To the right of show columns are `...` an ellipsis button. > Select the `...` > a dropdown reveals the option to export/import questions and answers.
128
128
129
-
Depending on the size of your web browser, you may experience the UI differently. Smaller browsers will see two separate ellipsis buttons.
129
+
Depending on the size of your web browser, you may experience the UI differently. Smaller browsers see two separate ellipsis buttons.
130
130
131
131
> [!div class="mx-imgBorder"]
132
132
> 
The custom question answering **prebuilt API** provides you the capability to answer questions based on a passage of text without having to create projects, maintain question and answer pairs, or incurring costs for underutilized infrastructure. This functionality is provided as an API and can be used to meet question and answering needs without having to learn the details about custom question answering.
14
+
The custom question answering **prebuilt API** provides you with the capability to answer questions based on a passage of text without having to create projects, maintain question and answer pairs, or incurring costs for underutilized infrastructure. This functionality is provided as an API and can be used to meet question and answering needs without having to learn the details about custom question answering.
15
15
16
-
Given a user query and a block of text/passage the API will return an answer and precise answer (if available).
16
+
Given a user query and a block of text/passage the API returns an answer and precise answer (if available).
17
17
18
18
## Example API usage
19
19
20
-
Imagine that you have one or more blocks of text from which you would like to get answers for a given question. Normally you would have had to create as many sources as the number of blocks of text. However, now with the prebuilt API you can query the blocks of text without having to define content sources in a project.
20
+
Imagine that you have one or more blocks of text from which you would like to get answers for a given question. Normally you have to create as many sources as the number of blocks of text. However, now with the prebuilt API you can query the blocks of text without having to define content sources in a project.
21
21
22
22
Some other scenarios where this API can be used are:
23
23
24
-
* You are developing an ebook reader app for end users, which allows them to highlight text, enter a question and find answers over a highlighted passage of text.
24
+
* You're developing an ebook reader app for end users, which allows them to highlight text, enter a question and find answers over a highlighted passage of text.
25
25
* A browser extension that allows users to ask a question over the content being currently displayed on the browser page.
26
26
* A health bot that takes queries from users and provides answers based on the medical content that the bot identifies as most relevant to the user query.
27
27
28
-
Below is an example of a sample request:
28
+
Here's an example of a sample request:
29
29
30
30
## Sample request
31
31
32
32
```
33
-
POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/language/:query-text
33
+
POST https://{Unique-to-your-endpoint}.cognitiveservices.azure.com/language/:query-text
34
34
```
35
35
36
36
### Sample query over a single block of text
@@ -50,7 +50,7 @@ Request Body
50
50
"records": [
51
51
{
52
52
"id": "1",
53
-
"text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it."
53
+
"text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you're using your Surface for power-intensive activities like gaming or video streaming while you're charging it."
54
54
},
55
55
{
56
56
"id": "2",
@@ -65,7 +65,7 @@ Request Body
65
65
66
66
## Sample response
67
67
68
-
In the above request body, we query over a single block of text. A sample response received for the above query is shown below,
68
+
In the request body, we query over a single block of text. Here's a sample response received for the query:
69
69
70
70
```json
71
71
{
@@ -75,7 +75,7 @@ In the above request body, we query over a single block of text. A sample respon
75
75
"body": {
76
76
"answers": [
77
77
{
78
-
"answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
78
+
"answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you're using your Surface for power-intensive activities like gaming or video streaming while you're charging it.",
79
79
"confidenceScore": 0.93,
80
80
"id": "1",
81
81
"answerSpan": {
@@ -88,7 +88,7 @@ In the above request body, we query over a single block of text. A sample respon
88
88
"length": 224
89
89
},
90
90
{
91
-
"answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
91
+
"answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you're using your Surface for power-intensive activities like gaming or video streaming while you're charging it.",
92
92
"confidenceScore": 0.92,
93
93
"id": "1",
94
94
"answerSpan": {
@@ -101,7 +101,7 @@ In the above request body, we query over a single block of text. A sample respon
101
101
"length": 224
102
102
},
103
103
{
104
-
"answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
104
+
"answer": "It can take longer if you're using your Surface for power-intensive activities like gaming or video streaming while you're charging it.",
105
105
"confidenceScore": 0.05,
106
106
"id": "1",
107
107
"answerSpan": null,
@@ -128,97 +128,97 @@ These numbers represent the **per individual API call limits**:
128
128
* Maximum three responses per document.
129
129
130
130
### Language codes supported
131
-
The following language codes are supported by Prebuilt API. These language codes are in accordance to the [ISO 639-1 codes standard](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
131
+
The following language codes support the Prebuilt API. These language codes are in accordance to the [ISO 639-1 codes standard](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
0 commit comments