Skip to content

Commit 1646226

Browse files
nourhaanfaridkayousefFARHAD SHAKERINaurghobyuantao-wang
authored
[Cognitive Services - Language] 2022-07-01-preview swagger (#19558)
* Language 2022-07-01-preview swagger * Update SuccessfulGetSupportedLanguages.json with fixes in dev * Update SuccessfulGetSupportedPrebuiltEntities.json with fixes in dev * Update SuccessfulGetSupportedLanguages.json with fixes in dev * fixing currency iso 4217 case error in analyzeconversations ISO4217 -> iso4217 * Update SuccessfulGetSupportedLanguages.json with fixes in dev * Update SuccessfulGetSupportedPrebuiltEntities.json with fixes in dev * Update SuccessfulGetSupportedLanguages.json with fixes in dev * Add back Conversations job cancel request * Add back fhir changes for healthcare * Add confidence score in healthcare relation and add healthcare example * prettier * fix HostParametersValidation * Add linting fixes * Fix screaming snake case for health entity category in july preview * Modify HealthcareEntityCategory to have pascal case values instead of SCREAMING_SNAKE_CASE in dev * Add linting fixes and missing change in dev * adjust indentation * Fix HealthCareEntityCateory for GA stable versions * Fix healthcare entity category in v3.1 example * Correct job id in example for health 3.1 * Modify Readme for July preview and remove readme within folder * Remove format int32 from few analyze text properties and update dev branch * Remove summarization int format * Revert "fixing currency iso 4217 case error in analyzeconversations" This reverts commit 1b5c97c. * Add abstractive summarization objects * Revert "Add abstractive summarization objects" This reverts commit 6eca2b4. * Add autolanguage detection and bringing to parity with dev * Add QnA swagger changes * Add QnA to Readme * Rename endpoint parameter back to Endpoint but keep format:uri * remove format uri * Update the CLU runtime swagger resolution kinds to match the service implementation. * Remove language code from URI * Update specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/analyzetext.json Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com> * removing additional en-us from link in dev Co-authored-by: Kareem Yousef <kayousef@microsoft.com> Co-authored-by: FARHAD SHAKERIN <fxs130430@utdallas.edu> Co-authored-by: Aurgho Bhattacharjee <aurghob@gmail.com> Co-authored-by: Yuantao Wang <yuantw@microsoft.com> Co-authored-by: Aurgho Bhattacharjee <aurghob@microsoft.com> Co-authored-by: Ahmed Ashour <aash@microsoft.com> Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>
1 parent b6ea2a9 commit 1646226

File tree

112 files changed

+20502
-85
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+20502
-85
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@
251251
}
252252
},
253253
"AnalyzeConversationTask": {
254+
"type": "object",
254255
"description": "The base class of a conversation input task.",
255256
"discriminator": "kind",
256257
"required": [
@@ -263,6 +264,7 @@
263264
}
264265
},
265266
"AnalyzeConversationTaskResult": {
267+
"type": "object",
266268
"description": "The base class of a conversation task result.",
267269
"discriminator": "kind",
268270
"required": [
@@ -275,6 +277,7 @@
275277
}
276278
},
277279
"ConversationalTask": {
280+
"type": "object",
278281
"description": "The input for a custom conversation task.",
279282
"allOf": [
280283
{
@@ -393,6 +396,7 @@
393396
"additionalProperties": true
394397
},
395398
"TextConversationItem": {
399+
"type": "object",
396400
"description": "The text modality of an input conversation.",
397401
"allOf": [
398402
{
@@ -1557,6 +1561,7 @@
15571561
}
15581562
},
15591563
"AnalyzeConversationJobsInput": {
1564+
"type": "object",
15601565
"properties": {
15611566
"displayName": {
15621567
"description": "Optional display name for the analysis job.",
@@ -1579,6 +1584,7 @@
15791584
]
15801585
},
15811586
"AnalyzeConversationLROTask": {
1587+
"type": "object",
15821588
"description": "The base class for an long running conversation input task.",
15831589
"discriminator": "kind",
15841590
"required": [
@@ -1658,6 +1664,7 @@
16581664
}
16591665
},
16601666
"MultiLanguageConversationAnalysisInput": {
1667+
"type": "object",
16611668
"required": [
16621669
"conversations"
16631670
],
@@ -1722,6 +1729,7 @@
17221729
}
17231730
},
17241731
"TextConversation": {
1732+
"type": "object",
17251733
"x-ms-discriminator-value": "text",
17261734
"required": [
17271735
"conversationItems"
@@ -1742,6 +1750,7 @@
17421750
}
17431751
},
17441752
"TranscriptConversation": {
1753+
"type": "object",
17451754
"x-ms-discriminator-value": "transcript",
17461755
"required": [
17471756
"conversationItems"
@@ -1950,6 +1959,7 @@
19501959
]
19511960
},
19521961
"ConversationPIIResult": {
1962+
"type": "object",
19531963
"description": "The result from PII detection and redaction operation for each conversation.",
19541964
"required": [
19551965
"conversationItems"

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

Lines changed: 40 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"swagger": "2.0",
33
"info": {
44
"title": "Microsoft Cognitive Language Service - Text Analysis",
5-
"description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.0",
5+
"description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/azure/cognitive-services/language-service/overview</a>.0",
66
"version": "2022-10-01-preview"
77
},
88
"securityDefinitions": {
@@ -316,6 +316,7 @@
316316
}
317317
},
318318
"MultiLanguageAnalysisInput": {
319+
"type": "object",
319320
"properties": {
320321
"documents": {
321322
"type": "array",
@@ -326,6 +327,7 @@
326327
}
327328
},
328329
"LanguageDetectionAnalysisInput": {
330+
"type": "object",
329331
"properties": {
330332
"documents": {
331333
"type": "array",
@@ -336,6 +338,7 @@
336338
}
337339
},
338340
"AnalyzeTextTask": {
341+
"type": "object",
339342
"discriminator": "kind",
340343
"required": [
341344
"kind"
@@ -347,6 +350,7 @@
347350
}
348351
},
349352
"AnalyzeTextLROTask": {
353+
"type": "object",
350354
"discriminator": "kind",
351355
"required": [
352356
"kind"
@@ -363,6 +367,7 @@
363367
]
364368
},
365369
"AnalyzeTextTaskResult": {
370+
"type": "object",
366371
"discriminator": "kind",
367372
"required": [
368373
"kind"
@@ -374,6 +379,7 @@
374379
}
375380
},
376381
"AnalyzeTextEntityLinkingInput": {
382+
"type": "object",
377383
"properties": {
378384
"analysisInput": {
379385
"$ref": "#/definitions/MultiLanguageAnalysisInput"
@@ -390,6 +396,7 @@
390396
"x-ms-discriminator-value": "EntityLinking"
391397
},
392398
"AnalyzeTextEntityRecognitionInput": {
399+
"type": "object",
393400
"properties": {
394401
"analysisInput": {
395402
"$ref": "#/definitions/MultiLanguageAnalysisInput"
@@ -406,6 +413,7 @@
406413
"x-ms-discriminator-value": "EntityRecognition"
407414
},
408415
"AnalyzeTextKeyPhraseExtractionInput": {
416+
"type": "object",
409417
"properties": {
410418
"analysisInput": {
411419
"$ref": "#/definitions/MultiLanguageAnalysisInput"
@@ -422,6 +430,7 @@
422430
"x-ms-discriminator-value": "KeyPhraseExtraction"
423431
},
424432
"AnalyzeTextPiiEntitiesRecognitionInput": {
433+
"type": "object",
425434
"properties": {
426435
"analysisInput": {
427436
"$ref": "#/definitions/MultiLanguageAnalysisInput"
@@ -438,6 +447,7 @@
438447
"x-ms-discriminator-value": "PiiEntityRecognition"
439448
},
440449
"AnalyzeTextLanguageDetectionInput": {
450+
"type": "object",
441451
"properties": {
442452
"analysisInput": {
443453
"$ref": "#/definitions/LanguageDetectionAnalysisInput"
@@ -454,6 +464,7 @@
454464
"x-ms-discriminator-value": "LanguageDetection"
455465
},
456466
"AnalyzeTextSentimentAnalysisInput": {
467+
"type": "object",
457468
"properties": {
458469
"analysisInput": {
459470
"$ref": "#/definitions/MultiLanguageAnalysisInput"
@@ -470,6 +481,7 @@
470481
"x-ms-discriminator-value": "SentimentAnalysis"
471482
},
472483
"AnalyzeTextJobsInput": {
484+
"type": "object",
473485
"properties": {
474486
"displayName": {
475487
"description": "Optional display name for the analysis job.",
@@ -519,6 +531,7 @@
519531
]
520532
},
521533
"CustomResult": {
534+
"type": "object",
522535
"properties": {
523536
"errors": {
524537
"type": "array",
@@ -823,32 +836,32 @@
823836
"type": "string",
824837
"description": "Healthcare Entity Category.",
825838
"enum": [
826-
"BODY_STRUCTURE",
827-
"AGE",
828-
"GENDER",
829-
"EXAMINATION_NAME",
830-
"DATE",
831-
"DIRECTION",
832-
"FREQUENCY",
833-
"MEASUREMENT_VALUE",
834-
"MEASUREMENT_UNIT",
835-
"RELATIONAL_OPERATOR",
836-
"TIME",
837-
"GENE_OR_PROTEIN",
838-
"VARIANT",
839-
"ADMINISTRATIVE_EVENT",
840-
"CARE_ENVIRONMENT",
841-
"HEALTHCARE_PROFESSION",
842-
"DIAGNOSIS",
843-
"SYMPTOM_OR_SIGN",
844-
"CONDITION_QUALIFIER",
845-
"MEDICATION_CLASS",
846-
"MEDICATION_NAME",
847-
"DOSAGE",
848-
"MEDICATION_FORM",
849-
"MEDICATION_ROUTE",
850-
"FAMILY_RELATION",
851-
"TREATMENT_NAME"
839+
"BodyStructure",
840+
"Age",
841+
"Gender",
842+
"ExaminationName",
843+
"Date",
844+
"Direction",
845+
"Frequency",
846+
"MeasurementValue",
847+
"MeasurementUnit",
848+
"RelationalOperator",
849+
"Time",
850+
"GeneOrProtein",
851+
"Variant",
852+
"AdministrativeEvent",
853+
"CareEnvironment",
854+
"HealthcareProfession",
855+
"Diagnosis",
856+
"SymptomOrSign",
857+
"ConditionalQualifier",
858+
"MedicationClass",
859+
"MedicationName",
860+
"Dosage",
861+
"MedicationForm",
862+
"MedicationRoute",
863+
"FamilyRelation",
864+
"TreatmentName"
852865
]
853866
},
854867
"subcategory": {

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,9 +345,27 @@
345345
"RequestStatistics": {
346346
"type": "object",
347347
"required": [
348+
"documentsCount",
349+
"validDocumentsCount",
350+
"erroneousDocumentsCount",
348351
"transactionsCount"
349352
],
350353
"properties": {
354+
"documentsCount": {
355+
"type": "integer",
356+
"format": "int32",
357+
"description": "Number of documents submitted in the request."
358+
},
359+
"validDocumentsCount": {
360+
"type": "integer",
361+
"format": "int32",
362+
"description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents."
363+
},
364+
"erroneousDocumentsCount": {
365+
"type": "integer",
366+
"format": "int32",
367+
"description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents."
368+
},
351369
"transactionsCount": {
352370
"type": "integer",
353371
"format": "int64",
@@ -815,6 +833,7 @@
815833
"x-ms-parameter-location": "client",
816834
"required": true,
817835
"type": "string",
836+
"format": "uri",
818837
"in": "path",
819838
"x-ms-skip-url-encoding": true
820839
},

0 commit comments

Comments
 (0)