migrate Neo4j (#1)

* migrate Neo4j

* x

.github/scripts/check_diff.py

@@ -2,7 +2,7 @@
 import sys
 from typing import Dict
 
-LIB_DIRS = ["libs/{lib}"]
+LIB_DIRS = ["libs/neo4j"]
 
 if __name__ == "__main__":
     files = sys.argv[1:]

.github/workflows/_release.yml

@@ -12,7 +12,7 @@ on:
       working-directory:
         required: true
         type: string
-        default: 'libs/{lib}'
+        default: 'libs/neo4j'
 
 env:
   PYTHON_VERSION: "3.11"
@@ -159,7 +159,9 @@ jobs:
 
       - name: Run integration tests
         env:
-          PARTNER_API_KEY: ${{ secrets.PARTNER_API_KEY }}
+          NEO4J_URI: ${{ secrets.NEO4J_URI }}
+          NEO4J_USERNAME: ${{ secrets.NEO4J_USERNAME }}
+          NEO4J_PASSWORD: ${{ secrets.NEO4J_PASSWORD }}
         run: make integration_tests
         working-directory: ${{ inputs.working-directory }}
 

README.md

@@ -1,63 +1,5 @@
-# 🦜️🔗 LangChain {partner}
+# 🦜️🔗 LangChain Neo4j
 
-This repository contains 1 package with {partner} integrations with LangChain:
+This repository contains 1 package with Neo4j integrations with LangChain:
 
-- [langchain-{package_lower}](https://pypi.org/project/langchain-{package_lower}/)
-
-## Initial Repo Checklist (Remove this section after completing)
-
-This setup assumes that the partner package is already split. For those instructions,
-see [these docs](https://python.langchain.com/docs/contributing/integrations#partner-packages).
-
-Code (auto ecli)
-
-- [ ] Fill out the readme above (for folks that follow pypi link)
-- [ ] Copy package into /libs folder
-- [ ] Update these fields in /libs/*/pyproject.toml
-
-    - `tool.poetry.repository`
-    - `tool.poetry.urls["Source Code"]`
-
-Workflow code (auto ecli)
-
-- [ ] Populate .github/workflows/_release.yml with `on.workflow_dispatch.inputs.working-directory.default`
-- [ ] Configure `LIB_DIRS` in .github/scripts/check_diff.py
-
-Workflow code (manual)
-
-- [ ] Add secrets as env vars in .github/workflows/_release.yml
-
-Monorepo workflow code (manual)
-
-- [ ] Pull in new code location, remove old in .github/workflows/api_doc_build.yml
-
-In github (manual)
-
-- [ ] Add integration testing secrets in Github (ask Erick for help)
-- [ ] Add partner collaborators in Github (ask Erick for help)
-- [ ] "Allow auto-merge" in General Settings 
-- [ ] Only "Allow squash merging" in General Settings
-- [ ] Set up ruleset matching CI build (ask Erick for help)
-    - name: ci build
-    - enforcement: active
-    - bypass: write
-    - target: default branch
-    - rules: restrict deletions, require status checks ("CI Success"), block force pushes
-- [ ] Set up ruleset
-    - name: require prs
-    - enforcement: active
-    - bypass: none
-    - target: default branch
-    - rules: restrict deletions, require a pull request before merging (0 approvals, no boxes), block force pushes
-
-Pypi (manual)
-
-- [ ] Add new repo to test-pypi and pypi trusted publishing (ask Erick for help)
-
-Slack
-
-- [ ] Set up release alerting in Slack (ask Erick for help)
-
-release:
-/github subscribe langchain-ai/langchain-{partner_lower} releases workflows:{name:"release"}
-/github unsubscribe langchain-ai/langchain-{partner_lower} issues pulls commits deployments
+- [langchain-neo4j](https://pypi.org/project/langchain-neo4j/)

libs/neo4j/.gitignore

@@ -0,0 +1 @@
+__pycache__

libs/neo4j/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LangChain, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

libs/neo4j/Makefile

@@ -0,0 +1,64 @@
+.PHONY: all format lint test tests integration_tests docker_tests help extended_tests
+
+# Default target executed when no arguments are given to make.
+all: help
+
+# Define a variable for the test file path.
+TEST_FILE ?= tests/unit_tests/
+integration_test integration_tests: TEST_FILE = tests/integration_tests/
+
+
+# unit tests are run with the --disable-socket flag to prevent network calls
+test tests:
+	poetry run pytest --disable-socket --allow-unix-socket $(TEST_FILE)
+
+test_watch:
+	poetry run ptw --snapshot-update --now . -- -vv $(TEST_FILE)
+
+# integration tests are run without the --disable-socket flag to allow network calls
+integration_test integration_tests:
+	poetry run pytest $(TEST_FILE)
+
+######################
+# LINTING AND FORMATTING
+######################
+
+# Define a variable for Python and notebook files.
+PYTHON_FILES=.
+MYPY_CACHE=.mypy_cache
+lint format: PYTHON_FILES=.
+lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/neo4j --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$')
+lint_package: PYTHON_FILES=langchain_neo4j
+lint_tests: PYTHON_FILES=tests
+lint_tests: MYPY_CACHE=.mypy_cache_test
+
+lint lint_diff lint_package lint_tests:
+	[ "$(PYTHON_FILES)" = "" ] || poetry run ruff check $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || poetry run ruff format $(PYTHON_FILES) --diff
+	[ "$(PYTHON_FILES)" = "" ] || mkdir -p $(MYPY_CACHE) && poetry run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
+
+format format_diff:
+	[ "$(PYTHON_FILES)" = "" ] || poetry run ruff format $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || poetry run ruff check --select I --fix $(PYTHON_FILES)
+
+spell_check:
+	poetry run codespell --toml pyproject.toml
+
+spell_fix:
+	poetry run codespell --toml pyproject.toml -w
+
+check_imports: $(shell find langchain_neo4j -name '*.py')
+	poetry run python ./scripts/check_imports.py $^
+
+######################
+# HELP
+######################
+
+help:
+	@echo '----'
+	@echo 'check_imports                - check imports'
+	@echo 'format                       - run code formatters'
+	@echo 'lint                         - run linters'
+	@echo 'test                         - run unit tests'
+	@echo 'tests                        - run unit tests'
+	@echo 'test TEST_FILE=<test_file>   - run all tests in file'

libs/neo4j/README.md

@@ -0,0 +1,148 @@
+# 🦜️🔗 LangChain Neo4j
+
+This package contains the LangChain integration with Neo4j.
+
+## 📦 Installation
+
+```bash
+pip install -U langchain-neo4j
+```
+
+## 💻 Examples
+
+### Neo4jGraph
+
+The `Neo4jGraph` class is a wrapper around Neo4j's Python driver.
+It provides a simple interface for interacting with a Neo4j database.
+
+```python
+from langchain_neo4j import Neo4jGraph
+
+graph = Neo4jGraph(url="bolt://localhost:7687", username="neo4j", password="password")
+graph.query("MATCH (n) RETURN n LIMIT 1;")
+```
+
+### Neo4jChatMessageHistory
+
+The `Neo4jChatMessageHistory` class is used to store chat message history in a Neo4j database.
+It stores messages as nodes and creates relationships between them, allowing for easy querying of the conversation history.
+
+```python
+from langchain_neo4j import Neo4jChatMessageHistory
+
+history = Neo4jChatMessageHistory(
+    url="bolt://localhost:7687",
+    username="neo4j",
+    password="password",
+    session_id="session_id_1",
+)
+history.add_user_message("hi!")
+history.add_ai_message("whats up?")
+history.messages
+```
+
+### Neo4jVector
+
+The `Neo4jVector` class provides functionality for managing a Neo4j vector store.
+It enables you to create new vector indexes, add vectors to existing indexes, and perform queries on indexes.
+
+```python
+from langchain.docstore.document import Document
+from langchain_openai import OpenAIEmbeddings
+
+from langchain_neo4j import Neo4jVector
+
+# Create a vector store from some documents and embeddings
+docs = [
+    Document(
+        page_content=(
+            "LangChain is a framework to build "
+            "with LLMs by chaining interoperable components."
+        ),
+    )
+]
+embeddings = OpenAIEmbeddings(
+    model="text-embedding-3-large",
+    api_key="sk-...",  # Replace with your OpenAI API key
+)
+db = Neo4jVector.from_documents(
+    docs,
+    embeddings,
+    url="bolt://localhost:7687",
+    username="neo4j",
+    password="password",
+)
+# Query the vector store for similar documents
+docs_with_score = db.similarity_search_with_score("What is LangChain?", k=1)
+```
+
+### GraphCypherQAChain
+
+The `CypherQAChain` class enables natural language interactions with a Neo4j database.
+It uses an LLM and the database's schema to translate a user's question into a Cypher query, which is executed against the database.
+The resulting data is then sent along with the user's question to the LLM to generate a natural language response.
+
+```python
+from langchain_openai import ChatOpenAI
+
+from langchain_neo4j import GraphCypherQAChain, Neo4jGraph
+
+llm = ChatOpenAI(
+    temperature=0,
+    api_key="sk-...",  # Replace with your OpenAI API key
+)
+graph = Neo4jGraph(url="bolt://localhost:7687", username="neo4j", password="password")
+chain = GraphCypherQAChain.from_llm(llm=llm, graph=graph, allow_dangerous_requests=True)
+chain.run("Who starred in Top Gun?")
+```
+
+## 🧪 Tests
+
+Install the test dependencies to run the tests:
+
+```bash
+poetry install --with test,test_integration
+```
+
+### Unit Tests
+
+Run the unit tests using:
+
+```bash
+make tests
+```
+
+### Integration Tests
+
+1. Start the Neo4j instance using Docker:
+
+    ```bash
+    cd tests/integration_tests/docker-compose
+    docker-compose -f neo4j.yml up
+    ```
+
+2. Run the tests:
+
+    ```bash
+    make integration_tests
+    ```
+
+## 🧹 Code Formatting and Linting
+
+Install the codespell, lint, and typing dependencies to lint and format your code:
+
+```bash
+poetry install --with codespell,lint,typing
+```
+
+To format your code, run:
+
+```bash
+make format
+```
+
+To lint it, run:
+
+```bash
+make lint
+```

libs/neo4j/langchain_neo4j/__init__.py

@@ -0,0 +1,21 @@
+from importlib import metadata
+
+from langchain_neo4j.chains.graph_qa.cypher import GraphCypherQAChain
+from langchain_neo4j.chat_message_histories.neo4j import Neo4jChatMessageHistory
+from langchain_neo4j.graphs.neo4j_graph import Neo4jGraph
+from langchain_neo4j.vectorstores.neo4j_vector import Neo4jVector
+
+try:
+    __version__ = metadata.version(__package__)
+except metadata.PackageNotFoundError:
+    # Case where package metadata is not available.
+    __version__ = ""
+del metadata  # optional, avoids polluting the results of dir(__package__)
+
+__all__ = [
+    "GraphCypherQAChain",
+    "Neo4jChatMessageHistory",
+    "Neo4jGraph",
+    "Neo4jVector",
+    "__version__",
+]