MCP Tools Reference: ces.googleapis.com

כלי: get_app_version

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

בדוגמת הקוד הבאה מוסבר איך להשתמש ב-curl כדי להפעיל את כלי ה-MCP‏ get_app_version.

בקשת Curl
curl --location 'https://ces.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_app_version",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

הודעת בקשה עבור AgentService.GetAppVersion.

GetAppVersionRequest

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

string

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

סכימת הפלט

ב-Customer Engagement Suite ‏(CES), גרסת אפליקציה היא תמונת מצב של האפליקציה בנקודת זמן ספציפית. הוא לא ניתן לשינוי אחרי שיוצרים אותו.

AppVersion

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "updateTime": string,
  "snapshot": {
    object (AppSnapshot)
  },
  "etag": string
}
שדות
name

string

מזהה. המזהה הייחודי של גרסת האפליקציה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}

displayName

string

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

description

string

זה שינוי אופציונלי. תיאור גרסת האפליקציה.

creator

string

פלט בלבד. כתובת האימייל של המשתמש שיצר את גרסת האפליקציה.

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".

snapshot

object (AppSnapshot)

פלט בלבד. תמונת המצב של האפליקציה כשהגרסה נוצרת.

etag

string

פלט בלבד. ‫Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית.

חותמת הזמן

ייצוג ב-JSON
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

מייצג שניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ‏1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-253402300799, כולל (טווח שמתאים ל-‎0001-01-01T00:00:00Z עד ‎9999-12-31T23:59:59Z).

nanos

integer

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

AppSnapshot

ייצוג ב-JSON
{
  "app": {
    object (App)
  },
  "agents": [
    {
      object (Agent)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "examples": [
    {
      object (Example)
    }
  ],
  "guardrails": [
    {
      object (Guardrail)
    }
  ],
  "toolsets": [
    {
      object (Toolset)
    }
  ]
}
שדות
app

object (App)

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

agents[]

object (Agent)

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

tools[]

object (Tool)

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

examples[]

object (Example)

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

guardrails[]

object (Guardrail)

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

toolsets[]

object (Toolset)

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

אפליקציה

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
שדות
name

string

מזהה. המזהה הייחודי של האפליקציה. פורמט: projects/{project}/locations/{location}/apps/{app}

displayName

string

חובה. השם המוצג של האפליקציה.

description

string

זה שינוי אופציונלי. תיאור קריא לאנשים של האפליקציה.

pinned

boolean

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

rootAgent

string

זה שינוי אופציונלי. הסוכן הראשי הוא נקודת הכניסה של האפליקציה. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

languageSettings

object (LanguageSettings)

זה שינוי אופציונלי. הגדרות השפה של האפליקציה.

timeZoneSettings

object (TimeZoneSettings)

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

audioProcessingConfig

object (AudioProcessingConfig)

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

loggingSettings

object (LoggingSettings)

זה שינוי אופציונלי. הגדרות הרישום של האפליקציה.

errorHandlingSettings

object (ErrorHandlingSettings)

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

modelSettings

object (ModelSettings)

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

toolExecutionMode

enum (ToolExecutionMode)

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

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

זה שינוי אופציונלי. סף ההערכה של האפליקציה.

variableDeclarations[]

object (VariableDeclaration)

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

predefinedVariableDeclarations[]

object (VariableDeclaration)

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

globalInstruction

string

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

guardrails[]

string

זה שינוי אופציונלי. רשימת ההנחיות לאפליקציה. פורמט: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

dataStoreSettings

object (DataStoreSettings)

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

defaultChannelProfile

object (ChannelProfile)

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

metadata

map (key: string, value: string)

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

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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".

etag

string

פלט בלבד. ‫Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית.

deploymentCount

integer

פלט בלבד. מספר הפריסות באפליקציה.

clientCertificateSettings

object (ClientCertificateSettings)

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

vpcScSettings

object (VpcScSettings)

זה שינוי אופציונלי. הגדרות VPC-SC לאפליקציה.

locked

boolean

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

validationErrors[]

string

פלט בלבד. הגדרות שגויות או אזהרות באפליקציה.

dashboardSettings

object (DashboardSettings)

זה שינוי אופציונלי. הגדרות ספציפיות לאפליקציה של מרכז הבקרה, לקישור ולהגדרה של מרכזי הבקרה של Contact Center Insights.

LanguageSettings

ייצוג ב-JSON
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
שדות
defaultLanguageCode

string

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

supportedLanguageCodes[]

string

זה שינוי אופציונלי. רשימת קודי השפות שהאפליקציה תומכת בהן, בנוסף ל-default_language_code.

enableMultilingualSupport

boolean

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

fallbackAction
(deprecated)

string

זה שינוי אופציונלי. הוצאה משימוש: התכונה הזו כבר לא נתמכת. כדי לשפר את הטיפול בקלט בכמה שפות, צריך להשתמש ב-enable_multilingual_support. הפעולה לביצוע כשהנציג מקבל קלט בשפה שאינה נתמכת.

זו יכולה להיות פעולה מוגדרת מראש או קריאת API לכלי בהתאמה אישית. הערכים התקינים הם: - שם המשאב המלא של הכלי, שמפעיל את הכלי הספציפי. - פעולת מערכת מוגדרת מראש, כמו "העברה לרמה גבוהה יותר" או "יציאה", שמפעילה אות EndSession עם metadata תואם כדי לסיים את השיחה.

TimeZoneSettings

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

string

זה שינוי אופציונלי. אזור הזמן של האפליקציה ממסד הנתונים של אזורי הזמן, למשל, America/Los_Angeles, ‏ Europe/Paris.

AudioProcessingConfig

ייצוג ב-JSON
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
שדות
synthesizeSpeechConfigs

map (key: string, value: object (SynthesizeSpeechConfig))

זה שינוי אופציונלי. הגדרת האופן שבו תגובת הנציג צריכה להיות מסונתזת, מיפוי מקוד השפה אל SynthesizeSpeechConfig.

אם לא נמצאה הגדרה לקוד השפה שצוין, המערכת תשתמש בהגדרה של קוד השפה הבסיסי. לדוגמה, אם המפה מכילה את הערכים "en-us" ו-"en", וקוד השפה שצוין הוא "en-gb", המערכת תשתמש בהגדרות של "en".

הערה: קוד השפה לא תלוי-רישיות.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

bargeInConfig

object (BargeInConfig)

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

inactivityTimeout

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. לדוגמה: "3.5s".

ambientSoundConfig

object (AmbientSoundConfig)

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

customVoiceSamples[]

object (CustomVoiceSample)

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

SynthesizeSpeechConfigsEntry

ייצוג ב-JSON
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
שדות
key

string

value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

ייצוג ב-JSON
{
  "voice": string,
  "speakingRate": number,
  "model": string,
  "instruction": string
}
שדות
voice

string

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

רשימת הקולות הזמינים מופיעה במאמר שפות וקולות נתמכים ב-Cloud Text-to-Speech.

speakingRate

number

זה שינוי אופציונלי. קצב/מהירות הדיבור בטווח [0.25, 2.0]. הערך 1.0 הוא המהירות הטבעית הרגילה שנתמכת בקול הספציפי. ‫2.0 היא מהירות כפולה, ו-0.5 היא חצי מהמהירות. ערכים מחוץ לטווח [0.25, 2.0] יחזירו שגיאה.

model

string

זה שינוי אופציונלי. המודל שמשמש לסינתוז אודיו. הערכים שנתמכים כרגע: - "gemini-3.1-flash-tts-preview" אם השדה ריק, המערכת משתמשת ב-Chirp3-HD.

instruction

string

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

BargeInConfig

ייצוג ב-JSON
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
שדות
disableBargeIn
(deprecated)

boolean

זה שינוי אופציונלי. הוצא משימוש: disable_barge_in הוצא משימוש לטובת disable_barge_in_control ב-ChannelProfile.

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

bargeInAwareness

boolean

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

משך

ייצוג ב-JSON
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

שניות חתומות של משך הזמן. הערך חייב להיות בין ‎-315,576,000,000 ל-‎+315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות/דקה * 60 דקות/שעה * 24 שעות/יום * 365.25 ימים/שנה * 10,000 שנים

nanos

integer

שברים חתומים של שנייה ברזולוציה של ננו-שנייה של משך הזמן. משכי זמן של פחות משנייה מיוצגים על ידי שדה seconds עם הערך 0 ושדה nanos עם ערך חיובי או שלילי. במשכי זמן של שנייה אחת או יותר, ערך שאינו אפס בשדה nanos חייב להיות עם אותו סימן כמו השדה seconds. הערך חייב להיות בין ‎-999,999,999 ל- ‎+999,999,999, כולל.

AmbientSoundConfig

ייצוג ב-JSON
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
שדות
volumeGainDb

number

זה שינוי אופציונלי. הגברת עוצמת הקול (בדציבלים) של עוצמת הקול המקורית הרגילה שנתמכת על ידי רעשי הסביבה, בטווח [‎-96.0, 16.0]. אם לא מגדירים את הפרמטר, או אם מגדירים אותו לערך של 0.0 (dB), האודיו יופעל באמפליטודת אות רגילה. ערך של ‎-6.0 (dB) יופעל בערך בחצי מהאמפליטודה של האות המקורי הרגיל. ערך של ‎+6.0 (dB) יגרום להפעלה בעוצמה של בערך פי שניים מהעוצמה הרגילה של האות המקורי. מומלץ מאוד לא לחרוג מ-‎+10 (dB), כי בדרך כלל אין עלייה אפקטיבית בעוצמת הקול בערך שגבוה מזה.

שדה של איחוד source. רעשי סביבה שיושמעו עם התשובה המסונתזת של הנציג, כדי שהשיחה תישמע טבעית יותר. הערך source יכול להיות רק אחד מהבאים:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

זה שינוי אופציונלי. הוצא משימוש: prebuilt_ambient_noise הוצא משימוש והוחלף ב-prebuilt_ambient_sound.

gcsUri

string

זה שינוי אופציונלי. רעשי סביבה כקובץ WAV עם ערוץ מונו בתדר 16kHz שמאוחסן ב-Cloud Storage.

הערה: חשוב לוודא שלסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com יש הרשאת storage.objects.get לאובייקט Cloud Storage.

prebuiltAmbientSound

string

זה שינוי אופציונלי. השם של צליל הרקע המובנה. הערכים התקינים הם: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

CustomVoiceSample

ייצוג ב-JSON
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
שדות
name

string

זה שינוי אופציונלי. השם שהמשתמש נתן לדגימת הקול בהתאמה אישית.

voiceSampleGcsUri

string

זה שינוי אופציונלי. ה-URI של Cloud Storage לדגימת האודיו לשכפול הקול. דגימת האודיו צריכה להיות קובץ WAV עם ערוץ מונו ותדר של 24kHz.

consentAudioGcsUri

string

זה שינוי אופציונלי. אודיו של הסכמה לשכפול קול.

voiceInstruction

string

זה שינוי אופציונלי. הוראות בשפה טבעית לגבי סגנון הקול, הטון, הקצב או ההגייה.

previewAudioContent

string (bytes format)

פלט בלבד. אודיו מסונתז של תצוגה מקדימה לקול בהתאמה אישית, בפורמט WAV קנוני (LINEAR16, ‏ 24kHz, ‏ 16-bit, מונו).

מחרוזת בקידוד Base64.

previewText

string

זה שינוי אופציונלי. טקסט לסנתוז של אודיו לתצוגה מקדימה של קול בהתאמה אישית.

warnings[]

object (Warning)

פלט בלבד. הודעות אזהרה שמופיעות במהלך העיבוד של שיבוט הקול (למשל, עוצמת קול נמוכה).

voiceInstructionMode

enum (VoiceInstructionMode)

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

אזהרה

ייצוג ב-JSON
{
  "message": string,
  "type": enum (WarningType)
}
שדות
message

string

פלט בלבד. תיאור קריא לאנשים של האזהרה.

type

enum (WarningType)

פלט בלבד. סוג האזהרה.

LoggingSettings

ייצוג ב-JSON
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "unredactedAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "unredactedBigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  },
  "requiredRecordingConsent": boolean
}
שדות
redactionConfig

