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

以流式方式协助用户进行查询。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

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

请求正文

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

JSON 表示法 
{
  "query": {
    object (Query)
  },
  "session": string,
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "agentsSpec": {
    object (AgentsSpec)
  },
  "toolsSpec": {
    object (ToolsSpec)
  },
  "generationSpec": {
    object (GenerationSpec)
  }
}
字段
query

object (Query)

可选。当前用户查询。

仅当提供 fileIds 时才支持空查询。在这种情况下，系统会根据这些上下文文件生成回答。
session

string

可选。用于请求的会话。如果指定了此参数，助理可以访问对话记录，并且查询和回答会存储在对话记录中。

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

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

object (AssistUserMetadata)

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

object (AgentsSpec)

可选。用于处理请求的代理的规范。
toolsSpec

object (ToolsSpec)

可选。用于处理请求的工具的规范。
generationSpec

object (GenerationSpec)

可选。请求的生成配置规范。

响应正文

对 AssistantService.StreamAssist 方法的响应。

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

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

object (AssistAnswer)

assistants.assist 回答资源对象，包含助理针对用户查询给出的最终回答的部分内容。

如果当前响应未向之前发送的 AssistAnswer.replies 添加任何内容，则不存在。

观察 AssistAnswer.state 以确定是否需要更多部分。当状态为 IN_PROGRESS 时，每个响应中的 AssistAnswer.replies 字段都将包含要附加到之前响应中收到的回复的回复（回复片段）。AssistAnswer.name 不会填充。

如果状态为 SUCCEEDED、FAILED 或 SKIPPED，则响应为最终响应，且 AssistAnswer.name 将具有一个值。
sessionInfo

object (SessionInfo)

会话信息。仅包含在响应流的最终 StreamAssistResponse 中。
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 文档。

AgentsSpec

用于处理请求的代理的规范。

JSON 表示法 
{
  "agentSpecs": [
    {
      object (AgentSpec)
    }
  ]
}
字段
agentSpecs[]

object (AgentSpec)

可选。用于处理请求的代理的规范。

AgentSpec

代理的规范。

JSON 表示法 
{
  "agentId": string
}
字段
agentId

string

必需。用于标识处理请求的代理资源的 ID。

此字段必须符合 RFC-1034 的要求，且长度上限为 63 个字符。

ToolsSpec

用于处理请求的工具的规范。

JSON 表示法 
{
  "vertexAiSearchSpec": {
    object (VertexAiSearchSpec)
  },
  "webGroundingSpec": {
    object (WebGroundingSpec)
  },
  "imageGenerationSpec": {
    object (ImageGenerationSpec)
  },
  "videoGenerationSpec": {
    object (VideoGenerationSpec)
  }
}
字段
vertexAiSearchSpec

object (VertexAiSearchSpec)

可选。Vertex AI Search 工具的规范。
webGroundingSpec

object (WebGroundingSpec)

可选。网络接地工具的规范。如果存在此字段，则启用基于网络搜索的接地。仅当 Assistant.web_grounding_type 为 [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] 或 [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] 时有效。
imageGenerationSpec

object (ImageGenerationSpec)

可选。图片生成工具的规范。
videoGenerationSpec

object (VideoGenerationSpec)

可选。视频生成工具的规范。

VertexAiSearchSpec

Vertex AI Search 工具的规范。

JSON 表示法 
{
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "filter": string
}
字段
dataStoreSpecs[]

object (DataStoreSpec)

可选。用于定义搜索调用中要过滤的 DataStore 和这些数据存储区的配置。仅针对具有多个数据存储区的 Engine 进行考虑。
filter

string

可选。过滤器语法使用一种表达式语言，可根据要过滤文档的一个或多个字段构建过滤条件。过滤表达式区分大小写。

如果此字段无法识别，则返回 INVALID_ARGUMENT。

Vertex AI Search 中的过滤是通过将 LHS 过滤键映射到 Vertex AI Search 后端中定义的键属性来完成的，此映射由客户在其架构中定义。例如，媒体客户的架构中可能包含“名称”字段。在这种情况下，过滤条件将如下所示：filter --> name:'ANY("king kong")'

如需详细了解过滤（包括语法和过滤运算符），请参阅过滤

WebGroundingSpec

此类型没有字段。

网络接地工具的规范。

ImageGenerationSpec

此类型没有字段。

图片生成工具的规范。

VideoGenerationSpec

此类型没有字段。

视频生成工具的规范。

GenerationSpec

请求的助理生成规范。这样，您就可以在引擎级替换默认的生成配置。

JSON 表示法 
{
  "modelId": string
}
字段
modelId

string

可选。用于生成式模型的 Vertex AI modelId。如果未设置，系统将使用默认的 Assistant 模型。

SessionInfo

有关会话的信息。

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

string

新生成的会话或继续的会话的名称。

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