Skip to main content

langchain-falkordb

PyPI version License: MIT CI

This package contains the LangChain integration for FalkorDB, a low-latency graph database with native vector and full-text indexing.

It provides:

  • FalkorDBGraph — a graph wrapper with schema introspection and GraphDocument ingestion, for building knowledge graphs.
  • FalkorDBVector — a LangChain vector store backed by FalkorDB vector indexes, with support for metadata filtering, maximal marginal relevance (MMR) search, and hybrid (vector + full-text) search.
  • FalkorDBQAChain — a natural-language-to-Cypher question-answering chain over a FalkorDB graph.
  • FalkorDBSaver — a LangGraph checkpointer that persists agent state in FalkorDB (pip install langchain-falkordb[langgraph]).
  • FalkorDBChatMessageHistory — a LangChain chat message history that persists conversations in FalkorDB.

Installation

pip install langchain-falkordb

You also need a running FalkorDB instance. The easiest way is Docker:

docker run -p 6379:6379 -it --rm falkordb/falkordb:latest

or use a free FalkorDB Cloud instance.

Graph wrapper

FalkorDBGraph gives you direct Cypher access with schema introspection, and ingests GraphDocument objects (e.g. produced by an LLM graph transformer):

from langchain_core.documents import Document
from langchain_falkordb import FalkorDBGraph
from langchain_falkordb.graphs import GraphDocument, Node, Relationship

graph = FalkorDBGraph("movies", host="localhost", port=6379)

tom = Node(id="Tom Hanks", type="Actor")
gump = Node(id="Forrest Gump", type="Movie")
graph.add_graph_documents(
    [
        GraphDocument(
            nodes=[tom, gump],
            relationships=[Relationship(source=tom, target=gump, type="ACTED_IN")],
            source=Document(page_content="Tom Hanks acted in Forrest Gump."),
        )
    ],
    include_source=True,  # links entities to their source Document node
)

graph.refresh_schema()
print(graph.get_schema)
print(graph.query("MATCH (a:Actor)-[:ACTED_IN]->(m:Movie) RETURN a.id, m.id"))

It also works with LLMGraphTransformer from langchain-experimental to build knowledge graphs from unstructured text: pass the transformer's GraphDocument output straight to add_graph_documents.

Vector store

FalkorDBVector works with any Embeddings implementation. The examples below use OpenAIEmbeddings from langchain-openai.

from langchain_falkordb import FalkorDBVector
from langchain_openai import OpenAIEmbeddings

vectorstore = FalkorDBVector.from_texts(
    texts=[
        "FalkorDB is a graph database",
        "LangChain is a framework for LLM applications",
    ],
    embedding=OpenAIEmbeddings(),
    host="localhost",
    port=6379,
    database="my_knowledge_base",  # optional; generated if omitted
)

results = vectorstore.similarity_search("What is FalkorDB?", k=1)
print(results[0].page_content)

Adding and managing documents

from langchain_core.documents import Document

vectorstore.add_documents(
    [Document(page_content="FalkorDB supports vector search", metadata={"topic": "search"})],
    ids=["doc-1"],
)

vectorstore.get_by_ids(["doc-1"])  # fetch by id
vectorstore.delete(["doc-1"])      # delete by id

Adding a document with an existing id overwrites it (upsert semantics).

Metadata filtering

results = vectorstore.similarity_search(
    "graph databases",
    k=4,
    filter={"topic": "search"},
)

Filter values are always passed as query parameters, never interpolated into the Cypher query.

Maximal marginal relevance (MMR) search

results = vectorstore.max_marginal_relevance_search(
    "graph databases", k=4, fetch_k=20, lambda_mult=0.5
)

Hybrid search

Hybrid search combines the vector index with a full-text index over the document text:

from langchain_falkordb import FalkorDBVector, SearchType

vectorstore = FalkorDBVector.from_texts(
    texts=["FalkorDB is a graph database"],
    embedding=OpenAIEmbeddings(),
    search_type=SearchType.HYBRID,
)

Reusing existing indexes and graphs

