Gemini Enterprise for Customer Experience API

Service: ces.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה צריכה להשתמש בספריות משלה כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כשמבצעים את בקשות ה-API.

מסמך Discovery

Discovery Document הוא מפרט שניתן לקריאה על ידי מחשב, שמתאר ומאפשר שימוש בממשקי API ל-REST. היא משמשת לבניית ספריות לקוח, תוספים ל-IDE וכלים אחרים שמתקשרים עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך Discovery הבא:

נקודת קצה של שירות

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. יכול להיות שלשירות אחד יהיו כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה (endpoint) וה-URI שמופיעים בהמשך הם יחסיים לנקודת הקצה הזו:

  • https://ces.googleapis.com

משאב REST: ‏ tasks

Methods
cancel POST /tasks/{id}:cancel
ביטול משימה בתהליך.
get GET /tasks/{id}
מקבל את המצב האחרון של משימה.
list GET /tasks
מציג רשימה של משימות שתואמות למסנן שצוין.
subscribe GET /tasks/{id}:subscribe
הרשמה לעדכונים על משימות שלא נמצאות במצב סופי.

משאב REST: ‏ tasks.pushNotificationConfigs

Methods
create POST /tasks/{taskId}/pushNotificationConfigs
יצירת הגדרת התראה על משימה.
delete DELETE /tasks/{taskId}/pushNotificationConfigs/{id}
מחיקת הגדרת התראה על משימה.
get GET /tasks/{taskId}/pushNotificationConfigs/{id}
אחזור הגדרת התראות פוש למשימה.
list GET /tasks/{taskId}/pushNotificationConfigs
קבלת רשימה של התראות פוש שהוגדרו למשימה.

