【LangChainのMessagePromptTemplateとは？】使い方を解説

MessagePromptTemplateとは

MessagePromptTemplateは、LangChainのフレームワークにおける重要な概念です。人間やAIなどの対話履歴を含むプロンプトテンプレートを作成するための機能を提供します。チャットベースの対話におけるメッセージの生成をしたいときに、役立ちます。

PromptTemplateクラスは、AIに送る単一のメッセージを表すプロンプトテンプレートを作成するものであるのに対し、ChatPromptTemplateクラスとMessagePromptTemplateによるプロンプトテンプレートの作成では、過去の対話履歴(人間とAIなどによるメッセージのやり取り)を含むプロンプトが作成できます。

MessagePromptTemplateの使い方

以下に、MessagePromptTemplateを使用してプロンプトテンプレートを作成するためのプログラムの例を示します。

AIMessagePromptTemplate、SystemMessagePromptTemplate、HumanMessagePromptTemplate

LangChainのMessagePromptTemplateでは、チャットモデルがメッセージの送信者を識別するための、ロールというものを指定します。一般的にロールとなるのは、AI、システム、人間です。AIMessagePromptTemplate、SystemMessagePromptTemplate、HumanMessagePromptTemplateというクラスが、それぞれAIのメッセージ、システムのメッセージ、人間のメッセージを作成します。

以下に、AIMessagePromptTemplate、SystemMessagePromptTemplate、HumanMessagePromptTemplateを使った実装コードの例を2つ示します。

コード1

from langchain.prompts.chat import (
    ChatPromptTemplate,
    SystemMessagePromptTemplate,
    HumanMessagePromptTemplate,
)

# システム用のメッセージプロンプトテンプレートの準備
template="あなたは {input_language} を {output_language} に翻訳するアシスタントです。"
system_message_prompt = SystemMessagePromptTemplate.from_template(template)

#人間用のメッセージプロンプトテンプレートの準備
human_template="{text}"
human_message_prompt = HumanMessagePromptTemplate.from_template(human_template)

# chatプロンプトテンプレートの準備
chat_prompt = ChatPromptTemplate.from_messages([system_message_prompt, human_message_prompt])

chat_prompt.format_prompt(
    input_language="日本語",
    output_language="英語",
    text="僕はITエンジニアです。"
).to_messages()

初めに、必要なクラスをインポートしています。

ChatPromptTemplate：会話全体のプロンプトテンプレートを作成するためのクラスです。
SystemMessagePromptTemplate：システムのメッセージ用のプロンプトテンプレートを作成するためのクラスです。システムのメッセージとは、AIのタスクや動作を定義し、AIがどのような性質や能力を持って振る舞うべきかを指定するものです。
HumanMessagePromptTemplate：人間のメッセージ用のプロンプトテンプレートを作成するためのクラスです。

次に、from_template()メソッドを用いて、システムのメッセージのプロンプトテンプレートと人間のメッセージのプロンプトテンプレートを作成します。プロンプトテンプレートは、input_language、output_language、textという変数を含んでいます。

それから、ChatPromptTemplateクラスのfrom_messages()メソッドを使って、会話全体のプロンプトテンプレートを作成しています。

最後に、作成したプロンプトテンプレート（chat_prompt）をフォーマットして、実際のメッセージのリストに変換しています。具体的には、format_prompt()メソッドによって、変数であるinput_language、output_language、textの値を指定することで、システムのメッセージと人間のメッセージのプロンプトを完成させており、to_messages()メソッドを呼び出すことで、フォーマットされたプロンプトテンプレートをメッセージのリストに変換しています。

このコードを実行すると、システムのメッセージと人間のメッセージによるプロンプトテンプレートが作成され、以下のようなプロンプトテンプレートが得られます。

[SystemMessage(content='あなたは日本語を英語に翻訳するアシスタントです。'),
 HumanMessage(content='僕はITエンジニアです。')]

コード2

from langchain.prompts import (
    ChatPromptTemplate,
    HumanMessagePromptTemplate,
    AIMessagePromptTemplate,
)

human_prompt1 = "What is the best way to learn programming?"
human_message_template1 = HumanMessagePromptTemplate.from_template(human_prompt1)

ai_prompt ="""\
1. Choose a programming language: Decide on a programming language that you want to learn.

2. Start with the basics: Familiarize yourself with the basic programming concepts such as variables, data types and control structures.

3. Practice, practice, practice: The best way to learn programming is through hands-on experience\
"""
ai_message_template =AIMessagePromptTemplate.from_template(ai_prompt)

human_prompt2 = "Summarize our conversation so far in {word_count} words."
human_message_template2 = HumanMessagePromptTemplate.from_template(human_prompt2)

# chatプロンプトテンプレートの準備
chat_prompt = ChatPromptTemplate.from_messages([human_message_template1, ai_message_template, human_message_template2])

chat_prompt.format_prompt(word_count="10").to_messages()

初めに、必要なクラスをインポートしています。AIMessagePromptTemplateは、AIのメッセージ用のプロンプトテンプレートを作成するためのクラスです。

