语言模型 API
语言模型 API 使你能够使用语言模型，并在 Visual Studio Code 扩展中集成由 AI 提供支持的功能和自然语言处理。
你可以在不同类型的扩展中使用语言模型 API。此 API 的典型用途是聊天扩展，你可以在其中使用语言模型解释用户的请求并帮助提供答案。但是，语言模型 API 的使用不限于此场景。你可以在语言或调试器扩展中使用语言模型，或者作为自定义扩展中命令或任务的一部分。例如，Rust 扩展可以使用语言模型提供默认名称，以改善其重命名体验。
使用语言模型 API 的过程包括以下步骤
- 构建语言模型提示
- 发送语言模型请求
- 解释响应
以下部分提供了有关如何在扩展中实施这些步骤的更多详细信息。
链接
构建语言模型提示
要与语言模型交互，扩展应首先精心设计其提示，然后向语言模型发送请求。你可以使用提示向语言模型提供有关你正在使用该模型执行的宽泛任务的说明。提示还可以定义解释用户消息的上下文。
语言模型 API 在构建语言模型提示时支持两种类型的消息
- 用户 - 用于提供说明和用户的请求
- 助手 - 用于将以前的语言模型响应历史记录作为上下文添加到提示中
注意：目前，语言模型 API 不支持使用系统消息。
你可以使用两种方法构建语言模型提示
LanguageModelChatMessage- 通过提供一个或多个字符串消息来创建提示。如果你刚开始使用语言模型 API，则可以使用此方法。@vscode/prompt-tsx- 通过使用 TSX 语法声明提示。
如果你想更好地控制语言模型提示的组成方式，可以使用 prompt-tsx 库。例如，该库可以帮助动态调整提示的长度以适应每个语言模型的上下文窗口大小。详细了解 @vscode/prompt-tsx 或探索 聊天扩展示例以开始使用。
要了解有关提示工程概念的更多信息，我们建议阅读 OpenAI 出色的提示工程指南。
提示： 利用丰富的 VS Code 扩展 API 来获取最相关的上下文并将其包含在提示中。例如，在编辑器中包含活动文件的内容。
使用 LanguageModelChatMessage 类
语言模型 API 提供了 LanguageModelChatMessage 类来表示和创建聊天消息。你可以分别使用 LanguageModelChatMessage.User 或 LanguageModelChatMessage.Assistant 方法创建用户或助手消息。
在以下示例中，第一条消息提供了提示的上下文
- 模型在回复中使用的角色（在此示例中是猫）
- 模型在生成响应时应遵循的规则（在此示例中，以有趣的方式使用猫的比喻来解释计算机科学概念）
第二条消息然后提供来自用户的特定请求或指令。它根据第一条消息提供的上下文，确定要完成的特定任务。
const craftedPrompt = [
vscode.LanguageModelChatMessage.User(
'You are a cat! Think carefully and step by step like a cat would. Your job is to explain computer science concepts in the funny manner of a cat, using cat metaphors. Always start your response by stating what concept you are explaining. Always include code samples.'
),
vscode.LanguageModelChatMessage.User('I want to understand recursion')
];
发送语言模型请求
为语言模型构建提示后，首先使用 selectChatModels 方法选择要使用的语言模型。此方法返回与指定条件匹配的语言模型数组。如果你正在实现一个聊天参与者，我们建议你改用作为 request 对象的一部分在聊天请求处理程序中传递的模型。这确保你的扩展程序尊重用户在聊天模型下拉列表中选择的模型。然后，通过使用 sendRequest 方法向语言模型发送请求。
要选择语言模型，你可以指定以下属性：vendor、id、family 或 version。使用这些属性可以广泛匹配给定供应商或系列的所有模型，或者通过其 ID 选择一个特定模型。在API 参考中了解有关这些属性的更多信息。
注意：目前，
gpt-4o、gpt-4o-mini、o1、o1-mini、claude-3.5-sonnet支持作为语言模型系列。如果您不确定要使用哪个模型，我们推荐使用gpt-4o，因为它具有卓越的性能和质量。对于直接在编辑器中的交互，我们推荐使用gpt-4o-mini，因为它具有良好的性能。
如果没有与指定条件匹配的模型，selectChatModels 方法将返回一个空数组。你的扩展必须适当地处理这种情况。
以下示例展示了如何选择所有 Copilot 模型，而不考虑系列或版本
const models = await vscode.lm.selectChatModels({
vendor: 'copilot'
});
// No models available
if (models.length === 0) {
// TODO: handle the case when no models are available
}
重要：Copilot 的语言模型在扩展使用它们之前需要用户同意。同意以身份验证对话框的形式实现。因此，
selectChatModels应该作为用户发起的操作（例如命令）的一部分进行调用。
选择模型后，你可以通过调用模型实例上的 sendRequest 方法向语言模型发送请求。你将传入之前精心设计的提示，以及任何其他选项和取消令牌。
当你向语言模型 API 发出请求时，请求可能会失败。例如，因为模型不存在，或者用户未同意使用语言模型 API，或者配额限制已超出。使用 LanguageModelError 来区分不同类型的错误。
以下代码片段显示了如何发出语言模型请求
try {
const [model] = await vscode.lm.selectChatModels({ vendor: 'copilot', family: 'gpt-4o' });
const request = model.sendRequest(craftedPrompt, {}, token);
} catch (err) {
// Making the chat request might fail because
// - model does not exist
// - user consent not given
// - quota limits were exceeded
if (err instanceof vscode.LanguageModelError) {
console.log(err.message, err.code, err.cause);
if (err.cause instanceof Error && err.cause.message.includes('off_topic')) {
stream.markdown(
vscode.l10n.t("I'm sorry, I can only explain computer science concepts.")
);
}
} else {
// add other error handling logic
throw err;
}
}
解释响应
发送请求后，你必须处理来自语言模型 API 的响应。根据你的使用场景，你可以将响应直接传递给用户，也可以解释响应并执行额外的逻辑。
来自语言模型 API 的响应（LanguageModelChatResponse）是基于流式的，这使你能够提供流畅的用户体验。例如，当你将 API 与聊天 API 结合使用时，通过持续报告结果和进度。
在处理流式响应时可能会发生错误，例如网络连接问题。请确保在代码中添加适当的错误处理来处理这些错误。
以下代码片段展示了一个扩展如何注册一个命令，该命令使用语言模型将活动编辑器中的所有变量名更改为有趣的猫咪名称。请注意，该扩展将代码流回编辑器，以提供流畅的用户体验。
vscode.commands.registerTextEditorCommand(
'cat.namesInEditor',
async (textEditor: vscode.TextEditor) => {
// Replace all variables in active editor with cat names and words
const [model] = await vscode.lm.selectChatModels({
vendor: 'copilot',
family: 'gpt-4o'
});
let chatResponse: vscode.LanguageModelChatResponse | undefined;
const text = textEditor.document.getText();
const messages = [
vscode.LanguageModelChatMessage
.User(`You are a cat! Think carefully and step by step like a cat would.
Your job is to replace all variable names in the following code with funny cat variable names. Be creative. IMPORTANT respond just with code. Do not use markdown!`),
vscode.LanguageModelChatMessage.User(text)
];
try {
chatResponse = await model.sendRequest(
messages,
{},
new vscode.CancellationTokenSource().token
);
} catch (err) {
if (err instanceof vscode.LanguageModelError) {
console.log(err.message, err.code, err.cause);
} else {
throw err;
}
return;
}
// Clear the editor content before inserting new content
await textEditor.edit(edit => {
const start = new vscode.Position(0, 0);
const end = new vscode.Position(
textEditor.document.lineCount - 1,
textEditor.document.lineAt(textEditor.document.lineCount - 1).text.length
);
edit.delete(new vscode.Range(start, end));
});
try {
// Stream the code into the editor as it is coming in from the Language Model
for await (const fragment of chatResponse.text) {
await textEditor.edit(edit => {
const lastLine = textEditor.document.lineAt(textEditor.document.lineCount - 1);
const position = new vscode.Position(lastLine.lineNumber, lastLine.text.length);
edit.insert(position, fragment);
});
}
} catch (err) {
// async response stream may fail, e.g network interruption or server side error
await textEditor.edit(edit => {
const lastLine = textEditor.document.lineAt(textEditor.document.lineCount - 1);
const position = new vscode.Position(lastLine.lineNumber, lastLine.text.length);
edit.insert(position, (<Error>err).message);
});
}
}
);
注意事项
模型可用性
我们不期望特定模型会永远受支持。当你在扩展中引用语言模型时，请务必在向该语言模型发送请求时采取“防御性”方法。这意味着你应该优雅地处理无法访问特定模型的情况。
选择合适的模型
扩展作者可以选择最适合其扩展的模型。我们推荐使用 gpt-4o，因为它具有卓越的性能和质量。要获取可用模型的完整列表，你可以使用此代码片段
const allModels = await vscode.lm.selectChatModels(MODEL_SELECTOR);
注意：推荐的 GPT-4o 模型有
64K令牌的限制。从selectChatModels调用返回的模型对象具有一个maxInputTokens属性，显示令牌限制。随着我们了解更多关于扩展如何使用语言模型的信息，这些限制将会扩大。
速率限制
扩展应负责任地使用语言模型并注意速率限制。VS Code 对用户透明，说明扩展如何使用语言模型，以及每个扩展发送多少请求以及这如何影响其各自的配额。
由于速率限制，扩展不应将语言模型 API 用于集成测试。在内部，VS Code 使用专用的非生产语言模型进行模拟测试，我们目前正在考虑如何为扩展提供可扩展的语言模型测试解决方案。
测试你的扩展
语言模型 API 提供的响应是非确定性的，这意味着你可能对相同的请求获得不同的响应。此行为对测试你的扩展可能具有挑战性。
扩展中用于构建提示和解释语言模型响应的部分是确定性的，因此可以在不使用实际语言模型的情况下进行单元测试。然而，与语言模型本身交互并获取响应是非确定性的，并且不易测试。考虑以模块化方式设计你的扩展代码，以便你能够对可测试的特定部分进行单元测试。
发布你的扩展
创建 AI 扩展后，你可以将扩展发布到 Visual Studio Marketplace
- 在发布到 VS Marketplace 之前，我们建议你阅读Microsoft AI 工具和实践指南。这些指南提供了负责任地开发和使用 AI 技术的最佳实践。
- 通过发布到 VS Marketplace，你的扩展符合GitHub Copilot 扩展性可接受开发和使用政策。
- 如果你的扩展除了使用语言模型 API 之外还提供其他功能，我们建议你在扩展清单中不要引入对 GitHub Copilot 的扩展依赖。这可确保不使用 GitHub Copilot 的扩展用户无需安装 GitHub Copilot 即可使用非语言模型功能。在这种情况下，请确保在访问语言模型时有适当的错误处理。
- 按照发布扩展中的说明上传到 Marketplace。