VS Code API

当身份验证提供程序的身份验证会话被添加、删除或更改时触发的 Event。

获取用户登录的指定提供程序的所有账户。与 getSession 配对使用，以便获取特定账户的身份验证会话。

目前，编辑器内置的扩展贡献了两个身份验证提供程序，分别实现了 GitHub 和 Microsoft 身份验证：它们的 providerId 分别是 'github' 和 'microsoft'。

注意：获取账户并不意味着您的扩展可以访问该账户或其身份验证会话。您可以通过调用 getSession 来验证对账户的访问权限。

获取匹配所需范围或满足 WWW-Authenticate 请求的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则会引发拒绝。如果存在多个具有相同范围的会话，用户将看到一个快速选择器来选择他们想要使用的账户。

内置身份验证提供程序包括

• 'github' - 用于 GitHub.com
• 'microsoft' - 用于个人和组织 Microsoft 账户
• (不太常见) 'github-enterprise' - 用于替代 GitHub 主机，GHE.com，GitHub Enterprise Server
• (不太常见) 'microsoft-sovereign-cloud' - 用于替代 Microsoft 云

获取匹配所需范围或请求的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则会引发拒绝。如果存在多个具有相同范围的会话，用户将看到一个快速选择器来选择他们想要使用的账户。

内置身份验证提供程序包括

• 'github' - 用于 GitHub.com
• 'microsoft' - 用于个人和组织 Microsoft 账户
• (不太常见) 'github-enterprise' - 用于替代 GitHub 主机，GHE.com，GitHub Enterprise Server
• (不太常见) 'microsoft-sovereign-cloud' - 用于替代 Microsoft 云

获取匹配所需范围或请求的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则会引发拒绝。如果存在多个具有相同范围的会话，用户将看到一个快速选择器来选择他们想要使用的账户。

内置身份验证提供程序包括

• 'github' - 用于 GitHub.com
• 'microsoft' - 用于个人和组织 Microsoft 账户
• (不太常见) 'github-enterprise' - 用于替代 GitHub 主机，GHE.com，GitHub Enterprise Server
• (不太常见) 'microsoft-sovereign-cloud' - 用于替代 Microsoft 云

注册一个身份验证提供程序。

每个 ID 只能有一个提供程序，并且当另一个提供程序已使用某个 ID 时会引发错误。ID 是区分大小写的。

创建一个新的 聊天参与者 实例。

执行由给定命令标识符表示的命令。

• 注意 1：在执行编辑器命令时，并非所有类型都可以作为参数传递。允许的类型是原始类型 string、boolean、number、undefined 和 null，以及 Position、Range、Uri 和 Location。
• 注意 2：在执行由扩展贡献的命令时，没有限制。

检索所有可用命令的列表。以下划线开头的命令被视为内部命令。

注册一个可以通过键盘快捷键、菜单项、操作或直接调用的命令。

使用现有的命令标识符重复注册命令将导致错误。

注册一个可以通过键盘快捷键、菜单项、操作或直接调用的文本编辑器命令。

文本编辑器命令与普通 命令 不同，它们仅在调用命令时存在活动编辑器时执行。此外，编辑器命令的处理程序可以访问活动编辑器和一个 edit-builder。请注意，edit-builder 仅在回调执行期间有效。

创建一个新的 评论控制器 实例。

当前活动的 调试控制台。如果没有活动调试会话，发送到调试控制台的输出将不会显示。

当前活动的 调试会话 或 undefined。活动调试会话是由调试操作浮动窗口表示的会话，或者当前显示在调试操作浮动窗口下拉菜单中的会话。如果没有活动调试会话，则值为 undefined。

当前聚焦的线程或堆栈帧，或者 undefined（如果没有聚焦线程或堆栈）。只要有活动的调试会话，线程就可以被聚焦；而堆栈帧只有在会话暂停并且已检索到调用堆栈时才能被聚焦。

断点列表。

当 活动调试会话 更改时触发的 Event。注意，当活动调试会话更改为 undefined 时，该事件也会触发。

当 debug.activeStackItem 更改时触发的事件。

当断点集被添加、删除或更改时发出的 Event。

当从 调试会话 收到自定义 DAP 事件时触发的 Event。

当一个新的 调试会话 启动时触发的 Event。

