MCP Tools Reference: ces.googleapis.com

כלי: create_app_version

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

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי create_app_version MCP.

בקשת 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": "create_app_version",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

בקשה לצ'אט עם AgentService.CreateAppVersion

CreateAppVersionRequest

ייצוג JSON 
{
  "parent": string,
  "appVersionId": string,
  "appVersion": {
    object (AppVersion)
  }
}
שדות
parent

string

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

string

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

object (AppVersion)

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

AppVersion

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": 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".
snapshot

object (AppSnapshot)

פלט בלבד. קובץ ה-snapshot של האפליקציה כשנוצרה הגרסה.
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 במקום זאת. הפעולה שתתבצע כשהסוכן יקבל קלט בשפה שלא נתמכת.

יכול להיות שמדובר בפעולה מוגדרת מראש או בקריאה מותאמת אישית לכלי. הערכים האפשריים הם: – השם המלא של משאב הכלי, שמפעיל ביצוע ספציפי של הכלי. – פעולת מערכת מוגדרת מראש, כמו 'העברה לטיפול בדרג גבוה יותר' או 'יציאה', שמפעילה אות 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)
  }
}
שדות
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)

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

SynthesizeSpeechConfigsEntry

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

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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

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

string

זה שינוי אופציונלי. הוצא משימוש: במקום זאת, צריך להשתמש ב-custom_voice_samples ב-AudioProcessingConfig.

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

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

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

string

זה שינוי אופציונלי. הוצא משימוש: במקום זאת, צריך להשתמש ב-custom_voice_samples ב-AudioProcessingConfig.

ה-URI של Cloud Storage לאודיו של הסכמה לשכפול קול.

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 עם ערוץ מונו, ‎16 kHz, שמאוחסן ב-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

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)
  }
}
שדות
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 עבור האפליקציה.

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 להקלטות אודיו.

הקידומת יכולה לכלול את הפלייס הולדרים הבאים, שיוחלפו באופן דינמי בזמן הצגת המודעה: ‫- ‎$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

זה שינוי אופציונלי. מספר הניסיונות המקסימלי לגיבוי לפני שהסוכן ישדר את האות 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,

  // 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 שהסוכן צריך להשתמש בו. אם לא מגדירים מודל, הסוכן יקבל בירושה את המודל מהסוכן הראשי שלו.

שדה איחוד _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)

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

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)

זה שינוי אופציונלי. התנהגות במקרה של קריאות נוספות לכלים. ברירת המחדל היא 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

זה שינוי אופציונלי. מאפשר הפניות עקיפות בין צמתי סכימה. הערך צריך להיות הפניה חוקית לצאצא של רכיב הבסיס 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. מותר להשתמש במאפיין הזה רק ברמת הבסיס של הסכימה.

אובייקט שמכיל רשימה של "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

מייצג JSON null.
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

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

string

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

string

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

InstagramConfig

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

string

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

string

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

string

פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאוחזרה.
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

זה שינוי אופציונלי. השם של משאב גרסת ה-Secret ב-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)
  }
  // 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)

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

object (Callback)

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

object (Callback)

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

object (Callback)

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

object (Callback)

זה שינוי אופציונלי. הפונקציות לקריאה חוזרת שיופעלו לפני הפעלת הכלי. אם יש כמה הפעלות של כלים, הקריאה החוזרת תופעל כמה פעמים. הקריאות החוזרות שסופקו מופעלות ברצף בסדר המדויק שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע מופסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
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.

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

התקשרות חזרה

ייצוג 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 יכול להיות רק אחד מהבאים:
pythonCode

string

חובה. קוד ה-Python להרצה עבור הקריאה החוזרת.

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)
  },

  // 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)

זה שינוי אופציונלי. הגדרות של אופן הפעולה של הכלי במצב מזויף.
שדה איחוד 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)

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

boolean

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

