配置高级自动补全功能

实验性

此功能须遵守服务专用条款的“通用服务条款”部分中的“非正式版产品条款”。 非正式版功能“按原样”提供，可能只能获得有限的支持。 如需了解详情，请参阅发布阶段说明。

重要提示：部分 Google Cloud 客户可以使用高级自动补全功能。如需了解详情或注册以使用此功能，请联系你的 Google Cloud 销售代表。

本页介绍 Vertex AI Search 的高级自动补全功能。

与基本自动补全功能一样，高级自动补全功能会根据用户为查询输入的前几个字符生成查询建议。

在阅读本页内容之前，请先熟悉 Vertex AI Search 的基本自动补全功能。请参阅配置自动补全。

高级自动补全功能的主要功能

高级自动补全与基本自动补全的区别在于其具有以下关键功能：

• 混合搜索：高级自动补全功能可与混合搜索应用搭配使用，这些应用是指与多个数据存储区关联的通用搜索应用。

• 访问权限控制：高级自动补全功能遵循访问权限控制设置。（访问控制也称为 ACL，即访问控制列表。）高级 自动填充功能只会提供与 所有资源。如需了解访问权限控制，请参阅使用数据源访问权限控制。

• 语言提升：可设置高级自动补全功能，以提升语言质量 语言。例如，如果浏览器语言为荷兰语，则自动补全 提升翻译质量。如需了解详情，请参阅 发送带有语言提升功能的自动补全请求。

• 不同类型的建议：借助高级自动补全功能， 常规的自动填充查询建议，您可以指定 不同类型的建议

  • 丰富的建议：用户会收到与他们输入的字母匹配的标题前缀的文档相关信息，这些信息以自动补全建议的形式显示。如需了解详情，请参阅发送自动补全请求并返回丰富的建议。

  • 近期查询：作为自动补全建议，用户可获取其近期的查询 与所输入的字母前缀匹配的查询。 有关详情，请参阅发送“自动补全”请求并返回近期的 查询。

发送自动补全请求

以下示例展示了如何使用 completionConfig.completeQuery 方法发送高级自动补全请求。

REST

若要使用 API 发送自动补全请求，请按以下步骤操作：

1. 找到您的应用 ID。如果您已经有应用 ID，请跳至下一步。

   1. 在 Google Cloud 控制台中，前往 Agent Builder 页面。

      前往“应用”

   2. 在应用页面上，找到应用的名称，然后从 ID 列中获取应用的 ID。

2. 调用 completionConfig.completeQuery 方法。

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING"
       }'
   

   • PROJECT_ID：您的 Google Cloud 项目的 ID。

   • APP_ID：Vertex AI Search 应用的 ID。

   • QUERY_STRING：用于提取建议的预测性输入。

发送带有语言提升功能的自动补全请求

您可以根据语言代码提升嵌入自动补全建议， 例如，提高或降低某些语言的自动补全建议显示的可能性。

增强值必须介于 -1 到 1 之间。设置负数“生日” 以该语言显示自动填充建议，正数 语言。

使用 BCP 47 定义的两个字母语言标记，例如 en、fr、hi 和 zh。

REST

如需发送包含语言提升值的自动补全请求，请执行以下操作： 请按以下步骤操作：

1. 找到您的应用 ID。如果您已经拥有应用 ID，请跳至下一步。

   1. 在 Google Cloud 控制台中，前往 Agent Builder 页面。

      前往“应用”

   2. 在应用页面上，找到应用的名称，然后从 ID 列中获取应用的 ID。

2. 调用 completionConfig.completeQuery 方法。

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "boostSpec": {
            "conditionBoostSpecs": [{
              "condition": "(langCode: ANY(LANG_CODE))",
              "boost": BOOST_VALUE
            }]
         }
       }'
   
   

   • PROJECT_ID：您的 Google Cloud 项目的 ID。

   • APP_ID：Vertex AI Search 应用的 ID。

   • QUERY_STRING：用于提取建议的预输入输入。

   • LANG_CODE：一种或多种语言的双字母代码。 使用转义引号。例如，\"fr\", \"es\" 用于将提升值应用于西班牙语和法语。

   • BOOST_VALUE：介于 -1 和 1 之间的浮点数。时间 值为负，则语言的自动建议被降位（ 在建议列表中较低的位置）。该值为 肯定的，系统会提升建议（它们在列表中的位置较靠前）。

   示例命令

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)"
   -H "Content-Type: application/json"
   "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery"
   -d '{
        "query": { "text": "Co"}
        "boostSpec": {
           "conditionBoostSpecs": [{
             "condition": "(langCode: ANY(\"es\", \"fr\"))",
             "boost": 0.75 }, {
             "condition": "(langCode: ANY(\"en\"))",
             "boost": -1
           }]
         }
       }'
    

   在此示例中，如果查询 Co 的自动补全建议是法语或西班牙语，则会被提升（在自动补全建议列表中排名靠前）；如果是英语，则会被隐藏（在自动补全建议列表中排名靠后）。

发送自动补全请求并返回丰富的建议

丰富的自动补全功能会返回标题中包含字词的内容（文档） 。

除了文档标题之外，自动补全请求还会返回 source_type 和 entity_type，以及关键属性（如果有）：uri、create_time 和 update_time。您可以在数据存储区页面的架构标签页上查看和修改键属性映射。

与所有高级自动补全建议一样，系统会遵循建议的任何文档的 ACL。

示例

员工正在查询公司内部网站，寻找有关访问权限的技术信息。

员工开始输入 tec，系统可能会返回以下文档：Data technicians handbook、Access technology guide 和 Techniques for troubleshooting access issues。

