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

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

HTTP 请求

POST https://discoveryengine.googleapis.com/v1/{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,
  "invocationTools": [
    string
  ],
  "invokedSkills": [
    {
      object (InvokedSkill)
    }
  ],
  "connectorAuthErrors": [
    {
      object (ConnectorAuthError)
    }
  ]
}
字段
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。用于反馈和支持。
invocationTools[]

string

已调用的工具的工具名称。
invokedSkills[]

object (InvokedSkill)

相应回合内执行的技能。
connectorAuthErrors[]

object (ConnectorAuthError)

在请求期间遇到的每个连接器身份验证错误。当一个或多个连接器身份验证失败，但请求继续使用剩余的连接器时，会显示此元素。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.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 后端中定义的键属性来完成的，此映射由客户在其架构中定义。例如，媒体客户的架构中可能包含“name”字段。在这种情况下，过滤条件将如下所示：filter --> name:'ANY("king kong")'

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

WebGroundingSpec

此类型没有字段。

网页接地工具的规范。

ImageGenerationSpec

此类型没有字段。

图片生成工具的规范。

VideoGenerationSpec

此类型没有字段。

视频生成工具的规范。

GenerationSpec

用于请求的助理生成规范。可在引擎级别替换默认生成配置。

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

string

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

SessionInfo

有关会话的信息。

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

string

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

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

InvokedSkill

表示在辅助通话期间使用的技能。

JSON 表示法 
{
  "name": string,
  "displayName": string
}
字段
name

string

技能的资源名称。
displayName

string

技能的显示名称。

ConnectorAuthError

描述特定数据连接器的身份验证错误。

JSON 表示法 
{
  "dataConnector": string,
  "errorMessage": string
}
字段
dataConnector

string

未能通过身份验证的数据连接器的资源名称。
errorMessage

string

描述身份验证失败的人类可读错误消息。