מענה על שאלות משיחות ב-Chat באמצעות אפליקציית Gemini AI Chat

במדריך הזה תלמדו איך ליצור אפליקציה ל-Google Chat שתענה על שאלות על סמך שיחות במרחבים משותפים ב-Chat באמצעות AI גנרטיבי שמבוסס על Vertex AI עם Gemini. אפליקציית Chat משתמשת ב-Google Workspace Event API וגם ב-Pub/Sub כדי לזהות שאלות שמתפרסמות במרחבי Chat ולענות עליהן בזמן אמת, גם אם לא מזכירים אותן.

אפליקציית Chat משתמשת בכל ההודעות שנשלחות במרחב המשותף כמקור נתונים ומאגר ידע: כשמישהו שואל שאלה, אפליקציית Chat בודקת אם יש תשובות ששותפו בעבר ואז משתפת אחת מהן. אם לא נמצאה תשובה, יופיע הכיתוב 'לא ניתן לענות'. בכל תשובה, המשתמשים יכולים ללחוץ על לחצן פעולה נוסף כדי להזכיר את מנהל המרחב המשותף ולבקש תשובה. בעזרת Gemini AI, אפליקציית Google Chat מתאימה את עצמה ומרחיבה את מאגר הידע שלה תוך כדי אימון על שיחות במרחבים משותפים שאליהם מצרפים אותה.

כך פועלת אפליקציית Chat בסביבת קליטת עובדים ותמיכה:

  • אם כוללים אזכור של אפליקציית העוזר הדיגיטלי ב-AI, היא תתווסף למרחב המשותף.
    איור 1. צ'רלי מוסיף את אפליקציית Chat, העוזרת הדיגיטלית של AI, למרחב ב-Chat.
  • דנה שואלת שאלה.
    איור 2. דנה שואלת אם החברה מציעה הכשרה לנאום ציבורי.
  • אפליקציית Chat עם עוזרת ה-AI עונה על השאלה.
    איור 3. באפליקציית Chat של עוזר המידע מבוסס-AI מוצגת הנחיה של Vertex AI עם Gemini לענות על שאלה של דנה על סמך היסטוריית השיחות של המרחב המשותף ב-Chat, ואז היא משתפת את התשובה.

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

מטרות

  • אתם יכולים לפתח אפליקציה ל-Chat שמשתמשת ב-AI גנרטיבי כדי לענות על שאלות על סמך ידע ששותף בשיחות במרחב ב-Chat.
  • בעזרת AI גנרטיבי:
    • זיהוי של שאלות של עובדים ותשובות עליהן.
    • לקבל מידע חדש משיחות מתמשכות במרחבים משותפים ב-Chat.
  • מקשיבים להודעות ומגיבים להן במרחבים ב-Chat בזמן אמת, גם בלי הודעות ישירות מאפליקציית Chat.
  • כותבים הודעות למסד נתונים של Firestore וקוראים ממנו הודעות.
  • אתם יכולים להזכיר למנהלים של המרחב המשותף אם לא נמצאה תשובה לשאלה מסוימת, כדי להקל על שיתוף הפעולה במרחבים המשותפים ב-Chat.

ארכיטקטורה

בתרשים הבא מוצגת הארכיטקטורה של משאבי Google Workspace ו-Google Cloud שבהם משתמשת אפליקציית Chat עם העוזרת הווירטואלית מבוססת-ה-AI.

תרשים הארכיטקטורה של אפליקציית צ'אטבוט התמיכה מבוססת-AI ב-Chat

כך פועלת אפליקציית Chat עם AI:

  • משתמש מוסיף את אפליקציית Chat עם העוזר הדיגיטלי מבוסס-AI למרחב משותף ב-Chat:

    1. אפליקציית Chat מבקשת מהמשתמשים שהוסיפו אותה למרחב ב-Chat להגדיר אימות והרשאה.

    2. אפליקציית Chat מאחזרת את ההודעות במרחב המשותף על ידי קריאה ל-method‏ spaces.messages.list ב-Chat API, ולאחר מכן מאחסנת את ההודעות שאוחזרו במסד נתונים של Firestore.

    3. אפליקציית Chat מפעילה את השיטה subscriptions.create ב-Google Workspace Event API כדי להתחיל להאזין לאירועים כמו הודעות במרחב המשותף. נקודת הקצה של ההתראות במינוי היא נושא Pub/Sub שבו מתבצע שימוש ב-Eventarc כדי להעביר את האירוע לאפליקציית Chat.

    4. אפליקציית Chat מפרסמת הודעת היכרות למרחב המשותף.

  • משתמש במרחב משותף ב-Chat מפרסם הודעה:

    1. אפליקציית Chat מקבלת את ההודעה בזמן אמת מהנושא Pub/Sub.

    2. אפליקציית Chat מוסיפה את ההודעה למסד הנתונים של Firestore.

      אם המשתמש עורך או מוחק את ההודעה מאוחר יותר, אפליקציית Chat מקבלת את האירוע המעודכן או המחוק בזמן אמת, ולאחר מכן מעדכנת או מוחקת את ההודעה במסד הנתונים של Firestore.

    3. אפליקציית Chat שולחת את ההודעה ל-Vertex AI באמצעות Gemini:

      1. ההנחיה מנחה את Vertex AI עם Gemini לבדוק אם ההודעה כוללת שאלה. אם כן, Gemini יענה על השאלה על סמך היסטוריית ההודעות של המרחב ב-Chat שנשמרה ב-Firestore ובאפליקציית Google Chat, ואז שולח את ההודעה למרחב המשותף ב-Chat. אם לא, אל תשיבו להודעה.

      2. אם מערכת Vertex AI עם Gemini עונה על השאלה, אפליקציית Chat מפרסמת את התשובה באמצעות קריאה לשיטה spaces.messages.create ב-Chat API באמצעות אימות האפליקציה.

        אם לא תהיה אפשרות לענות על השאלה הזו ב-Vertex AI עם Gemini, אפליקציית Chat תפורסם הודעה שבה יצוין שהיא לא יכולה למצוא תשובה לשאלה הזו בהיסטוריה של המרחב ב-Chat.

        ההודעות תמיד כוללות לחצן פעולה אביזר שהמשתמשים יכולים ללחוץ עליו, וגורם לאפליקציית Chat לאזכר באמצעות @מנהל/ת של המרחב המשותף ולבקש ממנו לענות.

  • אפליקציית Chat מקבלת התראה על מחזור חיים מ-Google Workspace Events API על כך שפג התוקף של המינוי למרחב המשותף ב-Chat:

    1. אפליקציית Chat שולחת בקשה לחדש את המינוי באמצעות קריאה ל-method‏ subscriptions.patch ב-Google Workspace Events API.
  • אנחנו מסירים את אפליקציית Chat מהמרחב המשותף ב-Chat:

    1. אפליקציית Chat מוחקת את המינוי על-ידי שליחת קריאה ל-method subscriptions.delete ב-Google Workspace Event API.

    2. אפליקציית Chat מוחקת את הנתונים של המרחב המשותף ב-Chat מ-Firestore.