string

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

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)

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

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

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. כברירת מחדל, אימות אדמין מועבר בבקשות ל-Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת למשתמשי הקצה. הערה: כדי לציין כאן הגדרת 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)

אימות של הרשאת OAuth 2.0 באמצעות פרופיל JWT.

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)

זה שינוי אופציונלי. חיפוש ב-DataStore ספציפי.
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)

זה שינוי אופציונלי. הגדרת ההארקה.
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, שנותח ממחרוזת התיעוד של קוד ה-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. השדה הזה מאוכלס אם השם שונה באמצעות שינוי ברירת המחדל של ערכת הכלים.
description

string

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

object (Schema)

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

object (Schema)

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

string

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

object (ApiAuthentication)

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

object (TlsConfig)

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

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.
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)
  }
}
שדות
name

string

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

string

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

object (AgentCard)

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

object (ApiAuthentication)

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

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

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

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)

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

CodeBlock

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

string

חובה. קוד Python שיופעל במצב מזויף של הכלי. חתימת פונקציית Python הצפויה – כדי לתפוס את כל קריאות הכלים: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: כדי לתפוס קריאה ספציפית לכלי: 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)

זה שינוי אופציונלי. נתונים של מטען ייעודי בהתאמה אישית.
image

object (Image)

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

object (ToolCall)

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

object (ToolResponse)

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

object (AgentTransfer)

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

object (Struct format)

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

object (Struct format)

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

Blob

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

string

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

string (bytes format)

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

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

תמונה

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

string

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

string (bytes format)

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

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

ToolCall

ייצוג JSON 
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": 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

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

string

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

object (Struct format)

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

string

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

string

פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. השדה ריק אם הסוכן הבסיסי הנפיק את ה-ID.
שדה איחוד 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,

  // 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' כדי לציין את פרטי השגיאה (אם יש). אם לא מציינים את המפתחות 'פלט' ו'שגיאה', המערכת מתייחסת לכל התגובה כתוצאה של הפעלת הכלי.
parentToolCallId

string

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

string

פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. השדה ריק אם הסוכן הבסיסי הנפיק את ה-ID.
שדה איחוד 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)
  }
  // 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.

ContentFilter

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

string

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

string

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

string

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

enum (MatchType)

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

boolean

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

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

חובה. פרומפט מדיניות.
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)

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

object (Callback)

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

object (Callback)

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

object (Callback)

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

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)

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

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, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

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

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.
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)

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

boolean

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

string

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

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. כברירת מחדל, אימות אדמין מועבר בבקשות ל-Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת למשתמשי הקצה. הערה: כדי לציין כאן הגדרת 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 רעשי הסביבה של רחוב.

ErrorHandlingStrategy

הגדרת האסטרטגיה לטיפול בשגיאות.

טיפוסים בני מנייה (enum)
ERROR_HANDLING_STRATEGY_UNSPECIFIED שיטת טיפול בשגיאות לא מוגדרת.
NONE לא מופעל טיפול ספציפי.
FALLBACK_RESPONSE אם יש שגיאות במערכת (למשל שגיאות ב-LLM), המשתמש יקבל הודעת גיבוי.
END_SESSION במקרה של שגיאות מערכת (למשל שגיאות ב-LLM), ייפלט אות EndSession.

ToolExecutionMode

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

טיפוסים בני מנייה (enum)
TOOL_EXECUTION_MODE_UNSPECIFIED מצב ההפעלה של הכלי לא צוין. ברירת המחדל היא PARALLEL.
PARALLEL אם בוחרים כמה כלים, הם יופעלו במקביל עם אותו ToolContext.
SEQUENTIAL אם בוחרים כמה כלים, הם יופעלו ברצף. הכלי הבא יופעל רק אחרי שהכלי הקודם יסיים את הפעולה, והוא יוכל לראות את ToolContext המעודכן מהכלי הקודם.

SemanticSimilarityChannel

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

