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

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

मकसद

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

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

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

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

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

Apps Script की सेवाएं

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

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

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

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

• 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 में, मेन्यू menu > एपीआई और सेवाएं > OAuth की सहमति वाली स्क्रीन पर जाएं.

   OAuth की सहमति वाली स्क्रीन पर जाना

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

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

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

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

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

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

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

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 से छुट्टियों के लिए उपलब्ध प्रॉपर्टी की समीक्षाओं के सैंपल का इस्तेमाल किया जा सकता है या अपने डेटा का इस्तेमाल किया जा सकता है. ज़रूरत पड़ने पर, ज़्यादा कॉलम जोड़े जा सकते हैं. हालांकि, स्क्रिप्ट को सही तरीके से चलाने के लिए, आईडी और टिप्पणियां कॉलम में डेटा होना ज़रूरी है.

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

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

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

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

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

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

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

// 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 की मदद से मैनेज करता है.

अगले चरण

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