DSPy: The framework for programming—not prompting—language models
Python
Add support for neo4j vector index
Tomaz Bratanicc81e973f6dec
diff --git a/dspy/retrieve/neo4j_rm.py b/dspy/retrieve/neo4j_rm.pynew file mode 100644index 000000000..20a5b7b33--- /dev/null+++ b/dspy/retrieve/neo4j_rm.py@@ -0,0 +1,104 @@+import os+from typing import Any, List, Optional, Union++import backoff+from openai import (+ APITimeoutError,+ InternalServerError,+ OpenAI,+ RateLimitError,+ UnprocessableEntityError,+)++import dspy+from dsp.utils import dotdict++try:+ from neo4j import GraphDatabase+ from neo4j.exceptions import (+ AuthError,+ ServiceUnavailable,+ )+except ImportError:+ raise ImportError(+ "Please install the neo4j package by running `pip install dspy-ai[neo4j]`",+ )+++class Embedder:+ def __init__(self, provider: str, model: str):+ if provider == "openai":+ api_key = os.getenv("OPENAI_API_KEY")+ if not api_key:+ raise ValueError("Environment variable OPENAI_API_KEY must be set")+ self.client = OpenAI()+ self.model = model++ @backoff.on_exception(+ backoff.expo,+ (+ APITimeoutError,+ InternalServerError,+ RateLimitError,+ UnprocessableEntityError,+ ),+ max_time=15,+ )+ def __call__(self, queries) -> Any:+ embedding = self.client.embeddings.create(input=queries, model=self.model)+ return [result.embedding for result in embedding.data]+++DEFAULT_INDEX_QUERY = "CALL db.index.vector.queryNodes($index, $k, $embedding) YIELD node, score "+++class Neo4jRM(dspy.Retrieve):+ def __init__(+ self,+ index_name: str,+ text_node_property: str,+ k: int = 5,+ retrieval_query: str = None,+ embedding_provider: str = "openai",+ embedding_model: str = "text-embedding-ada-002",+ ):+ super().__init__(k=k)+ self.index_name = index_name+ self.username = os.getenv("NEO4J_USERNAME")+ self.password = os.getenv("NEO4J_PASSWORD")+ self.uri = os.getenv("NEO4J_URI")+ self.database = os.getenv("NEO4J_DATABASE")+ self.k = k+ self.retrieval_query = retrieval_query+ self.text_node_property = text_node_property+ if not self.username:+ raise ValueError("Environment variable NEO4J_USERNAME must be set")+ if not self.password:+ raise ValueError("Environment variable NEO4J_PASSWORD must be set")+ if not self.uri:+ raise ValueError("Environment variable NEO4J_URI must be set")+ try:+ self.driver = GraphDatabase.driver(self.uri, auth=(self.username, self.password))+ self.driver.verify_connectivity()++ except (+ ServiceUnavailable,+ AuthError,+ ) as e:+ raise ConnectionError("Failed to connect to Neo4j database") from e++ self.embedder = Embedder(provider=embedding_provider, model=embedding_model)++ def forward(self, query_or_queries: Union[str, List[str]], k: Optional[int]) -> dspy.Prediction:+ if not isinstance(query_or_queries, list):+ query_or_queries = [query_or_queries]+ query_vectors = self.embedder(query_or_queries)+ contents = []+ retrieval_query = self.retrieval_query or f"RETURN node.{self.text_node_property} AS output"+ for vector in query_vectors:+ records, _, _ = self.driver.execute_query(+ DEFAULT_INDEX_QUERY + retrieval_query,+ {"embedding": vector, "index": self.index_name, "k": k or self.k},+ )+ contents.extend([dotdict({"long_text": r["output"]}) for r in records])+ return contents