尝试以扩展 VS Code 中的代理模式！

构建语言模型提示

您可以通过字符串拼接来构建语言模型提示，但这种方式难以组合功能并确保您的提示保持在语言模型的上下文窗口内。为克服这些限制，您可以使用 @vscode/prompt-tsx 库。

@vscode/prompt-tsx 库提供以下功能

  • 基于 TSX 的提示渲染：使用 TSX 组件编写提示，使其更具可读性和可维护性
  • 基于优先级的剪枝：自动剪除提示中不那么重要的部分，以适应模型的上下文窗口
  • 灵活的令牌管理：使用诸如 flexGrow、flexReserve 和 flexBasis 等属性，协同使用令牌预算
  • 工具集成：与 VS Code 的语言模型工具 API 集成

有关所有功能的完整概述和详细使用说明，请参阅完整的 README。

本文介绍了使用该库进行提示设计的实际示例。这些示例的完整代码可在prompt-tsx 仓库中找到。

管理会话历史中的优先级

在您的提示中包含会话历史很重要，因为它使用户能够对之前的消息提出后续问题。但是，您需要确保其优先级得到适当处理，因为历史记录可能会随着时间增长而变得庞大。我们发现最合理的模式通常是按以下顺序确定优先级

  1. 基本提示指令
  2. 当前用户查询
  3. 最近几轮聊天历史
  4. 任何支持数据
  5. 尽可能多地包含剩余的历史记录

因此，将提示中的历史记录分成两部分，其中最近的提示轮次优先于一般上下文信息。

在此库中，树中的每个 TSX 节点都具有优先级，其概念类似于 zIndex，其中数字越大表示优先级越高。

步骤 1：定义 HistoryMessages 组件

为了列出历史消息，请定义一个 HistoryMessages 组件。此示例提供了一个很好的起点，但如果您处理更复杂的数据类型，可能需要对其进行扩展。

此示例使用 PrioritizedList 辅助组件，该组件会自动为其每个子级分配升序或降序优先级。

import {
	UserMessage,
	AssistantMessage,
	PromptElement,
	BasePromptElementProps,
	PrioritizedList,
} from '@vscode/prompt-tsx';
import { ChatContext, ChatRequestTurn, ChatResponseTurn, ChatResponseMarkdownPart } from 'vscode';

interface IHistoryMessagesProps extends BasePromptElementProps {
	history: ChatContext['history'];
}

export class HistoryMessages extends PromptElement<IHistoryMessagesProps> {
	render(): PromptPiece {
		const history: (UserMessage | AssistantMessage)[] = [];
		for (const turn of this.props.history) {
			if (turn instanceof ChatRequestTurn) {
				history.push(<UserMessage>{turn.prompt}</UserMessage>);
			} else if (turn instanceof ChatResponseTurn) {
				history.push(
					<AssistantMessage name={turn.participant}>
						{chatResponseToMarkdown(turn)}
					</AssistantMessage>
				);
			}
		}
		return (
			<PrioritizedList priority={0} descending={false}>
				{history}
			</PrioritizedList>
		);
	}
}

步骤 2：定义 Prompt 组件

接下来，定义一个 MyPrompt 组件，其中包含基本指令、用户查询以及具有适当优先级的历史消息。优先级值在同级之间是局部的。请记住，您可能希望在处理提示中的其他任何内容之前修剪历史记录中的旧消息，因此您需要将两个 <HistoryMessages> 元素拆分。

import {
	UserMessage,
	PromptElement,
	BasePromptElementProps,
} from '@vscode/prompt-tsx';

interface IMyPromptProps extends BasePromptElementProps {
	history: ChatContext['history'];
	userQuery: string;
}

export class MyPrompt extends PromptElement<IMyPromptProps> {
	render() {
		return (
			<>
				<UserMessage priority={100}>
					Here are your base instructions. They have the highest priority because you want to make
					sure they're always included!
				</UserMessage>
				{/* Older messages in the history have the lowest priority since they're less relevant */}
				<HistoryMessages history={this.props.history.slice(0, -2)} priority={0} />
				{/* The last 2 history messages are preferred over any workspace context you have below */}
				<HistoryMessages history={this.props.history.slice(-2)} priority={80} />
				{/* The user query is right behind the based instructions in priority */}
				<UserMessage priority={90}>{this.props.userQuery}</UserMessage>
				<UserMessage priority={70}>
					With a slightly lower priority, you can include some contextual data about the workspace
					or files here...
				</UserMessage>
			</>
		);
	}
}

现在，在库尝试剪除提示的其他元素之前，所有较旧的历史消息都将被剪除。

步骤 3：定义 History 组件

为了让使用更方便，定义一个 History 组件，它封装了历史消息并使用 passPriority 属性作为直通容器。使用 passPriority 后，其子级在优先级方面被视为包含元素的直接子级。

import { PromptElement, BasePromptElementProps } from '@vscode/prompt-tsx';

