a
    •˜ëjZ  ã                   @   s’   d Z ddlmZ ddlmZ ddlmZ ddlmZm	Z	m
Z
 ddlmZmZ ddlmZ ddlmZ dd	lmZ ed
ddd�G dd„ deƒƒZdS )z6Chain that carries on a conversation and calls an LLM.é    )Ú
deprecated)Ú
BaseMemory)ÚBasePromptTemplate)Ú
ConfigDictÚFieldÚmodel_validator)ÚSelfÚoverride)ÚPROMPT)ÚLLMChain)ÚConversationBufferMemoryz0.2.7z;langchain_core.runnables.history.RunnableWithMessageHistoryz1.0)ZsinceÚalternativeZremovalc                   @   s˜   e Zd ZU dZeed�Zeed< e	Z
eed< dZeed< dZeed< ed	d
d�Zeeedœdd„ƒƒZeee dœdd„ƒZedd�edœdd„ƒZdS )ÚConversationChainaƒ  Chain to have a conversation and load context from memory.

    This class is deprecated in favor of ``RunnableWithMessageHistory``. Please refer
    to this tutorial for more detail: https://python.langchain.com/docs/tutorials/chatbot/

    ``RunnableWithMessageHistory`` offers several benefits, including:

    - Stream, batch, and async support;
    - More flexible memory handling, including the ability to manage memory
      outside the chain;
    - Support for multiple threads.

    Below is a minimal implementation, analogous to using ``ConversationChain`` with
    the default ``ConversationBufferMemory``:

        .. code-block:: python

            from langchain_core.chat_history import InMemoryChatMessageHistory
            from langchain_core.runnables.history import RunnableWithMessageHistory
            from langchain_openai import ChatOpenAI


            store = {}  # memory is maintained outside the chain


            def get_session_history(session_id: str) -> InMemoryChatMessageHistory:
                if session_id not in store:
                    store[session_id] = InMemoryChatMessageHistory()
                return store[session_id]


            llm = ChatOpenAI(model="gpt-3.5-turbo-0125")

            chain = RunnableWithMessageHistory(llm, get_session_history)
            chain.invoke(
                "Hi I'm Bob.",
                config={"configurable": {"session_id": "1"}},
            )  # session_id determines thread

    Memory objects can also be incorporated into the ``get_session_history`` callable:

        .. code-block:: python

            from langchain.memory import ConversationBufferWindowMemory
            from langchain_core.chat_history import InMemoryChatMessageHistory
            from langchain_core.runnables.history import RunnableWithMessageHistory
            from langchain_openai import ChatOpenAI


            store = {}  # memory is maintained outside the chain


            def get_session_history(session_id: str) -> InMemoryChatMessageHistory:
                if session_id not in store:
                    store[session_id] = InMemoryChatMessageHistory()
                    return store[session_id]

                memory = ConversationBufferWindowMemory(
                    chat_memory=store[session_id],
                    k=3,
                    return_messages=True,
                )
                assert len(memory.memory_variables) == 1
                key = memory.memory_variables[0]
                messages = memory.load_memory_variables({})[key]
                store[session_id] = InMemoryChatMessageHistory(messages=messages)
                return store[session_id]


            llm = ChatOpenAI(model="gpt-3.5-turbo-0125")

            chain = RunnableWithMessageHistory(llm, get_session_history)
            chain.invoke(
                "Hi I'm Bob.",
                config={"configurable": {"session_id": "1"}},
            )  # session_id determines thread

    Example:
        .. code-block:: python

            from langchain.chains import ConversationChain
            from langchain_community.llms import OpenAI

            conversation = ConversationChain(llm=OpenAI())

    )Údefault_factoryÚmemoryÚpromptÚinputÚ	input_keyÚresponseÚ
output_keyTZforbid)Zarbitrary_types_allowedÚextra)Úreturnc                 C   s   dS )NF© )Úclsr   r   úa/mnt/bigstor/www/usecases/.venv/lib/python3.9/site-packages/langchain/chains/conversation/base.pyÚis_lc_serializablex   s    z$ConversationChain.is_lc_serializablec                 C   s   | j gS )z5Use this since so some prompt vars come from history.)r   )Úselfr   r   r   Ú
input_keys}   s    zConversationChain.input_keysÚafter)Úmodec                 C   sx   | j j}| j}||v r0d|› d|› d�}t|ƒ‚| jj}g |¢|‘}t|ƒt|ƒkrtd|› d|› d|› d�}t|ƒ‚| S )z4Validate that prompt input variables are consistent.zThe input key z$ was also found in the memory keys (z+) - please provide keys that don't overlap.z:Got unexpected prompt input variables. The prompt expects z
, but got z as inputs from memory, and z as the normal input key.)r   Zmemory_variablesr   Ú
ValueErrorr   Zinput_variablesÚset)r   Zmemory_keysr   ÚmsgZprompt_variablesZexpected_keysr   r   r   Úvalidate_prompt_input_variables‚   s*    ÿÿÿÿþÿz1ConversationChain.validate_prompt_input_variablesN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   r   r   r   Ú__annotations__r
   r   r   r   Ústrr   r   Zmodel_configÚclassmethodr	   Úboolr   ÚpropertyÚlistr   r   r   r#   r   r   r   r   r      s    
Wþr   N)r'   Zlangchain_core._apir   Zlangchain_core.memoryr   Zlangchain_core.promptsr   Zpydanticr   r   r   Ztyping_extensionsr   r	   Z$langchain.chains.conversation.promptr
   Zlangchain.chains.llmr   Zlangchain.memory.bufferr   r   r   r   r   r   Ú<module>   s   ý