The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
fix(core): support `(message class, template)` tuples in `ChatPromptTemplate.from_messages` (#33989)
Connor Hyatte3939ade5af6
diff --git a/libs/core/langchain_core/prompts/chat.py b/libs/core/langchain_core/prompts/chat.pyindex a0069776d0..8840d291fd 100644--- a/libs/core/langchain_core/prompts/chat.py+++ b/libs/core/langchain_core/prompts/chat.py@@ -1438,6 +1438,14 @@ def _convert_to_message_template(message_ = _create_template_from_message_type(message_type_str, template, template_format=template_format)+ elif (+ hasattr(message_type_str, "model_fields")+ and "type" in message_type_str.model_fields+ ):+ message_type = message_type_str.model_fields["type"].default+ message_ = _create_template_from_message_type(+ message_type, template, template_format=template_format+ )else:message_ = message_type_str(prompt=PromptTemplate.from_template(diff --git a/libs/core/tests/unit_tests/prompts/test_chat.py b/libs/core/tests/unit_tests/prompts/test_chat.pyindex 33fe267353..f820c5d779 100644--- a/libs/core/tests/unit_tests/prompts/test_chat.py+++ b/libs/core/tests/unit_tests/prompts/test_chat.py@@ -30,9 +30,7 @@ from langchain_core.prompts.chat import ()from langchain_core.prompts.message import BaseMessagePromptTemplatefrom langchain_core.prompts.string import PromptTemplateFormat-from langchain_core.utils.pydantic import (- PYDANTIC_VERSION,-)+from langchain_core.utils.pydantic import PYDANTIC_VERSIONfrom tests.unit_tests.pydantic_utils import _normalize_schemaCUR_DIR = Path(__file__).parent.absolute().resolve()@@ -317,6 +315,288 @@ def test_chat_prompt_template_from_messages_jinja2() -> None:]+def test_chat_prompt_template_from_messages_using_message_classes() -> None:+ """Test creating a chat prompt template using message class tuples."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are a helpful AI bot. Your name is {name}."),+ (HumanMessage, "Hello, how are you doing?"),+ (AIMessage, "I'm doing well, thanks!"),+ (HumanMessage, "{user_input}"),+ ]+ )++ expected = [+ SystemMessage(+ content="You are a helpful AI bot. Your name is Bob.", additional_kwargs={}+ ),+ HumanMessage(content="Hello, how are you doing?", additional_kwargs={}),+ AIMessage(content="I'm doing well, thanks!", additional_kwargs={}),+ HumanMessage(content="What is your name?", additional_kwargs={}),+ ]++ messages = template.format_messages(name="Bob", user_input="What is your name?")+ assert messages == expected+++def test_chat_prompt_template_message_class_tuples_with_invoke() -> None:+ """Test message class tuples work with invoke() method."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are {name}."),+ (HumanMessage, "{question}"),+ ]+ )++ result = template.invoke({"name": "Alice", "question": "Hello?"})+ messages = result.to_messages()++ assert len(messages) == 2+ assert isinstance(messages[0], SystemMessage)+ assert isinstance(messages[1], HumanMessage)+ assert messages[0].content == "You are Alice."+ assert messages[1].content == "Hello?"+++def test_chat_prompt_template_message_class_tuples_mixed_syntax() -> None:+ """Test mixing message class tuples with string tuples."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "System prompt."), # class tuple+ ("human", "{user_input}"), # string tuple+ (AIMessage, "AI response."), # class tuple+ ]+ )++ messages = template.format_messages(user_input="Hello!")++ assert len(messages) == 3+ assert isinstance(messages[0], SystemMessage)+ assert isinstance(messages[1], HumanMessage)+ assert isinstance(messages[2], AIMessage)+ assert messages[0].content == "System prompt."+ assert messages[1].content == "Hello!"+ assert messages[2].content == "AI response."+++def test_chat_prompt_template_message_class_tuples_multiple_variables() -> None:+ """Test message class tuples with multiple template variables."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are {name}, a {role} assistant."),+ (HumanMessage, "My question about {topic} is: {question}"),+ ]+ )++ messages = template.format_messages(+ name="Bob", role="helpful", topic="Python", question="What is a list?"+ )++ assert len(messages) == 2+ assert messages[0].content == "You are Bob, a helpful assistant."+ assert messages[1].content == "My question about Python is: What is a list?"+++def test_chat_prompt_template_message_class_tuples_empty_template() -> None:+ """Test message class tuples with empty string template."""+ template = ChatPromptTemplate.from_messages(+ [+ (HumanMessage, ""),+ ]+ )++ messages = template.format_messages()++ assert len(messages) == 1+ assert isinstance(messages[0], HumanMessage)+ assert messages[0].content == ""+++def test_chat_prompt_template_message_class_tuples_static_text() -> None:+ """Test message class tuples with no template variables (static text)."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are a helpful assistant."),+ (HumanMessage, "Hello there!"),+ (AIMessage, "Hi! How can I help?"),+ ]+ )++ messages = template.format_messages()++ assert len(messages) == 3+ assert messages[0].content == "You are a helpful assistant."+ assert messages[1].content == "Hello there!"+ assert messages[2].content == "Hi! How can I help?"+++def test_chat_prompt_template_message_class_tuples_input_variables() -> None:+ """Test that input_variables are correctly extracted from message class tuples."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are {name}."),+ (HumanMessage, "{question}"),+ ]+ )++ assert sorted(template.input_variables) == ["name", "question"]+++def test_chat_prompt_template_message_class_tuples_partial_variables() -> None:+ """Test message class tuples with partial variables."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are {name}, a {role} assistant."),+ (HumanMessage, "{question}"),+ ]+ )++ partial_template = template.partial(name="Alice", role="helpful")+ messages = partial_template.format_messages(question="What is Python?")++ assert len(messages) == 2+ assert messages[0].content == "You are Alice, a helpful assistant."+ assert messages[1].content == "What is Python?"+++def test_chat_prompt_template_message_class_tuples_with_placeholder() -> None:+ """Test message class tuples combined with MessagesPlaceholder."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are a helpful assistant."),+ MessagesPlaceholder("history"),+ (HumanMessage, "{question}"),+ ]+ )++ messages = template.format_messages(+ history=[HumanMessage(content="Hi"), AIMessage(content="Hello!")],+ question="How are you?",+ )++ assert len(messages) == 4+ assert isinstance(messages[0], SystemMessage)+ assert isinstance(messages[1], HumanMessage)+ assert isinstance(messages[2], AIMessage)+ assert isinstance(messages[3], HumanMessage)+ assert messages[3].content == "How are you?"+++def test_chat_prompt_template_message_class_tuples_mustache_format() -> None:+ """Test message class tuples with mustache template format."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are {{name}}."),+ (HumanMessage, "{{question}}"),+ ],+ template_format="mustache",+ )++ messages = template.format_messages(name="Bob", question="Hello?")++ assert len(messages) == 2+ assert messages[0].content == "You are Bob."+ assert messages[1].content == "Hello?"+++def test_chat_prompt_template_message_class_tuples_append() -> None:+ """Test appending message class tuples to existing template."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are helpful."),+ ]+ )++ template.append((HumanMessage, "{question}"))++ messages = template.format_messages(question="What is AI?")++ assert len(messages) == 2+ assert isinstance(messages[0], SystemMessage)+ assert isinstance(messages[1], HumanMessage)+ assert messages[1].content == "What is AI?"+++def test_chat_prompt_template_message_class_tuples_extend() -> None:+ """Test extending template with message class tuples."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "System message."),+ ]+ )++ template.extend(+ [+ (HumanMessage, "{q1}"),+ (AIMessage, "Response."),+ (HumanMessage, "{q2}"),+ ]+ )++ messages = template.format_messages(q1="First?", q2="Second?")++ assert len(messages) == 4+ assert messages[1].content == "First?"+ assert messages[3].content == "Second?"+++def test_chat_prompt_template_message_class_tuples_concatenation() -> None:+ """Test concatenating two templates with message class tuples."""+ template1 = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are {name}."),+ ]+ )++ template2 = ChatPromptTemplate.from_messages(+ [+ (HumanMessage, "{question}"),+ ]+ )++ combined = template1 + template2+ messages = combined.format_messages(name="Alice", question="Hello?")++ assert len(messages) == 2+ assert messages[0].content == "You are Alice."+ assert messages[1].content == "Hello?"+++def test_chat_prompt_template_message_class_tuples_slicing() -> None:+ """Test slicing a template with message class tuples."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "System."),+ (HumanMessage, "Human 1."),+ (AIMessage, "AI."),+ (HumanMessage, "Human 2."),+ ]+ )++ sliced = template[1:3]+ messages = sliced.format_messages()++ assert len(messages) == 2+ assert isinstance(messages[0], HumanMessage)+ assert isinstance(messages[1], AIMessage)+++def test_chat_prompt_template_message_class_tuples_special_characters() -> None:+ """Test message class tuples with special characters in template."""+ template = ChatPromptTemplate.from_messages(+ [+ (SystemMessage, "You are a helpful assistant! 🤖"),+ (HumanMessage, "Question: {question}? (please answer)"),+ ]+ )++ messages = template.format_messages(question="What is 2+2")++ assert len(messages) == 2+ assert messages[0].content == "You are a helpful assistant! 🤖"+ assert messages[1].content == "Question: What is 2+2? (please answer)"++@pytest.mark.requires("jinja2")@pytest.mark.parametrize(("template_format", "image_type_placeholder", "image_data_placeholder"),