当 调试会话 终止时触发的 Event。

添加断点。

将通过调试适配器协议接收到的“Source”描述符对象转换为可用于加载其内容的 URI。如果源描述符基于路径，则返回文件 URI。如果源描述符使用引用号，则会构造一个特定的调试 URI（方案为“debug”），该 URI 需要一个相应的 ContentProvider 和一个正在运行的调试会话。

如果“Source”描述符信息不足以创建 URI，则会引发错误。

为特定调试类型注册 调试适配器描述符工厂。扩展只能为其定义的调试类型注册 DebugAdapterDescriptorFactory。否则会引发错误。为同一调试类型注册多个 DebugAdapterDescriptorFactory 会导致错误。

为给定的调试类型注册调试适配器跟踪器工厂。

为特定调试类型注册 调试配置提供程序。可选的 triggerKind 可用于指定何时触发提供程序的 provideDebugConfigurations 方法。目前有两种触发方式：使用 Initial（或未提供触发参数）值时，provideDebugConfigurations 方法用于提供要复制到新创建的 launch.json 的初始调试配置。使用 Dynamic 触发方式时，provideDebugConfigurations 方法用于动态确定要呈现给用户的调试配置（除了 launch.json 中的静态配置）。请注意，triggerKind 参数仅适用于 provideDebugConfigurations 方法：因此 resolveDebugConfiguration 方法不受任何影响。为不同触发方式注册具有 resolve 方法的单个提供程序会导致相同的 resolve 方法被调用多次。可以为同一类型注册多个提供程序。

删除断点。

通过使用命名启动或命名复合配置，或直接传递 DebugConfiguration 来启动调试。命名配置在给定文件夹中的 '.vscode/launch.json' 中查找。在调试开始之前，所有未保存的文件都会被保存，并且启动配置会更新到最新。配置中使用的文件夹特定变量（例如 '${workspaceFolder}'）会根据给定的文件夹进行解析。

停止给定的调试会话，或在省略 session 时停止所有调试会话。

应用程序的托管位置。在桌面版上是 'desktop'。在 Web 版上是指定的嵌入器，例如 'github.dev'、'codespaces' 或 'web'（如果嵌入器未提供该信息）。

编辑器的应用程序名称，例如 'VS Code'。

编辑器运行的应用程序根文件夹。

请注意，当在没有应用程序根文件夹表示的环境中运行时，该值为空字符串。

系统剪贴板。

指示这是应用程序的全新安装。如果在安装后的第一天内为 true，否则为 false。

指示用户是否启用了遥测。可以观察此值来确定扩展是否应发送遥测数据。

表示首选用户语言，例如 de-CH、fr 或 en-US。

编辑器的当前日志级别。

计算机的唯一标识符。

远程资源的名称。由扩展定义，常见的示例是 Linux 的 Windows 子系统（Windows Subsystem for Linux）的 wsl，或者使用安全外壳（secure shell）的远程资源的 ssh-remote。

请注意，当没有远程扩展主机时，该值为 undefined。但如果存在远程扩展主机，则在所有扩展主机（本地和远程）中该值都是已定义的。请使用 Extension.extensionKind 来了解特定扩展是否在远程运行。

当前会话的唯一标识符。每次启动编辑器时都会更改。

检测到的扩展主机默认 shell，它会被扩展主机平台的 terminal.integrated.defaultProfile 设置覆盖。请注意，在不支持 shell 的环境中，此值为空字符串。

UI kind 属性指示从哪个 UI 访问扩展。例如，扩展可以从桌面应用程序或 Web 浏览器访问。

编辑器在操作系统中注册的自定义 URI 方案。

当编辑器的日志级别发生变化时触发的 事件。

默认 shell 更改时触发的 事件。该事件会传递新的 shell 路径。

当用户启用或禁用遥测时触发的 事件。如果用户启用了遥测，则为 true；如果用户禁用了遥测，则为 false。

将 URI 解析为外部可访问的形式。

http: 或 https: 方案

将扩展正在运行的外部 URI（例如 http: 或 https: 链接）解析为客户端机器上相同资源的 URI。

如果扩展在客户端机器上运行，则此操作无效。

