langchain-core 0.3.72__py3-none-any.whl → 0.4.0.dev0__py3-none-any.whl

langchain_core/prompt_values.py

@@ -8,17 +8,65 @@ from __future__ import annotations
 
 from abc import ABC, abstractmethod
 from collections.abc import Sequence
-from typing import Literal, cast
+from typing import Literal, Union, cast
 
-from typing_extensions import TypedDict
+from typing_extensions import TypedDict, overload
 
 from langchain_core.load.serializable import Serializable
 from langchain_core.messages import (
+    AIMessage,
     AnyMessage,
     BaseMessage,
     HumanMessage,
+    SystemMessage,
+    ToolMessage,
     get_buffer_string,
 )
+from langchain_core.messages import content_blocks as types
+from langchain_core.v1.messages import AIMessage as AIMessageV1
+from langchain_core.v1.messages import HumanMessage as HumanMessageV1
+from langchain_core.v1.messages import MessageV1, ResponseMetadata
+from langchain_core.v1.messages import SystemMessage as SystemMessageV1
+from langchain_core.v1.messages import ToolMessage as ToolMessageV1
+
+
+def _convert_to_v1(message: BaseMessage) -> MessageV1:
+    """Best-effort conversion of a V0 AIMessage to V1."""
+    if isinstance(message.content, str):
+        content: list[types.ContentBlock] = []
+        if message.content:
+            content = [{"type": "text", "text": message.content}]
+    else:
+        content = []
+        for block in message.content:
+            if isinstance(block, str):
+                content.append({"type": "text", "text": block})
+            elif isinstance(block, dict):
+                content.append(cast("types.ContentBlock", block))
+            else:
+                pass
+
+    if isinstance(message, HumanMessage):
+        return HumanMessageV1(content=content)
+    if isinstance(message, AIMessage):
+        for tool_call in message.tool_calls:
+            content.append(tool_call)
+        return AIMessageV1(
+            content=content,
+            usage_metadata=message.usage_metadata,
+            response_metadata=cast("ResponseMetadata", message.response_metadata),
+            tool_calls=message.tool_calls,
+        )
+    if isinstance(message, SystemMessage):
+        return SystemMessageV1(content=content)
+    if isinstance(message, ToolMessage):
+        return ToolMessageV1(
+            tool_call_id=message.tool_call_id,
+            content=content,
+            artifact=message.artifact,
+        )
+    error_message = f"Unsupported message type: {type(message)}"
+    raise TypeError(error_message)
 
 
 class PromptValue(Serializable, ABC):
@@ -46,8 +94,18 @@ class PromptValue(Serializable, ABC):
     def to_string(self) -> str:
         """Return prompt value as string."""
 
+    @overload
+    def to_messages(
+        self, message_version: Literal["v0"] = "v0"
+    ) -> list[BaseMessage]: ...
+
+    @overload
+    def to_messages(self, message_version: Literal["v1"]) -> list[MessageV1]: ...
+
     @abstractmethod
-    def to_messages(self) -> list[BaseMessage]:
+    def to_messages(
+        self, message_version: Literal["v0", "v1"] = "v0"
+    ) -> Union[Sequence[BaseMessage], Sequence[MessageV1]]:
         """Return prompt as a list of Messages."""
 
 
@@ -71,8 +129,20 @@ class StringPromptValue(PromptValue):
         """Return prompt as string."""
         return self.text
 
-    def to_messages(self) -> list[BaseMessage]:
+    @overload
+    def to_messages(
+        self, message_version: Literal["v0"] = "v0"
+    ) -> list[BaseMessage]: ...
+
+    @overload
+    def to_messages(self, message_version: Literal["v1"]) -> list[MessageV1]: ...
+
+    def to_messages(
+        self, message_version: Literal["v0", "v1"] = "v0"
+    ) -> Union[Sequence[BaseMessage], Sequence[MessageV1]]:
         """Return prompt as messages."""
+        if message_version == "v1":
+            return [HumanMessageV1(content=self.text)]
         return [HumanMessage(content=self.text)]
 
 
@@ -89,8 +159,24 @@ class ChatPromptValue(PromptValue):
         """Return prompt as string."""
         return get_buffer_string(self.messages)
 
-    def to_messages(self) -> list[BaseMessage]:
-        """Return prompt as a list of messages."""
+    @overload
+    def to_messages(
+        self, message_version: Literal["v0"] = "v0"
+    ) -> list[BaseMessage]: ...
+
+    @overload
+    def to_messages(self, message_version: Literal["v1"]) -> list[MessageV1]: ...
+
+    def to_messages(
+        self, message_version: Literal["v0", "v1"] = "v0"
+    ) -> Union[Sequence[BaseMessage], Sequence[MessageV1]]:
+        """Return prompt as a list of messages.
+
+        Args:
+            message_version: The output version, either "v0" (default) or "v1".
+        """
+        if message_version == "v1":
+            return [_convert_to_v1(m) for m in self.messages]
         return list(self.messages)
 
     @classmethod
@@ -125,8 +211,26 @@ class ImagePromptValue(PromptValue):
         """Return prompt (image URL) as string."""
         return self.image_url["url"]
 
-    def to_messages(self) -> list[BaseMessage]:
+    @overload
+    def to_messages(
+        self, message_version: Literal["v0"] = "v0"
+    ) -> list[BaseMessage]: ...
+
+    @overload
+    def to_messages(self, message_version: Literal["v1"]) -> list[MessageV1]: ...
+
+    def to_messages(
+        self, message_version: Literal["v0", "v1"] = "v0"
+    ) -> Union[Sequence[BaseMessage], Sequence[MessageV1]]:
         """Return prompt (image URL) as messages."""