object (RedactionConfig)

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

audioRecordingConfig

object (AudioRecordingConfig)

זה שינוי אופציונלי. הגדרת האופן שבו יוקלטו אינטראקציות קוליות. האודיו כפוף לצנזור כפי שהוגדר ב-RedactionConfig.

unredactedAudioRecordingConfig

object (AudioRecordingConfig)

זה שינוי אופציונלי. ההגדרה קובעת הקלטה נוספת של אודיו לא מצונזר. אפשר להשתמש בזה כדי לשמור עותק של האודיו הגולמי כשצינזור האודיו enabled, בדרך כלל למטרות ביקורת או מעקב.

bigqueryExportSettings

object (BigQueryExportSettings)

זה שינוי אופציונלי. הגדרת אופן הייצוא של נתוני האפליקציה ל-BigQuery. נתוני השיחה מצונזרים בהתאם להגדרות ב-RedactionConfig.

unredactedBigqueryExportSettings

object (BigQueryExportSettings)

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

cloudLoggingSettings

object (CloudLoggingSettings)

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

conversationLoggingSettings

object (ConversationLoggingSettings)

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

evaluationAudioRecordingConfig

object (AudioRecordingConfig)

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

metricAnalysisSettings

object (MetricAnalysisSettings)

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

requiredRecordingConsent

boolean

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

אם הערך הוא True, הסשן מתחיל כשההקלטה מושבתת והיא נשארת מושבתת עד שהלקוח שולח את SessionInput.recording_control, ואז היא מחליטה בכל תור מאותו רגע ואילך. הגדרה זו כוללת הקלטת אודיו, היסטוריית שיחות, BigQuery Export ו-Cloud Logging.

כשהמדיניות מוגדרת לערך false (ברירת המחדל), ההגדרות שלמעלה נקבעות באופן עצמאי והלקוח לא צריך לשלוח שום דבר.

RedactionConfig

ייצוג ב-JSON
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
שדות
enableRedaction

boolean

זה שינוי אופציונלי. אם true, הצינזור יחול בתרחישי רישום שונים, כולל היסטוריית השיחות, Cloud Logging והקלטת אודיו.

inspectTemplate

string

זה שינוי אופציונלי. שם תבנית הבדיקה של DLP כדי להגדיר זיהוי של סוגי נתונים רגישים.

פורמט: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}

deidentifyTemplate

string

זה שינוי אופציונלי. שם תבנית להסרת פרטי הזיהוי ב-DLP, כדי להנחות איך להסיר את פרטי הזיהוי מהתוכן.

פורמט: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

ייצוג ב-JSON
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
שדות
gcsBucket

string

זה שינוי אופציונלי. קטגוריית Cloud Storage לאחסון הקלטות האודיו של הסשן. ה-URI חייב להתחיל ב-"gs://‎".

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

הערה: אם הקטגוריה של Cloud Storage נמצאת בפרויקט אחר מזה של האפליקציה, צריך לתת את ההרשאה storage.objects.create לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

gcsPathPrefix

string

זה שינוי אופציונלי. התחילית של הנתיב ב-Cloud Storage להקלטות האודיו.

הקידומת הזו יכולה לכלול את ה-placeholders הבאים, שיוחלפו באופן דינמי בזמן ההצגה: - $project: מזהה הפרויקט - $location: מיקום האפליקציה - $app: מזהה האפליקציה - $date: תאריך הסשן בפורמט YYYY-MM-DD - $session: מזהה הסשן

אם לא מציינים את הקידומת של הנתיב, המערכת תשתמש בקידומת ברירת המחדל $project/$location/$app/$date/$session/.

BigQueryExportSettings

ייצוג ב-JSON
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
שדות
enabled

boolean

זה שינוי אופציונלי. מציין אם הייצוא ל-BigQuery מופעל.

project

string

זה שינוי אופציונלי. מזהה הפרויקט של מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים.

הערה: אם מערך הנתונים של BigQuery נמצא בפרויקט אחר מהאפליקציה, צריך להקצות את התפקיד roles/bigquery.admin לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

dataset

string

זה שינוי אופציונלי. מזהה מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים.

CloudLoggingSettings

ייצוג ב-JSON
{
  "enableCloudLogging": boolean
}
שדות
enableCloudLogging

boolean

זה שינוי אופציונלי. אם להפעיל את Cloud Logging בסשנים.

ConversationLoggingSettings

ייצוג ב-JSON
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
שדות
disableConversationLogging

boolean

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

retentionWindow

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. לדוגמה: "3.5s".

MetricAnalysisSettings

ייצוג ב-JSON
{
  "llmMetricsOptedOut": boolean
}
שדות
llmMetricsOptedOut

boolean

זה שינוי אופציונלי. אם לאסוף נתוני שיחות למדדי ניתוח של LLM. אם הערך הוא True, נתוני השיחה לא ייאספו לצורך מדדי ניתוח של LLM. אחרת, נתוני השיחה ייאספו.

ErrorHandlingSettings

ייצוג ב-JSON
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
שדות
errorHandlingStrategy

enum (ErrorHandlingStrategy)

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

fallbackResponseConfig

object (FallbackResponseConfig)

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

endSessionConfig

object (EndSessionConfig)

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

FallbackResponseConfig

ייצוג ב-JSON
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
שדות
customFallbackMessages

map (key: string, value: string)

זה שינוי אופציונלי. הודעות ברירת המחדל במקרה של שגיאות מערכת (למשל, שגיאות LLM), ממופות לפי קוד שפה נתמך.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

maxFallbackAttempts

integer

זה שינוי אופציונלי. מספר הניסיונות המקסימלי של הנציג להשתמש ב-fallback לפני שהוא שולח את האות EndSession.

CustomFallbackMessagesEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

EndSessionConfig

ייצוג ב-JSON
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
שדות

שדה של איחוד _escalate_session.

הערך _escalate_session יכול להיות רק אחד מהבאים:

escalateSession

boolean

זה שינוי אופציונלי. אם להעביר את הסשן לטיפול של נציג אנושי ב-EndSession. אם הסשן מועבר לטיפול ברמה גבוהה יותר, metadata in EndSession יכיל את session_escalated = true. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ModelSettings

ייצוג ב-JSON
{
  "model": string,
  "thinkingLevel": enum (ThinkingLevel),

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
שדות
model

string

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

thinkingLevel

enum (ThinkingLevel)

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

שדה של איחוד _temperature.

הערך _temperature יכול להיות רק אחד מהבאים:

temperature

number

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

EvaluationMetricsThresholds

ייצוג ב-JSON
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
שדות
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

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

hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש ב-golden_hallucination_metric_behavior במקום זאת. ההתנהגות של מדד ההזיות משמשת כרגע להערכות של קבוצת הזהב.

goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

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

scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

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

GoldenEvaluationMetricsThresholds

ייצוג ב-JSON
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
שדות
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

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

expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

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

toolMatchingSettings

object (ToolMatchingSettings)

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

TurnLevelMetricsThresholds

ייצוג ב-JSON
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
שדות
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

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

שדה של איחוד _semantic_similarity_success_threshold.

הערך _semantic_similarity_success_threshold יכול להיות רק אחד מהבאים:

semanticSimilaritySuccessThreshold

integer

זה שינוי אופציונלי. סף ההצלחה של הדמיון הסמנטי. הערך חייב להיות מספר שלם בין 0 ל-4. ברירת המחדל היא >= 3.

שדה של איחוד _overall_tool_invocation_correctness_threshold.

הערך _overall_tool_invocation_correctness_threshold יכול להיות רק אחד מהבאים:

overallToolInvocationCorrectnessThreshold

number

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

ExpectationLevelMetricsThresholds

ייצוג ב-JSON
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
שדות

שדה של איחוד _tool_invocation_parameter_correctness_threshold.

הערך _tool_invocation_parameter_correctness_threshold יכול להיות רק אחד מהבאים:

toolInvocationParameterCorrectnessThreshold

number

זה שינוי אופציונלי. סף ההצלחה לתקינות של פרמטר קריאה לכלי ספציפי. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0.

ToolMatchingSettings

ייצוג ב-JSON
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
שדות
extraToolCallBehavior

enum (ExtraToolCallBehavior)

זה שינוי אופציונלי. התנהגות של קריאות API נוספות לכלי. ברירת המחדל היא FAIL.

VariableDeclaration

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
שדות
name

string

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

description

string

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

schema

object (Schema)

חובה. הסכימה של המשתנה.

סכימה

ייצוג ב-JSON
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
שדות
type

enum (Type)

חובה. סוג הנתונים.

properties

map (key: string, value: object (Schema))

זה שינוי אופציונלי. מאפיינים של Type.OBJECT.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

required[]

string

זה שינוי אופציונלי. מאפיינים נדרשים של Type.OBJECT.

description

string

זה שינוי אופציונלי. תיאור הנתונים.

items

object (Schema)

זה שינוי אופציונלי. סכימה של הרכיבים של Type.ARRAY.

nullable

boolean

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

uniqueItems

boolean

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

prefixItems[]

object (Schema)

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

additionalProperties

object (Schema)

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

anyOf[]

object (Schema)

זה שינוי אופציונלי. צריך לאמת את הערך מול כל אחת (אחת או יותר) מתת-הסכימות ברשימה.

enum[]

string

זה שינוי אופציונלי. ערכים אפשריים של הרכיב מסוג פרימיטיבי בפורמט enum. דוגמאות: 1. אנחנו יכולים להגדיר כיוון כך : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. אנחנו יכולים להגדיר את מספר הדירה כך : {type:INTEGER, format:enum, enum:["101", "201", "301"]}

default

value (Value format)

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

ref

string

זה שינוי אופציונלי. מאפשר הפניות עקיפות בין צומתי סכימה. הערך צריך להיות הפניה תקינה לצאצא של הרמה הבסיסית (root) defs.

לדוגמה, הסכימה הבאה מגדירה הפניה לצומת סכימה בשם "Pet":

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

הערך של המאפיין "pet" הוא הפניה לצומת הסכימה שנקרא "Pet". פרטים נוספים זמינים בכתובת https://json-schema.org/understanding-json-schema/structuring.

defs

map (key: string, value: object (Schema))

זה שינוי אופציונלי. מפה של הגדרות לשימוש על ידי ref. מותר רק ברמה הבסיסית (root) של הסכימה.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

title

string

זה שינוי אופציונלי. השם של הסכימה.

minItems

string (int64 format)

זה שינוי אופציונלי. מספר הרכיבים המינימלי ל-Type.ARRAY.

maxItems

string (int64 format)

זה שינוי אופציונלי. מספר הרכיבים המקסימלי ל-Type.ARRAY.

שדה של איחוד _minimum.

הערך _minimum יכול להיות רק אחד מהבאים:

minimum

number

זה שינוי אופציונלי. ערך מינימלי ל-Type.INTEGER ול-Type.NUMBER.

שדה של איחוד _maximum.

הערך _maximum יכול להיות רק אחד מהבאים:

maximum

number

זה שינוי אופציונלי. הערך המקסימלי של Type.INTEGER ו-Type.NUMBER.

PropertiesEntry

ייצוג ב-JSON
{
  "key": string,
  "value": {
    object (Schema)
  }
}
שדות
key

string

value

object (Schema)

ערך

ייצוג ב-JSON
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
שדות
שדה של איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים:
nullValue

null

מייצג null ב-JSON.

numberValue

number

מייצג מספר ב-JSON. אסור להשתמש בערכים NaN,‏ Infinity או -Infinity, כי אין להם תמיכה ב-JSON. הוא גם לא יכול לייצג ערכי Int64 גדולים, כי בדרך כלל פורמט JSON לא תומך בהם בסוג המספר שלו.

stringValue

string

מייצג מחרוזת JSON.

boolValue

boolean

מייצג ערך בוליאני של JSON (ליטרל true או false ב-JSON).

structValue

object (Struct format)

מייצג אובייקט JSON.

listValue

array (ListValue format)

מייצג מערך JSON.

Struct

ייצוג ב-JSON
{
  "fields": {
    string: value,
    ...
  }
}
שדות
fields

map (key: string, value: value (Value format))

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

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

ייצוג ב-JSON
{
  "key": string,
  "value": value
}
שדות
key

string

value

value (Value format)

ListValue

ייצוג ב-JSON
{
  "values": [
    value
  ]
}
שדות
values[]

value (Value format)

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

DefsEntry

ייצוג ב-JSON
{
  "key": string,
  "value": {
    object (Schema)
  }
}
שדות
key

string

value

object (Schema)

DataStoreSettings

ייצוג ב-JSON
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
שדות
engines[]

object (Engine)

פלט בלבד. המנועים של האפליקציה.

מנוע

ייצוג ב-JSON
{
  "name": string,
  "type": enum (Type)
}
שדות
name

string

פלט בלבד. שם המשאב של המנוע. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

type

enum (Type)

פלט בלבד. סוג המנוע.

ChannelProfile

ייצוג ב-JSON
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
שדות
profileId

string

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

channelType

enum (ChannelType)

זה שינוי אופציונלי. סוג פרופיל הערוץ.

personaProperty

object (PersonaProperty)

זה שינוי אופציונלי. המאפיין "פרסונה" בפרופיל הערוץ.

webWidgetConfig

object (WebWidgetConfig)

זה שינוי אופציונלי. ההגדרות של הווידג'ט לאתר.

whatsappConfig

object (WhatsAppConfig)

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

instagramConfig

object (InstagramConfig)

זה שינוי אופציונלי. הגדרה ספציפית לפריסות באינסטגרם.

שדה של איחוד _disable_dtmf.

הערך _disable_dtmf יכול להיות רק אחד מהבאים:

disableDtmf

boolean

זה שינוי אופציונלי. אם להשבית את ה-DTMF (חיוג צלילים).

שדה של איחוד _disable_barge_in_control.

הערך _disable_barge_in_control יכול להיות רק אחד מהבאים:

disableBargeInControl

boolean

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

שדה של איחוד _noise_suppression_level.

הערך _noise_suppression_level יכול להיות רק אחד מהבאים:

noiseSuppressionLevel

string

זה שינוי אופציונלי. רמת סינון הרעשים בפרופיל הערוץ. הערכים הזמינים הם "low",‏ "moderate",‏ "high",‏ "very_high".

PersonaProperty

ייצוג ב-JSON
{
  "persona": enum (Persona)
}
שדות
persona

enum (Persona)

זה שינוי אופציונלי. הפרסונה של הערוץ.

WebWidgetConfig

ייצוג ב-JSON
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
שדות
modality

enum (Modality)

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

theme

enum (Theme)

זה שינוי אופציונלי. העיצוב של הווידג'ט לאינטרנט.

webWidgetTitle

string

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

securitySettings

object (SecuritySettings)

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

SecuritySettings

ייצוג ב-JSON
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
שדות
enablePublicAccess

boolean

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

enableOriginCheck

boolean

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

allowedOrigins[]

string

זה שינוי אופציונלי. המקורות שמורשים לארח את הווידג'ט לאתר. מקור מוגדר על ידי RFC 6454. אם לא מציינים ערך, כל המקורות מותרים. אפשר להוסיף עד 100 מקורות. לדוגמה: "https://example.com"

enableRecaptcha

boolean

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

WhatsAppConfig

ייצוג ב-JSON
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
שדות
wabaId

string

חובה. מזהה החשבון ב-WhatsApp Business.

phoneNumberId

string

חובה. מזהה מספר הטלפון של Meta.

phoneNumber

string

זה שינוי אופציונלי. מספר הטלפון בפורמט E.164.

displayName

string

פלט בלבד. שם הדף העסקי ב-Meta שאוחזר.

thumbnailUrl

string

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

description

string

פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא.

InstagramConfig

ייצוג ב-JSON
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
שדות
instagramAccountId

string

חובה. מזהה החשבון באינסטגרם.

displayName

string

פלט בלבד. שם הדף העסקי ב-Meta שאוחזר.

thumbnailUrl

string

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

description

string

פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא.

MetadataEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

ClientCertificateSettings

ייצוג ב-JSON
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
שדות
tlsCertificate

string

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

privateKey

string

חובה. השם של משאב גרסת הסוד של SecretManager שבו מאוחסן המפתח הפרטי, מקודד בפורמט PEM. פורמט: projects/{project}/secrets/{secret}/versions/{version}

passphrase

string

זה שינוי אופציונלי. השם של משאב גרסת הסוד של SecretManager שבו מאוחסן ביטוי הסיסמה לפענוח המפתח הפרטי. אם המפתח הפרטי לא מוצפן, צריך להשאיר את השדה הזה ריק. פורמט: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

ייצוג ב-JSON
{
  "allowedOrigins": [
    string
  ]
}
שדות
allowedOrigins[]

string

זה שינוי אופציונלי. מקורות ה-HTTP(s) המותרים שכלי OpenAPI באפליקציה יכולים לקרוא להם ישירות כש-VPC Service Controls מופעל. המחרוזות האלה חייבות להתאים בדיוק למקור, כולל היציאה אם היא צוינה. לדוגמה, "https://example.com" או "https://example.com:443". הרשימה הזו עדיין לא חלה על כלי Python שעשויים לבצע קריאות HTTP ישירות.

DashboardSettings

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

string

זה שינוי אופציונלי. שם המשאב של מרכז הבקרה שמוגדר כברירת מחדל ב-Contact Center Insights ומשויך לאפליקציה. זהו מרכז הבקרה שיוצג כשמשתמשים יעברו לתצוגת המעקב של האפליקציה.

פורמט: projects/{project}/locations/{location}/dashboards/{dashboard}

סוכן

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],
  "validationErrors": [
    string
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  },
  "remoteA2aAgent": {
    object (RemoteA2aAgent)
  }
  // End of list of possible types for union field agent_type.
}
שדות
name