如果扩展在远程运行，此函数会自动建立从本地机器到远程 target 的端口转发隧道，并返回到该隧道的本地 URI。端口转发隧道的生命周期由编辑器管理，并且用户可以关闭隧道。

请注意，通过 openExternal 传递的 URI 会自动解析，您不应对它们调用 asExternalUri。

vscode.env.uriScheme

创建一个 URI，如果该 URI 在浏览器中打开（例如通过 openExternal），将触发已注册的 UriHandler。

扩展不应假定结果 URI 的任何内容，也不应以任何方式修改它。相反，扩展可以使用此 URI 进行身份验证流程，例如将其作为回调查询参数添加到要身份验证的服务器。

请注意，如果服务器决定向 URI 添加额外的查询参数（例如令牌或密钥），这些参数将出现在传递给 UriHandler 的 URI 中。

身份验证流程的**示例**

vscode.window.registerUriHandler({
  handleUri(uri: vscode.Uri): vscode.ProviderResult<void> {
    if (uri.path === '/did-authenticate') {
      console.log(uri.toString());
    }
  }
});

const callableUri = await vscode.env.asExternalUri(
  vscode.Uri.parse(vscode.env.uriScheme + '://my.extension/did-authenticate')
);
await vscode.env.openExternal(callableUri);

请注意，扩展不应缓存 asExternalUri 的结果，因为由于系统或用户操作，解析后的 URI 可能会变得无效 — 例如，在远程情况下，用户可能会关闭由 asExternalUri 打开的端口转发隧道。

任何其他方案

任何其他方案都将被视为工作区 URI。在这种情况下，该方法将返回一个 URI，当处理该 URI 时，编辑器将打开工作区。

创建一个新的 遥测记录器。

使用默认应用程序在外部打开链接。根据所使用的方案，这可以是

• 浏览器（http:, https:）
• 邮件客户端（mailto:）
• VSCode 本身（来自 vscode.env.uriScheme 的 vscode:）

请注意，showTextDocument 是在编辑器内部打开文本文档的正确方法，而不是此函数。

当前系统已知的 au 扩展。

当 extensions.all 发生变化时触发的事件。这可能发生在扩展安装、卸载、启用或禁用时。

通过以下格式的完整标识符获取扩展：publisher.name。

已为扩展加载的本地化字符串包。如果没有加载包，则为 undefined。通常，如果没有找到包或我们使用默认语言运行时，则不会加载包。

已为扩展加载的本地化包的 URI。如果没有加载包，则为 undefined。通常，如果没有找到包或我们使用默认语言运行时，则不会加载包。

标记字符串以进行本地化。如果对于 env.language 指定的语言有可用的本地化包，并且该包对此消息有本地化值，则将返回该本地化值（并为任何模板化值注入 args 值）。

示例

l10n.t('Hello {0}!', 'World');

标记字符串以进行本地化。如果对于 env.language 指定的语言有可用的本地化包，并且该包对此消息有本地化值，则将返回该本地化值（并为任何模板化值注入 args 值）。

示例

l10n.t('Hello {name}', { name: 'Erich' });

标记字符串以进行本地化。如果对于 env.language 指定的语言有可用的本地化包，并且该包对此消息有本地化值，则将返回该本地化值（并为任何模板化值注入 args 值）。

全局诊断集发生变化时触发的 事件。这是新添加和移除的诊断。

创建诊断集合。

创建一个新的 语言状态项。

获取给定资源的 au 诊断。

获取 au 诊断。

返回所有已知语言的标识符。

计算文档 选择器 与文档之间的匹配。大于零的值表示选择器匹配文档。

匹配根据以下规则计算

1. 当 DocumentSelector 为数组时，计算包含的每个 DocumentFilter 或语言标识符的匹配项，并取最大值。
2. 字符串将被解构，成为 DocumentFilter 的 language 部分，因此 "fooLang" 类似于 { language: "fooLang" }。
3. 通过将 DocumentFilter 的各个部分与文档进行比较来计算匹配。适用以下规则
   1. 当 DocumentFilter 为空（{}）时，结果为 0
   2. 当 scheme、language、pattern 或 notebook 已定义但其中一个不匹配时，结果为 0
   3. 匹配 * 会获得 5 的分数，通过相等性或 glob 模式匹配会获得 10 的分数
   4. 结果是每次匹配的最大值