בדיקת המוצרים שבהם משתמשת אפליקציית העוזר הדיגיטלי ל-AI ב-Chat

אפליקציית Chat של העוזר הדיגיטלי מבוסס ה-AI משתמשת במוצרים הבאים של Google Workspace ו-Google Cloud:

  • Vertex AI API עם Gemini: פלטפורמה של AI גנרטיבי שמבוססת על Gemini. אפליקציית הצ'אט עם עוזרת הידע מבוססת-ה-AI משתמשת ב-Vertex AI API עם Gemini כדי לזהות, להבין ולענות על שאלות של עובדים.
  • Chat API: ממשק API לפיתוח אפליקציות ב-Google Chat שמקבלות אירועי אינטראקציה ב-Chat ומגיבות להם, כמו הודעות. אפליקציית Chat עם העוזרת הווירטואלית מבוססת-ה-AI משתמשת ב-Chat API כדי:
    • לקבל אירועי אינטראקציה שנשלחים מ-Chat ולהגיב להם.
    • הצגת רשימה של ההודעות שנשלחו במרחב המשותף.
    • פרסום תשובות לשאלות של משתמשים במרחבים משותפים.
    • צריך להגדיר את המאפיינים שקובעים איך הוא יופיע ב-Chat, כמו השם ותמונת הדמות.
  • Google Workspace Event API: ה-API הזה מאפשר להירשם לאירועים ולנהל את ההתראות על שינויים בכל האפליקציות של Google Workspace. כדי לזהות שאלות ולענות עליהן גם בלי שציינו את השם שלה, אפליקציית Chat עם העוזר הדיגיטלי מבוסס-ה-AI משתמשת ב-Google Workspace Events API כדי להאזין להודעות שפורסמו במרחבים משותפים ב-Chat.
  • Firestore: מסד נתונים ללא שרת של מסמכים. ב-Chat, העוזר הדיגיטלי מבוסס ה-AI, אפליקציית Chat משתמשת ב-Firestore כדי לאחסן נתונים לגבי ההודעות שנשלחו במרחבים ב-Chat.
  • Pub/Sub:‏ Pub/Sub הוא שירות העברת הודעות אסינכרוני וניתן להתאמה, שמפריד בין שירותים שיוצרים הודעות לבין שירותים שמעבדים את ההודעות האלה. אפליקציית Chat לעזרה ב-AI נעזרת ב-Pub/Sub כדי לקבל אירועים של מינויים ממרחבים ב-Chat.
  • Eventarc:‏ Eventarc מאפשר ליצור ארכיטקטורות מבוססות-אירועים בלי שתצטרכו להטמיע, להתאים אישית או לתחזק את התשתית הבסיסית. אפליקציית Chat ל-Chat יכולה להיעזר ב-Eventarc כדי לנתב אירועים מ-Pub/Sub למרחב משותף ב-Chat ולפונקציה של Cloud Functions שמקבלת ומעבדת את אירועי המינויים.
  • Cloud Functions: שירות מחשוב קל ללא שרת (serverless) שמאפשר ליצור פונקציות עצמאיות למטרה יחידה, שיכולות להגיב לאירועי אינטראקציה ולאירועי הרשמה ב-Chat בלי צורך לנהל שרת או סביבת זמן ריצה. אפליקציית Chat עם עוזרת ה-AI משתמשת בשתי פונקציות של Cloud Functions שנקראות:
    • app: מארח את נקודת הקצה (endpoint) של HTTP שאליה Chat שולח אירועי אינטראקציה, וכפלטפורמת מחשוב להרצת לוגיקה שמעבדת את האירועים האלה ומגיבה להם.
    • eventsApp: מקבל ומעבד אירועים של מרחבים משותפים ב-Chat, כמו הודעות ממינוי ל-Pub/Sub.
    מערכת Cloud Functions משתמשת במוצרי Google Cloud הבאים כדי ליצור ולתת אירוח למשאבי מחשוב:
    • Cloud Build: פלטפורמה מנוהלת לניהול רציף (continuous delivery), להעברה ולפריסה, שמריצה גרסאות build אוטומטיות.
    • Cloud Run: סביבה מנוהלת להרצת אפליקציות בקונטיינרים.

