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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.6.0.tar.gz
Algorithm Hash digest
SHA256 89601fd9724b75d18d0cb6196ddb24af764d18b163023b415965e46a050dc5a0
MD5 846c13ea086994a2cdc27a5792683fa6
BLAKE2b-256 d4688de7ff68b2f7fca588cc555c353c256def2b915e1cd255c2dfa6ebc57335

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cec41964184d4dc2827905b1f94da1c2547867dcba14aa835a62c0d95fd050dc
MD5 ac784b44b925eafa788b22ea8bdb6d78
BLAKE2b-256 45b7e2b0da7e7316da125d500fba374d7a87e853e816f341b7084a14e0278c2a

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