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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.5.0.tar.gz
Algorithm Hash digest
SHA256 2cc8aec85aaa461fed569ee44969a50cceceb35d6838f1133fe8908c2702147d
MD5 5f126eb4a448f8500b5d3f38ebfe9361
BLAKE2b-256 8d9ca610b921a9dea7adf7cba07dbe2cd492661a85252d0f93fbf5bce9f79689

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54744a5652e6fc32a3dec14a54b3e8d99b65dbf72bd85de67814e114c959e591
MD5 494ef72aad417c08f103b691d8a2fdef
BLAKE2b-256 7c7e6a16e01e38ce691ef843470e33f753216fd68624410589057148380a6826

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