טיפוסים בני מנייה (enum)
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED לא צוין מדד. ברירת המחדל היא TEXT.
TEXT שימוש בדמיון סמנטי בין טקסטים.
AUDIO שימוש בדמיון סמנטי של אודיו.

ExtraToolCallBehavior

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

טיפוסים בני מנייה (enum)
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED התנהגות לא מוגדרת. ברירת המחדל היא FAIL.
FAIL הבדיקה תיכשל אם יזוהה קריאה נוספת לכלי.
ALLOW מאשרים את השימוש בכלי הנוסף.

HallucinationMetricBehavior

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

טיפוסים בני מנייה (enum)
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED התנהגות לא מוגדרת של מדד הזיות.
DISABLED השבתה של מדד ההזיות.
ENABLED הפעלת מדד ההזיות.

סוג

סוגי נתונים של OpenAPI.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED הסוג לא צוין.
STRING סוג המחרוזת.
INTEGER סוג Integer.
NUMBER סוג המספר.
BOOLEAN סוג בוליאני.
OBJECT סוג האובייקט.
ARRAY סוג המערך.

NullValue

מייצג JSON null.

‫NullValue הוא ערך שמירה, שמשתמש בערך מספרי עם ערך אחד בלבד כדי לייצג את ערך ה-null עבור איחוד הסוגים Value.

שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב כלי הסריאליזציה של 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 Chat).
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 עיצוב כהה.

כיוון

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

טיפוסים בני מנייה (enum)
DIRECTION_UNSPECIFIED כיוון לא מוגדר.
PARENT_TO_CHILD העברה מסוכן ראשי לסוכן הבן.
CHILD_TO_PARENT העברה מסוכן צאצא לסוכן ראשי.

RequestLocation

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

טיפוסים בני מנייה (enum)
REQUEST_LOCATION_UNSPECIFIED לא צוין. אין להשתמש בערך הזה.
HEADER מייצג את המפתח בכותרת ה-HTTP.
QUERY_STRING מייצג את המפתח במחרוזת של שאילתה.

OauthGrantType

סוגי הרשאות OAuth. יש תמיכה רק ב-client credential grant.

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

OperationType

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

טיפוסים בני מנייה (enum)
OPERATION_TYPE_UNSPECIFIED לא צוין סוג הפעולה. לא תקין, יצירה או עדכון של ConnectorTool ייכשלו.
LIST פעולה ברשימה.
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 הערך של השדה המספרי ישמש לעדכון דינמי של סכום ההגדלה. במקרה הזה, attribute_value (ערך המאפיין, הערך x) של נקודת הבקרה יהיה הערך בפועל של השדה המספרי שעבורו צוין boost_amount.
FRESHNESS בתרחיש השימוש של רעננות, ערך המאפיין יהיה משך הזמן שחלף בין השעה הנוכחית לבין התאריך בשדה התאריך והשעה שצוין. הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן לפי תקן ISO 8601). הדוגמה לכך היא: [nD][T[nH][nM][nS]]. לדוגמה: 5D, ‏ 3DT12H30M, ‏ T24H.

InterpolationType

סוג האינטרפולציה שרוצים להחיל. ברירת המחדל תהיה לינארית (Piecewise Linear).

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

ModalityType

סוג השיטה.

טיפוסים בני מנייה (enum)
MODALITY_TYPE_UNSPECIFIED סוג המודאליות לא צוין.
TEXT אופן הצגת הטקסט.
AUDIO שיטת אודיו.

FilterParameterBehavior

התנהגות פרמטרים של סינון.

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

מדינה

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

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

CorpusType

סוג המאגר של Vertex RAG.