示例

// default document from disk (file-scheme)
doc.uri; //'file:///my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript' }, doc); // 10;
match({ language: 'javascript', scheme: 'file' }, doc); // 10;
match('*', doc); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5

// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript', scheme: 'git' }, doc); // 10;
match('*', doc); // 5

// notebook cell document
doc.uri; // `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;
doc.languageId; // 'python'
match({ notebookType: 'jupyter-notebook' }, doc); // 10
match({ notebookType: 'fooNotebook', language: 'python' }, doc); // 0
match({ language: 'python' }, doc); // 10
match({ notebookType: '*' }, doc); // 5

注册调用层次结构提供程序。

注册代码操作提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册代码 Lens 提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册颜色提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册补全提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将按其 分数 排序，并且具有相同分数的组将被顺序地询问补全项。当一个或多个提供程序返回结果时，该过程停止。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

补全项提供程序可以与一组 triggerCharacters 关联。当键入触发字符时，会请求补全，但仅从注册了键入字符的提供程序处请求。因此，触发字符应与 字词字符 不同，常见的触发字符是 . 以触发成员补全。

注册声明提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册定义提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个新的 DocumentDropEditProvider。

可以为一种语言注册多个拖放提供程序。将内容拖放到编辑器中时，将根据它们处理的 MIME 类型（由其 DocumentDropEditProviderMetadata 指定）调用该编辑器注册的所有提供程序。

每个提供程序可以返回一个或多个 DocumentDropEdits。编辑会根据 DocumentDropEdit.yieldTo 属性进行排序。默认情况下，将应用第一个编辑。如果存在其他编辑，这些编辑将显示给用户，作为拖放控件中可选的拖放选项。

注册文档的格式化提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将按其 分数 排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

注册文档高亮提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将按其 分数 排序，并按顺序询问文档高亮。当提供程序返回 非假值 或 非失败 结果时，该过程停止。

注册文档链接提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个新的 DocumentPasteEditProvider。

可以为一种语言注册多个提供程序。所有已注册的语言提供程序都将根据其处理的 MIME 类型（由 DocumentPasteProviderMetadata 指定）在复制和粘贴操作中调用。

对于 复制操作，每个提供程序对 DataTransfer 所做的更改将合并到一个用于填充剪贴板的 DataTransfer 中。

