MCP Tools Reference: ces.googleapis.com

כלי: update_app

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

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

סכימת הקלט

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

UpdateAppRequest

ייצוג ב-JSON 
{
  "app": {
    object (App)
  },
  "updateMask": string
}
שדות
app

object (App)

חובה. האפליקציה שרוצים לעדכן.
updateMask

string (FieldMask format)

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

זוהי רשימה של שמות שדות שמוגדרים במלואם, שמופרדים באמצעות פסיקים. דוגמה: "user.displayName,photo"

אפליקציה

ייצוג ב-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)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
שדות
synthesizeSpeechConfigs

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

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

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

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

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

object (BargeInConfig)

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

string (Duration format)

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

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

object (AmbientSoundConfig)

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

object (CustomVoiceSample)

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

SynthesizeSpeechConfigsEntry

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

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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

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

number

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

string

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

string

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

BargeInConfig

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

boolean

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

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

boolean

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

משך

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

string (int64 format)

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

integer

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

AmbientSoundConfig

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

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

number

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

enum (PrebuiltAmbientNoise)

זה שינוי אופציונלי. הוצא משימוש: השימוש ב-prebuilt_ambient_noise הוצא משימוש, ועכשיו צריך להשתמש ב-prebuilt_ambient_sound.
gcsUri

string

זה שינוי אופציונלי. רעשי הסביבה כקובץ WAV עם ערוץ מונו, ‎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

CustomVoiceSample

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

string

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

string

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

string

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

string

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

string (bytes format)

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

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

string

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

object (Warning)

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

enum (VoiceInstructionMode)

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

אזהרה

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

string

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

enum (WarningType)

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

LoggingSettings

ייצוג ב-JSON 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "unredactedAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "unredactedBigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
שדות
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,
  "thinkingLevel": enum (ThinkingLevel),

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

string

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

enum (ThinkingLevel)

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

שדה איחוד _temperature.

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

number

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

EvaluationMetricsThresholds

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

object (GoldenEvaluationMetricsThresholds)

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

enum (HallucinationMetricBehavior)

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

enum (HallucinationMetricBehavior)

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

enum (HallucinationMetricBehavior)

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

GoldenEvaluationMetricsThresholds

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

object (TurnLevelMetricsThresholds)

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

object (ExpectationLevelMetricsThresholds)

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

object (ToolMatchingSettings)

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

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

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

FieldMask

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

string

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

PrebuiltAmbientNoise

רעשי סביבה מוכנים מראש.

טיפוסים בני מנייה (enum)
PREBUILT_AMBIENT_NOISE_UNSPECIFIED לא צוין.
RETAIL_STORE רעשי הסביבה בחנות קמעונאית.
CONVENTION_HALL רעשי הסביבה באולם כנסים.
OUTDOOR רעשי הסביבה של רחוב.

WarningType

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

טיפוסים בני מנייה (enum)
WARNING_TYPE_UNSPECIFIED סוג האזהרה לא צוין.
LOW_AUDIO_LEVEL רמת האודיו של דגימת הקול נמוכה מדי (למשל, אמפליטודת RMS נמוכה).

VoiceInstructionMode

מצב ההוראות לדוגמת הקול.

טיפוסים בני מנייה (enum)
VOICE_INSTRUCTION_MODE_UNSPECIFIED מצב ההוראה לא צוין. ברירת המחדל היא NO_INSTRUCTION.
NO_INSTRUCTION לא ייעשה שימוש בהוראות קוליות.
GENERATE_INSTRUCTION ההוראה הקולית תיווצר באופן אוטומטי על ידי AI מדגימת האודיו.
CUSTOM_INSTRUCTION הוראה קולית בהתאמה אישית שסופקה על ידי המשתמש.

ErrorHandlingStrategy

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

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

ThinkingLevel

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

טיפוסים בני מנייה (enum)
THINKING_LEVEL_UNSPECIFIED לא צוינה רמת ההעמקה.
DEFAULT רמת ההעמקה שמוגדרת כברירת מחדל.
LOW רמת העמקה נמוכה.
MEDIUM רמת העמקה בינונית.
HIGH רמת העמקה גבוהה.