string

מזהה. המזהה הייחודי של הנציג. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayName

string

חובה. השם המוצג של הנציג.

description

string

זה שינוי אופציונלי. תיאור קריא לאנשים של הנציג.

modelSettings

object (ModelSettings)

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

instruction

string

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

tools[]

string

זה שינוי אופציונלי. רשימת הכלים הזמינים לסוכן. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

childAgents[]

string

זה שינוי אופציונלי. רשימה של סוכני משנה בעץ הסוכנים. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

beforeAgentCallbacks[]

object (Callback)

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

afterAgentCallbacks[]

object (Callback)

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

beforeModelCallbacks[]

object (Callback)

זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך להפעיל לפני שקוראים למודל. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו.

afterModelCallbacks[]

object (Callback)

זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך להפעיל אחרי שהמודל נקרא. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו.

beforeToolCallbacks[]

object (Callback)

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

afterToolCallbacks[]

object (Callback)

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

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".

guardrails[]

string

זה שינוי אופציונלי. רשימת ההנחיות לסוכן. פורמט: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

etag

string

‫Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית.

toolsets[]

object (AgentToolset)

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

generatedSummary

string

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

transferRules[]

object (TransferRule)

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

validationErrors[]

string

פלט בלבד. שגיאות או הגדרות לא נכונות בנציג שעלולות להשפיע על האיכות שלו.

שדה של איחוד agent_type. סוג הנציג. הערך agent_type יכול להיות רק אחד מהבאים:
llmAgent

object (LlmAgent)

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

remoteDialogflowAgent

object (RemoteDialogflowAgent)

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

הערה: אם הנציג של Dialogflow נמצא בפרויקט אחר מהאפליקציה, צריך להעניק את התפקיד roles/dialogflow.client לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

remoteA2aAgent

object (RemoteA2aAgent)

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

RemoteDialogflowAgent

ייצוג ב-JSON
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean,
  "languageCodeVariable": string
}
שדות
agent

string

חובה. שם המשאב של הנציג ב-Dialogflow. פורמט: projects/{project}/locations/{location}/agents/{agent}

flowId

string

זה שינוי אופציונלי. מזהה התהליך של התהליך בנציג Dialogflow.

environmentId

string

זה שינוי אופציונלי. מזהה הסביבה של הנציג ב-Dialogflow שמשמש להפעלת הנציג. אם לא מציינים סביבה, המערכת משתמשת בסביבת הטיוטה.

inputVariableMapping

map (key: string, value: string)

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

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

outputVariableMapping

map (key: string, value: string)

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

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

respectResponseInterruptionSettings

boolean

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

  • אם הערך הוא false: כל הודעות התגובה מהנציג של Dialogflow פועלות לפי הגדרות ההתפרצות ברמת האפליקציה.
  • אם הערך הוא True: רק הודעות תגובה שבהן הערך של allow_playback_interruption מוגדר כ-True יהיו ניתנות להפרעה. כל שאר ההודעות יפעלו לפי ההגדרות של ההתפרצות ברמת האפליקציה.
languageCodeVariable

string

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

InputVariableMappingEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

OutputVariableMappingEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

RemoteA2aAgent

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

object (RemoteA2aConfig)

חובה. הגדרת החיבור של A2A.

RemoteA2aConfig

ייצוג ב-JSON
{
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "streamingEnabled": boolean,
  "contextId": string,

  // Union field agent_spec can be only one of the following:
  "agentCard": {
    object (AgentCard)
  },
  "agentRegistry": string
  // End of list of possible types for union field agent_spec.
}
שדות
apiAuthentication

object (ApiAuthentication)

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

inputVariableMapping

map (key: string, value: string)

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

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

outputVariableMapping

map (key: string, value: string)

זה שינוי אופציונלי. מיפוי של שמות המשתנים של הפלט של הנציג המרוחק לשמות המשתנים של GECX.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

streamingEnabled

boolean

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

contextId

string

זה שינוי אופציונלי. אם השדה לא ריק, האינטראקציות עם סוכן ה-A2A המרוחק ישתמשו במזהה ההקשר הזה. השדה context_id יכול להתייחס למשתנה של סשן כמו $context.variables.order_agent_session_id.

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

object (AgentCard)

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

agentRegistry

string

זה שינוי אופציונלי. הפניה לסוכן ב-Agent Registry. פורמט: projects/{project}/locations/{location}/agents/{agent}

AgentCard

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
שדות
name

string

חובה. שם של הנציג שקריא לאנשים.

description

string

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

supportedInterfaces[]

object (AgentInterface)

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

version

string

חובה. גרסת הנציג.

skills[]

object (AgentSkill)

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

AgentInterface

ייצוג ב-JSON
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
שדות
url

string

חובה. כתובת ה-URL שבה הממשק הזה זמין. זו צריכה להיות כתובת URL מוחלטת ותקינה מסוג HTTPS בסביבת הייצור. דוגמה: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"

protocolBinding

string

חובה. הקישור לפרוטוקול שנתמך בכתובת ה-URL הזו. זו מחרוזת בצורה פתוחה, שאפשר להרחיב בקלות לקישורי פרוטוקולים אחרים. הסכימות העיקריות שנתמכות באופן רשמי הן JSONRPC,‏ GRPC ו-HTTP+JSON.

tenant

string

מזהה הדייר שצריך להשתמש בו בבקשה כשמתקשרים לסוכן.

protocolVersion

string

חובה. גרסת פרוטוקול A2A שהממשק הזה חושף. להשתמש בגרסה המשנית העדכנית ביותר שנתמכת בכל גרסה ראשית. דוגמאות: "0.3", "1.0"

AgentSkill

ייצוג ב-JSON
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
שדות
id

string

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

name

string

חובה. שם המיומנות, בפורמט שקריא לאנשים.

description

string

חובה. תיאור מפורט של המיומנות.

tags[]

string

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

examples[]

string

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

inputModes[]

string

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

outputModes[]

string

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

ApiAuthentication

ייצוג ב-JSON
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
שדות
שדה של איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
apiKeyConfig

object (ApiKeyConfig)

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

oauthConfig

object (OAuthConfig)

זה שינוי אופציונלי. הגדרת OAuth.

serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

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

serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

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

bearerTokenConfig

object (BearerTokenConfig)

זה שינוי אופציונלי. הגדרה לאימות של טוקן למוכ"ז.

ApiKeyConfig

