एपीआई से कनेक्ट करें: सुझाव, शिकायत या राय का विश्लेषण करें

कोडिंग का लेवल: बीच के लेवल वाला
कुल समय: 20 मिनट
प्रोजेक्ट टाइप: कस्टम मेन्यू की मदद से ऑटोमेशन की सुविधा

मकसद

• समझें कि समाधान क्या है.
• जानें कि Apps Script सेवा के अंदर क्या काम करती है.
• अपना एनवायरमेंट सेट अप करें.
• स्क्रिप्ट सेट अप करें.
• स्क्रिप्ट चलाएं.

इस सलूशन के बारे में जानकारी

आपके पास टेक्स्ट डेटा, जैसे कि ओपेन-एंडेड सुझाव, शिकायत या राय का बड़े पैमाने पर विश्लेषण करने की सुविधा होती है. यह समाधान, Google Sheets में इकाई और भावनाओं का विश्लेषण करने के लिए, Urlफ़ेच सेवा का इस्तेमाल करता है. इससे Google Cloud Natural Language API से कनेक्ट किया जाता है.

यह कैसे काम करता है

स्क्रिप्ट, स्प्रेडशीट से टेक्स्ट इकट्ठा करती है और Google Cloud Natural Language API से कनेक्ट होती है, ताकि स्ट्रिंग में मौजूद इकाइयों और भावनाओं का विश्लेषण किया जा सके. पिवट टेबल, टेक्स्ट डेटा की सभी लाइनों में बताई गई हर इकाई के लिए, भावनाओं के औसत स्कोर की खास जानकारी देती है.

Apps Script सेवाएं

यह समाधान इन सेवाओं का इस्तेमाल करता है:

• स्प्रेडशीट सेवा–यह टेक्स्ट डेटा को Google Cloud Natural Language API को भेजती है और हर लाइन की भावनाओं का विश्लेषण हो जाने के बाद, उसे "पूरा हो गया" के तौर पर मार्क करती है.
• UrlFetch सेवा–टेक्स्ट पर इकाई और भावनाओं का विश्लेषण करने के लिए, Google Cloud Natural Language API से कनेक्ट होता है.

ज़रूरी शर्तें

इस सैंपल का इस्तेमाल करने के लिए, आपको ये ज़रूरी शर्तें पूरी करनी होंगी:

• Google खाता (Google Workspace खातों के लिए एडमिन की अनुमति ज़रूरी हो सकती है).

• इंटरनेट ऐक्सेस करने वाला वेब ब्राउज़र.

• Google Cloud प्रोजेक्ट, जिससे कोई बिलिंग खाता जुड़ा हो. किसी प्रोजेक्ट के लिए बिलिंग चालू करना लेख पढ़ें.

अपना एनवायरमेंट सेट अप करें

Google Cloud Console में अपना Cloud प्रोजेक्ट खोलें

अगर यह पहले से नहीं खुला है, तो वह Cloud प्रोजेक्ट खोलें जिसे आपको इस सैंपल के लिए इस्तेमाल करना है:

1. Google Cloud Console में, कोई प्रोजेक्ट चुनें पेज पर जाएं.

   Cloud प्रोजेक्ट चुनें

2. वह Google Cloud प्रोजेक्ट चुनें जिसका आपको इस्तेमाल करना है. या प्रोजेक्ट बनाएं पर क्लिक करके, स्क्रीन पर दिए गए निर्देशों का पालन करें. अगर आपने Google Cloud प्रोजेक्ट बनाया है, तो आपको प्रोजेक्ट के लिए बिलिंग चालू करनी पड़ सकती है.

Google Cloud Natural Language API चालू करें

यह समाधान, Google Cloud Natural Language API से कनेक्ट होता है. Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. किसी एक Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.

• अपने Cloud प्रोजेक्ट में, Google Cloud Natural Language API चालू करें.

  एपीआई चालू करें

उस स्क्रीन को कॉन्फ़िगर करना जहां OAuth के लिए सहमति दी जाती है

इस समाधान के लिए, कॉन्फ़िगर की गई सहमति वाली स्क्रीन वाला Cloud प्रोजेक्ट होना चाहिए. OAuth के लिए सहमति वाली स्क्रीन को कॉन्फ़िगर करने से, यह तय होता है कि Google, उपयोगकर्ताओं को क्या दिखाता है और आपके ऐप्लिकेशन को रजिस्टर करता है, ताकि आप उसे बाद में पब्लिश कर सकें.

1. Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > OAuth की सहमति वाली स्क्रीन पर जाएं.

   ऐसी स्क्रीन पर जाएं जहां OAuth के लिए सहमति दी जाती है

