ניהול הגדרות של יכולת התבוננות

במאמר הזה מוסבר איך להגדיר את הגדרות הניטור של אפליקציית Gemini Enterprise או של סוכנים ספציפיים באמצעות מסוף Google Cloud או REST API.

הלוגיקה של ההפעלה תלויה בסוג הסוכן:

• סוכן Core Assistant: משתמשים במתג ברמת האפליקציה (ברמת המנוע) בהגדרות.
• סוכנים אחרים: (בשלב הזה, רק סוכנים שנוצרו על ידי עובדים באמצעות Workflow Builder ו-Deep Research): משתמשים במתג ברמת הסוכן בהגדרות של כל סוכן.

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

• צפייה במדדים ב-Metrics Explorer.
• אפשר לראות את פרטי ההעברה ואת טווחי הזמן ב-Trace Explorer.

מושגים מרכזיים

בקטע הזה נסביר על מושגים מרכזיים שקשורים ליכולת הצפייה ב-Gemini Enterprise.

קונספט	תיאור
מעקב	trace הוא אוסף של span שמייצג בקשה או טרנזקציה יחידה, כשהיא עוברת דרך שירותים ורכיבים שונים. לדוגמה, trace מייצג את מחזור החיים המלא של בקשה. הנתונים כוללים שאלה שמשתמש שואל את Gemini Enterprise Assistant, את התשובה של Gemini Enterprise Assistant וכל פעולה שמתבצעת בעקבות התשובה, כמו שליחת אימייל.
Span	טווח (span) הוא יחידת עבודה יחידה עם תזמון בתוך עקבות. הוא מייצג פעולה ספציפית, כמו קריאה לפונקציה, בקשת API או שאילתה במסד נתונים. כל יחידה לוגית למעקב כולל פרטים כמו זמני ההתחלה ושעת סיום שלו, מזהה ייחודי והקשר שלו ליחידות לוגיות למעקב אחרות. קשרי הגומלין האלה יוצרים ביחד עקבות.
רישומים של יחידות לוגיות למעקב	יומני טווח הם הודעות או אירועים חופשיים עם חותמת זמן שמשויכים ליחידה לוגית למעקב ספציפית. הם מספקים מידע מפורט לפי הקשר על הביצוע של טווח, ועוזרים למשתמשים לנפות באגים ולהבין את זרימת הבקשה.
מדדים	מדדים הם מדידות מספריות שהמערכות אוספות לאורך זמן. המדידות האלה מייצגות את הביצועים, את השימוש במשאבים או את ההתנהגות של מערכת. מהנדסים משתמשים במדדים כדי לעקוב אחרי תקינות המערכת, לזהות מגמות ולהפעיל התראות.
יומני ביקורת על השימוש	יומני ביקורת של שימוש הם רשומות של פעילויות אדמין וגישות למשאבים ב- Google Cloud . הם מספקים מידע מפורט על מי ביצע איזו פעולה, מתי ומאיפה. היומנים האלה חיוניים לביקורת אבטחה, לתאימות ולהבנה של אופן השימוש במשאבים.
יומני שגיאות של מחבר Gemini Enterprise	ב-Gemini Enterprise connector error logs מתועדות שגיאות וכשלים שמתרחשים כשמשלבים את Gemini Enterprise עם מקורות נתונים של צד שלישי, כמו Jira ו-Microsoft OneDrive. היומנים האלה כוללים בעיות בחיבור, בעיות בהמרת נתונים ושגיאות ב-API.

לפני שמתחילים

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

• התפקיד אדמין של Gemini Enterprise.

• אפליקציית Gemini Enterprise קיימת. מידע על יצירת אפליקציה חדשה זמין במאמר יצירת אפליקציה.

הפעלה של הגדרות ה-Observability

כדי להפעיל את יכולת הצפייה באפליקציית Gemini Enterprise או בסוכנים ספציפיים, אפשר להשתמש במסוף Google Cloud או ב-REST API.

המסוף

כדי להפעיל את הגדרות יכולת הצפייה באמצעות מסוף Google Cloud , פועלים לפי השלבים הבאים:

1. נכנסים לדף Gemini Enterprise במסוף Google Cloud .

   ‫Gemini Enterprise

2. לוחצים על שם האפליקציה שרוצים להגדיר.

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

   • Core Assistant agent: לוחצים על Configurations (הגדרות) ואז על הכרטיסייה Observability (יכולת תצפית).
   • סוכנים אחרים (סוכנים שנוצרו על ידי עובדים ב-Workflow Builder וסוכני מחקר מעמיק): לוחצים על סוכנים, לוחצים על השם של הסוכן שרוצים להגדיר ואז לוחצים על הכרטיסייה הגדרה.

