MCP Tools Reference: ces.googleapis.com

כלי: create_app

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

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי create_app 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",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

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

CreateAppRequest

ייצוג JSON 
{
  "parent": string,
  "appId": string,
  "app": {
    object (App)
  }
}
שדות
parent

string

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

string

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

object (App)

חובה. האפליקציה ליצירה.

אפליקציה

ייצוג 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

חותמת הזמן

ייצוג 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, כולל.

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}

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 עיצוב כהה.

סכימת הפלט

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

פעולה

ייצוג JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
שדות
name

string

השם שהוקצה על ידי השרת, שהוא ייחודי רק בתוך אותו שירות שהחזיר אותו במקור. אם משתמשים במיפוי HTTP שמוגדר כברירת מחדל, name צריך להיות שם משאב שמסתיים ב-operations/{unique_id}.
metadata

object

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

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

אם הערך הוא false, המשמעות היא שהפעולה עדיין מתבצעת. אם הערך הוא true, הפעולה הושלמה ואפשר להשתמש בערך error או response.
שדה איחוד result. תוצאת הפעולה, שיכולה להיות error או response חוקי. אם done == false, אף אחד מהערכים error או response לא מוגדר. אם done == true, אפשר להגדיר בדיוק אחד מהערכים error או response. יכול להיות שחלק מהשירותים לא יספקו את התוצאה. הערך result יכול להיות רק אחד מהבאים:
error

object (Status)

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

object

התגובה הרגילה והמוצלחת של הפעולה. אם השיטה המקורית לא מחזירה נתונים בהצלחה, כמו Delete, התגובה היא google.protobuf.Empty. אם השיטה המקורית היא סטנדרטית Get/Create/Update, התגובה צריכה להיות המשאב. בשיטות אחרות, התשובה צריכה להיות מהסוג XxxResponse, כאשר Xxx הוא שם השיטה המקורי. לדוגמה, אם שם השיטה המקורי הוא TakeSnapshot(), סוג התגובה שמוסק הוא TakeSnapshotResponse.

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

הכול

ייצוג JSON 
{
  "typeUrl": string,
  "value": string
}
שדות
typeUrl

string

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

דוגמה: type.googleapis.com/google.protobuf.StringValue

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

הקידומת היא שרירותית, וההטמעות של Protobuf אמורות פשוט להסיר את כל מה שמופיע עד הסימן / האחרון, כולל הסימן עצמו, כדי לזהות את הסוג. ‫type.googleapis.com/ היא תחילית ברירת מחדל נפוצה שנדרשת בחלק מההטמעות מדור קודם. הקידומת הזו לא מציינת את המקור של הסוג, ולא צפוי שמזהי URI שמכילים אותה יגיבו לבקשות כלשהן.

כל מחרוזות כתובות ה-URL של הסוג חייבות להיות הפניות חוקיות ל-URI, עם הגבלה נוספת (בפורמט הטקסט) שלפיה התוכן של ההפניה חייב לכלול רק תווים אלפאנומריים, תווים מיוחדים עם קידוד אחוזים ותווים מהקבוצה הבאה (לא כולל הגרשיים החיצוניים): /-.~_!$&()*+,;=. למרות שאנחנו מאפשרים קידודים באחוזים, בהטמעות לא צריך לבטל את הקידוד שלהם כדי למנוע בלבול עם מנתחים קיימים. לדוגמה, בקשה עם הערך type.googleapis.com%2FFoo צריכה להידחות.

בתכנון המקורי של Any, נשקלה האפשרות להפעיל שירות לפתרון סוגים בכתובות ה-URL האלה של הסוגים, אבל ב-Protobuf מעולם לא הוטמע שירות כזה, והפנייה לכתובות ה-URL האלה נחשבת לבעייתית ולבעיית אבטחה פוטנציאלית. אל תנסו ליצור קשר עם כתובות URL מסוג 'יצירת קשר'.
value

string (bytes format)

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

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

סטטוס

ייצוג JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך enum של google.rpc.Code.
message

string

הודעת שגיאה שמוצגת למפתחים, שצריכה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשפה המקומית ולהישלח בשדה google.rpc.Status.details, או להיות מותאמת לשפה המקומית על ידי הלקוח.
details[]

object

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

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

הערות על כלים

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

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

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

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