Method: projects.locations.collections.engines.assistants.assist

为用户的查询提供协助。

HTTP 请求

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。Assistant 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
字段
query

object (Query)

可选。当前用户查询。

仅在提供了 fileIds 时，系统才支持空查询。在这种情况下，回答将基于这些上下文文件生成。
session

string

可选。请求要使用的会话。如果指定了此字段，助理可以访问会话历史记录，并且查询和回答会存储在其中。

如果指定 - 作为会话 ID，或将其留空，则系统会创建一个具有自动生成 ID 的新会话。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

可选。用于确定助理在何种情况下不回答查询。如果跳过回答，原因将列在 AssistResponse.answer 内的 AssistAnswer.assist_skipped_reasons 中。
fileIds[]

string

可选。用于回答请求的文件 ID。上传文件时，其 ID 会在 AddContextFileResponse.file_id 中返回。
userMetadata

object (AssistUserMetadata)

可选。发起查询的用户的相关信息。
languageCode

string

可选。如果语言检测失败，用于回答的语言。也用作由操作创建的错误消息的语言，无论语言检测结果如何。
webGroundingEnabled

boolean

可选。如果设为 true，则启用基于网页搜索的溯源功能。仅当 Assistant.web_grounding_type 为 [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] 或 [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] 时有效。
dataStoreSpecs[]

object (DataStoreSpec)

可选。用于定义搜索调用中要过滤的 DataStore 以及这些数据存储区的配置的规范。仅在 Engine 具有多个数据存储区时，系统才会考虑使用此字段。

如果不设置此字段，系统将使用引擎中的所有数据存储区，但 ignoreDataStores 设置为 true 时除外。
assistGenerationConfig

object (AssistGenerationConfig)

可选。请求级生成配置。用于在引擎级别替换默认生成配置。
googleSearchGroundingEnabled
(deprecated)

boolean

可选。已弃用。请改用 webGroundingEnabled。

响应正文

对 AssistantService.Assist 方法的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string
}
字段
answer

object (AssistAnswer)

针对查询生成的 AssistAnswer 资源。
sessionInfo

object (SessionInfo)

会话信息。
assistToken

string

用于标识当前请求-响应对的全局唯一 ID。用于反馈和支持。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

  • discoveryengine.assistants.assist

如需了解详情，请参阅 IAM 文档。

AssistSkippingMode

辅助请求可用的跳过行为。

枚举
ASSIST_SKIPPING_MODE_UNSPECIFIED 默认值。如果查询的意图并非请求帮助，则可以跳过回答。
REQUEST_ASSIST 请求助理回答。如果查询未通过政策检查，系统仍可能会跳过回答。

SessionInfo

有关会话的信息。

JSON 表示法 
{
  "session": string,
  "queryId": string
}
字段
session

string

新生成的会话或现有会话的名称。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

与此辅助 API 调用对应的查询 ID。一个会话可以包含多个对话轮次，每个对话轮次都有一个唯一的查询 ID。

通过在 assistants.assist API 调用中指定会话名称和此查询 ID，系统会结合本次搜索调用的结果来处理辅助请求。