From 6dcca35a34d273ed82688ab5b3fbf04dbec1968a Mon Sep 17 00:00:00 2001 From: "Andreas V. Jonsterhaug" <72311591+AndreasVJ@users.noreply.github.com> Date: Mon, 14 Jul 2025 17:00:01 +0200 Subject: [PATCH] fix(core): correct return type hints in BaseChatPromptTemplate (#32009) This PR changes the return type hints of the `format_prompt` and `aformat_prompt` methods in `BaseChatPromptTemplate` from `PromptValue` to `ChatPromptValue`. Since both methods always return a `ChatPromptValue`. --- libs/core/langchain_core/prompts/chat.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/libs/core/langchain_core/prompts/chat.py b/libs/core/langchain_core/prompts/chat.py index 2b912b13830..924762457f3 100644 --- a/libs/core/langchain_core/prompts/chat.py +++ b/libs/core/langchain_core/prompts/chat.py @@ -35,7 +35,7 @@ from langchain_core.messages import ( convert_to_messages, ) from langchain_core.messages.base import get_msg_title_repr -from langchain_core.prompt_values import ChatPromptValue, ImageURL, PromptValue +from langchain_core.prompt_values import ChatPromptValue, ImageURL from langchain_core.prompts.base import BasePromptTemplate from langchain_core.prompts.dict import DictPromptTemplate from langchain_core.prompts.image import ImagePromptTemplate @@ -715,20 +715,20 @@ class BaseChatPromptTemplate(BasePromptTemplate, ABC): """ return (await self.aformat_prompt(**kwargs)).to_string() - def format_prompt(self, **kwargs: Any) -> PromptValue: - """Format prompt. Should return a PromptValue. + def format_prompt(self, **kwargs: Any) -> ChatPromptValue: + """Format prompt. Should return a ChatPromptValue. Args: **kwargs: Keyword arguments to use for formatting. Returns: - PromptValue. + ChatPromptValue. """ messages = self.format_messages(**kwargs) return ChatPromptValue(messages=messages) - async def aformat_prompt(self, **kwargs: Any) -> PromptValue: - """Async format prompt. Should return a PromptValue. + async def aformat_prompt(self, **kwargs: Any) -> ChatPromptValue: + """Async format prompt. Should return a ChatPromptValue. Args: **kwargs: Keyword arguments to use for formatting.