הכנת הסביבה

בחלק הזה נסביר איך יוצרים ומגדירים פרויקט ב-Google Cloud לאפליקציית Chat.

יצירת פרויקט של Google Cloud

מסוף Google Cloud

  1. במסוף Google Cloud, נכנסים לתפריט > IAM & Admin > יצירת פרויקט.

    כניסה לדף Create a Project

  2. בשדה Project Name (שם הפרויקט), מזינים שם תיאורי לפרויקט.

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

  3. בשדה Location, לוחצים על Browse כדי להציג מיקומים פוטנציאליים לפרויקט. לאחר מכן לוחצים על בחירה.
  4. לוחצים על יצירה. נכנסים לדף Dashboard במסוף Google Cloud והפרויקט נוצר תוך כמה דקות.

CLI של gcloud

ניגשים ל-CLI של Google Cloud (gcloud) באחת מסביבות הפיתוח הבאות:

  • Cloud Shell: כדי להשתמש בטרמינל אונליין שבו כבר מוגדר ה-CLI של gcloud, צריך להפעיל את Cloud Shell.
    הפעלת Cloud Shell
  • מעטפת מקומית: כדי להשתמש בסביבת פיתוח מקומית צריך להתקין ולהפעיל את ה-CLI של gcloud.
    כדי ליצור פרויקט ב-Cloud, משתמשים בפקודה gcloud projects create:
    gcloud projects create PROJECT_ID
    מחליפים את PROJECT_ID על ידי הגדרת המזהה של הפרויקט שרוצים ליצור.

הפעלת החיוב בפרויקט ב-Cloud

מסוף Google Cloud

  1. נכנסים לקטע Billing במסוף Google Cloud. לוחצים על תפריט > חיוב > My Projects.

    כניסה לדף Billing for My Projects

  2. בקטע Select an organization, בוחרים את הארגון שמשויך לפרויקט ב-Google Cloud.
  3. בשורת הפרויקט, פותחים את התפריט Actions (), לוחצים על Change billing ובוחרים את החשבון לחיוב ב-Cloud.
  4. לוחצים על Set account.

CLI של gcloud

  1. כדי להציג רשימה של החשבונות הזמינים לחיוב, מריצים את הפקודה:
    gcloud billing accounts list
  2. קישור חשבון לחיוב לפרויקט ב-Google Cloud:
    gcloud billing projects link PROJECT_ID --billing-account=BILLING_ACCOUNT_ID

    מחליפים את מה שכתוב בשדות הבאים:

    • PROJECT_ID הוא מזהה הפרויקט של הפרויקט ב-Cloud שרוצים להפעיל בו חיוב.
    • BILLING_ACCOUNT_ID הוא מזהה החשבון לחיוב שרוצים לקשר לפרויקט ב-Google Cloud.

הפעלת ממשקי ה-API

מסוף Google Cloud

  1. במסוף Google Cloud, מפעילים את Google Chat API,‏ Vertex AI API,‏ Cloud Functions API,‏ Firestore API,‏ Cloud Build API,‏ Pub/Sub API,‏ Google Workspace Events API,‏ Eventarc API ו-Cloud Run Admin API.

    הפעלת ממשקי ה-API

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

  3. מוודאים שאתם מפעילים את ממשקי ה-API הנכונים ולוחצים על Enable.

CLI של gcloud

  1. אם צריך, מגדירים את הפרויקט הנוכחי ב-Cloud כפרויקט שיצרתם:

    gcloud config set project PROJECT_ID

    מחליפים את PROJECT_ID במזהה הפרויקט של הפרויקט ב-Cloud שיצרתם.

  2. מפעילים את Google Chat API, את Vertex AI API, את Cloud Functions API, את Firestore API, את Cloud Build API, את Pub/Sub API, את Google Workspace Event API, את Eventarc API ואת Cloud Run Admin API:

    gcloud services enable chat.googleapis.com \
    aiplatform.googleapis.com \
    cloudfunctions.googleapis.com \
    firestore.googleapis.com \
    cloudbuild.googleapis.com \
    pubsub.googleapis.com \
    workspaceevents.googleapis.com \
    eventarc.googleapis.com \
    run.googleapis.com

הגדרת אימות והרשאה

אימות והרשאה מאפשרים לאפליקציית Chat לגשת למשאבים ב-Google Workspace וב-Google Cloud.

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

  1. במסוף Google Cloud, נכנסים אל תפריט > APIs & Services> OAuth consent screen.

    מעבר למסך ההסכמה ל-OAuth

  2. בקטע סוג משתמש, בוחרים באפשרות פנימי ולוחצים על יצירה.

  3. בשדה App name, מקלידים AI knowledge assistant.

  4. בקטע User support email, בוחרים את כתובת האימייל שלכם או קבוצת Google מתאימה.

  5. בקטע פרטים ליצירת קשר עם המפתח, מזינים את כתובת האימייל שלכם.

  6. לוחצים על שמירה והמשך.

  7. לוחצים על הוספה או הסרה של היקפי הרשאות. תופיע חלונית עם רשימת היקפים לכל API שהפעלתם בפרויקט ב-Cloud.

  8. בקטע הוספת היקפים באופן ידני, מדביקים את ההיקף הבא:

    • https://www.googleapis.com/auth/chat.messages
  9. לוחצים על הוספה לטבלה.

  10. לוחצים על עדכון.

  11. לוחצים על שמירה והמשך.

  12. מעיינים בסיכום הרישום של האפליקציה ולוחצים על חזרה למרכז השליטה.

