Elasticsearch
Elasticsearch is a distributed, RESTful search and analytics engine, capable of performing both vector and lexical search. It is built on top of the Apache Lucene library.
This notebook shows how to use chat message history functionality with Elasticsearch
.
Set up Elasticsearchβ
There are two main ways to set up an Elasticsearch instance:
Elastic Cloud. Elastic Cloud is a managed Elasticsearch service. Sign up for a free trial.
Local Elasticsearch installation. Get started with Elasticsearch by running it locally. The easiest way is to use the official Elasticsearch Docker image. See the Elasticsearch Docker documentation for more information.
Install dependenciesβ
%pip install --upgrade --quiet elasticsearch langchain
Authenticationβ
How to obtain a password for the default "elastic" userβ
To obtain your Elastic Cloud password for the default "elastic" user:
- Log in to the Elastic Cloud console
- Go to "Security" > "Users"
- Locate the "elastic" user and click "Edit"
- Click "Reset password"
- Follow the prompts to reset the password
Use the Username/passwordβ
es_username = os.environ.get("ES_USERNAME", "elastic")
es_password = os.environ.get("ES_PASSWORD", "change me...")
history = ElasticsearchChatMessageHistory(
es_url=es_url,
es_user=es_username,
es_password=es_password,
index="test-history",
session_id="test-session"
)
How to obtain an API keyβ
To obtain an API key:
- Log in to the Elastic Cloud console
- Open
Kibana
and go to Stack Management > API Keys - Click "Create API key"
- Enter a name for the API key and click "Create"
Use the API keyβ
es_api_key = os.environ.get("ES_API_KEY")
history = ElasticsearchChatMessageHistory(
es_api_key=es_api_key,
index="test-history",
session_id="test-session"
)
Initialize Elasticsearch client and chat message historyβ
import os
from langchain_community.chat_message_histories import (
ElasticsearchChatMessageHistory,
)
es_url = os.environ.get("ES_URL", "http://localhost:9200")
# If using Elastic Cloud:
# es_cloud_id = os.environ.get("ES_CLOUD_ID")
# Note: see Authentication section for various authentication methods
history = ElasticsearchChatMessageHistory(
es_url=es_url, index="test-history", session_id="test-session"
)
API Reference:
Use the chat message historyβ
history.add_user_message("hi!")
history.add_ai_message("whats up?")
indexing message content='hi!' additional_kwargs={} example=False
indexing message content='whats up?' additional_kwargs={} example=False