MCP Tools Reference: ces.googleapis.com

כלי: 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": string
}
שדות
deployment

object (Deployment)

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

updateMask

string (FieldMask format)

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

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

פריסה

ייצוג JSON
{
  "name": string,
  "displayName": string,
  "appVersion": string,
  "channelProfile": {
    object (ChannelProfile)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "experimentConfig": {
    object (ExperimentConfig)
  },
  "whatsappCredentials": {
    object (WhatsAppCredentials)
  },
  "instagramCredentials": {
    object (InstagramCredentials)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "modality": enum (Modality)
}
שדות
name

string

מזהה. שם המשאב של הפריסה. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

displayName

string

חובה. השם המוצג של הפריסה.

appVersion

string

זה שינוי אופציונלי. שם המשאב של גרסת האפליקציה לפריסה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version} כדי להשתמש באפליקציית הטיוטה, צריך להשתמש ב-projects/{project}/locations/{location}/apps/{app}/versions/-.

channelProfile

object (ChannelProfile)

חובה. פרופיל הערוץ שבו נעשה שימוש בפריסה.

createTime

string (Timestamp format)

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

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

updateTime

string (Timestamp format)

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

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

etag

string

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

experimentConfig

object (ExperimentConfig)

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

whatsappCredentials

object (WhatsAppCredentials)

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

instagramCredentials

object (InstagramCredentials)

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

modelSettings

object (ModelSettings)

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

modality

enum (Modality)

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

ChannelProfile

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

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

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

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

string

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

channelType

enum (ChannelType)

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

personaProperty

object (PersonaProperty)

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

webWidgetConfig

object (WebWidgetConfig)

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

whatsappConfig

object (WhatsAppConfig)

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

instagramConfig

object (InstagramConfig)

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

שדה איחוד _disable_dtmf.

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

disableDtmf

boolean

זה שינוי אופציונלי. האם להשבית את DTMF (טון זוגי מרובה תדרים).

שדה איחוד _disable_barge_in_control.

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

disableBargeInControl

boolean

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

שדה איחוד _noise_suppression_level.

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

noiseSuppressionLevel

string

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

PersonaProperty

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

enum (Persona)

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

WebWidgetConfig

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

enum (Modality)

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

theme

enum (Theme)

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

webWidgetTitle

string

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

securitySettings

object (SecuritySettings)

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

SecuritySettings

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

boolean

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

enableOriginCheck

boolean

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

allowedOrigins[]

string

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

enableRecaptcha

boolean

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

WhatsAppConfig

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

string

חובה. מספר החשבון ב-WhatsApp Business.

phoneNumberId

string

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

phoneNumber

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

InstagramConfig

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

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

חותמת הזמן

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

string (int64 format)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ‏1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).

nanos

integer

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

ExperimentConfig

ייצוג JSON
{
  "versionRelease": {
    object (VersionRelease)
  }
}
שדות
versionRelease

object (VersionRelease)

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

VersionRelease

ייצוג JSON
{
  "state": enum (State),
  "trafficAllocations": [
    {
      object (TrafficAllocation)
    }
  ]
}
שדות
state

enum (State)

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

trafficAllocations[]

object (TrafficAllocation)

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

TrafficAllocation

ייצוג JSON
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
שדות
id

string

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

trafficPercentage

integer

זה שינוי אופציונלי. אחוז התנועה בהקצאת התנועה. חייב להיות בין 0 ל-100.

appVersion

string

זה שינוי אופציונלי. גרסת האפליקציה של הקצאת התנועה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

ייצוג JSON
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
שדות
authCode

string

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

pin

string

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

phoneNumber

string

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

businessAccountId

string

חובה. מזהה החשבון העסקי שבו רוצים להשתמש למספר הטלפון.

wabaId

string

חובה. מספר החשבון ב-WhatsApp Business.

conversationProfileId

string

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

InstagramCredentials

ייצוג JSON
{
  "authCode": string,
  "conversationProfileId": string
}
שדות
authCode

string

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

conversationProfileId

string

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

ModelSettings