ייצוג ב-JSON
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
שדות
keyName

string

חובה. שם הפרמטר או שם הכותרת של מפתח ה-API. למשל, אם בקשת ה-API היא "https://example.com/act?X-Api-Key=", אז "X-Api-Key" יהיה שם הפרמטר.

apiKeySecretVersion

string

חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן מפתח ה-API. פורמט: projects/{project}/secrets/{secret}/versions/{version}

הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

requestLocation

enum (RequestLocation)

חובה. מיקום המפתח בבקשה.

OAuthConfig

ייצוג ב-JSON
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
שדות
oauthGrantType

enum (OauthGrantType)

חובה. סוגי הרשאות OAuth.

clientId

string

חובה. מזהה הלקוח מספק ה-OAuth.

clientSecretVersion

string

חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן סוד הלקוח. פורמט: projects/{project}/secrets/{secret}/versions/{version}

הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

tokenEndpoint

string

חובה. נקודת הקצה של הטוקן בספק ה-OAuth שמוחלפת בטוקן גישה.

scopes[]

string

זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק.

ServiceAccountAuthConfig

ייצוג ב-JSON
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
שדות
serviceAccount

string

חובה. כתובת האימייל של חשבון השירות שמשמש לאימות. ‫CES משתמש בחשבון השירות הזה כדי להחליף טוקן גישה, ואז טוקן הגישה נשלח בכותרת Authorization של הבקשה.

לחשבון השירות צריך להיות התפקיד roles/iam.serviceAccountTokenCreator שמוקצה לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

scopes[]

string

זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק. אם לא מציינים היקף, המערכת משתמשת בהיקף ברירת המחדל https://www.googleapis.com/auth/cloud-platform.

BearerTokenConfig

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

string

חובה. הטוקן למוכ"ז. חייב להיות בפורמט $context.variables.<name_of_variable>.

InputVariableMappingEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

OutputVariableMappingEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

התקשרות חזרה

ייצוג ב-JSON
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
שדות
description

string

זה שינוי אופציונלי. תיאור קריא לאנשים של הקריאה החוזרת.

disabled

boolean

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

proactiveExecutionEnabled

boolean

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

שדה של איחוד callback. הקריאה החוזרת (callback) לביצוע. הערך callback יכול להיות רק אחד מהבאים:
pythonCode

string

חובה. קוד ה-Python שצריך להריץ בשביל הקריאה החוזרת (callback).

AgentToolset

ייצוג ב-JSON
{
  "toolset": string,
  "toolIds": [
    string
  ]
}
שדות
toolset

string

חובה. שם המשאב של ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

toolIds[]

string

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

TransferRule

ייצוג ב-JSON
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
שדות
childAgent

string

חובה. שם המשאב של הנציג הצאצא שהכלל חל עליו. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

direction

enum (Direction)

חובה. כיוון ההעברה.

שדה של איחוד rule_type. סוג הכלל. הערך rule_type יכול להיות רק אחד מהבאים:
deterministicTransfer

object (DeterministicTransfer)

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

disablePlannerTransfer

object (DisablePlannerTransfer)

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

DeterministicTransfer

ייצוג ב-JSON
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
שדות
שדה של איחוד condition_type. התנאי לבדיקה. הערך condition_type יכול להיות רק אחד מהבאים:
expressionCondition

object (ExpressionCondition)

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

pythonCodeCondition

object (PythonCodeCondition)

זה שינוי אופציונלי. כלל שמשתמש בבלוק קוד של Python כדי להעריך את התנאים. אם התנאי מקבל את הערך True, ההעברה מתבצעת.

ExpressionCondition

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

string

חובה. ייצוג המחרוזת של התנאי cloud.api.Expression.

PythonCodeCondition

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

string

חובה. קוד Python להרצה.

DisablePlannerTransfer

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

object (ExpressionCondition)

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

כלי

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },
  "readOnly": boolean,

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
שדות
name

string

מזהה. שם המשאב של הכלי. פורמט:

  • ‫projects/{project}/locations/{location}/apps/{app}/tools/{tool} לכלים עצמאיים.
  • ‫projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} לכלים שאוחזרו מערכת כלים.

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

displayName

string

פלט בלבד. השם המוצג של הכלי, שנגזר מסוג הכלי. לדוגמה, השם המוצג של [ClientFunction][Tool.ClientFunction] נגזר מהמאפיין name שלו.

executionType

enum (ExecutionType)

זה שינוי אופציונלי. סוג ההפעלה של הכלי.

timeout

string (Duration format)

זה שינוי אופציונלי. הזמן הקצוב לתפוגה של הרצת הכלי. אם לא מגדירים את המדיניות, זמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 30 שניות לכלים של SYNCHRONOUS ו-60 שניות לכלים של ASYNCHRONOUS.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. לדוגמה: "3.5s".

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".

etag

string

‫Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית.

generatedSummary

string

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

toolFakeConfig

object (ToolFakeConfig)

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

readOnly

boolean

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

שדה של איחוד tool_type. סוג הכלי. הערך tool_type יכול להיות רק אחד מהבאים:
clientFunction

object (ClientFunction)

זה שינוי אופציונלי. פונקציית הלקוח.

openApiTool

object (OpenApiTool)

זה שינוי אופציונלי. כלי ה-API הפתוח.

googleSearchTool

object (GoogleSearchTool)

זה שינוי אופציונלי. כלי חיפוש Google.

connectorTool

object (ConnectorTool)

זה שינוי אופציונלי. הכלי Integration Connector.

dataStoreTool

object (DataStoreTool)

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

pythonFunction

object (PythonFunction)

זה שינוי אופציונלי. כלי הפונקציות של Python.

mcpTool

object (McpTool)

זה שינוי אופציונלי. כלי ה-MCP. אי אפשר ליצור או לעדכן כלי MCP באופן ישיר, והוא מנוהל על ידי ערכת הכלים של MCP.

fileSearchTool

object (FileSearchTool)

זה שינוי אופציונלי. כלי החיפוש בקבצים.

systemTool

object (SystemTool)

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

agentTool

object (AgentTool)

זה שינוי אופציונלי. כלי הסוכן.

widgetTool

object (WidgetTool)

זה שינוי אופציונלי. כלי הווידג'ט.

remoteAgentTool

object (RemoteAgentTool)

זה שינוי אופציונלי. כלי הסוכן המרוחק.

ClientFunction

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
שדות
name

string

חובה. שם הפונקציה.

description

string

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

parameters

object (Schema)

זה שינוי אופציונלי. הסכימה של הפרמטרים של הפונקציה.

response

object (Schema)

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

OpenApiTool

ייצוג ב-JSON
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
שדות
openApiSchema

string

חובה. סכימת OpenAPI בפורמט JSON או YAML.

name

string

זה שינוי אופציונלי. שם הכלי. אם לא תציינו שם, שם הכלי ייגזר מסכימת OpenAPI, מ-operation.operationId.

description

string

זה שינוי אופציונלי. תיאור הכלי. אם לא תספקו תיאור, הוא יופק מהסכימה של OpenAPI, מ-operation.description או מ-operation.summary.

apiAuthentication

object (ApiAuthentication)

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

tlsConfig

object (TlsConfig)

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

serviceDirectoryConfig

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory.

ignoreUnknownFields

boolean

זה שינוי אופציונלי. אם הערך הוא True, הנציג יתעלם משדות לא מוכרים בתגובה מה-API.

url

string

זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת ה-Open API. השדה הזה מוגדר רק בכלים ביחסי התלות של הסביבה במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו קיימת ביחסי התלות של הסביבה ובסכימה יש את ה-placeholder‏ $env_var, היא תחליף את ה-placeholder בסכימה.

TlsConfig

ייצוג ב-JSON
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
שדות
caCerts[]

object (CaCert)

חובה. מציינת רשימה של אישורי CA מותאמים אישית שמותרים לאימות HTTPS.

CaCert

ייצוג ב-JSON
{
  "displayName": string,
  "cert": string
}
שדות
displayName

string

חובה. השם של אישורי ה-CA המותאמים אישית שמותרים. אפשר להשתמש בזה כדי להבחין בין אישורי ה-CA המותאמים אישית.

cert

string (bytes format)

חובה. אישורי ה-CA המותרים בהתאמה אישית (בפורמט DER) לאימות HTTPS. ההגדרה הזו מבטלת את מאגר האישורים של SSL שמוגדר כברירת מחדל. אם השדה הזה ריק או לא צוין, CES ישתמש במאגר האישורים שמוגדר כברירת מחדל ב-Google כדי לאמת אישורים. הערה: חשוב לוודא שאישורי השרת של HTTPS חתומים באמצעות "שם חלופי לנושא". לדוגמה, אפשר לחתום על תעודה בחתימה עצמית באמצעות הפקודה הבאה:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

מחרוזת בקידוד Base64.

ServiceDirectoryConfig

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

string

חובה. השם של שירות Service Directory. פורמט: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. המיקום של ספריית השירותים צריך להיות זהה למיקום של האפליקציה.

GoogleSearchTool

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (PromptConfig)
  }
}
שדות
name

string

חובה. שם הכלי.

description

string

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

contextUrls[]

string

זה שינוי אופציונלי. התוכן יישלף ישירות מכתובות ה-URL האלה לצורך הקשר וביסוס. דוגמה: "https://example.com/path.html". אפשר להוסיף עד 20 כתובות URL.

preferredDomains[]

string

זה שינוי אופציונלי. מציינת את הדומיינים שתוצאות החיפוש יוגבלו אליהם. לדוגמה: "example.com",‏ "another.site". אפשר לציין עד 20 דומיינים.

excludeDomains[]

string

זה שינוי אופציונלי. רשימת דומיינים שיוחרגו מתוצאות החיפוש. לדוגמה: "example.com". אפשר להחריג עד 2,000 דומיינים.

promptConfig

object (PromptConfig)

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

PromptConfig

ייצוג ב-JSON
{
  "textPrompt": string,
  "voicePrompt": string
}
שדות
textPrompt

string

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

voicePrompt

string

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

ConnectorTool

