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： 调用由扩展贡献的命令时没有限制。

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

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

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

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

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

创建新的 注释控制器 实例。

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

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

当前聚焦的线程或堆栈帧，如果未聚焦任何线程或堆栈，则为 undefined。当存在活动的调试会话时，任何时候都可以聚焦线程，而当会话暂停并且调用堆栈已检索时，才能聚焦堆栈帧。

断点列表。

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

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

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

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

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

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

添加断点。

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

如果 "Source" 描述对象包含不足以创建 Uri 的信息，则会抛出错误。

为特定的调试类型注册一个 调试适配器描述符工厂。扩展只能注册由该扩展定义的调试类型（或类型）的 DebugAdapterDescriptorFactory。否则将抛出错误。为同一调试类型注册多个 DebugAdapterDescriptorFactory 将导致错误。

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

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

删除断点。

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

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

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

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

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

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

系统剪贴板。

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

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

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

编辑器的当前日志级别。

计算机的唯一标识符。

远程的名称。由扩展定义，常见的示例包括用于 Windows Subsystem for Linux 的 wsl 或用于使用安全外壳进行远程连接的 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 会自动解析，您不应在这些 URI 上调用 asExternalUri。

vscode.env.uriScheme

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

扩展不应对生成的 URI 进行任何假设，也不应以任何方式修改它。相反，扩展可以在身份验证流程中使用此 URI，例如通过将 URI 添加为回调查询参数到要进行身份验证的服务器。

注意，如果服务器决定向 URI 添加其他查询参数（例如 token 或 secret），它们将出现在传递给 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，而不是此函数。

系统当前已知的所有扩展。

当 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 值以用于任何模板化值）。

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

创建一个诊断集合。

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

获取给定资源的全部诊断。

获取所有诊断。

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

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

匹配是根据以下规则计算的

1. 当 DocumentSelector 是数组时，为每个包含的 DocumentFilter 或语言标识符计算匹配，并取最大值。
2. 字符串将被解构为 DocumentFilter 的 language 部分，因此 "fooLang" 等同于 { language: "fooLang" }。
3. 通过比较 DocumentFilter 的各个部分与文档来匹配 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 或异常）不会导致整个操作失败。

注册一个补全提供程序。

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

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

注册一个声明提供程序。

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

注册一个定义提供程序。

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

注册一个新的 DocumentDropEditProvider。

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

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

为文档注册一个格式化提供程序。

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

注册一个文档高亮提供程序。

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

注册一个文档链接提供程序。

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

注册一个新的 DocumentPasteEditProvider。

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

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

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

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

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

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

为文档范围注册语义标记提供程序。

注意：如果文档同时具有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，则范围提供程序仅在初始调用，直到整个文档提供程序解析第一个请求。一旦整个文档提供程序解析了第一个请求，通过范围提供程序提供的语义标记将被丢弃，此后仅使用文档提供程序。

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

为整个文档注册语义标记提供程序。

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

注册文档符号提供程序。

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

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

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

注册折叠范围提供程序。

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

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

注册悬停提供程序。

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

注册实现提供程序。

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

注册插入提示提供程序。

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

注册行内补全提供程序。

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

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

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

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

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

注册一个用于输入时格式化的提供程序。当用户启用 editor.formatOnType 设置时，该提供程序将激活。

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

注册引用提供程序。

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

注册重命名提供程序。

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

注册选择范围提供程序。

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

注册签名帮助提供程序。

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

另请参阅 languages.registerSignatureHelpProvider

注册类型定义提供程序。

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

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

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

可以注册多个提供程序。在这种情况下，提供程序将并行请求，并且结果将被合并。失败的提供程序（被拒绝的 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 贡献点中定义语言模型聊天提供程序。

注册一个提供 Model Context Protocol 服务器供编辑器使用的提供程序。这允许编辑器动态地提供 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 集成激活或其某个属性更改时触发。

当 终端状态 发生变化时触发的 Event。

当编辑器的选项发生变化时触发的 Event。

当编辑器中的选择发生变化时触发的 Event。

当编辑器的视图列发生变化时触发的 Event。

当编辑器的可见范围发生变化时触发的 Event。

当 可见笔记本编辑器 发生变化时触发的 Event。

当 可见编辑器 数组发生变化时触发的 Event。

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

当终端被处置时触发的 Event。

当终端命令结束时触发。只有在终端 启用了 Shell 集成 时，此事件才会触发。

当终端已创建时触发的 Event，无论是通过 createTerminal API 还是通过命令。

当终端命令开始时触发。只有在终端 启用了 Shell 集成 时，此事件才会触发。

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

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

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

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

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

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

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

创建一个状态栏 项。

创建一个状态栏 项。

参见 createStatusBarItem 用于创建带有标识符的状态栏项。

创建一个具有底层 shell 进程的 Terminal。如果工作区目录存在，终端的工作目录将是工作区目录。

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

创建一个具有底层 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。

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

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

显示一个选择列表。

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

显示一个选择列表。