[Language Analyze Text] 2024-11-15-preview and 2024-11-01 updates (Azure#47339)

2024-11-15-preview and 2024-11-01 api update

Author: quentinRobinson

.vscode/cspell.json

@@ -358,21 +358,27 @@
         "grek",
         "gujr",
         "gurmukhi",
+        "hani",
         "hebr",
         "inclusivity",
         "jpan",
         "khmr",
         "knda",
         "laoo",
+        "meitei",
         "mlym",
+        "mtei",
         "mymr",
         "nigiri",
         "odia",
+        "olck",
         "orya",
         "petabit",
         "picometer",
         "qnas",
         "regon",
+        "sharada",
+        "shrd",
         "taml",
         "telu",
         "thaa",

sdk/cognitivelanguage/Azure.AI.Language.Text/CHANGELOG.md

@@ -1,16 +1,18 @@
 # Release History
 
-## 1.0.0-beta.2 (Unreleased)
+## 1.0.0-beta.2 (2024-12-15)
 
 ### Features Added
 
 - Exposed `JsonModelWriteCore` for model serialization procedure.
+- Added support for analyze-text API Versions
+  - 2024-11-01
+  - 2024-11-15-preview
 
 ### Breaking Changes
 
-### Bugs Fixed
-
-### Other Changes
+- Removed support for analyze-text API Versions
+  - 2023-11-15-preview
 
 ## 1.0.0-beta.1 (2024-08-06)
 

sdk/cognitivelanguage/Azure.AI.Language.Text/MigrationGuide.md

@@ -176,7 +176,15 @@ try
 
     foreach (LanguageDetectionDocumentResult document in AnalyzeTextLanguageDetectionResult.Results.Documents)
     {
-        Console.WriteLine($"For Document ID: {document.Id} detected language is {document.DetectedLanguage.Name} with a confidence score of {document.DetectedLanguage.ConfidenceScore}.");
+        Console.WriteLine($"Result for document with Id = \"{document.Id}\":");
+        Console.WriteLine($"    Name: {document.DetectedLanguage.Name}");
+        Console.WriteLine($"    Iso6391Name: {document.DetectedLanguage.Iso6391Name}");
+        if (document.DetectedLanguage.ScriptName != null)
+        {
+            Console.WriteLine($"    ScriptName: {document.DetectedLanguage.ScriptName}");
+            Console.WriteLine($"    ScriptIso15924Code: {document.DetectedLanguage.ScriptIso15924Code}");
+        }
+        Console.WriteLine($"    ConfidenceScore: {document.DetectedLanguage.ConfidenceScore}");
     }
 }
 catch (RequestFailedException exception)
@@ -565,7 +573,7 @@ AnalyzeTextInput body = new TextEntityRecognitionInput()
 Response<AnalyzeTextResult> response = await client.AnalyzeTextAsync(body);
 AnalyzeTextEntitiesResult entitiesTaskResult = (AnalyzeTextEntitiesResult)response.Value;
 
-foreach (EntitiesDocumentResultWithMetadataDetectedLanguage nerResult in entitiesTaskResult.Results.Documents)
+foreach (EntityActionResult nerResult in entitiesTaskResult.Results.Documents)
 {
     Console.WriteLine($"Result for document with Id = \"{nerResult.Id}\":");
 
@@ -577,8 +585,13 @@ foreach (EntitiesDocumentResultWithMetadataDetectedLanguage nerResult in entitie
         Console.WriteLine($"    Offset: {entity.Offset}");
         Console.WriteLine($"    Length: {entity.Length}");
         Console.WriteLine($"    Category: {entity.Category}");
-        if (!string.IsNullOrEmpty(entity.Subcategory))
-            Console.WriteLine($"    SubCategory: {entity.Subcategory}");
+        Console.WriteLine($"    Type: {entity.Type}");
+        Console.WriteLine($"    Tags:");
+        foreach (EntityTag tag in entity.Tags)
+        {
+            Console.WriteLine($"            TagName: {tag.Name}");
+            Console.WriteLine($"            TagConfidenceScore: {tag.ConfidenceScore}");
+        }
         Console.WriteLine($"    Confidence score: {entity.ConfidenceScore}");
         Console.WriteLine();
     }
@@ -698,7 +711,7 @@ foreach (PiiActionResult piiResult in piiTaskResult.Results.Documents)
     Console.WriteLine($"  Redacted Text: \"{piiResult.RedactedText}\":");
     Console.WriteLine($"  Recognized {piiResult.Entities.Count} entities:");
 
-    foreach (NamedEntity entity in piiResult.Entities)
+    foreach (PiiEntity entity in piiResult.Entities)
     {
         Console.WriteLine($"    Text: {entity.Text}");
         Console.WriteLine($"    Offset: {entity.Offset}");
@@ -1244,7 +1257,7 @@ foreach (AnalyzeTextOperationResult analyzeTextLROResult in analyzeTextJobState.
         CustomEntityRecognitionOperationResult customClassificationResult = (CustomEntityRecognitionOperationResult)analyzeTextLROResult;
 
         // View the classifications recognized in the input documents.
-        foreach (EntityActionResult entitiesDocument in customClassificationResult.Results.Documents)
+        foreach (CustomEntityActionResult entitiesDocument in customClassificationResult.Results.Documents)
         {
             Console.WriteLine($"Result for document with Id = \"{entitiesDocument.Id}\":");
             Console.WriteLine($"  Recognized {entitiesDocument.Entities.Count} Entities:");
@@ -2043,7 +2056,7 @@ foreach (AnalyzeTextOperationResult analyzeTextLROResult in analyzeTextJobState.
         EntityRecognitionOperationResult entityRecognitionLROResult = (EntityRecognitionOperationResult)analyzeTextLROResult;
 
         // View the classifications recognized in the input documents.
-        foreach (EntitiesDocumentResultWithMetadataDetectedLanguage nerResult in entityRecognitionLROResult.Results.Documents)
+        foreach (EntityActionResultWithMetadata nerResult in entityRecognitionLROResult.Results.Documents)
         {
             Console.WriteLine($"Result for document with Id = \"{nerResult.Id}\":");
 
@@ -2055,9 +2068,13 @@ foreach (AnalyzeTextOperationResult analyzeTextLROResult in analyzeTextJobState.
                 Console.WriteLine($"    Offset: {entity.Offset}");
                 Console.WriteLine($"    Length: {entity.Length}");
                 Console.WriteLine($"    Category: {entity.Category}");
-                if (!string.IsNullOrEmpty(entity.Subcategory))
-                    Console.WriteLine($"    SubCategory: {entity.Subcategory}");
-                Console.WriteLine($"    Confidence score: {entity.ConfidenceScore}");
+                Console.WriteLine($"    Type: {entity.Type}");
+                Console.WriteLine($"    Tags:");
+                foreach (EntityTag tag in entity.Tags)
+                {
+                    Console.WriteLine($"            TagName: {tag.Name}");
+                    Console.WriteLine($"            TagConfidenceScore: {tag.ConfidenceScore}");
+                }
                 Console.WriteLine();
             }
             Console.WriteLine();