Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow passing message dicts into ChatPromptTemplate #29363

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion libs/core/langchain_core/prompts/chat.py
Original file line number Diff line number Diff line change
Expand Up @@ -1461,7 +1461,15 @@ def _convert_to_message(
_message = _create_template_from_message_type(
"human", message, template_format=template_format
)
elif isinstance(message, tuple):
elif isinstance(message, (tuple, dict)):
if isinstance(message, dict):
if sorted(message.keys()) != ["content", "role"]:
isahers1 marked this conversation as resolved.
Show resolved Hide resolved
msg = (
"Expected dict to have keys 'role' and 'content'."
isahers1 marked this conversation as resolved.
Show resolved Hide resolved
f" Got: {message}"
)
raise ValueError(msg)
message = (message["role"], message["content"])
if len(message) != 2:
msg = f"Expected 2-tuple of (role, template), got {message}"
raise ValueError(msg)
Expand Down
35 changes: 35 additions & 0 deletions libs/core/tests/unit_tests/prompts/test_chat.py
Original file line number Diff line number Diff line change
Expand Up @@ -831,6 +831,41 @@ def test_chat_prompt_message_placeholder_tuple() -> None:
assert optional_prompt.format_messages() == []


def test_chat_prompt_message_placeholder_dict() -> None:
prompt = ChatPromptTemplate([{"role": "placeholder", "content": "{convo}"}])
assert prompt.format_messages(convo=[("user", "foo")]) == [
HumanMessage(content="foo")
]

assert prompt.format_messages() == []

# Is optional = True
optional_prompt = ChatPromptTemplate(
[{"role": "placeholder", "content": ["{convo}", False]}]
efriis marked this conversation as resolved.
Show resolved Hide resolved
)
assert optional_prompt.format_messages(convo=[("user", "foo")]) == [
HumanMessage(content="foo")
efriis marked this conversation as resolved.
Show resolved Hide resolved
]
with pytest.raises(KeyError):
assert optional_prompt.format_messages() == []


def test_chat_prompt_message_dict() -> None:
prompt = ChatPromptTemplate(
[{"role": "system", "content": "foo"}, {"role": "user", "content": "bar"}]
)
assert prompt.format_messages() == [
SystemMessage(content="foo"),
HumanMessage(content="bar"),
]

with pytest.raises(ValueError):
ChatPromptTemplate([{"role": "system", "content": False}])

with pytest.raises(ValueError):
ChatPromptTemplate([{"role": "foo", "content": "foo"}])


async def test_messages_prompt_accepts_list() -> None:
prompt = ChatPromptTemplate([MessagesPlaceholder("history")])
value = prompt.invoke([("user", "Hi there")]) # type: ignore
Expand Down
Loading