From 2cd77a53a3ba36a4703c0f9a5d6c7f559cc63ba7 Mon Sep 17 00:00:00 2001 From: Ashvin Date: Fri, 23 Aug 2024 21:19:41 +0530 Subject: [PATCH] docs: Add docstrings for CassandraChatMessageHistory class and package namespace function. (#24222) - Modified docstring for CassandraChatMessageHistory in libs/community/langchain_community/chat_message_history/cassandra.py. - Added docstring for _package_namespace function in docs/api_reference/create_api_rst.py --------- Co-authored-by: ashvin Co-authored-by: Erick Friis Co-authored-by: ccurme --- docs/api_reference/create_api_rst.py | 8 ++++++++ .../chat_message_histories/cassandra.py | 5 ++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/api_reference/create_api_rst.py b/docs/api_reference/create_api_rst.py index 5d7c558cea4..bb67e0bcd00 100644 --- a/docs/api_reference/create_api_rst.py +++ b/docs/api_reference/create_api_rst.py @@ -471,6 +471,14 @@ def _build_rst_file(package_name: str = "langchain") -> None: def _package_namespace(package_name: str) -> str: + """Returns the package name used. + + Args: + package_name: Can be either "langchain" or "core" or "experimental". + + Returns: + modified package_name: Can be either "langchain" or "langchain_{package_name}" + """ return ( package_name if package_name == "langchain" diff --git a/libs/community/langchain_community/chat_message_histories/cassandra.py b/libs/community/langchain_community/chat_message_histories/cassandra.py index 5437ea01a9f..f35ea5cede7 100644 --- a/libs/community/langchain_community/chat_message_histories/cassandra.py +++ b/libs/community/langchain_community/chat_message_histories/cassandra.py @@ -31,6 +31,8 @@ def _rows_to_messages(rows: Iterable[RowType]) -> List[BaseMessage]: class CassandraChatMessageHistory(BaseChatMessageHistory): + """Chat message history that is backed by Cassandra.""" + def __init__( self, session_id: str, @@ -41,7 +43,8 @@ class CassandraChatMessageHistory(BaseChatMessageHistory): *, setup_mode: SetupMode = SetupMode.SYNC, ) -> None: - """Chat message history that stores history in Cassandra. + """ + Initialize a new instance of CassandraChatMessageHistory. Args: session_id: arbitrary key that is used to store the messages