REST Resource: projects.locations.collections.engines

משאב: מנוע

מטא-נתונים שמתארים את פרמטרי האימון וההצגה של Engine.

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "dataStoreIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "commonConfig": {
    object (CommonConfig)
  },
  "knowledgeGraphConfig": {
    object (KnowledgeGraphConfig)
  },
  "appType": enum (AppType),
  "disableAnalytics": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "cmekConfig": {
    object (CmekConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "observabilityConfig": {
    object (ObservabilityConfig)
  },
  "connectorTenantInfo": {
    string: string,
    ...
  },
  "agentGatewaySetting": {
    object (AgentGatewaySetting)
  },
  "marketplaceAgentVisibility": enum (MarketplaceAgentVisibility),
  "procurementContactEmails": [
    string
  ],
  "associatedAgentRegistry": string,

  // Union field engine_config can be only one of the following:
  "similarDocumentsConfig": {
    object (SimilarDocumentsEngineConfig)
  },
  "chatEngineConfig": {
    object (ChatEngineConfig)
  },
  "searchEngineConfig": {
    object (SearchEngineConfig)
  },
  "mediaRecommendationEngineConfig": {
    object (MediaRecommendationEngineConfig)
  }
  // End of list of possible types for union field engine_config.

  // Union field engine_metadata can be only one of the following:
  "recommendationMetadata": {
    object (RecommendationMetadata)
  },
  "chatEngineMetadata": {
    object (ChatEngineMetadata)
  }
  // End of list of possible types for union field engine_metadata.
}
שדות
name

string

אי אפשר לשנות. מזהה. השם המוגדר במלואו של המשאב של המנוע.

השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים.

פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine צריך לכלול 1-63 תווים, והתווים התקפים הם ‎ /[a-z0-9][a-z0-9-_]*/‎. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

displayName

string

חובה. השם המוצג של המנוע. צריך להיות קריא לאנשים. מחרוזת בקידוד UTF-8 עם מגבלה של 1,024 תווים.

createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה נוצר מנוע ההמלצות.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה מערכת ההמלצות עודכנה לאחרונה.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

dataStoreIds[]

string

זה שינוי אופציונלי. מאגרי הנתונים שמשויכים למנוע הזה.

מנועים מסוג SOLUTION_TYPE_SEARCH ו-SOLUTION_TYPE_RECOMMENDATION יכולים להיות משויכים למאגר נתונים אחד לכל היותר.

אם solutionType הוא SOLUTION_TYPE_CHAT, אפשר לשייך כאן כמה DataStore באותו Collection.

הערה: כשמשתמשים ב-CreateEngineRequest, צריך לספק מזהה DataStore אחד, כי המערכת תשתמש בו לאתחולים הנדרשים.

solutionType

enum (SolutionType)

חובה. הפתרונות של המנוע.

industryVertical

enum (IndustryVertical)

זה שינוי אופציונלי. הענף שבו המנוע רשום. ההגבלה של הענף במנוע מבוססת על DataStore: הענף במנוע צריך להיות זהה לענף במאגר הנתונים שמקושר למנוע.

commonConfig

object (CommonConfig)

מפרט הגדרה נפוץ שמציין את המטא-נתונים של מנוע החיפוש.

knowledgeGraphConfig

object (KnowledgeGraphConfig)

זה שינוי אופציונלי. הגדרות ל-Knowledge Graph. רלוונטי רק אם solutionType הוא SOLUTION_TYPE_SEARCH.

appType

enum (AppType)

זה שינוי אופציונלי. אי אפשר לשנות. סוג האפליקציה שמקור המידע הזה מייצג. הערה: זהו מושג חדש שלא קשור לקטגוריות ענפיות קיימות או לסוגי פתרונות קיימים.

disableAnalytics

boolean

זה שינוי אופציונלי. האם להשבית את ניתוח הנתונים של חיפושים שבוצעו במנוע הזה.

features

map (key: string, value: enum (FeatureState))

זה שינוי אופציונלי. הגדרת התכונה של המנוע כדי להצטרף לתכונות או לבטל את ההצטרפות אליהן. מקשים נתמכים:

  • *: כל התכונות. אם הערך הזה מופיע, המערכת מתעלמת מכל שאר ההגדרות של מצב התכונה.
  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • disable-skills
  • disable-projects
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
cmekConfig

object (CmekConfig)

פלט בלבד. מידע שקשור ל-CMEK עבור המנוע.

configurableBillingApproach

enum (ConfigurableBillingApproach)

זה שינוי אופציונלי. הגדרה של גישת חיוב שניתנת להתאמה אישית.

modelConfigs

map (key: string, value: enum (ModelState))

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

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

observabilityConfig

object (ObservabilityConfig)

זה שינוי אופציונלי. הגדרת ניראות (observability) למנוע.

connectorTenantInfo

map (key: string, value: string)

זה שינוי אופציונלי. מיפוי של מזהה מחבר (לדוגמה, hybrid-github או shopify) למידע ספציפי לדייר שנדרש למחבר הזה. המבנה של מחרוזת המידע על הדייר תלוי במחבר.

agentGatewaySetting

object (AgentGatewaySetting)

זה שינוי אופציונלי. הגדרת שער הסוכן למנוע.

marketplaceAgentVisibility

enum (MarketplaceAgentVisibility)

זה שינוי אופציונלי. הרשאות הגישה לסוכנים בזירת המסחר בגלריית הסוכנים.

procurementContactEmails[]

string

זה שינוי אופציונלי. כתובות האימייל של אנשי הקשר בנושא רכש.

associatedAgentRegistry

string

פלט בלבד. מאגר הסוכנים שמכיל את הסוכנים, שרתי ה-MCP והכלים שמשויכים למנוע הזה. הוא נגזר בצד השרת מהרישום של Agent Gateway המקושר.

שדה איחוד engine_config. מפרטי הגדרה נוספים שמגדירים את ההתנהגות של המנוע. הערך engine_config יכול להיות רק אחד מהבאים:
similarDocumentsConfig

object (SimilarDocumentsEngineConfig)

מפרטי הגדרה נוספים למנוע similar-items.

chatEngineConfig

object (ChatEngineConfig)

הגדרות של Chat Engine. רלוונטי רק אם solutionType הוא SOLUTION_TYPE_CHAT.

searchEngineConfig

object (SearchEngineConfig)

הגדרות של מנוע החיפוש. רלוונטי רק אם solutionType הוא SOLUTION_TYPE_SEARCH.

mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

הגדרות של Media Engine. האפשרות הזו רלוונטית רק למאגרי נתונים עם solutionType SOLUTION_TYPE_RECOMMENDATION ועם IndustryVertical.MEDIA.

שדה איחוד engine_metadata. מטא-נתונים של המנוע כדי לעקוב אחרי הסטטוס שלו. הערך engine_metadata יכול להיות רק אחד מהבאים:
recommendationMetadata

object (RecommendationMetadata)

פלט בלבד. מידע נוסף על מערכת המלצות. רלוונטי רק אם solutionType הוא SOLUTION_TYPE_RECOMMENDATION.

chatEngineMetadata

object (ChatEngineMetadata)

פלט בלבד. מידע נוסף על Chat Engine. רלוונטי רק אם solutionType הוא SOLUTION_TYPE_CHAT.

SimilarDocumentsEngineConfig

בסוג הזה אין שדות.

מפרטי הגדרה נוספים למנוע similar-items.

ChatEngineConfig

הגדרות של Chat Engine.

ייצוג ב-JSON
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
שדות
agentCreationConfig

object (AgentCreationConfig)

התצורה ליצירת סוכן Dialogflow שמשויך למנוע הזה.

ההגדרות האלה נצרכות פעם אחת על ידי שירות Dialogflow ומועברות אליו. המשמעות היא שלא ניתן לאחזר אותם באמצעות EngineService.GetEngine או EngineService.ListEngines API אחרי יצירת המנוע.

allowCrossRegion

boolean

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

חשוב לזכור שallowCrossRegion נצרכים פעם אחת על ידי EngineService.CreateEngine ומועברים אליו. המשמעות היא שלא ניתן לאחזר אותם באמצעות EngineService.GetEngine או EngineService.ListEngines API אחרי יצירת המנוע.

AgentCreationConfig

הגדרות ליצירת סוכן Dialogflow.

ההגדרות האלה נצרכות פעם אחת על ידי שירות Dialogflow ומועברות אליו. המשמעות היא שלא ניתן לאחזר אותם באמצעות EngineService.GetEngine או EngineService.ListEngines API אחרי יצירת המנוע.

ייצוג ב-JSON
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
שדות
business

string

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

defaultLanguageCode

string

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

timeZone

string

חובה. אזור הזמן של הנציג ממסד הנתונים של אזורי הזמן, למשל America/New_York, Europe/Paris.

location

string

מיקום הסוכן ליצירת סוכן, ערכים נתמכים: global/us/eu. אם לא מספקים מיקום, מנוע ארה"ב ייצור סוכן באמצעות us-central-1 כברירת מחדל, ומנוע האיחוד האירופי ייצור סוכן באמצעות eu-west-1 כברירת מחדל.

SearchEngineConfig

הגדרות של מנוע חיפוש.

ייצוג ב-JSON
{
  "searchTier": enum (SearchTier),
  "requiredSubscriptionTier": enum (SubscriptionTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
שדות
searchTier

enum (SearchTier)

רמת תכונת החיפוש של המנוע הזה.

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

אם לא מציינים ערך, ברירת המחדל היא SearchTier.SEARCH_TIER_STANDARD.

requiredSubscriptionTier

enum (SubscriptionTier)

זה שינוי אופציונלי. רמת המינוי הנדרשת של המנוע הזה.

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

התכונה 'הארקה באינטרנט' זמינה באפליקציה רק אם היא מוגדרת כ-SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.

searchAddOns[]

enum (SearchAddOn)

התוסף שמנוע החיפוש הזה מפעיל.

SearchTier

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

טיפוסים בני מנייה (enum)
SEARCH_TIER_UNSPECIFIED ערך ברירת המחדל אם לא מציינים ערך enum. השימוש בערך הזה לא תקין.
SEARCH_TIER_STANDARD מסלול רגיל.
SEARCH_TIER_ENTERPRISE רמה ארגונית.

SearchAddOn

תוסף שמספק פונקציונליות נוספת לחיפוש.

טיפוסים בני מנייה (enum)
SEARCH_ADD_ON_UNSPECIFIED ערך ברירת המחדל אם לא מציינים ערך enum. השימוש בערך הזה לא תקין.
SEARCH_ADD_ON_LLM תוסף של מודל שפה גדול (LLM).

MediaRecommendationEngineConfig

מפרטים נוספים להגדרת מנוע המלצות למדיה.

ייצוג ב-JSON
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
שדות
type

string

חובה. סוג המנוע. לדוגמה, recommended-for-you.

השדה הזה, יחד עם optimizationObjective, מתאר את המטא-נתונים של המנוע שמשמשים לשליטה באימון המנוע ובשירות שלו.

ערכים נתמכים כרגע: recommended-for-you, ‏ others-you-may-like, ‏ more-like-this, ‏ most-popular-items.

optimizationObjective

string

יעד האופטימיזציה. לדוגמה, cvr.

השדה הזה, יחד עם optimizationObjective, מתאר את המטא-נתונים של המנוע שמשמשים לשליטה באימון המנוע ובשירות שלו.

הערכים הנתמכים כרגע: ctr, ‏ cvr.

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

recommended-for-you => ctr

others-you-may-like => ctr

optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

השם והערך של סף ההמרות המותאם אישית לאופטימיזציה של יעד ההמרות. במקרה של targetField watch-time, הערך של target_field_value צריך להיות מספר שלם שמציין את זמן ההתקדמות של המדיה בשניות בין (0, 86400] (לא כולל 0, כולל 86400) (לדוגמה, 90). בשדה היעד watch-percentage, הערך של target_field_value חייב להיות מספר עשרוני חוקי בין (0, 1.0] (לא כולל 0, כולל 1.0) (לדוגמה, 0.5).

trainingState

enum (TrainingState)

מצב האימון של המנוע (למשל TRAINING או PAUSED).

חלק מהעלות של הפעלת השירות הוא תדירות האימון – אפשר להשתמש בזה כדי לקבוע מתי לאמן את המנוע כדי לשלוט בעלות. אם לא מציינים שיטה: ערך ברירת המחדל של השיטה engines.create הוא TRAINING. ערך ברירת המחדל של השיטה engines.patch הוא לשמור על המצב כמו קודם.

engineFeaturesConfig

object (EngineFeaturesConfig)

זה שינוי אופציונלי. הגדרת תכונות נוספות של המנוע.

OptimizationObjectiveConfig

סף מותאם אישית ליעד האופטימיזציה cvr.

ייצוג ב-JSON
{
  "targetField": string,
  "targetFieldValueFloat": number
}
שדות
targetField

string

חובה. שם השדה לטירגוט. הערכים הנתמכים כרגע: watch-percentage, ‏ watch-time.

targetFieldValueFloat

number

חובה. סף ההגדרה שיוחל על היעד (לדוגמה, 0.5).

TrainingState

מצב האימון של המנוע.

טיפוסים בני מנייה (enum)
TRAINING_STATE_UNSPECIFIED לא צוין סטטוס אימון.
PAUSED האימון של המנוע מושהה.
TRAINING המנוע נמצא בתהליך אימון.

EngineFeaturesConfig

הגדרות נוספות של התכונות של סוג המנוע שנבחר.

ייצוג ב-JSON
{

  // Union field type_dedicated_config can be only one of the following:
  "recommendedForYouConfig": {
    object (RecommendedForYouFeatureConfig)
  },
  "mostPopularConfig": {
    object (MostPopularFeatureConfig)
  }
  // End of list of possible types for union field type_dedicated_config.
}
שדות
שדה איחוד type_dedicated_config. הגדרות שקשורות לתכונות שחלות על סוג מסוים של מנועי המלצות למדיה. הערך type_dedicated_config יכול להיות רק אחד מהבאים:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

המלצות להגדרת תכונות של מנוע.

RecommendedForYouFeatureConfig

הגדרות נוספות ליצירת מנוע recommended-for-you.

ייצוג ב-JSON
{
  "contextEventType": string
}
שדות
contextEventType

string

סוג האירוע שהמנוע מבצע לגביו שאילתה בזמן החיזוי. אם הערך מוגדר כ-generic, רק view-item, media-play ו-media-complete ישמשו כ-context-event באימון המנוע. אם הערך מוגדר כ-view-home-page,‏ view-home-page ישמש גם כ-context-events בנוסף ל-view-item,‏ media-play ו-media-complete. התמיכה קיימת כרגע במנוע recommended-for-you. הערכים הנתמכים כרגע: view-home-page, ‏ generic.

MostPopularFeatureConfig

הגדרות של תכונות שנדרשות ליצירת מנוע 'הכי פופולרי'.

ייצוג ב-JSON
{
  "timeWindowDays": string
}
שדות
timeWindowDays

string (int64 format)

חלון הזמן שבו מתבצעת שאילתה במנוע בזמן האימון והחיזוי. מספרים שלמים חיוביים בלבד. הערך מתייחס לאירועים מ-X הימים האחרונים. נדרש כרגע למנוע most-popular-items.

RecommendationMetadata

מידע נוסף על מערכת המלצות.

ייצוג ב-JSON
{
  "servingState": enum (ServingState),
  "dataState": enum (DataState),
  "lastTuneTime": string,
  "lastTrainTime": string,
  "tuningOperation": string
}
שדות
servingState

enum (ServingState)

פלט בלבד. מצב ההצגה של המנוע: ACTIVE, NOT_ACTIVE.

dataState

enum (DataState)

פלט בלבד. מצב הדרישות לגבי נתונים במנוע הזה: DATA_OK וDATA_ERROR.

אי אפשר לאמן את המנוע אם הנתונים במצב DATA_ERROR. למנוע יכול להיות סטטוס DATA_ERROR גם אם סטטוס ההצגה הוא ACTIVE: המנועים אומנו בהצלחה בעבר, אבל אי אפשר לרענן אותם כי למנוע הבסיסי אין יותר מספיק נתונים לאימון.

lastTuneTime

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

lastTrainTime

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

tuningOperation

string

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

אם מזהה הפעולה הזה קיים, אפשר להשתמש בו כדי לקבוע אם מתבצע כוונון של המנוע הזה. כדי לבדוק את סטטוס הפעולה, שולחים את הבקשה operations.get עם מזהה הפעולה הזה בפורמט של משאב המנוע. אם לא בוצע כוונון של המנוע הזה, המחרוזת ריקה.

ServingState

סטטוס ההצגה של מערכת ההמלצות.

טיפוסים בני מנייה (enum)
SERVING_STATE_UNSPECIFIED לא צוין סטטוס הצגה.
INACTIVE המנוע לא מציג מודעות.
ACTIVE המנוע פועל ואפשר לשלוח אליו שאילתות.
TUNED המנוע מאומן על היפר-פרמטרים מכווננים ואפשר להריץ עליו שאילתות.

DataState

מתאר אם למנוע הזה יש מספיק נתוני אימון כדי להמשיך להתאמן.

טיפוסים בני מנייה (enum)
DATA_STATE_UNSPECIFIED ערך ברירת המחדל לא צוין, ואסור להגדיר אותו באופן מפורש.
DATA_OK למנוע יש מספיק נתוני אימון.
DATA_ERROR אין למנוע מספיק נתוני אימון. אפשר לשלוח שאילתות לגבי הודעות שגיאה דרך Stackdriver.

ChatEngineMetadata

מידע נוסף על Chat Engine. השדות בהודעה הזו הם פלט בלבד.

ייצוג ב-JSON
{
  "dialogflowAgent": string
}
שדות
dialogflowAgent

string

שם המשאב של סוכן Dialogflow שאליו מתייחסת המערכת Chat Engine.

פורמט: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>

CommonConfig

הגדרות נפוצות של מנוע.

ייצוג ב-JSON
{
  "companyName": string
}
שדות
companyName

string

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

KnowledgeGraphConfig

הודעת הגדרה ל-Knowledge Graph.

ייצוג ב-JSON
{
  "enableCloudKnowledgeGraph": boolean,
  "cloudKnowledgeGraphTypes": [
    string
  ],
  "enablePrivateKnowledgeGraph": boolean,
  "privateKnowledgeGraphTypes": [
    string
  ],
  "featureConfig": {
    object (FeatureConfig)
  }
}
שדות
enableCloudKnowledgeGraph

boolean

האם להפעיל את Cloud Knowledge Graph במנוע.

אם לא מציינים ערך, ברירת המחדל היא false.

cloudKnowledgeGraphTypes[]

string

מציינים את סוגי הישויות שרוצים לתמוך בהן.

enablePrivateKnowledgeGraph

boolean

האם להפעיל את תרשים הידע הפרטי במנוע.

אם לא מציינים ערך, ברירת המחדל היא false.

privateKnowledgeGraphTypes[]

string

מציינים את סוגי הישויות שרוצים לתמוך בהן.

featureConfig

object (FeatureConfig)

זה שינוי אופציונלי. הגדרת התכונה של Knowledge Graph.

FeatureConfig

הגדרת התכונה של Knowledge Graph.

ייצוג ב-JSON
{
  "disablePrivateKgQueryUnderstanding": boolean,
  "disablePrivateKgEnrichment": boolean,
  "disablePrivateKgAutoComplete": boolean,
  "disablePrivateKgQueryUiChips": boolean
}
שדות
disablePrivateKgQueryUnderstanding

boolean

האם להשבית את ההבנה של שאילתות פרטיות ב-KG במנוע.

אם לא מציינים ערך, ברירת המחדל היא false.

disablePrivateKgEnrichment

boolean

האם להשבית את ההעשרה של הגרף הפרטי של הידע במנוע.

אם לא מציינים ערך, ברירת המחדל היא false.

disablePrivateKgAutoComplete

boolean

האם להשבית את ההשלמה האוטומטית של KG פרטי למנוע.

אם לא מציינים ערך, ברירת המחדל היא false.

disablePrivateKgQueryUiChips

boolean

האם להשבית את ה-KG הפרטי בשבבי ממשק המשתמש של השאילתות.

אם לא מציינים ערך, ברירת המחדל היא false.

AppType

האפליקציה של המנוע.

טיפוסים בני מנייה (enum)
APP_TYPE_UNSPECIFIED כל האפליקציות שלא צוינו.
APP_TYPE_INTRANET סוג האפליקציה לחיפוש באינטראנט ול-Agentspace.

FeatureState

המצב של התכונה במנוע.

טיפוסים בני מנייה (enum)
FEATURE_STATE_UNSPECIFIED לא צוין מצב התכונה.
FEATURE_STATE_ON התכונה מופעלת כדי שתהיה נגישה.
FEATURE_STATE_OFF התכונה מושבתת כדי שלא תהיה אליה גישה.

ConfigurableBillingApproach

הגדרה של גישת חיוב שניתנת להתאמה אישית.

טיפוסים בני מנייה (enum)
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED ערך ברירת המחדל. ב-Spark ובגישת חיוב לא ניתנת להגדרה שאינה Spark. מודל תמחור כללי.
CONFIGURABLE_BILLING_APPROACH_ENABLED הגישה לחיוב מבוססת על ההגדרות שצוינו על ידי הלקוח.

ModelState

הסטטוס של המודל במנוע.

טיפוסים בני מנייה (enum)
MODEL_STATE_UNSPECIFIED מצב המודל לא צוין.
MODEL_ENABLED האדמין הפעיל את המודל.
MODEL_DISABLED האדמין השבית את המודל.

AgentGatewaySetting

הגדרה של Agent Gateway, שאולי מצורפת למשאבי Gemini Enterprise לצורך שליטה ביציאה של סוכני Gemini Enterprise לסוכנים ולכלים מחוץ ל-Gemini Enterprise.

ייצוג ב-JSON
{
  "defaultEgressAgentGateway": {
    object (AgentGatewayReference)
  }
}
שדות
defaultEgressAgentGateway

object (AgentGatewayReference)

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

מצב הפריסה צריך להיות GOOGLE_MANAGED, ונתיב הגישה המנוהל צריך להיות AGENT_TO_ANYWHERE.

AgentGatewayReference

הפניה למשאב של Agent Gateway.

ייצוג ב-JSON
{
  "name": string
}
שדות
name

string

חובה. אי אפשר לשנות. שם המשאב של שער הסוכן.

הפורמט הנדרש: projects/{projectNumber}/locations/{location}/agentGateways/{agent_gateway}.

MarketplaceAgentVisibility

מייצג את הסוכנים ב-Marketplace שגלויים לכל המשתמשים בגלריית הסוכנים.

טיפוסים בני מנייה (enum)
MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED ברירת המחדל היא MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED.
SHOW_AVAILABLE_AGENTS_ONLY רק סוכנים שזמינים כרגע לשימוש על ידי המשתמשים מוצגים.
SHOW_AGENTS_ALREADY_INTEGRATED הצגת סוכני Marketplace שלמשתמש עדיין אין גישה אליהם, אבל הם משולבים במנוע. הרמה הזו כוללת גם את כל הסוכנים שמוצגים עם SHOW_AVAILABLE_AGENTS_ONLY.
SHOW_AGENTS_ALREADY_PURCHASED הצגת כל הסוכנים שגלויים עם SHOW_AGENTS_ALREADY_INTEGRATED, בתוספת סוכנים שכבר נרכשו על ידי הפרויקט או הארגון, גם אם הם לא משולבים כרגע במנוע.
SHOW_ALL_AGENTS כל הסוכנים ב-Marketplace גלויים, ללא קשר לסטטוס הגישה או הרכישה. הרמה הזו כוללת את כל הסוכנים שמוצגים ברמות הקודמות.

Methods

create

יוצרת Engine.

delete

מוחקת Engine.

get

הפונקציה מחזירה Engine.

getCompletionConfig

מקבלים CompletionConfig

getIamPolicy

מקבל את מדיניות בקרת הגישה ב-IAM עבור Engine.

getWorkspaceSettings

מקבלים את הגדרות Workspace למשתמש הקצה.

list

רשימה של כל Engine שמשויכים לפרויקט.

patch

עדכון של Engine

pause

השהיית האימון של Engine קיים.

resume

ממשיכים את האימון של Engine קיים.

setIamPolicy

הגדרת מדיניות בקרת הגישה ב-IAM עבור Engine.

tune

מכוונן Engine קיים.

updateCompletionConfig

מעדכן את CompletionConfig.