From c959d7bdd5be2fb0b6d84bcb9a9b05dd88cf5e6a Mon Sep 17 00:00:00 2001 From: Gabriel Luiz Freitas Almeida Date: Sun, 9 Jul 2023 10:51:18 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(constants.py):=20add=20miss?= =?UTF-8?q?ing=20documentation=20for=20INPUT=5FKEY=5FINFO=20and=20OUTPUT?= =?UTF-8?q?=5FKEY=5FINFO=20variables?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🐛 fix(memories.py): set info field for input_key and output_key fields to provide additional information to users --- src/backend/langflow/template/frontend_node/constants.py | 4 ++++ src/backend/langflow/template/frontend_node/memories.py | 7 ++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/backend/langflow/template/frontend_node/constants.py b/src/backend/langflow/template/frontend_node/constants.py index 90cdbf280..295995586 100644 --- a/src/backend/langflow/template/frontend_node/constants.py +++ b/src/backend/langflow/template/frontend_node/constants.py @@ -58,3 +58,7 @@ The base URL of the OpenAI API. Defaults to https://api.openai.com/v1. You can change this to use other APIs like JinaChat, LocalAI and Prem. """ + + +INPUT_KEY_INFO = """The variable to be used as Chat Input when more than one variable is available.""" +OUTPUT_KEY_INFO = """The variable to be used as Chat Output (e.g. answer in a ConversationalRetrievalChain)""" diff --git a/src/backend/langflow/template/frontend_node/memories.py b/src/backend/langflow/template/frontend_node/memories.py index d98a322ff..6ca85f3ac 100644 --- a/src/backend/langflow/template/frontend_node/memories.py +++ b/src/backend/langflow/template/frontend_node/memories.py @@ -2,6 +2,7 @@ from typing import Optional from langflow.template.field.base import TemplateField from langflow.template.frontend_node.base import FrontendNode +from langflow.template.frontend_node.constants import INPUT_KEY_INFO, OUTPUT_KEY_INFO from langflow.template.template.base import Template from langchain.memory.chat_message_histories.postgres import DEFAULT_CONNECTION_STRING from langchain.memory.chat_message_histories.mongodb import ( @@ -70,11 +71,15 @@ class MemoryFrontendNode(FrontendNode): field.required = False field.show = True field.advanced = False - if field.name in ["input_key", "output_key"]: + if field.name in {"input_key", "output_key"}: field.required = False field.show = True field.advanced = False field.value = "" + field.info = ( + INPUT_KEY_INFO if field.name == "input_key" else OUTPUT_KEY_INFO + ) + if field.name == "memory_key": field.value = "chat_history" if field.name == "chat_memory":