- משאב: Engine
- SimilarDocumentsEngineConfig
- ChatEngineConfig
- AgentCreationConfig
- SearchEngineConfig
- SearchTier
- SearchAddOn
- MediaRecommendationEngineConfig
- OptimizationObjectiveConfig
- TrainingState
- EngineFeaturesConfig
- RecommendedForYouFeatureConfig
- MostPopularFeatureConfig
- RecommendationMetadata
- ServingState
- DataState
- ChatEngineMetadata
- CommonConfig
- KnowledgeGraphConfig
- FeatureConfig
- AppType
- FeatureState
- ConfigurableBillingApproach
- ModelState
- 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') למידע ספציפי לדייר שנדרש עבור המחבר הזה. המבנה של מחרוזת המידע על הדייר תלוי במחבר. |
marketplaceAgentVisibility |
זה שינוי אופציונלי. הנראות של סוכני זירת המסחר בגלריית הסוכנים. |
procurementContactEmail |
זה שינוי אופציונלי. כתובת האימייל של איש הקשר בנושא רכש. |
שדה איחוד engine_config. מפרטים נוספים של הגדרות שמגדירים את ההתנהגות של המנוע. הערך engine_config יכול להיות רק אחד מהבאים: |
|
similarDocumentsConfig |
מפרטי הגדרה נוספים למנוע |
chatEngineConfig |
הגדרות של Chat Engine. רלוונטי רק אם |
searchEngineConfig |
הגדרות של מנוע החיפוש. רלוונטי רק אם |
mediaRecommendationEngineConfig |
הגדרות של Media Engine. האפשרות הזו רלוונטית רק למאגרי הנתונים עם |
שדה איחוד engine_metadata. מטא-נתונים של המנוע כדי לעקוב אחרי הסטטוס שלו. הערך engine_metadata יכול להיות רק אחד מהבאים: |
|
recommendationMetadata |
פלט בלבד. מידע נוסף על מערכת ההמלצות. רלוונטי רק אם |
chatEngineMetadata |
פלט בלבד. מידע נוסף על Chat Engine רלוונטי רק אם |
SimilarDocumentsEngineConfig
בסוג הזה אין שדות.
מפרטי הגדרה נוספים למנוע similar-items.
ChatEngineConfig
הגדרות של מנוע Chat.
| ייצוג ב-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 |
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 |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד type_dedicated_config. הגדרות שקשורות לתכונות שמוחלות על סוג מסוים של מנועי המלצות למדיה. הערך type_dedicated_config יכול להיות רק אחד מהבאים: |
|
recommendedForYouConfig |
המלצות להגדרת תכונות של מנוע. |
mostPopularConfig |
הגדרת התכונות הפופולרית ביותר של המנוע |
RecommendedForYouFeatureConfig
הגדרות נוספות ליצירת מנוע recommended-for-you.
| ייצוג ב-JSON |
|---|
{ "contextEventType": string } |
| שדות | |
|---|---|
contextEventType |
סוג האירוע שהמנוע מבצע לגביו שאילתה בזמן החיזוי. אם הערך מוגדר כ- |
MostPopularFeatureConfig
הגדרות התכונות שנדרשות ליצירת מנוע 'הכי פופולרי'.
| ייצוג ב-JSON |
|---|
{ "timeWindowDays": string } |
| שדות | |
|---|---|
timeWindowDays |
חלון הזמן שבמהלכו מתבצעת שאילתה במנוע בזמן האימון והחיזוי. מספרים שלמים חיוביים בלבד. הערך מתייחס לאירועים מ-X הימים האחרונים. נדרש כרגע למנוע |
RecommendationMetadata
מידע נוסף על מערכת ההמלצות.
| ייצוג ב-JSON |
|---|
{ "servingState": enum ( |
| שדות | |
|---|---|
servingState |
פלט בלבד. מצב ההצגה של המנוע: |
dataState |
פלט בלבד. מצב הדרישות לגבי נתונים במנוע הזה: אי אפשר לאמן את המנוע אם הנתונים במצב |
lastTuneTime |
פלט בלבד. חותמת הזמן שבה הסתיים הכוונון האחרון בהצלחה. המאפיין הזה רלוונטי רק למנועי המלצות מדיה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
lastTrainTime |
פלט בלבד. חותמת הזמן של סיום האימון האחרון שהצליח. המאפיין הזה רלוונטי רק למנועי המלצות מדיה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
tuningOperation |
פלט בלבד. המזהה של פעולת ההתאמה האחרונה שמשויכת למנוע. המאפיין הזה רלוונטי רק למנועי המלצות מדיה. אם מזהה הפעולה הזה קיים, אפשר להשתמש בו כדי לקבוע אם מתבצעת כוונון של המנוע הזה. כדי לבדוק את סטטוס הפעולה, שולחים את הבקשה 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 |
שם המשאב של סוכן Dialogflow שאליו מתייחס Chat Engine. פורמט: |
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 |
האם להפעיל את Knowledge Graph הפרטי עבור המנוע. אם לא מציינים ערך, ברירת המחדל היא 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 |
האדמין השבית את המודל. |
MarketplaceAgentVisibility
מייצג אילו סוכנים בזירת המסחר גלויים לכל המשתמשים בגלריית הסוכנים.
| טיפוסים בני מנייה (enum) | |
|---|---|
MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED |
ברירת המחדל היא MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED. |
SHOW_AVAILABLE_AGENTS_ONLY |
רק נציגים שזמינים כרגע לשימוש על ידי המשתמש מוצגים. |
SHOW_AGENTS_ALREADY_INTEGRATED |
הצגת סוכנים בזירת המסחר שלמשתמש עדיין אין גישה אליהם, אבל הם משולבים במנוע. הרמה הזו כוללת גם את כל הסוכנים שמוצגים עם SHOW_AVAILABLE_AGENTS_ONLY. |
SHOW_AGENTS_ALREADY_PURCHASED |
הצגת כל הסוכנים שגלויים ב-SHOW_AGENTS_ALREADY_INTEGRATED, בנוסף לסוכנים שכבר נרכשו על ידי הפרויקט או הארגון, גם אם הם לא משולבים כרגע במנוע. |
SHOW_ALL_AGENTS |
כל הסוכנים ב-Marketplace גלויים, ללא קשר לסטטוס הגישה או הרכישה. הרמה הזו כוללת את כל הסוכנים שמוצגים ברמות הקודמות. |
Methods |
|
|---|---|
|
יוצר Engine. |
|
מוחקת Engine. |
|
הפונקציה מחזירה Engine. |
|
מקבלים CompletionConfig |
|
מקבל את מדיניות בקרת הגישה ב-IAM עבור Engine. |
|
קבלת הגדרות Workspace למשתמש הקצה. |
|
רשימה של כל Engine שמשויכים לפרויקט. |
|
עדכון של Engine |
|
השהיית האימון של Engine קיים. |
|
ממשיך את האימון של Engine קיים. |
|
הגדרת מדיניות בקרת הגישה ב-IAM עבור Engine. |
|
מכוונן Engine קיים. |
|
מעדכן את CompletionConfig. |