Skip to content

Commit 276d197

Browse files
aurghobAurgho Bhattacharjee
authored and
kayousef
committed
Correct EntityLinking, PII, Conv PII, Healthcare Result API reference Documentation and fix healthcare auto language detection for october (Azure#21434)
* Correct EntityLinking Result Reference * prettier correction * temporarily excluding changes in dev * Correct PIIResult to have Detected Language * Correct documentation for EntitiesResult * Correct typo for EntitiesResultWithDetectedLanguage * Correct documentation for Conv PII result and Healthcare result objects * Add back changes to dev Co-authored-by: Aurgho Bhattacharjee <[email protected]>
1 parent a05bf6e commit 276d197

File tree

4 files changed

+138
-80
lines changed

4 files changed

+138
-80
lines changed

‎dev/cognitiveservices/data-plane/Language/analyzeconversations.json

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1330,14 +1330,7 @@
13301330
"conversations": {
13311331
"type": "array",
13321332
"items": {
1333-
"allOf": [
1334-
{
1335-
"$ref": "#/definitions/ConversationPIIResult"
1336-
},
1337-
{
1338-
"$ref": "#/definitions/ConversationResultBase"
1339-
}
1340-
]
1333+
"$ref": "#/definitions/ConversationalPIIResultWithResultBase"
13411334
}
13421335
}
13431336
},
@@ -1347,6 +1340,17 @@
13471340
}
13481341
]
13491342
},
1343+
"ConversationalPIIResultWithResultBase": {
1344+
"type": "object",
1345+
"allOf": [
1346+
{
1347+
"$ref": "#/definitions/ConversationPIIResult"
1348+
},
1349+
{
1350+
"$ref": "#/definitions/ConversationResultBase"
1351+
}
1352+
]
1353+
},
13501354
"ConversationPIIResult": {
13511355
"type": "object",
13521356
"description": "The result from PII detection and redaction operation for each conversation.",

‎dev/cognitiveservices/data-plane/Language/analyzetext.json

Lines changed: 57 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -832,14 +832,7 @@
832832
"documents": {
833833
"type": "array",
834834
"items": {
835-
"allOf": [
836-
{
837-
"$ref": "#/definitions/HealthcareEntitiesDocumentResult"
838-
},
839-
{
840-
"$ref": "#/definitions/DocumentDetectedLanguage"
841-
}
842-
]
835+
"$ref": "#/definitions/HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage"
843836
}
844837
}
845838
},
@@ -852,6 +845,17 @@
852845
"documents"
853846
]
854847
},
848+
"HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": {
849+
"type": "object",
850+
"allOf": [
851+
{
852+
"$ref": "#/definitions/HealthcareEntitiesDocumentResult"
853+
},
854+
{
855+
"$ref": "#/definitions/DocumentDetectedLanguageString"
856+
}
857+
]
858+
},
855859
"HealthcareEntitiesDocumentResult": {
856860
"type": "object",
857861
"properties": {
@@ -1499,14 +1503,7 @@
14991503
"type": "array",
15001504
"description": "Response by document",
15011505
"items": {
1502-
"allOf": [
1503-
{
1504-
"$ref": "#/definitions/EntitiesDocumentResult"
1505-
},
1506-
{
1507-
"$ref": "#/definitions/DocumentDetectedLanguage"
1508-
}
1509-
]
1506+
"$ref": "#/definitions/EntitiesResultWithDetectedLanguage"
15101507
}
15111508
}
15121509
},
@@ -1519,6 +1516,17 @@
15191516
"documents"
15201517
]
15211518
},
1519+
"EntitiesResultWithDetectedLanguage": {
1520+
"type": "object",
1521+
"allOf": [
1522+
{
1523+
"$ref": "#/definitions/EntitiesDocumentResult"
1524+
},
1525+
{
1526+
"$ref": "#/definitions/DocumentDetectedLanguage"
1527+
}
1528+
]
1529+
},
15221530
"EntitiesDocumentResult": {
15231531
"type": "object",
15241532
"properties": {
@@ -1648,14 +1656,7 @@
16481656
"type": "array",
16491657
"description": "Response by document",
16501658
"items": {
1651-
"allOf": [
1652-
{
1653-
"$ref": "#/definitions/LinkedEntitiesDocumentResult"
1654-
},
1655-
{
1656-
"$ref": "#/definitions/DocumentDetectedLanguage"
1657-
}
1658-
]
1659+
"$ref": "#/definitions/EntityLinkingResultWithDetectedLanguage"
16591660
}
16601661
}
16611662
},
@@ -1668,6 +1669,17 @@
16681669
"documents"
16691670
]
16701671
},
1672+
"EntityLinkingResultWithDetectedLanguage": {
1673+
"type": "object",
1674+
"allOf": [
1675+
{
1676+
"$ref": "#/definitions/LinkedEntitiesDocumentResult"
1677+
},
1678+
{
1679+
"$ref": "#/definitions/DocumentDetectedLanguage"
1680+
}
1681+
]
1682+
},
16711683
"LinkedEntitiesDocumentResult": {
16721684
"type": "object",
16731685
"required": [
@@ -1820,14 +1832,7 @@
18201832
"type": "array",
18211833
"description": "Response by document",
18221834
"items": {
1823-
"allOf": [
1824-
{
1825-
"$ref": "#/definitions/PiiEntitiesDocumentResult"
1826-
},
1827-
{
1828-
"$ref": "#/definitions/DocumentDetectedLanguage"
1829-
}
1830-
]
1835+
"$ref": "#/definitions/PIIResultWithDetectedLanguage"
18311836
}
18321837
}
18331838
},
@@ -1840,6 +1845,17 @@
18401845
"documents"
18411846
]
18421847
},
1848+
"PIIResultWithDetectedLanguage": {
1849+
"type": "object",
1850+
"allOf": [
1851+
{
1852+
"$ref": "#/definitions/PiiEntitiesDocumentResult"
1853+
},
1854+
{
1855+
"$ref": "#/definitions/DocumentDetectedLanguage"
1856+
}
1857+
]
1858+
},
18431859
"PiiDomain": {
18441860
"type": "string",
18451861
"description": "The PII domain used for PII Entity Recognition.",
@@ -2772,6 +2788,15 @@
27722788
}
27732789
}
27742790
},
2791+
"DocumentDetectedLanguageString": {
2792+
"type": "object",
2793+
"properties": {
2794+
"detectedLanguage": {
2795+
"type": "string",
2796+
"description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document."
2797+
}
2798+
}
2799+
},
27752800
"DocumentError": {
27762801
"type": "object",
27772802
"required": [

‎specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzeconversations.json

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1330,14 +1330,7 @@
13301330
"conversations": {
13311331
"type": "array",
13321332
"items": {
1333-
"allOf": [
1334-
{
1335-
"$ref": "#/definitions/ConversationPIIResult"
1336-
},
1337-
{
1338-
"$ref": "#/definitions/ConversationResultBase"
1339-
}
1340-
]
1333+
"$ref": "#/definitions/ConversationalPIIResultWithResultBase"
13411334
}
13421335
}
13431336
},
@@ -1347,6 +1340,17 @@
13471340
}
13481341
]
13491342
},
1343+
"ConversationalPIIResultWithResultBase": {
1344+
"type": "object",
1345+
"allOf": [
1346+
{
1347+
"$ref": "#/definitions/ConversationPIIResult"
1348+
},
1349+
{
1350+
"$ref": "#/definitions/ConversationResultBase"
1351+
}
1352+
]
1353+
},
13501354
"ConversationPIIResult": {
13511355
"type": "object",
13521356
"description": "The result from PII detection and redaction operation for each conversation.",

‎specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext.json

Lines changed: 57 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -832,14 +832,7 @@
832832
"documents": {
833833
"type": "array",
834834
"items": {
835-
"allOf": [
836-
{
837-
"$ref": "#/definitions/HealthcareEntitiesDocumentResult"
838-
},
839-
{
840-
"$ref": "#/definitions/DocumentDetectedLanguage"
841-
}
842-
]
835+
"$ref": "#/definitions/HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage"
843836
}
844837
}
845838
},
@@ -852,6 +845,17 @@
852845
"documents"
853846
]
854847
},
848+
"HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": {
849+
"type": "object",
850+
"allOf": [
851+
{
852+
"$ref": "#/definitions/HealthcareEntitiesDocumentResult"
853+
},
854+
{
855+
"$ref": "#/definitions/DocumentDetectedLanguageString"
856+
}
857+
]
858+
},
855859
"HealthcareEntitiesDocumentResult": {
856860
"type": "object",
857861
"properties": {
@@ -1499,14 +1503,7 @@
14991503
"type": "array",
15001504
"description": "Response by document",
15011505
"items": {
1502-
"allOf": [
1503-
{
1504-
"$ref": "#/definitions/EntitiesDocumentResult"
1505-
},
1506-
{
1507-
"$ref": "#/definitions/DocumentDetectedLanguage"
1508-
}
1509-
]
1506+
"$ref": "#/definitions/EntitiesResultWithDetectedLanguage"
15101507
}
15111508
}
15121509
},
@@ -1519,6 +1516,17 @@
15191516
"documents"
15201517
]
15211518
},
1519+
"EntitiesResultWithDetectedLanguage": {
1520+
"type": "object",
1521+
"allOf": [
1522+
{
1523+
"$ref": "#/definitions/EntitiesDocumentResult"
1524+
},
1525+
{
1526+
"$ref": "#/definitions/DocumentDetectedLanguage"
1527+
}
1528+
]
1529+
},
15221530
"EntitiesDocumentResult": {
15231531
"type": "object",
15241532
"properties": {
@@ -1648,14 +1656,7 @@
16481656
"type": "array",
16491657
"description": "Response by document",
16501658
"items": {
1651-
"allOf": [
1652-
{
1653-
"$ref": "#/definitions/LinkedEntitiesDocumentResult"
1654-
},
1655-
{
1656-
"$ref": "#/definitions/DocumentDetectedLanguage"
1657-
}
1658-
]
1659+
"$ref": "#/definitions/EntityLinkingResultWithDetectedLanguage"
16591660
}
16601661
}
16611662
},
@@ -1668,6 +1669,17 @@
16681669
"documents"
16691670
]
16701671
},
1672+
"EntityLinkingResultWithDetectedLanguage": {
1673+
"type": "object",
1674+
"allOf": [
1675+
{
1676+
"$ref": "#/definitions/LinkedEntitiesDocumentResult"
1677+
},
1678+
{
1679+
"$ref": "#/definitions/DocumentDetectedLanguage"
1680+
}
1681+
]
1682+
},
16711683
"LinkedEntitiesDocumentResult": {
16721684
"type": "object",
16731685
"required": [
@@ -1820,14 +1832,7 @@
18201832
"type": "array",
18211833
"description": "Response by document",
18221834
"items": {
1823-
"allOf": [
1824-
{
1825-
"$ref": "#/definitions/PiiEntitiesDocumentResult"
1826-
},
1827-
{
1828-
"$ref": "#/definitions/DocumentDetectedLanguage"
1829-
}
1830-
]
1835+
"$ref": "#/definitions/PIIResultWithDetectedLanguage"
18311836
}
18321837
}
18331838
},
@@ -1840,6 +1845,17 @@
18401845
"documents"
18411846
]
18421847
},
1848+
"PIIResultWithDetectedLanguage": {
1849+
"type": "object",
1850+
"allOf": [
1851+
{
1852+
"$ref": "#/definitions/PiiEntitiesDocumentResult"
1853+
},
1854+
{
1855+
"$ref": "#/definitions/DocumentDetectedLanguage"
1856+
}
1857+
]
1858+
},
18431859
"PiiDomain": {
18441860
"type": "string",
18451861
"description": "The PII domain used for PII Entity Recognition.",
@@ -2772,6 +2788,15 @@
27722788
}
27732789
}
27742790
},
2791+
"DocumentDetectedLanguageString": {
2792+
"type": "object",
2793+
"properties": {
2794+
"detectedLanguage": {
2795+
"type": "string",
2796+
"description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document."
2797+
}
2798+
}
2799+
},
27752800
"DocumentError": {
27762801
"type": "object",
27772802
"required": [

0 commit comments

Comments
 (0)