2. उपयोगकर्ता टाइप के लिए, अंदरूनी चुनें. इसके बाद, बनाएं पर क्लिक करें.
3. ऐप्लिकेशन रजिस्ट्रेशन फ़ॉर्म भरें. इसके बाद, सेव करें और जारी रखें पर क्लिक करें.

4. फ़िलहाल, दायरों को छोड़कर आगे बढ़ा जा सकता है. साथ ही, सेव करें और जारी रखें पर क्लिक करें. आने वाले समय में, जब अपने Google Workspace संगठन से बाहर इस्तेमाल करने के लिए कोई ऐप्लिकेशन बनाया जाएगा, तो आपको उपयोगकर्ता टाइप को बाहरी उपयोगकर्ता में बदलना होगा. इसके बाद, आपको अपने ऐप्लिकेशन के लिए ज़रूरी अनुमति के दायरे जोड़ने होंगे.

5. अपने ऐप्लिकेशन रजिस्ट्रेशन की खास जानकारी देखें. बदलाव करने के लिए, बदलाव करें पर क्लिक करें. अगर ऐप्लिकेशन रजिस्ट्रेशन ठीक लग रहा है, तो डैशबोर्ड पर वापस जाएं पर क्लिक करें.

Google Cloud Natural Language API के लिए एपीआई पासकोड पाना

1. Google Cloud Console पर जाएं. पक्का करें कि बिलिंग की सुविधा वाला आपका प्रोजेक्ट खुला हो.

2. Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

   क्रेडेंशियल पर जाएं

3. क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें.

4. बाद के चरण में इस्तेमाल करने के लिए, अपनी एपीआई कुंजी का ध्यान रखें.

स्क्रिप्ट सेट अप करें

Apps Script प्रोजेक्ट बनाना

1. सुझाव के लिए भावनाओं का विश्लेषण सैंपल स्प्रेडशीट की कॉपी बनाने के लिए, नीचे दिए गए बटन पर क्लिक करें. इस समाधान का Apps Script प्रोजेक्ट, स्प्रेडशीट में अटैच किया गया है.
   कॉपी बनाएं
2. एक्सटेंशन > Apps Script पर क्लिक करें.
3. अपनी एपीआई कुंजी का इस्तेमाल करके, स्क्रिप्ट फ़ाइल में इस वैरिएबल को अपडेट करें:

   const myApiKey = 'YOUR_API_KEY'; // Replace with your API key.

4. ' को सेव करें' पर क्लिक करें.

टेक्स्ट डेटा जोड़ें

1. स्प्रेडशीट पर वापस जाएं.
2. आईडी और टिप्पणियां कॉलम में टेक्स्ट डेटा जोड़ें. आपके पास Kaggle में दी गई, छुट्टियों की प्रॉपर्टी की समीक्षाओं के सैंपल का इस्तेमाल करने या अपने डेटा का इस्तेमाल करने का विकल्प है. ज़रूरत पड़ने पर और कॉलम जोड़े जा सकते हैं. हालांकि, स्क्रिप्ट को सही तरीके से चलाने के लिए, id और टिप्पणियां कॉलम में डेटा होना ज़रूरी है.

स्क्रिप्ट चलाएं

1. स्प्रेडशीट में सबसे ऊपर, भावनाएं टूल > इकाइयों और भावनाओं को मार्क करें पर क्लिक करें. इस कस्टम मेन्यू को दिखाने के लिए, आपको पेज को रीफ़्रेश करना पड़ सकता है.

2. जब कहा जाए, तब स्क्रिप्ट को अनुमति दें. अगर OAuth के लिए सहमति देने वाली स्क्रीन पर चेतावनी दिखती है, इस ऐप्लिकेशन की पुष्टि नहीं हुई है, तो बेहतर > को चुनकर जारी रखें {Project Name} पर जाएं (असुरक्षित).

3. भावुक करने वाले टूल > इकाई और भावनाओं को फिर से मार्क करें पर क्लिक करें.

4. स्क्रिप्ट पूरी हो जाने के बाद, नतीजे देखने के लिए पिवट टेबल शीट पर स्विच करें.

कोड की समीक्षा करें

इस समाधान के Apps Script कोड की समीक्षा करने के लिए, नीचे सोर्स कोड देखें पर क्लिक करें:

सोर्स कोड देखें

Code.gs

solutions/automations/feedback-sentiment-analysis/code.js

GitHub पर देखें

// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/feedback-sentiment-analysis

/*
Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Sets API key for accessing Cloud Natural Language API.
const myApiKey = 'YOUR_API_KEY'; // Replace with your API key.

// Matches column names in Review Data sheet to variables.
let COLUMN_NAME = {
  COMMENTS: 'comments',
  ENTITY: 'entity_sentiment',
  ID: 'id'
};

/**
 * Creates a Demo menu in Google Spreadsheets.
 */
