מפתחים יכולים להשתמש ב-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.
- מיקומים של Conversational Analytics API: סקירה כללית של נקודות הקצה האזוריות או הרב-אזוריות של ה-API שמאפשרות לכם לשלוט במיקום הגיאוגרפי של המשאבים, ההגדרות והנתונים של הסוכן.
כדי להתחיל ליצור סוכני נתונים, צריך לבצע את השלבים שמפורטים במסמכי התיעוד בנושא הגדרה ודרישות מוקדמות. במדריכים, בהדגמות ובכלים של Conversational Analytics API אפשר למצוא הסברים מפורטים, אפליקציות לדוגמה, ערכות SDK וכלים אחרים לפיתוח.
הגדרה ותנאים מוקדמים
לפני שמשתמשים ב-API או בדוגמאות, צריך לבצע את השלבים הבאים:
- הפעלת Conversational Analytics API: מאמר שמתאר את הדרישות המוקדמות להפעלת Conversational Analytics API.
- בקרת גישה באמצעות IAM: במאמר הזה מוסבר איך משתמשים בניהול זהויות והרשאות גישה כדי לשתף ולנהל את הגישה לסוכני נתונים.
- אימות וחיבור למקור נתונים: הוראות לאימות ל-API ולהגדרת חיבורים לנתונים של BigQuery, Lakehouse, Looker, Data Studio ומסדי נתונים בענן (AlloyDB, GoogleSQL for Spanner, Cloud SQL ו-Cloud SQL ל-PostgreSQL).
- מפתחות הצפנה בניהול הלקוח (CMEK): במאמר הזה מוסבר איך להשתמש במפתחות הצפנה משלכם ב-Cloud Key Management Service כדי להגן על סוכני נתונים ועל שיחות שמשתמשים במקורות נתונים של Looker.
- אילוצים על מדיניות הארגון: במאמר הזה מוסבר איך להשתמש באילוצים מוגדרים מראש על מדיניות הארגון כדי לשלוט במשאבים ברמת הארגון, התיקייה או הפרויקט.
איך יוצרים סוכן נתונים ואיך מתקשרים איתו
אחרי שמבצעים את השלבים הקודמים, משתמשים ב-Conversational Analytics API כדי ליצור סוכן נתונים ולקיים איתו אינטראקציה. לשם כך, פועלים לפי השלבים הבאים:
- יצירת סוכן נתונים באמצעות HTTP: כולל דוגמה מלאה ליצירה של סוכן נתונים ואינטראקציה איתו באמצעות בקשות HTTP ישירות עם Python.
- יצירת סוכן נתונים באמצעות Python SDK: כולל דוגמה מלאה ליצירה של סוכן נתונים וליצירת אינטראקציה איתו באמצעות Python SDK.
- הנחיית התנהגות הסוכן באמצעות הקשר שנוצר: במאמר הזה מוסבר איך לספק הקשר שנוצר כדי להנחות את התנהגות הסוכן ולשפר את דיוק התשובות. אפשר גם לראות דוגמאות של הקשר שנוצר עם מקורות נתונים של BigQuery ועם מקורות נתונים של Looker.
- הצגת תגובה של סוכן Conversational Analytics API כהמחשה: מספקת דוגמה לעיבוד מפרטי תרשימים מתגובות API ולהצגתם כהמחשות באמצעות Python SDK וספריית Vega-Altair.
שיטות מומלצות
כדי לקבל מידע על שיטות מומלצות לשימוש ב-Conversational Analytics API, מומלץ לעיין במדריכים הבאים:
- ניהול העלויות של BigQuery עבור הסוכנים שלכם: כאן מוסבר איך לעקוב אחרי העלויות של BigQuery עבור הסוכנים של Conversational Analytics API ולנהל אותן על ידי הגדרת מגבלות הוצאות ברמת הפרויקט, ברמת המשתמש וברמת השאילתה.
- איך שואלים שאלות יעילות: במאמר הזה מוסבר איך לנסח שאלות יעילות לסוכנים כדי להפיק את המרב מה-API של ניתוח שיחות.
- שמירה ומחיקה של נתונים: מידע על שמירה ומחיקה של נתונים של סוכני נתונים ושיחות ב-Conversational Analytics API.
- מכסות ומגבלות: מידע על המכסות והמגבלות של Conversational Analytics API.
- פתרון בעיות שקשורות לשגיאות ב-Conversational Analytics API: פתרון בעיות נפוצות שקשורות לשגיאות ב-Conversational Analytics API.
- מגבלות ידועות: מידע מפורט על מגבלות ידועות של Conversational Analytics API, כולל מגבלות של שאילתות, נתונים, ויזואליזציות ושאלות.
- הצגת תשובות של סוכן למקורות נתונים של Looker: שיטות מומלצות להצגת תשובות של Conversational Analytics API בממשק משתמש כשמשתמשים במקורות נתונים של Looker.
הפניית API וספריות לקוח
- Gemini Data Analytics REST reference: כולל תיאורים מפורטים של גרסאות API, שיטות, נקודות קצה והגדרות סוגים.
- ערכות SDK וכלי פיתוח: רשימה של ספריות לקוח ספציפיות לשפה.
פעולות מרכזיות ב-API
ה-API מספק את נקודות הקצה הבאות לניהול סוכני נתונים ושיחות:
| פעולה | שיטת HTTP | נקודת קצה (endpoint) | תיאור |
|---|---|---|---|
| יצירת סוכן | POST |
/v1/projects/*/locations/*/dataAgents |
יצירת סוכן נתונים חדש. |
| יצירת סוכן באופן סינכרוני | POST |
/v1/projects/*/locations/*/dataAgents:createSync |
יצירה סינכרונית של סוכן נתונים חדש. |
| קבלת נציג | GET |
/v1/projects/*/locations/*/dataAgents/* |
הסוכן מאחזר את הפרטים של סוכן נתונים ספציפי. |
| קבלת מדיניות ניהול הזהויות והרשאות הגישה (IAM) | POST |
/v1/projects/*/locations/*/dataAgents/*:getIamPolicy |
מקבל את ההרשאות לניהול הזהויות והרשאות הגישה שהוקצו לכל משתמש עבור סוכן נתונים ספציפי. משתמשים עם תפקיד בעלים של סוכן נתונים יכולים להתקשר לנקודת הקצה הזו כדי להציג את מדיניות ניהול הזהויות והגישה של סוכן הנתונים לפני השימוש בנקודת הקצה setIAMpolicy כדי לשתף סוכן נתונים עם משתמשים אחרים. |
| הגדרת מדיניות לניהול זהויות והרשאות גישה | POST |
/v1/projects/*/locations/*/dataAgents/*:setIamPolicy |
הגדרת מדיניות ניהול הזהויות והרשאות הגישה (IAM) לסוכן נתונים ספציפי. משתמשים עם הרשאת גישה מסוג בעלים של סוכן נתונים צריכים להתקשר לנקודת הקצה הזו כדי לשתף סוכן נתונים עם משתמשים אחרים, וכך לעדכן את ההרשאות של המשתמשים האלה לניהול זהויות וגישה. |
| עדכון סוכן | PATCH |
/v1/projects/*/locations/*/dataAgents/* |
שינוי של סוכן נתונים קיים. |
| עדכון סוכן באופן סינכרוני | PATCH |
/v1/projects/*/locations/*/dataAgents/*:updateSync |
שינוי סוכן נתונים קיים באופן סינכרוני. |
| הצגת רשימה של סוכנים | GET |
/v1/projects/*/locations/*/dataAgents |
הצגת רשימה של סוכני נתונים שזמינים בפרויקט. |
| הצגת רשימה של נציגי תמיכה שאפשר לגשת אליהם | GET |
/v1/projects/*/locations/*/dataAgents:listaccessible |
הצגת רשימה של סוכני נתונים שאפשר לגשת אליהם בפרויקט. סוכן נתונים נחשב לנגיש אם למשתמש שמפעיל את ה-API הזה יש את ההרשאה get בסוכן. אפשר להשתמש בשדה creator_filter כדי לנהל את הסוכנים שהשיטה הזו מחזירה:
|
| מחיקת סוכן | DELETE |
/v1/projects/*/locations/*/dataAgents/* |
הסרת סוכן נתונים. |
| מחיקת סוכן באופן סינכרוני | DELETE |
/v1/projects/*/locations/*/dataAgents/*:deleteSync |
הסרה של סוכן נתונים באופן סינכרוני. |
| יצירת שיחה | POST |
/v1/projects/*/locations/*/conversations |
מתחילים שיחה חדשה ומתמשכת. |
| שיחה באמצעות חומרי עזר | POST |
/v1/projects/*/locations/*:chat |
המשך שיחה עם שמירת מצב על ידי שליחת הודעה בצ'אט שמפנה לשיחה קיימת ולהקשר של הנציג שמשויך אליה. בשיחות רב-שלביות, Google Cloud מאחסן ומנהל את היסטוריית השיחות. |
| צ'אט באמצעות הפניה לסוכן נתונים | POST |
/v1/projects/*/locations/*:chat |
שליחת הודעה בצ'אט ללא שמירת מצב, עם הפניה לסוכן נתונים שנשמר כדי לספק הקשר. בשיחות רב-שלביות, האפליקציה צריכה לנהל את היסטוריית השיחות ולספק אותה בכל בקשה. |
| שיחה באמצעות הקשר מוטבע | POST |
/v1/projects/*/locations/*:chat |
שולחת הודעת צ'אט בלי שמירת מצב על ידי ציון כל ההקשר ישירות בבקשה, בלי להשתמש בסוכן נתונים שמור. בשיחות רב-שלביות, האפליקציה צריכה לנהל את היסטוריית השיחות ולספק אותה בכל בקשה. |
| קבלת שיחה | GET |
/v1/projects/*/locations/*/conversations/* |
מאחזר את הפרטים של שיחה ספציפית. |
| רשימת השיחות | GET |
/v1/projects/*/locations/*/conversations |
הצגת רשימת השיחות בפרויקט ספציפי. |
| איך רואים את רשימת ההודעות בשיחה | GET |
/v1/projects/*/locations/*/conversations/*/messages |
רשימת ההודעות בשיחה ספציפית. |
| איך מוחקים שיחות | DELETE |
/v1/projects/*/locations/*/conversations/* |
מחיקת שיחה ספציפית. כדי להתקשר לנקודת הקצה הזו, צריך להיות לכם תפקיד של אדמין בנושא בממשק לניהול זהויות והרשאות גישה (IAM), או לפחות הרשאת cloudaicompanion.topics.delete בממשק לניהול זהויות והרשאות גישה (IAM).
|
| שאילתת נתונים | POST |
/v1beta/projects/*/locations/*/conversations:queryData |
שליפת נתונים ממסדי נתונים של AlloyDB, GoogleSQL ל-Spanner, Cloud SQL ו-Cloud SQL ל-PostgreSQL באמצעות שפה טבעית. |
תמיכה ומשוב
כדי לקבל עזרה או לדווח על בעיה, אפשר ליצור קשר עם שירות הלקוחות. כדי לפתוח בקשת תמיכה, פועלים לפי ההנחיות במאמר יצירה וניהול של בקשות תמיכה. כשיוצרים את הפנייה, צריך לפעול לפי ההנחיות הבאות:
- כדי לקבל תמיכה ב-Conversational Analytics API עם BigQuery, ברשימה Select a product (בחירת מוצר), בוחרים באפשרות BigQuery, ובשדה Feature (תכונה), בוחרים באפשרות AI and Machine Learning::Conversational Analytics API in BigQuery (AI ולמידת מכונה::Conversational Analytics API ב-BigQuery).
- כדי לקבל תמיכה ב-Conversational Analytics API עם Looker, ברשימה Select a product (בחירת מוצר), בוחרים באפשרות Looker (original) (Looker (מקורי)), ובשדה Feature (תכונה), בוחרים באפשרות Gemini in Looker::Conversational Analytics API (Gemini ב-Looker::Conversational Analytics API).
אם יש לכם משוב כללי או שאלות לגבי Conversational Analytics API, אתם יכולים לשלוח אימייל לכתובת conversational-analytics-api-feedback@google.com. אנחנו לא מתחייבים להשיב לאימיילים, אבל אנחנו קוראים אותם ומתייחסים למשוב הזה בתכנון של תוכניות הפיתוח.
אפשר גם להגיש בקשה להוספת תכונה לפונקציונליות החדשה של Conversational Analytics API.