יצירת פרטי כניסה למזהה הלקוח ב-OAuth

  1. במסוף Google Cloud, נכנסים אל תפריט > APIs & Services > Credentials.

    כניסה לדף Credentials

  2. לוחצים על Create Credentials (יצירת פרטי כניסה) > OAuth client ID (מזהה לקוח OAuth).

  3. לוחצים על Application type > Web application.

  4. בשדה Name, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.

  5. בקטע URIs מורשים להפניה אוטומטית, לוחצים על Add URI (הוספת URI).

  6. בקטע URIs 1, מקלידים את הטקסט הבא:

    https://REGION-PROJECT_ID.cloudfunctions.net/app/oauth2
    

    מחליפים את מה שכתוב בשדות הבאים:

    • REGION: האזור של הפונקציה של Cloud Functions, כמו us-central1. בהמשך, כשיוצרים את שתי הפונקציות של Cloud Functions, צריך להגדיר את האזור שלהן לערך הזה.
    • PROJECT_ID: מזהה הפרויקט של הפרויקט ב-Cloud שיצרתם.
  7. לוחצים על יצירה.

  8. בחלון OAuth client created, לוחצים על Download JSON.

  9. שומרים את הקובץ שהורדתם בתור client_secrets.json. לאחר מכן, כשיוצרים את שתי הפונקציות של Cloud Functions, כוללים את הקובץ client_secrets.json בכל פריסה.

  10. לוחצים על אישור.

יצירת הנושא Pub/Sub

הנושא Pub/Sub פועל עם Google Workspace Events API כדי להירשם לאירועים במרחב משותף ב-Chat, כמו הודעות, ולשלוח התראות לאפליקציית Chat בזמן אמת.

כך יוצרים נושא Pub/Sub:

מסוף Google Cloud

  1. במסוף Google Cloud, עוברים אל תפריט > Pub/Sub.

    כניסה ל-Pub/Sub

  2. לוחצים על יצירת נושא.

  3. במזהה הנושא, מקלידים events-api.

  4. מבטלים את הבחירה באפשרות הוספת מינוי ברירת מחדל.

  5. בקטע Encryption, בוחרים באפשרות Google-managed encryption key.

  6. לוחצים על יצירה. הנושא Pub/Sub יופיע.

  7. כדי שנושא Pub/Sub הזה יפעל יחד עם Google Workspace Events API, צריך לתת למשתמש IAM ב-Chat הרשאה לפרסם בנושא Pub/Sub:

    1. בחלונית events-api, בקטע PERMISSIONS, לוחצים על Add Principal.

    2. בקטע Add principals, מקלידים chat-api-push@system.gserviceaccount.com בקטע New principals.

    3. בקטע הקצאת תפקידים, בקטע בחירת תפקיד, בוחרים באפשרות Pub/Sub > פרסום הודעות ב-Pub/Sub.

    4. לוחצים על שמירה.

CLI של gcloud

  1. יוצרים נושא Pub/Sub עם מזהה הנושא events-api:

    gcloud pubsub topics create events-api
  2. מעניקים למשתמש IAM ב-Chat הרשאה לפרסם בנושא Pub/Sub:

    gcloud pubsub topics add-iam-policy-binding events-api \
    --member='serviceAccount:chat-api-push@system.gserviceaccount.com' \
    --role='roles/pubsub.publisher'

יצירת מסד הנתונים של Firestore

מסד הנתונים של Firestore שומר ומאחזר נתונים ממרחבים משותפים ב-Chat, כמו הודעות. לא מגדירים את מודל הנתונים, שהוא מוגדר באופן משתמע בקוד לדוגמה באמצעות הקבצים model/message.js ו-services/firestore-service.js.

במסד הנתונים של אפליקציית Chat לעזרה ב-AI נעשה שימוש במודל נתונים של NoSQL שמבוסס על מסמכים שמסודרים ב אוספים. למידע נוסף, ראו מודל נתוני Firestore.

בתרשים הבא מוצגת סקירה כללית של מודל הנתונים של אפליקציית Chat במסגרת העוזר הדיגיטלי מבוסס ה-AI:

מודל הנתונים של מסד הנתונים ב-Firestore.

הרמה הבסיסית (root) מכילה שני אוספים:

  1. spaces, כשכל מסמך מייצג מרחב ב-Chat שאליו מתווספת אפליקציית Chat. כל הודעה מיוצגת על ידי מסמך באוסף המשנה messages.

  2. users, שבו כל מסמך מייצג משתמש שהוסיף את אפליקציית Chat למרחב משותף ב-Chat.

הצגת הגדרות של אוספים, מסמכים ושדות

spaces

מרחב משותף ב-Chat שכולל את אפליקציית Chat עם העוזר הדיגיטלי מבוסס-AI.

שדות
Document IDString
מזהה ייחודי של מרחב ספציפי. חלק משם המשאב של המרחב המשותף ב-Chat API.
messagesSubcollection of Documents (messages)
הודעות שנשלחו במרחב ב-Chat. תואם ל-Document ID של message ב-Firebase.
spaceNameString
השם הייחודי של המרחב ב-Chat API. תואם לשם המשאב של המרחב המשותף ב-Chat API.

messages

הודעות שנשלחו במרחב ב-Chat.

