הגדרת יומני ביקורת לשימוש ב-Gemini Enterprise

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

אתם יכולים לנהל את ביקורת השימוש ב-Gemini Enterprise באמצעות ההגדרות ObservabilityConfig באפליקציית Gemini Enterprise. הפעלת האפשרות 'יכולת תצפית' מאפשרת ללכוד נתונים של בקשות ותשובות, כולל הנחיות ומטא-נתונים של ביסוס, ולשמור אותם ב-Cloud Logging.

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

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

  • כדי להפעיל את רישום הביקורת ביומן, צריך להיות לכם תפקיד אדמין של Discovery Engine (roles/discoveryengine.admin) ב-IAM.
  • כדי לגשת ל-Cloud Logging, צריך לקבל את תפקיד ה-IAM‏ Logs Viewer (roles/logging.viewer).

הפעלה של רישום ביומן ביקורת של השימוש באפליקציות

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

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

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

REST

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: השם המוצג של האפליקציה שרוצים ליצור.

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

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

REST

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: מזהה האפליקציה.

המידע שתועד

בטבלה הבאה מפורטים נתוני השימוש שנרשמים ביומן של Gemini Enterprise:

נתיב השירות נתונים שתועדו
SearchService.Search

הנתונים נרשמים ביומן במקורות שמשמשים להארקה או כקלט ל-LLM.

בקשה:
  • query
  • user_info

תשובה:
  • attribution_token
  • results.id
AssistantService.Assist

רישום ביומן של הבקשה והתשובה מהעוזר של Gemini Enterprise.

בקשה:
  • name
  • query.text
  • query.parts

תשובה:
  • assist_token
  • answer.name
  • answer.state
  • answer.replies.grounded_content.text
  • answer.replies.grounded_content.text_grounding_metadata.segments
  • answer.replies.grounded_content.text_grounding_metadata.references
  • answer.skipped_reasons
AssistantService.StreamAssist בקשה:
  • name
  • query.text
  • query.parts
  • agents_spec

תשובה:
  • assist_token
  • answer.name
  • answer.state
  • answer.replies.grounded_content.text
  • answer.replies.grounded_content.text_grounding_metadata.segments
  • answer.replies.grounded_content.text_grounding_metadata.references
  • answer.skipped_reasons
ConversationSearchService.AnswerQuery בקשה:
  • serving_config
  • query.query_id
  • query.text
  • session
  • user_pseudo_id
  • end_user_spec
  • answer_generation_spec.model_spec.model_version
  • answer_generation_spec.prompt_spec.preamble
  • answer_generation_spec.include_citations
  • answer_generation_spec.answer_language_code
  • answer_generation_spec.ignore_adversarial_query
  • answer_generation_spec.ignore_non_answer_seeking_query
  • answer_generation_spec.ignore_jail_breaking_query

תשובה:
  • answer
  • answer_query_token
EngineService.CreateEngine בקשה:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores

תשובה:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
EngineService.UpdateEngine בקשה:
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
  • update_mask

תשובה:
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
AgentService.SetIamPolicy בקשה:
  • policy.bindings.roles
  • policy.bindings.members

תשובה:
  • policy.bindings.roles
  • policy.bindings.members
AgentService.CreateAgent בקשה:
  • parent
  • agent_id
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case

תשובה:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
AgentService.UpdateAgent בקשה:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
  • update_mask

תשובה:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
AgentService.CreateAgentRequest בקשה:
  • parent
  • agent_id
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case

תשובה:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
GroundedGenerationService.GenerateGroundedContent בקשה:
  • contents
  • location
  • generation_spec
  • system_instruction
  • safety_settings
  • user_labels
  • grounding_spec.explicit_search_queries
  • grounding_spec.grounding_sources

תשובה:
  • content
  • grounding_metadata
  • grounding_score
DataConnectorService.UpdateDataConnector בקשה:
  • data_connector.name
  • data_connector.create_time
  • data_connector.update_time
  • data_connector.data_source
  • data_connector.refresh_interval
  • data_connector.bap_config

תשובה:
  • data_connector.name
  • data_connector.create_time
  • data_connector.update_time
  • data_connector.data_source
  • data_connector.refresh_interval
  • data_connector.bap_config
AssistantService.AddContextFile בקשה:
  • name
  • file_name

תשובה:
  • session
  • file_id
AssistantService.UploadSessionFile בקשה:
  • name
  • blob.filename

תשובה:
  • file_id

גישה ליומני שימוש

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

  1. נכנסים לדף Logs Explorer במסוף Google Cloud .

    כניסה לדף Logs Explorer

  2. בוחרים את Google Cloud הפרויקט שבו הפעלתם את יומני הביקורת.

  3. כדי להציג רק את היומנים של Gemini Enterprise, מזינים את השאילתה הבאה בשדה עורך השאילתות ולוחצים על Run Query:

      logName="projects/PROJECT_ID/logs/discoveryengine.googleapis.com%2Fgemini_enterprise_user_activity

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

    • ‫PROJECT_ID: מזהה הפרויקט.

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

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

REST

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: מזהה האפליקציה.