Skip to content

Commit 20ac72c

Browse files
authored
Merge pull request #214615 from aahill/hazem-oct-update
Hazem oct update
2 parents 205522e + fc7c830 commit 20ac72c

File tree

5 files changed

+178
-80
lines changed

5 files changed

+178
-80
lines changed

articles/cognitive-services/language-service/conversational-language-understanding/concepts/data-formats.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: language-service
1010
ms.topic: conceptual
11-
ms.date: 05/13/2022
11+
ms.date: 10/14/2022
1212
ms.author: aahi
1313
ms.custom: language-service-custom-clu
1414
---
@@ -24,14 +24,17 @@ If you're [importing a project](../how-to/create-project.md#import-project) into
2424

2525
```json
2626
{
27-
"projectFileVersion": "2022-05-01",
27+
"projectFileVersion": "2022-10-01-preview",
2828
"stringIndexType": "Utf16CodeUnit",
2929
"metadata": {
3030
"projectKind": "Conversation",
3131
"projectName": "{PROJECT-NAME}",
3232
"multilingual": true,
3333
"description": "DESCRIPTION",
34-
"language": "{LANGUAGE-CODE}"
34+
"language": "{LANGUAGE-CODE}",
35+
"settings": {
36+
"confidenceThreshold": 0
37+
}
3538
},
3639
"assets": {
3740
"projectKind": "Conversation",
@@ -43,7 +46,7 @@ If you're [importing a project](../how-to/create-project.md#import-project) into
4346
"entities": [
4447
{
4548
"category": "entity1",
46-
"compositionSetting": "requireExactOverlap",
49+
"compositionSetting": "{COMPOSITION-SETTING}",
4750
"list": {
4851
"sublists": [
4952
{
@@ -61,8 +64,20 @@ If you're [importing a project](../how-to/create-project.md#import-project) into
6164
},
6265
"prebuilts": [
6366
{
64-
"category": "PREBUILT1"
67+
"category": "{PREBUILT-COMPONENTS}"
6568
}
69+
],
70+
"regex": {
71+
"expressions": [
72+
{
73+
"regexKey": "regex1",
74+
"language": "{LANGUAGE-CODE}",
75+
"regexPattern": "{REGEX-PATTERN}"
76+
}
77+
]
78+
},
79+
"requiredComponents": [
80+
"{REQUIRED-COMPONENTS}"
6681
]
6782
}
6883
],
@@ -89,19 +104,28 @@ If you're [importing a project](../how-to/create-project.md#import-project) into
89104
|Key |Placeholder |Value | Example |
90105
|---------|---------|----------|--|
91106
| `api-version` | `{API-VERSION}` | The version of the API you're calling. The value referenced here is for the latest released [model version](../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data) released. | `2022-05-01` |
92-
|`confidenceThreshold`|`{CONFIDENCE-THRESHOLD}`|This is the threshold score below which the intent will be predicted as [none intent](none-intent.md)|`0.7`|
107+
|`confidenceThreshold`|`{CONFIDENCE-THRESHOLD}`|This is the threshold score below which the intent will be predicted as [none intent](none-intent.md). Values are from `0` to `1`|`0.7`|
93108
| `projectName` | `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `EmailApp` |
94-
| `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#multi-lingual-option) for more information about supported language codes. | `true`|
95-
|`sublists`|`[]`|Array containing a sublists|`[]`|
109+
| `multilingual` | `true`| A boolean value that enables you to have utterances 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#multi-lingual-option) for more information about supported language codes. | `true`|
110+
|`sublists`|`[]`|Array containing sublists. Each sublist is a key and its associated values.|`[]`|
111+
|`compositionSetting`|`{COMPOSITION-SETTING}`|Rule that defines how to manage multiple components in your entity. Options are `combineComponents` or `separateComponents`. |`combineComponents`|
96112
|`synonyms`|`[]`|Array containing all the synonyms|synonym|
97-
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the utterances used in your project. If your project is a multilingual project, choose the [language code](../language-support.md) of the majority of the utterances. |`en-us`|
98-
| `intents` | `[]` | Array containing all the intents you have in the project. These are the intent types that will be extracted from your utterances.| `[]` |
99-
| `entities` | `[]` | Array containing all the entities in your project. These are the entities that will be extracted from your utterances.| `[]` |
113+
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the utterances, synonyms, and regular expressions used in your project. If your project is a multilingual project, choose the [language code](../language-support.md) of the majority of the utterances. |`en-us`|
114+
| `intents` | `[]` | Array containing all the intents you have in the project. These are the intents that will be classified from your utterances.| `[]` |
115+
| `entities` | `[]` | Array containing all the entities in your project. These are the entities that will be extracted from your utterances. Every entity can have additional optional components defined with them: list, prebuilt, or regex. | `[]` |
100116
| `dataset` | `{DATASET}` | The test set to which this utterance 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`|
101117
| `category` | ` ` | The type of entity associated with the span of text specified. | `Entity1`|
102118
| `offset` | ` ` | The inclusive character position of the start of the entity. |`5`|
103119
| `length` | ` ` | The character length of the entity. |`5`|
104-
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the utterances used in your project. If your project is a multilingual project, choose the [language code](../language-support.md) of the majority of the utterances. |`en-us`|
120+
| `listKey`| ` ` | A normalized value for the list of synonyms to map back to in prediction. | `Microsoft` |
121+
| `values`| `{VALUES-FOR-LIST}` | A list of comma separated strings that will be matched exactly for extraction and map to the list key. | `"msft", "microsoft", "MS"` |
122+
| `regexKey`| `{REGEX-PATTERN}` | A regular expression. | `ProductPattern1` |
123+
| `regexPattern`| `{REGEX-PATTERN}` | A regular expression. | `^pre` |
124+
| `prebuilts`| `{PREBUILT-COMPONENTS}` | The prebuilt components that can extract common types. You can find the list of prebuilts you can add [here](../prebuilt-component-reference.md). | `Quantity.Number` |
125+
| `requiredComponents` | `{REQUIRED-COMPONENTS}` | A setting that specifies a requirement that a specific component be present to return the entity. You can learn more [here](./entity-components.md#required-components). The possible values are `learned`, `regex`, `list`, or `prebuilts` |`"learned", "prebuilt"`|
126+
127+
128+
105129

106130
## Utterance file format
107131

0 commit comments

Comments
 (0)