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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.4.3.tar.gz
Algorithm Hash digest
SHA256 2805627ad7ccc35a0b6baa09633eeaf61e4b2ec04573ebf7bcd1cc3585f8d566
MD5 b374f50a1f0dbbbe2df0892efe7ce0a4
BLAKE2b-256 79acd33effbd981ded195395dfbd10fb25c6ce78c248d5b226afa2e0c74f76cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for langchain_graph_retriever-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1aa301c740bbe0b7220d6c2ca6d881629b9eab7ff02145c9d06b19fe7b79c65e
MD5 5e534596281970531de358767d351d1b
BLAKE2b-256 e3573c150bc3ea0dcc12edbfd737724527e0b9d7139d8ee20a741f72f6edc26b

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