Conversational Analytics API: פיתוח סוכני נתונים וצ'אט עם הנתונים

מפתחים יכולים להשתמש ב-Conversational Analytics API, שאפשר לגשת אליו דרך geminidataanalytics.googleapis.com, כדי ליצור ממשק צ'אט מבוסס-בינה מלאכותית (AI) או סוכן נתונים. ה-API משתמש בשפה טבעית כדי לענות על שאלות לגבי נתונים מובנים ב-BigQuery, ב-Looker וב-Data Studio. הוא גם תומך בשליחת שאילתות לגבי נתונים מ-AlloyDB, מ-GoogleSQL for Spanner, מ-Cloud SQL ומ-Cloud SQL ל-PostgreSQL באמצעות השיטה החדשה QueryData. באמצעות Conversational Analytics API, אתם מספקים לסוכן הנתונים שלכם פרטי עסק ונתונים (הקשר), וגם גישה לכלים כמו SQL,‏ Python וספריות להמחשה חזותית. התשובות של הנציג מוצגות למשתמש, ואפליקציית הלקוח יכולה לרשום אותן ביומן. כך נוצרת חוויית צ'אט חלקה עם נתונים שניתן לבדוק.

איך Gemini for Google Cloud ‎ משתמש בנתונים שלכם, ובאילו מקרים.

תחילת העבודה עם Conversational Analytics API

כדי להתחיל להשתמש ב-Conversational Analytics API, כדאי לעיין במסמכים הבאים כדי להבין את הגישות הזמינות לשילוב ואת המושגים המרכזיים:

  • ארכיטקטורה ומושגים מרכזיים: הסבר על האופן שבו סוכני נתונים מעבדים בקשות, זרימות עבודה ליוצרי סוכנים ולמשתמשים, מצבי שיחה ותפקידים נדרשים של ניהול זהויות והרשאות גישה (IAM).
  • דפוסי שילוב של סוכני נתונים: השוואה בין גישות ארכיטקטוניות כדי לקבוע מהי שיטת החיבור הטובה ביותר לאפליקציה שלכם.
  • ניהול מצב: מידע על מצבי שיחה עם שמירת מצב ועל מצבי שיחה בלי שמירת מצב, על האופן שבו ה-API מנהל את היסטוריית השיחות ועל היקפי מצב הסשן של ADK.

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

הגדרה ותנאים מוקדמים

לפני שמשתמשים ב-API או בדוגמאות, צריך לבצע את השלבים הבאים:

איך יוצרים סוכן נתונים ואיך מתקשרים איתו

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

שיטות מומלצות

כדי לקבל מידע על שיטות מומלצות לשימוש ב-Conversational Analytics API, מומלץ לעיין במדריכים הבאים:

הפניית API וספריות לקוח

פעולות מרכזיות ב-API

ה-API מספק את נקודות הקצה הבאות לניהול סוכני נתונים ושיחות:

פעולה שיטת HTTP נקודת קצה (endpoint) תיאור
יצירת סוכן POST /v1beta/projects/*/locations/*/dataAgents יצירת סוכן נתונים חדש.
יצירת סוכן באופן סינכרוני POST /v1beta/projects/*/locations/*/dataAgents:createSync יצירה סינכרונית של סוכן נתונים חדש.
קבלת נציג GET /v1beta/projects/*/locations/*/dataAgents/* הסוכן מאחזר את הפרטים של סוכן נתונים ספציפי.
קבלת מדיניות ניהול הזהויות והרשאות הגישה (IAM) POST /v1beta/projects/*/locations/*/dataAgents/*:getIamPolicy מקבל את ההרשאות לניהול הזהויות והרשאות הגישה שהוקצו לכל משתמש עבור סוכן נתונים ספציפי. משתמשים עם תפקיד בעלים של סוכן נתונים יכולים להתקשר לנקודת הקצה הזו כדי להציג את מדיניות ניהול הזהויות והגישה של סוכן הנתונים לפני השימוש בנקודת הקצה setIAMpolicy כדי לשתף סוכן נתונים עם משתמשים אחרים.
הגדרת מדיניות לניהול זהויות והרשאות גישה POST /v1beta/projects/*/locations/*/dataAgents/*:setIamPolicy הגדרת מדיניות ניהול הזהויות והרשאות הגישה (IAM) לסוכן נתונים ספציפי. משתמשים עם הרשאת גישה מסוג בעלים של סוכן נתונים צריכים להתקשר לנקודת הקצה הזו כדי לשתף סוכן נתונים עם משתמשים אחרים, וכך לעדכן את ההרשאות של המשתמשים האלה לניהול זהויות וגישה.
עדכון סוכן PATCH /v1beta/projects/*/locations/*/dataAgents/* שינוי של סוכן נתונים קיים.
עדכון סוכן באופן סינכרוני PATCH /v1beta/projects/*/locations/*/dataAgents/*:updateSync שינוי סוכן נתונים קיים באופן סינכרוני.
הצגת רשימה של סוכנים GET /v1beta/projects/*/locations/*/dataAgents הצגת רשימה של סוכני נתונים שזמינים בפרויקט.
הצגת רשימה של נציגי תמיכה שאפשר לגשת אליהם GET /v1beta/projects/*/locations/*/dataAgents:listaccessible הצגת רשימה של סוכני נתונים שאפשר לגשת אליהם בפרויקט. סוכן נתונים נחשב לנגיש אם למשתמש שמפעיל את ה-API הזה יש את ההרשאה get בסוכן. אפשר להשתמש בשדה creator_filter כדי לנהל את הסוכנים שהשיטה הזו מחזירה:
  • ‫NONE (ברירת מחדל): מחזירה את כל סוכני הנתונים שהמשתמש יכול לגשת אליהם, ללא קשר למי שיצר את הסוכנים.
  • ‫CREATOR_ONLY: הפונקציה מחזירה רק את סוכני הנתונים שהמשתמש יכול לגשת אליהם ושנוצרו על ידו.
  • ‫NOT_CREATOR_ONLY: מחזירה רק את סוכני הנתונים שהמשתמש יכול לגשת אליהם ושנוצרו על ידי אחרים.
מחיקת סוכן DELETE /v1beta/projects/*/locations/*/dataAgents/* הסרת סוכן נתונים.
מחיקת סוכן באופן סינכרוני DELETE /v1beta/projects/*/locations/*/dataAgents/*:deleteSync הסרה של סוכן נתונים באופן סינכרוני.
יצירת שיחה POST /v1beta/projects/*/locations/*/conversations מתחילים שיחה חדשה ומתמשכת.
שיחה באמצעות חומרי עזר POST /v1beta/projects/*/locations/*:chat המשך שיחה עם שמירת מצב על ידי שליחת הודעה בצ'אט שמפנה לשיחה קיימת ולהקשר של הנציג שמשויך אליה. בשיחות רב-שלביות, Google Cloud מאחסן ומנהל את היסטוריית השיחות.
צ'אט באמצעות הפניה לסוכן נתונים POST /v1beta/projects/*/locations/*:chat שליחת הודעה בצ'אט ללא שמירת מצב, עם הפניה לסוכן נתונים שנשמר כדי לספק הקשר. בשיחות רב-שלביות, האפליקציה צריכה לנהל את היסטוריית השיחות ולספק אותה בכל בקשה.
שיחה באמצעות הקשר מוטבע POST /v1beta/projects/*/locations/*:chat שולחת הודעת צ'אט בלי שמירת מצב על ידי ציון כל ההקשר ישירות בבקשה, בלי להשתמש בסוכן נתונים שמור. בשיחות רב-שלביות, האפליקציה צריכה לנהל את היסטוריית השיחות ולספק אותה בכל בקשה.
קבלת שיחה GET /v1beta/projects/*/locations/*/conversations/* מאחזר את הפרטים של שיחה ספציפית.
רשימת השיחות GET /v1beta/projects/*/locations/*/conversations הצגת רשימת השיחות בפרויקט ספציפי.
איך רואים את רשימת ההודעות בשיחה GET /v1beta/projects/*/locations/*/conversations/*/messages רשימת ההודעות בשיחה ספציפית.
איך מוחקים שיחות DELETE /v1beta/projects/*/locations/*/conversations/* מחיקת שיחה ספציפית. כדי להתקשר לנקודת הקצה הזו, צריך להיות לכם תפקיד של אדמין בנושא בממשק לניהול זהויות והרשאות גישה (IAM), או לפחות הרשאת cloudaicompanion.topics.delete בממשק לניהול זהויות והרשאות גישה (IAM).
שאילתת נתונים POST /v1beta/projects/*/locations/*/conversations:queryData שליפת נתונים ממסדי נתונים של AlloyDB,‏ GoogleSQL ל-Spanner,‏ Cloud SQL ו-Cloud SQL ל-PostgreSQL באמצעות שפה טבעית.

שליחת משוב

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