טיפוסים בני מנייה (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 התאמה לתוכן מתבצעת באמצעות תחביר של ביטויים רגולריים.

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 משביתים את מסנן הבטיחות.

סכימת הפלט

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

AppVersion

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": 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".
snapshot

object (AppSnapshot)

פלט בלבד. קובץ ה-snapshot של האפליקציה כשנוצרה הגרסה.
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 במקום זאת. הפעולה שתתבצע כשהסוכן יקבל קלט בשפה שלא נתמכת.

יכול להיות שמדובר בפעולה מוגדרת מראש או בקריאה מותאמת אישית לכלי. הערכים האפשריים הם: – השם המלא של משאב הכלי, שמפעיל ביצוע ספציפי של הכלי. – פעולת מערכת מוגדרת מראש, כמו 'העברה לטיפול בדרג גבוה יותר' או 'יציאה', שמפעילה אות 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)
  }
}
שדות
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)

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

SynthesizeSpeechConfigsEntry

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

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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

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

string

זה שינוי אופציונלי. הוצא משימוש: במקום זאת, צריך להשתמש ב-custom_voice_samples ב-AudioProcessingConfig.

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

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

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

string

זה שינוי אופציונלי. הוצא משימוש: במקום זאת, צריך להשתמש ב-custom_voice_samples ב-AudioProcessingConfig.

ה-URI של Cloud Storage לאודיו של הסכמה לשכפול קול.

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 עם ערוץ מונו, ‎16 kHz, שמאוחסן ב-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

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)
  }
}
שדות
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 עבור האפליקציה.

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 להקלטות אודיו.

הקידומת יכולה לכלול את הפלייס הולדרים הבאים, שיוחלפו באופן דינמי בזמן הצגת המודעה: ‫- ‎$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

זה שינוי אופציונלי. מספר הניסיונות המקסימלי לגיבוי לפני שהסוכן ישדר את האות 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,

  // 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 שהסוכן צריך להשתמש בו. אם לא מגדירים מודל, הסוכן יקבל בירושה את המודל מהסוכן הראשי שלו.

שדה איחוד _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)

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

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)

זה שינוי אופציונלי. התנהגות במקרה של קריאות נוספות לכלים. ברירת המחדל היא 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

זה שינוי אופציונלי. מאפשר הפניות עקיפות בין צמתי סכימה. הערך צריך להיות הפניה חוקית לצאצא של רכיב הבסיס 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. מותר להשתמש במאפיין הזה רק ברמת הבסיס של הסכימה.

אובייקט שמכיל רשימה של "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

מייצג JSON null.
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

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

string

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

string

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

InstagramConfig

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

string

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

string

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

string

פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאוחזרה.
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

זה שינוי אופציונלי. השם של משאב גרסת ה-Secret ב-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)
  }
  // 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)

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

object (Callback)

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

object (Callback)

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

object (Callback)

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

object (Callback)

זה שינוי אופציונלי. הפונקציות לקריאה חוזרת שיופעלו לפני הפעלת הכלי. אם יש כמה הפעלות של כלים, הקריאה החוזרת תופעל כמה פעמים. הקריאות החוזרות שסופקו מופעלות ברצף בסדר המדויק שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע מופסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
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.

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

התקשרות חזרה

ייצוג 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 יכול להיות רק אחד מהבאים:
pythonCode

string

חובה. קוד ה-Python להרצה עבור הקריאה החוזרת.

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)
  },

  // 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)

זה שינוי אופציונלי. הגדרות של אופן הפעולה של הכלי במצב מזויף.
שדה איחוד 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)

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

boolean

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

string

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

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)

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

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

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. כברירת מחדל, אימות אדמין מועבר בבקשות ל-Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת למשתמשי הקצה. הערה: כדי לציין כאן הגדרת 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)

אימות של הרשאת OAuth 2.0 באמצעות פרופיל JWT.

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)

זה שינוי אופציונלי. חיפוש ב-DataStore ספציפי.
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)

זה שינוי אופציונלי. הגדרת ההארקה.
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, שנותח ממחרוזת התיעוד של קוד ה-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. השדה הזה מאוכלס אם השם שונה באמצעות שינוי ברירת המחדל של ערכת הכלים.
description

string

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

object (Schema)

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