interface IHistoryProps extends BasePromptElementProps {
	history: ChatContext['history'];
	newer: number; // last 2 message priority values
	older: number; // previous message priority values
	passPriority: true; // require this prop be set!
}

export class History extends PromptElement<IHistoryProps> {
	render(): PromptPiece {
		return (
			<>
				<HistoryMessages history={this.props.history.slice(0, -2)} priority={this.props.older} />
				<HistoryMessages history={this.props.history.slice(-2)} priority={this.props.newer} />
			</>
		);
	}
}

现在，您可以使用并复用此单个元素来包含聊天历史。

<History history={this.props.history} passPriority older={0} newer={80}/>

调整文件内容大小以适应

在此示例中，您希望将用户当前正在查看的所有文件的内容包含到他们的提示中。这些文件可能很大，以至于包含所有文件会导致它们的文本被剪除！此示例展示了如何使用 flexGrow 属性协同调整文件内容大小以适应令牌预算。

步骤 1：定义基本指令和用户查询

首先，您定义一个包含基本指令的 UserMessage 组件。

<UserMessage priority={100}>Here are your base instructions.</UserMessage>

然后，您使用 UserMessage 组件包含用户查询。该组件具有高优先级，以确保它紧随基本指令之后包含。

<UserMessage priority={90}>{this.props.userQuery}</UserMessage>

步骤 2：包含文件内容

现在，您可以使用 FileContext 组件包含文件内容。您为其分配一个 flexGrow 值 1，以确保它在基本指令、用户查询和历史记录之后渲染。

<FileContext priority={70} flexGrow={1} files={this.props.files} />

带有 flexGrow 值时，元素会获得传递到其 render() 和 prepare() 调用中的 PromptSizing 对象中任何未使用的令牌预算。您可以在 prompt-tsx 文档中阅读有关 flex 元素行为的更多信息。

步骤 3：包含历史记录

接下来，使用您之前创建的 History 组件包含历史消息。这有点棘手，因为您确实希望显示一些历史记录，但也希望文件内容占据提示的大部分。

因此，为 History 组件分配一个 flexGrow 值 2，以确保它在所有其他元素（包括 <FileContext />）之后渲染。此外，设置一个 flexReserve 值 "/5"，为历史记录保留总预算的 1/5。

<History
	history={this.props.history}
	passPriority
	older={0}
	newer={80}
	flexGrow={2}
	flexReserve="/5"
/>

步骤 3：组合提示的所有元素

现在，将所有元素组合到 MyPrompt 组件中。

import {
	UserMessage,
	PromptElement,
	BasePromptElementProps,
} from '@vscode/prompt-tsx';
import { History } from './history';

interface IFilesToInclude {
	document: TextDocument;
	line: number;
}

interface IMyPromptProps extends BasePromptElementProps {
	history: ChatContext['history'];
	userQuery: string;
	files: IFilesToInclude[];
}

export class MyPrompt extends PromptElement<IMyPromptProps> {
	render() {
		return (
			<>
				<UserMessage priority={100}>Here are your base instructions.</UserMessage>
				<History
					history={this.props.history}
					passPriority
					older={0}
					newer={80}
					flexGrow={2}
					flexReserve="/5"
				/>
				<UserMessage priority={90}>{this.props.userQuery}</UserMessage>
				<FileContext priority={70} flexGrow={1} files={this.props.files} />
			</>
		);
	}
}

步骤 4：定义 FileContext 组件

最后，定义一个 FileContext 组件，其中包含用户当前正在查看的文件的内容。由于您使用了 flexGrow，您可以实现逻辑，通过使用 PromptSizing 中的信息，为每个文件获取“感兴趣”行周围尽可能多行。

为简洁起见，getExpandedFiles 的实现逻辑已省略。您可以在 prompt-tsx 仓库中查看。

import { PromptElement, BasePromptElementProps, PromptSizing, PromptPiece } from '@vscode/prompt-tsx';

class FileContext extends PromptElement<{ files: IFilesToInclude[] } & BasePromptElementProps> {
	async render(_state: void, sizing: PromptSizing): Promise<PromptPiece> {
		const files = await this.getExpandedFiles(sizing);
		return <>{files.map(f => f.toString())}</>;
	}

	private async getExpandedFiles(sizing: PromptSizing) {
		// Implementation details are summarized here.
		// Refer to the repo for the complete implementation.
	}
}

总结

在这些示例中，您创建了一个 MyPrompt 组件，其中包含基本指令、用户查询、历史消息以及具有不同优先级的 文件内容。您使用 flexGrow 协同调整文件内容大小以适应令牌预算。

通过遵循此模式，您可以确保提示中最重要的部分始终被包含，而不那么重要的部分则根据需要进行剪枝，以适应模型的上下文窗口。有关 getExpandedFiles 方法和 FileContextTracker 类的完整实现细节，请参阅 prompt-tsx 仓库。

07/09/2025