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 该消息用于轮询助理会话的状态。
DISMISS 此消息用于关闭待审核的助理会话。这会将 Google 助理会话的状态更改为空闲。

AssistantOutput

助理智能体的输出。

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

object (AssistantMessage)

必需。助理智能体的回答。
userResponseSuggestions

object (UserResponseSuggestions)

仅限输出。助理智能体提供的建议用户回答。