Method: projects.locations.dataStores.conversations.converse

进行一次对话。

HTTP 请求

POST https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要获取的对话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}。使用 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- 激活自动会话模式，该模式会在 conversations.converse 会话中自动创建新对话。

请求正文

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

JSON 表示法 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
字段
query

object (TextInput)

必需。当前用户输入。
servingConfig

string

要使用的服务配置的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId}。如果未设置，将使用默认服务配置。
conversation

object (Conversation)

仅供自动会话使用的对话。由于系统在自动会话中会自动为对话分配新的名称，因此名称字段将被忽略。
userLabels

map (key: string, value: string)

应用于资源的用户标签必须符合以下要求：

  • 每项资源可以有多个标签，但不能超过 64 个。
  • 每个标签都必须采用键值对形式。
  • 键的最小长度为 1 个字符，最大长度为 63 个字符，且不能为空。值可以为空，最大长度为 63 个字符。
  • 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。
  • 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。
  • 键必须以小写字母或国际字符开头。

如需了解详情，请参阅 Google Cloud 文档。
summarySpec

object (SummarySpec)

用于配置响应中返回的摘要的规范。
filter

string

过滤条件语法由一种表达式语言组成，用于根据要过滤的文档的一个或多个字段构造谓词。过滤条件表达式区分大小写。此字段将用于过滤搜索结果，可能会影响摘要响应。

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

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

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

object (BoostSpec)

提升规范，用于提升搜索结果中某些文档的排序权重，可能会影响对话响应。如需详细了解提升，请参阅提升

响应正文

如果成功，则响应正文包含一个 ConverseConversationResponse 实例。

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

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

  • discoveryengine.conversations.converse

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