dv-pipecat-ai 0.0.74.dev770__py3-none-any.whl → 0.0.82.dev776__py3-none-any.whl

pipecat/processors/frameworks/langchain.py

@@ -4,6 +4,8 @@
 # SPDX-License-Identifier: BSD 2-Clause License
 #
 
+"""Langchain integration processor for Pipecat."""
+
 from typing import Optional, Union
 
 from loguru import logger
@@ -12,9 +14,9 @@ from pipecat.frames.frames import (
     Frame,
     LLMFullResponseEndFrame,
     LLMFullResponseStartFrame,
-    LLMMessagesFrame,
     TextFrame,
 )
+from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContextFrame
 from pipecat.processors.frame_processor import FrameDirection, FrameProcessor
 
 try:
@@ -26,23 +28,47 @@ except ModuleNotFoundError as e:
 
 
 class LangchainProcessor(FrameProcessor):
+    """Processor that integrates Langchain runnables with Pipecat's frame pipeline.
+
+    This processor takes LLM message frames, extracts the latest user message,
+    and processes it through a Langchain runnable chain. The response is streamed
+    back as text frames with appropriate response markers.
+    """
+
     def __init__(self, chain: Runnable, transcript_key: str = "input"):
+        """Initialize the Langchain processor.
+
+        Args:
+            chain: The Langchain runnable to use for processing messages.
+            transcript_key: The key to use when passing input to the chain.
+        """
         super().__init__()
         self._chain = chain
         self._transcript_key = transcript_key
         self._participant_id: Optional[str] = None
 
     def set_participant_id(self, participant_id: str):
+        """Set the participant ID for session tracking.
+
+        Args:
+            participant_id: The participant ID to use for session configuration.
+        """
         self._participant_id = participant_id
 
     async def process_frame(self, frame: Frame, direction: FrameDirection):
+        """Process incoming frames and handle LLM message frames.
+
+        Args:
+            frame: The incoming frame to process.
+            direction: The direction of frame flow in the pipeline.
+        """
         await super().process_frame(frame, direction)
 
-        if isinstance(frame, LLMMessagesFrame):
+        if isinstance(frame, OpenAILLMContextFrame):
             # Messages are accumulated on the context as a list of messages.
             # The last one by the human is the one we want to send to the LLM.
             logger.debug(f"Got transcription frame {frame}")
-            text: str = frame.messages[-1]["content"]
+            text: str = frame.context.messages[-1]["content"]
 
             await self._ainvoke(text.strip())
         else:
@@ -50,6 +76,14 @@ class LangchainProcessor(FrameProcessor):
 
     @staticmethod
     def __get_token_value(text: Union[str, AIMessageChunk]) -> str:
+        """Extract token value from various text types.
+
+        Args:
+            text: The text or message chunk to extract value from.
+
+        Returns:
+            The extracted string value.
+        """
         match text:
             case str():
                 return text
@@ -59,6 +93,7 @@ class LangchainProcessor(FrameProcessor):
                 return ""
 
     async def _ainvoke(self, text: str):
+        """Invoke the Langchain runnable with the provided text."""
         logger.debug(f"Invoking chain with {text}")
         await self.push_frame(LLMFullResponseStartFrame())
         try: