כלי: get_app_version
קבלת פרטים על גרסת האפליקציה שצוינה.
בדוגמת הקוד הבאה מוסבר איך להשתמש ב-curl כדי להפעיל את כלי ה-MCP get_app_version.
| בקשת 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": "get_app_version", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
סכימת הקלט
הודעת בקשה עבור AgentService.GetAppVersion.
GetAppVersionRequest
| ייצוג ב-JSON |
|---|
{ "name": string } |
| שדות | |
|---|---|
name |
חובה. שם המשאב של גרסת האפליקציה שרוצים לאחזר. |
סכימת הפלט
ב-Customer Engagement Suite (CES), גרסת אפליקציה היא תמונת מצב של האפליקציה בנקודת זמן ספציפית. הוא לא ניתן לשינוי אחרי שיוצרים אותו.
AppVersion
| ייצוג ב-JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"creator": string,
"createTime": string,
"updateTime": string,
"snapshot": {
object ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של גרסת האפליקציה. פורמט: |
displayName |
זה שינוי אופציונלי. השם המוצג של גרסת האפליקציה. |
description |
זה שינוי אופציונלי. תיאור גרסת האפליקציה. |
creator |
פלט בלבד. כתובת האימייל של המשתמש שיצר את גרסת האפליקציה. |
createTime |
פלט בלבד. חותמת הזמן של יצירת גרסת האפליקציה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של גרסת האפליקציה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
snapshot |
פלט בלבד. תמונת המצב של האפליקציה כשהגרסה נוצרת. |
etag |
פלט בלבד. Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
חותמת הזמן
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
מייצג שניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) 1970-01-01T00:00:00Z. הערך חייב להיות בין -62135596800 ל-253402300799, כולל (טווח שמתאים ל-0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z). |
nanos |
שברים לא שליליים של שנייה ברזולוציה של ננו-שנייה. השדה הזה הוא החלק של הננו-שניות במשך הזמן, ולא חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שנספרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל. |
AppSnapshot
| ייצוג ב-JSON |
|---|
{ "app": { object ( |
| שדות | |
|---|---|
app |
זה שינוי אופציונלי. ההגדרות הבסיסיות של האפליקציה. |
agents[] |
זה שינוי אופציונלי. רשימת הסוכנים באפליקציה. |
tools[] |
זה שינוי אופציונלי. רשימת הכלים באפליקציה. |
examples[] |
זה שינוי אופציונלי. רשימת דוגמאות באפליקציה. |
guardrails[] |
זה שינוי אופציונלי. רשימת ההנחיות באפליקציה. |
toolsets[] |
זה שינוי אופציונלי. רשימת ערכות הכלים באפליקציה. |
אפליקציה
| ייצוג ב-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 |
זה שינוי אופציונלי. מציין אם האפליקציה נעולה לשינויים. אם האפליקציה נעולה, שינויים במשאבי האפליקציה יידחו. |
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[] |
זה שינוי אופציונלי. הגדרת דגימות קול בהתאמה אישית לשכפול קול. |
SynthesizeSpeechConfigsEntry
| ייצוג ב-JSON |
|---|
{
"key": string,
"value": {
object ( |
| שדות | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| ייצוג ב-JSON |
|---|
{ "voice": string, "speakingRate": number, "model": string, "instruction": string } |
| שדות | |
|---|---|
voice |
זה שינוי אופציונלי. שם הקול. אם לא מגדירים את השדה הזה, השירות יבחר קול על סמך הפרמטרים האחרים, כמו language_code. רשימת הקולות הזמינים מופיעה במאמר שפות וקולות נתמכים ב-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 |
זה שינוי אופציונלי. אם ההגדרה הזו מופעלת, הנציג יתאים את התשובה הבאה שלו בהנחה שהמשתמש לא שמע את כל ההודעה הקודמת של הנציג. אין להשתמש בזה בתרחישים שבהם התשובות של הנציג מוצגות באופן חזותי. |
משך
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
שניות חתומות של משך הזמן. הערך חייב להיות בין -315,576,000,000 ל-+315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות/דקה * 60 דקות/שעה * 24 שעות/יום * 365.25 ימים/שנה * 10,000 שנים |
nanos |
שברים חתומים של שנייה ברזולוציה של ננו-שנייה של משך הזמן. משכי זמן של פחות משנייה מיוצגים על ידי שדה |
AmbientSoundConfig
| ייצוג ב-JSON |
|---|
{ "volumeGainDb": number, // Union field |
| שדות | |
|---|---|
volumeGainDb |
זה שינוי אופציונלי. הגברת עוצמת הקול (בדציבלים) של עוצמת הקול המקורית הרגילה שנתמכת על ידי רעשי הסביבה, בטווח [-96.0, 16.0]. אם לא מגדירים את הפרמטר, או אם מגדירים אותו לערך של 0.0 (dB), האודיו יופעל באמפליטודת אות רגילה. ערך של -6.0 (dB) יופעל בערך בחצי מהאמפליטודה של האות המקורי הרגיל. ערך של +6.0 (dB) יגרום להפעלה בעוצמה של בערך פי שניים מהעוצמה הרגילה של האות המקורי. מומלץ מאוד לא לחרוג מ-+10 (dB), כי בדרך כלל אין עלייה אפקטיבית בעוצמת הקול בערך שגבוה מזה. |
שדה של איחוד source. רעשי סביבה שיושמעו עם התשובה המסונתזת של הנציג, כדי שהשיחה תישמע טבעית יותר. הערך source יכול להיות רק אחד מהבאים: |
|
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" |
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. |
אזהרה
| ייצוג ב-JSON |
|---|
{
"message": string,
"type": enum ( |
| שדות | |
|---|---|
message |
פלט בלבד. תיאור קריא לאנשים של האזהרה. |
type |
פלט בלבד. סוג האזהרה. |
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
| ייצוג ב-JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| שדות | |
|---|---|
enabled |
זה שינוי אופציונלי. מציין אם הייצוא ל-BigQuery מופעל. |
project |
זה שינוי אופציונלי. מזהה הפרויקט של מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים. הערה: אם מערך הנתונים של BigQuery נמצא בפרויקט אחר מהאפליקציה, צריך להקצות את התפקיד |
dataset |
זה שינוי אופציונלי. מזהה מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים. |
CloudLoggingSettings
| ייצוג ב-JSON |
|---|
{ "enableCloudLogging": boolean } |
| שדות | |
|---|---|
enableCloudLogging |
זה שינוי אופציונלי. אם להפעיל את Cloud Logging בסשנים. |
ConversationLoggingSettings
| ייצוג ב-JSON |
|---|
{ "disableConversationLogging": boolean, "retentionWindow": string } |
| שדות | |
|---|---|
disableConversationLogging |
זה שינוי אופציונלי. אם להשבית את הרישום ביומן של השיחות בסשנים. |
retentionWindow |
זה שינוי אופציונלי. קובעת את חלון השמירה של השיחה. אם לא מגדירים את המדיניות, השיחה נשמרת למשך 365 ימים. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
MetricAnalysisSettings
| ייצוג ב-JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| שדות | |
|---|---|
llmMetricsOptedOut |
זה שינוי אופציונלי. אם לאסוף נתוני שיחות למדדי ניתוח של LLM. אם הערך הוא True, נתוני השיחה לא ייאספו לצורך מדדי ניתוח של LLM. אחרת, נתוני השיחה ייאספו. |
ErrorHandlingSettings
| ייצוג ב-JSON |
|---|
{ "errorHandlingStrategy": enum ( |
| שדות | |
|---|---|
errorHandlingStrategy |
זה שינוי אופציונלי. האסטרטגיה שבה רוצים להשתמש לטיפול בשגיאות. |
fallbackResponseConfig |
זה שינוי אופציונלי. הגדרת הטיפול בתגובות חלופיות. |
endSessionConfig |
זה שינוי אופציונלי. הגדרה לסיום הסשן במקרה של שגיאות מערכת (למשל, שגיאות LLM). |
FallbackResponseConfig
| ייצוג ב-JSON |
|---|
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer } |
| שדות | |
|---|---|
customFallbackMessages |
זה שינוי אופציונלי. הודעות ברירת המחדל במקרה של שגיאות מערכת (למשל, שגיאות LLM), ממופות לפי קוד שפה נתמך. אובייקט שמכיל רשימה של צמדי |
maxFallbackAttempts |
זה שינוי אופציונלי. מספר הניסיונות המקסימלי של הנציג להשתמש ב-fallback לפני שהוא שולח את האות |
CustomFallbackMessagesEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
EndSessionConfig
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד הערך |
|
escalateSession |
זה שינוי אופציונלי. אם להעביר את הסשן לטיפול של נציג אנושי ב- |
ModelSettings
| ייצוג ב-JSON |
|---|
{ "model": string, "thinkingLevel": enum ( |
| שדות | |
|---|---|
model |
זה שינוי אופציונלי. מודל ה-LLM שהסוכן צריך להשתמש בו. אם לא מגדירים מודל, הסוכן יורש את המודל מהסוכן הראשי שלו. |
thinkingLevel |
זה שינוי אופציונלי. רמת ההעמקה של המודל. |
שדה של איחוד הערך |
|
temperature |
זה שינוי אופציונלי. אם מגדירים את הטמפרטורה, היא תשמש למודל ה-LLM. הטמפרטורה קובעת את רמת הרנדומיזציה של התשובות של המודל. ערכים נמוכים יותר יובילו לתשובות צפויות יותר. טמפרטורות גבוהות יותר יוצרות תשובות יצירתיות יותר. |
EvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| שדות | |
|---|---|
goldenEvaluationMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של מדדי ההערכה המושלמים. |
hallucinationMetricBehavior |
זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש ב- |
goldenHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות הזהב. |
scenarioHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות המדד "הזיות" בהערכות של תרחישים. |
GoldenEvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| שדות | |
|---|---|
turnLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת התור. |
expectationLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת הציפייה. |
toolMatchingSettings |
זה שינוי אופציונלי. הגדרות ההתאמה של הכלי. קריאת API מיותרת לכלי היא קריאה שקיימת בהרצה אבל לא תואמת לאף קריאת API לכלי בציפייה האידיאלית. |
TurnLevelMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "semanticSimilarityChannel": enum ( |
| שדות | |
|---|---|
semanticSimilarityChannel |
זה שינוי אופציונלי. ערוץ הדמיון הסמנטי שבו משתמשים להערכה. |
שדה של איחוד הערך |
|
semanticSimilaritySuccessThreshold |
זה שינוי אופציונלי. סף ההצלחה של הדמיון הסמנטי. הערך חייב להיות מספר שלם בין 0 ל-4. ברירת המחדל היא >= 3. |
שדה של איחוד הערך |
|
overallToolInvocationCorrectnessThreshold |
זה שינוי אופציונלי. סף ההצלחה של הדיוק הכולל בהפעלת הכלים. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0. |
ExpectationLevelMetricsThresholds
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד הערך |
|
toolInvocationParameterCorrectnessThreshold |
זה שינוי אופציונלי. סף ההצלחה לתקינות של פרמטר קריאה לכלי ספציפי. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0. |
ToolMatchingSettings
| ייצוג ב-JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| שדות | |
|---|---|
extraToolCallBehavior |
זה שינוי אופציונלי. התנהגות של קריאות API נוספות לכלי. ברירת המחדל היא FAIL. |
VariableDeclaration
| ייצוג ב-JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| שדות | |
|---|---|
name |
חובה. שם המשתנה. השם חייב להתחיל באות או בקו תחתון, ויכול להכיל רק אותיות, מספרים או קווים תחתונים. |
description |
חובה. תיאור המשתנה. |
schema |
חובה. הסכימה של המשתנה. |
סכימה
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
חובה. סוג הנתונים. |
properties |
זה שינוי אופציונלי. מאפיינים של Type.OBJECT. אובייקט שמכיל רשימה של צמדי |
required[] |
זה שינוי אופציונלי. מאפיינים נדרשים של Type.OBJECT. |
description |
זה שינוי אופציונלי. תיאור הנתונים. |
items |
זה שינוי אופציונלי. סכימה של הרכיבים של Type.ARRAY. |
nullable |
זה שינוי אופציונלי. מציין אם הערך יכול להיות null. |
uniqueItems |
זה שינוי אופציונלי. מציין שהפריטים במערך חייבים להיות ייחודיים. רלוונטי רק ל-TYPE.ARRAY. |
prefixItems[] |
זה שינוי אופציונלי. סכמות של רכיבים ראשוניים של Type.ARRAY. |
additionalProperties |
זה שינוי אופציונלי. יכול להיות ערך בוליאני או אובייקט, שולט בנוכחות של מאפיינים נוספים. |
anyOf[] |
זה שינוי אופציונלי. צריך לאמת את הערך מול כל אחת (אחת או יותר) מתת-הסכימות ברשימה. |
enum[] |
זה שינוי אופציונלי. ערכים אפשריים של הרכיב מסוג פרימיטיבי בפורמט enum. דוגמאות: 1. אנחנו יכולים להגדיר כיוון כך : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. אנחנו יכולים להגדיר את מספר הדירה כך : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
זה שינוי אופציונלי. ערך ברירת המחדל של הנתונים. |
ref |
זה שינוי אופציונלי. מאפשר הפניות עקיפות בין צומתי סכימה. הערך צריך להיות הפניה תקינה לצאצא של הרמה הבסיסית (root) לדוגמה, הסכימה הבאה מגדירה הפניה לצומת סכימה בשם "Pet": הערך של המאפיין "pet" הוא הפניה לצומת הסכימה שנקרא "Pet". פרטים נוספים זמינים בכתובת https://json-schema.org/understanding-json-schema/structuring. |
defs |
זה שינוי אופציונלי. מפה של הגדרות לשימוש על ידי אובייקט שמכיל רשימה של צמדי |
title |
זה שינוי אופציונלי. השם של הסכימה. |
minItems |
זה שינוי אופציונלי. מספר הרכיבים המינימלי ל-Type.ARRAY. |
maxItems |
זה שינוי אופציונלי. מספר הרכיבים המקסימלי ל-Type.ARRAY. |
שדה של איחוד הערך |
|
minimum |
זה שינוי אופציונלי. ערך מינימלי ל-Type.INTEGER ול-Type.NUMBER. |
שדה של איחוד הערך |
|
maximum |
זה שינוי אופציונלי. הערך המקסימלי של Type.INTEGER ו-Type.NUMBER. |
PropertiesEntry
| ייצוג ב-JSON |
|---|
{
"key": string,
"value": {
object ( |
| שדות | |
|---|---|
key |
|
value |
|
ערך
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים: |
|
nullValue |
מייצג |
numberValue |
מייצג מספר ב-JSON. אסור להשתמש בערכים |
stringValue |
מייצג מחרוזת JSON. |
boolValue |
מייצג ערך בוליאני של JSON (ליטרל |
structValue |
מייצג אובייקט JSON. |
listValue |
מייצג מערך JSON. |
Struct
| ייצוג ב-JSON |
|---|
{ "fields": { string: value, ... } } |
| שדות | |
|---|---|
fields |
מפה לא מסודרת של ערכים שהוקלדו באופן דינמי. אובייקט שמכיל רשימה של צמדי |
FieldsEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": value } |
| שדות | |
|---|---|
key |
|
value |
|
ListValue
| ייצוג ב-JSON |
|---|
{ "values": [ value ] } |
| שדות | |
|---|---|
values[] |
שדה חוזר של ערכים שהוקלדו באופן דינמי. |
DefsEntry
| ייצוג ב-JSON |
|---|
{
"key": string,
"value": {
object ( |
| שדות | |
|---|---|
key |
|
value |
|
DataStoreSettings
| ייצוג ב-JSON |
|---|
{
"engines": [
{
object ( |
| שדות | |
|---|---|
engines[] |
פלט בלבד. המנועים של האפליקציה. |
מנוע
| ייצוג ב-JSON |
|---|
{
"name": string,
"type": enum ( |
| שדות | |
|---|---|
name |
פלט בלבד. שם המשאב של המנוע. פורמט: |
type |
פלט בלבד. סוג המנוע. |
ChannelProfile
| ייצוג ב-JSON |
|---|
{ "profileId": string, "channelType": enum ( |
| שדות | |
|---|---|
profileId |
זה שינוי אופציונלי. המזהה הייחודי של פרופיל הערוץ. |
channelType |
זה שינוי אופציונלי. סוג פרופיל הערוץ. |
personaProperty |
זה שינוי אופציונלי. המאפיין "פרסונה" בפרופיל הערוץ. |
webWidgetConfig |
זה שינוי אופציונלי. ההגדרות של הווידג'ט לאתר. |
whatsappConfig |
זה שינוי אופציונלי. הגדרה ספציפית לפריסות של וואטסאפ. |
instagramConfig |
זה שינוי אופציונלי. הגדרה ספציפית לפריסות באינסטגרם. |
שדה של איחוד הערך |
|
disableDtmf |
זה שינוי אופציונלי. אם להשבית את ה-DTMF (חיוג צלילים). |
שדה של איחוד הערך |
|
disableBargeInControl |
זה שינוי אופציונלי. אם להשבית את האפשרות של המשתמשים להתפרץ לשיחה. - true: המשתמש לא יכול לקטוע את הסוכן בזמן שהוא מדבר. - false: הסוכן שומר על שליטה אוטומטית במקרים שבהם המשתמש יכול להתפרץ. |
שדה של איחוד הערך |
|
noiseSuppressionLevel |
זה שינוי אופציונלי. רמת סינון הרעשים בפרופיל הערוץ. הערכים הזמינים הם "low", "moderate", "high", "very_high". |
PersonaProperty
| ייצוג ב-JSON |
|---|
{
"persona": enum ( |
| שדות | |
|---|---|
persona |
זה שינוי אופציונלי. הפרסונה של הערוץ. |
WebWidgetConfig
| ייצוג ב-JSON |
|---|
{ "modality": enum ( |
| שדות | |
|---|---|
modality |
זה שינוי אופציונלי. המודאליות של הווידג'ט באינטרנט. |
theme |
זה שינוי אופציונלי. העיצוב של הווידג'ט לאינטרנט. |
webWidgetTitle |
זה שינוי אופציונלי. הכותרת של הווידג'ט לאתר. |
securitySettings |
זה שינוי אופציונלי. הגדרות האבטחה של הווידג'ט לאתר. |
SecuritySettings
| ייצוג ב-JSON |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| שדות | |
|---|---|
enablePublicAccess |
זה שינוי אופציונלי. מציין אם הגישה הציבורית לווידג'ט לאתר מופעלת. אם |
enableOriginCheck |
זה שינוי אופציונלי. מציין אם בדיקת המקור של הווידג'ט לאתר מופעלת. אם הערך הוא |
allowedOrigins[] |
זה שינוי אופציונלי. המקורות שמורשים לארח את הווידג'ט לאתר. מקור מוגדר על ידי RFC 6454. אם לא מציינים ערך, כל המקורות מותרים. אפשר להוסיף עד 100 מקורות. לדוגמה: "https://example.com" |
enableRecaptcha |
זה שינוי אופציונלי. מציין אם האימות מסוג reCAPTCHA מופעל בווידג'ט לאתר. |
WhatsAppConfig
| ייצוג ב-JSON |
|---|
{ "wabaId": string, "phoneNumberId": string, "phoneNumber": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| שדות | |
|---|---|
wabaId |
חובה. מזהה החשבון ב-WhatsApp Business. |
phoneNumberId |
חובה. מזהה מספר הטלפון של Meta. |
phoneNumber |
זה שינוי אופציונלי. מספר הטלפון בפורמט E.164. |
displayName |
פלט בלבד. שם הדף העסקי ב-Meta שאוחזר. |
thumbnailUrl |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק במטא שאוחזרה. |
description |
פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא. |
InstagramConfig
| ייצוג ב-JSON |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| שדות | |
|---|---|
instagramAccountId |
חובה. מזהה החשבון באינסטגרם. |
displayName |
פלט בלבד. שם הדף העסקי ב-Meta שאוחזר. |
thumbnailUrl |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק במטא שאוחזרה. |
description |
פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא. |
MetadataEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
ClientCertificateSettings
| ייצוג ב-JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| שדות | |
|---|---|
tlsCertificate |
חובה. אישור ה-TLS מקודד בפורמט PEM. המחרוזת הזו חייבת לכלול את שורות הכותרת העליונה והכותרת התחתונה. |
privateKey |
חובה. השם של משאב גרסת הסוד של SecretManager שבו מאוחסן המפתח הפרטי, מקודד בפורמט PEM. פורמט: |
passphrase |
זה שינוי אופציונלי. השם של משאב גרסת הסוד של SecretManager שבו מאוחסן ביטוי הסיסמה לפענוח המפתח הפרטי. אם המפתח הפרטי לא מוצפן, צריך להשאיר את השדה הזה ריק. פורמט: |
VpcScSettings
| ייצוג ב-JSON |
|---|
{ "allowedOrigins": [ string ] } |
| שדות | |
|---|---|
allowedOrigins[] |
זה שינוי אופציונלי. מקורות ה-HTTP(s) המותרים שכלי OpenAPI באפליקציה יכולים לקרוא להם ישירות כש-VPC Service Controls מופעל. המחרוזות האלה חייבות להתאים בדיוק למקור, כולל היציאה אם היא צוינה. לדוגמה, "https://example.com" או "https://example.com:443". הרשימה הזו עדיין לא חלה על כלי Python שעשויים לבצע קריאות HTTP ישירות. |
DashboardSettings
| ייצוג ב-JSON |
|---|
{ "defaultDashboard": string } |
| שדות | |
|---|---|
defaultDashboard |
זה שינוי אופציונלי. שם המשאב של מרכז הבקרה שמוגדר כברירת מחדל ב-Contact Center Insights ומשויך לאפליקציה. זהו מרכז הבקרה שיוצג כשמשתמשים יעברו לתצוגת המעקב של האפליקציה. פורמט: |
סוכן
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "modelSettings": { object ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של הנציג. פורמט: |
displayName |
חובה. השם המוצג של הנציג. |
description |
זה שינוי אופציונלי. תיאור קריא לאנשים של הנציג. |
modelSettings |
זה שינוי אופציונלי. הגדרות למודל ה-LLM. |
instruction |
זה שינוי אופציונלי. הוראות למודל ה-LLM כדי להנחות את ההתנהגות של הנציג. |
tools[] |
זה שינוי אופציונלי. רשימת הכלים הזמינים לסוכן. פורמט: |
childAgents[] |
זה שינוי אופציונלי. רשימה של סוכני משנה בעץ הסוכנים. פורמט: |
beforeAgentCallbacks[] |
זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך להפעיל לפני שקוראים לנציג. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו. |
afterAgentCallbacks[] |
זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך לבצע אחרי שהסוכן נקרא. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו. |
beforeModelCallbacks[] |
זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך להפעיל לפני שקוראים למודל. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו. |
afterModelCallbacks[] |
זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך להפעיל אחרי שהמודל נקרא. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו. |
beforeToolCallbacks[] |
זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך להפעיל לפני שהכלי מופעל. אם יש כמה הפעלות של כלים, הקריאה החוזרת תבוצע כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו. |
afterToolCallbacks[] |
זה שינוי אופציונלי. הקריאות החוזרות (callbacks) שצריך להפעיל אחרי שהכלי מופעל. אם יש כמה הפעלות של כלים, הקריאה החוזרת תבוצע כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בסדר המדויק שבו הן מופיעות ברשימה. אם קריאה חוזרת מחזירה תגובה שבוטלה, הביצוע נפסק והמערכת מדלגת על כל הקריאות החוזרות שנותרו. |
createTime |
פלט בלבד. חותמת הזמן של יצירת הנציג. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של הנציג. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
guardrails[] |
זה שינוי אופציונלי. רשימת ההנחיות לסוכן. פורמט: |
etag |
Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
toolsets[] |
זה שינוי אופציונלי. רשימת ערכות הכלים של הסוכן. |
generatedSummary |
פלט בלבד. אם הנציג נוצר על ידי עוזר ה-LLM, השדה הזה מכיל סיכום תיאורי של היצירה. |
transferRules[] |
זה שינוי אופציונלי. כללי העברה של נציגים. אם יש כמה כללים תואמים, המערכת תשתמש בכלל הראשון ברשימה. |
validationErrors[] |
פלט בלבד. שגיאות או הגדרות לא נכונות בנציג שעלולות להשפיע על האיכות שלו. |
שדה של איחוד agent_type. סוג הנציג. הערך agent_type יכול להיות רק אחד מהבאים: |
|
llmAgent |
זה שינוי אופציונלי. סוג הסוכן שמוגדר כברירת מחדל. |
remoteDialogflowAgent |
זה שינוי אופציונלי. הסוכן המרוחק של Dialogflow שישמש להפעלת הסוכן. אם השדה הזה מוגדר, המערכת תתעלם מכל שאר המאפיינים ברמת הנציג. הערה: אם הנציג של Dialogflow נמצא בפרויקט אחר מהאפליקציה, צריך להעניק את התפקיד |
remoteA2aAgent |
זה שינוי אופציונלי. סוכן A2A המרוחק שבו משתמשים להפעלת הסוכן. |
RemoteDialogflowAgent
| ייצוג ב-JSON |
|---|
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean, "languageCodeVariable": string } |
| שדות | |
|---|---|
agent |
חובה. שם המשאב של הנציג ב-Dialogflow. פורמט: |
flowId |
זה שינוי אופציונלי. מזהה התהליך של התהליך בנציג Dialogflow. |
environmentId |
זה שינוי אופציונלי. מזהה הסביבה של הנציג ב-Dialogflow שמשמש להפעלת הנציג. אם לא מציינים סביבה, המערכת משתמשת בסביבת הטיוטה. |
inputVariableMapping |
זה שינוי אופציונלי. המיפוי של שמות המשתנים של האפליקציה לשמות הפרמטרים של הסשן ב-Dialogflow, שיישלחו לסוכן Dialogflow כקלט. אובייקט שמכיל רשימה של צמדי |
outputVariableMapping |
זה שינוי אופציונלי. מיפוי השמות של הפרמטרים של הסשן ב-Dialogflow לשמות של המשתנים באפליקציה שיישלחו בחזרה לנציג CES אחרי שהנציג ב-Dialogflow יסיים את הפעולה. אובייקט שמכיל רשימה של צמדי |
respectResponseInterruptionSettings |
זה שינוי אופציונלי. מציין אם לכבד את ההגדרות של ההפרעות ברמת ההודעה שהוגדרו בנציג Dialogflow.
|
languageCodeVariable |
זה שינוי אופציונלי. שם המשתנה שמכיל את קוד השפה שבו צריך להשתמש בסשן של Dialogflow. אם לא מציינים קוד שפה, המערכת משתמשת בקוד השפה שמוגדר כברירת מחדל לנציג Dialogflow. |
InputVariableMappingEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
RemoteA2aAgent
| ייצוג ב-JSON |
|---|
{
"a2aConfig": {
object ( |
| שדות | |
|---|---|
a2aConfig |
חובה. הגדרת החיבור של A2A. |
RemoteA2aConfig
| ייצוג ב-JSON |
|---|
{ "apiAuthentication": { object ( |
| שדות | |
|---|---|
apiAuthentication |
זה שינוי אופציונלי. הגדרת האימות לקריאה לסוכן המרוחק. אופציונלי אם ההפניה למרשם כבר מטפלת באימות. |
inputVariableMapping |
זה שינוי אופציונלי. מיפוי של שמות משתני הקלט של הסוכן המרוחק לשמות המשתנים של GECX. אובייקט שמכיל רשימה של צמדי |
outputVariableMapping |
זה שינוי אופציונלי. מיפוי של שמות המשתנים של הפלט של הנציג המרוחק לשמות המשתנים של GECX. אובייקט שמכיל רשימה של צמדי |
streamingEnabled |
זה שינוי אופציונלי. האם הסטרימינג מופעל לסוכן המרוחק. |
contextId |
זה שינוי אופציונלי. אם השדה לא ריק, האינטראקציות עם סוכן ה-A2A המרוחק ישתמשו במזהה ההקשר הזה. השדה context_id יכול להתייחס למשתנה של סשן כמו |
שדה של איחוד agent_spec. מפרט הסוכן המרוחק. הערך agent_spec יכול להיות רק אחד מהבאים: |
|
agentCard |
זה שינוי אופציונלי. כרטיס הסוכן המלא שמוגדר בתוך השורה. |
agentRegistry |
זה שינוי אופציונלי. הפניה לסוכן ב-Agent Registry. פורמט: |
AgentCard
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "supportedInterfaces": [ { object ( |
| שדות | |
|---|---|
name |
חובה. שם של הנציג שקריא לאנשים. |
description |
חובה. תיאור של תחום הפעולה או מרחב הפתרונות של הסוכן. |
supportedInterfaces[] |
חובה. רשימה מסודרת של ממשקים נתמכים. הרשומה הראשונה היא המועדפת. |
version |
חובה. גרסת הנציג. |
skills[] |
חובה. מיומנויות מייצגות יחידת יכולת שסוכן יכול לבצע. זה אולי נשמע קצת מופשט, אבל זה מייצג קבוצה ממוקדת יותר של פעולות שהסוכן יכול לבצע בהצלחה. |
AgentInterface
| ייצוג ב-JSON |
|---|
{ "url": string, "protocolBinding": string, "tenant": string, "protocolVersion": string } |
| שדות | |
|---|---|
url |
חובה. כתובת ה-URL שבה הממשק הזה זמין. זו צריכה להיות כתובת URL מוחלטת ותקינה מסוג HTTPS בסביבת הייצור. דוגמה: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" |
protocolBinding |
חובה. הקישור לפרוטוקול שנתמך בכתובת ה-URL הזו. זו מחרוזת בצורה פתוחה, שאפשר להרחיב בקלות לקישורי פרוטוקולים אחרים. הסכימות העיקריות שנתמכות באופן רשמי הן |
tenant |
מזהה הדייר שצריך להשתמש בו בבקשה כשמתקשרים לסוכן. |
protocolVersion |
חובה. גרסת פרוטוקול A2A שהממשק הזה חושף. להשתמש בגרסה המשנית העדכנית ביותר שנתמכת בכל גרסה ראשית. דוגמאות: "0.3", "1.0" |
AgentSkill
| ייצוג ב-JSON |
|---|
{ "id": string, "name": string, "description": string, "tags": [ string ], "examples": [ string ], "inputModes": [ string ], "outputModes": [ string ] } |
| שדות | |
|---|---|
id |
חובה. מזהה ייחודי של המיומנות של הנציג. |
name |
חובה. שם המיומנות, בפורמט שקריא לאנשים. |
description |
חובה. תיאור מפורט של המיומנות. |
tags[] |
חובה. קבוצה של מילות מפתח שמתארות את היכולות של המיומנות. |
examples[] |
הנחיות או תרחישים לדוגמה שהמיומנות הזו יכולה לטפל בהם. |
inputModes[] |
קבוצת סוגי המדיה הנתמכים לקלט במיומנות הזו, שמחליפה את ברירות המחדל של הנציג. |
outputModes[] |
קבוצת סוגי המדיה הנתמכים לפלט של המיומנות הזו, שמחליפה את ברירות המחדל של הנציג. |
ApiAuthentication
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים: |
|
apiKeyConfig |
זה שינוי אופציונלי. הגדרות לאימות באמצעות מפתח API. |
oauthConfig |
זה שינוי אופציונלי. הגדרת OAuth. |
serviceAgentIdTokenAuthConfig |
זה שינוי אופציונלי. הגדרות לאימות של טוקן של מזהה שנוצר מסוכן השירות של CES. |
serviceAccountAuthConfig |
זה שינוי אופציונלי. הגדרות לאימות של חשבון שירות. |
bearerTokenConfig |
זה שינוי אופציונלי. הגדרה לאימות של טוקן למוכ"ז. |
ApiKeyConfig
| ייצוג ב-JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| שדות | |
|---|---|
keyName |
חובה. שם הפרמטר או שם הכותרת של מפתח ה-API. למשל, אם בקשת ה-API היא "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן מפתח ה-API. פורמט: הערה: צריך להקצות את התפקיד |
requestLocation |
חובה. מיקום המפתח בבקשה. |
OAuthConfig
| ייצוג ב-JSON |
|---|
{
"oauthGrantType": enum ( |
| שדות | |
|---|---|
oauthGrantType |
חובה. סוגי הרשאות OAuth. |
clientId |
חובה. מזהה הלקוח מספק ה-OAuth. |
clientSecretVersion |
חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן סוד הלקוח. פורמט: הערה: צריך להקצות את התפקיד |
tokenEndpoint |
חובה. נקודת הקצה של הטוקן בספק ה-OAuth שמוחלפת בטוקן גישה. |
scopes[] |
זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק. |
ServiceAccountAuthConfig
| ייצוג ב-JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| שדות | |
|---|---|
serviceAccount |
חובה. כתובת האימייל של חשבון השירות שמשמש לאימות. CES משתמש בחשבון השירות הזה כדי להחליף טוקן גישה, ואז טוקן הגישה נשלח בכותרת לחשבון השירות צריך להיות התפקיד |
scopes[] |
זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק. אם לא מציינים היקף, המערכת משתמשת בהיקף ברירת המחדל |
BearerTokenConfig
| ייצוג ב-JSON |
|---|
{ "token": string } |
| שדות | |
|---|---|
token |
חובה. הטוקן למוכ"ז. חייב להיות בפורמט |
InputVariableMappingEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
התקשרות חזרה
| ייצוג ב-JSON |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| שדות | |
|---|---|
description |
זה שינוי אופציונלי. תיאור קריא לאנשים של הקריאה החוזרת. |
disabled |
זה שינוי אופציונלי. אם הקריאה החוזרת מושבתת. הסוכן מתעלם מהקריאות החוזרות המושבתות. |
proactiveExecutionEnabled |
זה שינוי אופציונלי. אם היא מופעלת, פונקציית ה-callback תופעל גם על פלטים של מודלים ביניים. ההגדרה הזו משפיעה רק על קריאה חוזרת (callback) אחרי המודל. צריך להפעיל בזהירות. בדרך כלל, צריך להפעיל את הקריאה החוזרת (callback) של המודל רק אחרי שמקבלים את כל התשובות מהמודל. הפעלה של ביצוע פרואקטיבי עלולה להשפיע לרעה על עלות הביצוע ועל זמן האחזור, וצריך להפעיל אותה רק במצבים נדירים. |
שדה של איחוד callback. הקריאה החוזרת (callback) לביצוע. הערך callback יכול להיות רק אחד מהבאים: |
|
pythonCode |
חובה. קוד ה-Python שצריך להריץ בשביל הקריאה החוזרת (callback). |
AgentToolset
| ייצוג ב-JSON |
|---|
{ "toolset": string, "toolIds": [ string ] } |
| שדות | |
|---|---|
toolset |
חובה. שם המשאב של ערכת הכלים. פורמט: |
toolIds[] |
זה שינוי אופציונלי. מזהי הכלים לסינון ערכת הכלים. |
TransferRule
| ייצוג ב-JSON |
|---|
{ "childAgent": string, "direction": enum ( |
| שדות | |
|---|---|
childAgent |
חובה. שם המשאב של הנציג הצאצא שהכלל חל עליו. פורמט: |
direction |
חובה. כיוון ההעברה. |
שדה של איחוד rule_type. סוג הכלל. הערך rule_type יכול להיות רק אחד מהבאים: |
|
deterministicTransfer |
זה שינוי אופציונלי. כלל שמעביר את השיחה באופן מיידי לנציג היעד כשהתנאי מתקיים. |
disablePlannerTransfer |
זה שינוי אופציונלי. כלל שמונע מהמתכנן להעביר את השיחה לסוכן היעד. |
DeterministicTransfer
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד condition_type. התנאי לבדיקה. הערך condition_type יכול להיות רק אחד מהבאים: |
|
expressionCondition |
זה שינוי אופציונלי. כלל שמעריך תנאי של מצב סשן. אם התנאי מקבל את הערך True, ההעברה מתבצעת. |
pythonCodeCondition |
זה שינוי אופציונלי. כלל שמשתמש בבלוק קוד של Python כדי להעריך את התנאים. אם התנאי מקבל את הערך True, ההעברה מתבצעת. |
ExpressionCondition
| ייצוג ב-JSON |
|---|
{ "expression": string } |
| שדות | |
|---|---|
expression |
חובה. ייצוג המחרוזת של התנאי cloud.api.Expression. |
PythonCodeCondition
| ייצוג ב-JSON |
|---|
{ "pythonCode": string } |
| שדות | |
|---|---|
pythonCode |
חובה. קוד Python להרצה. |
DisablePlannerTransfer
| ייצוג ב-JSON |
|---|
{
"expressionCondition": {
object ( |
| שדות | |
|---|---|
expressionCondition |
חובה. אם התנאי מקבל את הערך True, למתכנן לא תהיה אפשרות להעביר את הנתונים לסוכן היעד. |
כלי
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| שדות | |
|---|---|
name |
מזהה. שם המשאב של הכלי. פורמט:
הכלים האלה דינמיים ומיועדים לפלט בלבד. אי אפשר להפנות אליהם ישירות במקום שבו מצופה כלי. |
displayName |
פלט בלבד. השם המוצג של הכלי, שנגזר מסוג הכלי. לדוגמה, השם המוצג של [ClientFunction][Tool.ClientFunction] נגזר מהמאפיין |
executionType |
זה שינוי אופציונלי. סוג ההפעלה של הכלי. |
timeout |
זה שינוי אופציונלי. הזמן הקצוב לתפוגה של הרצת הכלי. אם לא מגדירים את המדיניות, זמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 30 שניות לכלים של משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
createTime |
פלט בלבד. חותמת הזמן של יצירת הכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של הכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
etag |
Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
generatedSummary |
פלט בלבד. אם הכלי נוצר על ידי העוזר הדיגיטלי שמבוסס על LLM, השדה הזה מכיל סיכום תיאורי של היצירה. |
toolFakeConfig |
זה שינוי אופציונלי. הגדרת אופן הפעולה של הכלי במצב מדומה. |
readOnly |
פלט בלבד. מציין אם הכלי הוא לקריאה בלבד. אם הערך הוא True, המשתמש לא יכול לשנות את הכלי. |
שדה של איחוד tool_type. סוג הכלי. הערך tool_type יכול להיות רק אחד מהבאים: |
|
clientFunction |
זה שינוי אופציונלי. פונקציית הלקוח. |
openApiTool |
זה שינוי אופציונלי. כלי ה-API הפתוח. |
googleSearchTool |
זה שינוי אופציונלי. כלי חיפוש Google. |
connectorTool |
זה שינוי אופציונלי. הכלי Integration Connector. |
dataStoreTool |
זה שינוי אופציונלי. הכלי של מאגר הנתונים. |
pythonFunction |
זה שינוי אופציונלי. כלי הפונקציות של Python. |
mcpTool |
זה שינוי אופציונלי. כלי ה-MCP. אי אפשר ליצור או לעדכן כלי MCP באופן ישיר, והוא מנוהל על ידי ערכת הכלים של MCP. |
fileSearchTool |
זה שינוי אופציונלי. כלי החיפוש בקבצים. |
systemTool |
זה שינוי אופציונלי. כלי המערכת. |
agentTool |
זה שינוי אופציונלי. כלי הסוכן. |
widgetTool |
זה שינוי אופציונלי. כלי הווידג'ט. |
remoteAgentTool |
זה שינוי אופציונלי. כלי הסוכן המרוחק. |
ClientFunction
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| שדות | |
|---|---|
name |
חובה. שם הפונקציה. |
description |
זה שינוי אופציונלי. תיאור הפונקציה. |
parameters |
זה שינוי אופציונלי. הסכימה של הפרמטרים של הפונקציה. |
response |
זה שינוי אופציונלי. הסכימה של תגובת הפונקציה. |
OpenApiTool
| ייצוג ב-JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| שדות | |
|---|---|
openApiSchema |
חובה. סכימת OpenAPI בפורמט JSON או YAML. |
name |
זה שינוי אופציונלי. שם הכלי. אם לא תציינו שם, שם הכלי ייגזר מסכימת OpenAPI, מ- |
description |
זה שינוי אופציונלי. תיאור הכלי. אם לא תספקו תיאור, הוא יופק מהסכימה של OpenAPI, מ- |
apiAuthentication |
זה שינוי אופציונלי. פרטי האימות שנדרשים על ידי ה-API. |
tlsConfig |
זה שינוי אופציונלי. הגדרת ה-TLS. כולל את אישורי השרת בהתאמה אישית שהלקוח יסמוך עליהם. |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרת Service Directory. |
ignoreUnknownFields |
זה שינוי אופציונלי. אם הערך הוא True, הנציג יתעלם משדות לא מוכרים בתגובה מה-API. |
url |
זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת ה-Open API. השדה הזה מוגדר רק בכלים ביחסי התלות של הסביבה במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו קיימת ביחסי התלות של הסביבה ובסכימה יש את ה-placeholder $env_var, היא תחליף את ה-placeholder בסכימה. |
TlsConfig
| ייצוג ב-JSON |
|---|
{
"caCerts": [
{
object ( |
| שדות | |
|---|---|
caCerts[] |
חובה. מציינת רשימה של אישורי CA מותאמים אישית שמותרים לאימות HTTPS. |
CaCert
| ייצוג ב-JSON |
|---|
{ "displayName": string, "cert": string } |
| שדות | |
|---|---|
displayName |
חובה. השם של אישורי ה-CA המותאמים אישית שמותרים. אפשר להשתמש בזה כדי להבחין בין אישורי ה-CA המותאמים אישית. |
cert |
חובה. אישורי ה-CA המותרים בהתאמה אישית (בפורמט DER) לאימות HTTPS. ההגדרה הזו מבטלת את מאגר האישורים של SSL שמוגדר כברירת מחדל. אם השדה הזה ריק או לא צוין, CES ישתמש במאגר האישורים שמוגדר כברירת מחדל ב-Google כדי לאמת אישורים. הערה: חשוב לוודא שאישורי השרת של HTTPS חתומים באמצעות "שם חלופי לנושא". לדוגמה, אפשר לחתום על תעודה בחתימה עצמית באמצעות הפקודה הבאה: מחרוזת בקידוד Base64. |
ServiceDirectoryConfig
| ייצוג ב-JSON |
|---|
{ "service": string } |
| שדות | |
|---|---|
service |
חובה. השם של שירות Service Directory. פורמט: |
GoogleSearchTool
| ייצוג ב-JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| שדות | |
|---|---|
name |
חובה. שם הכלי. |
description |
זה שינוי אופציונלי. תיאור המטרה של הכלי. |
contextUrls[] |
זה שינוי אופציונלי. התוכן יישלף ישירות מכתובות ה-URL האלה לצורך הקשר וביסוס. דוגמה: "https://example.com/path.html". אפשר להוסיף עד 20 כתובות URL. |
preferredDomains[] |
זה שינוי אופציונלי. מציינת את הדומיינים שתוצאות החיפוש יוגבלו אליהם. לדוגמה: "example.com", "another.site". אפשר לציין עד 20 דומיינים. |
excludeDomains[] |
זה שינוי אופציונלי. רשימת דומיינים שיוחרגו מתוצאות החיפוש. לדוגמה: "example.com". אפשר להחריג עד 2,000 דומיינים. |
promptConfig |
זה שינוי אופציונלי. הוראות לפרומפט שמועברות למתכנן לגבי האופן שבו צריך לעבד את תוצאות החיפוש לטקסט ולקול. |
PromptConfig
| ייצוג ב-JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| שדות | |
|---|---|
textPrompt |
זה שינוי אופציונלי. הגדרת ההנחיה שמשמשת להוראות המערכת כשמקיימים אינטראקציה עם הנציג בשיחות צ'אט. אם לא מגדירים את המדיניות, המערכת תשתמש בהנחיה שמוגדרת כברירת מחדל. |
voicePrompt |
זה שינוי אופציונלי. הגדרת ההנחיה שמשמשת להוראות המערכת כשמקיימים אינטראקציה עם הסוכן בשיחות קוליות. אם לא מגדירים את המדיניות, המערכת תשתמש בהנחיה שמוגדרת כברירת מחדל. |
ConnectorTool
| ייצוג ב-JSON |
|---|
{ "connection": string, "action": { object ( |
| שדות | |
|---|---|
connection |
חובה. השם המלא של המשאב של החיבור המקושר ב-Integration Connectors. פורמט: |
action |
חובה. הפעולה שהכלי צריך לבצע. |
authConfig |
זה שינוי אופציונלי. ההגדרה קובעת איך מתבצע האימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות API של Integration Connectors. אפשר לשנות אותה באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל בחיבור את האפשרות לעקוף את האימות. אחרת, יצירת ה-ConnectorTool תיכשל. פרטים נוספים זמינים בכתובת https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override. |
name |
זה שינוי אופציונלי. שם הכלי שבו הסוכן יכול להשתמש כדי להחליט אם להפעיל את ConnectorTool. |
description |
זה שינוי אופציונלי. תיאור הכלי שבו הנציג יכול להשתמש כדי להחליט אם להפעיל את ConnectorTool. |
פעולה
| ייצוג ב-JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| שדות | |
|---|---|
inputFields[] |
זה שינוי אופציונלי. שדות של ישויות שמשמשים כקלט לפעולה. אם לא מציינים שדות, המערכת משתמשת בכל השדות של הישות. |
outputFields[] |
זה שינוי אופציונלי. שדות הישות שיוחזרו מהפעולה. אם לא מציינים שדות, כל השדות של הישות יוחזרו. |
שדה של איחוד action_spec. מפרט של פעולה שצריך להגדיר כדי שהכלי ישתמש בה. הערך action_spec יכול להיות רק אחד מהבאים: |
|
connectionActionId |
מזהה של פעולת חיבור שהכלי ישתמש בה. |
entityOperation |
הגדרת פעולת הישות שהכלי ישתמש בה. |
EntityOperation
| ייצוג ב-JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| שדות | |
|---|---|
entityId |
חובה. מזהה הישות. |
operation |
חובה. הפעולה שרוצים לבצע בישות. |
EndUserAuthConfig
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים: |
|
oauth2AuthCodeConfig |
אימות באמצעות קוד הרשאה של OAuth 2.0. |
oauth2JwtBearerConfig |
אימות מסוג JWT Profile Oauth 2.0 Authorization Grant. |
Oauth2AuthCodeConfig
| ייצוג ב-JSON |
|---|
{ "oauthToken": string } |
| שדות | |
|---|---|
oauthToken |
חובה. שם הפרמטר של אסימון OAuth שצריך להעביר. חייב להיות בפורמט |
Oauth2JwtBearerConfig
| ייצוג ב-JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| שדות | |
|---|---|
issuer |
חובה. שם הפרמטר של המנפיק שצריך להעביר. חייב להיות בפורמט |
subject |
חובה. שם הפרמטר של הנושא שצריך להעביר. חייב להיות בפורמט |
clientKey |
חובה. שם הפרמטר של הלקוח שרוצים להעביר. חייב להיות בפורמט |
DataStoreTool
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| שדות | |
|---|---|
name |
חובה. שם הכלי של מאגר הנתונים. |
description |
זה שינוי אופציונלי. תיאור הכלי. |
boostSpecs[] |
זה שינוי אופציונלי. מפרט לחיזוק מסמכים מסוימים. |
modalityConfigs[] |
זה שינוי אופציונלי. הגדרות המודאליות של מאגר הנתונים. |
filterParameterBehavior |
זה שינוי אופציונלי. ההתנהגות של פרמטר הסינון. |
שדה של איחוד search_source. מגדיר את מקור החיפוש, מאגר נתונים יחיד או מנוע. הערך search_source יכול להיות רק אחד מהבאים: |
|
dataStoreSource |
זה שינוי אופציונלי. חיפוש בתוך מאגר נתונים ספציפי אחד. |
engineSource |
זה שינוי אופציונלי. חיפוש בתוך מנוע (יכול להיות בכמה מאגרי נתונים). |
DataStoreSource
| ייצוג ב-JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| שדות | |
|---|---|
filter |
זה שינוי אופציונלי. מפרט המסנן של מאגר הנתונים. מידע נוסף זמין בכתובת: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
זה שינוי אופציונלי. מאגר הנתונים. |
DataStore
| ייצוג ב-JSON |
|---|
{ "name": string, "type": enum ( |
| שדות | |
|---|---|
name |
חובה. השם המלא של המשאב ב-DataStore. פורמט: |
type |
פלט בלבד. סוג מאגר הנתונים. השדה הזה הוא לקריאה בלבד ומאוכלס על ידי השרת. |
documentProcessingMode |
פלט בלבד. מצב עיבוד המסמכים של החיבור למאגר הנתונים. מוגדר רק למאגרי נתונים מסוג PUBLIC_WEB ו-UNSTRUCTURED. |
displayName |
פלט בלבד. השם המוצג של מאגר הנתונים. |
createTime |
פלט בלבד. חותמת הזמן של מועד יצירת מאגר הנתונים. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
connectorConfig |
פלט בלבד. הגדרת המחבר לחיבור של מאגר הנתונים. |
ConnectorConfig
| ייצוג ב-JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| שדות | |
|---|---|
collection |
שם המשאב של האוסף שאליו שייך מאגר הנתונים. |
collectionDisplayName |
השם המוצג של האוסף שאליו שייך מאגר הנתונים. |
dataSource |
השם של מקור הנתונים. לדוגמה: |
EngineSource
| ייצוג ב-JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| שדות | |
|---|---|
engine |
חובה. השם המלא של משאב המנוע. פורמט: |
dataStoreSources[] |
זה שינוי אופציונלי. משמש לטירגוט מאגרי נתונים ספציפיים בתוך המנוע. אם השדה ריק, החיפוש יחול על כל מאגרי הנתונים שמשויכים למנוע. |
filter |
זה שינוי אופציונלי. מסנן שמופעל על החיפוש במנוע. לא רלוונטי ולא בשימוש אם צוין "data_store_sources". מידע נוסף זמין בכתובת: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
BoostSpecs
| ייצוג ב-JSON |
|---|
{
"dataStores": [
string
],
"spec": [
{
object ( |
| שדות | |
|---|---|
dataStores[] |
חובה. מאגר הנתונים שבו מוגדרת הגברת החשיבות. שם המשאב המלא של DataStore, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
חובה. רשימה של מפרטי חיזוק. |
BoostSpec
| ייצוג ב-JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| שדות | |
|---|---|
conditionBoostSpecs[] |
חובה. רשימה של מפרטי חיזוק. |
ConditionBoostSpec
| ייצוג ב-JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| שדות | |
|---|---|
condition |
חובה. ביטוי שמציין תנאי לחיזוק. התחביר זהה לתחביר של ביטוי סינון. נכון לעכשיו, התנאי היחיד שנתמך הוא רשימה של קודי שפה מסוג BCP-47. דוגמה: כדי להגביר את ההצעות בשפות en או fr: (lang_code: ANY("en", "fr")) |
boost |
זה שינוי אופציונלי. עוצמת החיזוק, שצריכה להיות בטווח של [-1, 1]. חיזוק שלילי פירושו הורדה בדירוג. ברירת המחדל היא 0.0. הגדרה של 1.0 מקדמת את ההצעות באופן משמעותי. עם זאת, זה לא בהכרח אומר שהתוצאה הראשונה תהיה הצעה שקודמה. הגדרה לערך -1.0 תוריד את ההצעות בדרגה באופן משמעותי. עם זאת, יכול להיות שעדיין יוצגו הצעות רלוונטיות אחרות. הגדרה של 0.0 פירושה שלא הוחל חיזוק. המערכת מתעלמת מתנאי ההגברה. |
boostControlSpec |
זה שינוי אופציונלי. מפרט מורכב לדירוג מותאם אישית על סמך ערך מאפיין שהלקוח הגדיר. |
BoostControlSpec
| ייצוג ב-JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| שדות | |
|---|---|
fieldName |
זה שינוי אופציונלי. שם השדה שהערך שלו ישמש לקביעת סכום ההגדלה. |
attributeType |
זה שינוי אופציונלי. סוג המאפיין שמשמש לקביעת סכום ההגדלה. ערך המאפיין יכול להגיע מערך השדה של ה-field_name שצוין. במקרה של ערך מספרי, זה פשוט: attribute_value = numerical_field_value. אבל במקרה של עדכניות, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
זה שינוי אופציונלי. סוג האינטרפולציה שצריך להחיל כדי לחבר את נקודות הבקרה שמפורטות בהמשך. |
controlPoints[] |
זה שינוי אופציונלי. נקודות הבקרה שמשמשות להגדרת העקומה. הפונקציה המונוטונית (שמוגדרת באמצעות interpolation_type שלמעלה) עוברת דרך נקודות הבקרה שמפורטות כאן. |
ControlPoint
| ייצוג ב-JSON |
|---|
{ "attributeValue": string, "boostAmount": number } |
| שדות | |
|---|---|
attributeValue |
זה שינוי אופציונלי. יכול להיות אחד מהבאים: 1. הערך המספרי של השדה. 2. מפרט משך הזמן של העדכניות: הערך חייב להיות בפורמט של ערך XSD |
boostAmount |
זה שינוי אופציונלי. הערך בין -1 ל-1 שבו הציון יוגדל אם הערך של attribute_value יתאים לערך שצוין למעלה. |
ModalityConfig
| ייצוג ב-JSON |
|---|
{ "modalityType": enum ( |
| שדות | |
|---|---|
modalityType |
חובה. סוג המודאליות. |
rewriterConfig |
זה שינוי אופציונלי. הגדרות הכתיבה מחדש. |
summarizationConfig |
זה שינוי אופציונלי. הגדרת הסיכום. |
groundingConfig |
זה שינוי אופציונלי. הגדרת ה-grounding. |
snippetsConfig |
זה שינוי אופציונלי. הגדרת קטעי הקוד. |
RewriterConfig
| ייצוג ב-JSON |
|---|
{
"modelSettings": {
object ( |
| שדות | |
|---|---|
modelSettings |
חובה. הגדרות למודל ה-LLM. |
prompt |
זה שינוי אופציונלי. הגדרת ההנחיה. אם לא מגדירים את המדיניות, המערכת תשתמש בהנחיה שמוגדרת כברירת מחדל. |
disabled |
זה שינוי אופציונלי. אם הכלי לשכתוב מושבת. |
SummarizationConfig
| ייצוג ב-JSON |
|---|
{
"modelSettings": {
object ( |
| שדות | |
|---|---|
modelSettings |
זה שינוי אופציונלי. הגדרות למודל ה-LLM. |
prompt |
זה שינוי אופציונלי. הגדרת ההנחיה. אם לא מגדירים את המדיניות, המערכת תשתמש בהנחיה שמוגדרת כברירת מחדל. |
disabled |
זה שינוי אופציונלי. אם הסיכום מושבת. |
GroundingConfig
| ייצוג ב-JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| שדות | |
|---|---|
groundingLevel |
זה שינוי אופציונלי. סף הביסוס של התשובה על סמך המקורות שאוחזרו. אפשר להגדיר ערך בטווח [1, 5]. הרמה משמשת כסף לביסוס התשובה, כלומר כל התשובות עם ציון ביסוס מתחת לסף יחזרו להחזרת קטעים רלוונטיים בלבד. לדוגמה, אם הרמה היא 3, הציון של מידת הביסוס צריך להיות 3 ומעלה כדי שהתשובה תוחזר. |
disabled |
זה שינוי אופציונלי. אם הגראונדינג מושבת. |
SnippetsConfig
| ייצוג ב-JSON |
|---|
{ "enableSnippets": boolean, "maxSnippets": integer } |
| שדות | |
|---|---|
enableSnippets |
זה שינוי אופציונלי. אם התקצירים מופעלים. |
maxSnippets |
זה שינוי אופציונלי. מספר קטעי הקוד שיוחזרו לכל שאילתה. אם לא מגדירים את הפרמטר, כברירת מחדל מוחזרים כל קטעי הקוד מהשירות. |
PythonFunction
| ייצוג ב-JSON |
|---|
{
"name": string,
"pythonCode": string,
"description": string,
"serviceDirectoryConfig": {
object ( |
| שדות | |
|---|---|
name |
זה שינוי אופציונלי. שם הפונקציה ב-Python שרוצים להפעיל. השם חייב להיות זהה לשם של פונקציית Python שמוגדרת בקוד Python. תלוי אותיות רישיות. אם לא תציינו שם, המערכת תשתמש בפונקציה הראשונה שמוגדרת בקוד Python. |
pythonCode |
זה שינוי אופציונלי. קוד Python להרצה בכלי. |
description |
פלט בלבד. תיאור הפונקציה ב-Python, שנותח מתוך ה-docstring של קוד ה-Python. |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרת Service Directory לכלי. |
McpTool
| ייצוג ב-JSON |
|---|
{ "name": string, "nameOverride": string, "description": string, "inputSchema": { object ( |
| שדות | |
|---|---|
name |
חובה. השם של כלי ה-MCP. |
nameOverride |
זה שינוי אופציונלי. שינוי השם של כלי ה-MCP. השדה הזה מאוכלס אם השם הוחלף על ידי שינוי של Toolset. |
description |
זה שינוי אופציונלי. תיאור כלי ה-MCP. |
inputSchema |
זה שינוי אופציונלי. הסכימה של הארגומנטים של הקלט של כלי ה-MCP. |
outputSchema |
זה שינוי אופציונלי. הסכימה של הארגומנטים של הפלט של כלי ה-MCP. |
serverAddress |
חובה. כתובת השרת של שרת ה-MCP, לדוגמה, "https://example.com/mcp/". אם השרת נוצר באמצעות MCP SDK, כתובת ה-URL צריכה להסתיים ב-"/mcp/". יש תמיכה רק בשרתים שמבוססים על העברת Streamable HTTP. הכתובת הזו זהה ל-server_address ב-McpToolset. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http. |
apiAuthentication |
זה שינוי אופציונלי. פרטי האימות שנדרשים כדי להפעיל את הכלי בשרת ה-MCP. באימות באמצעות טוקן למוכ"ז, הטוקן חל רק על הפעלת הכלי, ולא על הצגת הכלים. לשם כך, צריך לאפשר הצגה של כלים בלי אימות. |
tlsConfig |
זה שינוי אופציונלי. הגדרת ה-TLS. כוללת את אישורי השרת בהתאמה אישית שהלקוח צריך לסמוך עליהם. |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות של שירותים בתוך היקף. |
customHeaders |
זה שינוי אופציונלי. הכותרות בהתאמה אישית שיישלחו בבקשה לשרת ה-MCP. הערכים חייבים להיות בפורמט אובייקט שמכיל רשימה של צמדי |
state |
פלט בלבד. מצב הזמינות הדינמי של הכלי בשרת החיצוני. |
CustomHeadersEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
FileSearchTool
| ייצוג ב-JSON |
|---|
{
"corpusType": enum ( |
| שדות | |
|---|---|
corpusType |
זה שינוי אופציונלי. סוג הקורפוס. ברירת המחדל היא FULLY_MANAGED. |
name |
חובה. שם הכלי. |
description |
זה שינוי אופציונלי. תיאור הכלי. |
fileCorpus |
זה שינוי אופציונלי. המאגר שבו הקבצים מאוחסנים. פורמט: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
SystemTool
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string } |
| שדות | |
|---|---|
name |
חובה. שם כלי המערכת. |
description |
פלט בלבד. תיאור כלי המערכת. |
AgentTool
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "agent": string } |
| שדות | |
|---|---|
name |
חובה. שם הכלי של הסוכן. |
description |
זה שינוי אופציונלי. תיאור המטרה של הכלי. |
agent |
זה שינוי אופציונלי. שם המשאב של הנציג שהוא נקודת הכניסה של הכלי. פורמט: |
WidgetTool
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| שדות | |
|---|---|
name |
חובה. השם המוצג של הווידג'ט. |
description |
זה שינוי אופציונלי. תיאור הווידג'ט. |
widgetType |
זה שינוי אופציונלי. סוג הווידג'ט. אם לא מציינים סוג, סוג ברירת המחדל יהיה CUSTOMIZED. |
uiConfig |
זה שינוי אופציונלי. הגדרות לרינדור הווידג'ט. |
dataMapping |
זה שינוי אופציונלי. המיפוי שמגדיר איך הנתונים מכלי המקור ממופים לפרמטרים של הקלט של הווידג'ט. |
textResponseConfig |
זה שינוי אופציונלי. הגדרת תשובות טקסט שתמיד נכללות. |
שדה של איחוד input. הקלט של כלי הווידג'ט. הערך input יכול להיות רק אחד מהבאים: |
|
parameters |
זה שינוי אופציונלי. הפרמטרים של הקלט של כלי הווידג'ט. |
DataMapping
| ייצוג ב-JSON |
|---|
{ "sourceToolName": string, "fieldMappings": { string: string, ... }, "pythonFunction": { object ( |
| שדות | |
|---|---|
sourceToolName |
זה שינוי אופציונלי. שם המשאב של הכלי שמספק את הנתונים לווידג'ט (למשל, כלי חיפוש או פונקציה בהתאמה אישית). פורמט: |
fieldMappings |
זה שינוי אופציונלי. מפה של שדות הפרמטרים של הקלט של הווידג'ט לשדות הפלט התואמים של כלי המקור. אובייקט שמכיל רשימה של צמדי |
pythonFunction |
זה שינוי אופציונלי. הגדרת פונקציית Python שמשמשת להמרת הפלט של כלי המקור לפורמט הקלט של הווידג'ט. |
mode |
זה שינוי אופציונלי. המצב של מיפוי הנתונים. |
pythonScript |
הוצא משימוש: צריך להשתמש ב- |
FieldMappingsEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
TextResponseConfig
| ייצוג ב-JSON |
|---|
{
"type": enum ( |
| שדות | |
|---|---|
type |
זה שינוי אופציונלי. האסטרטגיה למתן תשובת הטקסט. |
staticText |
זה שינוי אופציונלי. תשובת הטקסט הסטטי שתוחזר כשהסוג הוא STATIC. |
textResponseInstruction |
זה שינוי אופציונלי. הוראה למודל השפה הגדול (LLM) לגבי אופן היצירה של תשובת הטקסט. משמש כתיאור של הפרמטר של תגובת הטקסט אם הסוג הוא LLM_GENERATED. |
RemoteAgentTool
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "agentCard": { object ( |
| שדות | |
|---|---|
name |
חובה. שם הכלי. |
description |
חובה. תיאור הכלי. |
agentCard |
חובה. כרטיס הסוכן של הסוכן המרוחק שהכלי הזה מפעיל. |
apiAuthentication |
זה שינוי אופציונלי. הגדרת האימות לקריאה לסוכן המרוחק. |
statefulAgent |
זה שינוי אופציונלי. כשההגדרה הזו מופעלת, האינטראקציה בין אפליקציית CXAS לבין הנציג המרוחק תשתף את אותו הקשר. אם הסוכן המרוחק מחזיר context_id, הוא יישמר לכל משך הסשן של כלי הסוכן המרוחק הזה. |
inputVariableMapping |
זה שינוי אופציונלי. מיפוי של שמות משתני הקלט של הסוכן המרוחק לשמות המשתנים של GECX. אובייקט שמכיל רשימה של צמדי |
outputVariableMapping |
זה שינוי אופציונלי. מיפוי של שמות המשתנים של הפלט של הנציג המרוחק לשמות המשתנים של GECX. אובייקט שמכיל רשימה של צמדי |
InputVariableMappingEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
ToolFakeConfig
| ייצוג ב-JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| שדות | |
|---|---|
enableFakeMode |
זה שינוי אופציונלי. אם הכלי משתמש במצב מזויף. |
שדה של איחוד tool_response. התשובה היא סטטית או שהיא מסופקת על ידי פונקציית Python. הערך tool_response יכול להיות רק אחד מהבאים: |
|
codeBlock |
זה שינוי אופציונלי. בלוק קוד שיופעל במקום קריאת API אמיתית לכלי. |
CodeBlock
| ייצוג ב-JSON |
|---|
{ "pythonCode": string } |
| שדות | |
|---|---|
pythonCode |
חובה. קוד Python שיופעל במצב מזויף של הכלי. חתימת פונקציית Python צפויה – כדי לתפוס את כל קריאות ה-API לכלים: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: כדי לתפוס קריאת API לכלי ספציפי: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: אם הפונקציה מחזירה None, הכלי האמיתי יופעל במקום זאת. |
דוגמה
| ייצוג ב-JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"entryAgent": string,
"messages": [
{
object ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של הדוגמה. פורמט: |
displayName |
חובה. השם המוצג של הדוגמה. |
description |
זה שינוי אופציונלי. תיאור קריא לאנשים של הדוגמה. |
entryAgent |
זה שינוי אופציונלי. הסוכן שמטפל בשיחה בהתחלה. אם לא צוין אחרת, הדוגמה מייצגת שיחה שמטופלת על ידי הנציג הראשי. פורמט: |
messages[] |
זה שינוי אופציונלי. אוסף ההודעות שמרכיבות את השיחה. |
createTime |
פלט בלבד. חותמת הזמן של יצירת הדוגמה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של הדוגמה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
invalid |
פלט בלבד. יכול להיות שהדוגמה לא תהיה תקפה אם המשאבים שמפנים אליה יימחקו. דוגמאות לא תקינות לא ישמשו כדוגמאות לפרומפט עם כמה דוגמאות (few-shot). |
etag |
Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
הודעה
| ייצוג ב-JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| שדות | |
|---|---|
role |
זה שינוי אופציונלי. התפקיד בשיחה, למשל: משתמש, נציג. |
chunks[] |
זה שינוי אופציונלי. תוכן ההודעה כסדרה של קטעים. |
eventTime |
זה שינוי אופציונלי. חותמת הזמן של שליחת או קבלת ההודעה. אין להשתמש אם ההודעה היא חלק מ- הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
מקטע
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד data. נתוני המקטע. הערך data יכול להיות רק אחד מהבאים: |
|
text |
זה שינוי אופציונלי. נתוני טקסט. |
transcript |
זה שינוי אופציונלי. תמליל שמשויך לאודיו. |
blob |
זה שינוי אופציונלי. נתוני Blob. |
payload |
זה שינוי אופציונלי. נתוני מטען ייעודי (payload) בהתאמה אישית. |
image |
זה שינוי אופציונלי. נתוני התמונה. |
toolCall |
זה שינוי אופציונלי. בקשה להפעלת כלי. |
toolResponse |
זה שינוי אופציונלי. תגובה להרצת הכלי. |
agentTransfer |
זה שינוי אופציונלי. אירוע העברה של סוכן. |
updatedVariables |
מבנה שמייצג משתנים שעודכנו בשיחה, עם מפתחות לפי שמות המשתנים. |
defaultVariables |
מבנה שמייצג משתני ברירת מחדל בתחילת השיחה, עם מפתחות לפי שמות המשתנים. |
כתם
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA. |
data |
חובה. בייטים גולמיים של ה-blob. מחרוזת בקידוד Base64. |
תמונה
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string, "altText": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA. סוגי התמונות הנתמכים כוללים: * image/png * image/jpeg * image/webp |
data |
חובה. בייטים גולמיים של התמונה. מחרוזת בקידוד Base64. |
altText |
זה שינוי אופציונלי. הטקסט החלופי של התמונה. |
ToolCall
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה הייחודי של קריאת ה-API לכלי. אם השדה מאוכלס, הלקוח צריך להחזיר את תוצאת ההפעלה עם המזהה התואם ב- |
displayName |
פלט בלבד. השם המוצג של הכלי. |
args |
זה שינוי אופציונלי. הפרמטרים והערכים של הקלט לכלי בפורמט של אובייקט JSON. |
parentToolCallId |
פלט בלבד. המזהה של קריאת ה-API לכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאה ראשית. ריק לקריאות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת הקריאה שהתחילה אותה, במקום להציג כל שלב כרכיב אחים. |
agentName |
פלט בלבד. השם של הנציג שביצע את השיחה, בפורמט שקריא לבני אדם, למשל "אדריכל קבלן". השדה ריק כשהסוכן ברמה הבסיסית (root) הנפיק אותו. |
targetApp |
פלט בלבד. האפליקציה שאליה השיחה הזו מיועדת, נגזרת על ידי Assistant מהארגומנטים של המשאבים של השיחה: שם משאב של אפליקציה, |
שדה של איחוד tool_identifier. המזהה של הכלי שצריך להפעיל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי להרצה מתוך ערכת הכלים. |
ToolsetTool
| ייצוג ב-JSON |
|---|
{ "toolset": string, "toolId": string } |
| שדות | |
|---|---|
toolset |
חובה. שם המשאב של ערכת הכלים שממנה נגזר הכלי הזה. פורמט: |
toolId |
זה שינוי אופציונלי. מזהה הכלי שלפיו מסננים את הכלים כדי לאחזר את הסכימה שלהם. |
ToolResponse
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה התואם של |
displayName |
פלט בלבד. השם המוצג של הכלי. |
response |
חובה. תוצאת ההפעלה של הכלי בפורמט של אובייקט JSON. צריך להשתמש במפתח output כדי לציין את התגובה של הכלי, ובמפתח error כדי לציין את פרטי השגיאה (אם יש). אם המפתחות "output" ו-"error" לא צוינו, כל ה-"response" נחשב לתוצאת ההפעלה של הכלי. |
parentToolCallId |
פלט בלבד. המזהה של קריאת ה-API לכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאה ראשית. ריק לקריאות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת הקריאה שהתחילה אותה, במקום להציג כל שלב כרכיב אחים. |
agentName |
פלט בלבד. השם של הנציג שביצע את השיחה, בפורמט שקריא לבני אדם, למשל "אדריכל קבלן". השדה ריק כשהסוכן ברמה הבסיסית (root) הנפיק אותו. |
targetApp |
פלט בלבד. האפליקציה שהכלי שהופעל טירגט; משקפת את |
שדה של איחוד tool_identifier. המזהה של הכלי שהופעל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי שהופעל מתוך ערכת הכלים. |
AgentTransfer
| ייצוג ב-JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| שדות | |
|---|---|
targetAgent |
חובה. הנציג שאליו מועברת השיחה. הנציג יטפל בשיחה מכאן והלאה. פורמט: |
displayName |
פלט בלבד. השם המוצג של הנציג. |
שכבת הגנה
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של מעקה הבטיחות. פורמט: |
displayName |
חובה. השם המוצג של מעקה הבטיחות. |
description |
זה שינוי אופציונלי. תיאור של ההנחיה. |
enabled |
זה שינוי אופציונלי. אם אמצעי ההגנה מופעל. |
action |
זה שינוי אופציונלי. הפעולה שצריך לבצע כשהמעקה מופעל. |
createTime |
פלט בלבד. חותמת הזמן של יצירת מעקה הבטיחות. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של מעקה הבטיחות. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
etag |
Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
שדה של איחוד guardrail_type. סוג מעקה הבטיחות. הערך guardrail_type יכול להיות רק אחד מהבאים: |
|
contentFilter |
זה שינוי אופציונלי. הנחיה שאוסרת על שימוש בתוכן מסוים בשיחה. |
llmPromptSecurity |
זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה אם ההנחיה נחשבת לא בטוחה על סמך הסיווג של ה-LLM. |
llmPolicy |
זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה אם התשובה של ה-LLM נחשבת כמפירה את המדיניות על סמך הסיווג של ה-LLM. |
modelSafety |
זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה אם התשובה של ה-LLM נחשבת לא בטוחה, בהתאם להגדרות הבטיחות של המודל. |
codeCallback |
זה שינוי אופציונלי. הנחיה שעשויה לחסום את השיחה על סמך התוצאה של הפעלת ה-callback. |
supervisor |
זה שינוי אופציונלי. אמצעי הגנה שמפעיל התערבות של מפקח. |
ContentFilter
| ייצוג ב-JSON |
|---|
{
"bannedContents": [
string
],
"bannedContentsInUserInput": [
string
],
"bannedContentsInAgentResponse": [
string
],
"matchType": enum ( |
| שדות | |
|---|---|
bannedContents[] |
זה שינוי אופציונלי. רשימה של ביטויים אסורים. ההגדרה חלה גם על הקלט של המשתמשים וגם על התשובות של הסוכן. |
bannedContentsInUserInput[] |
זה שינוי אופציונלי. רשימה של ביטויים אסורים. ההגדרה חלה רק על קלט של משתמשים. |
bannedContentsInAgentResponse[] |
זה שינוי אופציונלי. רשימה של ביטויים אסורים. ההגדרה חלה רק על תשובות של נציגים. |
matchType |
חובה. סוג ההתאמה של מסנן התוכן. |
disregardDiacritics |
זה שינוי אופציונלי. אם הערך הוא True, המערכת מתעלמת מסימנים דיאקריטיים במהלך ההתאמה. |
sensitiveWordsExemptions[] |
זה שינוי אופציונלי. רשומות ברשימת המילים הרגישות שההגנה הזו מאפשרת. רלוונטי רק אם הערך של match_type הוא SENSITIVE_WORDS. כל ערך חייב להיות זהה לרשומה ברשימה (לא תלוי-רישיות, המערכת מתעלמת מרווחים לבנים מסביב). ערכים אחרים לא משפיעים. ההגדרה חלה רק על ההגנה הזו. עד 1,000 רשומות, כל אחת באורך של עד 256 תווים. |
LlmPromptSecurity
| ייצוג ב-JSON |
|---|
{ "failOpen": boolean, // Union field |
| שדות | |
|---|---|
failOpen |
זה שינוי אופציונלי. ההגדרה הזו קובעת מה קורה כשיש שגיאה במודל ה-LLM. - אם הערך הוא True: המערכת עוקפת את מנגנון ההגנה. - אם הערך הוא False (ברירת המחדל): מעקה הבטיחות מופעל או חוסם. הערה: אם מספקים מדיניות בהתאמה אישית, המערכת מתעלמת מהשדה הזה ומשתמשת בהגדרה fail_open של המדיניות. |
שדה של איחוד security_config. מגדירה את מצב הגדרת האבטחה. המשתמש צריך לבחור באחת מההגדרות הבאות. הערך security_config יכול להיות רק אחד מהבאים: |
|
defaultSettings |
זה שינוי אופציונלי. להשתמש בהגדרות האבטחה שמוגדרות מראש כברירת מחדל במערכת. כדי לבחור במצב הזה, צריך לכלול בבקשה הודעת default_settings ריקה. השרת יאכלס את השדה default_prompt_template בתגובה. |
customPolicy |
זה שינוי אופציונלי. כדי להגדיר את מעקה הבטיחות, משתמשים ב-LlmPolicy שמוגדר על ידי המשתמש. |
DefaultSecuritySettings
| ייצוג ב-JSON |
|---|
{ "defaultPromptTemplate": string } |
| שדות | |
|---|---|
defaultPromptTemplate |
פלט בלבד. תבנית ברירת המחדל לפרומפט שבה המערכת משתמשת. השדה הזה מיועד להצגת ההנחיה שהמערכת משתמשת בה כברירת מחדל. הוא OUTPUT_ONLY. |
LlmPolicy
| ייצוג ב-JSON |
|---|
{ "maxConversationMessages": integer, "modelSettings": { object ( |
| שדות | |
|---|---|
maxConversationMessages |
זה שינוי אופציונלי. כשבודקים את המדיניות הזו, צריך להביא בחשבון את n ההודעות האחרונות בשיחה. אם לא מגדירים ערך, המערכת תשתמש בערך ברירת המחדל 10. |
modelSettings |
זה שינוי אופציונלי. הגדרות המודל. |
prompt |
חובה. הנחיה לגבי המדיניות. תומך בפלייסהולדרים של משתני סשן ( |
policyScope |
חובה. מגדיר מתי להחיל את בדיקת המדיניות במהלך השיחה. אם המדיניות מוגדרת לערך |
failOpen |
זה שינוי אופציונלי. אם מתרחשת שגיאה במהלך בדיקת המדיניות, המערכת תמשיך לפעול ולא תפעיל את מעקה הבטיחות. |
allowShortUtterance |
זה שינוי אופציונלי. כברירת מחדל, בדיקת המדיניות של ה-LLM לא מתבצעת על ביטויים קצרים. אם מפעילים את ההגדרה הזו, בדיקת המדיניות חלה על כל הביטויים, כולל אלה שבדרך כלל המערכת מדלגת עליהם. |
ModelSafety
| ייצוג ב-JSON |
|---|
{
"safetySettings": [
{
object ( |
| שדות | |
|---|---|
safetySettings[] |
חובה. רשימה של הגדרות בטיחות. |
SafetySetting
| ייצוג ב-JSON |
|---|
{ "category": enum ( |
| שדות | |
|---|---|
category |
חובה. קטגוריית הפגיעה. |
threshold |
חובה. סף החסימה של תוכן פוגעני. |
CodeCallback
| ייצוג ב-JSON |
|---|
{ "beforeAgentCallback": { object ( |
| שדות | |
|---|---|
beforeAgentCallback |
זה שינוי אופציונלי. הקריאה החוזרת (callback) שצריך להפעיל לפני שקוראים לסוכן. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': 'OK' או 'TRIGGER'. - "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד. |
afterAgentCallback |
זה שינוי אופציונלי. הקריאה החוזרת (callback) שתבוצע אחרי שהסוכן יופעל. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': 'OK' או 'TRIGGER'. - "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד. |
beforeModelCallback |
זה שינוי אופציונלי. הקריאה החוזרת (callback) שצריך להפעיל לפני הקריאה למודל. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': 'OK' או 'TRIGGER'. - "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד. |
afterModelCallback |
זה שינוי אופציונלי. הקריאה החוזרת (callback) שצריך להפעיל אחרי שהמודל נקרא. אם יש כמה קריאות למודל, פונקציית ה-callback תופעל כמה פעמים. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: - 'decision': 'OK' או 'TRIGGER'. - "reason": מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER עשויה לעצור את המשך העיבוד. |
מפקח/ת
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
זה שינוי אופציונלי. סוג המפקח. |
detectionMode |
זה שינוי אופציונלי. מצב הזיהוי של המפקח. |
TriggerAction
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד action. הפעולה שצריך לבצע. הערך action יכול להיות רק אחד מהבאים: |
|
respondImmediately |
זה שינוי אופציונלי. להגיב מיד עם תשובה שהוגדרה מראש. |
transferAgent |
זה שינוי אופציונלי. להעביר את השיחה לנציג אחר. |
generativeAnswer |
זה שינוי אופציונלי. להשיב באמצעות תשובה שנוצרה על ידי AI. |
RespondImmediately
| ייצוג ב-JSON |
|---|
{
"responses": [
{
object ( |
| שדות | |
|---|---|
responses[] |
חובה. התגובות המוכנות מראש שהנציג יכול לבחור מתוכן. התשובה נבחרת באופן אקראי. |
תשובה
| ייצוג ב-JSON |
|---|
{ "text": string, "disabled": boolean } |
| שדות | |
|---|---|
text |
חובה. הטקסט שהסוכן ישתמש בו כדי להשיב. |
disabled |
זה שינוי אופציונלי. אם התשובה מושבתת. הנציג לא משתמש בתשובות מושבתות. |
TransferAgent
| ייצוג ב-JSON |
|---|
{ "agent": string } |
| שדות | |
|---|---|
agent |
חובה. שם הנציג שאליו רוצים להעביר את השיחה. הנציג חייב להיות באותה אפליקציה כמו הנציג הנוכחי. פורמט: |
GenerativeAnswer
| ייצוג ב-JSON |
|---|
{ "prompt": string } |
| שדות | |
|---|---|
prompt |
חובה. ההנחיה שמשמשת ליצירת התשובה. |
ערכת כלים
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "timeout": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של ערכת הכלים. פורמט: |
displayName |
זה שינוי אופציונלי. השם המוצג של ערכת הכלים. המזהה חייב להיות ייחודי באותה אפליקציה. |
description |
זה שינוי אופציונלי. תיאור של ערכת הכלים. |
timeout |
זה שינוי אופציונלי. הזמן הקצוב לתפוגה של הרצת ערכת הכלים. אם המדיניות לא מוגדרת, ברירת המחדל של זמן הקצוב לתפוגה היא 30 שניות לערכות כלים של משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
createTime |
פלט בלבד. חותמת הזמן של מועד היצירה של ערכת הכלים. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של ערכת הכלים. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
etag |
ETag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
executionType |
זה שינוי אופציונלי. סוג הביצוע של הכלים בערכת הכלים. |
toolFakeConfig |
זה שינוי אופציונלי. הגדרת אופן הפעולה של הכלים במצב מדומה. |
שדה של איחוד toolset_type. סוג ערכת הכלים. הערך toolset_type יכול להיות רק אחד מהבאים: |
|
mcpToolset |
זה שינוי אופציונלי. ערכת כלים שמכילה רשימה של כלים שמוצעים על ידי שרת ה-MCP. |
openApiToolset |
זה שינוי אופציונלי. ערכת כלים שמכילה רשימה של כלים שמוגדרים על ידי סכימת OpenAPI. |
connectorToolset |
זה שינוי אופציונלי. ערכת כלים שיוצרת כלים מחיבור של Integration Connectors. |
McpToolset
| ייצוג ב-JSON |
|---|
{ "serverAddress": string, "apiAuthentication": { object ( |
| שדות | |
|---|---|
serverAddress |
חובה. הכתובת של שרת ה-MCP, לדוגמה, "https://example.com/mcp/". אם השרת נוצר באמצעות MCP SDK, כתובת ה-URL צריכה להסתיים ב-"/mcp/". יש תמיכה רק בשרתים שמבוססים על העברת Streamable HTTP. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http. |
apiAuthentication |
זה שינוי אופציונלי. פרטי האימות שנדרשים כדי לגשת לכלים ולהפעיל כלי בשרת ה-MCP. באימות באמצעות טוקן למוכ"ז, הטוקן חל רק על הפעלת הכלי, ולא על הצגת הכלים. לשם כך, צריך לאפשר הצגה של כלים בלי אימות. |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות של שירותים בתוך היקף. |
tlsConfig |
זה שינוי אופציונלי. הגדרת ה-TLS. כוללת את אישורי השרת בהתאמה אישית שהלקוח צריך לסמוך עליהם. |
customHeaders |
זה שינוי אופציונלי. הכותרות בהתאמה אישית שיישלחו בבקשה לשרת ה-MCP. הערכים חייבים להיות בפורמט אובייקט שמכיל רשימה של צמדי |
toolOverrides[] |
זה שינוי אופציונלי. שינויים בכלים ספציפיים בערכת הכלים הזו. כך אפשר לשנות פרטים ספציפיים כמו תיאורים או שמות, או להצמיד את המצבים של הכלים כדי שהם לא יהיו דינמיים לחלוטין. |
CustomHeadersEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": string } |
| שדות | |
|---|---|
key |
|
value |
|
McpToolOverride
| ייצוג ב-JSON |
|---|
{
"tool": string,
"nameOverride": string,
"descriptionOverride": string,
"snapshot": {
object ( |
| שדות | |
|---|---|
tool |
חובה. השם המקורי של הכלי כפי שהוא מופק על ידי שרת ה-MCP. |
nameOverride |
זה שינוי אופציונלי. אם הוא קיים, הכלי הזה משתמש בשם הזה בנציג במקום בשם המקורי. השדה הזה משמש בעיקר כשם חלופי אם שרת ה-MCP מציע כלים עם שמות לא ברורים. |
descriptionOverride |
זה שינוי אופציונלי. אם יש תיאור, הכלי הזה משתמש בו במקום בתיאור המקורי מהשרת. |
snapshot |
פלט בלבד. אם הכלי הזה קיים, הוא "מוצמד" ומשתמש בערכי תמונת המצב כחלופות אם השרת לא זמין באופן זמני או אם אין שינוי. |
McpToolDefinition
| ייצוג ב-JSON |
|---|
{ "description": string, "inputSchema": { object ( |
| שדות | |
|---|---|
description |
פלט בלבד. תיאור כלי ה-MCP. אפשר לשנות את ההגדרה הזו באמצעות |
inputSchema |
פלט בלבד. הסכימה של הארגומנטים של הקלט של כלי ה-MCP. |
outputSchema |
פלט בלבד. הסכימה של הארגומנטים של הפלט של כלי ה-MCP. |
OpenApiToolset
| ייצוג ב-JSON |
|---|
{ "openApiSchema": string, "apiAuthentication": { object ( |
| שדות | |
|---|---|
openApiSchema |
חובה. סכימת OpenAPI של ערכת הכלים. |
apiAuthentication |
זה שינוי אופציונלי. פרטי האימות שנדרשים על ידי ה-API. |
tlsConfig |
זה שינוי אופציונלי. הגדרת ה-TLS. כולל את אישורי השרת בהתאמה אישית |
serviceDirectoryConfig |
זה שינוי אופציונלי. הגדרת Service Directory. |
ignoreUnknownFields |
זה שינוי אופציונלי. אם הערך הוא True, הנציג יתעלם משדות לא ידועים בתגובה מה-API בכל הפעולות שמוגדרות בסכימה של OpenAPI. |
url |
זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת ה-Open API. השדה הזה מוגדר רק בערכות כלים ביחסי התלות של הסביבה במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו קיימת ביחסי התלות של הסביבה ובסכימה יש את ה-placeholder $env_var, היא תחליף את ה-placeholder בסכימה. |
ConnectorToolset
| ייצוג ב-JSON |
|---|
{ "connection": string, "authConfig": { object ( |
| שדות | |
|---|---|
connection |
חובה. השם המלא של המשאב של החיבור המקושר ב-Integration Connectors. פורמט: |
authConfig |
זה שינוי אופציונלי. ההגדרה קובעת איך מתבצע האימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות API של Integration Connectors. אפשר לשנות אותה באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל בחיבור את האפשרות לעקוף את האימות. אחרת, יצירת ערכת הכלים תיכשל. מידע נוסף זמין בכתובת https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connectorActions[] |
חובה. רשימת הפעולות של המחבר או הישות שרוצים ליצור להן כלים. |
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_SEARCH |
מנוע SOLUTION_TYPE_SEARCH לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה. |
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 |
עיצוב כהה. |
RequestLocation
המיקום של מפתח ה-API בבקשה.
| טיפוסים בני מנייה (enum) | |
|---|---|
REQUEST_LOCATION_UNSPECIFIED |
לא צוין. אין להשתמש בערך הזה. |
HEADER |
מייצג את המפתח בכותרת ה-HTTP. |
QUERY_STRING |
מייצג את המפתח במחרוזת של השאילתה. |
OauthGrantType
סוגי הרשאות OAuth. יש תמיכה רק בהרשאת פרטי כניסה של לקוח.
| טיפוסים בני מנייה (enum) | |
|---|---|
OAUTH_GRANT_TYPE_UNSPECIFIED |
לא צוין. ברירת המחדל היא CLIENT_CREDENTIAL. |
CLIENT_CREDENTIAL |
מייצג את תהליך פרטי הכניסה של הלקוח. |
כיוון
כיוון ההעברה.
| טיפוסים בני מנייה (enum) | |
|---|---|
DIRECTION_UNSPECIFIED |
כיוון לא מוגדר. |
PARENT_TO_CHILD |
העברה מהסוכן הראשי לסוכן המשני. |
CHILD_TO_PARENT |
העברה מהסוכן המשני לסוכן הראשי. |
OperationType
הפעולה שצריך לבצע על היישות.
| טיפוסים בני מנייה (enum) | |
|---|---|
OPERATION_TYPE_UNSPECIFIED |
סוג הפעולה לא צוין. לא תקין, היצירה או העדכון של ConnectorTool ייכשלו. |
LIST |
פעולה ברשימה. |
GET |
פעולת Get. |
CREATE |
פעולת יצירה. |
UPDATE |
פעולת עדכון. |
DELETE |
פעולת מחיקה. |
DataStoreType
סוג מאגר הנתונים.
| טיפוסים בני מנייה (enum) | |
|---|---|
DATA_STORE_TYPE_UNSPECIFIED |
לא צוין. הערך הזה מציין שסוג מאגר הנתונים לא צוין, ולכן לא ייעשה בו שימוש במהלך החיפוש. |
PUBLIC_WEB |
מאגר נתונים שמכיל תוכן מהאינטרנט שגלוי לכולם. |
UNSTRUCTURED |
מאגר נתונים שמכיל נתונים פרטיים לא מובְנים. |
FAQ |
מאגר נתונים שמכיל נתונים מובְנים שמשמשים כשאלות נפוצות. |
CONNECTOR |
מאגר נתונים שהוא מחבר לשירות של צד ראשון או של צד שלישי. |
DocumentProcessingMode
מצב עיבוד המסמכים של מאגר הנתונים.
| טיפוסים בני מנייה (enum) | |
|---|---|
DOCUMENT_PROCESSING_MODE_UNSPECIFIED |
לא צוין. |
DOCUMENTS |
מסמכים מעובדים כמסמכים. |
CHUNKS |
המסמכים מומרים לקטעים. |
AttributeType
המאפיין (או הפונקציה) שעליו יחול הדירוג בהתאמה אישית.
| טיפוסים בני מנייה (enum) | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
סוג מאפיין לא מזוהה. |
NUMERICAL |
הערך של השדה המספרי ישמש לעדכון דינמי של סכום החיזוק. במקרה כזה, ערך המאפיין (ערך ה-X) של נקודת הבקרה יהיה הערך בפועל של השדה המספרי שעבורו צוין סכום החיזוק. |
FRESHNESS |
בתרחיש לדוגמה של עדכניות, ערך המאפיין יהיה משך הזמן בין השעה הנוכחית לבין התאריך בשדה התאריך והשעה שצוין. הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן בפורמט ISO 8601). התבנית של הכתובת הזו היא: [nD][T[nH][nM][nS]]. למשל: 5D, 3DT12H30M, T24H. |
InterpolationType
סוג האינטרפולציה שצריך להחיל. ברירת המחדל תהיה לינארית (לינארית חלקית).
| טיפוסים בני מנייה (enum) | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
סוג האינטרפולציה לא צוין. במקרה כזה, ברירת המחדל היא "לינארי". |
LINEAR |
המערכת תבצע אינטרפולציה לינארית חלקית. |
ModalityType
סוג המודאליות.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_TYPE_UNSPECIFIED |
סוג המודליות לא צוין. |
TEXT |
מודליות טקסט. |
AUDIO |
מודל אודיו. |
FilterParameterBehavior
התנהגות של פרמטר סינון.
| טיפוסים בני מנייה (enum) | |
|---|---|
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED |
התנהגות ברירת המחדל של המסנן. כולל פרמטר סינון למאגרי נתונים של מחברים. בשאר הסוגים של מאגרי הנתונים, פרמטר הקלט של המסנן מושמט. |
ALWAYS_INCLUDE |
תמיד צריך לכלול פרמטר סינון לכל סוגי מאגרי הנתונים. |
NEVER_INCLUDE |
הפרמטר filter אף פעם לא נכלל ברשימת הפרמטרים של הכלי, בלי קשר לסוג מאגר הנתונים. |
מדינה
מייצג את מצב הזמינות הדינמי של הכלי.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATE_UNSPECIFIED |
מצב ברירת המחדל. |
ACTIVE |
הכלי זמין והשרת מציע אותו באופן פעיל. |
INACTIVE |
הכלי מוגדר או מוצמד, אבל השרת לא מציע אותו כרגע. |
STALE |
הכלי קיים בשרת, אבל לא תואם לגרסה שבשרת. |
CorpusType
סוג קורפוס ה-RAG ב-Vertex.
| טיפוסים בני מנייה (enum) | |
|---|---|
CORPUS_TYPE_UNSPECIFIED |
סוג הקורפוס לא צוין. |
USER_OWNED |
הקורפוס נוצר על ידי המשתמש ונמצא בבעלותו. |
FULLY_MANAGED |
הקורפוס נוצר על ידי הסוכן. |
WidgetType
כל סוגי הווידג'טים הזמינים. יכול להיות שבעתיד נוסיף ערכים חדשים ל-enum הזה.
| טיפוסים בני מנייה (enum) | |
|---|---|
WIDGET_TYPE_UNSPECIFIED |
סוג הווידג'ט לא צוין. |
CUSTOM |
סוג הווידג'ט בהתאמה אישית. |
PRODUCT_CAROUSEL |
ווידג'ט של קרוסלת מוצרים. |
PRODUCT_DETAILS |
ווידג'ט של פרטי המוצר. |
QUICK_ACTIONS |
ווידג'ט של פעולות מהירות. |
PRODUCT_COMPARISON |
ווידג'ט להשוואת מוצרים. |
ADVANCED_PRODUCT_DETAILS |
ווידג'ט מתקדם של פרטי המוצר. |
SHORT_FORM |
ווידג'ט של סרטונים קצרים. |
OVERALL_SATISFACTION |
ווידג'ט שביעות רצון כללית. |
ORDER_SUMMARY |
ווידג'ט של סיכום ההזמנה. |
APPOINTMENT_DETAILS |
ווידג'ט של פרטי הפגישה. |
APPOINTMENT_SCHEDULER |
ווידג'ט לקביעת פגישות. |
CONTACT_FORM |
ווידג'ט של טופס ליצירת קשר. |
מצב
השיטה שמשמשת למיפוי נתונים מכלי המקור לווידג'ט.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODE_UNSPECIFIED |
מצב לא מוגדר. |
FIELD_MAPPING |
משתמשים במפה field_mappings כדי לשנות את הנתונים. |
PYTHON_SCRIPT |
משתמשים ב-python_script כדי לשנות את הנתונים. |
סוג
מגדיר איך התשובה בטקסט נוצרת.
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
סוג לא מזוהה. |
NONE |
ה-LLM מחליט באופן דינמי אם ליצור תשובת טקסט לצד הווידג'ט, על סמך ההקשר של השיחה. |
LLM_GENERATED |
ה-LLM נדרש באופן מפורש ליצור תשובה שהיא טקסט. |
STATIC |
תמיד נעשה שימוש בתגובת טקסט סטטית שהוגדרה מראש. |
ExecutionType
סוג ההפעלה של הכלי או ערכת הכלים.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXECUTION_TYPE_UNSPECIFIED |
סוג ההפעלה לא צוין. אם לא צוין ערך, ברירת המחדל היא SYNCHRONOUS. |
SYNCHRONOUS |
הכלי מופעל באופן סינכרוני. הסשן נחסם עד שהכלי מחזיר תשובה. |
ASYNCHRONOUS |
הכלי מופעל באופן אסינכרוני. הסשן יימשך בזמן שהכלי פועל. |
MatchType
סוג ההתאמה של מסנן התוכן.
| טיפוסים בני מנייה (enum) | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
סוג ההתאמה לא צוין. |
SIMPLE_STRING_MATCH |
התוכן מותאם למחרוזות משנה תו אחר תו. |
WORD_BOUNDARY_STRING_MATCH |
התוכן תואם רק אם התבנית שנמצאה בטקסט מוקפת בתווי הפרדה בין מילים. ביטויים חסומים יכולים להכיל גם מפרידי מילים. |
REGEXP_MATCH |
ההתאמה לתוכן מתבצעת באמצעות תחביר של ביטויים רגולריים. |
SENSITIVE_WORDS |
המערכת בודקת אם התוכן תואם לרשימה של מילים וביטויים רגישים. אם מצרפים לאפליקציה או לסוכן מעקה בטיחות עם סוג ההתאמה הזה, הוא מחליף את מסנן המילים הרגישות שמוגדר כברירת מחדל בסוכנים המושפעים. כדי לבטל את ההסכמה לשימוש במסנן ברירת המחדל, צריך להשבית את מעקה הבטיחות. |
PolicyScope
מגדיר מתי להחיל את בדיקת המדיניות במהלך השיחה.
| טיפוסים בני מנייה (enum) | |
|---|---|
POLICY_SCOPE_UNSPECIFIED |
היקף המדיניות לא צוין. |
USER_QUERY |
בדיקת המדיניות מופעלת על קלט של משתמשים. |
AGENT_RESPONSE |
בדיקת המדיניות מופעלת בתגובה של הנציג. החלת היקף המדיניות הזה תגרום לזמן אחזור נוסף לפני שהנציג יוכל להגיב. |
USER_QUERY_AND_AGENT_RESPONSE |
בדיקת המדיניות מופעלת גם על הקלט של המשתמש וגם על התשובה של הנציג. החלת היקף המדיניות הזה תגרום לזמן אחזור נוסף לפני שהנציג יוכל להגיב. |
HarmCategory
קטגוריית הנזק.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
קטגוריית הפגיעה לא צוינה. |
HARM_CATEGORY_HATE_SPEECH |
קטגוריית הנזק היא דברי שטנה. |
HARM_CATEGORY_DANGEROUS_CONTENT |
קטגוריית הנזק היא תוכן מסוכן. |
HARM_CATEGORY_HARASSMENT |
קטגוריית הפגיעה היא הטרדה. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
קטגוריית הפגיעה היא תוכן מיני בוטה. |
HARM_CATEGORY_PROFANITY |
קטגוריית הפגיעה היא שפה גסה. |
HARM_CATEGORY_TOXIC |
קטגוריית הפגיעה היא רעילות. |
HarmBlockThreshold
רמות סף מבוססות-הסתברות לחסימה.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
סף חסימה לא מוגדר של נזק. |
BLOCK_LOW_AND_ABOVE |
חסימת סף נמוך ומעלה (כלומר, חסימה של יותר תוכן). |
BLOCK_MEDIUM_AND_ABOVE |
חסימה של סף בינוני ומעלה. |
BLOCK_ONLY_HIGH |
לחסום רק סף גבוה (כלומר, לחסום פחות). |
BLOCK_NONE |
לא לחסום אף אחד. |
OFF |
משביתים את מסנן הבטיחות. |
סוג
סוג המפקח.
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
לא צוין סוג. |
INVALID_TEXT |
סוג הבעיה בטקסט לא תקין. |
LANGUAGE_SHIFT |
סוג הבעיה: שינוי שפה. |
SPEAKER_SHIFT |
סוג הבעיה: שינוי הדובר. |
AUDIO_MISMATCH |
סוג הבעיה: חוסר התאמה באודיו. |
MISSING_TOOL_CALL |
לא צוין סוג הבעיה בקריאת ה-API לכלי. |
CUSTOM |
סוג בעיה מותאם אישית. |
CHOPPY_AUDIO |
סוג הבעיה: אודיו קטוע. |
PROFANITY |
סוג הבעיה: שפה גסה של הנציג. |
DetectionMode
מצב הזיהוי של המפקח.
| טיפוסים בני מנייה (enum) | |
|---|---|
DETECTION_MODE_UNSPECIFIED |
מצב הזיהוי לא צוין. ברירת המחדל היא NON_BLOCKING. |
NON_BLOCKING |
מצב זיהוי ללא חסימה. התגובה לא נחסמת בזמן שהמערכת מזהה את המפקח. |
BLOCKING |
חסימת מצב זיהוי. התגובה נחסמת כשהפיקוח פועל. |
הערות לגבי הכלים
הערות לגבי כלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כלא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשה לאישור.
בנוסף למחרוזת הכותרת, הרמזים הבוליאניים הבאים מוגדרים כך:
-
readOnlyHint: אם הערך הוא True, הכלי לא משנה את הסביבה שלו. ברירת המחדל: false. -
destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא False, הכלי יכול לבצע רק פעולות הוספה. ברירת המחדל: true. -
idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת המחדל: false. -
openWorldHint: אם הערך הוא True, הכלי יכול לקיים אינטראקציה עם "עולם פתוח" של ישויות חיצוניות. אם הערך הוא false, הכלי יכול לקיים אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי חיפוש באינטרנט הוא כלי בעולם פתוח, אבל כלי זיכרון הוא לא כלי בעולם פתוח.
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