object (Schema)

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

string

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

object (ApiAuthentication)

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

object (TlsConfig)

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

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.
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)
  }
}
שדות
name

string

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

string

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

object (AgentCard)

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

object (ApiAuthentication)

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

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

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

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)

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

CodeBlock

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

string

חובה. קוד Python שיופעל במצב מזויף של הכלי. חתימת פונקציית Python הצפויה – כדי לתפוס את כל קריאות הכלים: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: כדי לתפוס קריאה ספציפית לכלי: 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)

זה שינוי אופציונלי. נתונים של מטען ייעודי בהתאמה אישית.
image

object (Image)

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

object (ToolCall)

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

object (ToolResponse)

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

object (AgentTransfer)

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

object (Struct format)

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

object (Struct format)

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

Blob

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

string

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

string (bytes format)

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

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

תמונה

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

string

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

string (bytes format)

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

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

ToolCall

ייצוג JSON 
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": 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

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

string

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

object (Struct format)

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

string

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

string

פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. השדה ריק אם הסוכן הבסיסי הנפיק את ה-ID.
שדה איחוד 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,

  // 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' כדי לציין את פרטי השגיאה (אם יש). אם לא מציינים את המפתחות 'פלט' ו'שגיאה', המערכת מתייחסת לכל התגובה כתוצאה של הפעלת הכלי.
parentToolCallId

string

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

string

פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. השדה ריק אם הסוכן הבסיסי הנפיק את ה-ID.
שדה איחוד 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)
  }
  // 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.

ContentFilter

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

string

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

string

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

string

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

enum (MatchType)

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

boolean

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

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

חובה. פרומפט מדיניות.
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)

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

object (Callback)

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

object (Callback)

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

object (Callback)

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

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)

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

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, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

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

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.
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)

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

boolean

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

string

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

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. כברירת מחדל, אימות אדמין מועבר בבקשות ל-Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת למשתמשי הקצה. הערה: כדי לציין כאן הגדרת 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 רעשי הסביבה של רחוב.

ErrorHandlingStrategy

הגדרת האסטרטגיה לטיפול בשגיאות.

טיפוסים בני מנייה (enum)
ERROR_HANDLING_STRATEGY_UNSPECIFIED שיטת טיפול בשגיאות לא מוגדרת.
NONE לא מופעל טיפול ספציפי.
FALLBACK_RESPONSE אם יש שגיאות במערכת (למשל שגיאות ב-LLM), המשתמש יקבל הודעת גיבוי.
END_SESSION במקרה של שגיאות מערכת (למשל שגיאות ב-LLM), ייפלט אות EndSession.

ToolExecutionMode

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

טיפוסים בני מנייה (enum)
TOOL_EXECUTION_MODE_UNSPECIFIED מצב ההפעלה של הכלי לא צוין. ברירת המחדל היא PARALLEL.
PARALLEL אם בוחרים כמה כלים, הם יופעלו במקביל עם אותו ToolContext.
SEQUENTIAL אם בוחרים כמה כלים, הם יופעלו ברצף. הכלי הבא יופעל רק אחרי שהכלי הקודם יסיים את הפעולה, והוא יוכל לראות את ToolContext המעודכן מהכלי הקודם.

SemanticSimilarityChannel

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

טיפוסים בני מנייה (enum)
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED לא צוין מדד. ברירת המחדל היא TEXT.
TEXT שימוש בדמיון סמנטי בין טקסטים.
AUDIO שימוש בדמיון סמנטי של אודיו.

ExtraToolCallBehavior

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

טיפוסים בני מנייה (enum)
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED התנהגות לא מוגדרת. ברירת המחדל היא FAIL.
FAIL הבדיקה תיכשל אם יזוהה קריאה נוספת לכלי.
ALLOW מאשרים את השימוש בכלי הנוסף.

HallucinationMetricBehavior

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