ייצוג JSON
{
  "model": string,

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

string

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

שדה איחוד _temperature.

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

temperature

number

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

FieldMask

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

string

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

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 (ChannelProfile)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "experimentConfig": {
    object (ExperimentConfig)
  },
  "whatsappCredentials": {
    object (WhatsAppCredentials)
  },
  "instagramCredentials": {
    object (InstagramCredentials)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "modality": enum (Modality)
}
שדות
name

string

מזהה. שם המשאב של הפריסה. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

displayName

string

חובה. השם המוצג של הפריסה.

appVersion

string

זה שינוי אופציונלי. שם המשאב של גרסת האפליקציה לפריסה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version} כדי להשתמש באפליקציית הטיוטה, צריך להשתמש ב-projects/{project}/locations/{location}/apps/{app}/versions/-.

channelProfile

object (ChannelProfile)

חובה. פרופיל הערוץ שבו נעשה שימוש בפריסה.

createTime

string (Timestamp format)

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

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

updateTime

string (Timestamp format)

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

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

etag

string

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

experimentConfig

object (ExperimentConfig)

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

whatsappCredentials

object (WhatsAppCredentials)

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

instagramCredentials

object (InstagramCredentials)

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

modelSettings

object (ModelSettings)

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

modality

enum (Modality)

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

ChannelProfile

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

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

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

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

string

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

channelType

enum (ChannelType)

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

personaProperty

object (PersonaProperty)

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

webWidgetConfig

object (WebWidgetConfig)

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

whatsappConfig

object (WhatsAppConfig)

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

instagramConfig

object (InstagramConfig)

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

שדה איחוד _disable_dtmf.

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

disableDtmf

boolean

זה שינוי אופציונלי. האם להשבית את DTMF (טון זוגי מרובה תדרים).

שדה איחוד _disable_barge_in_control.

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

disableBargeInControl

boolean

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

שדה איחוד _noise_suppression_level.

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

noiseSuppressionLevel

string

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

PersonaProperty

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

enum (Persona)

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

WebWidgetConfig

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

enum (Modality)

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

theme

enum (Theme)

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

webWidgetTitle

string

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

securitySettings

object (SecuritySettings)

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

SecuritySettings

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

boolean

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

enableOriginCheck

boolean

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

allowedOrigins[]

string

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

enableRecaptcha

boolean

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

WhatsAppConfig

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

string

חובה. מספר החשבון ב-WhatsApp Business.

phoneNumberId

string

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

phoneNumber

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

InstagramConfig

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

string

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

displayName

string

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

thumbnailUrl

string

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

description

string

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

חותמת הזמן

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

string (int64 format)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ‏1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).

nanos

integer

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

ExperimentConfig

ייצוג JSON
{
  "versionRelease": {
    object (VersionRelease)
  }
}
שדות
versionRelease

object (VersionRelease)

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

VersionRelease

ייצוג JSON
{
  "state": enum (State),
  "trafficAllocations": [
    {
      object (TrafficAllocation)
    }
  ]
}
שדות
state

enum (State)

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

trafficAllocations[]

object (TrafficAllocation)

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

TrafficAllocation

ייצוג JSON
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
שדות
id

string

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

trafficPercentage

integer

זה שינוי אופציונלי. אחוז התנועה בהקצאת התנועה. חייב להיות בין 0 ל-100.

appVersion

string

זה שינוי אופציונלי. גרסת האפליקציה של הקצאת התנועה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

ייצוג JSON
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
שדות
authCode

string

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

pin

string

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

phoneNumber

string

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

businessAccountId

string

חובה. מזהה החשבון העסקי שבו רוצים להשתמש למספר הטלפון.

wabaId

string

חובה. מספר החשבון ב-WhatsApp Business.

conversationProfileId

string

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

InstagramCredentials

ייצוג JSON
{
  "authCode": string,
  "conversationProfileId": string
}
שדות
authCode

string

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

conversationProfileId

string

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

ModelSettings

ייצוג JSON
{
  "model": string,

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

string

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

שדה איחוד _temperature.

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

temperature

number

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

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