תחילת העבודה עם Perspective API

תחילת העבודה עם Perspective API

מידע על Codelab זה

העדכון האחרון: מרץ 10, 2022

נכתב על ידי Jigsaw

1.‏ לפני שמתחילים

Perspective API הוא ממשק API חינמי שעוזר לכם לארח שיחות טובות יותר באינטרנט. ה-API משתמש בלמידה חישובית (ML) כדי לנתח מחרוזת טקסט ולחזות את ההשפעה האפשרית שלה על השיחה.

ב-codelab הזה עליכם להגדיר Perspective API.

הערה: פרספקטיבה API נועדה להקל על ניהול התוכן. הוא לא נועד להחליף לחלוטין את עבודתם של מקבלי החלטות אנושיים.

מה תלמדו

• גישה מבוססת AI לניהול שמסמנים תוכן ברגע שבו נוצר.

מה תצטרך להכין

• חשבון Google לגישה ל-Google Cloud
• מהירות אינטרנט סבירה

2.‏ כדי להתחיל:

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

1. ב-Google Cloud Console, משתמשים בפרויקט קיים.
2. אם צריך, פועלים לפי השלבים הבאים כדי ליצור פרויקט חדש:

• נכנסים באמצעות חשבון Google.
• פותחים את Cloud Console.
• לוחצים על יצירת פרויקט או פותחים את התפריט בחירת פרויקט ולוחצים על פרויקט חדש בתיבת הדו-שיח.
• נותנים שם לפרויקט ולוחצים על יצירה.

הפרויקט מופיע עכשיו בתפריט הנפתח.

בקשת גישה ל-API

• כדי לבקש גישה ל-API, יש למלא את הטופס הזה.

תוך שעה, תקבלו הודעת אימייל המאשרת שאתם יכולים להציג את ה-API ולהפעיל אותו ב-Google Cloud.

הערה: אם לא קיבלת הודעת אימייל תוך יום עסקים אחד, עליך למלא את הטופס שוב או לפנות לצוות התמיכה.

3.‏ הפעלת ה-API

• ב-Cloud Console, מנווטים לדף סקירה כללית של פרספקטיבה API ואז לוחצים על הפעלה.

4.‏ יצירת מפתח ה-API

1. בתפריט הניווט, לוחצים על APIs & Services > Credentials > Create Login > API Key.

הערה: אם שולחים בקשות בשפה בצד הלקוח כמו JavaScript, מפתח ה-API שלכם חשוף לכל המבקרים. מומלץ מאוד להטמיע את הבקשה דרך שרת ולהחיל הגבלות מפתח כדי שהמפתח יוסתר בדפדפנים, ורק השרת יוכל להשתמש במפתח הזה. לקבלת מידע נוסף, ראו דוגמה לאופן השימוש בשרת proxy באמצעות שרת והמלצות אבטחה נוספות למפתח API.

מפתח ה-API שלך אמור לפעול בעוד מספר דקות. עם זאת, הוא עשוי להימשך עד שעה. עד אז, ייתכן שתקבלו הודעת שגיאה.

2. מעתיקים את מפתח ה-API.

5.‏ בקשות לדוגמה

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

1. שלח בקשה AnalyzeComment.
2. מריצים אחת מקריאות ה-API לדוגמה האלה כדי לקבל ציונים ישירות מ-Perspective API.

השיטה AnalyzeComment שולחת בקשת API לניתוח שדה comment.text עבור requestedAttributes, במקרה הזה המודל TOXICITY.

3. מדביקים את מפתח ה-API בשדה API_KEY.

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

4. בתיעוד של ההפניה ל-API ניתן למצוא פרטים על כל שדות הבקשה והתשובות, וכן את הערכים הזמינים עבור requestedAttributes.

יש גם מאפיינים ניסיוניים, כמו OBSCENE , ATTACK_ON_COMMENTER ו-SPAM שבהם אפשר להשתמש גם.

Python

הבקשה והתגובה לדוגמה האלה משתמשות בגרסת Python של ספריות הלקוח של Google API.

1. להתקין את ספריית הלקוחות של Python.
2. מריצים את הפקודות הבאות:

אתם אמורים לראות משהו כמו הפלט הזה:

הברכה הידידותית שלך קיבלה ציון נמוך של רעילות.

Node.js

הבקשה והתגובה לדוגמה האלה משתמשות בגרסת Node.js של ספריות הלקוח ב-Google API.

1. מתקינים את ספריית הלקוח של Node.js או מתקינים את חבילת npm googleapis.
2. מריצים את הפקודות הבאות:

אתם אמורים לראות משהו כמו הפלט הזה:

cURL

הבקשה והתגובה לדוגמה האלה משתמשים בפקודה cURL. פקודה זו אמורה לפעול ברוב משתמשי MacOS ו-Linux. ייתכן שתצטרכו להתקין את cURL כדי להריץ את הפקודה הזו.

• מחליפים את YOUR_KEY_HERE במפתח ה-API.

בתגובה זו, השדה attributeScores.TOXICITY.summaryScore.value נותן את ציון הרגישות של מודל התגובה. התגובה קיבלה 0.9 מתוך 1.0.

6.‏ מזל טוב

הפעלת את Perspective API!

מידע נוסף

• האתר של Perspective API מכיל מידע נוסף על ה-API, כולל מקרים לדוגמה.
• האתר של Perspective API למפתחים מכיל מידע נוסף על מאפיינים, שפות ושיטות. אם אתם רוצים להתחיל במהירות, בדף שיטות מוסבר איך להשתמש בשיטות AnalyzeComment ו-SuggestCommentScore.