משאב REST: ‏ v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
קבלת מידע על מיקום.
list GET /v1/{name=projects/*}/locations
רשימת המיקומים הנתמכים בשירות הזה.

משאב REST: ‏ v1.projects.locations.apps

Methods
create POST /v1/{parent=projects/*/locations/*}/apps
יוצר אפליקציה חדשה בפרויקט ובמיקום שצוינו.
delete DELETE /v1/{name=projects/*/locations/*/apps/*}
מוחק את האפליקציה שצוינה.
executeTool POST /v1/{parent=projects/*/locations/*/apps/*}:executeTool
מפעיל את הכלי שצוין עם הארגומנטים שצוינו.
exportApp POST /v1/{name=projects/*/locations/*/apps/*}:exportApp
מייצא את האפליקציה שצוינה.
get GET /v1/{name=projects/*/locations/*/apps/*}
מקבל פרטים של האפליקציה שצוינה.
getExtendedAgentCard GET /v1/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
מקבל את כרטיס הסוכן המורחב של הסוכן המאומת.
importApp POST /v1/{parent=projects/*/locations/*}/apps:importApp
מייבא את האפליקציה שצוינה.
list ‫GET /v1/{parent=projects/*/locations/*}/apps
מציג רשימה של אפליקציות בפרויקט ובמיקום שצוינו.
patch PATCH /v1/{app.name=projects/*/locations/*/apps/*}
מעדכן את האפליקציה שצוינה.
retrieveToolSchema POST /v1/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
אחזור הסכימה של הכלי הנתון.

משאב REST: ‏ v1.projects.locations.apps.agents

Methods
create POST /v1/{parent=projects/*/locations/*/apps/*}/agents
יצירת סוכן חדש באפליקציה הנתונה.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/agents/*}
מוחק את הסוכן שצוין.
get GET /v1/{name=projects/*/locations/*/apps/*/agents/*}
קבלת פרטים על הסוכן שצוין.
list GET /v1/{parent=projects/*/locations/*/apps/*}/agents
מציג רשימה של נציגים באפליקציה הנתונה.
patch PATCH /v1/{agent.name=projects/*/locations/*/apps/*/agents/*}
מעדכן את הסוכן שצוין.

משאב REST: ‏ v1.projects.locations.apps.changelogs

Methods
get GET /v1/{name=projects/*/locations/*/apps/*/changelogs/*}
מקבל את יומן השינויים שצוין.
list GET /v1/{parent=projects/*/locations/*/apps/*}/changelogs
מציג את יומני השינויים של האפליקציה שצוינה.

משאב REST: ‏ v1.projects.locations.apps.conversations

Methods
batchDelete POST /v1/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
מחיקה של כמה שיחות בבת אחת.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/conversations/*}
מחיקת השיחה שצוינה.
get GET /v1/{name=projects/*/locations/*/apps/*/conversations/*}
מקבל פרטים של השיחה שצוינה.
list GET /v1/{parent=projects/*/locations/*/apps/*}/conversations
מציג רשימה של שיחות באפליקציה שצוינה.

משאב REST: ‏ v1.projects.locations.apps.deployments

Methods
create POST /v1/{parent=projects/*/locations/*/apps/*}/deployments
יוצר פריסה חדשה באפליקציה הנתונה.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/deployments/*}
מוחק את הפריסה שצוינה.
get GET /v1/{name=projects/*/locations/*/apps/*/deployments/*}
הצגת פרטים של פריסה ספציפית.
getExtendedAgentCard GET /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard
מקבל את כרטיס הסוכן המורחב של הסוכן המאומת.
list GET /v1/{parent=projects/*/locations/*/apps/*}/deployments
מציג את הפריסות באפליקציה שצוינה.
patch PATCH /v1/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
מעדכן את הפריסה שצוינה.

משאב REST: ‏ v1.projects.locations.apps.deployments.message

Methods
send POST /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
שליחת הודעה לנציג.
stream POST /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream
שולחת הודעת סטרימינג לנציג, ומאפשרת אינטראקציה בזמן אמת ועדכוני סטטוס.

משאב REST: ‏ v1.projects.locations.apps.examples

Methods
create POST /v1/{parent=projects/*/locations/*/apps/*}/examples
יוצר דוגמה חדשה באפליקציה הנתונה.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/examples/*}
מוחק את הדוגמה שצוינה.
get GET /v1/{name=projects/*/locations/*/apps/*/examples/*}
מקבל פרטים על הדוגמה שצוינה.
list GET /v1/{parent=projects/*/locations/*/apps/*}/examples
מציג דוגמאות באפליקציה שצוינה.
patch PATCH /v1/{example.name=projects/*/locations/*/apps/*/examples/*}
מעדכן את הדוגמה שצוינה.

משאב REST: ‏ v1.projects.locations.apps.guardrails

Methods
create POST /v1/{parent=projects/*/locations/*/apps/*}/guardrails
יוצרת אמצעי הגנה חדש באפליקציה הנתונה.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/guardrails/*}
מוחק את אמצעי הבקרה שצוין.
get GET /v1/{name=projects/*/locations/*/apps/*/guardrails/*}
קבלת פרטים על אמצעי הבקרה שצוין.
list GET /v1/{parent=projects/*/locations/*/apps/*}/guardrails
מציג את אמצעי הבקרה ברשימות באפליקציה הנתונה.
patch PATCH /v1/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
מעדכן את אמצעי הבקרה שצוין.

משאב REST: ‏ v1.projects.locations.apps.message

Methods
send POST /v1/{tenant=projects/*/locations/*/apps/*}/message:send
שליחת הודעה לנציג.
stream POST /v1/{tenant=projects/*/locations/*/apps/*}/message:stream
שולחת הודעת סטרימינג לנציג, ומאפשרת אינטראקציה בזמן אמת ועדכוני סטטוס.

משאב REST: ‏ v1.projects.locations.apps.sessions

Methods
generateChatToken POST /v1/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken
יוצר אסימון בהיקף סשן לווידג'ט של הצ'אט לצורך אימות באמצעות ממשקי Session API.
runSession POST /v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
מתחיל אינטראקציה חד-שלבית עם סוכן CES במהלך סשן.
streamRunSession POST /v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
מפעיל אינטראקציה של תור אחד עם נציג CES.

משאב REST: ‏ v1.projects.locations.apps.tools

Methods
create POST /v1/{parent=projects/*/locations/*/apps/*}/tools
יוצר כלי חדש באפליקציה שצוינה.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/tools/*}
מחיקת הכלי שצוין.
get GET /v1/{name=projects/*/locations/*/apps/*/tools/*}
מקבל פרטים על הכלי שצוין.
list GET /v1/{parent=projects/*/locations/*/apps/*}/tools
מציג את כלי הרשימות באפליקציה שצוינה.
patch PATCH /v1/{tool.name=projects/*/locations/*/apps/*/tools/*}
מעדכן את הכלי שצוין.

משאב REST: ‏ v1.projects.locations.apps.toolsets

Methods
create POST /v1/{parent=projects/*/locations/*/apps/*}/toolsets
יוצר ערכת כלים חדשה באפליקציה הנתונה.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/toolsets/*}
מחיקת ערכת הכלים שצוינה.
get GET /v1/{name=projects/*/locations/*/apps/*/toolsets/*}
מקבל פרטים של ערכת הכלים שצוינה.
list GET /v1/{parent=projects/*/locations/*/apps/*}/toolsets
מציג את ערכות הכלים באפליקציה שצוינה.
patch PATCH /v1/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
מעדכן את ערכת הכלים שצוינה.
retrieveTools POST /v1/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
אחזור רשימת הכלים שכלולים בערכת הכלים שצוינה.

משאב REST: ‏ v1.projects.locations.apps.versions

Methods
create ‫POST /v1/{parent=projects/*/locations/*/apps/*}/versions
יוצר גרסה חדשה של האפליקציה באפליקציה שצוינה.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/versions/*}
מוחק את גרסת האפליקציה שצוינה.
get GET /v1/{name=projects/*/locations/*/apps/*/versions/*}
מקבל פרטים על גרסת האפליקציה שצוינה.
getExtendedAgentCard GET /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard
מקבל את כרטיס הסוכן המורחב של הסוכן המאומת.
list GET /v1/{parent=projects/*/locations/*/apps/*}/versions
רשימה של כל גרסאות האפליקציה באפליקציה הנתונה.
patch PATCH /v1/{appVersion.name=projects/*/locations/*/apps/*/versions/*}
מעדכן את גרסת האפליקציה שצוינה.
restore POST /v1/{name=projects/*/locations/*/apps/*/versions/*}:restore
משחזר את גרסת האפליקציה שצוינה.

משאב REST: ‏ v1.projects.locations.apps.versions.message

Methods
send POST /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
שליחת הודעה לנציג.
stream POST /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream
שולחת הודעת סטרימינג לנציג, ומאפשרת אינטראקציה בזמן אמת ועדכוני סטטוס.

משאב REST: ‏ v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
מתחילה ביטול אסינכרוני של פעולה ממושכת.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
מחיקת פעולה ממושכת.
get ‫GET /v1/{name=projects/*/locations/*/operations/*}
אחזור המצב העדכני של פעולה ממושכת.
list GET /v1/{name=projects/*/locations/*}/operations
רשימת הפעולות שתואמות למסנן שצוין בבקשה.