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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.4.0.tar.gz
Algorithm Hash digest
SHA256 354ccebdecc6e1b8232c15daebe7f63921762809ce5c97018006925c0ac0cb32
MD5 03b5a47cbe0aa19443bb8e6b993270a4
BLAKE2b-256 b4adc97d53f32c00d1dfac59c43bc5f57f284f81058c1397dbfacceb65526a87

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9eee55837b4743af7747f4a4618002e36bdefe5f52f8ae6f1d640d4f7a625388
MD5 c9b7269a049b59823b2fda74a83e26e8
BLAKE2b-256 87493e5dcbb39c97df9784ec9921445303d10ab4e6bbaeeeb1062f35bffe988f

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