פיתוח אפליקציה ל-Google Chat באמצעות סוכן AI ב-ADK

בדף הזה מוסבר איך ליצור אפליקציית Google Chat שמקשרת לסוכן AI של ערכה לפיתוח סוכנים (ADK) שמארח ב-Vertex AI Agent Engine.

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

דוגמה לאפליקציית צ'אט מרובת-סוכנים של LLM Auditor.

התרשים הבא מציג את הארכיטקטורה ואת דפוס העברת ההודעות:

ארכיטקטורה של אפליקציה ל-Chat שהוטמעה באמצעות סוכן AI של ADK.

בתרשים שלמעלה, משתמש שמקיים אינטראקציה עם אפליקציית צ'אט שהוטמעה באמצעות סוכן AI של ADK, מעביר את המידע לפי התהליך הבא:

  1. משתמש שולח הודעה לאפליקציית Chat, בצ'אט ישיר או במרחב ב-Chat.
  2. הלוגיקה של אפליקציית Chat, שמוטמעת ב-Apps Script או כשרת אינטרנט עם נקודות קצה של HTTP, מקבלת את ההודעה ומעבדת אותה.
  3. סוכן ה-AI שמוטמע באמצעות ADK ומתארח ב-Vertex AI Agent Engine מקבל את האינטראקציה ומעבד אותה.
  4. אפשר גם לשלב את אפליקציית Chat או את סוכן ה-AI עם שירותי Google Workspace, כמו יומן או Sheets, או עם שירותים אחרים של Google, כמו מפות Google או YouTube.
  5. אפליקציית Chat שולחת תשובות באופן אסינכרוני באמצעות Google Chat API כדי לעדכן אתכם בהתקדמות של סוכן ה-AI.
  6. התשובות מועברות למשתמש.

מטרות

  • מגדירים את הסביבה.
  • פורסים את סוכן ה-AI של ADK.
  • פורסים את אפליקציית Chat.
  • מגדירים את אפליקציית Chat.
  • בודקים את אפליקציית Chat.

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

הגדרת הסביבה

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

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

  • במסוף Google Cloud, מפעילים את ממשקי ה-API של Google Chat,‏ Vertex AI ו-Cloud Resource Manager.

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

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

כל האפליקציות שמשתמשות ב-OAuth 2.0 דורשות הגדרה של מסך הסכמה. הגדרת מסך ההסכמה ל-OAuth של האפליקציה קובעת מה מוצג למשתמשים ולבודקי האפליקציה, ורושמת את האפליקציה כדי שתוכלו לפרסם אותה בהמשך.

  1. ב-Google API Console, נכנסים לתפריט > Google Auth platform > Branding.

    מעבר לדף Branding

  2. אם כבר הגדרתם את פלטפורמת האימות של Google, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטעים Branding,‏ Audience וData Access. אם מופיעה ההודעה Google Auth platform not configured yet, לוחצים על Get Started:
    1. בקטע App Information בשדה App name, מזינים שם לאפליקציה.
    2. בקטע User support email, בוחרים כתובת אימייל לתמיכה שאליה משתמשים יפנו אם יש להם שאלות לגבי ההסכמה שלהם.
    3. לוחצים על Next.
    4. בקטע Audience, לוחצים על Internal.
    5. לוחצים על Next.
    6. בקטע Contact Information, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
    7. לוחצים על Next.
    8. בקטע Finish, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, מסמנים את התיבה I agree to the Google API Services: User Data Policy.
    9. לוחצים על Continue.
    10. לוחצים על Create.
  3. כרגע אתם יכולים לדלג על הוספת היקפי הרשאות. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון שלכם ב-Google Workspace, תצטרכו לשנות את סוג המשתמש ל-External. לאחר מכן מוסיפים את היקפי ההרשאות שהאפליקציה דורשת. למידע נוסף, אפשר לעיין במדריך המלא בנושא הגדרת הסכמה ל-OAuth.

איך יוצרים חשבון שירות במסוף Google Cloud

כדי ליצור חשבון שירות חדש עם התפקיד Vertex AI User, פועלים לפי השלבים הבאים:

Google Cloud Console

  1. במסוף Google Cloud, לוחצים על סמל התפריט > IAM & Admin > Service Accounts.

    לדף Service accounts

    שאר השלבים יופיעו במסוף Google Cloud.

  2. בוחרים פרויקט ב-Google Cloud.
  3. לוחצים על יצירת חשבון שירות.
  4. מזינים שם לחשבון השירות שיופיע במסוף Google Cloud.
  5. אם לא רוצים להגדיר את אמצעי בקרת הגישה עכשיו, לוחצים על Done כדי לסיים את יצירת חשבון השירות. כדי להגדיר אמצעי בקרת גישה עכשיו, לוחצים על Create and continue וממשיכים לשלב הבא.
  6. אופציונלי: מקצים תפקידים לחשבון השירות כדי לתת גישה למשאבים בפרויקט בענן של Google בנוסף למשאבים ב-Google Workspace. מידע נוסף על ניהול הגישה לפרויקטים, לתיקיות ולארגונים
  7. לוחצים על המשך.
  8. אופציונלי: מזינים משתמשים או קבוצות שיכולים לנהל את חשבון השירות הזה ולבצע פעולות באמצעותו. פרטים נוספים מופיעים במאמר התחזות לחשבון שירות.
  9. לוחצים על Done כדי לסיים ליצור את חשבון השירות.

    רושמים את כתובת האימייל של חשבון השירות.

‫CLI של gcloud

  1. יוצרים את חשבון השירות: 
    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
  --display-name="SERVICE_ACCOUNT_NAME"
  2. אופציונלי: מקצים תפקידים לחשבון השירות כדי לתת גישה למשאבים בפרויקט בענן של Google בנוסף למשאבים ב-Google Workspace. מידע נוסף על ניהול הגישה לפרויקטים, לתיקיות ולארגונים

חשבון השירות מופיע בדף של חשבון השירות.

יצירת מפתח פרטי

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

  1. במסוף Google Cloud, לוחצים על סמל התפריט > IAM & Admin > Service Accounts.

    לדף Service accounts

    שאר השלבים יופיעו במסוף Google Cloud.

  2. בוחרים פרויקט ב-Google Cloud.
  3. לוחצים על כתובת האימייל של חשבון השירות שעבורו רוצים ליצור מפתח.
  4. לוחצים על הכרטיסייה Keys.
  5. לוחצים על התפריט הנפתח Add key ובוחרים באפשרות Create new key.
  6. בוחרים באפשרות JSON בתור Key type ולוחצים על Create.

    זוג המפתחות הציבורי/פרטי החדש נוצר ומורד למחשב שלכם כקובץ מפתח של חשבון שירות. שומרים את קובץ ה-JSON שהורדתם בשם credentials.json בספריית העבודה. הקובץ הזה הוא העותק היחיד של המפתח. אחרי שמורידים את קובץ המפתח, אי אפשר להוריד אותו שוב. מידע על אחסון מאובטח של המפתח זמין במאמר שיטות מומלצות לניהול מפתחות של חשבונות שירות.

מידע נוסף על חשבונות שירות זמין במאמר בנושא חשבונות שירות במסמכי העזרה של Google Cloud IAM.

פריסת סוכן ה-AI של ADK

  1. פותחים את הדוגמה של LLM Auditor ב-Vertex AI Agent Garden:

    פתיחת הדוגמה

  2. לוחצים על פריסה.

  3. אם מתבקשים, בוחרים את הפרויקט בענן ב-Google Cloud.

  4. לוחצים על Deploy in Cloud Shell (פריסה ב-Cloud Shell).

  5. אם מתבקשים, לוחצים על Authorize ומבצעים את תהליך OAuth עבור Cloud Shell.

  6. כש-Cloud Shell נטען באופן מלא, לוחצים על Enter כדי להריץ את שורת הפקודה שנטענה מראש ולהתחיל בפריסה.

  7. אם מתבקשים להזין אזור, מקישים על Enter כדי להשתמש בברירת המחדל.

  8. אחרי שההעברה מסתיימת, עוברים אל Vertex AI Agent Engine:

    פתיחת Vertex AI Agent Engine

  9. לוחצים על הסמל ליצירת עותק כדי להעתיק את שם המשאב של הסוכן החדש מהטבלה.

