- משאב: Engine
- ChatEngineConfig
- AgentCreationConfig
- SearchEngineConfig
- SearchTier
- SearchAddOn
- MediaRecommendationEngineConfig
- OptimizationObjectiveConfig
- TrainingState
- EngineFeaturesConfig
- RecommendedForYouFeatureConfig
- MostPopularFeatureConfig
- ChatEngineMetadata
- CommonConfig
- KnowledgeGraphConfig
- FeatureConfig
- AppType
- FeatureState
- ConfigurableBillingApproach
- ModelState
- ObservabilityConfig
- AgentGatewaySetting
- AgentGatewayReference
- MarketplaceAgentVisibility
- Methods
משאב: מנוע
מטא-נתונים שמתארים את פרמטרי האימון וההצגה של Engine.
| ייצוג JSON |
|---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "dataStoreIds": [ string ], "solutionType": enum ( |
| שדות | |
|---|---|
name |
אי אפשר לשנות. מזהה. השם המוגדר במלואו של המשאב של המנוע. השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים. פורמט: |
displayName |
חובה. השם המוצג של המנוע. התיאור צריך להיות קריא לאנשים. מחרוזת בקידוד UTF-8 עם מגבלה של 1,024 תווים. |
createTime |
פלט בלבד. חותמת הזמן שבה נוצר מנוע ההמלצות. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
updateTime |
פלט בלבד. חותמת הזמן שבה מערכת ההמלצות עודכנה לאחרונה. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
dataStoreIds[] |
זה שינוי אופציונלי. מאגרי הנתונים שמשויכים למנוע הזה. מנועים מסוג אם הערה: כשמשתמשים ב- |
solutionType |
חובה. הפתרונות של המנוע. |
industryVertical |
זה שינוי אופציונלי. הענף שבו המנוע רשום. ההגבלה של הענף במנוע מבוססת על |
commonConfig |
מפרט הגדרה נפוץ שמציין את המטא-נתונים של מנוע החיפוש. |
knowledgeGraphConfig |
זה שינוי אופציונלי. הגדרות של Knowledge Graph. רלוונטי רק אם |
appType |
זה שינוי אופציונלי. אי אפשר לשנות. סוג האפליקציה שמקור המידע הזה מייצג. הערה: זהו מושג חדש שלא קשור לקטגוריות ענפיות קיימות או לסוגי פתרונות קיימים. |
disableAnalytics |
זה שינוי אופציונלי. האם להשבית את ניתוח הנתונים של חיפושים שבוצעו במנוע הזה. |
features |
זה שינוי אופציונלי. הגדרת התכונה של המנוע כדי להצטרף לתכונות או לבטל את ההצטרפות אליהן. מקשים נתמכים:
|
cmekConfig |
פלט בלבד. מידע שקשור ל-CMEK ב-Engine. |
configurableBillingApproach |
זה שינוי אופציונלי. הגדרה של גישת חיוב שניתנת להתאמה אישית. |
modelConfigs |
זה שינוי אופציונלי. מיפוי של שם מודל להגדרה הספציפית שלו במנוע הזה. כך משתמשים עם הרשאת אדמין יכולים להפעיל או להשבית מודלים ספציפיים. במאגר הזה נשמרים רק מודלים שהאדמין שינה את המצב שלהם. אם המצב לא מצוין, או אם modelConfigs ריק עבור המודל הזה, המערכת תחליט אם המודל הזה יהיה זמין או לא על סמך הגדרת ברירת המחדל. לדוגמה, מודל תצוגה מקדימה צריך להיות מושבת כברירת מחדל אם האדמין לא בחר להפעיל אותו. |
observabilityConfig |
זה שינוי אופציונלי. הגדרת ניראות (observability) למנוע. |
connectorTenantInfo |
זה שינוי אופציונלי. מיפוי של מזהה מחבר (לדוגמה, hybrid-github או shopify) למידע ספציפי לדייר שנדרש עבור המחבר הזה. המבנה של מחרוזת פרטי הדייר תלוי במחבר. |
agentGatewaySetting |
זה שינוי אופציונלי. הגדרת שער הסוכן למנוע. |
marketplaceAgentVisibility |
זה שינוי אופציונלי. החשיפה של סוכני Marketplace בגלריית הסוכנים. |
procurementContactEmails[] |
זה שינוי אופציונלי. כתובות האימייל של אנשי הקשר בנושא רכש. |
associatedAgentRegistry |
פלט בלבד. מאגר הסוכנים שמכיל את הסוכנים, שרתי ה-MCP והכלים שמשויכים למנוע הזה. נגזר בצד השרת מהמרשם של Agent Gateway המקושר. |
| מפרטי הגדרה נוספים שמגדירים את ההתנהגות של המנוע. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה: | |
chatEngineConfig |
הגדרות של Chat Engine. רלוונטי רק אם |
searchEngineConfig |
הגדרות של מנוע החיפוש. רלוונטי רק אם |
mediaRecommendationEngineConfig |
הגדרות של Media Engine. האפשרות הזו רלוונטית רק למאגרי נתונים עם |
| סוף השדות הבלעדיים. | |
| מטא-נתונים של המנוע כדי לעקוב אחרי הסטטוס שלו. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה: | |
chatEngineMetadata |
פלט בלבד. מידע נוסף על Chat Engine. רלוונטי רק אם |
| סוף השדות הבלעדיים. | |
ChatEngineConfig
הגדרות של Chat Engine.
| ייצוג JSON |
|---|
{
"agentCreationConfig": {
object ( |
| שדות | |
|---|---|
agentCreationConfig |
התצורה ליצירת סוכן Dialogflow שמשויך למנוע הזה. חשוב לציין שההגדרות האלה נצרכות פעם אחת על ידי שירות Dialogflow ומועברות אליו. המשמעות היא שלא ניתן לאחזר אותם באמצעות |
dialogflowAgentToLink |
שם המשאב של סוכן Dialogflow קיים לקישור למנוע Chat הזה. הלקוחות יכולים לספק פורמט: הערה: המידע |
allowCrossRegion |
זה שינוי אופציונלי. אם הדגל מוגדר כ-true, אנחנו מאפשרים לסוכן ולמנוע להיות במיקומים שונים. אחרת, הסוכן והמנוע צריכים להיות באותו מיקום. הסימון מוגדר כ-false כברירת מחדל. חשוב לזכור ש |
AgentCreationConfig
הגדרות ליצירת סוכן של Dialogflow.
חשוב לציין שההגדרות האלה נצרכות פעם אחת על ידי שירות Dialogflow ומועברות אליו. המשמעות היא שלא ניתן לאחזר אותם באמצעות EngineService.GetEngine או EngineService.ListEngines API אחרי יצירת המנוע.
| ייצוג JSON |
|---|
{ "business": string, "defaultLanguageCode": string, "timeZone": string, "location": string } |
| שדות | |
|---|---|
business |
שם החברה, הארגון או הישות האחרת שהסוכן מייצג. משמש להנחיה של LLM במחבר ידע ולחיפוש ידע. |
defaultLanguageCode |
חובה. שפת ברירת המחדל של הסוכן כתג שפה. כאן אפשר לעיין ברשימת קודי השפות הנתמכים כרגע. |
timeZone |
חובה. אזור הזמן של הנציג ממסד הנתונים של אזורי הזמן, למשל America/New_York, Europe/Paris. |
location |
מיקום הסוכן ליצירת סוכן, ערכים נתמכים: global/us/eu. אם לא מספקים מיקום, מנוע ארה"ב ייצור סוכן באמצעות us-central-1 כברירת מחדל, ומנוע האיחוד האירופי ייצור סוכן באמצעות eu-west-1 כברירת מחדל. |
SearchEngineConfig
הגדרות של מנוע חיפוש.
| ייצוג JSON |
|---|
{ "searchTier": enum ( |
| שדות | |
|---|---|
searchTier |
רמת התכונות של מנוע החיפוש הזה. יכול להיות שיהיו רמות שונות עם תמחור שונה. מידע נוסף זמין במסמכי התיעוד בנושא תמחור. אם לא מציינים ערך, ברירת המחדל היא |
requiredSubscriptionTier |
זה שינוי אופציונלי. רמת המינוי הנדרשת של המנוע הזה. אם רמת המינוי הנדרשת היא חיפוש, משתמש עם רמת רישיון גבוהה יותר, כמו assist, עדיין יכול לגשת לאפליקציה העצמאית שמשויכת למנוע הזה. התכונה 'הארקה באינטרנט' זמינה באפליקציה רק אם היא מוגדרת כ- |
searchAddOns[] |
התוסף שמנוע החיפוש הזה מפעיל. |
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 ( |
| שדות | |
|---|---|
type |
חובה. סוג המנוע. למשל, השדה הזה יחד עם ערכים נתמכים כרגע: |
optimizationObjective |
יעד האופטימיזציה. לדוגמה, השדה הזה יחד עם הערכים הנתמכים כרגע: אם לא מציינים, אנחנו בוחרים ברירת מחדל לפי סוג המנוע. ברירת המחדל תלויה בסוג ההמלצה:
|
optimizationObjectiveConfig |
השם והערך של סף ההמרות המותאם אישית לאופטימיזציה של יעד ההמרות. במקרה של targetField |
trainingState |
מצב האימון של המנוע (למשל חלק מהעלות של הפעלת השירות היא תדירות האימון – אפשר להשתמש בזה כדי לקבוע מתי לאמן את המנוע כדי לשלוט בעלויות. אם לא מציינים שיטה: ערך ברירת המחדל של השיטה |
engineFeaturesConfig |
זה שינוי אופציונלי. הגדרת תכונות נוספות של המנוע. |
OptimizationObjectiveConfig
סף מותאם אישית ליעד האופטימיזציה cvr.
| ייצוג JSON |
|---|
{ "targetField": string, "targetFieldValueFloat": number } |
| שדות | |
|---|---|
targetField |
חובה. שם השדה לטירגוט. הערכים הנתמכים כרגע: |
targetFieldValueFloat |
חובה. סף ההגדרה שיוחל על היעד (למשל, 0.5). |
TrainingState
מצב האימון של המנוע.
| טיפוסים בני מנייה (enum) | |
|---|---|
TRAINING_STATE_UNSPECIFIED |
לא צוין סטטוס אימון. |
PAUSED |
האימון של המנוע מושהה. |
TRAINING |
המנוע נמצא בתהליך אימון. |
EngineFeaturesConfig
הגדרות נוספות של התכונות של סוג המנוע שנבחר.
| ייצוג JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "recommendedForYouConfig": { object ( |
| שדות | |
|---|---|
| הגדרות שקשורות לתכונות שחלות על סוג מסוים של מנועי המלצות למדיה. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה: | |
recommendedForYouConfig |
המלצות להגדרת תכונות של מנוע. |
mostPopularConfig |
הגדרת התכונות הפופולרית ביותר של המנוע. |
| סוף השדות הבלעדיים. | |
RecommendedForYouFeatureConfig
הגדרות נוספות ליצירת מנוע recommended-for-you.
| ייצוג JSON |
|---|
{ "contextEventType": string } |
| שדות | |
|---|---|
contextEventType |
סוג האירוע שבו המנוע מבצע שאילתה בזמן החיזוי. אם הערך מוגדר כ- |
MostPopularFeatureConfig
הגדרות של תכונות שנדרשות ליצירת מנוע 'הכי פופולרי'.
| ייצוג JSON |
|---|
{ "timeWindowDays": string } |
| שדות | |
|---|---|
timeWindowDays |
חלון הזמן שבו מתבצעת שאילתה במנוע בזמן האימון והחיזוי. מספרים שלמים חיוביים בלבד. הערך מתייחס לאירועים מ-X הימים האחרונים. נדרש כרגע למנוע |
ChatEngineMetadata
מידע נוסף על Chat Engine. השדות בהודעה הזו הם פלט בלבד.
| ייצוג JSON |
|---|
{ "dialogflowAgent": string } |
| שדות | |
|---|---|
dialogflowAgent |
שם המשאב של סוכן Dialogflow שאליו מתייחס מנוע Chat. פורמט: |
CommonConfig
הגדרות נפוצות של מנוע.
| ייצוג JSON |
|---|
{ "companyName": string } |
| שדות | |
|---|---|
companyName |
השם של החברה, העסק או הישות שמשויכים למנוע. הגדרה כזו עשויה לעזור לשפר תכונות שקשורות ל-LLM. |
KnowledgeGraphConfig
הודעת הגדרה ל-Knowledge Graph.
| ייצוג JSON |
|---|
{
"enableCloudKnowledgeGraph": boolean,
"cloudKnowledgeGraphTypes": [
string
],
"enablePrivateKnowledgeGraph": boolean,
"privateKnowledgeGraphTypes": [
string
],
"featureConfig": {
object ( |
| שדות | |
|---|---|
enableCloudKnowledgeGraph |
האם להפעיל את Cloud Knowledge Graph במנוע. אם לא מציינים ערך, ברירת המחדל היא false. |
cloudKnowledgeGraphTypes[] |
מציינים את סוגי הישויות שרוצים לתמוך בהן. |
enablePrivateKnowledgeGraph |
האם להפעיל את תרשים הידע הפרטי במנוע. אם לא מציינים ערך, ברירת המחדל היא false. |
privateKnowledgeGraphTypes[] |
מציינים את סוגי הישויות שרוצים לתמוך בהן. |
featureConfig |
זה שינוי אופציונלי. הגדרת התכונה של Knowledge Graph. |
FeatureConfig
הגדרת התכונה של Knowledge Graph.
| ייצוג JSON |
|---|
{ "disablePrivateKgQueryUnderstanding": boolean, "disablePrivateKgEnrichment": boolean, "disablePrivateKgAutoComplete": boolean, "disablePrivateKgQueryUiChips": boolean } |
| שדות | |
|---|---|
disablePrivateKgQueryUnderstanding |
האם להשבית את ההבנה של שאילתות ב-KG הפרטי במנוע. אם לא מציינים ערך, ברירת המחדל היא false. |
disablePrivateKgEnrichment |
האם להשבית את ההעשרה של הגרף הפרטי של הידע במנוע. אם לא מציינים ערך, ברירת המחדל היא false. |
disablePrivateKgAutoComplete |
האם להשבית את ההשלמה האוטומטית של KG פרטי למנוע. אם לא מציינים ערך, ברירת המחדל היא false. |
disablePrivateKgQueryUiChips |
האם להשבית את ה-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 ובחשבונות אחרים שבהם אי אפשר להגדיר את שיטת החיוב. מודל תמחור כללי. |
CONFIGURABLE_BILLING_APPROACH_ENABLED |
הגישה לחיוב מבוססת על ההגדרות שצוינו על ידי הלקוח. |
ModelState
הסטטוס של המודל במנוע.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODEL_STATE_UNSPECIFIED |
מצב המודל לא צוין. |
MODEL_ENABLED |
האדמין הפעיל את המודל. |
MODEL_DISABLED |
האדמין השבית את המודל. |
ObservabilityConfig
הגדרת ניראות (observability) של משאב.
| ייצוג JSON |
|---|
{ "observabilityEnabled": boolean, "sensitiveLoggingEnabled": boolean } |
| שדות | |
|---|---|
observabilityEnabled |
זה שינוי אופציונלי. הפעלה של יכולת התבוננות. אם מציינים את הדגל |
sensitiveLoggingEnabled |
זה שינוי אופציונלי. הגדרה שמאפשרת רישום ביומן של מידע רגיש. רישום רגיש כולל תוכן ליבה של לקוחות (לדוגמה, הנחיות, תגובות). אם |
AgentGatewaySetting
ההגדרה של Agent Gateway, שאפשר לצרף למשאבי Gemini Enterprise כדי לשלוט ביציאה של סוכני Gemini Enterprise לסוכנים ולכלים מחוץ ל-Gemini Enterprise.
| ייצוג JSON |
|---|
{
"defaultEgressAgentGateway": {
object ( |
| שדות | |
|---|---|
defaultEgressAgentGateway |
זה שינוי אופציונלי. שער ברירת המחדל של סוכן היציאה לשימוש, כשההגדרה הזו חלה על משאב Gemini Enterprise. מצב הפריסה צריך להיות GOOGLE_MANAGED, ונתיב הגישה המנוהל צריך להיות AGENT_TO_ANYWHERE. |
AgentGatewayReference
הפניה למשאב של Agent Gateway.
| ייצוג JSON |
|---|
{ "name": string } |
| שדות | |
|---|---|
name |
חובה. אי אפשר לשנות. שם המשאב של שער הסוכן. הפורמט הנדרש: |
MarketplaceAgentVisibility
מייצג את הסוכנים בשוק שגלויים לכל המשתמשים בגלריית הסוכנים.
| טיפוסים בני מנייה (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 |
|
|---|---|
|
יוצר Engine. |
|
מוחקת Engine. |
|
הפונקציה מחזירה Engine. |
|
מקבל את מדיניות בקרת הגישה ב-IAM עבור Engine. |
|
רשימה של כל Engine שמשויכים לפרויקט. |
|
עדכון של Engine |
|
הגדרת מדיניות בקרת הגישה ב-IAM עבור Engine. |