Method: projects.locations.apps.runAssistant

為指定助理工作階段執行助理代理。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
app

string

這是必要旗標，要執行助理的應用程式。格式：projects/{project}/locations/{location}/apps/{app}

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
欄位
assistantSession

string

這是必要旗標，用於執行助理的助理工作階段。格式：projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

這是必要旗標，要傳送給助理代理的訊息。
interactionType

enum (RunAssistantRequest.InteractionType)

選用。助理訊息的不同互動類型。

回應主體

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 權限

需要 app 資源的下列 IAM 權限：

  • ces.apps.update

詳情請參閱 IAM 說明文件。

RunAssistantRequest.InteractionType

傳送給 Google 助理的訊息互動類型。

列舉
INTERACTION_TYPE_UNSPECIFIED 預設值。如未指定類型，系統會使用這個值。
NEW_MESSAGE 訊息是使用者輸入內容。使用者輸入內容會顯示在片段清單中。
POLL 這則訊息用於輪詢 Google 助理工作階段的狀態。
DISMISS 這則訊息用於關閉待審查的助理工作階段。這會將 Google 助理工作階段的狀態變更為閒置。

AssistantOutput

助理代理的輸出內容。

JSON 表示法 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
欄位
message

object (AssistantMessage)

這是必要旗標，助理代理的回覆。
userResponseSuggestions

object (UserResponseSuggestions)

僅供輸出。助理代理建議的使用者回覆。