ToolExecutionMode

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

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

SemanticSimilarityChannel

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

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

ExtraToolCallBehavior

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

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

שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב הסריאליזטורים של ProtoJSON יפלטו Value עם null_value שמוגדר כ-JSON null בלי קשר לערך המספרי, ולכן יבצעו המרה הלוך ושוב לערך 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.
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 עיצוב כהה.

סכימת הפלט

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

אפליקציה

ייצוג ב-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)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
שדות
synthesizeSpeechConfigs

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

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

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

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

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

object (BargeInConfig)

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

string (Duration format)

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

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

object (AmbientSoundConfig)

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

object (CustomVoiceSample)

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

SynthesizeSpeechConfigsEntry

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

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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

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

number

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

string

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

string

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

BargeInConfig

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

boolean

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

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

boolean

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

משך

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

string (int64 format)

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

integer

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

AmbientSoundConfig

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

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

number

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

enum (PrebuiltAmbientNoise)

זה שינוי אופציונלי. הוצא משימוש: השימוש ב-prebuilt_ambient_noise הוצא משימוש, ועכשיו צריך להשתמש ב-prebuilt_ambient_sound.
gcsUri

string

זה שינוי אופציונלי. רעשי הסביבה כקובץ WAV עם ערוץ מונו, ‎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

CustomVoiceSample

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

string

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

string

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

string

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

string

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

string (bytes format)

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

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

string

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

object (Warning)

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

enum (VoiceInstructionMode)

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

אזהרה

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

string

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

enum (WarningType)

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

LoggingSettings

ייצוג ב-JSON 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "unredactedAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "unredactedBigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
שדות
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,
  "thinkingLevel": enum (ThinkingLevel),

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

string

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

enum (ThinkingLevel)

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

שדה איחוד _temperature.

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

number

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

EvaluationMetricsThresholds

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

object (GoldenEvaluationMetricsThresholds)

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

enum (HallucinationMetricBehavior)

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

enum (HallucinationMetricBehavior)

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

enum (HallucinationMetricBehavior)

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

GoldenEvaluationMetricsThresholds

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

object (TurnLevelMetricsThresholds)

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

object (ExpectationLevelMetricsThresholds)

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

object (ToolMatchingSettings)

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

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

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

WarningType

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

טיפוסים בני מנייה (enum)
WARNING_TYPE_UNSPECIFIED סוג האזהרה לא צוין.
LOW_AUDIO_LEVEL רמת האודיו של דגימת הקול נמוכה מדי (למשל, אמפליטודת RMS נמוכה).

VoiceInstructionMode

מצב ההוראות לדוגמת הקול.

טיפוסים בני מנייה (enum)
VOICE_INSTRUCTION_MODE_UNSPECIFIED מצב ההוראה לא צוין. ברירת המחדל היא NO_INSTRUCTION.
NO_INSTRUCTION לא ייעשה שימוש בהוראות קוליות.
GENERATE_INSTRUCTION ההוראה הקולית תיווצר באופן אוטומטי על ידי AI מדגימת האודיו.
CUSTOM_INSTRUCTION הוראה קולית בהתאמה אישית שסופקה על ידי המשתמש.

ErrorHandlingStrategy

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

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

ThinkingLevel

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

טיפוסים בני מנייה (enum)
THINKING_LEVEL_UNSPECIFIED לא צוינה רמת ההעמקה.
DEFAULT רמת ההעמקה שמוגדרת כברירת מחדל.
LOW רמת העמקה נמוכה.
MEDIUM רמת העמקה בינונית.
HIGH רמת העמקה גבוהה.

ToolExecutionMode

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

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

SemanticSimilarityChannel

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

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

ExtraToolCallBehavior

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

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

שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב הסריאליזטורים של ProtoJSON יפלטו Value עם null_value שמוגדר כ-JSON null בלי קשר לערך המספרי, ולכן יבצעו המרה הלוך ושוב לערך 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.
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 עיצוב כהה.

הערות בכלי

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

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

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

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