4. אתם יכולים להפעיל או להשבית את ההגדרות הבאות:

   הגדרת ניראות	תיאור
   הפעלת שדרוג של מעקבים ויומנים של OpenTelemetry	כשהאפשרות הזו מופעלת, אפשר לראות ב-Cloud Logging את יומני המעקב, היחידות הלוגיות למעקב, יומני היחידות הלוגיות למעקב והמדדים שמשויכים ליומנים.
   הפעלת רישום ביומן של קלט הפרומפטים ופלט התשובות	כשהאפשרות הזו מופעלת, Cloud Logging מתעד את התוכן המלא של ההנחיות והתשובות של המשתמשים. זה כולל נתונים רגישים או פרטים אישיים מזהים (PII). כדי להפעיל את ההגדרה הזו, צריך קודם להפעיל את ההגדרה הפעלת אינסטרומנטציה של עקבות ויומנים של OpenTelemetry. שימו לב: הפעלת ההגדרה הזו גורמת לרישום ביומן של נתונים רגישים, כולל פרטים אישיים מזהים (PII). הגישה ליומנים מוגבלת לעובדים מורשים בלבד.

REST

כדי להגדיר הגדרות של יכולת צפייה באמצעות ה-API ל-REST, אפשר לעיין בקטעים הבאים:

• הגדרת אפשרויות ניהול של נראות ב-Core Assistant (ברמת האפליקציה)
• הגדרת אפשרויות ניטור לסוכן ספציפי

קביעת הגדרות של יכולת מעקב עבור Core Assistant (ברמת האפליקציה)

כדי להגדיר את הגדרות יכולת הצפייה באמצעות ה-API ל-REST ברמת האפליקציה (שחלות על סוכן Core Assistant), אפשר לעיין בקטעים הבאים:

• הפעלת יכולת התבוננות כשיוצרים אפליקציה
• הפעלת יכולת התבוננות באפליקציה קיימת

הפעלת יכולת צפייה כשיוצרים אפליקציה

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

מונח חשוב: ב-Gemini Enterprise, המונח אפליקציה יכול לשמש לחלופין למונח מנוע בהקשר של ממשקי API. מנוע Gemini Enterprise הוא מנוע חיפוש כללי שבו השדה app_type מוגדר לערך APP_TYPE_INTRANET.

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "name": "projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID",
  "displayName": "APP_DISPLAY_NAME",
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "searchEngineConfig": {
    "searchTier": "SEARCH_TIER_ENTERPRISE",
    "searchAddOns": ["SEARCH_ADD_ON_LLM"],
    "requiredSubscriptionTier": "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"
  },
  "industryVertical": "GENERIC",
  "appType": "APP_TYPE_INTRANET",
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

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

• ‫ENDPOINT_LOCATION: האזור הרב-אזורי של בקשת ה-API. מציינים אחד מהערכים הבאים:
  • ‫us לאזור עם מספר אזורים בארה"ב
  • ‫eu לאזור עם מספר אזורים באיחוד האירופי
  • global למיקום הגלובלי
  מידע נוסף זמין במאמר בנושא הגדרת אזור גיאוגרפי מרובה למאגר הנתונים.
• ‫PROJECT_ID: מזהה הפרויקט.
• ‫LOCATION: האזור המרובה של מאגר הנתונים: global,‏ us או eu
• ‫APP_ID: המזהה של האפליקציה שרוצים ליצור.
• ‫APP_DISPLAY_NAME: השם המוצג של האפליקציה שרוצים ליצור.

הפעלת יכולת צפייה באפליקציה קיימת

כדי להפעיל את התכונה 'יכולת צפייה' באפליקציה קיימת, מריצים את הפקודה הבאה:

מונח חשוב: ב-Gemini Enterprise, המונח אפליקציה יכול לשמש לחלופין למונח מנוע בהקשר של ממשקי API. מנוע Gemini Enterprise הוא מנוע חיפוש כללי שבו השדה app_type מוגדר לערך APP_TYPE_INTRANET.

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

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

• ‫ENDPOINT_LOCATION: האזור הרב-אזורי של בקשת ה-API. מציינים אחד מהערכים הבאים:
  • ‫us לאזור עם מספר אזורים בארה"ב
  • ‫eu לאזור עם מספר אזורים באיחוד האירופי
  • global למיקום הגלובלי
  מידע נוסף זמין במאמר בנושא הגדרת אזור גיאוגרפי מרובה למאגר הנתונים.
• ‫PROJECT_ID: מזהה הפרויקט.
• ‫LOCATION: האזור המרובה של מאגר הנתונים: global,‏ us או eu
• ‫APP_ID: מזהה האפליקציה.

הגדרת ניראות (observability) לסוכן ספציפי

כדי להפעיל את יכולת הצפייה בסוכן ספציפי (כמו סוכן של כלי בניית תהליכי עבודה או סוכן מחקר מעמיק) באמצעות REST API, מריצים את הפקודה הבאה כדי לעדכן את observabilityConfig של הסוכן:

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant/agents/AGENT_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

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

• ‫ENDPOINT_LOCATION: האזור הרב-אזורי של בקשת ה-API. מציינים אחד מהערכים הבאים:
  • ‫us לאזור עם מספר אזורים בארה"ב
  • ‫eu לאזור עם מספר אזורים באיחוד האירופי
  • global למיקום הגלובלי
  מידע נוסף זמין במאמר בנושא הגדרת אזור גיאוגרפי מרובה למאגר הנתונים.
