Skip to content

Commit 8ccbd2b

Browse files
committed
fixes
1 parent 6797928 commit 8ccbd2b

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/language-studio/test-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To test your deployed models from within the [Language Studio](https://aka.ms/La
2121

2222
5. Click on **Run the test** from the top menu.
2323

24-
6. In the **Result** tab, you can see the extracted entities from your text and their types. You can also view the [JSON response](../rest-api/get-results.md#response-body) under the **JSON** tab.
24+
6. In the **Result** tab, you can see the extracted entities from your text and their types. You can also view the [JSON response](../../how-to/call-api.md#get-task-results) under the **JSON** tab.
2525

2626
:::image type="content" source="../../media/test-model-results.png" alt-text="A screenshot showing the deployment testing screen in Language Studio." lightbox="../../media/test-model-results.png":::
2727

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/quickstarts/language-studio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ ms.author: aahi
1919
2020
## Create a new Azure Language resource and Azure storage account
2121

22-
Before you can use custom Text Analytics for health, you'll need to create an Azure Language resource, which will give you the credentials that you need to create a project and start training a model. You'll also need an Azure storage account, where you can upload your dataset that will be used to build your model.
22+
Before you can use custom Text Analytics for health, you need to create an Azure Language resource, which will give you the credentials that you need to create a project and start training a model. You'll also need an Azure storage account, where you can upload your dataset that is used to build your model.
2323

2424
> [!IMPORTANT]
2525
> To quickly get started, we recommend creating a new Azure Language resource using the steps provided in this article. Using the steps in this article will let you create the Language resource and storage account at the same time, which is easier than doing it later.
2626
>
27-
> If you have a pre-existing resource that you'd like to use, you will need to connect it to storage account. See [guidance to using a pre-existing resource](../../how-to/create-project.md#using-a-pre-existing-language-resource) for more information.
27+
> If you have a pre-existing resource that you'd like to use, you will need to connect it to storage account. For more information, see [guidance to using a pre-existing resource](../../how-to/create-project.md#using-a-pre-existing-language-resource).
2828
2929
[!INCLUDE [create a new resource from the Azure portal](../resource-creation-azure-portal.md)]
3030

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/rest-api/get-results.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -280,11 +280,11 @@ The response is a JSON document with the following parameters
280280
|text|`first entity`| The text that was extracted for a specific entity.|
281281
|category|`MedicationName`| The name of the entity type or category corresponding to the extracted text.|
282282
|confidenceScore|`0.9`| A number denoting the model's certainty level of the extracted entity ranging from 0 to 1 with higher number denoting higher certainty.|
283-
|assertion|`certainty`| [Assertions](../../../text-analytics-for-health/concepts/assertion-detection.md) associated with the extracted entity. Assertions are only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
284-
|name|`Ibuprofen`| The normalized name for the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
285-
|links| [] | An array containing all the results from the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
286-
|dataSource| `UMLS` | The reference standard resulting from the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
287-
|id| `C0020740` | The reference code resulting from the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity belonging to the extracted data source. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
283+
|assertion|`certainty`| [Assertions](../../../text-analytics-for-health/concepts/assertion-detection.md) associated with the extracted entity. Assertions are only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features).|
284+
|name|`Ibuprofen`| The normalized name for the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
285+
|links| [] | An array containing all the results from the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
286+
|dataSource| `UMLS` | The reference standard resulting from the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
287+
|id| `C0020740` | The reference code resulting from the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity belonging to the extracted data source. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
288288
|relations| [] | Array containing all the extracted relationships. [Relationship extraction](../../../text-analytics-for-health/concepts/relation-extraction.md) is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
289289
|relationType| `DosageOfMedication` | The category of the extracted [relationship](../../../text-analytics-for-health/concepts/relation-extraction.md). Relationship extraction is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
290290
|entities| `"Dosage", "Medication"` | The entities associated with the extracted relationship. Relationship extraction is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/rest-api/import-project.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -148,28 +148,28 @@ Use the following JSON in your request. Replace the placeholder values below wit
148148

149149
|Key |Placeholder |Value | Example |
150150
|---------|---------|----------|--|
151-
| `multilingual` | `true`| A boolean value that enables you to have documents in multiple languages in your dataset and when your model is deployed you can query the model in any supported language (not necessarily included in your training documents). See [language support](../language-support.md#) to learn more about multilingual support. | `true`|
151+
| `multilingual` | `true`| A boolean value that enables you to have documents in multiple languages in your dataset and when your model is deployed you can query the model in any supported language (not necessarily included in your training documents). See [language support](../../language-support.md) to learn more about multilingual support. | `true`|
152152
|`projectName`|`{PROJECT-NAME}`|Project name|`myproject`|
153153
| `storageInputContainerName` |`{CONTAINER-NAME}`|Container name|`mycontainer`|
154154
| `entities` | | Array containing all the entity types you have in the project. These are the entity types that will be extracted from your documents into.| |
155-
| `category` | | The name of the entity type which can be user defined in the case of a new entity definition or predefined in the case of prebuilt entities. For more information, see the entity naming rules below.| |
155+
| `category` | | The name of the entity type, which can be user defined for new entity definitions, or predefined for prebuilt entities. | |
156156
|`compositionSetting`|`{COMPOSITION-SETTING}`|Rule that defines how to manage multiple components in your entity. Options are `combineComponents` or `separateComponents`. |`combineComponents`|
157157
| `list` | | Array containing all the sublists you have in the project for a specific entity. Lists can be added to prebuilt entities or new entities with learned components.| |
158158
|`sublists`|`[]`|Array containing sublists. Each sublist is a key and its associated values.|`[]`|
159159
| `listKey`| `One` | A normalized value for the list of synonyms to map back to in prediction. | `One` |
160160
|`synonyms`|`[]`|Array containing all the synonyms|synonym|
161-
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the synonym in your sublist. If your project is a multilingual project and you want to support your list of synonyms for all the languages in your project, you have to explicitly add your synonyms to each language. See [Language support](../language-support.md) for more information about supported language codes. |`en`|
161+
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the synonym in your sublist. If your project is a multilingual project and you want to support your list of synonyms for all the languages in your project, you have to explicitly add your synonyms to each language. See [Language support](../../language-support.md) for more information about supported language codes. |`en`|
162162
| `values`| `"EntityNumberone"`, `"FirstEntity"` | A list of comma separated strings that will be matched exactly for extraction and map to the list key. | `"EntityNumberone"`, `"FirstEntity"` |
163-
| `prebuilts` | `MedicationName` | The name of the prebuilt component populating the prebuilt entity. [Prebuilt entities](../../text-analytics-for-health/concepts/health-entity-categories.md) are automatically loaded into your project by default but you can extend them with list components in your labels file. | `MedicationName` |
163+
| `prebuilts` | `MedicationName` | The name of the prebuilt component populating the prebuilt entity. [Prebuilt entities](../../../text-analytics-for-health/concepts/health-entity-categories.md) are automatically loaded into your project by default but you can extend them with list components in your labels file. | `MedicationName` |
164164
| `documents` | | Array containing all the documents in your project and list of the entities labeled within each document. | [] |
165165
| `location` | `{DOCUMENT-NAME}` | The location of the documents in the storage container. Since all the documents are in the root of the container this should be the document name.|`doc1.txt`|
166-
| `dataset` | `{DATASET}` | The [test set](../how-to/train-model.md#data-splitting) to which this file will go to when split before training. Learn more about data splitting [here](../how-to/train-model.md#data-splitting). Possible values for this field are `Train` and `Test`. |`Train`|
166+
| `dataset` | `{DATASET}` | The [test set](../../how-to/train-model.md#data-splitting) to which this file will go to when split before training. Possible values for this field are `Train` and `Test`. |`Train`|
167167
| `regionOffset` | | The inclusive character position of the start of the text. |`0`|
168168
| `regionLength` | | The length of the bounding box in terms of UTF16 characters. Training only considers the data in this region. |`500`|
169169
| `category` | | The type of entity associated with the span of text specified. | `Entity1`|
170170
| `offset` | | The start position for the entity text. | `25`|
171171
| `length` | | The length of the entity in terms of UTF16 characters. | `20`|
172-
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the document used in your project. If your project is a multilingual project, choose the language code of the majority of the documents. See [Language support](../language-support.md) for more information about supported language codes. |`en`|
172+
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the document used in your project. If your project is a multilingual project, choose the language code of the majority of the documents. See [Language support](../../language-support.md) for more information about supported language codes. |`en`|
173173

174174
Once you send your API request, you’ll receive a `202` response indicating that the job was submitted correctly. In the response headers, extract the `operation-location` value. It will be formatted like this:
175175

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/rest-api/train-model.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Submit a **POST** request using the following URL, headers, and JSON body to sub
2020
|---------|---------|---------|
2121
| `{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2222
| `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `myProject` |
23-
|`{API-VERSION}` | The version of the API you are calling. The value referenced here is for the latest version released. See [Model lifecycle](../../../concepts/model-lifecycle.md) to learn more about other available API versions. | `2022-05-01` |
23+
|`{API-VERSION}` | The version of the API you're calling. The value referenced here is for the latest version released. See [Model lifecycle](../../../concepts/model-lifecycle.md) to learn more about other available API versions. | `2022-05-01` |
2424

2525
#### Headers
2626

@@ -49,8 +49,8 @@ Use the following JSON in your request body. The model is given the `{MODEL-NAME
4949

5050
|Key |Placeholder |Value | Example |
5151
|---------|---------|-----|----|
52-
| modelLabel | `{MODEL-NAME}` | The model name that will be assigned to your model once trained successfully. | `myModel` |
53-
| trainingConfigVersion | `{CONFIG-VERSION}` | This is the [model version](../../../concepts/model-lifecycle.md) that will be used to train the model. | `2022-05-01`|
52+
| modelLabel | `{MODEL-NAME}` | The model name that is assigned to your model once trained successfully. | `myModel` |
53+
| trainingConfigVersion | `{CONFIG-VERSION}` | This is the [model version](../../../concepts/model-lifecycle.md) that is used to train the model. | `2022-05-01`|
5454
| evaluationOptions | | Option to split your data across training and testing sets. | `{}` |
5555
| kind | `percentage` | Split methods. Possible values are `percentage` or `manual`. See [How to train a model](../../how-to/train-model.md#data-splitting) for more information. |`percentage`|
5656
| trainingSplitPercentage | `80`| Percentage of your tagged data to be included in the training set. Recommended value is `80`. | `80`|
@@ -59,7 +59,7 @@ Use the following JSON in your request body. The model is given the `{MODEL-NAME
5959
> [!NOTE]
6060
> The `trainingSplitPercentage` and `testingSplitPercentage` are only required if `Kind` is set to `percentage` and the sum of both percentages should be equal to 100.
6161
62-
Once you send your API request, you’ll receive a `202` response indicating that the job was submitted correctly. In the response headers, extract the `location` value. It will be formatted like this:
62+
Once you send your API request, you’ll receive a `202` response indicating that the job was submitted correctly. In the response headers, extract the `location` value. It is formatted like this:
6363

6464
```rest
6565
{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}

0 commit comments

Comments
 (0)