+        if message_version == "v1":
+            block: types.ImageContentBlock = {
+                "type": "image",
+                "url": self.image_url["url"],
+            }
+            if "detail" in self.image_url:
+                block["detail"] = self.image_url["detail"]
+            return [HumanMessageV1(content=[block])]
         return [HumanMessage(content=[cast("dict", self.image_url)])]
 
 

langchain_core/prompts/base.py

@@ -307,6 +307,7 @@ class BasePromptTemplate(
         .. code-block:: python
 
             prompt.format(variable1="foo")
+
         """
 
     async def aformat(self, **kwargs: Any) -> FormatOutputType:
@@ -323,6 +324,7 @@ class BasePromptTemplate(
         .. code-block:: python
 
             await prompt.aformat(variable1="foo")
+
         """
         return self.format(**kwargs)
 
@@ -363,6 +365,7 @@ class BasePromptTemplate(
         .. code-block:: python
 
             prompt.save(file_path="path/prompt.yaml")
+
         """
         if self.partial_variables:
             msg = "Cannot save prompt with partial variables."
@@ -442,6 +445,7 @@ def format_document(doc: Document, prompt: BasePromptTemplate[str]) -> str:
             prompt = PromptTemplate.from_template("Page {page}: {page_content}")
             format_document(doc, prompt)
             >>> "Page 1: This is a joke"
+
     """
     return prompt.format(**_get_document_info(doc, prompt))
 

langchain_core/prompts/chat.py

@@ -126,6 +126,7 @@ class MessagesPlaceholder(BaseMessagePromptTemplate):
             # -> [
             #     HumanMessage(content="Hello!"),
             # ]
+
     """
 
     variable_name: str
@@ -1164,6 +1165,7 @@ class ChatPromptTemplate(BaseChatPromptTemplate):
 
         Returns:
             a chat prompt template.
+
         """
         return cls(messages, template_format=template_format)
 
@@ -1248,6 +1250,7 @@ class ChatPromptTemplate(BaseChatPromptTemplate):
                 template2 = template.partial(user="Lucy", name="R2D2")
 
                 template2.format_messages(input="hello")
+
         """
         prompt_dict = self.__dict__.copy()
         prompt_dict["input_variables"] = list(

langchain_core/prompts/few_shot.py

@@ -357,6 +357,7 @@ class FewShotChatMessagePromptTemplate(
             from langchain_core.chat_models import ChatAnthropic
             chain = final_prompt | ChatAnthropic(model="claude-3-haiku-20240307")
             chain.invoke({"input": "What's 3+3?"})
+
     """
 
     input_variables: list[str] = Field(default_factory=list)

langchain_core/prompts/few_shot_with_templates.py

@@ -122,6 +122,7 @@ class FewShotPromptWithTemplates(StringPromptTemplate):
         .. code-block:: python
 
             prompt.format(variable1="foo")
+
         """
         kwargs = self._merge_partial_and_user_variables(**kwargs)
         # Get the examples to use.

langchain_core/prompts/image.py

@@ -90,6 +90,7 @@ class ImagePromptTemplate(BasePromptTemplate[ImageURL]):
             .. code-block:: python
 
                 prompt.format(variable1="foo")
+
         """
         formatted = {}
         for k, v in self.template.items():

langchain_core/prompts/pipeline.py

@@ -45,6 +45,7 @@ class PipelinePromptTemplate(BasePromptTemplate):
           Each PromptTemplate will be formatted and then passed
           to future prompt templates as a variable with
           the same name as `name`
+
     """
 
     final_prompt: BasePromptTemplate

langchain_core/prompts/prompt.py

@@ -56,6 +56,7 @@ class PromptTemplate(StringPromptTemplate):
 
             # Instantiation using initializer
             prompt = PromptTemplate(template="Say {foo}")
+
     """
 
     @property

langchain_core/prompts/structured.py

@@ -115,6 +115,7 @@ class StructuredPrompt(ChatPromptTemplate):
 
         Returns:
             a structured prompt template
+
         """
         return cls(messages, schema, **kwargs)
 

langchain_core/rate_limiters.py

@@ -123,6 +123,7 @@ class InMemoryRateLimiter(BaseRateLimiter):
 
 
     .. versionadded:: 0.2.24
+
     """  # noqa: E501
 
     def __init__(

langchain_core/retrievers.py

@@ -124,6 +124,7 @@ class BaseRetriever(RunnableSerializable[RetrieverInput, RetrieverOutput], ABC):
                     # Op -- (n_docs,1) -- Cosine Sim with each doc
                     results = cosine_similarity(self.tfidf_array, query_vec).reshape((-1,))
                     return [self.docs[i] for i in results.argsort()[-self.k :][::-1]]
+
     """  # noqa: E501
 
     model_config = ConfigDict(
@@ -230,6 +231,7 @@ class BaseRetriever(RunnableSerializable[RetrieverInput, RetrieverOutput], ABC):
         .. code-block:: python
 
             retriever.invoke("query")
+
         """
         from langchain_core.callbacks.manager import CallbackManager
 
@@ -294,6 +296,7 @@ class BaseRetriever(RunnableSerializable[RetrieverInput, RetrieverOutput], ABC):
         .. code-block:: python
 
             await retriever.ainvoke("query")
+
         """
         from langchain_core.callbacks.manager import AsyncCallbackManager