ייצוג ב-JSON
{
  "connection": string,
  "action": {
    object (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
שדות
connection

string

חובה. השם המלא של המשאב של החיבור המקושר ב-Integration Connectors. פורמט: projects/{project}/locations/{location}/connections/{connection}

action

object (Action)

חובה. הפעולה שהכלי צריך לבצע.

authConfig

object (EndUserAuthConfig)

זה שינוי אופציונלי. ההגדרה קובעת איך מתבצע האימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות API של Integration Connectors. אפשר לשנות אותה באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל בחיבור את האפשרות לעקוף את האימות. אחרת, יצירת ה-ConnectorTool תיכשל. פרטים נוספים זמינים בכתובת https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.

name

string

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

description

string

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

פעולה

ייצוג ב-JSON
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
שדות
inputFields[]

string

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

outputFields[]

string

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

שדה של איחוד action_spec. מפרט של פעולה שצריך להגדיר כדי שהכלי ישתמש בה. הערך action_spec יכול להיות רק אחד מהבאים:
connectionActionId

string

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

entityOperation

object (EntityOperation)

הגדרת פעולת הישות שהכלי ישתמש בה.

EntityOperation

ייצוג ב-JSON
{
  "entityId": string,
  "operation": enum (OperationType)
}
שדות
entityId

string

חובה. מזהה הישות.

operation

enum (OperationType)

חובה. הפעולה שרוצים לבצע בישות.

EndUserAuthConfig

ייצוג ב-JSON
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
שדות
שדה של איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

אימות באמצעות קוד הרשאה של OAuth 2.0.

oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

אימות מסוג JWT Profile Oauth 2.0 Authorization Grant.

Oauth2AuthCodeConfig

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

string

חובה. שם הפרמטר של אסימון OAuth שצריך להעביר. חייב להיות בפורמט $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

ייצוג ב-JSON
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
שדות
issuer

string

חובה. שם הפרמטר של המנפיק שצריך להעביר. חייב להיות בפורמט $context.variables.<name_of_variable>.

subject

string

חובה. שם הפרמטר של הנושא שצריך להעביר. חייב להיות בפורמט $context.variables.<name_of_variable>.

clientKey

string

חובה. שם הפרמטר של הלקוח שרוצים להעביר. חייב להיות בפורמט $context.variables.<name_of_variable>.

DataStoreTool

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
שדות
name

string

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

description

string

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

boostSpecs[]

object (BoostSpecs)

זה שינוי אופציונלי. מפרט לחיזוק מסמכים מסוימים.

modalityConfigs[]

object (ModalityConfig)

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

filterParameterBehavior

enum (FilterParameterBehavior)

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

שדה של איחוד search_source. מגדיר את מקור החיפוש, מאגר נתונים יחיד או מנוע. הערך search_source יכול להיות רק אחד מהבאים:
dataStoreSource

object (DataStoreSource)

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

engineSource

object (EngineSource)

זה שינוי אופציונלי. חיפוש בתוך מנוע (יכול להיות בכמה מאגרי נתונים).

DataStoreSource

ייצוג ב-JSON
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
שדות
filter

string

זה שינוי אופציונלי. מפרט המסנן של מאגר הנתונים. מידע נוסף זמין בכתובת: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

dataStore

object (DataStore)

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

DataStore

ייצוג ב-JSON
{
  "name": string,
  "type": enum (DataStoreType),
  "documentProcessingMode": enum (DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (ConnectorConfig)
  }
}
שדות
name

string

חובה. השם המלא של המשאב ב-DataStore. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

type

enum (DataStoreType)

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

documentProcessingMode

enum (DocumentProcessingMode)

פלט בלבד. מצב עיבוד המסמכים של החיבור למאגר הנתונים. מוגדר רק למאגרי נתונים מסוג PUBLIC_WEB ו-UNSTRUCTURED.

displayName

string

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

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".

connectorConfig

object (ConnectorConfig)

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

ConnectorConfig

ייצוג ב-JSON
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
שדות
collection

string

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

collectionDisplayName

string

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

dataSource

string

השם של מקור הנתונים. לדוגמה: salesforce, jira, confluence, bigquery.

EngineSource

ייצוג ב-JSON
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreSource)
    }
  ],
  "filter": string
}
שדות
engine

string

חובה. השם המלא של משאב המנוע. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

dataStoreSources[]

object (DataStoreSource)

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

filter

string

זה שינוי אופציונלי. מסנן שמופעל על החיפוש במנוע. לא רלוונטי ולא בשימוש אם צוין "data_store_sources". מידע נוסף זמין בכתובת: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

BoostSpecs

ייצוג ב-JSON
{
  "dataStores": [
    string
  ],
  "spec": [
    {
      object (BoostSpec)
    }
  ]
}
שדות
dataStores[]

string

חובה. מאגר הנתונים שבו מוגדרת הגברת החשיבות. שם המשאב המלא של DataStore, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

spec[]

object (BoostSpec)

חובה. רשימה של מפרטי חיזוק.

BoostSpec

ייצוג ב-JSON
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
שדות
conditionBoostSpecs[]

object (ConditionBoostSpec)

חובה. רשימה של מפרטי חיזוק.

ConditionBoostSpec

ייצוג ב-JSON
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
שדות
condition

string

חובה. ביטוי שמציין תנאי לחיזוק. התחביר זהה לתחביר של ביטוי סינון. נכון לעכשיו, התנאי היחיד שנתמך הוא רשימה של קודי שפה מסוג BCP-47. דוגמה: כדי להגביר את ההצעות בשפות en או fr: ‏(lang_code: ANY("en", "fr"))

boost

number

זה שינוי אופציונלי. עוצמת החיזוק, שצריכה להיות בטווח של [-1, 1]. חיזוק שלילי פירושו הורדה בדירוג. ברירת המחדל היא 0.0.

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

הגדרה לערך ‎-1.0 תוריד את ההצעות בדרגה באופן משמעותי. עם זאת, יכול להיות שעדיין יוצגו הצעות רלוונטיות אחרות.

הגדרה של 0.0 פירושה שלא הוחל חיזוק. המערכת מתעלמת מתנאי ההגברה.

boostControlSpec

object (BoostControlSpec)

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

BoostControlSpec

ייצוג ב-JSON
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
שדות
fieldName

string

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

attributeType

enum (AttributeType)

זה שינוי אופציונלי. סוג המאפיין שמשמש לקביעת סכום ההגדלה. ערך המאפיין יכול להגיע מערך השדה של ה-field_name שצוין. במקרה של ערך מספרי, זה פשוט: attribute_value = numerical_field_value. אבל במקרה של עדכניות, attribute_value = (time.now() - datetime_field_value).

interpolationType

enum (InterpolationType)

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

controlPoints[]

object (ControlPoint)

זה שינוי אופציונלי. נקודות הבקרה שמשמשות להגדרת העקומה. הפונקציה המונוטונית (שמוגדרת באמצעות interpolation_type שלמעלה) עוברת דרך נקודות הבקרה שמפורטות כאן.

ControlPoint

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

string

זה שינוי אופציונלי. יכול להיות אחד מהבאים: 1. הערך המספרי של השדה. 2. מפרט משך הזמן של העדכניות: הערך חייב להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן בפורמט ISO 8601). התבנית של הכתובת הזו היא: [nD][T[nH][nM][nS]].

boostAmount

number

זה שינוי אופציונלי. הערך בין ‎-1 ל-1 שבו הציון יוגדל אם הערך של attribute_value יתאים לערך שצוין למעלה.

ModalityConfig

ייצוג ב-JSON
{
  "modalityType": enum (ModalityType),
  "rewriterConfig": {
    object (RewriterConfig)
  },
  "summarizationConfig": {
    object (SummarizationConfig)
  },
  "groundingConfig": {
    object (GroundingConfig)
  },
  "snippetsConfig": {
    object (SnippetsConfig)
  }
}
שדות
modalityType

enum (ModalityType)

חובה. סוג המודאליות.

rewriterConfig

object (RewriterConfig)

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

summarizationConfig

object (SummarizationConfig)

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

groundingConfig

object (GroundingConfig)

זה שינוי אופציונלי. הגדרת ה-grounding.

snippetsConfig

object (SnippetsConfig)

זה שינוי אופציונלי. הגדרת קטעי הקוד.

RewriterConfig

ייצוג ב-JSON
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
שדות
modelSettings

object (ModelSettings)

חובה. הגדרות למודל ה-LLM.

prompt

string

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

disabled

boolean

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

SummarizationConfig

ייצוג ב-JSON
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
שדות
modelSettings

object (ModelSettings)

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

prompt

string

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

disabled

boolean

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

GroundingConfig

ייצוג ב-JSON
{
  "groundingLevel": number,
  "disabled": boolean
}
שדות
groundingLevel

number

זה שינוי אופציונלי. סף הביסוס של התשובה על סמך המקורות שאוחזרו. אפשר להגדיר ערך בטווח [1, 5]. הרמה משמשת כסף לביסוס התשובה, כלומר כל התשובות עם ציון ביסוס מתחת לסף יחזרו להחזרת קטעים רלוונטיים בלבד.

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

disabled

boolean

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

SnippetsConfig

ייצוג ב-JSON
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
שדות
enableSnippets

boolean

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

maxSnippets

integer

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

PythonFunction

ייצוג ב-JSON
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
שדות
name

string

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

pythonCode

string

זה שינוי אופציונלי. קוד Python להרצה בכלי.

description

string

פלט בלבד. תיאור הפונקציה ב-Python, שנותח מתוך ה-docstring של קוד ה-Python.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

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

McpTool

ייצוג ב-JSON
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (State)
}
שדות
name

string

חובה. השם של כלי ה-MCP.

nameOverride

string

זה שינוי אופציונלי. שינוי השם של כלי ה-MCP. השדה הזה מאוכלס אם השם הוחלף על ידי שינוי של Toolset.

description

string

זה שינוי אופציונלי. תיאור כלי ה-MCP.

inputSchema

object (Schema)

זה שינוי אופציונלי. הסכימה של הארגומנטים של הקלט של כלי ה-MCP.

outputSchema

object (Schema)

זה שינוי אופציונלי. הסכימה של הארגומנטים של הפלט של כלי ה-MCP.

serverAddress

string

חובה. כתובת השרת של שרת ה-MCP, לדוגמה, "https://example.com/mcp/‎". אם השרת נוצר באמצעות MCP SDK, כתובת ה-URL צריכה להסתיים ב-"/mcp/". יש תמיכה רק בשרתים שמבוססים על העברת Streamable HTTP. הכתובת הזו זהה ל-server_address ב-McpToolset. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.

apiAuthentication

object (ApiAuthentication)

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

tlsConfig

object (TlsConfig)

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

serviceDirectoryConfig

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות של שירותים בתוך היקף.

customHeaders

map (key: string, value: string)

זה שינוי אופציונלי. הכותרות בהתאמה אישית שיישלחו בבקשה לשרת ה-MCP. הערכים חייבים להיות בפורמט $context.variables.<name_of_variable> ואפשר להגדיר אותם במשתני הסשן. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (State)

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

CustomHeadersEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

FileSearchTool

ייצוג ב-JSON
{
  "corpusType": enum (CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
שדות
corpusType

enum (CorpusType)

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

name

string

חובה. שם הכלי.

description

string

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

fileCorpus

string

זה שינוי אופציונלי. המאגר שבו הקבצים מאוחסנים. פורמט: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

SystemTool

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

string

חובה. שם כלי המערכת.

description

string

פלט בלבד. תיאור כלי המערכת.

AgentTool

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

string

חובה. שם הכלי של הסוכן.

description

string

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

agent

string

זה שינוי אופציונלי. שם המשאב של הנציג שהוא נקודת הכניסה של הכלי. פורמט: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
שדות
name

string

חובה. השם המוצג של הווידג'ט.

description

string

זה שינוי אופציונלי. תיאור הווידג'ט.

widgetType

enum (WidgetType)

זה שינוי אופציונלי. סוג הווידג'ט. אם לא מציינים סוג, סוג ברירת המחדל יהיה CUSTOMIZED.

uiConfig

object (Struct format)

זה שינוי אופציונלי. הגדרות לרינדור הווידג'ט.

dataMapping

object (DataMapping)

זה שינוי אופציונלי. המיפוי שמגדיר איך הנתונים מכלי המקור ממופים לפרמטרים של הקלט של הווידג'ט.

textResponseConfig

object (TextResponseConfig)

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

שדה של איחוד input. הקלט של כלי הווידג'ט. הערך input יכול להיות רק אחד מהבאים:
parameters

object (Schema)

זה שינוי אופציונלי. הפרמטרים של הקלט של כלי הווידג'ט.

DataMapping

ייצוג ב-JSON
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (Mode),
  "pythonScript": string
}
שדות
sourceToolName

string

זה שינוי אופציונלי. שם המשאב של הכלי שמספק את הנתונים לווידג'ט (למשל, כלי חיפוש או פונקציה בהתאמה אישית). פורמט: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}

fieldMappings

map (key: string, value: string)

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

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

pythonFunction

object (PythonFunction)

זה שינוי אופציונלי. הגדרת פונקציית Python שמשמשת להמרת הפלט של כלי המקור לפורמט הקלט של הווידג'ט.

mode

enum (Mode)

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

pythonScript
(deprecated)

string

הוצא משימוש: צריך להשתמש ב-python_function במקום זאת.

FieldMappingsEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

TextResponseConfig

ייצוג ב-JSON
{
  "type": enum (Type),
  "staticText": string,
  "textResponseInstruction": string
}
שדות
type

enum (Type)

זה שינוי אופציונלי. האסטרטגיה למתן תשובת הטקסט.

staticText

string

זה שינוי אופציונלי. תשובת הטקסט הסטטי שתוחזר כשהסוג הוא STATIC.

textResponseInstruction

string

זה שינוי אופציונלי. הוראה למודל השפה הגדול (LLM) לגבי אופן היצירה של תשובת הטקסט. משמש כתיאור של הפרמטר של תגובת הטקסט אם הסוג הוא LLM_GENERATED.

RemoteAgentTool

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "statefulAgent": boolean,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  }
}
שדות
name

string

