Skip to main content

LangChain retriever for traversing document graphs on top of vector-based similarity search.

Project description

LangChain Graph Retriever

LangChain Graph Retriever is a Python library that supports traversing a document graph on top of vector-based similarity search. It works seamlessly with LangChain's retriever framework and supports various graph traversal strategies for efficient document discovery.

Features

  • Vector Search: Perform similarity searches using vector embeddings.
  • Graph Traversal: Apply traversal strategies such as breadth-first (Eager) or Maximal Marginal Relevance (MMR) to explore document relationships.
  • Customizable Strategies: Easily extend and configure traversal strategies to meet your specific use case.
  • Multiple Adapters: Support for various vector stores, including AstraDB, Cassandra, Chroma, OpenSearch, and in-memory storage.
  • Synchronous and Asynchronous Retrieval: Supports both sync and async workflows for flexibility in different applications.

Installation

Install the library via pip:

pip install langchain-graph-retriever

Getting Started

Here is an example of how to use LangChain Graph Retriever:

from langchain_graph_retriever import GraphRetriever
from langchain_core.vectorstores import Chroma

# Initialize the vector store (Chroma in this example)
vector_store = Chroma(embedding_function=your_embedding_function)

# Create the Graph Retriever
retriever = GraphRetriever(
    store=vector_store,
    # Define edges based on document metadata
    edges=[("keywords", "keywords")],
)

# Perform a retrieval
documents = retriever.retrieve("What is the capital of France?")

# Print the results
for doc in documents:
    print(doc.page_content)

License

This project is licensed under the Apache 2 License. See the LICENSE file for more details.

Project details


Download files

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

Source Distribution

langchain_graph_retriever-0.3.0.tar.gz (49.0 kB view details)

Uploaded Source

Built Distribution

langchain_graph_retriever-0.3.0-py3-none-any.whl (48.2 kB view details)

Uploaded Python 3

File details

Details for the file langchain_graph_retriever-0.3.0.tar.gz.

File metadata

File hashes

Hashes for langchain_graph_retriever-0.3.0.tar.gz
Algorithm Hash digest
SHA256 58e1eb7b8b64af405135b22adbeae415c562cda2b22fca1bec42274d7d58af62
MD5 c1546140e5488350a54ba6dceb66b935
BLAKE2b-256 141b41bf53e558fec3d55d9f9c9d9d19c640c3c386a21959baedee0e4b72985e

See more details on using hashes here.

File details

Details for the file langchain_graph_retriever-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_graph_retriever-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0561efda22b96571cb78eecbe617f38da8c0f571e2d8ce36131c40a7ad513b62
MD5 1cbab0b42e3a026b1f4d6deacba70b0d
BLAKE2b-256 c9c03e1035763f617152a7fa91d7f3e2b9a2ef1fe0eaf21d8f4b5fbb28454322

See more details on using hashes here.

Supported by

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