Merge pull request #103862 from suhas92/patch-27

[Text Analytics] Update Quickstart - JS

Author: GitHubber17

articles/cognitive-services/text-analytics/includes/quickstarts/nodejs-sdk.md

@@ -51,6 +51,16 @@ npm init
 ```
 ### Install the client library
 
+#### [Version 3.0-preview](#tab/version-3)
+
+Install the `@azure/ai-text-analytics` NPM packages:
+
+```console
+npm install --save @azure/ai-text-analytics
+```
+
+#### [Version 2.1](#tab/version-2)
+
 Install the `@azure/cognitiveservices-textanalytics` NPM packages:
 
 ```console
@@ -61,11 +71,27 @@ Your app's `package.json` file will be updated with the dependencies.
 
 Create a file named `index.js` and add the following libraries:
 
+---
+
+Your app's `package.json` file will be updated with the dependencies.
+Create a file named `index.js` and add the following libraries:
+
+#### [Version 3.0-preview](#tab/version-3)
+
+```javascript
+"use strict";
+
+const { TextAnalyticsClient, TextAnalyticsApiKeyCredential } = require("@azure/ai-text-analytics");
+```
+
+#### [Version 2.1](#tab/version-2)
+
 ```javascript
 "use strict";
 
 const { TextAnalyticsClient, CognitiveServicesCredential } = require("@azure/cognitiveservices-textanalytics");
 ```
+---
 
 Create variables for your resource's Azure endpoint and key.
 
@@ -100,7 +126,7 @@ The response object is a list containing the analysis information for each docum
 Create a new `TextAnalyticsClient` object with your key and endpoint as parameters.
 
 ```javascript
-const client = new TextAnalyticsClient(endpoint,  new CognitiveServicesCredential(key));
+const textAnalyticsClient = new TextAnalyticsClient(endpoint,  new TextAnalyticsApiKeyCredential(key));
 ```
 
 #### [Version 2.1](#tab/version-2)
@@ -122,19 +148,19 @@ async function sentimentAnalysis(client){
 
     const sentimentInput = [
         "I had the best day of my life. I wish you were there with me."
-    ]
-
+    ];
     const sentimentResult = await client.analyzeSentiment(sentimentInput);
