- משאב: App
- ייצוג ב-JSON
- LanguageSettings
- TimeZoneSettings
- AudioProcessingConfig
- SynthesizeSpeechConfig
- BargeInConfig
- AmbientSoundConfig
- AmbientSoundConfig.PrebuiltAmbientNoise
- CustomVoiceSample
- CustomVoiceSample.Warning
- CustomVoiceSample.Warning.WarningType
- CustomVoiceSample.VoiceInstructionMode
- LoggingSettings
- RedactionConfig
- AudioRecordingConfig
- BigQueryExportSettings
- CloudLoggingSettings
- ConversationLoggingSettings
- MetricAnalysisSettings
- ErrorHandlingSettings
- ErrorHandlingSettings.ErrorHandlingStrategy
- ErrorHandlingSettings.FallbackResponseConfig
- ErrorHandlingSettings.EndSessionConfig
- App.ToolExecutionMode
- App.VariableDeclaration
- DataStoreSettings
- DataStoreSettings.Engine
- DataStoreSettings.Engine.Type
- ClientCertificateSettings
- VpcScSettings
- EvaluationSettings
- EvaluationSettings.ScenarioConversationInitiator
- DashboardSettings
- Methods
משאב: אפליקציה
אפליקציה משמשת כמאגר ברמה העליונה לקבוצה של סוכנים, כולל הסוכן הראשי וסוכני המשנה שלו, יחד עם ההגדרות המשויכות אליהם. הסוכנים האלה פועלים יחד כדי להשיג יעדים ספציפיים בהקשר של האפליקציה.
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של האפליקציה. פורמט: |
displayName |
חובה. השם המוצג של האפליקציה. |
description |
זה שינוי אופציונלי. תיאור קריא לאנשים של האפליקציה. |
pinned |
זה שינוי אופציונלי. אם האפליקציה מוצמדת ברשימת האפליקציות. |
rootAgent |
זה שינוי אופציונלי. הסוכן הראשי הוא נקודת הכניסה של האפליקציה. פורמט: |
languageSettings |
זה שינוי אופציונלי. הגדרות השפה של האפליקציה. |
timeZoneSettings |
זה שינוי אופציונלי. הגדרות אזור הזמן של האפליקציה. |
audioProcessingConfig |
זה שינוי אופציונלי. הגדרת עיבוד האודיו של האפליקציה. |
loggingSettings |
זה שינוי אופציונלי. הגדרות הרישום של האפליקציה. |
errorHandlingSettings |
זה שינוי אופציונלי. הגדרות הטיפול בשגיאות של האפליקציה. |
modelSettings |
זה שינוי אופציונלי. הגדרות ברירת המחדל של מודל ה-LLM באפליקציה. משאבים ספציפיים (למשל נציגים, אמצעי הגנה) יכולים לשנות את ההגדרות האלה לפי הצורך. |
toolExecutionMode |
זה שינוי אופציונלי. מצב הפעלת הכלים באפליקציה. אם לא מציינים מצב, ברירת המחדל היא PARALLEL. |
evaluationMetricsThresholds |
זה שינוי אופציונלי. סף ההערכה של האפליקציה. |
variableDeclarations[] |
זה שינוי אופציונלי. ההצהרות של המשתנים. |
predefinedVariableDeclarations[] |
פלט בלבד. ההצהרות על משתנים מוגדרים מראש של האפליקציה. |
globalInstruction |
זה שינוי אופציונלי. הוראות לכל הסוכנים באפליקציה. אפשר להשתמש בהוראה הזו כדי להגדיר זהות או אישיות יציבה לכל הסוכנים. |
guardrails[] |
זה שינוי אופציונלי. רשימת ההנחיות לאפליקציה. פורמט: |
dataStoreSettings |
זה שינוי אופציונלי. הגדרות מאגר הנתונים של האפליקציה. |
defaultChannelProfile |
זה שינוי אופציונלי. פרופיל הערוץ שמוגדר כברירת מחדל באפליקציה. |
metadata |
זה שינוי אופציונלי. מטא-נתונים על האפליקציה. אפשר להשתמש בשדה הזה כדי לאחסן מידע נוסף שרלוונטי לפרטי האפליקציה או לשימושים המיועדים שלה. אובייקט שמכיל רשימה של צמדי |
createTime |
פלט בלבד. חותמת הזמן של יצירת האפליקציה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של האפליקציה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
etag |
פלט בלבד. Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
deploymentCount |
פלט בלבד. מספר הפריסות באפליקציה. |
clientCertificateSettings |
זה שינוי אופציונלי. הגדרות ברירת המחדל של אישור הלקוח באפליקציה. |
vpcScSettings |
זה שינוי אופציונלי. הגדרות VPC-SC לאפליקציה. |
locked |
זה שינוי אופציונלי. מציין אם האפליקציה נעולה לשינויים. אם האפליקציה נעולה, שינויים במשאבי האפליקציה יידחו. |
evaluationPersonas[] |
זה שינוי אופציונלי. הפרסונות להערכה של האפליקציה. השדה הזה משמש להגדרת הפרסונות שאפשר להשתמש בהן להערכה. אפשר להגדיר עד 30 פרופילים של משתמשים. |
evaluationSettings |
זה שינוי אופציונלי. הגדרות ההערכה של האפליקציה. |
validationErrors[] |
פלט בלבד. הגדרות שגויות או אזהרות באפליקציה. |
dashboardSettings |
זה שינוי אופציונלי. הגדרות ספציפיות לאפליקציה של מרכז הבקרה, לקישור ולהגדרה של מרכזי הבקרה של Contact Center Insights. |
LanguageSettings
הגדרות השפה של האפליקציה.
| ייצוג ב-JSON |
|---|
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string } |
| שדות | |
|---|---|
defaultLanguageCode |
זה שינוי אופציונלי. קוד השפה שמוגדר כברירת מחדל באפליקציה. |
supportedLanguageCodes[] |
זה שינוי אופציונלי. רשימת קודי השפות שהאפליקציה תומכת בהן, בנוסף ל- |
enableMultilingualSupport |
זה שינוי אופציונלי. הפעלת תמיכה בכמה שפות. אם |
fallbackAction |
זה שינוי אופציונלי. הוצאה משימוש: התכונה הזו כבר לא נתמכת. כדי לשפר את הטיפול בקלט בכמה שפות, צריך להשתמש ב- זו יכולה להיות פעולה מוגדרת מראש או קריאת API לכלי בהתאמה אישית. הערכים התקינים הם: - שם המשאב המלא של הכלי, שמפעיל את הכלי הספציפי. - פעולת מערכת מוגדרת מראש, כמו "העברה לרמה גבוהה יותר" או "יציאה", שמפעילה אות |
TimeZoneSettings
הגדרות אזור הזמן של האפליקציה.
| ייצוג ב-JSON |
|---|
{ "timeZone": string } |
| שדות | |
|---|---|
timeZone |
זה שינוי אופציונלי. אזור הזמן של האפליקציה ממסד הנתונים של אזורי הזמן, למשל, America/Los_Angeles, Europe/Paris. |
AudioProcessingConfig
הגדרות לעיבוד ולשליחה של קלט ופלט של אודיו.
| ייצוג ב-JSON |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| שדות | |
|---|---|
synthesizeSpeechConfigs |
זה שינוי אופציונלי. הגדרת האופן שבו תגובת הנציג צריכה להיות מסונתזת, מיפוי מקוד השפה אל אם לא נמצאה הגדרה לקוד השפה שצוין, המערכת תשתמש בהגדרה של קוד השפה הבסיסי. לדוגמה, אם המפה מכילה את הערכים "en-us" ו-"en", וקוד השפה שצוין הוא "en-gb", המערכת תשתמש בהגדרות של "en". הערה: קוד השפה לא תלוי-רישיות. אובייקט שמכיל רשימה של צמדי |
bargeInConfig |
זה שינוי אופציונלי. ההגדרה הזו קובעת את ההתנהגות של הנציג כשהמשתמש מתפרץ לדבריו. |
inactivityTimeout |
זה שינוי אופציונלי. משך הזמן שבו המשתמש לא פעיל (אין דיבור או אינטראקציה) לפני שהסוכן מבקש מהמשתמש לחדש את האינטראקציה. אם המדיניות לא מוגדרת, הסוכן לא יבקש מהמשתמש לחדש את השימוש. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
ambientSoundConfig |
זה שינוי אופציונלי. הגדרת צליל הסביבה שיושמע עם התשובה המסונתזת של הנציג, כדי לשפר את הטבעיות של השיחה. |
customVoiceSamples[] |
זה שינוי אופציונלי. הגדרת דגימות קול בהתאמה אישית לשכפול קול. |
SynthesizeSpeechConfig
הגדרת האופן שבו התשובה של הנציג תעובד.
| ייצוג ב-JSON |
|---|
{ "voice": string, "speakingRate": number, "model": string, "instruction": string } |
| שדות | |
|---|---|
voice |
זה שינוי אופציונלי. שם הקול. אם לא מגדירים קול, השירות יבחר קול על סמך הפרמטרים האחרים, כמו languageCode. רשימת הקולות הזמינים מופיעה במאמר שפות וקולות נתמכים ב-Cloud Text-to-Speech. |
speakingRate |
זה שינוי אופציונלי. קצב/מהירות הדיבור בטווח [0.25, 2.0]. הערך 1.0 הוא המהירות הטבעית הרגילה שנתמכת בקול הספציפי. 2.0 היא מהירות כפולה, ו-0.5 היא חצי מהמהירות. ערכים מחוץ לטווח [0.25, 2.0] יחזירו שגיאה. |
model |
זה שינוי אופציונלי. המודל שמשמש לסינתוז אודיו. הערכים שנתמכים כרגע: - "gemini-3.1-flash-tts-preview" אם השדה ריק, המערכת משתמשת ב-Chirp3-HD. |
instruction |
זה שינוי אופציונלי. ההוראה שמשמשת לסנתז דיבור כשמשתמשים במודל גנרטיבי. |
BargeInConfig
הגדרת האופן שבו המערכת צריכה לטפל בפעילויות של התפרצות לדברי אחרים מצד המשתמש.
| ייצוג ב-JSON |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| שדות | |
|---|---|
disableBargeIn |
זה שינוי אופציונלי. הוצא משימוש: המשתמש לא יכול להתפרץ לדברי הנציג. אם הערך הוא True, המערכת תתעלם מהקלט של המשתמש בזמן שהנציג מפעיל את התשובה. |
bargeInAwareness |
זה שינוי אופציונלי. אם ההגדרה הזו מופעלת, הנציג יתאים את התשובה הבאה שלו בהנחה שהמשתמש לא שמע את כל ההודעה הקודמת של הנציג. אין להשתמש בזה בתרחישים שבהם התשובות של הנציג מוצגות באופן חזותי. |
AmbientSoundConfig
הגדרת צליל הסביבה שיושמע עם התשובה המסונתזת של הנציג, כדי לשפר את הטבעיות של השיחה.
| ייצוג ב-JSON |
|---|
{
"volumeGainDb": number,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"prebuiltAmbientNoise": enum ( |
| שדות | |
|---|---|
volumeGainDb |
זה שינוי אופציונלי. הגברת עוצמת הקול (בדציבלים) של עוצמת הקול המקורית הרגילה שנתמכת על ידי רעשי הסביבה, בטווח [-96.0, 16.0]. אם לא מגדירים את הפרמטר, או אם מגדירים אותו לערך של 0.0 (dB), האודיו יופעל באמפליטודת אות רגילה. ערך של -6.0 (dB) יופעל בערך בחצי מהאמפליטודה של האות המקורי הרגיל. ערך של +6.0 (dB) יגרום להפעלה בעוצמה של בערך פי שניים מהעוצמה הרגילה של האות המקורי. מומלץ מאוד לא לחרוג מ-+10 (dB), כי בדרך כלל אין עלייה אפקטיבית בעוצמת הקול בערך שגבוה מזה. |
| רעשי סביבה שיושמעו עם התשובה המסונתזת של הנציג, כדי שהשיחה תישמע טבעית יותר. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
prebuiltAmbientNoise |
זה שינוי אופציונלי. הוצא משימוש: |
gcsUri |
זה שינוי אופציונלי. רעשי סביבה כקובץ WAV עם ערוץ מונו בתדר 16kHz שמאוחסן ב-Cloud Storage. הערה: חשוב לוודא שלסוכן השירות של CES |
prebuiltAmbientSound |
זה שינוי אופציונלי. השם של צליל הרקע המובנה. הערכים התקינים הם: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner" |
| סוף השדות שמוציאים זה את זה. | |
AmbientSoundConfig.PrebuiltAmbientNoise
רעשי סביבה מובנים.
| טיפוסים בני מנייה (enum) | |
|---|---|
PREBUILT_AMBIENT_NOISE_UNSPECIFIED |
לא צוין. |
RETAIL_STORE |
רעשי הסביבה של חנות קמעונאית. |
CONVENTION_HALL |
רעשי הסביבה של אולם כנסים. |
OUTDOOR |
רעשי סביבה של רחוב. |
CustomVoiceSample
הגדרת דגימת קול בהתאמה אישית שמשמשת לשכפול קול.
| ייצוג ב-JSON |
|---|
{ "name": string, "voiceSampleGcsUri": string, "consentAudioGcsUri": string, "voiceInstruction": string, "previewAudioContent": string, "previewText": string, "warnings": [ { object ( |
| שדות | |
|---|---|
name |
זה שינוי אופציונלי. השם שהמשתמש נתן לדגימת הקול בהתאמה אישית. |
voiceSampleGcsUri |
זה שינוי אופציונלי. ה-URI של Cloud Storage לדגימת האודיו לשכפול הקול. דגימת האודיו צריכה להיות קובץ WAV עם ערוץ מונו ותדר של 24kHz. |
consentAudioGcsUri |
זה שינוי אופציונלי. אודיו של הסכמה לשכפול קול. |
voiceInstruction |
זה שינוי אופציונלי. הוראות בשפה טבעית לגבי סגנון הקול, הטון, הקצב או ההגייה. |
previewAudioContent |
פלט בלבד. אודיו מסונתז של תצוגה מקדימה לקול בהתאמה אישית, בפורמט WAV קנוני (LINEAR16, 24kHz, 16-bit, מונו). מחרוזת בקידוד Base64. |
previewText |
זה שינוי אופציונלי. טקסט לסנתוז של אודיו לתצוגה מקדימה של קול בהתאמה אישית. |
warnings[] |
פלט בלבד. הודעות אזהרה שמופיעות במהלך העיבוד של שיבוט הקול (למשל, עוצמת קול נמוכה). |
voiceInstructionMode |
זה שינוי אופציונלי. מצב ההוראות לדגימת הקול. אם לא מציינים ערך, ברירת המחדל היא NO_INSTRUCTION. |
CustomVoiceSample.Warning
הודעת אזהרה שמופיעה במהלך עיבוד דגימת הקול.
| ייצוג ב-JSON |
|---|
{
"message": string,
"type": enum ( |
| שדות | |
|---|---|
message |
פלט בלבד. תיאור קריא לאנשים של האזהרה. |
type |
פלט בלבד. סוג האזהרה. |
CustomVoiceSample.Warning.WarningType
סוג האזהרה שהתקבלה במהלך עיבוד דגימת הקול.
| טיפוסים בני מנייה (enum) | |
|---|---|
WARNING_TYPE_UNSPECIFIED |
סוג האזהרה לא צוין. |
LOW_AUDIO_LEVEL |
עוצמת הקול של דגימת הקול נמוכה מדי (למשל, משרעת RMS נמוכה). |
CustomVoiceSample.VoiceInstructionMode
מצב ההוראות לדגימת הקול.
| טיפוסים בני מנייה (enum) | |
|---|---|
VOICE_INSTRUCTION_MODE_UNSPECIFIED |
לא צוין אופן ההוראה. ברירת המחדל היא NO_INSTRUCTION. |
NO_INSTRUCTION |
לא תהיה הנחיה קולית. |
GENERATE_INSTRUCTION |
ההוראה הקולית תיווצר באופן אוטומטי על ידי AI מדגימת האודיו. |
CUSTOM_INSTRUCTION |
הוראה קולית בהתאמה אישית שהמשתמש נתן. |
LoggingSettings
הגדרות שמתארות את התנהגויות הרישום ביומן של האפליקציה.
| ייצוג ב-JSON |
|---|
{ "redactionConfig": { object ( |
| שדות | |
|---|---|
redactionConfig |
זה שינוי אופציונלי. הגדרות לצנזור מידע אישי רגיש. |
audioRecordingConfig |
זה שינוי אופציונלי. הגדרת האופן שבו יוקלטו אינטראקציות קוליות. האודיו כפוף לצנזור כפי שהוגדר ב- |
unredactedAudioRecordingConfig |
זה שינוי אופציונלי. ההגדרה קובעת הקלטה נוספת של אודיו לא מצונזר. אפשר להשתמש בזה כדי לשמור עותק של האודיו הגולמי כשצינזור האודיו |
bigqueryExportSettings |
זה שינוי אופציונלי. הגדרת אופן הייצוא של נתוני האפליקציה ל-BigQuery. נתוני השיחה מצונזרים בהתאם להגדרות ב- |
unredactedBigqueryExportSettings |
זה שינוי אופציונלי. הגדרת אופן הייצוא של נתוני האפליקציה ל-BigQuery. אם הייצוא מופעל, נתוני השיחה המלאים ייוצאו לטבלאות ב-BigQuery. |
cloudLoggingSettings |
זה שינוי אופציונלי. הגדרות שמתארות את ההתנהגויות של Cloud Logging באפליקציה. |
conversationLoggingSettings |
זה שינוי אופציונלי. הגדרות שמתארות את אופן הרישום של השיחות באפליקציה. |
evaluationAudioRecordingConfig |
זה שינוי אופציונלי. הגדרת האופן שבו אינטראקציות קוליות יוקלטו לצורך ההערכה. כברירת מחדל, הקלטת אודיו לא מופעלת בסשנים של הערכה. |
metricAnalysisSettings |
זה שינוי אופציונלי. הגדרות שמתארות את ההתנהגויות של איסוף נתוני השיחות בצינור עיבוד הנתונים של ניתוח ה-LLM באפליקציה. |
requiredRecordingConsent |
זה שינוי אופציונלי. אם האפליקציה צריכה להודיע מה עשוי להיות מוקלט לפני שתוכן כלשהו נשמר. אם הערך הוא True, הסשן מתחיל כשההקלטה מושבתת והיא נשארת מושבתת עד שהלקוח שולח את כשהמדיניות מוגדרת לערך |
RedactionConfig
הגדרות שמנחות איך לטפל במידע אישי רגיש.
| ייצוג ב-JSON |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| שדות | |
|---|---|
enableRedaction |
זה שינוי אופציונלי. אם |
inspectTemplate |
זה שינוי אופציונלי. שם תבנית הבדיקה של DLP כדי להגדיר זיהוי של סוגי נתונים רגישים. פורמט: |
deidentifyTemplate |
זה שינוי אופציונלי. שם תבנית להסרת פרטי הזיהוי ב-DLP, כדי להנחות איך להסיר את פרטי הזיהוי מהתוכן. פורמט: |
AudioRecordingConfig
הגדרת האופן שבו האינטראקציות הקוליות יוקלטו.
| ייצוג ב-JSON |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| שדות | |
|---|---|
gcsBucket |
זה שינוי אופציונלי. קטגוריית Cloud Storage לאחסון הקלטות האודיו של הסשן. ה-URI חייב להתחיל ב-"gs://". צריך לבחור מיקום לקטגוריה שעומד בדרישות של מיקום אחסון הנתונים. הערה: אם הקטגוריה של Cloud Storage נמצאת בפרויקט אחר מזה של האפליקציה, צריך לתת את ההרשאה |
gcsPathPrefix |
זה שינוי אופציונלי. התחילית של הנתיב ב-Cloud Storage להקלטות האודיו. הקידומת הזו יכולה לכלול את ה-placeholders הבאים, שיוחלפו באופן דינמי בזמן ההצגה: - $project: מזהה הפרויקט - $location: מיקום האפליקציה - $app: מזהה האפליקציה - $date: תאריך הסשן בפורמט YYYY-MM-DD - $session: מזהה הסשן אם לא מציינים את הקידומת של הנתיב, המערכת תשתמש בקידומת ברירת המחדל |
BigQueryExportSettings
הגדרות שמתארות את אופן הפעולה של ייצוא BigQuery באפליקציה.
| ייצוג ב-JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| שדות | |
|---|---|
enabled |
זה שינוי אופציונלי. מציין אם הייצוא ל-BigQuery מופעל. |
project |
זה שינוי אופציונלי. מזהה הפרויקט של מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים. הערה: אם מערך הנתונים של BigQuery נמצא בפרויקט אחר מהאפליקציה, צריך להקצות את התפקיד |
dataset |
זה שינוי אופציונלי. מזהה מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים. |
CloudLoggingSettings
הגדרות שמתארות את ההתנהגויות של Cloud Logging באפליקציה.
| ייצוג ב-JSON |
|---|
{ "enableCloudLogging": boolean } |
| שדות | |
|---|---|
enableCloudLogging |
זה שינוי אופציונלי. אם להפעיל את Cloud Logging בסשנים. |
ConversationLoggingSettings
הגדרות שמתארות את אופן הרישום של השיחות באפליקציה.
| ייצוג ב-JSON |
|---|
{ "disableConversationLogging": boolean, "retentionWindow": string } |
| שדות | |
|---|---|
disableConversationLogging |
זה שינוי אופציונלי. אם להשבית את הרישום ביומן של השיחות בסשנים. |
retentionWindow |
זה שינוי אופציונלי. קובעת את חלון השמירה של השיחה. אם לא מגדירים את המדיניות, השיחה נשמרת למשך 365 ימים. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
MetricAnalysisSettings
הגדרות לתיאור ההתנהגויות של איסוף נתוני השיחות עבור צינור עיבוד הנתונים של מדדי הניתוח של LLM.
| ייצוג ב-JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| שדות | |
|---|---|
llmMetricsOptedOut |
זה שינוי אופציונלי. אם לאסוף נתוני שיחות למדדי ניתוח של LLM. אם הערך הוא True, נתוני השיחה לא ייאספו לצורך מדדי ניתוח של LLM. אחרת, נתוני השיחה ייאספו. |
ErrorHandlingSettings
הגדרות שמתארות איך לטפל בשגיאות באפליקציה.
| ייצוג ב-JSON |
|---|
{ "errorHandlingStrategy": enum ( |
| שדות | |
|---|---|
errorHandlingStrategy |
זה שינוי אופציונלי. האסטרטגיה שבה רוצים להשתמש לטיפול בשגיאות. |
fallbackResponseConfig |
זה שינוי אופציונלי. הגדרת הטיפול בתגובות חלופיות. |
endSessionConfig |
זה שינוי אופציונלי. הגדרה לסיום הסשן במקרה של שגיאות מערכת (למשל, שגיאות LLM). |
ErrorHandlingSettings.ErrorHandlingStrategy
מגדיר את האסטרטגיה לטיפול בשגיאות.
| טיפוסים בני מנייה (enum) | |
|---|---|
ERROR_HANDLING_STRATEGY_UNSPECIFIED |
אסטרטגיית טיפול בשגיאות לא מזוהה. |
NONE |
לא מופעל טיפול ספציפי. |
FALLBACK_RESPONSE |
אם יהיו שגיאות במערכת (למשל, שגיאות ב-LLM), המשתמש יקבל הודעת גיבוי. |
END_SESSION |
אות EndSession יישלח במקרה של שגיאות מערכת (למשל, שגיאות LLM). |
ErrorHandlingSettings.FallbackResponseConfig
הגדרת הטיפול בתגובות חלופיות.
| ייצוג ב-JSON |
|---|
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer } |
| שדות | |
|---|---|
customFallbackMessages |
זה שינוי אופציונלי. הודעות ברירת המחדל במקרה של שגיאות מערכת (למשל, שגיאות LLM), ממופות לפי קוד שפה נתמך. אובייקט שמכיל רשימה של צמדי |
maxFallbackAttempts |
זה שינוי אופציונלי. מספר הניסיונות המקסימלי של הנציג להשתמש ב-fallback לפני שהוא שולח את האות |
ErrorHandlingSettings.EndSessionConfig
הגדרה לסיום הסשן במקרה של שגיאות מערכת (למשל, שגיאות LLM).
| ייצוג ב-JSON |
|---|
{ "escalateSession": boolean } |
| שדות | |
|---|---|
escalateSession |
זה שינוי אופציונלי. אם להעביר את הסשן לטיפול של נציג אנושי ב- |
App.ToolExecutionMode
ההגדרה הזו קובעת את אופן הפעולה של הכלי אם הנציג בוחר כמה כלים בו-זמנית.
| טיפוסים בני מנייה (enum) | |
|---|---|
TOOL_EXECUTION_MODE_UNSPECIFIED |
מצב הפעלת כלי לא מוגדר. ברירת המחדל היא PARALLEL. |
PARALLEL |
אם נבחרו כמה כלים, הם יופעלו במקביל עם אותו ToolContext. |
SEQUENTIAL |
אם נבחרו כמה כלים, הם יופעלו ברצף. הכלי הבא יופעל רק אחרי שהכלי הקודם יסיים את הפעולה שלו, והוא יוכל לראות את ה-ToolContext המעודכן מהכלי הקודם. |
App.VariableDeclaration
מגדיר את המבנה והמטא-נתונים של משתנה.
| ייצוג ב-JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| שדות | |
|---|---|
name |
חובה. שם המשתנה. השם חייב להתחיל באות או בקו תחתון, ויכול להכיל רק אותיות, מספרים או קווים תחתונים. |
description |
חובה. תיאור המשתנה. |
schema |
חובה. הסכימה של המשתנה. |
DataStoreSettings
הגדרות שקשורות למאגר הנתונים של האפליקציה.
| ייצוג ב-JSON |
|---|
{
"engines": [
{
object ( |
| שדות | |
|---|---|
engines[] |
פלט בלבד. המנועים של האפליקציה. |
DataStoreSettings.Engine
מנוע שאליו מחוברים מאגרי הנתונים. מידע נוסף על חיפוש מבוסס-Vertex AI: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction
| ייצוג ב-JSON |
|---|
{
"name": string,
"type": enum ( |
| שדות | |
|---|---|
name |
פלט בלבד. שם המשאב של המנוע. פורמט: |
type |
פלט בלבד. סוג המנוע. |
DataStoreSettings.Engine.Type
סוג המנוע. אפשר לעיין במסמכי התיעוד שזמינים בכתובת 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_SEARCH |
מנוע SOLUTION_TYPE_SEARCH לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה. |
ENGINE_TYPE_CHAT |
סוג מנוע הצ'אט. מנוע SOLUTION_TYPE_CHAT לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה. |
ClientCertificateSettings
הגדרות לאישורי לקוח בהתאמה אישית.
| ייצוג ב-JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| שדות | |
|---|---|
tlsCertificate |
חובה. אישור ה-TLS מקודד בפורמט PEM. המחרוזת הזו חייבת לכלול את שורות הכותרת העליונה והכותרת התחתונה. |
privateKey |
חובה. השם של משאב גרסת הסוד של SecretManager שבו מאוחסן המפתח הפרטי, מקודד בפורמט PEM. פורמט: |
passphrase |
זה שינוי אופציונלי. השם של משאב גרסת הסוד של SecretManager שבו מאוחסן ביטוי הסיסמה לפענוח המפתח הפרטי. אם המפתח הפרטי לא מוצפן, צריך להשאיר את השדה הזה ריק. פורמט: |
VpcScSettings
הגדרות VPC-SC לאפליקציה.
| ייצוג ב-JSON |
|---|
{ "allowedOrigins": [ string ] } |
| שדות | |
|---|---|
allowedOrigins[] |
זה שינוי אופציונלי. מקורות ה-HTTP(s) המותרים שכלי OpenAPI באפליקציה יכולים לקרוא להם ישירות כש-VPC Service Controls מופעל. המחרוזות האלה חייבות להתאים בדיוק למקור, כולל היציאה אם היא צוינה. לדוגמה, "https://example.com" או "https://example.com:443". הרשימה הזו עדיין לא חלה על כלי Python שעשויים לבצע קריאות HTTP ישירות. |
EvaluationSettings
הגדרות להערכה.
| ייצוג ב-JSON |
|---|
{ "scenarioConversationInitiator": enum ( |
| שדות | |
|---|---|
scenarioConversationInitiator |
זה שינוי אופציונלי. מי מתחיל את השיחה בהערכת התרחיש. |
goldenRunMethod |
זה שינוי אופציונלי. שיטת ברירת המחדל להרצת הערכות זהב. הערך הזה ישמש אם לא צוין goldenRunMethod ב-RunEvaluationRequest. |
goldenEvaluationToolCallBehaviour |
זה שינוי אופציונלי. הגדרת ברירת המחדל של אופן הפעולה של קריאת API לכלי בהערכות של קבוצת הזהב. |
scenarioEvaluationToolCallBehaviour |
זה שינוי אופציונלי. ההגדרה הזו קובעת את התנהגות ברירת המחדל של קריאות API לכלים בהערכות של תרחישים. |
metricsConfig |
זה שינוי אופציונלי. מגדיר את מדדי ברירת המחדל להערכות. |
scenarioExecutionMode |
זה שינוי אופציונלי. מצב ההפעלה של הערכות התרחישים. אם לא מציינים ערך, ברירת המחדל היא QUALITY_OPTIMIZED. |
evaluationRunCachingSettings |
זה שינוי אופציונלי. הגדרות השמירה במטמון שבהן צריך להשתמש בהרצת ההערכה. |
EvaluationSettings.ScenarioConversationInitiator
קובע מי מתחיל את השיחה בסשן הערכת תרחיש.
| טיפוסים בני מנייה (enum) | |
|---|---|
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED |
לא צוין. ברירת המחדל היא USER. |
USER |
המשתמש מתחיל את השיחה. |
AGENT |
הנציג מתחיל את השיחה. |
DashboardSettings
הגדרות של מרכזי בקרה שמשויכים לאפליקציה, שמופיעים בתצוגת המעקב.
| ייצוג ב-JSON |
|---|
{ "defaultDashboard": string } |
| שדות | |
|---|---|
defaultDashboard |
זה שינוי אופציונלי. שם המשאב של מרכז הבקרה שמוגדר כברירת מחדל ב-Contact Center Insights ומשויך לאפליקציה. זהו מרכז הבקרה שיוצג כשמשתמשים יעברו לתצוגת המעקב של האפליקציה. פורמט: |
Methods |
|
|---|---|
|
מפעיל את Arc, העוזר האישי מבוסס-AI, בסשן שצוין. |
|
יצירת אפליקציה חדשה בפרויקט ובמיקום הנתונים. |
|
מחיקת האפליקציה שצוינה. |
|
מפעיל את הכלי הנתון עם הארגומנטים הנתונים. |
|
ייצוא של האפליקציה שצוינה. |
|
יוצר משאבים ספציפיים (למשל, |
|
יוצר הצעות מותאמות אישית להכשרת עובדים חדשים במצב האפס של Arc: מסווג את המשתמש ששלח את הבקשה (חדש / בודק / חוזר) לפי היסטוריית הסשנים שלו עם Assistant באפליקציה, ומחזיר הצעות קשורות (להמשיך סשן, להמשיך לעבוד או להתחיל משהו חדש) שיוצגו לפני שליחת הודעה כלשהי. |
|
קבלת פרטים על האפליקציה שצוינה. |
|
מקבל את כרטיס הסוכן המורחב של הסוכן המאומת. |
|
מייבאת את האפליקציה שצוינה. |
|
ייבוא הערכות לאפליקציה. |
|
הצגת רשימה של האפליקציות בפרויקט ובמיקום שצוינו. |
|
עדכון האפליקציה שצוינה. |
|
אחזור הסכימה של הכלי הנתון. |
|
מפעיל את סוכן Assistant בסשן שצוין. |
|
מריץ הערכה של האפליקציה. |
|
בודק את הקול של דמות. |