对于 [DocumentPasteEditProvider.providerDocumentPasteEdits 粘贴操作](#_DocumentPasteEditProvider.providerDocumentPasteEdits 粘贴操作)，将调用每个提供程序，并且它们可以返回一个或多个 DocumentPasteEdits。编辑会根据 DocumentPasteEdit.yieldTo 属性进行排序。默认情况下，将应用第一个编辑，其余编辑将显示给用户，作为粘贴控件中可选的粘贴选项。

为文档范围注册格式化提供程序。

注意： 文档范围提供程序也是一个 文档格式化程序，这意味着在注册范围提供程序时，无需 注册 文档格式化程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将按其 分数 排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

为文档范围注册语义令牌提供程序。

注意： 如果一个文档同时拥有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，则范围提供程序仅在最初被调用，用于完全文档提供程序解析第一个请求所需的时间。一旦完全文档提供程序解析了第一个请求，通过范围提供程序提供的语义令牌将被丢弃，此后将仅使用文档提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将按其 分数 排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

为整个文档注册语义令牌提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将按其 分数 排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

注册文档符号提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个用于在文本文档中定位可求值表达式的提供程序。编辑器将在活动调试会话中求值表达式，并在调试悬停时显示结果。

如果为语言注册了多个提供程序，则将使用任意一个提供程序。

注册折叠范围提供程序。

可以为语言注册多个提供程序。在这种情况下，提供程序会并行请求，并将结果合并。如果多个折叠范围从同一位置开始，则仅使用第一个注册提供程序的结果。如果折叠范围与一个位置更小的范围重叠，它也会被忽略。

失败的提供程序（承诺被拒绝或抛出异常）不会导致整个操作失败。

注册悬停提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册实现提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册内嵌提示提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册内联完成提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个为调试器的“内联值”功能提供数据的提供程序。每当通用调试器在源文件中停止时，就会调用为该文件语言注册的提供程序，以返回将在编辑器行末显示的文本数据。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册链接编辑范围提供程序。

可以为语言注册多个提供程序。在这种情况下，提供程序将按其 得分 进行排序，并使用具有结果的最佳匹配提供程序。选定提供程序的失败将导致整个操作失败。

注册一个在键入时工作的格式化提供程序。当用户启用 editor.formatOnType 设置时，该提供程序将处于活动状态。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将按其 分数 排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

注册引用提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册重命名提供程序。

可以为语言注册多个提供程序。在这种情况下，提供程序将按其 得分 进行排序，并按顺序请求。第一个生成结果的提供程序定义了整个操作的结果。

注册选择范围提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册签名帮助提供程序。

可以为语言注册多个提供程序。在这种情况下，提供程序将按其 得分 进行排序，并按顺序调用，直到某个提供程序返回有效结果。

另请参阅 languages.registerSignatureHelpProvider

注册类型定义提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将并行被调用，结果将被合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册类型层次结构提供程序。

注册工作区符号提供程序。

可以注册多个提供程序。在这种情况下，提供程序会并行请求，并将结果合并。失败的提供程序（承诺被拒绝或抛出异常）不会导致整个操作失败。

为语言设置 语言配置。

设置（并更改）与给定文档关联的 语言。

注意，调用此函数将触发 onDidCloseTextDocument 事件，然后是 onDidOpenTextDocument 事件。

所有可用工具的列表，这些工具已通过 lm.registerTool 由所有扩展程序注册。它们可以使用 lm.invokeTool 调用，其输入应与声明的 inputSchema 匹配。

当可用聊天模型集发生变化时触发的事件。

通过名称和给定的输入调用 lm.tools 中列出的工具。输入将根据工具声明的模式进行验证。

工具可以由聊天参与者在处理聊天请求的上下文中调用，也可以由任何扩展在任何自定义流程中全局调用。

在前一种情况下，调用者应传递 toolInvocationToken（来自 聊天请求），这可以确保聊天 UI 为正确的对话显示工具调用。

工具 结果 是一个由 文本 和 prompt-tsx 部分组成的数组。如果工具调用者使用 vscode/prompt-tsx，它可以将响应部分合并到其提示中使用 ToolResult。如果不是，则可以将这些部分通过带有 LanguageModelToolResultPart 的用户消息传递给 LanguageModelChat。

如果聊天参与者希望保留跨多轮的工具结果，它可以将工具结果存储在处理程序返回的 ChatResult.metadata 中，并在下一轮从 ChatResponseTurn.result 中检索它们。

注册一个 LanguageModelChatProvider。注意：您还必须通过 package.json 中的 languageModelChatProviders 贡献点来定义语言模型聊天提供程序。

注册一个提供程序，该程序发布模型上下文协议（MCP）服务器供编辑器使用。这允许 MCP 服务器动态地提供给编辑器，而不仅仅是用户在其配置文件中创建的服务器。

在此方法调用之前，扩展必须使用相应的 id 注册 contributes.mcpServerDefinitionProviders 扩展点，例如：

    "contributes": {
        "mcpServerDefinitionProviders": [
            {
                "id": "cool-cloud-registry.mcp-servers",
                "label": "Cool Cloud Registry",
            }
        ]
    }

当新的 McpServerDefinitionProvider 可用时，编辑器默认会在提交聊天消息时自动调用它来发现新服务器和工具。要启用此流程，扩展应在激活期间调用 registerMcpServerDefinitionProvider。

注册一个 LanguageModelTool。该工具还必须在 package.json 的 languageModelTools 贡献点中注册。注册的工具可在 lm.tools 列表中供任何扩展查看。但是，为了让语言模型看到它，它必须在 LanguageModelChatRequestOptions.tools 中提供的可用工具列表中。

通过 选择器 选择聊天模型。这可能会产生零个或多个聊天模型，扩展程序必须优雅地处理这些情况，特别是当不存在聊天模型时。

const models = await vscode.lm.selectChatModels({ family: 'gpt-3.5-turbo' });
if (models.length > 0) {
    const [first] = models;
    const response = await first.sendRequest(...)
    // ...
} else {
    // NO chat models available
}

可以选择器来广泛匹配特定供应商或系列的模型，也可以通过 ID 来精确选择单个模型。请记住，可用模型的集合会随时间变化，而且提示在不同模型上的表现也可能不同。

注意，扩展程序可以保留此函数返回的结果并稍后使用。但是，当 onDidChangeChatModels 事件触发时，聊天模型列表可能会发生变化，扩展程序应重新查询。

创建一个新的笔记本控制器。

创建一个用于与特定渲染器通信的新消息实例。

• 注意 1：扩展只能创建它们在其 package.json 文件中定义的渲染器。
• 注意 2：只有当渲染器的 notebookRenderer 贡献中 requiresMessaging 设置为 always 或 optional 时，渲染器才能访问消息功能。

为给定的笔记本类型注册一个 单元格状态栏项提供程序。

扩展创建的最后一个源控件的 输入框。

• 已弃用 - 请改用 SourceControl.inputBox

创建一个新的 源控件 实例。

当前活动的任务执行，或者一个空数组。

任务结束时触发。

底层进程结束时触发。此事件不会为不执行底层进程的任务触发。

任务开始时触发。

底层进程启动时触发。此事件不会为不执行底层进程的任务触发。

执行由编辑器管理的任务。返回的任务执行可用于终止任务。

• 抛出 - 当在无法启动新进程的环境中运行 ShellExecution 或 ProcessExecution 任务时。在此类环境中，只能运行 CustomExecution 任务。

获取系统中所有可用的任务。这包括来自 tasks.json 文件的任务，以及通过扩展贡献的任务提供程序中的任务。

注册一个任务提供程序。

创建一个新的测试控制器。

根据设置配置的当前活动颜色主题。活动主题可以通过 workbench.colorTheme 设置进行更改。

当前活动的 笔记本编辑器 或 undefined。活动编辑器是当前具有焦点编辑器，或者在没有编辑器有焦点时，是最近更改输入的编辑器。

当前活动的终端或 undefined。活动终端是当前具有焦点或最近拥有焦点的终端。

当前活动的编辑器或 undefined。活动编辑器是当前具有焦点编辑器，或者在没有编辑器有焦点时，是最近更改输入的编辑器。

表示当前窗口的状态。

表示主编辑器区域内的网格小部件

当前打开的终端，或者一个空数组。

当前可见的 笔记本编辑器，或者一个空数组。

当前可见的编辑器，或者一个空数组。

当活动颜色主题更改或发生更改时触发的 Event。

当 活动笔记本编辑器 更改时触发的 Event。注意，当活动编辑器更改为 undefined 时，事件也会触发。

当 活动终端 更改时触发的 Event。注意，当活动终端更改为 undefined 时，事件也会触发。

当 活动编辑器 更改时触发的 Event。注意，当活动编辑器更改为 undefined 时，事件也会触发。

当 笔记本编辑器选择 更改时触发的 Event。

当 笔记本编辑器可见范围 更改时触发的 Event。

当终端中的 Shell Integration 激活或其某个属性更改时触发。

当 终端状态 更改时触发的 Event。

当编辑器的选项更改时触发的 Event。

当编辑器中的选区更改时触发的 Event。

当编辑器的视图列更改时触发的 Event。

当编辑器的可见范围更改时触发的 Event。

当 可见笔记本编辑器 数组更改时触发的 Event。

当 可见编辑器 数组更改时触发的 Event。

当当前窗口的焦点或活动状态更改时触发的 Event。事件的值表示窗口是否获得焦点。

当终端被释放时触发的 Event。

当终端命令结束时触发。此事件仅在终端 激活了 Shell Integration 时触发。

当终端被创建时（通过 createTerminal API 或命令）触发的 Event。

当终端命令开始时触发。此事件仅在终端 激活了 Shell Integration 时触发。

创建一个 InputBox，让用户输入文本。

请注意，在许多情况下，更方便的 window.showInputBox 更易于使用。window.createInputBox 应在 window.showInputBox 不提供所需灵活性时使用。

使用给定的名称和语言 ID 创建一个新的 输出通道。如果未提供语言 ID，则使用 Log 作为默认语言 ID。

您可以从 可见编辑器 或 活动编辑器 访问可见或活动的输出通道，作为 文本文档，并使用语言 ID 来贡献语言功能，如语法着色、代码 Lens 等。

使用给定的名称创建一个新的 日志输出通道。

创建一个 QuickPick，让用户从 T 类型项的列表中选择一个项。

请注意，在许多情况下，更方便的 window.showQuickPick 更易于使用。window.createQuickPick 应在 window.showQuickPick 不提供所需灵活性时使用。

创建一个状态栏 项。

创建一个状态栏 项。

另请参阅 createStatusBarItem，用于创建带标识符的状态栏项。

使用后备 shell 进程创建一个 Terminal。终端的 cwd 将是工作区目录（如果存在）。

• 抛出 - 当在无法启动新进程的环境中运行时。

使用后备 shell 进程创建一个 Terminal。

• 抛出 - 当在无法启动新进程的环境中运行时。

创建一个由扩展控制其输入和输出的 Terminal。

创建一个 TextEditorDecorationType，用于向文本编辑器添加装饰。

为使用 views 扩展点贡献的视图创建一个 TreeView。

创建并显示一个新的 Webview 面板。

为 customEditors 扩展点贡献的 viewType 注册自定义编辑器提供程序。

当打开自定义编辑器时，会触发 onCustomEditor:viewType 激活事件。您的扩展程序必须在激活时为 viewType 注册 CustomTextEditorProvider、CustomReadonlyEditorProvider 或 CustomEditorProvider。

注册文件装饰提供程序。

注册一个提供程序，用于在终端中检测和处理链接。

为贡献的终端配置文件注册一个提供程序。

为使用 views 扩展点贡献的视图注册一个 TreeDataProvider。这将允许您向 TreeView 贡献数据并在数据更改时进行更新。

注意：要访问 TreeView 并对其执行操作，请使用 createTreeView。

注册一个能够处理系统范围的 URI 的 URI 处理程序。如果打开了多个窗口，则最上面的窗口将处理 URI。URI 处理程序的作用域限定在其贡献的扩展程序内；它只能处理定向到扩展程序本身的 URI。URI 必须遵守以下规则：

• URI 方案必须是 vscode.env.uriScheme；
• URI 权限必须是扩展 ID（例如 my.extension）；
• URI 路径、查询和片段部分是任意的。

例如，如果 my.extension 扩展程序注册了一个 URI 处理程序，它将只能处理以 product-name://my.extension 开头的 URI。

每个扩展程序在其整个激活生命周期中只能注册一个 URI 处理程序。

• 注意：存在一个 onUri 激活事件，当一个指向当前扩展程序的 URI 即将处理时，该事件会被触发。

注册 Webview 面板序列化器。

支持恢复的扩展程序应具有 "onWebviewPanel:viewType" 激活事件，并确保在激活期间调用 registerWebviewPanelSerializer。

对于给定的 viewType，一次只能注册一个序列化器。

为 Webview 视图注册新的提供程序。

在状态栏上设置一条消息。这是更强大的状态栏 项目 的简写。

在状态栏上设置一条消息。这是更强大的状态栏 项目 的简写。

在状态栏上设置一条消息。这是更强大的状态栏 项目 的简写。

注意状态栏消息会堆叠，并且在使用完毕后必须将其 disposed。

显示错误消息。

另请参阅 showInformationMessage

显示错误消息。

另请参阅 showInformationMessage

显示错误消息。

另请参阅 showInformationMessage

显示错误消息。

另请参阅 showInformationMessage

向用户显示信息消息。可以选择提供一个数组的项目，这些项目将显示为可点击的按钮。

向用户显示信息消息。可以选择提供一个数组的项目，这些项目将显示为可点击的按钮。

显示信息消息。

另请参阅 showInformationMessage

显示信息消息。

另请参阅 showInformationMessage

打开一个输入框，要求用户输入。

如果输入框被取消（例如，按 ESC 键），则返回值将是 undefined。否则，返回值将是用户键入的字符串，如果用户未键入任何内容但用 OK 按钮关闭了输入框，则返回空字符串。

在 笔记本编辑器 中显示给定的 NotebookDocument。

向用户显示文件打开对话框，允许选择要打开的文件。

显示一个允许多选的选项列表。

显示一个选项列表。

显示一个允许多选的选项列表。

显示一个选项列表。