# Connect to a vector index that already contains data
store = FalkorDBVector.from_existing_index(
    embedding=OpenAIEmbeddings(),
    database="my_knowledge_base",
    node_label="Chunk",
)

# Embed and search text properties of an existing graph
store = FalkorDBVector.from_existing_graph(
    embedding=OpenAIEmbeddings(),
    database="my_graph",
    node_label="Document",
    embedding_node_property="embedding",
    text_node_properties=["title", "content"],
)

Question answering over a graph

FalkorDBQAChain turns a natural-language question into Cypher, runs it, and phrases the answer:

from langchain_falkordb import FalkorDBGraph, FalkorDBQAChain
from langchain_openai import ChatOpenAI

graph = FalkorDBGraph("movies")
chain = FalkorDBQAChain.from_llm(
    ChatOpenAI(model="gpt-4o-mini"),
    graph=graph,
    allow_dangerous_requests=True,  # explicit opt-in, see security note below
)
print(chain.invoke({"query": "Who acted in Forrest Gump?"})["result"])

Security note: the chain executes LLM-generated Cypher against your database. Use narrowly-scoped credentials and set allow_dangerous_requests=True only after understanding the risks.

LangGraph checkpointer

FalkorDBSaver persists LangGraph agent state in FalkorDB, so threads survive restarts and can be shared between processes:

pip install langchain-falkordb[langgraph]
from langchain_falkordb.checkpoint import FalkorDBSaver

checkpointer = FalkorDBSaver(host="localhost", port=6379)
graph = builder.compile(checkpointer=checkpointer)  # any StateGraph builder
graph.invoke({"total": 0}, {"configurable": {"thread_id": "thread-1"}})

Chat message history

from langchain_falkordb import FalkorDBChatMessageHistory

history = FalkorDBChatMessageHistory(
    session_id="user-42",
    host="localhost",
    port=6379,
)

history.add_user_message("Hello!")
history.add_ai_message("Hi! How can I help?")
print(history.messages)

Each session is stored in its own graph named after the session_id, so histories are isolated per session and survive reconnects.

Authentication

For protected instances (e.g. FalkorDB Cloud), pass username / password (and ssl=True if applicable) to the constructors, or set the FALKORDB_USERNAME and FALKORDB_PASSWORD environment variables.

Development

git clone https://github.com/FalkorDB/langchain-falkordb.git
cd langchain-falkordb
poetry install --with test,lint,typing

Run unit tests (no services needed):

poetry run pytest tests/unit_tests --disable-socket

Run integration tests (requires FalkorDB on localhost:6379, override with FALKORDB_HOST / FALKORDB_PORT):

docker run -d -p 6379:6379 falkordb/falkordb:latest
poetry run pytest tests/integration_tests

Lint and type-check:

poetry run ruff check .
poetry run ruff format --check .
poetry run mypy langchain_falkordb

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langchain_falkordb-0.2.0.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langchain_falkordb-0.2.0-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file langchain_falkordb-0.2.0.tar.gz.

File metadata

  • Download URL: langchain_falkordb-0.2.0.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for langchain_falkordb-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d6c9d9ec5c864ac4f626cea34cbcd289f142d0aef83aaa62c2064365ff1597f5
MD5 66f58e0d4891dc5fb37f76c0f955b416
BLAKE2b-256 3516646fafe26b33a64fa591755a2f6fa82c18926039fe3d2ef50fc06bea0403

See more details on using hashes here.

Provenance

The following attestation bundles were made for langchain_falkordb-0.2.0.tar.gz:

Publisher: python-publish.yml on FalkorDB/langchain-falkordb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file langchain_falkordb-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_falkordb-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 851dce461a081001b1b536d4a72209f46f6225c3da8b217f54ce49b5d2b65b0a
MD5 02fa58175c1cf98acde1faeb5146c674
BLAKE2b-256 af08e793da0f11318ad07f945c458634b24473c8175b4b70a2878d9bd354f2f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for langchain_falkordb-0.2.0-py3-none-any.whl:

Publisher: python-publish.yml on FalkorDB/langchain-falkordb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page