יצירה והגדרה של פרויקט אפליקציית Chat

  1. לוחצים על הלחצן הבא כדי לפתוח את פרויקט Apps Script של ADK AI Agent Quickstart.

    פתיחת הפרויקט

  2. לוחצים על סקירה כללית > הסמל ליצירת עותק יצירת עותק.

  3. בפרויקט Apps Script, לוחצים על הסמל של הגדרות הפרויקט Project Settings (הגדרות הפרויקט) > Edit script properties (עריכת מאפייני התסריט) > Add script property (הוספת מאפיין תסריט) כדי להוסיף את מאפייני התסריט הבאים:

    1. ‫REASONING_ENGINE_RESOURCE_NAME עם שם המשאב של סוכן Vertex AI שהעתקתם בשלבים הקודמים.
    2. ‫SERVICE_ACCOUNT_KEY עם מפתח ה-JSON מחשבון השירות שהורדתם בשלבים הקודמים, כמו { ... }.

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

  5. ב-Google API Console, לוחצים על סמל התפריט > IAM & Admin > Settings (הגדרות).

    כניסה לדף IAM & Admin Settings

  6. מעתיקים את הערך בשדה מספר הפרויקט.

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

  8. בקטע פרויקט ב-Google Cloud Platform‏ (GCP), לוחצים על שינוי הפרויקט.

  9. בשדה GCP project number (מספר הפרויקט ב-GCP), מדביקים את מספר הפרויקט ב-Google Cloud שהועתק בשלבים הקודמים.

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

יצירת פריסת בדיקה

כדי להשתמש בפרויקט הזה של Apps Script בשלב הבא, צריך מזהה פריסה.

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

  1. בפרויקט Apps Script של אפליקציית Chat, לוחצים על Deploy (פריסה) > Test deployments (פריסות לבדיקה).
  2. בקטע Head deployment ID (מזהה הפריסה של הגרסה האחרונה), לוחצים על הסמל ליצירת עותק Copy (העתקה).
  3. לוחצים על סיום.

הגדרת אפליקציית Chat

כדי לפרוס את האפליקציה ל-Google Chat לצורך בדיקה, פועלים לפי השלבים הבאים באמצעות הפריסה של Apps Script:

  1. ב-קונסולה לממשקי API, מחפשים את Google Chat API ולוחצים על Google Chat API.
  2. לוחצים על ניהול.

  3. לוחצים על Configuration (הגדרה) ומגדירים את אפליקציית Chat:

    1. בשדה App name, מזינים ADK Quickstart.
    2. בשדה כתובת ה-URL של האווטאר מזינים את הערך https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
    3. בשדה Description (תיאור) מזינים ADK Quickstart.
    4. בקטע פונקציונליות, בוחרים באפשרות הצטרפות למרחבים ולשיחות קבוצתיות.
    5. בקטע 'הגדרות חיבור', בוחרים באפשרות פרויקט Apps Script.
    6. בשדה Deployment ID (מזהה הפריסה), מדביקים את מזהה הפריסה של Head שהעתקתם קודם.
    7. בקטע 'חשיפה', בוחרים באפשרות אנשים וקבוצות ספציפיים בדומיין ומזינים את כתובת האימייל.

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

אפליקציית Chat מוכנה להגיב להודעות.

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

כדי לבדוק את אפליקציית Chat, פותחים מרחב לצ'אט ישיר עם אפליקציית Chat ושולחים הודעה:

  1. פותחים את Google Chat באמצעות חשבון Google Workspace שציינתם כשנרשמתם כבודקים מהימנים.

    מעבר אל Google Chat

  2. לוחצים על צ'אט חדש.
  3. בשדה Add 1 or more people (הוספת אדם אחד או יותר), מקלידים את השם של אפליקציית Chat.

  4. בוחרים את אפליקציית Chat מתוך התוצאות. ייפתח צ'אט ישיר.

  5. בצ'אט הישיר החדש עם האפליקציה, כותבים The Eiffel Tower was completed in 1900 ומקישים עלenter.

    אפליקציית הצ'אט תשיב עם תשובות של סוכני משנה מסוג מבקר ועורך.

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

פתרון בעיות

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

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

הסרת המשאבים

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

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

    כניסה ל-Resource Manager

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