כלי: update_deployment
מעדכן את הפריסה שצוינה. חשוב להקפיד להעביר תמיד מסכת עדכון בקלט.
בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי update_deployment MCP.
| בקשת Curl |
|---|
curl --location 'https://ces.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "update_deployment", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
סכימת הקלט
בקשת הודעה עבור AgentService.UpdateDeployment.
UpdateDeploymentRequest
| ייצוג JSON |
|---|
{
"deployment": {
object ( |
| שדות | |
|---|---|
deployment |
חובה. הפריסה שרוצים לעדכן. |
updateMask |
זה שינוי אופציונלי. רשימת השדות לעדכון. זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: |
פריסה
| ייצוג JSON |
|---|
{ "name": string, "displayName": string, "appVersion": string, "channelProfile": { object ( |
| שדות | |
|---|---|
name |
מזהה. שם המשאב של הפריסה. פורמט: |
displayName |
חובה. השם המוצג של הפריסה. |
appVersion |
זה שינוי אופציונלי. שם המשאב של גרסת האפליקציה לפריסה. פורמט: |
channelProfile |
חובה. פרופיל הערוץ שבו נעשה שימוש בפריסה. |
createTime |
פלט בלבד. חותמת הזמן שבה הפריסה הזו נוצרה. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של הפריסה הזו. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
etag |
פלט בלבד. תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון ידרוס את כל השינויים שמתבצעים בו-זמנית. |
experimentConfig |
זה שינוי אופציונלי. הגדרת הניסוי לפריסה. |
whatsappCredentials |
זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל של ערוץ וואטסאפ, צריך להזין פרטי כניסה זמניים לוואטסאפ. |
instagramCredentials |
זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל של ערוץ אינסטגרם, צריך להזין פרטי כניסה זמניים לאינסטגרם. |
modelSettings |
זה שינוי אופציונלי. הגדרות המודל לפריסה. ההגדרות האלה מבטלות את ההגדרות של המודל שנקבעו ברמת האפליקציה או הסוכן. הערה: כדי לבטל את הגדרות המודל ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS. |
modality |
זה שינוי אופציונלי. אופן הפריסה. הערה: כדי להשתמש בהחלפת מודאליות ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS. |
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 |
פלט בלבד. השם של הדף העסקי ב-מטא שאוחזר. |
thumbnailUrl |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאוחזרה. |
description |
פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא. |
InstagramConfig
| ייצוג JSON |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| שדות | |
|---|---|
instagramAccountId |
חובה. מספר החשבון באינסטגרם. |
displayName |
פלט בלבד. השם של הדף העסקי ב-מטא שאוחזר. |
thumbnailUrl |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאוחזרה. |
description |
פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא. |
חותמת הזמן
| ייצוג 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, כולל. |
ExperimentConfig
| ייצוג JSON |
|---|
{
"versionRelease": {
object ( |
| שדות | |
|---|---|
versionRelease |
זה שינוי אופציונלי. גרסת ההפצה של הניסוי. |
VersionRelease
| ייצוג JSON |
|---|
{ "state": enum ( |
| שדות | |
|---|---|
state |
זה שינוי אופציונלי. המצב של השקת הגרסה. |
trafficAllocations[] |
זה שינוי אופציונלי. הקצאות תנועה לגרסה. |
TrafficAllocation
| ייצוג JSON |
|---|
{ "id": string, "trafficPercentage": integer, "appVersion": string } |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה של הקצאת התנועה. מחרוזת בפורמט חופשי, עד 128 תווים. |
trafficPercentage |
זה שינוי אופציונלי. אחוז התנועה בהקצאת התנועה. חייב להיות בין 0 ל-100. |
appVersion |
זה שינוי אופציונלי. גרסת האפליקציה של הקצאת התנועה. פורמט: |
WhatsAppCredentials
| ייצוג JSON |
|---|
{ "authCode": string, "pin": string, "phoneNumber": string, "businessAccountId": string, "wabaId": string, "conversationProfileId": string } |
| שדות | |
|---|---|
authCode |
חובה. קוד האימות של Meta שסופק על ידי תהליך ההרשמה המוטמע. |
pin |
חובה. קוד האימות בן 6 הספרות שנוצר על ידי המשתמש לאימות דו-שלבי. |
phoneNumber |
חובה. מספר הטלפון שרוצים לרשום בוואטסאפ. |
businessAccountId |
חובה. מזהה החשבון העסקי שבו רוצים להשתמש למספר הטלפון. |
wabaId |
חובה. מספר החשבון ב-WhatsApp Business. |
conversationProfileId |
זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה. |
InstagramCredentials
| ייצוג JSON |
|---|
{ "authCode": string, "conversationProfileId": string } |
| שדות | |
|---|---|
authCode |
חובה. קוד האימות של Meta שסופק על ידי תהליך ההרשמה המוטמע. |
conversationProfileId |
זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה. |
ModelSettings
| ייצוג JSON |
|---|
{ "model": string, // Union field |
| שדות | |
|---|---|
model |
זה שינוי אופציונלי. מודל ה-LLM שהסוכן צריך להשתמש בו. אם לא מגדירים מודל, הסוכן יקבל בירושה את המודל מהסוכן הראשי שלו. |
שדה איחוד הערך |
|
temperature |
זה שינוי אופציונלי. אם מוגדרת רמת אקראיות, היא תשמש את מודל ה-LLM. הטמפרטורה קובעת את רמת האקראיות של התשובות של המודל. טמפרטורות נמוכות יותר מפיקות תשובות צפויות יותר. טמפרטורות גבוהות יותר יוצרות תשובות יצירתיות יותר. |
FieldMask
| ייצוג JSON |
|---|
{ "paths": [ string ] } |
| שדות | |
|---|---|
paths[] |
קבוצת הנתיבים של אנונימיזציה של שדות. |
ChannelType
סוג פרופיל הערוץ.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN |
סוג הערוץ לא ידוע. |
WEB_UI |
ערוץ בממשק משתמש באינטרנט. |
API |
ערוץ API. |
TWILIO |
ערוץ Twilio. |
GOOGLE_TELEPHONY_PLATFORM |
ערוץ Google Telephony Platform. |
CONTACT_CENTER_AS_A_SERVICE |
ערוץ Contact Center as a Service (CCaaS). |
CONTACT_CENTER_AS_A_SERVICE_CHAT |
ערוץ Contact Center as a Service (CCaaS Chat). |
FIVE9 |
ערוץ Five9. |
CONTACT_CENTER_INTEGRATION |
ערוץ שילוב של מרכז תמיכה של צד שלישי. |
WHATSAPP |
ערוץ וואטסאפ. |
INSTAGRAM |
ערוץ באינסטגרם. |
פרסונה
הפרסונה של הערוץ.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN |
פרסונה לא ידועה. |
CONCISE |
הסוכן שומר על תשובות תמציתיות וענייניות |
CHATTY |
הסוכן מספק הקשר, הסברים ופרטים נוספים |
מודליות
האופן שבו הווידג'ט מוצג באתר.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_UNSPECIFIED |
אופן השימוש לא ידוע. |
CHAT_AND_VOICE |
הווידג'ט תומך גם בצ'אט וגם בקלט קולי. |
VOICE_ONLY |
הווידג'ט תומך רק בהזנת קלט קולי. |
CHAT_ONLY |
הווידג'ט תומך רק בהזנת צ'אט. |
CHAT_VOICE_AND_VIDEO |
הווידג'ט תומך בקלט של צ'אט, קול ווידאו. |
עיצוב
העיצוב של הווידג'ט לאתר.
| טיפוסים בני מנייה (enum) | |
|---|---|
THEME_UNSPECIFIED |
עיצוב לא ידוע. |
LIGHT |
עיצוב בהיר. |
DARK |
עיצוב כהה. |
מדינה
מצב הניסוי.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATE_UNSPECIFIED |
מצב לא מוגדר. |
PENDING |
הוצא משימוש: המצב הזה כבר לא בשימוש. |
RUNNING |
מצב הפעלה. הניסוי פועל ותקף. |
DONE |
הוצא משימוש: המצב הזה כבר לא בשימוש. |
EXPIRED |
הוצא משימוש: המצב הזה כבר לא בשימוש. |
מודליות
אופן הפריסה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_UNSPECIFIED |
אופן השימוש לא ידוע. |
MODALITY_TEXT |
אופן הצגת הטקסט. |
MODALITY_VOICE |
אופן השימוש בקול. |
MODALITY_VIDEO |
אופן הצגת הווידאו. |
סכימת הפלט
פריסה מייצגת גרסה של האפליקציה שלא ניתן לשנות, שאפשר להריץ עליה שאילתות. היא משמשת לפריסת גרסה של האפליקציה עם פרופיל ערוץ ספציפי.
פריסה
| ייצוג JSON |
|---|
{ "name": string, "displayName": string, "appVersion": string, "channelProfile": { object ( |
| שדות | |
|---|---|
name |
מזהה. שם המשאב של הפריסה. פורמט: |
displayName |
חובה. השם המוצג של הפריסה. |
appVersion |
זה שינוי אופציונלי. שם המשאב של גרסת האפליקציה לפריסה. פורמט: |
channelProfile |
חובה. פרופיל הערוץ שבו נעשה שימוש בפריסה. |
createTime |
פלט בלבד. חותמת הזמן שבה הפריסה הזו נוצרה. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של הפריסה הזו. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
etag |
פלט בלבד. תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון ידרוס את כל השינויים שמתבצעים בו-זמנית. |
experimentConfig |
זה שינוי אופציונלי. הגדרת הניסוי לפריסה. |
whatsappCredentials |
זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל של ערוץ וואטסאפ, צריך להזין פרטי כניסה זמניים לוואטסאפ. |
instagramCredentials |
זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל של ערוץ אינסטגרם, צריך להזין פרטי כניסה זמניים לאינסטגרם. |
modelSettings |
זה שינוי אופציונלי. הגדרות המודל לפריסה. ההגדרות האלה מבטלות את ההגדרות של המודל שנקבעו ברמת האפליקציה או הסוכן. הערה: כדי לבטל את הגדרות המודל ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS. |
modality |
זה שינוי אופציונלי. אופן הפריסה. הערה: כדי להשתמש בהחלפת מודאליות ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS. |
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 |
פלט בלבד. השם של הדף העסקי ב-מטא שאוחזר. |
thumbnailUrl |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאוחזרה. |
description |
פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא. |
InstagramConfig
| ייצוג JSON |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| שדות | |
|---|---|
instagramAccountId |
חובה. מספר החשבון באינסטגרם. |
displayName |
פלט בלבד. השם של הדף העסקי ב-מטא שאוחזר. |
thumbnailUrl |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאוחזרה. |
description |
פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא. |
חותמת הזמן
| ייצוג 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, כולל. |
ExperimentConfig
| ייצוג JSON |
|---|
{
"versionRelease": {
object ( |
| שדות | |
|---|---|
versionRelease |
זה שינוי אופציונלי. גרסת ההפצה של הניסוי. |
VersionRelease
| ייצוג JSON |
|---|
{ "state": enum ( |
| שדות | |
|---|---|
state |
זה שינוי אופציונלי. המצב של השקת הגרסה. |
trafficAllocations[] |
זה שינוי אופציונלי. הקצאות תנועה לגרסה. |
TrafficAllocation
| ייצוג JSON |
|---|
{ "id": string, "trafficPercentage": integer, "appVersion": string } |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה של הקצאת התנועה. מחרוזת בפורמט חופשי, עד 128 תווים. |
trafficPercentage |
זה שינוי אופציונלי. אחוז התנועה בהקצאת התנועה. חייב להיות בין 0 ל-100. |
appVersion |
זה שינוי אופציונלי. גרסת האפליקציה של הקצאת התנועה. פורמט: |
WhatsAppCredentials
| ייצוג JSON |
|---|
{ "authCode": string, "pin": string, "phoneNumber": string, "businessAccountId": string, "wabaId": string, "conversationProfileId": string } |
| שדות | |
|---|---|
authCode |
חובה. קוד האימות של Meta שסופק על ידי תהליך ההרשמה המוטמע. |
pin |
חובה. קוד האימות בן 6 הספרות שנוצר על ידי המשתמש לאימות דו-שלבי. |
phoneNumber |
חובה. מספר הטלפון שרוצים לרשום בוואטסאפ. |
businessAccountId |
חובה. מזהה החשבון העסקי שבו רוצים להשתמש למספר הטלפון. |
wabaId |
חובה. מספר החשבון ב-WhatsApp Business. |
conversationProfileId |
זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה. |
InstagramCredentials
| ייצוג JSON |
|---|
{ "authCode": string, "conversationProfileId": string } |
| שדות | |
|---|---|
authCode |
חובה. קוד האימות של Meta שסופק על ידי תהליך ההרשמה המוטמע. |
conversationProfileId |
זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה. |
ModelSettings
| ייצוג JSON |
|---|
{ "model": string, // Union field |
| שדות | |
|---|---|
model |
זה שינוי אופציונלי. מודל ה-LLM שהסוכן צריך להשתמש בו. אם לא מגדירים מודל, הסוכן יקבל בירושה את המודל מהסוכן הראשי שלו. |
שדה איחוד הערך |
|
temperature |
זה שינוי אופציונלי. אם מוגדרת רמת אקראיות, היא תשמש את מודל ה-LLM. הטמפרטורה קובעת את רמת האקראיות של התשובות של המודל. טמפרטורות נמוכות יותר מפיקות תשובות צפויות יותר. טמפרטורות גבוהות יותר יוצרות תשובות יצירתיות יותר. |
ChannelType
סוג פרופיל הערוץ.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN |
סוג הערוץ לא ידוע. |
WEB_UI |
ערוץ בממשק משתמש באינטרנט. |
API |
ערוץ API. |
TWILIO |
ערוץ Twilio. |
GOOGLE_TELEPHONY_PLATFORM |
ערוץ Google Telephony Platform. |
CONTACT_CENTER_AS_A_SERVICE |
ערוץ Contact Center as a Service (CCaaS). |
CONTACT_CENTER_AS_A_SERVICE_CHAT |
ערוץ Contact Center as a Service (CCaaS Chat). |
FIVE9 |
ערוץ Five9. |
CONTACT_CENTER_INTEGRATION |
ערוץ שילוב של מרכז תמיכה של צד שלישי. |
WHATSAPP |
ערוץ וואטסאפ. |
INSTAGRAM |
ערוץ באינסטגרם. |
פרסונה
הפרסונה של הערוץ.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN |
פרסונה לא ידועה. |
CONCISE |
הסוכן שומר על תשובות תמציתיות וענייניות |
CHATTY |
הסוכן מספק הקשר, הסברים ופרטים נוספים |
מודליות
האופן שבו הווידג'ט מוצג באתר.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_UNSPECIFIED |
אופן השימוש לא ידוע. |
CHAT_AND_VOICE |
הווידג'ט תומך גם בצ'אט וגם בקלט קולי. |
VOICE_ONLY |
הווידג'ט תומך רק בהזנת קלט קולי. |
CHAT_ONLY |
הווידג'ט תומך רק בהזנת צ'אט. |
CHAT_VOICE_AND_VIDEO |
הווידג'ט תומך בקלט של צ'אט, קול ווידאו. |
עיצוב
העיצוב של הווידג'ט לאתר.
| טיפוסים בני מנייה (enum) | |
|---|---|
THEME_UNSPECIFIED |
עיצוב לא ידוע. |
LIGHT |
עיצוב בהיר. |
DARK |
עיצוב כהה. |
מדינה
מצב הניסוי.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATE_UNSPECIFIED |
מצב לא מוגדר. |
PENDING |
הוצא משימוש: המצב הזה כבר לא בשימוש. |
RUNNING |
מצב הפעלה. הניסוי פועל ותקף. |
DONE |
הוצא משימוש: המצב הזה כבר לא בשימוש. |
EXPIRED |
הוצא משימוש: המצב הזה כבר לא בשימוש. |
מודליות
אופן הפריסה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_UNSPECIFIED |
אופן השימוש לא ידוע. |
MODALITY_TEXT |
אופן הצגת הטקסט. |
MODALITY_VOICE |
אופן השימוש בקול. |
MODALITY_VIDEO |
אופן הצגת הווידאו. |
הערות על כלים
הערות על כלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כאל רמזים לא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשת אישור.
בנוסף למחרוזת הכותרת, מוגדרים הרמזים הבוליאניים הבאים:
-
readOnlyHint: אם הערך הוא true, הכלי לא משנה את הסביבה שלו. ברירת מחדל: false. -
destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא false, הכלי יכול לבצע רק פעולות של הוספה. ברירת מחדל: true. -
idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת מחדל: false. -
openWorldHint: אם הערך הוא True, הכלי יכול ליצור אינטראקציה עם 'עולם פתוח' של ישויות חיצוניות. אם הערך הוא false, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.
רמז הרסני: ✅ | רמז אידמפוטנטי: ❌ | רמז לקריאה בלבד: ❌ | רמז לעולם פתוח: ❌