MCP Tools Reference: ces.googleapis.com

כלי: update_app

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

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

בקשת 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. הפעולה לביצוע כשהנציג מקבל קלט בשפה שאינה נתמכת.

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

TimeZoneSettings

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

string

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

AudioProcessingConfig

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

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

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

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

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

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

bargeInConfig

object (BargeInConfig)

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

inactivityTimeout

string (Duration format)

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

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

ambientSoundConfig

object (AmbientSoundConfig)

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

customVoiceSamples[]

object (CustomVoiceSample)

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

SynthesizeSpeechConfigsEntry

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

string

value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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

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

speakingRate

number

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

model

string

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

instruction

string

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

BargeInConfig

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

boolean

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

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

bargeInAwareness

boolean

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

משך

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

string (int64 format)

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

nanos

integer

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

AmbientSoundConfig

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

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

number

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

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

enum (PrebuiltAmbientNoise)

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

gcsUri

string

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

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

prebuiltAmbientSound

string

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

CustomVoiceSample

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

string

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

voiceSampleGcsUri

string

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

consentAudioGcsUri

string

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

voiceInstruction

string

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

previewAudioContent

string (bytes format)

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

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

previewText

string

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

warnings[]

object (Warning)

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

voiceInstructionMode

enum (VoiceInstructionMode)

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

אזהרה

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

string

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

type

enum (WarningType)

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

LoggingSettings

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

object (RedactionConfig)

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

audioRecordingConfig

object (AudioRecordingConfig)

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

unredactedAudioRecordingConfig

object (AudioRecordingConfig)

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

bigqueryExportSettings

object (BigQueryExportSettings)

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

unredactedBigqueryExportSettings

object (BigQueryExportSettings)

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

cloudLoggingSettings

object (CloudLoggingSettings)

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

conversationLoggingSettings

object (ConversationLoggingSettings)

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

evaluationAudioRecordingConfig

object (AudioRecordingConfig)

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

metricAnalysisSettings

object (MetricAnalysisSettings)

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

requiredRecordingConsent

boolean

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

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

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

RedactionConfig

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

boolean

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

inspectTemplate

string

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

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

deidentifyTemplate

string

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

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

AudioRecordingConfig

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

string

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

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

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

gcsPathPrefix

string

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

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

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

BigQueryExportSettings

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

boolean

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

project

string

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

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

dataset

string

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

CloudLoggingSettings

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

boolean

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

ConversationLoggingSettings

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

boolean

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

retentionWindow

string (Duration format)

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

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

MetricAnalysisSettings

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

boolean

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

ErrorHandlingSettings

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

enum (ErrorHandlingStrategy)

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

fallbackResponseConfig

object (FallbackResponseConfig)

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

endSessionConfig

object (EndSessionConfig)

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

FallbackResponseConfig

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

map (key: string, value: string)

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

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

maxFallbackAttempts

integer

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

CustomFallbackMessagesEntry

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

string

value

string

EndSessionConfig