שדות
Document IDString
המזהה הייחודי של הודעה ספציפית.
nameString
השם הייחודי של הודעה ב-Chat API. תואם לשם המשאב של ההודעה ב-Chat API.
textString
גוף הטקסט של ההודעה.
timeString (Timestamp format)
השעה שבה ההודעה נוצרה.

users

משתמשים שהוסיפו את אפליקציית Chat עם העוזרת הווירטואלית מבוססת-ה-AI למרחב משותף ב-Chat.

שדות
Document IDString
מזהה ייחודי של משתמש ספציפי.
accessTokenString
אסימון הגישה שהוענק במהלך הרשאת משתמש ב-OAuth 2.0 המשמש לקריאה לממשקי ה-API של Google Workspace.
refreshTokenString
אסימון הרענון הוענק במהלך הרשאת משתמש ב-OAuth 2.0.

כך יוצרים את מסד הנתונים של Firestore:

מסוף Google Cloud

  1. במסוף Google Cloud, נכנסים אל תפריט > Firestore.

    כניסה אל Firestore

  2. לוחצים על Create database.

  3. בקטע Select your Firestore mode, לוחצים על Native mode.

  4. לוחצים על המשך.

  5. מגדירים את מסד הנתונים:

    1. בקטע Name your מסד הנתונים, משאירים את Database ID (מזהה מסד הנתונים) בתור (default).

    2. בקטע סוג מיקום, בוחרים באפשרות אזור.

    3. בקטע Region, מציינים אזור למסד הנתונים, למשל us-central1. כדי לקבל את הביצועים הטובים ביותר, כדאי לבחור את המיקום של Cloud Functions של אפליקציית Chat או מיקום קרוב אליו.

  6. לוחצים על Create dataset.

CLI של gcloud

  • יוצרים מסד נתונים של Firestore במצב Native:

    gcloud firestore databases create \
    --location=LOCATION \
    --type=firestore-native

    מחליפים את LOCATION בשם של אזור ב-Firestore, למשל us-central1. כדי לקבל את הביצועים הטובים ביותר, כדאי לבחור את אותו מיקום או מיקום קרוב למיקום של Cloud Functions של אפליקציית Chat.

יצירה ופריסה של אפליקציית Chat

עכשיו, אחרי שיצרתם והגדרתם את הפרויקט ב-Google Cloud, אתם מוכנים ליצור ולפרוס את אפליקציית Chat, ואז תוכלו לבצע את הפעולות הבאות:

  1. יצירה ופריסה של שתי פונקציות ב-Cloud Functions. אחד כדי להגיב לאירועי אינטראקציה ב-Chat, והשני כדי להגיב לאירועי Pub/Sub.
  2. יוצרים ופורסים אפליקציית Chat בדף ההגדרה של Google Chat API.

יצירה ופריסה של פונקציות ב-Cloud Functions

בקטע הזה, יוצרים ופורסים שתי פונקציות של Cloud Functions בשם:

  • app: מארח ומריץ את הקוד של אפליקציית Chat, שמגיב לאירועים שמתקבלים מ-Chat כבקשות HTTP.
  • eventsApp: מקבל ומעבד אירועים במרחבים משותפים ב-Chat, כמו הודעות מ-Pub/Sub.

ה-Cloud Functions האלה ביחד מהווים את הלוגיקה של אפליקציית Chat ל'עוזר דיגיטלי מבוסס-AI'.

לפני שיוצרים את Cloud Functions, מומלץ להקדיש כמה רגעים כדי ללמוד ולהבין את הקוד לדוגמה שמתארח ב-GitHub.

הצגת הקוד ב-GitHub

יצירה ופריסה של app