• ‫PROJECT_ID: מזהה הפרויקט.
• ‫LOCATION: האזור המרובה של מאגר הנתונים: global,‏ us או eu
• ‫APP_ID: מזהה האפליקציה.
• ‫AGENT_ID: המזהה של הסוכן שרוצים להגדיר

השבתת הגדרות ה-Observability

כדי להשבית את הגדרות יכולת הבקרה באפליקציית Gemini Enterprise או בסוכנים ספציפיים, אפשר להשתמש ב Google Cloud מסוף או ב-REST API.

המסוף

כדי להשבית את הגדרות יכולת הצפייה באמצעות מסוף Google Cloud :

1. נכנסים לדף Gemini Enterprise במסוף Google Cloud .

   ‫Gemini Enterprise

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

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

   • סוכן Core Assistant: לוחצים על Configurations (הגדרות) ואז על הכרטיסייה Observability (יכולת תצפית).
   • סוכנים אחרים (כולל סוכנים שנוצרו על ידי עובדים באמצעות הכלי ליצירת תהליכי עבודה וסוכנים לביצוע מחקר מעמיק): לוחצים על סוכנים, לוחצים על השם של הסוכן שרוצים להגדיר ואז לוחצים על הכרטיסייה הגדרה.

4. אפשר להשבית את ההגדרות הבאות:

   הגדרת ניראות	תיאור
   הפעלת שדרוג של מעקבים ויומנים של OpenTelemetry	כשההגדרה הזו מושבתת, היא מפסיקה את האיסוף של עקבות, טווחים, יומני טווחים ומדדים. היא גם משביתה את ההגדרה הפעלת רישום ביומן של קלט בהנחיות ופלט בתגובות, כלומר לא נשלחים יומנים ל-Cloud Logging.
   הפעלת רישום ביומן של קלט הפרומפטים ופלט התשובות	כשהאפשרות הזו מושבתת, Cloud Logging לא רושם ביומן את קלט הפרומפטים ואת פלט התשובות.

REST

כדי להשבית את הגדרות ה-Observability באמצעות ה-API בארכיטקטורת REST, אפשר לעיין בקטעים הבאים:

• השבתת יכולת הצפייה ברמת האפליקציה (Core Assistant)
• השבתת יכולת הצפייה בסוכן ספציפי

השבתת יכולת הצפייה ברמת האפליקציה (Core Assistant)

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

מונח חשוב: ב-Gemini Enterprise, המונח אפליקציה יכול לשמש לחלופין למונח מנוע בהקשר של ממשקי API. מנוע Gemini Enterprise הוא מנוע חיפוש כללי שבו השדה app_type מוגדר לערך APP_TYPE_INTRANET.

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": false,
    "sensitiveLoggingEnabled": false
  }
}'

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

• ‫ENDPOINT_LOCATION: האזור הרב-אזורי של בקשת ה-API. מציינים אחד מהערכים הבאים:
  • ‫us לאזור עם מספר אזורים בארה"ב
  • ‫eu לאזור עם מספר אזורים באיחוד האירופי
  • global למיקום הגלובלי
  מידע נוסף זמין במאמר בנושא הגדרת אזור גיאוגרפי מרובה למאגר הנתונים.
• ‫PROJECT_ID: מזהה הפרויקט.
• ‫LOCATION: האזור המרובה של מאגר הנתונים: global,‏ us או eu
• ‫APP_ID: מזהה האפליקציה.

השבתת יכולת הצפייה בסוכן ספציפי

כדי להשבית את יכולת הצפייה בסוכן ספציפי (למשל סוכן של כלי בניית תהליכי עבודה או סוכן מחקר מעמיק), מריצים את הפקודה הבאה:

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant/agents/AGENT_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": false,
    "sensitiveLoggingEnabled": false
  }
}'

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

• ‫ENDPOINT_LOCATION: האזור הרב-אזורי של בקשת ה-API. מציינים אחד מהערכים הבאים:
  • ‫us לאזור עם מספר אזורים בארה"ב
  • ‫eu לאזור עם מספר אזורים באיחוד האירופי
  • global למיקום הגלובלי
  מידע נוסף זמין במאמר בנושא הגדרת אזור גיאוגרפי מרובה למאגר הנתונים.
• ‫PROJECT_ID: מזהה הפרויקט.
• ‫LOCATION: האזור המרובה של מאגר הנתונים: global,‏ us או eu
• ‫APP_ID: מזהה האפליקציה.
• ‫AGENT_ID: המזהה של הסוכן שרוצים להגדיר

המאמרים הבאים

• מידע נוסף על גישה ליומנים של Gemini Enterprise זמין במאמר גישה ליומני ביקורת על השימוש.
• מידע נוסף על גישה לנתוני מעקב וטווח של Gemini Enterprise זמין במאמר גישה למעקבים ולטווחים בכלי Trace Explorer.
• מידע נוסף על גישה למדדים של Gemini Enterprise זמין במאמר גישה למדדים ב-Metrics Explorer.