VS Code 中由必应驱动的设置搜索
2018 年 4 月 25 日，作者：Rob Lourens @roblourens 和 Ankith Karat [email protected]
您是否曾经在 VS Code 中难以找到某个特定设置？您并不孤单。通过查看常见的 GitHub 问题、StackOverflow 问题、推文以及我们进行的用户研究，我们发现许多用户在查找设置方面遇到了问题。考虑到 VS Code 自带超过 400 个设置，并且随着扩展的安装，许多用户可能会拥有更多设置，因此这并不奇怪。如果包括典型的用户错误，例如拼写错误以及选择正确搜索词的挑战，用户会难以找到设置。
因此，几个月前，我们开始与必应团队讨论他们是否可以将他们的搜索专业知识应用于我们的问题。两个月前，我们发布了结果 - 由必应提供支持的智能设置搜索体验。
之前
之后
工作原理
经过一段时间的讨论和原型设计，我们决定采用一种安排，其中必应团队将运行一个设置搜索服务，该服务将为用户在 VS Code 的设置编辑器中搜索的查询提供智能模糊设置匹配。
将必应的自然语言搜索功能集成到 VS Code 中被证明具有挑战性。为了搜索网络上的文档，必应考虑了与页面相似性、点击数据、用户行为数据等相关的数千个信号。但我们没有针对我们的设置提供这种丰富的元数据 - 只是每个设置的简短名称和描述。因此，必应团队结合了自定义服务和必应的基本搜索功能，创建了一个针对我们的搜索场景进行优化的系统。
以下是系统的概览
让我们看看每个部分。
这个系统本质上有两方面 - 离线收集和索引设置详细信息，以及在线提供结果。第一部分由摄取服务实现。它负责创建包含来自 VS Code 本身和扩展的设置的丰富索引。由于我们希望查询响应时间尽可能短，因此我们在摄取设置时尽早完成尽可能多的工作，以减少处理查询时必须执行的工作量。
必应摄取服务
收集 VS Code 和扩展设置数据
在每次构建过程中，VS Code 以一种模式启动，在此模式下，它将所有配置写入 JSON 文件。我们必须实际启动 VS Code，因为我们无法静态地确定所有配置元数据。该文件包含每个设置的几部分信息 - 名称、描述、类型、默认值以及对于“枚举”类型设置，有效值的列表及其描述。然后，我们将该文件上传到 Azure 存储。如果您好奇，您可以在这里查看最近的示例
https://ticino.blob.core.windows.net/configuration/123000832/c1cd4378.../configuration.json
123000832 是一个唯一的构建编号，它由产品版本加上自上次发布以来的 Git 提交次数计算得出。c1cd4378... 是构建所基于的 Git 提交 ID。而 ticino，一些死忠粉可能还记得，是我们最初短暂的代号。
必应的轮询服务监视 Azure 存储容器，发现新构建，并通知摄取服务。同时，必应不断地抓取 VS Code 扩展市场，等待扩展更新和新扩展。当找到一个扩展时，它将下载其 package.json 文件（对于扩展，所有配置元数据都包含在 package.json 中。无需启动它。）并将这些设置也传递给摄取服务。
整个过程完全自动化，并不断实时更新我们每个稳定版构建和每日 Insiders 构建的索引设置。在构建完成后的几分钟内，必应的索引已更新，以包含任何新添加的设置。
1. 替代词管道
用户有时使用与我们在设置名称和描述中使用的词语不同但等效的词语进行搜索。为了确保我们能够处理这些情况，我们集成了必应的“替代词”生成管道。此管道使用用户行为、点击、在线排名和页面相似性等信号从必应的搜索数据中收集具有相似含义的词语。例如，“更新”和“升级”被设置为“替代词”，搜索其中一个将返回包含另一个词的设置。
2. 词干提取器和拼写器管道
我们不想因为用户拼错设置名称而对其进行处罚，但我们很早就发现，简单的模糊匹配要么会错过人类能够理解的英语单词的变体，要么会包含太多误报匹配。因此，我们还包含了一个拼写器和一个词干提取器服务，它们是从用于 Bing.com 的完整服务中提取出来的，这些服务为索引添加了常见的拼写错误和同一个词干的替代形式。例如，“formatted”、“formatter”、“format” - 所有这些都将为使用单词“formatting”的设置编入索引。
3. 自然语言处理 (NLP) 管道
我们还想让用户能够用自己的自然语言描述他们的查询，因此我们添加了必应的自然语言处理管道。该管道收集常用的语音和文本模式并将它们添加到索引中。例如，它使系统能够识别“如何禁用 css 验证”中的重要词语，以找到 "css.validate"。
4. 反馈/排名管道
我们创建了一个反馈机制，使我们能够从用户反馈中学习和改进。它允许我们手动指定新的词语对，或为某些查询提高预期结果的排名。反馈将上传到服务，并几乎立即反映在搜索结果中。
门控模块
对索引的每次摄取都将通过门控模块，该模块只是确保索引没有由于某些编程错误而损坏。我们编写了测试用例来验证以下内容
- 新索引向后兼容，并为所有 VS Code 构建提供服务
- 我们的黄金查询集返回预期结果
门控模块中的故障将阻止索引摄取，并立即通知团队。还创建了一个仪表盘服务，使我们能够监控管道所有阶段的运行状况。它具有警报机制和回滚到最后一个已知良好状态的能力，以确保可以快速解决任何问题，并最大限度地减少停机时间。
搜索服务
最后，在运行时，来自用户的查询将命中 Azure 负载均衡器 服务，该服务将根据其物理位置或当前负载，选择我们的地理复制服务器之一来处理查询。位于该位置的搜索服务通过索引查找检索相关结果，在某些情况下应用手动排名覆盖，并将它们返回给 VS Code 客户端。
将所有内容整合在一起
我们现在拥有了一个系统，该系统能够更好地理解设置查询，并为许多以前不会返回结果的查询提供结果。
以下是一些示例
如果您遇到类似的问题，并且没有搜索团队为您构建自定义服务，就像必应团队为我们做的那样，我们仍然有一些好消息。您可以从 必应的认知服务 开始，这将帮助您为自己的应用程序添加一些智能。例如
关于测试的说明
在开发此系统时，我们需要一种方法来定量评估结果。我们决定构建一个基于 归一化折扣累积增益 (NDCG) 概念的测试框架。不深入细节，这是一种根据查询、一组结果以及这些结果的评分来对搜索引擎的结果进行评分的方法。我们手动编写了很多测试用例，但意识到我们需要一种自动化的方式来为所有设置生成测试用例，包括新添加的设置以及扩展中的设置。因此，我们编写了一个可以自动为任何设置生成测试用例的工具。它使用来自设置名称和描述的词语，并将它们通过不同的转换器，这些转换器模拟用户选择替代词、拼写错误或使用自然语言模式进行搜索。我们还为一些流行扩展的设置生成了测试用例。
我们每 6 个小时运行一次完整的测试套件，它可以自动更新，以便始终测试最新构建中的设置。测试套件向我们保证系统正常运行，并让我们确信，当我们在后端进行更改时，不会影响结果质量。
下一步
我们有几种方法可以继续改进系统。例如，我们还在建立一个基于用户行为的自动反馈循环。如果许多人搜索类似的查询，然后选择了相同的结果，那么我们知道该结果可能是一个好结果，应该将其排名更高。
目前，该服务仅用英语编入索引，但我们希望对翻译的设置描述进行编入索引，并支持非英语语言的搜索。还有一些配置元数据目前没有编入索引，例如 "workbench.colorCustomizations" 设置的可能值。为了进一步改进搜索，我们希望显示尚未安装的扩展的结果。如果您搜索 "debug python"，并且没有本地设置的强匹配，那么我们希望引导您使用可以帮助您调试 Python 代码的扩展。我们还考虑了这项技术在 VS Code 中的其他应用。也许命令面板可以从类似的服务中受益。
我们需要您的反馈
感谢 Bing 团队的帮助，现在查找设置更容易了！用户反馈是我们改进结果的最佳方式，因此在您搜索设置时，如果您没有看到预期的结果，请在 GitHub 上提交问题。事实上，如果您使用的是 VS Code Insiders，您甚至会看到一个按钮，可以调用我们新的问题报告器，让您更轻松地提交包含所有必要详细信息的问题。
编码愉快！
Rob Lourens，VS Code - @roblourens
Ankith Karat，Bing - [email protected]