ייצוג ב-JSON
{

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

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

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

escalateSession

boolean

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

ModelSettings

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

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

string

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

thinkingLevel

enum (ThinkingLevel)

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

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

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

temperature

number

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

EvaluationMetricsThresholds

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

object (GoldenEvaluationMetricsThresholds)

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

hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

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

goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

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

scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

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

GoldenEvaluationMetricsThresholds

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

object (TurnLevelMetricsThresholds)

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

expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

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

toolMatchingSettings

object (ToolMatchingSettings)

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

TurnLevelMetricsThresholds

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

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

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

enum (SemanticSimilarityChannel)

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

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

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

semanticSimilaritySuccessThreshold

integer

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

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

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

overallToolInvocationCorrectnessThreshold

number

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

ExpectationLevelMetricsThresholds

ייצוג ב-JSON
{

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

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

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

toolInvocationParameterCorrectnessThreshold

number

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

ToolMatchingSettings

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

enum (ExtraToolCallBehavior)

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

VariableDeclaration

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

string

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

description

string

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

schema

object (Schema)

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

סכימה

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

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

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

enum (Type)

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

properties

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

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

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

required[]

string

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

description

string

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

items

object (Schema)

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

nullable

boolean

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

uniqueItems

boolean

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

prefixItems[]

object (Schema)

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

additionalProperties

object (Schema)

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

anyOf[]

object (Schema)

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

enum[]

string

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

default

value (Value format)

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

ref

string

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

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

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

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

defs

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

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

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

title

string

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

minItems

string (int64 format)

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

maxItems

string (int64 format)

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

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

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

minimum

number

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

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

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

maximum

number

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

PropertiesEntry

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

string

value

object (Schema)

ערך

ייצוג ב-JSON
{

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

null

מייצג null ב-JSON.

numberValue

number

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

stringValue

string

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

boolValue

boolean

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

structValue

object (Struct format)

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

listValue

array (ListValue format)

מייצג מערך JSON.

Struct

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

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

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

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

FieldsEntry

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

string

value

value (Value format)

ListValue

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

value (Value format)

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

DefsEntry

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

string

value

object (Schema)

DataStoreSettings

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

object (Engine)

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

מנוע

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

string

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

type

enum (Type)

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

ChannelProfile

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

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

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

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

string

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

channelType

enum (ChannelType)

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

personaProperty

object (PersonaProperty)

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

webWidgetConfig

object (WebWidgetConfig)

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

whatsappConfig

object (WhatsAppConfig)

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

instagramConfig

object (InstagramConfig)

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

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

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

disableDtmf

boolean

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

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

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

disableBargeInControl

boolean

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

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

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

noiseSuppressionLevel

string

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

PersonaProperty

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

enum (Persona)

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

WebWidgetConfig

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

enum (Modality)

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

theme

enum (Theme)

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

webWidgetTitle

string

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

securitySettings

object (SecuritySettings)

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

SecuritySettings

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

boolean

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

enableOriginCheck

boolean

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

allowedOrigins[]

string

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

enableRecaptcha

boolean

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

WhatsAppConfig

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

string

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

phoneNumberId

string

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

phoneNumber

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

InstagramConfig

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

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

MetadataEntry

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

string

value

string

חותמת הזמן

ייצוג ב-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 אות EndSession יישלח במקרה של שגיאות מערכת (למשל, שגיאות LLM).

ThinkingLevel

הגדרת רמת ההעמקה של המודל.

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

ToolExecutionMode

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

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

SemanticSimilarityChannel

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

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

ExtraToolCallBehavior

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

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

HallucinationMetricBehavior

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

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

סוג

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

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

NullValue

מייצג null ב-JSON.

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

שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יבצעו סבב מלא לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך Null.

סוג

סוג המנוע. אפשר לעיין במסמכי התיעוד שזמינים בכתובת https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType ובכתובת https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג המנוע לא צוין.
ENGINE_TYPE_CHAT סוג מנוע הצ'אט. מנוע SOLUTION_TYPE_CHAT לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה.

ChannelType

סוג פרופיל הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN סוג הערוץ לא ידוע.
WEB_UI ערוץ ממשק המשתמש באינטרנט.
API ערוץ API.
TWILIO ערוץ Twilio.
GOOGLE_TELEPHONY_PLATFORM ערוץ Google Telephony Platform.
CONTACT_CENTER_AS_A_SERVICE ערוץ Contact Center as a Service‏ (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT ערוץ Contact Center as a Service (צ'אט CCaaS).
FIVE9 ערוץ Five9.
CONTACT_CENTER_INTEGRATION ערוץ שילוב של מוקד שירות של צד שלישי.
WHATSAPP ערוץ וואטסאפ.
INSTAGRAM ערוץ באינסטגרם.

פרסונה

הפרסונה של הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN פרסונה לא ידועה.
CONCISE הסוכן שומר על תשובות תמציתיות וענייניות
CHATTY הנציג מספק הקשר, הסברים ופרטים נוספים

מודליות

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

טיפוסים בני מנייה (enum)
MODALITY_UNSPECIFIED אופן לא ידוע.
CHAT_AND_VOICE הווידג'ט תומך גם בקלט של צ'אט וגם בקלט קולי.
VOICE_ONLY הווידג'ט תומך רק בקלט קולי.
CHAT_ONLY הווידג'ט תומך רק בקלט של צ'אט.
CHAT_VOICE_AND_VIDEO הווידג'ט תומך בקלט של צ'אט, קול ווידאו.

עיצוב

העיצוב של הווידג'ט לאתר.

טיפוסים בני מנייה (enum)
THEME_UNSPECIFIED עיצוב לא ידוע.
LIGHT עיצוב בהיר.
DARK עיצוב כהה.

סכימת הפלט

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

אפליקציה

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

string

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

displayName

string

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

description

string

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

pinned

boolean

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

rootAgent

string

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

languageSettings

object (LanguageSettings)

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

timeZoneSettings

object (TimeZoneSettings)

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

audioProcessingConfig

object (AudioProcessingConfig)

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

loggingSettings

object (LoggingSettings)

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

errorHandlingSettings

object (ErrorHandlingSettings)

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

modelSettings

object (ModelSettings)

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

toolExecutionMode

enum (ToolExecutionMode)

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

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

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

variableDeclarations[]

object (VariableDeclaration)

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

predefinedVariableDeclarations[]

object (VariableDeclaration)

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

globalInstruction

string

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

guardrails[]

string

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

dataStoreSettings

object (DataStoreSettings)

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

defaultChannelProfile

object (ChannelProfile)

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

metadata

map (key: string, value: string)

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

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

createTime

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

etag

string

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

deploymentCount

integer

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

clientCertificateSettings

object (ClientCertificateSettings)

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

vpcScSettings

object (VpcScSettings)

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

locked

boolean

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

validationErrors[]

string

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

dashboardSettings

object (DashboardSettings)

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

LanguageSettings

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

string

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

supportedLanguageCodes[]

string

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

enableMultilingualSupport

boolean

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

fallbackAction
(deprecated)

string

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

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

TimeZoneSettings

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

string

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

AudioProcessingConfig

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

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

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

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

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

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

bargeInConfig

object (BargeInConfig)

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

inactivityTimeout

string (Duration format)

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

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

ambientSoundConfig

object (AmbientSoundConfig)

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

customVoiceSamples[]

object (CustomVoiceSample)

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

SynthesizeSpeechConfigsEntry

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

string

value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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

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

speakingRate

number

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

model

string

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

instruction

string

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

BargeInConfig

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

boolean

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

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

bargeInAwareness

boolean

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

משך

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

string (int64 format)

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

nanos

integer

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

AmbientSoundConfig

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

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

number

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

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

enum (PrebuiltAmbientNoise)

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

gcsUri

string

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

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

prebuiltAmbientSound

string

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

CustomVoiceSample

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

string

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

voiceSampleGcsUri

string

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

consentAudioGcsUri

string

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

voiceInstruction

string

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

previewAudioContent

string (bytes format)

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

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

previewText

string

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

warnings[]

object (Warning)

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

voiceInstructionMode

enum (VoiceInstructionMode)

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

אזהרה

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

string

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

type

enum (WarningType)

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

LoggingSettings

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

object (RedactionConfig)

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

audioRecordingConfig

object (AudioRecordingConfig)

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

unredactedAudioRecordingConfig

object (AudioRecordingConfig)

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

bigqueryExportSettings

object (BigQueryExportSettings)

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

unredactedBigqueryExportSettings

object (BigQueryExportSettings)

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

cloudLoggingSettings

object (CloudLoggingSettings)

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

conversationLoggingSettings

object (ConversationLoggingSettings)

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

evaluationAudioRecordingConfig

object (AudioRecordingConfig)

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

metricAnalysisSettings

object (MetricAnalysisSettings)

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

requiredRecordingConsent

boolean

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

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

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

RedactionConfig

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

boolean

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

inspectTemplate

string

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

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

deidentifyTemplate

string

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

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

AudioRecordingConfig

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

string

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

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

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

gcsPathPrefix

string

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

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

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

BigQueryExportSettings

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

boolean

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

project

string

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

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

dataset

string

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

CloudLoggingSettings

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

boolean

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

ConversationLoggingSettings

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

boolean

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

retentionWindow

string (Duration format)

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

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

MetricAnalysisSettings

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

boolean

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

ErrorHandlingSettings

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

enum (ErrorHandlingStrategy)

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

fallbackResponseConfig

object (FallbackResponseConfig)

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

endSessionConfig

object (EndSessionConfig)

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

FallbackResponseConfig

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

map (key: string, value: string)

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

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

maxFallbackAttempts

integer

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

CustomFallbackMessagesEntry

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

string

value

string

EndSessionConfig

ייצוג ב-JSON
{

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

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

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

escalateSession

boolean

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

ModelSettings

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

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

string

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

thinkingLevel

enum (ThinkingLevel)

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

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

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

temperature

number

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

EvaluationMetricsThresholds

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

object (GoldenEvaluationMetricsThresholds)

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

hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

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

goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

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

scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

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

GoldenEvaluationMetricsThresholds

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

object (TurnLevelMetricsThresholds)

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

expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

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

toolMatchingSettings

object (ToolMatchingSettings)

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

TurnLevelMetricsThresholds

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

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

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

enum (SemanticSimilarityChannel)

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

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

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

semanticSimilaritySuccessThreshold

integer

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

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

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

overallToolInvocationCorrectnessThreshold

number

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

ExpectationLevelMetricsThresholds

ייצוג ב-JSON
{

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

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

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

toolInvocationParameterCorrectnessThreshold

number

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

ToolMatchingSettings

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

enum (ExtraToolCallBehavior)

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

VariableDeclaration

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

string

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

description

string

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

schema

object (Schema)

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

סכימה

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

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

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

enum (Type)

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

properties

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

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

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

required[]

string

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

description

string

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

items

object (Schema)

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

nullable

boolean

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

uniqueItems

boolean

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

prefixItems[]

object (Schema)

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

additionalProperties

object (Schema)

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

anyOf[]

object (Schema)

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

enum[]

string

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

default

value (Value format)

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

ref

string

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

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

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

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

defs

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

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

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

title

string

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

minItems

string (int64 format)

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

maxItems

string (int64 format)

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

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

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

minimum

number

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

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

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

maximum

number

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

PropertiesEntry

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

string

value

object (Schema)

ערך

ייצוג ב-JSON
{

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

null

מייצג null ב-JSON.

numberValue

number

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

stringValue

string

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

boolValue

boolean

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

structValue

object (Struct format)

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

listValue

array (ListValue format)

מייצג מערך JSON.

Struct

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

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

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

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

FieldsEntry

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

string

value

value (Value format)

ListValue

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

value (Value format)

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

DefsEntry

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

string

value

object (Schema)

DataStoreSettings

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

object (Engine)

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

מנוע

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

string

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

type

enum (Type)

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

ChannelProfile

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

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

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

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

string

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

channelType

enum (ChannelType)

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

personaProperty

object (PersonaProperty)

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

webWidgetConfig

object (WebWidgetConfig)

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

whatsappConfig

object (WhatsAppConfig)

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

instagramConfig

object (InstagramConfig)

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

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

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

disableDtmf

boolean

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

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

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

disableBargeInControl

boolean

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

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

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

noiseSuppressionLevel

string

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

PersonaProperty

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

enum (Persona)

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

WebWidgetConfig

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

enum (Modality)

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

theme

enum (Theme)

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

webWidgetTitle

string

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

securitySettings

object (SecuritySettings)

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

SecuritySettings

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

boolean

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

enableOriginCheck

boolean

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

allowedOrigins[]

string

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

enableRecaptcha

boolean

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

WhatsAppConfig

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

string

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

phoneNumberId

string

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

phoneNumber

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

InstagramConfig

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

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

MetadataEntry

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

string

value

string

חותמת הזמן

ייצוג ב-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 אות EndSession יישלח במקרה של שגיאות מערכת (למשל, שגיאות LLM).

ThinkingLevel

הגדרת רמת ההעמקה של המודל.

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

ToolExecutionMode

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

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

SemanticSimilarityChannel

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

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

ExtraToolCallBehavior

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

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

HallucinationMetricBehavior

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

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

סוג

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

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

NullValue

מייצג null ב-JSON.

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

שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יבצעו סבב מלא לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך Null.

סוג

סוג המנוע. אפשר לעיין במסמכי התיעוד שזמינים בכתובת https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType ובכתובת https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג המנוע לא צוין.
ENGINE_TYPE_CHAT סוג מנוע הצ'אט. מנוע SOLUTION_TYPE_CHAT לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה.

ChannelType

סוג פרופיל הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN סוג הערוץ לא ידוע.
WEB_UI ערוץ ממשק המשתמש באינטרנט.
API ערוץ API.
TWILIO ערוץ Twilio.
GOOGLE_TELEPHONY_PLATFORM ערוץ Google Telephony Platform.
CONTACT_CENTER_AS_A_SERVICE ערוץ Contact Center as a Service‏ (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT ערוץ Contact Center as a Service (צ'אט CCaaS).
FIVE9 ערוץ Five9.
CONTACT_CENTER_INTEGRATION ערוץ שילוב של מוקד שירות של צד שלישי.
WHATSAPP ערוץ וואטסאפ.
INSTAGRAM ערוץ באינסטגרם.

פרסונה

הפרסונה של הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN פרסונה לא ידועה.
CONCISE הסוכן שומר על תשובות תמציתיות וענייניות
CHATTY הנציג מספק הקשר, הסברים ופרטים נוספים

מודליות

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

טיפוסים בני מנייה (enum)
MODALITY_UNSPECIFIED אופן לא ידוע.
CHAT_AND_VOICE הווידג'ט תומך גם בקלט של צ'אט וגם בקלט קולי.
VOICE_ONLY הווידג'ט תומך רק בקלט קולי.
CHAT_ONLY הווידג'ט תומך רק בקלט של צ'אט.
CHAT_VOICE_AND_VIDEO הווידג'ט תומך בקלט של צ'אט, קול ווידאו.

עיצוב

העיצוב של הווידג'ט לאתר.

טיפוסים בני מנייה (enum)
THEME_UNSPECIFIED עיצוב לא ידוע.
LIGHT עיצוב בהיר.
DARK עיצוב כהה.

הערות לגבי הכלים

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

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

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

Destructive Hint: ✅ | Idempotent Hint: ❌ | Read Only Hint: ❌ | Open World Hint: ❌