Method: projects.locations.apps.runAssistant

מפעיל את סוכן Assistant בסשן שצוין.

בקשת HTTP

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

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

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

פרמטרים
app

string

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
שדות
assistantSession

string

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

object (AssistantMessage)

חובה. ההודעה שתישלח לנציג של Assistant.
interactionType

enum (RunAssistantRequest.InteractionType)

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

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
שדות
output

object (AssistantOutput)

חובה. הפלט מהעוזר הדיגיטלי.
state

enum (AssistantSessionState)

פלט בלבד. סטטוס הסשן של העוזר הדיגיטלי.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • ces.apps.update

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

RunAssistantRequest.InteractionType

סוג האינטראקציה של ההודעה שנשלחה ל-Assistant.

טיפוסים בני מנייה (enum)
INTERACTION_TYPE_UNSPECIFIED ערך ברירת המחדל. המערכת משתמשת בערך הזה אם הסוג לא צוין.
NEW_MESSAGE ההודעה היא קלט מהמשתמש. הקלט מהמשתמש מופיע ברשימת החלקים.
POLL ההודעה מיועדת לדגימת המצב של הסשן ב-Assistant.
DISMISS ההודעה נועדה לסגור את הסשן של Assistant שממתין לבדיקה. הפעולה הזו תעביר את הסשן של Assistant למצב המתנה.

AssistantOutput

הפלט מהעוזר הדיגיטלי.

ייצוג ב-JSON 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
שדות
message

object (AssistantMessage)

חובה. התשובה מהסוכן של Assistant.
userResponseSuggestions

object (UserResponseSuggestions)

פלט בלבד. הצעות לתשובות של המשתמש מהסוכן של Assistant.