チュートリアル: Chat API を使用してコードチュートリアルチャット参加者を作成する
このチュートリアルでは、GitHub Copilot Chat エクスペリエンスと統合する Visual Studio Code 拡張機能を作成する方法を学びます。Chat 拡張機能 API を使用してチャット参加者を提供します。あなたの参加者は、プログラミング概念の説明とサンプル演習を提供するコードチューターになります。
前提条件
このチュートリアルを完了するには、以下のツールとアカウントが必要です。
ステップ 1: プロジェクトのセットアップ
まず、Yeoman と VS Code 拡張機能ジェネレーターを使用して拡張機能プロジェクトを生成します。
npx --package yo --package generator-code -- yo code
セットアップを完了するには、以下のオプションを選択します。
# ? What type of extension do you want to create? New Extension (TypeScript)
# ? What's the name of your extension? Code Tutor
### Press <Enter> to choose default for all options below ###
# ? What's the identifier of your extension? code-tutor
# ? What's the description of your extension? LEAVE BLANK
# ? Initialize a git repository? Yes
# ? Bundle the source code with webpack? No
# ? Which package manager to use? npm
# ? Do you want to open the new folder with Visual Studio Code? Open with `code`
拡張機能プロジェクトが生成されると、extension.ts と package.json の2つのファイルを操作することになります。これらについては、拡張機能の構造に関するドキュメントで詳しく知ることができます。簡単な概要は次のとおりです。
extension.tsは拡張機能のメインエントリポイントであり、チャット参加者のロジックが含まれています。package.jsonには、参加者の名前や説明など、拡張機能のメタデータが含まれています。
extension.ts の activate() メソッドにある自動生成されたコードを削除します。ここにチャット参加者のロジックを配置します。
ステップ 2: チャット参加者の登録
package.json ファイルで、自動生成された contributes セクションを以下に置き換えます。
"contributes":{
"chatParticipants": [
{
"id": "chat-tutorial.code-tutor",
"fullName": "Code Tutor",
"name": "tutor",
"description": "What can I teach you?",
"isSticky": true
}
]
}
このコードは、以下の属性を持つチャット参加者を登録します。
- コードで参照される一意の ID
chat-tutorial.code-tutor - 参加者からの応答のタイトル領域に表示されるフルネーム
Code Tutor - Chat ビューでチャット参加者を
@tutorとして参照するために使用される名前tutor - チャット入力フィールドにプレースホルダーテキストとして表示される説明 "What can I teach you?"
最後に、isSticky: true を設定すると、ユーザーが参加者との対話を開始した後、チャット入力フィールドに自動的に参加者名が先行して表示されます。
ステップ 3: プロンプトの作成
参加者が登録されたので、コードチューターのロジックの実装を開始できます。extension.ts ファイルで、リクエスト用のプロンプトを定義します。
良いプロンプトを作成することは、参加者から最良の応答を得るための鍵です。プロンプトエンジニアリングのヒントについては、こちらの記事を確認してください。
あなたのコードチューターは、直接的な答えを提供するのではなく、学生が概念を理解するように導くことで、現実世界のチューターを模倣する必要があります。さらに、チューターはトピックに焦点を当て、プログラミング以外の質問には答えないようにする必要があります。
以下の2つのプロンプトを検討してください。指定された動作を与える可能性が高いのはどちらですか？
-
あなたは役立つコードチューターです。あなたの仕事は、概念の簡単な説明とサンプルコードを使ってユーザーに教えることです。
-
あなたは役立つコードチューターです。あなたの仕事は、概念の簡単な説明とサンプルコードを使ってユーザーに教えることです。一連のメッセージで概念のガイド付き概要を返してください。ユーザーに直接答えを与えるのではなく、自分で答えを見つけるように導いてください。ユーザーがプログラミング以外の質問をした場合は、丁重に回答を拒否してください。
2番目のプロンプトはより具体的であり、参加者に応答方法の明確な方向性を示します。このプロンプトを extension.ts ファイルに追加します。
const BASE_PROMPT =
'You are a helpful code tutor. Your job is to teach the user with simple descriptions and sample code of the concept. Respond with a guided overview of the concept in a series of messages. Do not give the user the answer directly, but guide them to find the answer themselves. If the user asks a non-programming question, politely decline to respond.';
ステップ 4: リクエストハンドラーの実装
プロンプトが選択されたので、リクエストハンドラーを実装する必要があります。これはユーザーのチャットリクエストを処理するものです。リクエストハンドラーを定義し、リクエストを処理するためのロジックを実行し、ユーザーに応答を返します。
まず、ハンドラーを定義します。
// define a chat handler
const handler: vscode.ChatRequestHandler = async (
request: vscode.ChatRequest,
context: vscode.ChatContext,
stream: vscode.ChatResponseStream,
token: vscode.CancellationToken
) => {
return;
};
このハンドラーの本体内で、プロンプトと、そのプロンプトを含む messages 配列を初期化します。次に、ユーザーがチャットボックスに入力した内容を送信します。これには request.prompt を介してアクセスできます。
request.model.sendRequest を使用してリクエストを送信します。これにより、現在選択されているモデルを使用してリクエストが送信されます。最後に、応答をユーザーにストリームします。
// define a chat handler
const handler: vscode.ChatRequestHandler = async (
request: vscode.ChatRequest,
context: vscode.ChatContext,
stream: vscode.ChatResponseStream,
token: vscode.CancellationToken
) => {
// initialize the prompt
let prompt = BASE_PROMPT;
// initialize the messages array with the prompt
const messages = [vscode.LanguageModelChatMessage.User(prompt)];
// add in the user's message
messages.push(vscode.LanguageModelChatMessage.User(request.prompt));
// send the request
const chatResponse = await request.model.sendRequest(messages, {}, token);
// stream the response
for await (const fragment of chatResponse.text) {
stream.markdown(fragment);
}
return;
};
ステップ 5: チャット参加者の作成
ハンドラーが実装されたら、最後のステップは Chat 拡張機能 API の createChatParticipant メソッドを使用してチャット参加者を作成することです。package.json で使用したのと同じ ID を必ず使用してください。
さらに、アイコンを追加して参加者をカスタマイズする必要があります。これにより、参加者とやり取りする際に Chat ビューに表示されます。
// define a chat handler
const handler: vscode.ChatRequestHandler = async (
request: vscode.ChatRequest,
context: vscode.ChatContext,
stream: vscode.ChatResponseStream,
token: vscode.CancellationToken
) => {
// initialize the prompt
let prompt = BASE_PROMPT;
// initialize the messages array with the prompt
const messages = [vscode.LanguageModelChatMessage.User(prompt)];
// add in the user's message
messages.push(vscode.LanguageModelChatMessage.User(request.prompt));
// send the request
const chatResponse = await request.model.sendRequest(messages, {}, token);
// stream the response
for await (const fragment of chatResponse.text) {
stream.markdown(fragment);
}
return;
};
// create participant
const tutor = vscode.chat.createChatParticipant('chat-tutorial.code-tutor', handler);
// add icon to participant
tutor.iconPath = vscode.Uri.joinPath(context.extensionUri, 'tutor.jpeg');
ステップ 6: コードの実行
チャット参加者を試す準備ができました！F5 キーを押してコードを実行します。チャット参加者が含まれた新しい VS Code ウィンドウが開きます。
Copilot Chat ペインで、@tutor と入力することで参加者を呼び出すことができます！
学習したい内容を入力して試してみてください。概念の概要を説明する応答が表示されるはずです！
会話を続けるために関連するメッセージを入力しても、参加者が会話に基づいてフォローアップの応答をしないことに気づくでしょう。これは、現在の参加者がユーザーの現在のメッセージのみを送信しており、参加者のメッセージ履歴を送信していないためです。
以下のスクリーンショットでは、チューターはスタックの初期の説明に正しく応答しています。しかし、フォローアップでは、ユーザーがPythonでのスタックの実装を見続けるために会話を続けていることを理解せず、代わりにPythonに関する一般的な応答を返しています。
ステップ 7: コンテキストを増やすためのメッセージ履歴の追加
Copilot Chat の最大の価値の1つは、最良の応答を得るために複数のメッセージを反復できることです。これを行うには、参加者のメッセージ履歴をチャットリクエストに送信する必要があります。これには context.history を介してアクセスできます。
その履歴を取得し、messages 配列に追加する必要があります。これは、request.prompt が追加される前に行う必要があります。
// define a chat handler
const handler: vscode.ChatRequestHandler = async (
request: vscode.ChatRequest,
context: vscode.ChatContext,
stream: vscode.ChatResponseStream,
token: vscode.CancellationToken
) => {
// initialize the prompt
let prompt = BASE_PROMPT;
// initialize the messages array with the prompt
const messages = [vscode.LanguageModelChatMessage.User(prompt)];
// get all the previous participant messages
const previousMessages = context.history.filter(
h => h instanceof vscode.ChatResponseTurn
);
// add the previous messages to the messages array
previousMessages.forEach(m => {
let fullMessage = '';
m.response.forEach(r => {
const mdPart = r as vscode.ChatResponseMarkdownPart;
fullMessage += mdPart.value.value;
});
messages.push(vscode.LanguageModelChatMessage.Assistant(fullMessage));
});
// add in the user's message
messages.push(vscode.LanguageModelChatMessage.User(request.prompt));
// send the request
const chatResponse = await request.model.sendRequest(messages, {}, token);
// stream the response
for await (const fragment of chatResponse.text) {
stream.markdown(fragment);
}
return;
};
これでコードを実行すると、以前のメッセージのすべてのコンテキストを含めて参加者と会話できるようになります！以下のスクリーンショットでは、参加者がユーザーが Python でのスタックの実装を見たいと要求していることを正しく理解しています。
ステップ 8: コマンドの追加
基本的な参加者が実装されたので、コマンドを追加して拡張できます。コマンドは一般的なユーザーの意図に対する短縮表記であり、/ 記号で示されます。拡張機能は、そのコマンドを使用して言語モデルに適切にプロンプトを出すことができます。
概念の練習問題を与えるようにチューターに促すコマンドを追加すると良いでしょう。package.json ファイルにコマンドを登録し、extension.ts にロジックを実装する必要があります。コマンド名を exercise とすると、/exercise と入力して呼び出すことができます。
package.json で、chatParticipants プロパティに commands プロパティを追加します。ここで、コマンドの名前と簡単な説明を指定します。
"contributes": {
"chatParticipants": [
{
"id": "chat-tutorial.code-tutor",
"fullName": "Code Tutor",
"name": "tutor",
"description": "What can I teach you?",
"isSticky": true,
"commands": [
{
"name": "exercise",
"description": "Provide exercises to practice a concept."
}
]
}
]
},
チューターからサンプル演習を取得するロジックを実装する最も簡単な方法は、リクエストに送信するプロンプトを変更することです。参加者にサンプル演習を返すように要求する新しいプロンプト EXERCISES_PROMPT を作成します。これはどのようなものになるかの一例です。
const EXERCISES_PROMPT =
'You are a helpful tutor. Your job is to teach the user with fun, simple exercises that they can complete in the editor. Your exercises should start simple and get more complex as the user progresses. Move one concept at a time, and do not move on to the next concept until the user provides the correct answer. Give hints in your exercises to help the user learn. If the user is stuck, you can provide the answer and explain why it is the answer. If the user asks a non-programming question, politely decline to respond.';
次に、リクエストハンドラーに、ユーザーがコマンドを参照したことを検出するロジックを追加する必要があります。これには request.command プロパティを介してアクセスできます。
コマンドが参照された場合、プロンプトを新しく作成した EXERCISES_PROMPT に更新します。
// define a chat handler
const handler: vscode.ChatRequestHandler = async (
request: vscode.ChatRequest,
context: vscode.ChatContext,
stream: vscode.ChatResponseStream,
token: vscode.CancellationToken
) => {
// initialize the prompt
let prompt = BASE_PROMPT;
if (request.command === 'exercise') {
prompt = EXERCISES_PROMPT;
}
// initialize the messages array with the prompt
const messages = [vscode.LanguageModelChatMessage.User(prompt)];
// get all the previous participant messages
const previousMessages = context.history.filter(
h => h instanceof vscode.ChatResponseTurn
);
// add the previous messages to the messages array
previousMessages.forEach(m => {
let fullMessage = '';
m.response.forEach(r => {
const mdPart = r as vscode.ChatResponseMarkdownPart;
fullMessage += mdPart.value.value;
});
messages.push(vscode.LanguageModelChatMessage.Assistant(fullMessage));
});
// add in the user's message
messages.push(vscode.LanguageModelChatMessage.User(request.prompt));
// send the request
const chatResponse = await request.model.sendRequest(messages, {}, token);
// stream the response
for await (const fragment of chatResponse.text) {
stream.markdown(fragment);
}
return;
};
これで追加すべきものはすべてです！メッセージ履歴を取得し、リクエストを送信し、リクエストをストリームする残りのロジックはすべて同じです。
これで /exercise と入力すると、チャット参加者が起動し、インタラクティブな演習でコーディングを練習できます！
次のステップ
おめでとうございます！プログラミング概念の説明とサンプル演習を提供できるチャット参加者の作成に成功しました。プロンプトの微調整、スラッシュコマンドの追加、または言語モデル API などの他の API を活用することで、参加者をさらに拡張できます。準備ができたら、Visual Studio Code Marketplace に拡張機能を公開することもできます。
このチュートリアルの完全なソースコードは、vscode-extensions-sample リポジトリで見つけることができます。