חובה. שם הכלי.

description

string

חובה. תיאור הכלי.

agentCard

object (AgentCard)

חובה. כרטיס הסוכן של הסוכן המרוחק שהכלי הזה מפעיל.

apiAuthentication

object (ApiAuthentication)

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

statefulAgent

boolean

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

inputVariableMapping

map (key: string, value: string)

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

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

outputVariableMapping

map (key: string, value: string)

זה שינוי אופציונלי. מיפוי של שמות המשתנים של הפלט של הנציג המרוחק לשמות המשתנים של GECX.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

InputVariableMappingEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

OutputVariableMappingEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

ToolFakeConfig

ייצוג ב-JSON
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
שדות
enableFakeMode

boolean

זה שינוי אופציונלי. אם הכלי משתמש במצב מזויף.

שדה של איחוד tool_response. התשובה היא סטטית או שהיא מסופקת על ידי פונקציית Python. הערך tool_response יכול להיות רק אחד מהבאים:
codeBlock

object (CodeBlock)

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

CodeBlock

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

string

חובה. קוד Python שיופעל במצב מזויף של הכלי. חתימת פונקציית Python צפויה – כדי לתפוס את כל קריאות ה-API לכלים: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: כדי לתפוס קריאת API לכלי ספציפי: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: אם הפונקציה מחזירה None, הכלי האמיתי יופעל במקום זאת.

דוגמה

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
שדות
name

string

מזהה. המזהה הייחודי של הדוגמה. פורמט: projects/{project}/locations/{location}/apps/{app}/examples/{example}

displayName

string

חובה. השם המוצג של הדוגמה.

description

string

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

entryAgent

string

זה שינוי אופציונלי. הסוכן שמטפל בשיחה בהתחלה. אם לא צוין אחרת, הדוגמה מייצגת שיחה שמטופלת על ידי הנציג הראשי. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

messages[]

object (Message)

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

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".

invalid

boolean

פלט בלבד. יכול להיות שהדוגמה לא תהיה תקפה אם המשאבים שמפנים אליה יימחקו. דוגמאות לא תקינות לא ישמשו כדוגמאות לפרומפט עם כמה דוגמאות (few-shot).

etag

string

‫Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית.

הודעה

ייצוג ב-JSON
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
שדות
role

string

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

chunks[]

object (Chunk)

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

eventTime

string (Timestamp format)

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

הפורמט הוא 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".

מקטע

ייצוג ב-JSON
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
שדות
שדה של איחוד data. נתוני המקטע. הערך data יכול להיות רק אחד מהבאים:
text

string

זה שינוי אופציונלי. נתוני טקסט.

transcript

string

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

blob

object (Blob)

זה שינוי אופציונלי. נתוני Blob.

payload

object (Struct format)

זה שינוי אופציונלי. נתוני מטען ייעודי (payload) בהתאמה אישית.

image

object (Image)

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

toolCall

object (ToolCall)

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

toolResponse

object (ToolResponse)

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

agentTransfer

object (AgentTransfer)

זה שינוי אופציונלי. אירוע העברה של סוכן.

updatedVariables

object (Struct format)

מבנה שמייצג משתנים שעודכנו בשיחה, עם מפתחות לפי שמות המשתנים.

defaultVariables

object (Struct format)

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

כתם

ייצוג ב-JSON
{
  "mimeType": string,
  "data": string
}
שדות
mimeType

string

חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA.

data

string (bytes format)

חובה. בייטים גולמיים של ה-blob.

מחרוזת בקידוד Base64.

תמונה

ייצוג ב-JSON
{
  "mimeType": string,
  "data": string,
  "altText": string
}
שדות
mimeType

string

חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA. סוגי התמונות הנתמכים כוללים: * image/png * image/jpeg * image/webp

data

string (bytes format)

חובה. בייטים גולמיים של התמונה.

מחרוזת בקידוד Base64.

altText

string

זה שינוי אופציונלי. הטקסט החלופי של התמונה.

ToolCall

ייצוג ב-JSON
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
שדות
id

string

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

displayName

string

פלט בלבד. השם המוצג של הכלי.

args

object (Struct format)

זה שינוי אופציונלי. הפרמטרים והערכים של הקלט לכלי בפורמט של אובייקט JSON.

parentToolCallId

string

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

agentName

string

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

targetApp

string

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

שדה של איחוד tool_identifier. המזהה של הכלי שצריך להפעיל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool

string

זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

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

ToolsetTool

ייצוג ב-JSON
{
  "toolset": string,
  "toolId": string
}
שדות
toolset

string

חובה. שם המשאב של ערכת הכלים שממנה נגזר הכלי הזה. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

toolId

string

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

ToolResponse

ייצוג ב-JSON
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
שדות
id

string

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

displayName

string

פלט בלבד. השם המוצג של הכלי.

response

object (Struct format)

חובה. תוצאת ההפעלה של הכלי בפורמט של אובייקט JSON. צריך להשתמש במפתח output כדי לציין את התגובה של הכלי, ובמפתח error כדי לציין את פרטי השגיאה (אם יש). אם המפתחות "output" ו-"error" לא צוינו, כל ה-"response" נחשב לתוצאת ההפעלה של הכלי.

parentToolCallId

string

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

agentName

string

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

targetApp

string

פלט בלבד. האפליקציה שהכלי שהופעל טירגט; משקפת את ToolCall.target_app.

שדה של איחוד tool_identifier. המזהה של הכלי שהופעל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool

string

זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

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

AgentTransfer

ייצוג ב-JSON
{
  "targetAgent": string,
  "displayName": string
}
שדות
targetAgent

string

חובה. הנציג שאליו מועברת השיחה. הנציג יטפל בשיחה מכאן והלאה. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayName

string

פלט בלבד. השם המוצג של הנציג.

שכבת הגנה

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "action": {
    object (TriggerAction)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field guardrail_type can be only one of the following:
  "contentFilter": {
    object (ContentFilter)
  },
  "llmPromptSecurity": {
    object (LlmPromptSecurity)
  },
  "llmPolicy": {
    object (LlmPolicy)
  },
  "modelSafety": {
    object (ModelSafety)
  },
  "codeCallback": {
    object (CodeCallback)
  },
  "supervisor": {
    object (Supervisor)
  }
  // End of list of possible types for union field guardrail_type.
}
שדות
name

string

מזהה. המזהה הייחודי של מעקה הבטיחות. פורמט: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

displayName

string

חובה. השם המוצג של מעקה הבטיחות.

description

string

זה שינוי אופציונלי. תיאור של ההנחיה.

enabled

boolean

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

action

object (TriggerAction)

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

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".

etag

string

‫Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית.

שדה של איחוד guardrail_type. סוג מעקה הבטיחות. הערך guardrail_type יכול להיות רק אחד מהבאים:
contentFilter

object (ContentFilter)

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

llmPromptSecurity

object (LlmPromptSecurity)

זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה אם ההנחיה נחשבת לא בטוחה על סמך הסיווג של ה-LLM.

llmPolicy

object (LlmPolicy)

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

modelSafety

object (ModelSafety)

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

codeCallback

object (CodeCallback)

זה שינוי אופציונלי. הנחיה שעשויה לחסום את השיחה על סמך התוצאה של הפעלת ה-callback.

supervisor

object (Supervisor)

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

ContentFilter

ייצוג ב-JSON
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean,
  "sensitiveWordsExemptions": [
    string
  ]
}
שדות
bannedContents[]

string

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

bannedContentsInUserInput[]

string

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

bannedContentsInAgentResponse[]

string

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

matchType

enum (MatchType)

חובה. סוג ההתאמה של מסנן התוכן.

disregardDiacritics

boolean

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

sensitiveWordsExemptions[]

string

זה שינוי אופציונלי. רשומות ברשימת המילים הרגישות שההגנה הזו מאפשרת. רלוונטי רק אם הערך של match_type הוא SENSITIVE_WORDS. כל ערך חייב להיות זהה לרשומה ברשימה (לא תלוי-רישיות, המערכת מתעלמת מרווחים לבנים מסביב). ערכים אחרים לא משפיעים. ההגדרה חלה רק על ההגנה הזו. עד 1,000 רשומות, כל אחת באורך של עד 256 תווים.

LlmPromptSecurity

ייצוג ב-JSON
{
  "failOpen": boolean,

  // Union field security_config can be only one of the following:
  "defaultSettings": {
    object (DefaultSecuritySettings)
  },
  "customPolicy": {
    object (LlmPolicy)
  }
  // End of list of possible types for union field security_config.
}
שדות
failOpen

boolean

זה שינוי אופציונלי. ההגדרה הזו קובעת מה קורה כשיש שגיאה במודל ה-LLM. - אם הערך הוא True: המערכת עוקפת את מנגנון ההגנה. - אם הערך הוא False (ברירת המחדל): מעקה הבטיחות מופעל או חוסם.

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

שדה של איחוד security_config. מגדירה את מצב הגדרת האבטחה. המשתמש צריך לבחור באחת מההגדרות הבאות. הערך security_config יכול להיות רק אחד מהבאים:
defaultSettings

object (DefaultSecuritySettings)

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

customPolicy

object (LlmPolicy)

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

DefaultSecuritySettings

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

string

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

LlmPolicy

ייצוג ב-JSON
{
  "maxConversationMessages": integer,
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "policyScope": enum (PolicyScope),
  "failOpen": boolean,
  "allowShortUtterance": boolean
}
שדות
maxConversationMessages

integer

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

modelSettings

object (ModelSettings)

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

prompt

string

חובה. הנחיה לגבי המדיניות. תומך בפלייסהולדרים של משתני סשן ({var}) וגם ב-{agent_system_instruction} כדי להוסיף את הוראות המערכת שהנציג פתר.

policyScope

enum (PolicyScope)

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

failOpen

boolean

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

allowShortUtterance

boolean

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

ModelSafety

ייצוג ב-JSON
{
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ]
}
שדות
safetySettings[]

object (SafetySetting)

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

SafetySetting

ייצוג ב-JSON
{
  "category": enum (HarmCategory),
  "threshold": enum (HarmBlockThreshold)
}
שדות
category

enum (HarmCategory)

חובה. קטגוריית הפגיעה.

threshold

enum (HarmBlockThreshold)

חובה. סף החסימה של תוכן פוגעני.

CodeCallback

ייצוג ב-JSON
{
  "beforeAgentCallback": {
    object (Callback)
  },
  "afterAgentCallback": {
    object (Callback)
  },
  "beforeModelCallback": {
    object (Callback)
  },
  "afterModelCallback": {
    object (Callback)
  }
}
שדות
beforeAgentCallback

object (Callback)

זה שינוי אופציונלי. הקריאה החוזרת (callback) שצריך להפעיל לפני שקוראים לסוכן. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': ‏ 'OK' או 'TRIGGER'. ‫- "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד.

afterAgentCallback

object (Callback)

זה שינוי אופציונלי. הקריאה החוזרת (callback) שתבוצע אחרי שהסוכן יופעל. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': ‏ 'OK' או 'TRIGGER'. ‫- "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד.

beforeModelCallback

object (Callback)

זה שינוי אופציונלי. הקריאה החוזרת (callback) שצריך להפעיל לפני הקריאה למודל. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': ‏ 'OK' או 'TRIGGER'. ‫- "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד.

afterModelCallback

object (Callback)

זה שינוי אופציונלי. הקריאה החוזרת (callback) שצריך להפעיל אחרי שהמודל נקרא. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': ‏ 'OK' או 'TRIGGER'. ‫- "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד.

מפקח/ת

ייצוג ב-JSON
{
  "type": enum (Type),
  "detectionMode": enum (DetectionMode)
}
שדות
type

enum (Type)

זה שינוי אופציונלי. סוג המפקח.

detectionMode

enum (DetectionMode)

זה שינוי אופציונלי. מצב הזיהוי של המפקח.

TriggerAction

ייצוג ב-JSON
{

  // Union field action can be only one of the following:
  "respondImmediately": {
    object (RespondImmediately)
  },
  "transferAgent": {
    object (TransferAgent)
  },
  "generativeAnswer": {
    object (GenerativeAnswer)
  }
  // End of list of possible types for union field action.
}
שדות
שדה של איחוד action. הפעולה שצריך לבצע. הערך action יכול להיות רק אחד מהבאים:
respondImmediately

