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.6.3.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

langchain_graph_retriever-0.6.3-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.6.3.tar.gz
Algorithm Hash digest
SHA256 7fab5dd08e6b30f4e8315c261fc87ee20e36a7621935371f5bfb5d6036d68bf7
MD5 e835d000b4145f9804489f1c6a6c91f0
BLAKE2b-256 e1c0e953f5b07f7f62b781f42f0cf291ac7b6385c0351d34be5d7c64e4771df6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 176b77dd23b21f0e1bacc6cc92e3a8df3951afcd43d9bcf199e06ec926ef265d
MD5 17532f3d4705bf23bffee8f7dd3c8c8c
BLAKE2b-256 a7625225bc4756b2ac32d5ff18cce3447a96443539078b24068bd3037e6e295b

See more details on using hashes here.

Supported by

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