added VectorStorage using ChromaDB & Unstructured

pull/570/head
Richard Anthony Hein 9 months ago
parent 63f827852b
commit 48322af3a2

@ -0,0 +1,5 @@
from swarms.server.vector_store import VectorStorage
__all__ = [
"VectorStorage",
]

@ -0,0 +1,219 @@
import asyncio
import json
import os
import glob
from datetime import datetime
from typing import Dict, Literal
from chromadb.config import Settings
from langchain.document_loaders import UnstructuredHTMLLoader
from langchain.embeddings import HuggingFaceBgeEmbeddings
from langchain.storage import LocalFileStore
from langchain.text_splitter import RecursiveCharacterTextSplitter
from langchain.vectorstores.chroma import Chroma
from langchain.schema import BaseRetriever
from swarms.server.async_parent_document_retriever import AsyncParentDocumentRetriever
store_type = "local" # "redis" or "local"
class VectorStorage:
def __init__(self, directory):
self.embeddings = HuggingFaceBgeEmbeddings(
cache_folder="./.embeddings",
model_name="BAAI/bge-large-en",
model_kwargs={"device": "cuda"}, # Use GPU
encode_kwargs={"normalize_embeddings": True},
query_instruction="Represent this sentence for searching relevant passages: ",
)
self.directory = directory
self.child_splitter = RecursiveCharacterTextSplitter(
chunk_size=200, chunk_overlap=20
)
self.parent_splitter = RecursiveCharacterTextSplitter(
chunk_size=2000, chunk_overlap=200
)
if store_type == "redis":
from langchain.storage import RedisStore
from langchain.utilities.redis import get_client
username = r"username"
password = r"password"
client = get_client(
redis_url=f"redis://{username}:{password}@redis-10854.c282.east-us-mz.azure.cloud.redislabs.com:10854"
)
self.store = RedisStore(client=client)
else:
self.store = LocalFileStore(root_path="./.parent_documents")
self.settings = Settings(
persist_directory="./.chroma_db",
is_persistent=True,
anonymized_telemetry=False,
)
# create a new vectorstore or get an existing one, with default collection
self.vectorstore = self.getVectorStore()
self.client = self.vectorstore._client
self.retrievers: Dict[str, BaseRetriever] = {}
# default retriever for when no collection title is specified
self.retrievers[
str(self.vectorstore._LANGCHAIN_DEFAULT_COLLECTION_NAME)
] = self.vectorstore.as_retriever()
async def initRetrievers(self, directories: list[str] | None = None):
start_time = datetime.now()
print(f"Start vectorstore initialization time: {start_time}")
# for each subdirectory in the directory, create a new collection if it doesn't exist
dirs = directories or os.listdir(self.directory)
# make sure the subdir is not a file on MacOS (which has a hidden .DS_Store file)
dirs = [
subdir
for subdir in dirs
if not os.path.isfile(f"{self.directory}/{subdir}")
]
print(f"{len(dirs)} subdirectories to load: {dirs}")
for subdir in dirs:
self.retrievers[subdir] = await self.initRetriever(subdir)
end_time = datetime.now()
print("Vectorstore initialization complete.")
print(f"Vectorstore initialization end time: {end_time}")
print(f"Total time taken: {end_time - start_time}")
return self.retrievers
async def initRetriever(self, subdir: str) -> BaseRetriever:
# Ensure only one process/thread is executing this method at a time
lock = asyncio.Lock()
async with lock:
subdir_start_time = datetime.now()
print(f"Start {subdir} processing time: {subdir_start_time}")
# get all existing collections
collections = self.client.list_collections()
print(f"Existing collections: {collections}")
# load all .html documents in the subdirectory and ignore any .processed files
# Initialize an empty list to hold the documents
documents = []
# Define the maximum number of files to load at a time
max_files = 1000
# Get a list of all files in the directory
all_files = glob.glob(f"{self.directory}/{subdir}/*.html", recursive=False)
print(f"Loading {len(all_files)} documents for title version {subdir}.")
# Load files in chunks of max_files
for i in range(0, len(all_files), max_files):
chunksStartTime = datetime.now()
chunk_files = all_files[i : i + max_files]
for file in chunk_files:
loader = UnstructuredHTMLLoader(
file,
encoding="utf-8",
)
documents.extend(loader.load())
print(f"Loaded {len(documents)} documents for title version {subdir}.")
chunksEndTime = datetime.now()
print(
f"{max_files} html file chunks processing time: {chunksEndTime - chunksStartTime}"
)
print(f"Creating new collection for {subdir}...")
# create a new collection
# if metadata file named metadata.json exists, use that as metadata
# otherwise, default to using a metadata with just the date processed.
metadata = {"processDate": str(datetime.now())}
metadata_file = f"{self.directory}/{subdir}/metadata.json"
if os.path.isfile(metadata_file):
# load the metadata.json into a dict
with open(metadata_file, "r") as metadataFile:
metadata = dict[str, str](json.load(metadataFile))
collection = self.client.create_collection(
name=subdir,
get_or_create=True, # create if it doesn't exist, otherwise get it
metadata=metadata,
)
# reload vectorstore based on collection to pass to parent doc retriever
vectorstore = self.getVectorStore(collection_name=collection.name)
# create a new parent document retriever
retriever = AsyncParentDocumentRetriever(
docstore=self.store,
vectorstore=vectorstore,
child_splitter=self.child_splitter,
parent_splitter=self.parent_splitter,
)
# add documents to the collection and docstore
print(f"Adding {len(documents)} documents to collection...")
add_docs_start_time = datetime.now()
await retriever.aadd_documents(
documents=documents, add_to_docstore=True
)
add_docs_end_time = datetime.now()
print(
f"Adding {len(documents)} documents to collection took: {add_docs_end_time - add_docs_start_time}"
)
# rename all files to .processed so they don't get loaded again
# but allows us to do a manual reload if needed, or future
# processing of the files
for file in chunk_files:
os.rename(file, f"{file}.processed")
documents = [] # clear documents list for next chunk
subdir_end_time = datetime.now()
print(f"Subdir {subdir } processing end time: {subdir_end_time}")
print(f"Time taken: {subdir_end_time - subdir_start_time}")
# reload vectorstore based on collection to pass to parent doc retriever (it may have changed or be None)
collection = self.client.get_collection(name=subdir)
vectorstore = self.getVectorStore(collection_name=collection.name)
retriever = AsyncParentDocumentRetriever(
docstore=self.store,
vectorstore=vectorstore,
child_splitter=self.child_splitter,
parent_splitter=self.parent_splitter,
)
return retriever
def getVectorStore(self, collection_name: str | None = None) -> Chroma:
if collection_name is None or "" or "None" :
collection_name = "langchain"
print("collection_name: " + collection_name)
vectorstore = Chroma(
client_settings=self.settings,
embedding_function=self.embeddings,
collection_name=collection_name,
)
return vectorstore
def list_collections(self):
vectorstore = Chroma(
client_settings=self.settings, embedding_function=self.embeddings
)
return vectorstore._client.list_collections()
async def getRetriever(self, collection_name: str | None = None):
if self.retrievers is None:
self.retrievers = await self.initRetrievers()
if (
collection_name is None
or collection_name == ""
or collection_name == "None"
):
name = str(Chroma._LANGCHAIN_DEFAULT_COLLECTION_NAME)
else:
name = collection_name
try:
retriever = self.retrievers[name]
except KeyError:
print(f"Retriever for {name} not found, using default...")
retriever = self.retrievers[Chroma._LANGCHAIN_DEFAULT_COLLECTION_NAME]
return retriever
Loading…
Cancel
Save