object (RespondImmediately)

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

transferAgent

object (TransferAgent)

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

generativeAnswer

object (GenerativeAnswer)

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

RespondImmediately

ייצוג ב-JSON
{
  "responses": [
    {
      object (Response)
    }
  ]
}
שדות
responses[]

object (Response)

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

תשובה

ייצוג ב-JSON
{
  "text": string,
  "disabled": boolean
}
שדות
text

string

חובה. הטקסט שהסוכן ישתמש בו כדי להשיב.

disabled

boolean

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

TransferAgent

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

string

חובה. שם הנציג שאליו רוצים להעביר את השיחה. הנציג חייב להיות באותה אפליקציה כמו הנציג הנוכחי. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

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

string

חובה. ההנחיה שמשמשת ליצירת התשובה.

ערכת כלים

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
שדות
name

string

מזהה. המזהה הייחודי של ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

displayName

string

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

description

string

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

timeout

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. לדוגמה: "3.5s".

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".

etag

string

‫ETag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית.

executionType

enum (ExecutionType)

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

toolFakeConfig

object (ToolFakeConfig)

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

שדה של איחוד toolset_type. סוג ערכת הכלים. הערך toolset_type יכול להיות רק אחד מהבאים:
mcpToolset

object (McpToolset)

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

openApiToolset

object (OpenApiToolset)

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

connectorToolset

object (ConnectorToolset)

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

McpToolset

ייצוג ב-JSON
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
שדות
serverAddress

string

חובה. הכתובת של שרת ה-MCP, לדוגמה, "https://example.com/mcp/‎". אם השרת נוצר באמצעות MCP SDK, כתובת ה-URL צריכה להסתיים ב-"/mcp/". יש תמיכה רק בשרתים שמבוססים על העברת Streamable HTTP. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.

apiAuthentication

object (ApiAuthentication)

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

serviceDirectoryConfig

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות של שירותים בתוך היקף.

tlsConfig

object (TlsConfig)

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

customHeaders

map (key: string, value: string)

זה שינוי אופציונלי. הכותרות בהתאמה אישית שיישלחו בבקשה לשרת ה-MCP. הערכים חייבים להיות בפורמט $context.variables.<name_of_variable> ואפשר להגדיר אותם במשתני הסשן. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

toolOverrides[]

object (McpToolOverride)

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

CustomHeadersEntry

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

value

string

McpToolOverride

ייצוג ב-JSON
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
שדות
tool

string

חובה. השם המקורי של הכלי כפי שהוא מופק על ידי שרת ה-MCP.

nameOverride

string

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

descriptionOverride

string

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

snapshot

object (McpToolDefinition)

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

McpToolDefinition

ייצוג ב-JSON
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
שדות
description

string

פלט בלבד. תיאור כלי ה-MCP. אפשר לשנות את ההגדרה הזו באמצעות description_override ב-McpToolOverride.

inputSchema

object (Schema)

פלט בלבד. הסכימה של הארגומנטים של הקלט של כלי ה-MCP.

outputSchema

object (Schema)

פלט בלבד. הסכימה של הארגומנטים של הפלט של כלי ה-MCP.

OpenApiToolset

ייצוג ב-JSON
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
שדות
openApiSchema

string

חובה. סכימת OpenAPI של ערכת הכלים.

apiAuthentication

object (ApiAuthentication)

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

tlsConfig

object (TlsConfig)

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

serviceDirectoryConfig

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory.

ignoreUnknownFields

boolean

זה שינוי אופציונלי. אם הערך הוא True, הנציג יתעלם משדות לא ידועים בתגובה מה-API בכל הפעולות שמוגדרות בסכימה של OpenAPI.

url

string

זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת ה-Open API. השדה הזה מוגדר רק בערכות כלים ביחסי התלות של הסביבה במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו קיימת ביחסי התלות של הסביבה ובסכימה יש את ה-placeholder‏ $env_var, היא תחליף את ה-placeholder בסכימה.

ConnectorToolset

ייצוג ב-JSON
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
שדות
connection

string

חובה. השם המלא של המשאב של החיבור המקושר ב-Integration Connectors. פורמט: projects/{project}/locations/{location}/connections/{connection}

authConfig

object (EndUserAuthConfig)

זה שינוי אופציונלי. ההגדרה קובעת איך מתבצע האימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות API של Integration Connectors. אפשר לשנות אותה באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל בחיבור את האפשרות לעקוף את האימות. אחרת, יצירת ערכת הכלים תיכשל. מידע נוסף זמין בכתובת https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override

connectorActions[]

object (Action)

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

PrebuiltAmbientNoise

רעשי סביבה מובנים.

טיפוסים בני מנייה (enum)
PREBUILT_AMBIENT_NOISE_UNSPECIFIED לא צוין.
RETAIL_STORE רעשי הסביבה של חנות קמעונאית.
CONVENTION_HALL רעשי הסביבה של אולם כנסים.
OUTDOOR רעשי סביבה של רחוב.

WarningType

סוג האזהרה שהתקבלה במהלך עיבוד דגימת הקול.

טיפוסים בני מנייה (enum)
WARNING_TYPE_UNSPECIFIED סוג האזהרה לא צוין.
LOW_AUDIO_LEVEL עוצמת הקול של דגימת הקול נמוכה מדי (למשל, משרעת RMS נמוכה).

VoiceInstructionMode

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

טיפוסים בני מנייה (enum)
VOICE_INSTRUCTION_MODE_UNSPECIFIED לא צוין אופן ההוראה. ברירת המחדל היא NO_INSTRUCTION.
NO_INSTRUCTION לא תהיה הנחיה קולית.
GENERATE_INSTRUCTION ההוראה הקולית תיווצר באופן אוטומטי על ידי AI מדגימת האודיו.
CUSTOM_INSTRUCTION הוראה קולית בהתאמה אישית שהמשתמש נתן.

ErrorHandlingStrategy

מגדיר את האסטרטגיה לטיפול בשגיאות.

טיפוסים בני מנייה (enum)
ERROR_HANDLING_STRATEGY_UNSPECIFIED אסטרטגיית טיפול בשגיאות לא מזוהה.
NONE לא מופעל טיפול ספציפי.
FALLBACK_RESPONSE אם יהיו שגיאות במערכת (למשל, שגיאות ב-LLM), המשתמש יקבל הודעת גיבוי.
END_SESSION אות EndSession יישלח במקרה של שגיאות מערכת (למשל, שגיאות LLM).

ThinkingLevel

הגדרת רמת ההעמקה של המודל.

טיפוסים בני מנייה (enum)
THINKING_LEVEL_UNSPECIFIED רמת ההעמקה לא צוינה.
DEFAULT רמת ההעמקה שמוגדרת כברירת מחדל.
LOW רמת העמקה נמוכה.
MEDIUM רמת העמקה בינונית.
HIGH רמת העמקה גבוהה.

ToolExecutionMode

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

טיפוסים בני מנייה (enum)
TOOL_EXECUTION_MODE_UNSPECIFIED מצב הפעלת כלי לא מוגדר. ברירת המחדל היא PARALLEL.
PARALLEL אם נבחרו כמה כלים, הם יופעלו במקביל עם אותו ToolContext.
SEQUENTIAL אם נבחרו כמה כלים, הם יופעלו ברצף. הכלי הבא יופעל רק אחרי שהכלי הקודם יסיים את הפעולה שלו, והוא יוכל לראות את ה-ToolContext המעודכן מהכלי הקודם.

SemanticSimilarityChannel

הערוץ שבו רוצים להשתמש לדמיון סמנטי.

טיפוסים בני מנייה (enum)
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED לא צוין מדד. ברירת המחדל היא TEXT.
TEXT שימוש בדמיון סמנטי של טקסט.
AUDIO שימוש בדמיון סמנטי של אודיו.

ExtraToolCallBehavior

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

טיפוסים בני מנייה (enum)
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED התנהגות לא מוגדרת. ברירת המחדל היא FAIL.
FAIL ההערכה תיכשל אם תהיה קריאה נוספת לכלי.
ALLOW מאשרים את קריאת ה-API הנוספת לכלי.

HallucinationMetricBehavior

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

טיפוסים בני מנייה (enum)
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED התנהגות לא מוגדרת של מדד ההזיות.
DISABLED השבתת המדד "הזיה".
ENABLED הפעלת המדד "הזיות".

סוג

סוגי נתונים של OpenAPI.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED לא צוין סוג.
STRING סוג מחרוזת.
INTEGER מספר שלם.
NUMBER סוג המספר.
BOOLEAN סוג בוליאני.
OBJECT סוג האובייקט.
ARRAY סוג המערך.

NullValue

מייצג null ב-JSON.

‫NullValue הוא sentinel, שמשתמש ב-enum עם ערך אחד בלבד כדי לייצג את הערך null לאיחוד מסוג Value.

שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יבצעו סבב מלא לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך Null.

סוג

סוג המנוע. אפשר לעיין במסמכי התיעוד שזמינים בכתובת https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType ובכתובת https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג המנוע לא צוין.
ENGINE_TYPE_CHAT סוג מנוע הצ'אט. מנוע SOLUTION_TYPE_CHAT לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה.

ChannelType