function onOpen() {
  SpreadsheetApp.getUi()
    .createMenu('Sentiment Tools')
    .addItem('Mark entities and sentiment', 'markEntitySentiment')
    .addToUi();
};

/**
* Analyzes entities and sentiment for each comment in  
* Review Data sheet and copies results into the 
* Entity Sentiment Data sheet.
*/
function markEntitySentiment() {
  // Sets variables for "Review Data" sheet
  let ss = SpreadsheetApp.getActiveSpreadsheet();
  let dataSheet = ss.getSheetByName('Review Data');
  let rows = dataSheet.getDataRange();
  let numRows = rows.getNumRows();
  let values = rows.getValues();
  let headerRow = values[0];

  // Checks to see if "Entity Sentiment Data" sheet is present, and
  // if not, creates a new sheet and sets the header row.
  let entitySheet = ss.getSheetByName('Entity Sentiment Data');
  if (entitySheet == null) {
   ss.insertSheet('Entity Sentiment Data');
   let entitySheet = ss.getSheetByName('Entity Sentiment Data');
   let esHeaderRange = entitySheet.getRange(1,1,1,6);
   let esHeader = [['Review ID','Entity','Salience','Sentiment Score',
                    'Sentiment Magnitude','Number of mentions']];
   esHeaderRange.setValues(esHeader);
  };

  // Finds the column index for comments, language_detected, 
  // and comments_english columns.
  let textColumnIdx = headerRow.indexOf(COLUMN_NAME.COMMENTS);
  let entityColumnIdx = headerRow.indexOf(COLUMN_NAME.ENTITY);
  let idColumnIdx = headerRow.indexOf(COLUMN_NAME.ID);
  if (entityColumnIdx == -1) {
    Browser.msgBox("Error: Could not find the column named " + COLUMN_NAME.ENTITY + 
                   ". Please create an empty column with header \"entity_sentiment\" on the Review Data tab.");
    return; // bail
  };

  ss.toast("Analyzing entities and sentiment...");
  for (let i = 0; i < numRows; ++i) {
    let value = values[i];
    let commentEnCellVal = value[textColumnIdx];
    let entityCellVal = value[entityColumnIdx];
    let reviewId = value[idColumnIdx];

    // Calls retrieveEntitySentiment function for each row that has a comment 
    // and also an empty entity_sentiment cell value.
    if(commentEnCellVal && !entityCellVal) {
        let nlData = retrieveEntitySentiment(commentEnCellVal);
        // Pastes each entity and sentiment score into Entity Sentiment Data sheet.
        let newValues = []
        for (let entity in nlData.entities) {
          entity = nlData.entities [entity];
          let row = [reviewId, entity.name, entity.salience, entity.sentiment.score, 
                     entity.sentiment.magnitude, entity.mentions.length
                    ];
          newValues.push(row);
        }
      if(newValues.length) {
        entitySheet.getRange(entitySheet.getLastRow() + 1, 1, newValues.length, newValues[0].length).setValues(newValues);
      }
        // Pastes "complete" into entity_sentiment column to denote completion of NL API call.
        dataSheet.getRange(i+1, entityColumnIdx+1).setValue("complete");
     }
   }
};

/**
 * Calls the Cloud Natural Language API with a string of text to analyze
 * entities and sentiment present in the string.
 * @param {String} the string for entity sentiment analysis
 * @return {Object} the entities and related sentiment present in the string
 */
function retrieveEntitySentiment (line) {
  let apiKey = myApiKey;
  let apiEndpoint = 'https://language.googleapis.com/v1/documents:analyzeEntitySentiment?key=' + apiKey;
  // Creates a JSON request, with text string, language, type and encoding
  let nlData = {
    document: {
      language: 'en-us',
      type: 'PLAIN_TEXT',
      content: line
    },
    encodingType: 'UTF8'
  };
  // Packages all of the options and the data together for the API call.
  let nlOptions = {
    method : 'post',
    contentType: 'application/json',  
    payload : JSON.stringify(nlData)
  };
  // Makes the API call.
  let response = UrlFetchApp.fetch(apiEndpoint, nlOptions);
  return JSON.parse(response);
};

योगदानकर्ता

Google, इस सैंपल को मैनेज करने के लिए Google Developer के विशेषज्ञों की मदद लेता है.

अगले चरण

• ब्लॉग: Google Cloud Natural Language API और Apps Script का इस्तेमाल करके, Google Sheets में टेक्स्ट का विश्लेषण करना
• Google Cloud Natural Language API का दस्तावेज़