טיפוסים בני מנייה (enum)
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED התנהגות לא מוגדרת של מדד הזיות.
DISABLED השבתה של מדד ההזיות.
ENABLED הפעלת מדד ההזיות.

סוג

סוגי נתונים של OpenAPI.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED הסוג לא צוין.
STRING סוג המחרוזת.
INTEGER סוג Integer.
NUMBER סוג המספר.
BOOLEAN סוג בוליאני.
OBJECT סוג האובייקט.
ARRAY סוג המערך.

NullValue

מייצג JSON null.

‫NullValue הוא ערך שמירה, שמשתמש בערך מספרי עם ערך אחד בלבד כדי לייצג את ערך ה-null עבור איחוד הסוגים Value.

שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב כלי הסריאליזציה של 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 Chat).
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 עיצוב כהה.

כיוון

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

טיפוסים בני מנייה (enum)
DIRECTION_UNSPECIFIED כיוון לא מוגדר.
PARENT_TO_CHILD העברה מסוכן ראשי לסוכן הבן.
CHILD_TO_PARENT העברה מסוכן צאצא לסוכן ראשי.

RequestLocation

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

טיפוסים בני מנייה (enum)
REQUEST_LOCATION_UNSPECIFIED לא צוין. אין להשתמש בערך הזה.
HEADER מייצג את המפתח בכותרת ה-HTTP.
QUERY_STRING מייצג את המפתח במחרוזת של שאילתה.

OauthGrantType

סוגי הרשאות OAuth. יש תמיכה רק ב-client credential grant.

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

OperationType

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

טיפוסים בני מנייה (enum)
OPERATION_TYPE_UNSPECIFIED לא צוין סוג הפעולה. לא תקין, יצירה או עדכון של ConnectorTool ייכשלו.
LIST פעולה ברשימה.
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 הערך של השדה המספרי ישמש לעדכון דינמי של סכום ההגדלה. במקרה הזה, attribute_value (ערך המאפיין, הערך x) של נקודת הבקרה יהיה הערך בפועל של השדה המספרי שעבורו צוין boost_amount.
FRESHNESS בתרחיש השימוש של רעננות, ערך המאפיין יהיה משך הזמן שחלף בין השעה הנוכחית לבין התאריך בשדה התאריך והשעה שצוין. הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן לפי תקן ISO 8601). הדוגמה לכך היא: [nD][T[nH][nM][nS]]. לדוגמה: 5D, ‏ 3DT12H30M, ‏ T24H.

InterpolationType

סוג האינטרפולציה שרוצים להחיל. ברירת המחדל תהיה לינארית (Piecewise Linear).

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

ModalityType

סוג השיטה.

טיפוסים בני מנייה (enum)
MODALITY_TYPE_UNSPECIFIED סוג המודאליות לא צוין.
TEXT אופן הצגת הטקסט.
AUDIO שיטת אודיו.

FilterParameterBehavior

התנהגות פרמטרים של סינון.

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

מדינה

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

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

CorpusType

סוג המאגר של Vertex RAG.

טיפוסים בני מנייה (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 התאמה לתוכן מתבצעת באמצעות תחביר של ביטויים רגולריים.

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 משביתים את מסנן הבטיחות.

הערות על כלים

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

בנוסף למחרוזת הכותרת, מוגדרים הרמזים הבוליאניים הבאים:

  • ‫readOnlyHint: אם הערך הוא true, הכלי לא משנה את הסביבה שלו. ברירת מחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא false, הכלי יכול לבצע רק פעולות של הוספה. ברירת מחדל: true.
  • ‫idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת מחדל: false.
  • ‫openWorldHint: אם הערך הוא True, הכלי יכול ליצור אינטראקציה עם 'עולם פתוח' של ישויות חיצוניות. אם הערך הוא false, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.

רמז הרסני: ✅ | רמז אידמפוטנטי: ❌ | רמז לקריאה בלבד: ❌ | רמז לעולם פתוח: ❌