סוג פרופיל הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN סוג הערוץ לא ידוע.
WEB_UI ערוץ ממשק המשתמש באינטרנט.
API ערוץ API.
TWILIO ערוץ Twilio.
GOOGLE_TELEPHONY_PLATFORM ערוץ Google Telephony Platform.
CONTACT_CENTER_AS_A_SERVICE ערוץ Contact Center as a Service‏ (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT ערוץ Contact Center as a Service (צ'אט CCaaS).
FIVE9 ערוץ Five9.
CONTACT_CENTER_INTEGRATION ערוץ שילוב של מוקד שירות של צד שלישי.
WHATSAPP ערוץ וואטסאפ.
INSTAGRAM ערוץ באינסטגרם.

פרסונה

הפרסונה של הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN פרסונה לא ידועה.
CONCISE הסוכן שומר על תשובות תמציתיות וענייניות
CHATTY הנציג מספק הקשר, הסברים ופרטים נוספים

מודליות

אופן הפעולה של הווידג'ט באינטרנט.

טיפוסים בני מנייה (enum)
MODALITY_UNSPECIFIED אופן לא ידוע.
CHAT_AND_VOICE הווידג'ט תומך גם בקלט של צ'אט וגם בקלט קולי.
VOICE_ONLY הווידג'ט תומך רק בקלט קולי.
CHAT_ONLY הווידג'ט תומך רק בקלט של צ'אט.
CHAT_VOICE_AND_VIDEO הווידג'ט תומך בקלט של צ'אט, קול ווידאו.

עיצוב

העיצוב של הווידג'ט לאתר.

טיפוסים בני מנייה (enum)
THEME_UNSPECIFIED עיצוב לא ידוע.
LIGHT עיצוב בהיר.
DARK עיצוב כהה.

RequestLocation

המיקום של מפתח ה-API בבקשה.

טיפוסים בני מנייה (enum)
REQUEST_LOCATION_UNSPECIFIED לא צוין. אין להשתמש בערך הזה.
HEADER מייצג את המפתח בכותרת ה-HTTP.
QUERY_STRING מייצג את המפתח במחרוזת של השאילתה.

OauthGrantType

סוגי הרשאות OAuth. יש תמיכה רק בהרשאת פרטי כניסה של לקוח.

טיפוסים בני מנייה (enum)
OAUTH_GRANT_TYPE_UNSPECIFIED לא צוין. ברירת המחדל היא CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL מייצג את תהליך פרטי הכניסה של הלקוח.

כיוון

כיוון ההעברה.

טיפוסים בני מנייה (enum)
DIRECTION_UNSPECIFIED כיוון לא מוגדר.
PARENT_TO_CHILD העברה מהסוכן הראשי לסוכן המשני.
CHILD_TO_PARENT העברה מהסוכן המשני לסוכן הראשי.

OperationType

הפעולה שצריך לבצע על היישות.

טיפוסים בני מנייה (enum)
OPERATION_TYPE_UNSPECIFIED סוג הפעולה לא צוין. לא תקין, היצירה או העדכון של ConnectorTool ייכשלו.
LIST פעולה ברשימה.
GET פעולת Get.
CREATE פעולת יצירה.
UPDATE פעולת עדכון.
DELETE פעולת מחיקה.

DataStoreType

סוג מאגר הנתונים.

טיפוסים בני מנייה (enum)
DATA_STORE_TYPE_UNSPECIFIED לא צוין. הערך הזה מציין שסוג מאגר הנתונים לא צוין, ולכן לא ייעשה בו שימוש במהלך החיפוש.
PUBLIC_WEB מאגר נתונים שמכיל תוכן מהאינטרנט שגלוי לכולם.
UNSTRUCTURED מאגר נתונים שמכיל נתונים פרטיים לא מובְנים.
FAQ מאגר נתונים שמכיל נתונים מובְנים שמשמשים כשאלות נפוצות.
CONNECTOR מאגר נתונים שהוא מחבר לשירות של צד ראשון או של צד שלישי.

DocumentProcessingMode

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

טיפוסים בני מנייה (enum)
DOCUMENT_PROCESSING_MODE_UNSPECIFIED לא צוין.
DOCUMENTS מסמכים מעובדים כמסמכים.
CHUNKS המסמכים מומרים לקטעים.

AttributeType

המאפיין (או הפונקציה) שעליו יחול הדירוג בהתאמה אישית.

טיפוסים בני מנייה (enum)
ATTRIBUTE_TYPE_UNSPECIFIED סוג מאפיין לא מזוהה.
NUMERICAL הערך של השדה המספרי ישמש לעדכון דינמי של סכום החיזוק. במקרה כזה, ערך המאפיין (ערך ה-X) של נקודת הבקרה יהיה הערך בפועל של השדה המספרי שעבורו צוין סכום החיזוק.
FRESHNESS בתרחיש לדוגמה של עדכניות, ערך המאפיין יהיה משך הזמן בין השעה הנוכחית לבין התאריך בשדה התאריך והשעה שצוין. הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן בפורמט ISO 8601). התבנית של הכתובת הזו היא: [nD][T[nH][nM][nS]]. למשל: 5D,‏ 3DT12H30M,‏ T24H.

InterpolationType

סוג האינטרפולציה שצריך להחיל. ברירת המחדל תהיה לינארית (לינארית חלקית).

טיפוסים בני מנייה (enum)
INTERPOLATION_TYPE_UNSPECIFIED סוג האינטרפולציה לא צוין. במקרה כזה, ברירת המחדל היא "לינארי".
LINEAR המערכת תבצע אינטרפולציה לינארית חלקית.

ModalityType

סוג המודאליות.

טיפוסים בני מנייה (enum)
MODALITY_TYPE_UNSPECIFIED סוג המודליות לא צוין.
TEXT מודליות טקסט.
AUDIO מודל אודיו.

FilterParameterBehavior

התנהגות של פרמטר סינון.

טיפוסים בני מנייה (enum)
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED התנהגות ברירת המחדל של המסנן. כולל פרמטר סינון למאגרי נתונים של מחברים. בשאר הסוגים של מאגרי הנתונים, פרמטר הקלט של המסנן מושמט.
ALWAYS_INCLUDE תמיד צריך לכלול פרמטר סינון לכל סוגי מאגרי הנתונים.
NEVER_INCLUDE הפרמטר filter אף פעם לא נכלל ברשימת הפרמטרים של הכלי, בלי קשר לסוג מאגר הנתונים.

מדינה

מייצג את מצב הזמינות הדינמי של הכלי.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב ברירת המחדל.
ACTIVE הכלי זמין והשרת מציע אותו באופן פעיל.
INACTIVE הכלי מוגדר או מוצמד, אבל השרת לא מציע אותו כרגע.
STALE הכלי קיים בשרת, אבל לא תואם לגרסה שבשרת.

CorpusType

סוג קורפוס ה-RAG ב-Vertex.

טיפוסים בני מנייה (enum)
CORPUS_TYPE_UNSPECIFIED סוג הקורפוס לא צוין.
USER_OWNED הקורפוס נוצר על ידי המשתמש ונמצא בבעלותו.
FULLY_MANAGED הקורפוס נוצר על ידי הסוכן.

WidgetType

כל סוגי הווידג'טים הזמינים. יכול להיות שבעתיד נוסיף ערכים חדשים ל-enum הזה.

טיפוסים בני מנייה (enum)
WIDGET_TYPE_UNSPECIFIED סוג הווידג'ט לא צוין.
CUSTOM סוג הווידג'ט בהתאמה אישית.
PRODUCT_DETAILS ווידג'ט של פרטי המוצר.
QUICK_ACTIONS ווידג'ט של פעולות מהירות.
PRODUCT_COMPARISON ווידג'ט להשוואת מוצרים.
ADVANCED_PRODUCT_DETAILS ווידג'ט מתקדם של פרטי המוצר.
SHORT_FORM ווידג'ט של סרטונים קצרים.
OVERALL_SATISFACTION ווידג'ט שביעות רצון כללית.
ORDER_SUMMARY ווידג'ט של סיכום ההזמנה.
APPOINTMENT_DETAILS ווידג'ט של פרטי הפגישה.
APPOINTMENT_SCHEDULER ווידג'ט לקביעת פגישות.
CONTACT_FORM ווידג'ט של טופס ליצירת קשר.

מצב

השיטה שמשמשת למיפוי נתונים מכלי המקור לווידג'ט.

טיפוסים בני מנייה (enum)
MODE_UNSPECIFIED מצב לא מוגדר.
FIELD_MAPPING משתמשים במפה field_mappings כדי לשנות את הנתונים.
PYTHON_SCRIPT משתמשים ב-python_script כדי לשנות את הנתונים.

סוג

מגדיר איך התשובה בטקסט נוצרת.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג לא מזוהה.
NONE ה-LLM מחליט באופן דינמי אם ליצור תשובת טקסט לצד הווידג'ט, על סמך ההקשר של השיחה.
LLM_GENERATED ה-LLM נדרש באופן מפורש ליצור תשובה שהיא טקסט.
STATIC תמיד נעשה שימוש בתגובת טקסט סטטית שהוגדרה מראש.

ExecutionType

סוג ההפעלה של הכלי או ערכת הכלים.

טיפוסים בני מנייה (enum)
EXECUTION_TYPE_UNSPECIFIED סוג ההפעלה לא צוין. אם לא צוין ערך, ברירת המחדל היא SYNCHRONOUS.
SYNCHRONOUS הכלי מופעל באופן סינכרוני. הסשן נחסם עד שהכלי מחזיר תשובה.
ASYNCHRONOUS הכלי מופעל באופן אסינכרוני. הסשן יימשך בזמן שהכלי פועל.

MatchType

סוג ההתאמה של מסנן התוכן.

טיפוסים בני מנייה (enum)
MATCH_TYPE_UNSPECIFIED סוג ההתאמה לא צוין.
SIMPLE_STRING_MATCH התוכן מותאם למחרוזות משנה תו אחר תו.
WORD_BOUNDARY_STRING_MATCH התוכן תואם רק אם התבנית שנמצאה בטקסט מוקפת בתווי הפרדה בין מילים. ביטויים חסומים יכולים להכיל גם מפרידי מילים.
REGEXP_MATCH ההתאמה לתוכן מתבצעת באמצעות תחביר של ביטויים רגולריים.
SENSITIVE_WORDS המערכת בודקת אם התוכן תואם לרשימה של מילים וביטויים רגישים. אם מצרפים לאפליקציה או לסוכן מעקה בטיחות עם סוג ההתאמה הזה, הוא מחליף את מסנן המילים הרגישות שמוגדר כברירת מחדל בסוכנים המושפעים. כדי לבטל את ההסכמה לשימוש במסנן ברירת המחדל, צריך להשבית את מעקה הבטיחות.

PolicyScope

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

טיפוסים בני מנייה (enum)
POLICY_SCOPE_UNSPECIFIED היקף המדיניות לא צוין.
USER_QUERY בדיקת המדיניות מופעלת על קלט של משתמשים.
AGENT_RESPONSE בדיקת המדיניות מופעלת בתגובה של הנציג. החלת היקף המדיניות הזה תגרום לזמן אחזור נוסף לפני שהנציג יוכל להגיב.
USER_QUERY_AND_AGENT_RESPONSE בדיקת המדיניות מופעלת גם על הקלט של המשתמש וגם על התשובה של הנציג. החלת היקף המדיניות הזה תגרום לזמן אחזור נוסף לפני שהנציג יוכל להגיב.

HarmCategory

קטגוריית הנזק.

טיפוסים בני מנייה (enum)
HARM_CATEGORY_UNSPECIFIED קטגוריית הפגיעה לא צוינה.
HARM_CATEGORY_HATE_SPEECH קטגוריית הנזק היא דברי שטנה.
HARM_CATEGORY_DANGEROUS_CONTENT קטגוריית הנזק היא תוכן מסוכן.
HARM_CATEGORY_HARASSMENT קטגוריית הפגיעה היא הטרדה.
HARM_CATEGORY_SEXUALLY_EXPLICIT קטגוריית הפגיעה היא תוכן מיני בוטה.
HARM_CATEGORY_PROFANITY קטגוריית הפגיעה היא שפה גסה.
HARM_CATEGORY_TOXIC קטגוריית הפגיעה היא רעילות.

HarmBlockThreshold

רמות סף מבוססות-הסתברות לחסימה.

טיפוסים בני מנייה (enum)
HARM_BLOCK_THRESHOLD_UNSPECIFIED סף חסימה לא מוגדר של נזק.
BLOCK_LOW_AND_ABOVE חסימת סף נמוך ומעלה (כלומר, חסימה של יותר תוכן).
BLOCK_MEDIUM_AND_ABOVE חסימה של סף בינוני ומעלה.
BLOCK_ONLY_HIGH לחסום רק סף גבוה (כלומר, לחסום פחות).
BLOCK_NONE לא לחסום אף אחד.
OFF משביתים את מסנן הבטיחות.

סוג

סוג המפקח.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED לא צוין סוג.
INVALID_TEXT סוג הבעיה בטקסט לא תקין.
LANGUAGE_SHIFT סוג הבעיה: שינוי שפה.
SPEAKER_SHIFT סוג הבעיה: שינוי הדובר.
AUDIO_MISMATCH סוג הבעיה: חוסר התאמה באודיו.
MISSING_TOOL_CALL לא צוין סוג הבעיה בקריאת ה-API לכלי.
CUSTOM סוג בעיה מותאם אישית.
CHOPPY_AUDIO סוג הבעיה: אודיו קטוע.
PROFANITY סוג הבעיה: שפה גסה של הנציג.

DetectionMode

מצב הזיהוי של המפקח.

טיפוסים בני מנייה (enum)
DETECTION_MODE_UNSPECIFIED מצב הזיהוי לא צוין. ברירת המחדל היא NON_BLOCKING.
NON_BLOCKING מצב זיהוי ללא חסימה. התגובה לא נחסמת בזמן שהמערכת מזהה את המפקח.
BLOCKING חסימת מצב זיהוי. התגובה נחסמת כשהפיקוח פועל.

הערות לגבי הכלים

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

בנוסף למחרוזת הכותרת, הרמזים הבוליאניים הבאים מוגדרים כך:

  • ‫readOnlyHint: אם הערך הוא True, הכלי לא משנה את הסביבה שלו. ברירת המחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא False, הכלי יכול לבצע רק פעולות הוספה. ברירת המחדל: true.
  • ‫idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת המחדל: false.
  • ‫openWorldHint: אם הערך הוא True, הכלי יכול לקיים אינטראקציה עם "עולם פתוח" של ישויות חיצוניות. אם הערך הוא false, הכלי יכול לקיים אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי חיפוש באינטרנט הוא כלי בעולם פתוח, אבל כלי זיכרון הוא לא כלי בעולם פתוח.

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