Skip to content

feat: Add placeholder for LangChain with Memorystore Redis integration #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 16, 2024
Merged

feat: Add placeholder for LangChain with Memorystore Redis integration #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee284f3
feat: Add placeholder for LangChain with Memorystore Redis integration
PingXie Feb 16, 2024
7351c44
fix: fix formatting of the notebooks
craig08 Feb 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
362 changes: 181 additions & 181 deletions docs/chat_message_history.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,184 +1,184 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {
"id": "6-0_o3DxsFGi"
},
"source": [
"Google Database\n",
"\n",
"Use [Google Memorystore for Redis](https://cloud.google.com/memorystore/docs/redis/memorystore-for-redis-overview) to store chat message history for LangChain."
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "dWakBoPnsFGj"
},
"source": [
"## Pre-reqs"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "EudfLv_UsFGk"
},
"source": [
"### Setting Up a Memorystore for Redis Instance\n",
"\n",
"Before proceeding, an active Memorystore for Redis instance is needed to store chat message history:\n",
"\n",
"* Create a Memorystore for Redis Instance (>= 5.0): If an instance doesn't exist, follow the instructions at https://cloud.google.com/memorystore/docs/redis/create-instance-console to create a new one. Ensure the version is greater than or equal to 5.0.\n",
"* Obtain Endpoint: Note the endpoint associated with the instance."
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "J5nxjYxHsFGk"
},
"source": [
"### Installing the LangChain Memorystore for Redis Module\n",
"\n",
"Interaction with the Memorystore for Redis instance from LangChain requires installing the necessary module:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"tags": [],
"id": "iLwVMVkYsFGk"
},
"outputs": [],
"source": [
"# Install Memorystore for Redis for LangChain module\n",
"%pip install langchain_google_memorystore_redis"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "2L7kMu__sFGl"
},
"source": [
"## Basic Usage"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "A2fT1iEhsFGl"
},
"source": [
"### Initialize a MemorystoreChatMessageHistory\n",
"\n",
"Each chat message history object must have a unique session ID. If the session ID already has messages stored in Redis, they will can be retrieved."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "YEDKWR6asFGl"
},
"outputs": [],
"source": [
"import redis\n",
"from langchain_google_memorystore_redis import MemorystoreChatMessageHistory\n",
"\n",
"# Connect to a Memorystore for Redis instance\n",
"redis_client = redis.from_url(\"redis://127.0.0.1:6379\")\n",
"\n",
"message_history = MemorystoreChatMessageHistory(redis_client, session_id='session1')"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "EmoJcTgosFGl"
},
"source": [
"### Add Messages"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "gB1PGe6wsFGm"
},
"outputs": [],
"source": [
"message_history.add_ai_message('Hey! I am AI!')\n",
"message_history.add_user_message('Hey! I am human!')"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "02xxvmzTsFGm"
},
"source": [
"### Retrieve All Messages Stored in the Session"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "BvS3UFsysFGm"
},
"outputs": [],
"source": [
"message_history.messages"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "sFJdt3ubsFGo"
},
"source": [
"### Clear Messages"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "H5I7K3MTsFGo"
},
"outputs": [],
"source": [
"message_history.clear()"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.6"
},
"colab": {
"provenance": []
}
"cells": [
{
"cell_type": "markdown",
"metadata": {
"id": "6-0_o3DxsFGi"
},
"source": [
"Google Database\n",
"\n",
"Use [Google Memorystore for Redis](https://cloud.google.com/memorystore/docs/redis/memorystore-for-redis-overview) to store chat message history for LangChain."
]
},
"nbformat": 4,
"nbformat_minor": 0
{
"cell_type": "markdown",
"metadata": {
"id": "dWakBoPnsFGj"
},
"source": [
"## Pre-reqs"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "EudfLv_UsFGk"
},
"source": [
"### Setting Up a Memorystore for Redis Instance\n",
"\n",
"Before proceeding, an active Memorystore for Redis instance is needed to store chat message history:\n",
"\n",
"* Create a Memorystore for Redis Instance (>= 5.0): If an instance doesn't exist, follow the instructions at https://cloud.google.com/memorystore/docs/redis/create-instance-console to create a new one. Ensure the version is greater than or equal to 5.0.\n",
"* Obtain Endpoint: Note the endpoint associated with the instance."
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "J5nxjYxHsFGk"
},
"source": [
"### Installing the LangChain Memorystore for Redis Module\n",
"\n",
"Interaction with the Memorystore for Redis instance from LangChain requires installing the necessary module:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"tags": [],
"id": "iLwVMVkYsFGk"
},
"outputs": [],
"source": [
"# Install Memorystore for Redis for LangChain module\n",
"%pip install langchain_google_memorystore_redis"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "2L7kMu__sFGl"
},
"source": [
"## Basic Usage"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "A2fT1iEhsFGl"
},
"source": [
"### Initialize a MemorystoreChatMessageHistory\n",
"\n",
"Each chat message history object must have a unique session ID. If the session ID already has messages stored in Redis, they will can be retrieved."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "YEDKWR6asFGl"
},
"outputs": [],
"source": [
"import redis\n",
"from langchain_google_memorystore_redis import MemorystoreChatMessageHistory\n",
"\n",
"# Connect to a Memorystore for Redis instance\n",
"redis_client = redis.from_url(\"redis://127.0.0.1:6379\")\n",
"\n",
"message_history = MemorystoreChatMessageHistory(redis_client, session_id=\"session1\")"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "EmoJcTgosFGl"
},
"source": [
"### Add Messages"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "gB1PGe6wsFGm"
},
"outputs": [],
"source": [
"message_history.add_ai_message(\"Hey! I am AI!\")\n",
"message_history.add_user_message(\"Hey! I am human!\")"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "02xxvmzTsFGm"
},
"source": [
"### Retrieve All Messages Stored in the Session"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "BvS3UFsysFGm"
},
"outputs": [],
"source": [
"message_history.messages"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "sFJdt3ubsFGo"
},
"source": [
"### Clear Messages"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "H5I7K3MTsFGo"
},
"outputs": [],
"source": [
"message_history.clear()"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.6"
},
"colab": {
"provenance": []
}
},
"nbformat": 4,
"nbformat_minor": 0
}
Loading