借助丰富的建议功能，您可以针对这些建议的每个文档显示以下所有文档信息：文档标题 (title)、文档链接 (uri)、上次更新时间 (update_time) 和来源 (source_type)，例如文档是在 Confluence Cloud 还是 Slack 中找到的。知道如何操作 最近有一份文档被更新了，该文档的来源有助于 员工选择首先查看的文档。

限制

丰富的自动补全功能仅适用于第三方连接器，并且仅适用于这些第三方连接器的特定实体数据存储区。下表显示了 哪些实体支持哪些连接器。

第三方连接器	支持的实体
Box	文件
Confluence Cloud	页面	空格
Dropbox	文件
Jira Cloud	问题	空格
OneDrive	文件
Salesforce	账号	潜在客户	机会
ServiceNow	突发事件	知识
Sharepoint Online	附件	事件	文件	页面
Slack	消息

过程

如需发送会返回丰富建议的自动补全请求，请按以下步骤操作：

REST

1. 找到您的应用 ID。如果您已经拥有应用 ID，请跳至下一步。

   1. 在 Google Cloud 控制台中，前往 Agent Builder 页面。

      前往“应用”页面

   2. 在应用页面上，找到应用的名称，然后从 ID 列中获取应用的 ID。

2. 调用 completionConfig.completeQuery 方法。

   
   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "completionConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig",
         "suggestionTypes": ["CONTENT"]
       }'
   
   

   • PROJECT_ID：您的 Google Cloud 项目的 ID。

   • APP_ID：Vertex AI Search 应用的 ID。

   • QUERY_STRING：用于提取建议的预测性输入。

   • DATA_STORE_ID：Vertex AI Search 数据存储区的 ID。

   命令和结果示例

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)"
   -H "Content-Type: application/json"
   "https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery"
   - d {
         "completionConfig": "projects/123456/locations/us/collections/default_collection/dataStores/my-data-store/completionConfig",
         "query": "C",
         "suggestionTypes": ["CONTENT"]
       }
   
   {
     "contentSuggestions": [{
       "suggestion": "critical crash in payment module",
       "document": {
         "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/10000",
         "derivedStructData": {
           "title": "Critical Crash in Payment Module",
           "uri": "https://cymballabs.atlassian.net/browse/CPT-1",
           "source_type": "jira",
           "entity_type": "issue"
         }
       },
       "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
     }]
   }
   
   

注意：如果您将 suggestionTypes 指定为 CONTENT，则 curl 命令中的所有 boostSpec、queryModel 或 includeTailSuggestions 参数都会被忽略。

发送自动补全请求并返回最近的查询

返回与请求中的查询匹配前缀的用户最近查询的列表作为建议。

系统会按照时间由近到远的顺序列出匹配的查询建议。如需使用近期搜索功能，必须提供用户伪 ID。

示例

一名员工正在查询其公司的 Intranet 网站，以获取有关 去度假该员工执行了以下查询，按时间顺序（从最近到最早）列出：

PTO、Vacation blackout periods、How much vacation time do I have?、Time off、Vacation policy、covering a vacant position during absences 和 Can I take unpaid time off?。

现在，当员工在搜索框中输入 vac 时， 自动补全建议将如下所示：

• Vacation blackout periods
• How much vacation time do I have?
• Vacation policy
• Covering a vacant position during absences

过程

如需发送自动补全请求以返回用户的最新查询，请按以下步骤操作：

REST

1. 找到您的应用 ID。如果您已经有应用 ID，请跳至下一步。

   1. 在 Google Cloud 控制台中，前往 Agent Builder 页面。

      前往“应用”页面

   2. 在应用页面上，找到应用的名称，并从以下位置获取应用 ID： ID 列中的值。

2. 调用 completionConfig.completeQuery 方法。

   
   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "completionConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId: "USER_PSEUDO_ID"
       }'
   
   

   • PROJECT_ID：您的 Google Cloud 项目的 ID。

   • APP_ID：Vertex AI Search 应用的 ID。

   • QUERY_STRING：用于提取建议的预测性输入。

   • DATA_STORE_ID：Vertex AI Search 数据存储区的 ID。

   • USER_PSEUDO_ID：用户的假名化标识符。您 可以为此字段使用 HTTP Cookie，该 Cookie 可唯一标识 单个设备上的访问者。请勿将此字段设置为相同的标识符 多个用户这会合并他们的查询历史记录。错误做法 在此字段中包含个人身份信息 (PII)。

   命令和结果示例

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)"
   -H "Content-Type: application/json"
   "https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery"
   - d '{
         "completionConfig": "projects/123456/locations/us/collections/default_collection/dataStores/my-data-store/completionConfig",
         "query": "C",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId: "test_user"
       }
   
   {
     "contentSuggestions": [{
       "suggestion": "critical crash in payment module",
       "document": {
         "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/10000",
         "derivedStructData": {
           "title": "Critical Crash in Payment Module",
           "uri": "https://cymballabs.atlassian.net/browse/CPT-1",
           "source_type": "jira",
           "entity_type": "issue"
         }
       },
       "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
     }]
   }
   

注意：如果您将 suggestionTypes 指定为 RECENT_SEARCH，则 curl 命令中的所有 boostSpec、queryModel 或 includeTailSuggestions 参数都会被忽略。

使用自动补全拒绝名单

您可以使用拒绝名单来防止特定字词显示为自动补全建议。

虽然高级自动补全功能是应用级的，但拒绝名单是应用级的 数据存储区层级的数据。如果您的应用是混合搜索应用，这一点非常重要。 为连接到应用的每个数据存储区创建一个拒绝名单。

如需了解如何创建和使用拒绝名单，请参阅使用自动补全拒绝名单。