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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.4.2.tar.gz
Algorithm Hash digest
SHA256 479019b9de7a40c5258e9e93e0b10b431811ebd6ce9af3852c83964c813b6a0d
MD5 1567d3a0bf9f4703e740cd8db37409b3
BLAKE2b-256 d2ddd09fcfb785a7ed5641aa3bf1bb4a2cd33421d32cf5b66062b99cc8ea9dde

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 421cf890c040e92b6045303fbeefc39578caa2906589b10c0cad46d0da4e80ea
MD5 4108335b6bd37b487e79e097f4d65040
BLAKE2b-256 2f0e6d76d95db025949efd3f6489dd6dc70b4ab6c269a8d468d337877fb13c16

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