מסוף Google Cloud

  1. מורידים את הקוד מ-GitHub כקובץ ZIP.

    הורדת קובץ ה-ZIP

  2. מחלצים את קובץ ה-ZIP שהורדתם.

    התיקייה שחולצה מכילה את כל מאגר הדוגמאות של Google Workspace.

  3. בתיקייה שחולצה, עוברים לספרייה google-chat-samples-main/node/ai-knowledge-assistant.

  4. בתיקייה google-chat-samples/node/ai-knowledge-assistant, מוסיפים את הקובץ client_secrets.json שהורדתם כשיצרתם את פרטי הכניסה של מזהה הלקוח ב-OAuth לצורך אימות והרשאה.

  5. מומלץ לדחוס את התוכן של התיקייה ai-knowledge-assistant לקובץ ZIP.

    ספריית הבסיס של קובץ ה-ZIP חייבת להכיל את הקבצים והתיקיות הבאים:

    • .gcloudignore
    • .gitignore
    • README.md
    • deploy.sh
    • env.js
    • events_index.js
    • http_index.js
    • index.js
    • client_secrets.json
    • package-lock.json
    • package.json
    • controllers/
    • model/
    • services/
    • test/
  6. במסוף Google Cloud, נכנסים אל תפריט > Cloud Functions.

    כניסה ל-Cloud Functions

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

  7. לוחצים על Create Function.

  8. בדף Create function, מגדירים את הפונקציה:

    1. ב-Environment (סביבה), בוחרים באפשרות Cloud Run Function.
    2. בשדה Function name, מקלידים app.
    3. בקטע אזור, בוחרים אזור, למשל us-central1. האזור הזה חייב להתאים לאזור שהגדרתם ב-URI להפניה אוטומטית המורשית כשיצרתם את פרטי הכניסה של מזהה הלקוח ב-OAuth לאימות ולהרשאה.
    4. בקטע Trigger type, בוחרים באפשרות HTTPS.
    5. בקטע Authentication, בוחרים באפשרות Allow unauthenticated invocations.
    6. לוחצים על הבא.
  9. בקטע Runtime, בוחרים באפשרות Node.js 20.

  10. בקטע Entry point, מוחקים את טקסט ברירת המחדל ומזינים app.

  11. בקטע קוד מקור, בוחרים באפשרות העלאת מיקוד.

  12. בקטע Destination bucket, יוצרים או בוחרים קטגוריה:

    1. לוחצים על מה מעניין אותך היום?
    2. בוחרים קטגוריה.
    3. לוחצים על בחירה.

    מערכת Google Cloud מעלה את קובץ ה-ZIP ומחלצת את קובצי הרכיבים בקטגוריה הזו. לאחר מכן, Cloud Functions מעתיק את קובצי הרכיבים לפונקציה של Cloud Functions.

  13. בקטע קובץ ZIP, מעלים את קובץ ה-ZIP שהורדתם מ-GitHub, חילצתם ודחסתם מחדש:

    1. לוחצים על מה מעניין אותך היום?
    2. עוברים אל קובץ ה-zip ובוחרים בו.
    3. לוחצים על פתיחה.
  14. לוחצים על פריסת.

    הדף Cloud Functions detail נפתח, והפונקציה מופיעה עם שני מדדי התקדמות: אחד ל-build ואחד לשירות. כששני מדדי ההתקדמות נעלמים ומוחלפים בסימון וי, הפונקציה פרוסה ומוכנה.

  15. עורכים את קוד הדוגמה כדי להגדיר קבועים:

    1. בדף Cloud Functions details, לוחצים על Edit.
    2. לוחצים על הבא.
    3. בקטע קוד מקור, בוחרים באפשרות עורך מוטבע.
    4. בעורך המוטבע, פותחים ועורכים את הקובץ env.js:
      1. מגדירים את הערך של project למזהה הפרויקט ב-Cloud.
      2. מגדירים את הערך של location לאזור של Cloud Function, למשל us-central1.
  16. לוחצים על פריסת.

CLI של gcloud

  1. משכפלים את הקוד מ-GitHub:

    git clone https://github.com/googleworkspace/google-chat-samples.git
  2. תעברו לספרייה שמכילה את הקוד של אפליקציית Chat ל-Chat: של העוזר הדיגיטלי הזה בנושא AI:

    cd google-chat-samples/node/ai-knowledge-assistant
  3. בספרייה google-chat-samples/node/ai-knowledge-assistant, מוסיפים את הקובץ client_secrets.json שהורדתם כשיצרתם פרטי כניסה של מזהה לקוח ב-OAuth לצורך אימות והרשאה.

  4. עורכים את הקובץ env.js כדי להגדיר את משתני הסביבה:

    1. מגדירים את הערך של project לפי מזהה הפרויקט ב-Cloud.
    2. מגדירים את הערך של location לאזור של Cloud Function, למשל us-central1.
  5. פורסים את הפונקציה של Cloud Functions ב-Google Cloud:

    gcloud functions deploy app \
    --gen2 \
    --region=REGION \
    --runtime=nodejs20 \
    --source=. \
    --entry-point=app \
    --trigger-http \
    --allow-unauthenticated

    מחליפים את REGION בערך של האזור של הפונקציה של Cloud Functions, שתואם לערך שהוגדר בקובץ env.js, למשל us-central1.

יצירה ופריסה של eventsApp

מסוף Google Cloud

  1. במסוף Google Cloud, נכנסים אל תפריט > Cloud Functions.

    כניסה ל-Cloud Functions

    מוודאים שבחרתם בפרויקט Google Cloud באפליקציית Chat.

  2. לוחצים על Create Function.

  3. בדף Create function, מגדירים את הפונקציה:

    1. בקטע Environment, בוחרים באפשרות Cloud Run Function.
    2. בשדה Function name, מקלידים eventsApp.
    3. בקטע אזור, בוחרים אזור, למשל us-central1. האזור הזה חייב להתאים לאזור שהגדרתם ב-URI המורשה להפניה אוטומטית כשיצרתם פרטי כניסה של מזהה לקוח ב-OAuth לצורך אימות והרשאה.
    4. בקטע Trigger type בוחרים באפשרות Cloud Pub/Sub.
    5. בנושא Cloud Pub/Sub, בוחרים את שם הנושא ב-Pub/Sub שיצרתם, בפורמט projects/PROJECT/topics/events-api, כאשר PROJECT הוא מזהה הפרויקט ב-Cloud.
    6. אם מופיעה הודעה שמתחילה ב-Service account(s) might not have enough permissions to deploy the function with the selected trigger., לוחצים על Grant All.
    7. לוחצים על הבא.
  4. בקטע Runtime, בוחרים באפשרות Node.js 20.

  5. בקטע Entry point, מוחקים את טקסט ברירת המחדל ומזינים eventsApp.

  6. בקטע Source code (קוד מקור), בוחרים באפשרות Zip from Cloud Storage (מיקוד מ-Cloud Storage).

  7. בקטע המיקום של Cloud Storage, לוחצים על עיון.

  8. בוחרים את הקטגוריה שאליה העליתם את קובץ ה-ZIP כשיצרתם את הפונקציה app של Cloud Functions.

  9. לוחצים על קובץ ה-ZIP שהעליתם.

  10. לוחצים על בחירה.

  11. לוחצים על פריסת.

    הדף Cloud Functions ייפתח, והפונקציה תופיע עם שלושה אינדיקטורים להתקדמות: אחד ל-build, אחד לשירות ואחד לטריגר. כשכל שלושת מדדי ההתקדמות ייעלמו ויוחלפו בסימון וי, הפונקציה תהיה מוכנה לשימוש.

  12. עורכים את קוד הדוגמה כדי להגדיר קבועים:

    1. בדף Cloud Functions details, לוחצים על Edit.
    2. לוחצים על הבא.
    3. בקטע קוד מקור, בוחרים באפשרות עורך מוטבע.
    4. בעורך המוטבע, פותחים ועורכים את הקובץ env.js:
      1. מגדירים את הערך של project לפי מזהה הפרויקט ב-Cloud.
      2. מגדירים את הערך של location לאזור של הפונקציה של Cloud Functions, למשל us-central1.
  13. לוחצים על Deploy (פריסה).

