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: ‏ v1beta.projects.locations

Methods
get GET /v1beta/{name=projects/*/locations/*}
קבלת מידע על מיקום.
getSecuritySettings GET /v1beta/{name=projects/*/locations/*/securitySettings}
מאחזר את הגדרות האבטחה של הפרויקט והמיקום.
list GET /v1beta/{name=projects/*}/locations
רשימת המיקומים שבהם השירות הזה נתמך.
updateSecuritySettings ‫PATCH /v1beta/{securitySettings.name=projects/*/locations/*/securitySettings}
מעדכן את הגדרות האבטחה של הפרויקט והמיקום.

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

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

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

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

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

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

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

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

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

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

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

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

משאב REST: ‏ v1beta.projects.locations.apps.evaluationDatasets

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

משאב REST: ‏ v1beta.projects.locations.apps.evaluationExpectations

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

משאב REST: ‏ v1beta.projects.locations.apps.evaluationRuns

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

משאב REST: ‏ v1beta.projects.locations.apps.evaluations

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

משאב REST: ‏ v1beta.projects.locations.apps.evaluations.results

Methods
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
מחיקת תוצאת בדיקה.
export POST /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results:export
מייצא את תוצאות הבדיקה.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
קבלת פרטים של תוצאת ההערכה שצוינה.
list GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results
מציג את כל תוצאות ההערכה להערכה נתונה.
runEvaluationResultMetrics POST /v1beta/{evaluationResultId=projects/*/locations/*/apps/*/evaluations/*/results/*}:runEvaluationResultMetrics
מפעיל מדדים על תוצאת הערכה קיימת.

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

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

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

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

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

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

משאב REST: ‏ v1beta.projects.locations.apps.scheduledEvaluationRuns

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

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

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

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

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

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

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

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

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

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

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

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

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