ניתוח הסנטימנט של משוב באמצעות Google Cloud Natural Language API

רמת הקידוד: בינונית
משך הזמן: 20 דקות
סוג הפרויקט: אוטומציה עם תפריט בהתאמה אישית

מטרות

להבין מה הפתרון עושה.
הסבר על הפעולות של שירותי Apps Script בפתרון.
מגדירים את הסביבה.
מגדירים את הסקריפט.
מריצים את הסקריפט.

מידע על הפתרון הזה

אתם יכולים לנתח כמויות גדולות של נתוני טקסט, כמו משוב פתוח. כדי לבצע ניתוח של ישויות וסנטימנט מתוך Google Sheets, הפתרון הזה משתמש בשירות UrlFetch כדי להתחבר אל Google Cloud Natural Language API.

איור שמראה איך ניתוח סנטימנטים פועל

איך זה עובד

הסקריפט אוסף טקסט מהגיליון האלקטרוני ומתחבר אל Google Cloud Natural Language API כדי לנתח את היישויות והסנטימנט שמופיעים במחרוזת. טבלת צירים מסכמת את ציון הסנטימנט הממוצע של כל ישות שהוזכרה בכל השורות של נתוני הטקסט.

שירותי Apps Script

הפתרון הזה משתמש בשירותים הבאים:

שירות גיליון אלקטרוני: שולח את נתוני הטקסט אל Google Cloud Natural Language API ומסמן כל שורה כ'הושלם' אחרי ניתוח הסנטימנט שלה.
שירות UrlFetch: מתחבר אל Cloud Natural Language API כדי לבצע ניתוח של ישויות ושל סנטימנט בטקסט.

דרישות מוקדמות

כדי להשתמש בדוגמה הזו, אתם צריכים לעמוד בדרישות המוקדמות הבאות:

חשבון Google (יכול להיות שחשבונות Google Workspace ידרשו אישור אדמין).
דפדפן אינטרנט עם גישה לאינטרנט.
פרויקט בענן של Google עם חשבון לחיוב שמשויך אליו. אפשר להיעזר במאמר הפעלת החיוב בפרויקט.

הגדרת הסביבה

כדי להשתמש בפתרון הזה, צריך להשלים את שלבי ההגדרה הבאים.

פותחים את פרויקט בענן במסוף Google Cloud

אם הוא לא פתוח, פותחים את פרויקט בענן שבו רוצים להשתמש בדוגמה הזו:

נכנסים לדף Select a project במסוף Google Cloud.
בוחרים פרויקט בענן
בוחרים את הפרויקט בענן של Google שבו רוצים להשתמש. לחלופין, לוחצים על Create project ופועלים לפי ההוראות במסך. אם יוצרים פרויקט ב-Google Cloud, יכול להיות שיהיה צורך להפעיל את החיוב בפרויקט.

הפעלת Google Cloud Natural Language API

הפתרון הזה מתחבר ל-Google Cloud Natural Language API. לפני שאתם משתמשים בממשקי Google API, אתם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.

בפרויקט בענן, מפעילים את Google Cloud Natural Language API.

הפעלת ה-API

מגדירים את מסך ההסכמה של OAuth

הפתרון הזה דורש פרויקט בענן עם מסך הסכמה מוגדר. הגדרת מסך ההסכמה ל-OAuth מגדירה מה Google מציגה למשתמשים ורושמת את האפליקציה כדי שתוכלו לפרסם אותה מאוחר יותר.

במסוף Google Cloud, עוברים אל תפריט > Google Auth platform > Branding.
מעבר לדף Branding
אם כבר הגדרתם את Google Auth platform, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטעים Branding,‏ Audience וData Access. אם מופיעה ההודעה Google Auth platform not configured yet, לוחצים על Get Started:

בקטע App Information בשדה App name, מזינים שם לאפליקציה.
בקטע User support email, בוחרים כתובת אימייל לתמיכה שאליה משתמשים יפנו אם יש להם שאלות לגבי ההסכמה שלהם.
לוחצים על Next.
בקטע Audience, לוחצים על Internal.
לוחצים על Next.
בקטע Contact Information, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
לוחצים על Next.
בקטע Finish, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, סמנו את התיבה I agree to the Google API Services: User Data Policy.
לוחצים על Continue.
לוחצים על Create.

כרגע אתם יכולים לדלג על הוספת היקפי הרשאות. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון שלכם ב-Google Workspace, תצטרכו לשנות את סוג המשתמש ל-External. לאחר מכן מוסיפים את היקפי ההרשאות שהאפליקציה דורשת. למידע נוסף, אפשר לעיין במדריך המלא בנושא הגדרת הסכמה ל-OAuth.