CLI של gcloud

  1. אם אתם עדיין לא שם, ב-CLI של gcloud עוברים לספרייה שמכילה את הקוד של אפליקציית Chat של העוזר הדיגיטלי בנושא AI ששכפולם בעבר מ-GitHub:

    cd google-chat-samples/node/ai-knowledge-assistant
  2. בספרייה google-chat-samples/node/ai-knowledge-assistant, מוסיפים את הקובץ client_secrets.json שהורדתם כשיצרתם פרטי כניסה של מזהה לקוח ב-OAuth לצורך אימות והרשאה.

  3. עורכים את הקובץ env.js כדי להגדיר את משתני הסביבה:

    1. מגדירים את הערך של project למזהה הפרויקט ב-Cloud.
    2. מגדירים את הערך של location לאזור של Cloud Function, למשל us-central1.
  4. פורסים את הפונקציה של Cloud Functions ב-Google Cloud:

    gcloud functions deploy eventsApp \
    --gen2 \
    --region=REGION \
    --runtime=nodejs20 \
    --source=. \
    --entry-point=eventsApp \
    --trigger-topic=events-api

    מחליפים את REGION בערך של האזור של הפונקציה של Cloud Functions, שתואם לערך שהוגדר בקובץ env.js, למשל us-central1.

העתקת כתובת ה-URL לטריגר של הפונקציה של Cloud Functions app

עליכם להדביק את כתובת ה-URL של הטריגר של Cloud Function‏ app בקטע הבא, כשתבצעו את הגדרת אפליקציית Chat במסוף Google Cloud.

מסוף Google Cloud

  1. במסוף Google Cloud, נכנסים אל תפריט > Cloud Functions.

    כניסה אל Cloud Functions

  2. בעמודה Name ברשימה של הפונקציות של Cloud Functions, לוחצים על app.

  3. לוחצים על Trigger (טריגר).

  4. מעתיקים את כתובת ה-URL.

CLI של gcloud

  1. תיאור הפונקציה של Cloud Functions app:

    gcloud functions describe app
  2. מעתיקים את המאפיין url.

איך מגדירים את אפליקציית Chat במסוף Google Cloud

בחלק הזה מוסבר איך מגדירים את ה-API של Chat במסוף Google Cloud בעזרת מידע על אפליקציית Chat, כולל השם של אפליקציית Chat וכתובת ה-URL שמפעילה את הפונקציה של Cloud Functions שאליה היא שולחת אירועי אינטראקציה ב-Chat.

  1. במסוף Google Cloud, לוחצים על תפריט > מוצרים נוספים > Google Workspace > Product Library > Google Chat API > ניהול > הגדרה.

    להגדרת Chat API

  2. בשדה App name, מקלידים AI knowledge assistant.

  3. בשדה כתובת ה-URL של הדמות, מקלידים https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/live_help/default/24px.svg.

  4. בקטע תיאור, מקלידים Answers questions with AI.

  5. מעבירים את המתג הפעלת תכונות אינטראקטיביות למצב פעיל.

  6. בקטע פונקציונליות, בוחרים באפשרות הצטרפות למרחבים משותפים ולשיחות קבוצתיות.

  7. בקטע Connection settings (הגדרות חיבור), בוחרים באפשרות HTTP endpoint URL (כתובת ה-URL של נקודת הקצה ב-HTTP).

  8. בשדה כתובת URL של נקודת קצה מסוג HTTP, מדביקים את כתובת ה-URL של הטריגר מהפונקציה של Cloud Functions‏ app בפורמט https://REGION-PROJECT_ID.cloudfunctions.net/app, כאשר REGION הוא האזור של הפונקציה ב-Cloud, למשל us-central1, ו-PROJECT_ID הוא מזהה הפרויקט של הפרויקט ב-Cloud שיצרתם.

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

  10. לחלופין, בקטע יומנים, בוחרים באפשרות רישום שגיאות ביומן.

  11. לוחצים על שמירה. תוצג הודעה על שמירת ההגדרות, והמשמעות היא שאפליקציית Chat מוכנה לבדיקה.

בדיקת האפליקציה של Chat

אפשר לבדוק את אפליקציית Chat בנושא צ'אטבוט התמיכה מבוסס-AI ב-Chat עם הודעות. פשוט שואלים שאלות שהעוזר הדיגיטלי מבוסס-AI ב-Chat יכול לענות עליהן.

