wehub-resource-sync
114 lines
4.5 KiB
Python
114 lines
4.5 KiB
Python
|
|
"""This example shows how to use Neo4j as a vector embedding database with llmware
|
|
|
|
(A) Python Dependencies -
|
|
|
|
As a first step, you should pip install theh Neo4j driver, which is not included in the llmware package:
|
|
1. pip3 install neo4j
|
|
|
|
(B) Installing Neo4j -
|
|
|
|
If you need help installing Neo4j, there are many great online sources and communities, e.g.,:
|
|
-- Neo4j Installation - https://neo4j.com/docs/operations-manual/current/installation/ (All OS)
|
|
-- Mac OS - https://neo4j.com/docs/operations-manual/current/installation/osx/
|
|
-- Linux - https://neo4j.com/docs/operations-manual/current/installation/linux/
|
|
-- Debian repository - https://debian.neo4j.com/
|
|
-- Windows - https://neo4j.com/docs/operations-manual/current/installation/windows/
|
|
-- Docker - https://hub.docker.com/_/neo4j
|
|
-- please also see the docker-compose-neo4j.yaml script provided in the llmware script repository
|
|
|
|
(C) Configurations -
|
|
|
|
-- set os.environ variables to 'automatically' pass in installing embedding
|
|
-- os.environ["NEO4J_URI"] = "neo4j://localhost:7687"
|
|
-- os.environ["NEO4J_USERNAME"] = "neo4j" # by default
|
|
-- os.environ["NEO4J_PASSWORD"] = "neo4j" # by default
|
|
-- os.environ["NEO4J_DATABASE"] = "llmware"
|
|
|
|
"""
|
|
|
|
|
|
import os
|
|
|
|
from llmware.setup import Setup
|
|
from llmware.library import Library
|
|
from llmware.retrieval import Query
|
|
from llmware.configs import LLMWareConfig
|
|
|
|
# example default Neo4j install with database = llmware & user = neo4j
|
|
os.environ["NEO4J_URI"] = "neo4j://localhost:7687"
|
|
os.environ["NEO4J_USERNAME"] = "neo4j"
|
|
os.environ["NEO4J_PASSWORD"] = "neo4j"
|
|
os.environ["NEO4J_DATABASE"] = "llmware"
|
|
|
|
|
|
def build_lib (library_name, folder="Agreements"):
|
|
|
|
# Step 1 - Create library which is the main 'organizing construct' in llmware
|
|
print ("\nupdate: Step 1 - Creating library: {}".format(library_name))
|
|
|
|
library = Library().create_new_library(library_name)
|
|
|
|
# Step 2 - Pull down the sample files from S3 through the .load_sample_files() command
|
|
# --note: if you need to refresh the sample files, set 'over_write=True'
|
|
print ("update: Step 2 - Downloading Sample Files")
|
|
|
|
sample_files_path = Setup().load_sample_files(over_write=False)
|
|
|
|
# Step 3 - point ".add_files" method to the folder of documents that was just created
|
|
# this method parses the documents, text chunks, and captures in MongoDB
|
|
print("update: Step 3 - Parsing and Text Indexing Files")
|
|
|
|
# options: Agreements | UN-Resolutions-500
|
|
library.add_files(input_folder_path=os.path.join(sample_files_path, folder))
|
|
|
|
return library
|
|
|
|
|
|
# start script
|
|
|
|
print("update: Step 1- starting here- building library- parsing PDFs into text chunks")
|
|
|
|
LLMWareConfig().set_active_db("sqlite")
|
|
|
|
lib = build_lib("neo4j_lib_0")
|
|
|
|
# optional - check the status of the library card and embedding
|
|
lib_card = lib.get_library_card()
|
|
print("update: -- before embedding process - check library card - ", lib_card)
|
|
|
|
print("update: Step 2 - starting to install embeddings")
|
|
|
|
# alt embedding models - "mini-lm-sbert" | industry-bert-contracts | text-embedding-ada-002
|
|
# note: if you want to use text-embedding-ada-002, you will need an OpenAI key and enter into os.environ variable
|
|
# e.g., os.environ["USER_MANAGED_OPENAI_API_KEY"] = "<insert your key>"
|
|
|
|
# batch sizes from 100-500 usually give good performance and work on most environments
|
|
lib.install_new_embedding(embedding_model_name="industry-bert-contracts",vector_db="neo4j",batch_size=300)
|
|
|
|
# optional - check the status of the library card and embedding
|
|
lib_card = lib.get_library_card()
|
|
print("update: -- after embedding process - check updated library card - ", lib_card)
|
|
|
|
# run a query
|
|
# note: embedding_model_name is optional, but useful if you create multiple embeddings on the same library
|
|
# --see other example scripts for multiple embeddings
|
|
|
|
# create query object
|
|
query_neo4j = Query(lib, embedding_model_name="industry-bert-contracts")
|
|
|
|
# run multiple queries using query_neo4j
|
|
my_search_results = query_neo4j.semantic_query("What is the sale bonus?", result_count = 24)
|
|
|
|
for i, qr in enumerate(my_search_results):
|
|
print("update: semantic query results: ", i, qr)
|
|
|
|
# if you want to delete the embedding - uncomment the line below
|
|
# lib.delete_installed_embedding("industry-bert-contracts", "neo4j")
|
|
|
|
# optional - check the embeddings on the library
|
|
emb_record = lib.get_embedding_status()
|
|
for j, entries in enumerate(emb_record):
|
|
print("update: embeddings on library: ", j, entries)
|
|
|