Method: projects.locations.apps.assistantSessions.cancelAssistantTurn

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

בקשת HTTP

POST https://ces.googleapis.com/v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של הנתיב

פרמטרים
name

string

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "turnId": string
}
שדות
turnId

string

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

גוף התשובה

תגובה ל-assistantSessions.cancelAssistantTurn.

אם הפעולה מצליחה, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "cancelled": boolean
}
שדות
cancelled

boolean

אם נמצאה פנייה במהלך הטיסה והתבקשה להפסיק (ישירות במשימה הזו, או באמצעות הפקעה של תקופה לפנייה שמתארחת במקום אחר).

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • ces.assistantSessions.get

מידע נוסף זמין במאמרי העזרה בנושא IAM.