Method: projects.locations.apps.chatAiAssistant

מפעיל את Arc, העוזר האישי מבוסס-AI, בסשן שצוין.

בקשת HTTP

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:chatAiAssistant

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

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

פרמטרים
app

string

חובה. האפליקציה שבה רוצים להפעיל את Assistant. פורמט: projects/{project}/locations/{location}/apps/{app}

גוף הבקשה

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

ייצוג ב-JSON 
{
  "assistantSession": string,
  "message": string,
  "attachedGcsUris": [
    string
  ],
  "contextToken": string
}
שדות
assistantSession

string

חובה. הסשן של Assistant שבו משתמשים כדי להפעיל את Assistant. פורמט: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

string

חובה. ההודעה שתישלח לנציג של Assistant.
attachedGcsUris[]

string

זה שינוי אופציונלי. מזהי URI של Cloud Storage לקבצים שהמשתמש העלה במהלך התור הזה. דוגמה: "gs://cxas-transient-uploads/uuid/prd.pdf"
contextToken

string

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

גוף התשובה

הודעת התשובה של AssistantService.ChatAiAssistant.

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

ייצוג ב-JSON 
{
  "eventId": string,
  "eventTime": string,
  "uiEvent": {
    object (UiEvent)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textChunk": string,
  "statusMessage": string,
  "sessionCheckpoint": {
    object (SessionCheckpoint)
  }
  // End of mutually exclusive fields.
}
שדות
eventId

string

המזהה הייחודי של האירוע.
eventTime

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".
uiEvent

object (UiEvent)

זה שינוי אופציונלי. המטען הייעודי (payload) של אירוע בממשק המשתמש.
המטען הייעודי (payload) של האירוע. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
textChunk

string

טוקן טקסט (לסטרימינג של תשובות מ-Gemini מילה אחר מילה)
statusMessage

string

עדכון סטטוס פשוט
sessionCheckpoint

object (SessionCheckpoint)

אירוע סיכום של נקודת בקרה או דחיסה של סשן, שמכיל את כוונת המשתמש (Intent) וסיכום מתגלגל.
סוף השדות שמוציאים זה את זה.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • ces.apps.update

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