-    result.forEach(document => {
+
+    sentimentResult.forEach(document => {
         console.log(`ID: ${document.id}`);
         console.log(`\tDocument Sentiment: ${document.sentiment}`);
         console.log(`\tDocument Scores:`);
-        console.log(`\t\tPositive: ${document.documentScores.positive.toFixed(2)} \tNegative: ${document.documentScores.negative.toFixed(2)} \tNeutral: ${document.documentScores.neutral.toFixed(2)}`);
+        console.log(`\t\tPositive: ${document.sentimentScores.positive.toFixed(2)} \tNegative: ${document.sentimentScores.negative.toFixed(2)} \tNeutral: ${document.sentimentScores.neutral.toFixed(2)}`);
         console.log(`\tSentences Sentiment(${document.sentences.length}):`);
         document.sentences.forEach(sentence => {
             console.log(`\t\tSentence sentiment: ${sentence.sentiment}`)
             console.log(`\t\tSentences Scores:`);
-            console.log(`\t\tPositive: ${sentence.sentenceScores.positive.toFixed(2)} \tNegative: ${sentence.sentenceScores.negative.toFixed(2)} \tNeutral: ${sentence.sentenceScores.neutral.toFixed(2)}`);
+            console.log(`\t\tPositive: ${sentence.sentimentScores.positive.toFixed(2)} \tNegative: ${sentence.sentimentScores.negative.toFixed(2)} \tNeutral: ${sentence.sentimentScores.neutral.toFixed(2)}`);
             console.log(`\t\tLength: ${sentence.length}, Offset: ${sentence.offset}`);
         })
     });
@@ -150,7 +176,7 @@ Run your code with `node index.js` in your console window.
 ID: 0
         Document Sentiment: positive
         Document Scores:
-                Positive: 0.61  Negative: 0.01  Neutral: 0.39
+                Positive: 1.00  Negative: 0.00  Neutral: 0.00
         Sentences Sentiment(2):
                 Sentence sentiment: positive
                 Sentences Scores:
@@ -185,22 +211,18 @@ Run your code with `node index.js` in your console window.
 
 #### [Version 3.0-preview](#tab/version-3)
 
-Create an array of strings containing the document you want to analyze. Call the client's `detectLanguages()` method and get the returned `DetectLanguageResult`. Then iterate through the results, and print each document's ID, with respective primary and detected language.
+Create an array of strings containing the document you want to analyze. Call the client's `detectLanguage()` method and get the returned `DetectLanguageResultCollection`. Then iterate through the results, and print each document's ID with respective primary language.
 
 ```javascript
 async function languageDetection(client) {
 
     const languageInputArray = [
         "Ce document est rédigé en Français."
-    ]
-
-    const languageResult = await client.detectLanguages(languageInputArray);
+    ];
+    const languageResult = await client.detectLanguage(languageInputArray);
 
-    result.forEach(document => {
+    languageResult.forEach(document => {
         console.log(`ID: ${document.id}`);
-        document.detectedLanguages.forEach(language =>
-        console.log(`\tDetected Language ${language.name}`)
-        );
         console.log(`\tPrimary Language ${document.primaryLanguage.name}`)
     });
 }
@@ -213,7 +235,6 @@ Run your code with `node index.js` in your console window.
 
 ```console
 ID: 0
-        Detected Language French
         Primary Language French
 ```
 
@@ -253,13 +274,12 @@ async function entityRecognition(client){
         "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, to develop and sell BASIC interpreters for the Altair 8800",
         "La sede principal de Microsoft se encuentra en la ciudad de Redmond, a 21 kilómetros de Seattle."
     ];
-
     const entityResults = await client.recognizeEntities(entityInputs);
 
     entityResults.forEach(document => {
         console.log(`Document ID: ${document.id}`);
         document.entities.forEach(entity => {
-            console.log(`\tName: ${entity.text} \tType: ${entity.type} \tSub Type: ${entity.subtype != "" ? entity.subtype : "N/A"}`);
+            console.log(`\tName: ${entity.text} \tCategory: ${entity.category} \tSubcategory: ${entity.subCategory ? entity.subCategory : "N/A"}`);
             console.log(`\tOffset: ${entity.offset}, Length: ${entity.length} \tScore: ${entity.score}`);
         });
     });
@@ -273,23 +293,26 @@ Run your code with `node index.js` in your console window.
 
 ```console
 Document ID: 0
-        Name: Microsoft         Type: Organization      Sub Type: N/A
+        Name: Microsoft         Category: Organization  Subcategory: N/A
         Offset: 0, Length: 9    Score: 1
-        Name: Bill Gates        Type: Person    Sub Type: N/A
-        Offset: 25, Length: 10  Score: 0.999786376953125
-        Name: Paul Allen        Type: Person    Sub Type: N/A
-        Offset: 40, Length: 10  Score: 0.9988105297088623
-        Name: April 4, 1975     Type: DateTime  Sub Type: Date
+        Name: Bill Gates        Category: Person        Subcategory: N/A
+        Offset: 25, Length: 10  Score: 0.67
+        Name: Paul Allen        Category: Person        Subcategory: N/A
+        Offset: 40, Length: 10  Score: 0.81
+        Name: April 4, 1975     Category: DateTime      Subcategory: Date
         Offset: 54, Length: 13  Score: 0.8
-        Name: Altair    Type: Organization      Sub Type: N/A
-        Offset: 116, Length: 6  Score: 0.7996330857276917
-        Name: 8800      Type: Quantity  Sub Type: Number
+        Name: interpreters      Category: PersonType    Subcategory: N/A
+        Offset: 95, Length: 12  Score: 0.6
+        Name: 8800      Category: Quantity      Subcategory: Number
         Offset: 123, Length: 4  Score: 0.8
 Document ID: 1
-        Name: Microsoft         Type: Organization      Sub Type: N/A
-        Offset: 21, Length: 9   Score: 0.9837456345558167
-        Name: 21        Type: Quantity  Sub Type: Number
+        Name: Microsoft         Category: Organization  Subcategory: N/A
+        Offset: 21, Length: 9   Score: 0.96
+        Name: Redmond   Category: Location      Subcategory: GPE
+        Offset: 60, Length: 7   Score: 0.09
+        Name: 21        Category: Quantity      Subcategory: Number
         Offset: 71, Length: 2   Score: 0.8
+        Name: Seattle   Category: Location      Subcategory: GPE
 ```
 
 ## Using NER to detect personal information
@@ -302,13 +325,13 @@ async function entityPiiRecognition(client){
 
     const entityPiiInput = [
         "Insurance policy for SSN on file 123-12-1234 is here by approved."
-    ]
-    const entityResults = await client.recognizePiiEntities(entityPiiInput);
+    ];
+    const entityPiiResults = await client.recognizePiiEntities(entityPiiInput);
 
-    result.forEach(document => {
+    entityPiiResults.forEach(document => {
         console.log(`Document ID: ${document.id}`);
         document.entities.forEach(entity => {
-            console.log(`\tName: ${entity.text} \tType: ${entity.type} \tSub Type: ${entity.subtype != "" ? entity.subtype : "N/A"}`);
+            console.log(`\tName: ${entity.text} \tCategory: ${entity.category} \tSubcategory: ${entity.subCategory ? entity.subCategory : "N/A"}`);
             console.log(`\tOffset: ${entity.offset}, Length: ${entity.length} \tScore: ${entity.score}`);
         });
     });
@@ -322,7 +345,7 @@ Run your code with `node index.js` in your console window.
 
 ```console
 Document ID: 0
-        Name: 123-12-1234       Type: U.S. Social Security Number (SSN)         Sub Type: N/A
+        Name: 123-12-1234       Category: U.S. Social Security Number (SSN)     Subcategory: N/A
         Offset: 33, Length: 11  Score: 0.85
 ```
 
@@ -335,7 +358,7 @@ async function linkedEntityRecognition(client){
 
     const linkedEntityInput = [
         "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, to develop and sell BASIC interpreters for the Altair 8800. During his career at Microsoft, Gates held the positions of chairman, chief executive officer, president and chief software architect, while also being the largest individual shareholder until May 2014."
-    ]
+    ];
     const entityResults = await client.recognizeLinkedEntities(linkedEntityInput);
 
     entityResults.forEach(document => {
@@ -346,7 +369,7 @@ async function linkedEntityRecognition(client){
             entity.matches.forEach(match => {
                 console.log(`\t\tText: ${match.text}`);
                 console.log(`\t\tOffset: ${match.offset}, Length: ${match.length} \tScore: ${match.score.toFixed(3)}`);
-            })
+            });
         });
     });
 }
@@ -362,31 +385,31 @@ Document ID: 0
         Name: Altair 8800       ID: Altair 8800         URL: https://en.wikipedia.org/wiki/Altair_8800  Data Source: Wikipedia
         Matches:
                 Text: Altair 8800
-                Offset: 116, Length: 11         Score: 0.650
+                Offset: 116, Length: 11         Score: 0.777
         Name: Bill Gates        ID: Bill Gates  URL: https://en.wikipedia.org/wiki/Bill_Gates   Data Source: Wikipedia
         Matches:
                 Text: Bill Gates
-                Offset: 25, Length: 10  Score: 0.243
+                Offset: 25, Length: 10  Score: 0.555
                 Text: Gates
-                Offset: 161, Length: 5  Score: 0.243
+                Offset: 161, Length: 5  Score: 0.555
         Name: Paul Allen        ID: Paul Allen  URL: https://en.wikipedia.org/wiki/Paul_Allen   Data Source: Wikipedia
         Matches:
                 Text: Paul Allen
-                Offset: 40, Length: 10  Score: 0.174
+                Offset: 40, Length: 10  Score: 0.533
         Name: Microsoft         ID: Microsoft   URL: https://en.wikipedia.org/wiki/Microsoft    Data Source: Wikipedia
         Matches:
                 Text: Microsoft
-                Offset: 0, Length: 9    Score: 0.196
+                Offset: 0, Length: 9    Score: 0.469
                 Text: Microsoft
-                Offset: 150, Length: 9  Score: 0.196
+                Offset: 150, Length: 9  Score: 0.469
         Name: April 4   ID: April 4     URL: https://en.wikipedia.org/wiki/April_4      Data Source: Wikipedia
         Matches:
                 Text: April 4
-                Offset: 54, Length: 7   Score: 0.137
+                Offset: 54, Length: 7   Score: 0.248
         Name: BASIC     ID: BASIC       URL: https://en.wikipedia.org/wiki/BASIC        Data Source: Wikipedia
         Matches:
                 Text: BASIC
-                Offset: 89, Length: 5   Score: 0.052
+                Offset: 89, Length: 5   Score: 0.281
 ```
 
 #### [Version 2.1](#tab/version-2)
@@ -443,12 +466,10 @@ async function keyPhraseExtraction(client){
 
     const keyPhrasesInput = [
         "My cat might need to see a veterinarian.",
-    ]
-
-    const result = await client.extractKeyPhrases(keyPhrasesInput)
-
-
-    result.forEach(document => {
+    ];
+    const keyPhraseResult = await client.extractKeyPhrases(keyPhrasesInput);
+    
+    keyPhraseResult.forEach(document => {
         console.log(`ID: ${document.id}`);
         console.log(`\tDocument Key Phrases: ${document.keyPhrases}`);
     });