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

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

मकसद

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

इस समाधान के बारे में जानकारी

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

भावनाओं का विश्लेषण करने के तरीके का डायग्राम

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

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

Apps Script की सेवाएं

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

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

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

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

  • Google खाता (Google Workspace खातों के लिए, एडमिन की अनुमति ज़रूरी हो सकती है).
  • इंटरनेट ऐक्सेस करने की सुविधा वाला वेब ब्राउज़र.

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

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

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

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

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

    कोई क्लाउड प्रोजेक्ट चुनें

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

Google Cloud Natural Language API चालू करना

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

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

  1. Google Cloud Console में, मेन्यू &gt Google Auth platform &gt ब्रैंडिंग पर जाएं.

    ब्रैंडिंग पर जाएं

  2. अगर आपने पहले ही Google Auth platformको कॉन्फ़िगर कर लिया है, तो ब्रैंडिंग, दर्शक, और डेटा ऐक्सेस में जाकर, OAuth सहमति स्क्रीन की इन सेटिंग को कॉन्फ़िगर किया जा सकता है. अगर आपको Google Auth platform अभी तक कॉन्फ़िगर नहीं किया गया है मैसेज दिखता है, तो शुरू करें पर क्लिक करें:
    1. ऐप्लिकेशन की जानकारी में जाकर, ऐप्लिकेशन का नाम में ऐप्लिकेशन का नाम डालें.
    2. उपयोगकर्ता सहायता के लिए ईमेल पता में, सहायता के लिए वह ईमेल पता चुनें जिस पर उपयोगकर्ता, सहमति से जुड़े सवालों के लिए आपसे संपर्क कर सकें.
    3. आगे बढ़ें पर क्लिक करें.
    4. दर्शक सेक्शन में जाकर, संगठन के अंदर से जनरेट होने वाला ट्रैफ़िक चुनें.
    5. आगे बढ़ें पर क्लिक करें.
    6. संपर्क जानकारी में जाकर, वह ईमेल पता डालें जिस पर आपको अपने प्रोजेक्ट में हुए किसी भी बदलाव की सूचना मिल सके.
    7. आगे बढ़ें पर क्लिक करें.
    8. पूरा करें में जाकर, Google API सेवाओं के उपयोगकर्ता के डेटा की नीति पढ़ें. अगर आप इससे सहमत हैं, तो मैं Google API सेवाओं के उपयोगकर्ता के डेटा की नीति से सहमत हूं को चुनें.
    9. जारी रखें पर क्लिक करें.
    10. बनाएं पर क्लिक करें.
  3. फ़िलहाल, स्कोप जोड़ने की प्रोसेस को स्किप किया जा सकता है. अगर आपको आने वाले समय में, अपने Google Workspace संगठन के बाहर इस्तेमाल करने के लिए कोई ऐप्लिकेशन बनाना है, तो आपको उपयोगकर्ता का टाइप बदलकर बाहरी करना होगा. इसके बाद, अपने ऐप्लिकेशन के लिए ज़रूरी अनुमति के स्कोप जोड़ें. ज़्यादा जानने के लिए, OAuth की सहमति कॉन्फ़िगर करना गाइड पढ़ें.

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. id और comments कॉलम में टेक्स्ट डेटा जोड़ें. Kaggle से, छुट्टी के दौरान किराए पर दी जाने वाली प्रॉपर्टी की समीक्षाओं के सैंपल का इस्तेमाल किया जा सकता है. इसके अलावा, अपने डेटा का भी इस्तेमाल किया जा सकता है. अगर ज़रूरी हो, तो और कॉलम जोड़े जा सकते हैं. हालांकि, स्क्रिप्ट को सही तरीके से चलाने के लिए, id और comments कॉलम में डेटा होना चाहिए.

स्क्रिप्ट चलाना

  1. स्प्रेडशीट में सबसे ऊपर, Sentiment Tools > Mark entities and sentiment पर क्लिक करें. इस कस्टम मेन्यू को देखने के लिए, आपको पेज रीफ़्रेश करना पड़ सकता है.
  2. जब आपसे कहा जाए, तब स्क्रिप्ट को अनुमति दें. अगर OAuth की सहमति वाली स्क्रीन पर, इस ऐप्लिकेशन की पुष्टि नहीं हुई है चेतावनी दिखती है, तो ऐडवांस > {Project Name} पर जाएं (सुरक्षित नहीं है) को चुनकर जारी रखें.

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

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

कोड की समीक्षा करना

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

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

Code.gs

solutions/automations/feedback-sentiment-analysis/code.js
// 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 Experts की मदद से मैनेज करता है.

अगले चरण