קבלת מפתח API ל-Google Cloud Natural Language API

נכנסים למסוף Google Cloud. מוודאים שהפרויקט שמוגדר בו חיוב פתוח.
במסוף Google Cloud, לוחצים על סמל התפריט > APIs & Services ‏> Credentials.

כניסה לדף Credentials
לוחצים על Create credentials > API key.
חשוב לשמור את מפתח ה-API כי תצטרכו אותו בשלב מאוחר יותר.

הגדרת הסקריפט

כדי להגדיר את הסקריפט:

יצירת פרויקט Apps Script

לוחצים על הלחצן הבא כדי ליצור עותק של גיליון אלקטרוני לדוגמה של ניתוח סנטימנטים של משוב. פרויקט Apps Script של הפתרון הזה מצורף לגיליון האלקטרוני.

יצירת עותק
לוחצים על תוספים > Apps Script.
מעדכנים את המשתנה הבא בקובץ הסקריפט עם מפתח ה-API:
```
const myApiKey = 'YOUR_API_KEY'; // Replace with your API key.
```
לוחצים על סמל השמירה .

הוספת נתוני טקסט

חוזרים לגיליון האלקטרוני.
מוסיפים נתוני טקסט לעמודות id וcomments. אתם יכולים להשתמש בדוגמאות לביקורות על נכסי נופש מ-Kaggle או להשתמש בנתונים שלכם. אפשר להוסיף עוד עמודות לפי הצורך, אבל כדי שהסקריפט יפעל בהצלחה, צריך להזין נתונים בעמודות id ו-comments.

הפעלת הסקריפט

בחלק העליון של הגיליון האלקטרוני, לוחצים על Sentiment Tools (כלים לניתוח סנטימנטים) > Mark entities and sentiment (סימון ישויות וסנטימנטים). יכול להיות שתצטרכו לרענן את הדף כדי שהתפריט המותאם אישית יופיע.
כשמוצגת בקשה, מאשרים את הסקריפט. <<../_snippets/oauth.md>>
לוחצים על Sentiment Tools (כלים לניתוח סנטימנט) > Mark entities and sentiment (סימון ישויות וסנטימנט) שוב.
כשהסקריפט יסיים את הפעולה, עוברים לגיליון Pivot Table כדי לראות את התוצאות.

בדיקת הקוד

כדי לבדוק את קוד 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.
const 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
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const dataSheet = ss.getSheetByName("Review Data");
  const rows = dataSheet.getDataRange();
  const numRows = rows.getNumRows();
  const values = rows.getValues();
  const 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.
  const entitySheet = ss.getSheetByName("Entity Sentiment Data");
  if (entitySheet == null) {
    ss.insertSheet("Entity Sentiment Data");
    const entitySheet = ss.getSheetByName("Entity Sentiment Data");
    const esHeaderRange = entitySheet.getRange(1, 1, 1, 6);
    const 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.
  const textColumnIdx = headerRow.indexOf(COLUMN_NAME.COMMENTS);
  const entityColumnIdx = headerRow.indexOf(COLUMN_NAME.ENTITY);
  const 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) {
    const value = values[i];
    const commentEnCellVal = value[textColumnIdx];
    const entityCellVal = value[entityColumnIdx];
    const reviewId = value[idColumnIdx];

    // Calls retrieveEntitySentiment function for each row that has a comment
    // and also an empty entity_sentiment cell value.
    if (commentEnCellVal && !entityCellVal) {
      const nlData = retrieveEntitySentiment(commentEnCellVal);
      // Pastes each entity and sentiment score into Entity Sentiment Data sheet.
      const newValues = [];
      for (let entity in nlData.entities) {
        entity = nlData.entities[entity];
        const 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) {
  const apiKey = myApiKey;
  const apiEndpoint = `https://language.googleapis.com/v1/documents:analyzeEntitySentiment?key=${apiKey}`;
  // Creates a JSON request, with text string, language, type and encoding
  const 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.
  const nlOptions = {
    method: "post",
    contentType: "application/json",
    payload: JSON.stringify(nlData),
  };
  // Makes the API call.
  const response = UrlFetchApp.fetch(apiEndpoint, nlOptions);
  return JSON.parse(response);
}

תורמים

הדוגמה הזו מתוחזקת על ידי Google בעזרת מומחי Google לפיתוח.

ניתוח הסנטימנט של משוב באמצעות Google Cloud Natural Language API קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.