הנה כמה דרכים לבדוק את אפליקציית הצ'אט של העוזר הדיגיטלי מבוסס ה-AI:

  • אפשר להוסיף את אפליקציית Chat לעזרה מ-AI ב-Chat למרחב משותף קיים ב-Chat ולשאול שאלות רלוונטיות לאותו מרחב.
  • יוצרים מרחב משותף ב-Chat ומפרסמים בו כמה הודעות שישמשו כמקור נתונים. הן יכולות להגיע מ-Gemini בעזרת הנחיה כמו Answer 20 common onboarding questions employees ask their teams.. לחלופין, אפשר להדביק כמה פסקאות מהמדריך לפיתוח בעזרת הסקירה הכללית של Chat ולשאול שאלות.

במדריך הזה תלמדו ליצור מרחב משותף ב-Chat ולהדביק כמה פסקאות מהמדריך פיתוח באמצעות סקירה כללית של Chat.

  1. פותחים את Google Chat.

    כניסה ל-Google Chat

  2. יצירת מרחב משותף ב-Chat:

    1. לוחצים על צ'אט חדש > יצירת מרחב משותף.

    2. בשדה Space name, כותבים Testing AI knowledge assistant app.

    3. בקטע למטרה הזו מיועד המרחב הזה?, בוחרים באפשרות שיתוף פעולה.

    4. בקטע הגדרות גישה, בוחרים מי יוכל לגשת למרחב המשותף.

    5. לוחצים על יצירה.

  3. הוספת הודעות לשימוש כמקור נתונים:

    1. בדפדפן אינטרנט, אפשר לקרוא את המדריך סקירה כללית על פיתוח ב-Chat.

    2. מעתיקים ומדביקים את תוכן המדריך במרחב המשותף ב-Chat שיצרתם.

  4. מוסיפים את אפליקציית Chat עם עוזרת ה-AI:

    1. בסרגל הכתיבה של ההודעה, מקלידים @AI knowledge assistant ובתפריט ההצעות שמופיע, בוחרים את אפליקציית Chat עם העוזרת הווירטואלית מבוססת-ה-AI ולוחצים על enter.

    2. תופיע הודעה השואלת אם אתם רוצים להוסיף למרחב המשותף את אפליקציית הצ'אט של העוזר הדיגיטלי בנושא AI. לוחצים על צירוף למרחב המשותף.

    3. אם זו הפעם הראשונה שאתם מוסיפים את אפליקציית Chat למרחב משותף, עליכם להגדיר את האימות וההרשאה לאפליקציית Chat:

      1. לוחצים על Configure (הגדרה).
      2. ייפתח חלון חדש בדפדפן או כרטיסייה חדשה שבה תתבקשו לבחור חשבון Google. בוחרים את החשבון שאיתו רוצים לבדוק.
      3. בודקים את ההרשאות שעוזר ה-AI מבקש באפליקציית Chat. כדי להעניק את ההרשאות, לוחצים על אישור.
      4. תופיע ההודעה You may close this page now.. סוגרים את החלון או הכרטיסייה של הדפדפן וחוזרים למרחב המשותף ב-Chat.
  5. שאל שאלה:

    1. בשורת הכתיבה של ההודעה, מקלידים שאלה כמו What are Google Chat apps?

    2. אפליקציית Chat עם העוזר הדיגיטלי מבוסס-ה-AI עונה.

    3. אם התשובה לא מדויקת או מספקת, כדי לשפר את היסטוריית השיחות של ה-AI, לוחצים על Get help. באפליקציית Chat, בכלי המידע על AI, מופיע מנהל של מרחב משותף ומבקש ממנו לענות על השאלה. בפעם הבאה, אפליקציית Chat עם העוזרת הווירטואלית מבוססת-ה-AI תדע את התשובה.

שיקולים, אפשרויות ארכיטקטוניות חלופיות והשלבים הבאים

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

Firestore, Cloud Storage או הודעות ברשימת השיחות ב-Chat API

במדריך הזה מומלץ לאחסן נתונים של מרחבים משותפים ב-Chat, כמו הודעות, במסד נתונים של Firestore. כך אפשר לשפר את הביצועים בהשוואה לקריאה ל-method‏ list במשאב Message באמצעות Chat API בכל פעם שאפליקציית Chat עונה על שאלה. בנוסף, שליחה חוזרת של list messages עלולה לגרום לאפליקציית Chat להגיע למכסת ה-API.

עם זאת, אם היסטוריית השיחות של מרחב משותף ב-Chat מתחילה להיות ארוכה מדי, השימוש ב-Firestore עלול להיות יקר.

Cloud Storage היא חלופה ל-Firestore. לכל מרחב משותף שבו נעשה שימוש ב-AI של אפליקציית Chat יש אובייקט משלו, וכל אובייקט הוא קובץ טקסט שמכיל את כל ההודעות במרחב המשותף. היתרון של הגישה הזו הוא שאפשר להזין בבת אחת את התוכן המלא של קובץ הטקסט ל-Vertex AI באמצעות Gemini, אבל החיסרון הוא שנדרש יותר עבודה כדי לעדכן את היסטוריית השיחות, כי אי אפשר להוסיף לאובייקט ב-Cloud Storage אלא רק להחליף אותו. הגישה הזו לא הגיונית אם מעדכנים את היסטוריית ההודעות באופן קבוע, אבל היא יכולה להתאים אם מעדכנים את היסטוריית ההודעות בקבוצות מדי פעם, למשל פעם בשבוע.

פתרון בעיות

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

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

הסרת המשאבים

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

  1. במסוף Google Cloud, עוברים לדף Manage resources. לוחצים על תפריט > IAM & Admin > Manage Resources.

    כניסה למנהל המשאבים

  2. ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete .
  3. כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.