次に、from_template()メソッドを用いて、人間のメッセージのプロンプトテンプレート（human_message_template1、human_message_template2）とAIのメッセージのプロンプトテンプレート（ai_message_template）を作成します。ai_message_templateは、word_countという変数を含んでいます。

それから、ChatPromptTemplateクラスのfrom_messages()メソッドを使って、会話全体のプロンプトテンプレートを作成しています。

最後に、format_promptメソッドを呼び出してword_countの値を指定し、to_messages()メソッドによってプロンプトテンプレートを実際のメッセージリストに変換しています。

このコードを実行すると、AIのメッセージと人間のメッセージによるプロンプトテンプレートが作成され、以下のようなプロンプトテンプレートが得られます。

[HumanMessage(content='What is the best way to learn programming?'),
 AIMessage(content='1. Choose a programming language: Decide on a programming language that you want to learn.\n\n2. Start with the basics: Familiarize yourself with the basic programming concepts such as variables, data types and control structures.\n\n3. Practice, practice, practice: The best way to learn programming is through hands-on experience'),
 HumanMessage(content='Summarize our conversation so far in 10 words.')]

MessagesPlaceholder

LangChainにはMessagesPlaceholderというクラスが用意されています。AIMessagePromptTemplate、 SystemMessagePromptTemplate、HumanMessagePromptTemplateなどのクラスを使用する代わりに、MessagesPlaceholderを使用しても、同じプロンプトテンプレートを作成することができます。例えば、MessagesPlaceholderを使い、以下のようなコードを書くことで、前の節でのコード2のプログラムと、同じプロンプトテンプレートを作成できます

from langchain.prompts import (
    ChatPromptTemplate,
    HumanMessagePromptTemplate,
    MessagesPlaceholder,
)
from langchain_core.messages import AIMessage, HumanMessage

human_prompt = "Summarize our conversation so far in {word_count} words."
human_message_template = HumanMessagePromptTemplate.from_template(human_prompt)

chat_prompt = ChatPromptTemplate.from_messages(
    [MessagesPlaceholder(variable_name="conversation"), human_message_template]
)

human_message = HumanMessage(content="What is the best way to learn programming?")
ai_message = AIMessage(
    content="""\
1. Choose a programming language: Decide on a programming language that you want to learn.

2. Start with the basics: Familiarize yourself with the basic programming concepts such as variables, data types and control structures.

3. Practice, practice, practice: The best way to learn programming is through hands-on experience\
"""
)

chat_prompt.format_prompt(
    conversation=[human_message, ai_message], word_count="10"
).to_messages()

from langchain_core.messages import AIMessage, HumanMessageという行では、AIMessageとHumanMessageというクラスをインポートしています。これらのクラスは、それぞれAIと人間のメッセージを表現するためのものです。

そして、human_message = HumanMessage(content="What is the best way to learn programming?")では、HumanMessageクラスのインスタンスを作成し、その内容を"What is the best way to learn programming?"としています。同様に、ai_message = AIMessage(...)では、AIMessageクラスのインスタンスを作成し、その内容を指定しています。

chat_prompt = ChatPromptTemplate.from_messages([MessagesPlaceholder(variable_name="conversation"), human_message_template])では、MessagesPlaceholder(variable_name="conversation")の部分で、会話の履歴を変数として受け取る場所を定義しており、その変数の名前を"conversation"としています。chat_prompt.format_prompt(conversation=[human_message, ai_message], word_count="10").to_messages()を実行したときに、"conversation"に2つのメッセージhuman_messageとai_messageのリストを代入することで、会話の履歴を受け取っています。

チャットメッセージのロールに任意のものを指定したいとき

MessagePromptTemplateでは、一般的にロールとなるのは、AI、システム、人間と説明しました。しかし、ロールに任意のものを指定したいときは、ChatMessagePromptTemplateを用いて、以下のように実装します。

from langchain.prompts import ChatMessagePromptTemplate

prompt = "May the {subject} be with you"

chat_message_prompt = ChatMessagePromptTemplate.from_template(
    role="Jedi", template=prompt
)
chat_message_prompt.format(subject="force")

このコードでは、"May the {subject} be with you"というメッセージを送信したロールを"Jedi"と指定しています。コードを実行すると、以下のようなプロンプトテンプレートが得られます。

ChatMessage(content='May the force be with you', role='Jedi')

まとめ

この記事では、LangChainのMessagePromptTemplateの使い方を解説しました。このクラスを使用すると、対話履歴を含むプロンプトテンプレートを簡単に作成し、フォーマットすることができます。

参考文献

備考

LLM を業務で活用したり、自社のサービスに組み込みたくありませんか？Hakky では、AI を用いた企業独自のシステムを構築するご支援を行っています。ソリューションサイト：https://www.about.st-hakky.com/chatgpt-solution

「どんなことが出来るのか」「いま考えているこのようなことは本当に実現可能か」など、ご検討段階でも構いませんので、ぜひお気軽にフォームよりお問い合わせくださいませ。