mirror of
https://github.com/getzep/graphiti.git
synced 2025-06-27 02:00:02 +00:00
19fde653a6
* update driver * mypy updates * mypy updates * mypy updates * Update graphiti_core/graph_queries.py Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * mypy updates * mypy * mypy updates * mypy updates * mypy updates * mypy updates --------- Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
517 lines
16 KiB
Python
517 lines
16 KiB
Python
"""
|
|
Copyright 2024, Zep Software, Inc.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
"""
|
|
|
|
import logging
|
|
from abc import ABC, abstractmethod
|
|
from datetime import datetime
|
|
from time import time
|
|
from typing import Any
|
|
from uuid import uuid4
|
|
|
|
from pydantic import BaseModel, Field
|
|
from typing_extensions import LiteralString
|
|
|
|
from graphiti_core.driver.driver import GraphDriver
|
|
from graphiti_core.embedder import EmbedderClient
|
|
from graphiti_core.errors import EdgeNotFoundError, GroupsEdgesNotFoundError
|
|
from graphiti_core.helpers import DEFAULT_DATABASE, parse_db_date
|
|
from graphiti_core.models.edges.edge_db_queries import (
|
|
COMMUNITY_EDGE_SAVE,
|
|
ENTITY_EDGE_SAVE,
|
|
EPISODIC_EDGE_SAVE,
|
|
)
|
|
from graphiti_core.nodes import Node
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
ENTITY_EDGE_RETURN: LiteralString = """
|
|
RETURN
|
|
e.uuid AS uuid,
|
|
startNode(e).uuid AS source_node_uuid,
|
|
endNode(e).uuid AS target_node_uuid,
|
|
e.created_at AS created_at,
|
|
e.name AS name,
|
|
e.group_id AS group_id,
|
|
e.fact AS fact,
|
|
e.episodes AS episodes,
|
|
e.expired_at AS expired_at,
|
|
e.valid_at AS valid_at,
|
|
e.invalid_at AS invalid_at,
|
|
properties(e) AS attributes
|
|
"""
|
|
|
|
|
|
class Edge(BaseModel, ABC):
|
|
uuid: str = Field(default_factory=lambda: str(uuid4()))
|
|
group_id: str = Field(description='partition of the graph')
|
|
source_node_uuid: str
|
|
target_node_uuid: str
|
|
created_at: datetime
|
|
|
|
@abstractmethod
|
|
async def save(self, driver: GraphDriver): ...
|
|
|
|
async def delete(self, driver: GraphDriver):
|
|
result = await driver.execute_query(
|
|
"""
|
|
MATCH (n)-[e:MENTIONS|RELATES_TO|HAS_MEMBER {uuid: $uuid}]->(m)
|
|
DELETE e
|
|
""",
|
|
uuid=self.uuid,
|
|
database_=DEFAULT_DATABASE,
|
|
)
|
|
|
|
logger.debug(f'Deleted Edge: {self.uuid}')
|
|
|
|
return result
|
|
|
|
def __hash__(self):
|
|
return hash(self.uuid)
|
|
|
|
def __eq__(self, other):
|
|
if isinstance(other, Node):
|
|
return self.uuid == other.uuid
|
|
return False
|
|
|
|
@classmethod
|
|
async def get_by_uuid(cls, driver: GraphDriver, uuid: str): ...
|
|
|
|
|
|
class EpisodicEdge(Edge):
|
|
async def save(self, driver: GraphDriver):
|
|
result = await driver.execute_query(
|
|
EPISODIC_EDGE_SAVE,
|
|
episode_uuid=self.source_node_uuid,
|
|
entity_uuid=self.target_node_uuid,
|
|
uuid=self.uuid,
|
|
group_id=self.group_id,
|
|
created_at=self.created_at,
|
|
database_=DEFAULT_DATABASE,
|
|
)
|
|
|
|
logger.debug(f'Saved edge to Graph: {self.uuid}')
|
|
|
|
return result
|
|
|
|
@classmethod
|
|
async def get_by_uuid(cls, driver: GraphDriver, uuid: str):
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Episodic)-[e:MENTIONS {uuid: $uuid}]->(m:Entity)
|
|
RETURN
|
|
e.uuid As uuid,
|
|
e.group_id AS group_id,
|
|
n.uuid AS source_node_uuid,
|
|
m.uuid AS target_node_uuid,
|
|
e.created_at AS created_at
|
|
""",
|
|
uuid=uuid,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_episodic_edge_from_record(record) for record in records]
|
|
|
|
if len(edges) == 0:
|
|
raise EdgeNotFoundError(uuid)
|
|
return edges[0]
|
|
|
|
@classmethod
|
|
async def get_by_uuids(cls, driver: GraphDriver, uuids: list[str]):
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Episodic)-[e:MENTIONS]->(m:Entity)
|
|
WHERE e.uuid IN $uuids
|
|
RETURN
|
|
e.uuid As uuid,
|
|
e.group_id AS group_id,
|
|
n.uuid AS source_node_uuid,
|
|
m.uuid AS target_node_uuid,
|
|
e.created_at AS created_at
|
|
""",
|
|
uuids=uuids,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_episodic_edge_from_record(record) for record in records]
|
|
|
|
if len(edges) == 0:
|
|
raise EdgeNotFoundError(uuids[0])
|
|
return edges
|
|
|
|
@classmethod
|
|
async def get_by_group_ids(
|
|
cls,
|
|
driver: GraphDriver,
|
|
group_ids: list[str],
|
|
limit: int | None = None,
|
|
uuid_cursor: str | None = None,
|
|
):
|
|
cursor_query: LiteralString = 'AND e.uuid < $uuid' if uuid_cursor else ''
|
|
limit_query: LiteralString = 'LIMIT $limit' if limit is not None else ''
|
|
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Episodic)-[e:MENTIONS]->(m:Entity)
|
|
WHERE e.group_id IN $group_ids
|
|
"""
|
|
+ cursor_query
|
|
+ """
|
|
RETURN
|
|
e.uuid As uuid,
|
|
e.group_id AS group_id,
|
|
n.uuid AS source_node_uuid,
|
|
m.uuid AS target_node_uuid,
|
|
e.created_at AS created_at
|
|
ORDER BY e.uuid DESC
|
|
"""
|
|
+ limit_query,
|
|
group_ids=group_ids,
|
|
uuid=uuid_cursor,
|
|
limit=limit,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_episodic_edge_from_record(record) for record in records]
|
|
|
|
if len(edges) == 0:
|
|
raise GroupsEdgesNotFoundError(group_ids)
|
|
return edges
|
|
|
|
|
|
class EntityEdge(Edge):
|
|
name: str = Field(description='name of the edge, relation name')
|
|
fact: str = Field(description='fact representing the edge and nodes that it connects')
|
|
fact_embedding: list[float] | None = Field(default=None, description='embedding of the fact')
|
|
episodes: list[str] = Field(
|
|
default=[],
|
|
description='list of episode ids that reference these entity edges',
|
|
)
|
|
expired_at: datetime | None = Field(
|
|
default=None, description='datetime of when the node was invalidated'
|
|
)
|
|
valid_at: datetime | None = Field(
|
|
default=None, description='datetime of when the fact became true'
|
|
)
|
|
invalid_at: datetime | None = Field(
|
|
default=None, description='datetime of when the fact stopped being true'
|
|
)
|
|
attributes: dict[str, Any] = Field(
|
|
default={}, description='Additional attributes of the edge. Dependent on edge name'
|
|
)
|
|
|
|
async def generate_embedding(self, embedder: EmbedderClient):
|
|
start = time()
|
|
|
|
text = self.fact.replace('\n', ' ')
|
|
self.fact_embedding = await embedder.create(input_data=[text])
|
|
|
|
end = time()
|
|
logger.debug(f'embedded {text} in {end - start} ms')
|
|
|
|
return self.fact_embedding
|
|
|
|
async def load_fact_embedding(self, driver: GraphDriver):
|
|
query: LiteralString = """
|
|
MATCH (n:Entity)-[e:RELATES_TO {uuid: $uuid}]->(m:Entity)
|
|
RETURN e.fact_embedding AS fact_embedding
|
|
"""
|
|
records, _, _ = await driver.execute_query(
|
|
query, uuid=self.uuid, database_=DEFAULT_DATABASE, routing_='r'
|
|
)
|
|
|
|
if len(records) == 0:
|
|
raise EdgeNotFoundError(self.uuid)
|
|
|
|
self.fact_embedding = records[0]['fact_embedding']
|
|
|
|
async def save(self, driver: GraphDriver):
|
|
edge_data: dict[str, Any] = {
|
|
'source_uuid': self.source_node_uuid,
|
|
'target_uuid': self.target_node_uuid,
|
|
'uuid': self.uuid,
|
|
'name': self.name,
|
|
'group_id': self.group_id,
|
|
'fact': self.fact,
|
|
'fact_embedding': self.fact_embedding,
|
|
'episodes': self.episodes,
|
|
'created_at': self.created_at,
|
|
'expired_at': self.expired_at,
|
|
'valid_at': self.valid_at,
|
|
'invalid_at': self.invalid_at,
|
|
}
|
|
|
|
edge_data.update(self.attributes or {})
|
|
|
|
result = await driver.execute_query(
|
|
ENTITY_EDGE_SAVE,
|
|
edge_data=edge_data,
|
|
database_=DEFAULT_DATABASE,
|
|
)
|
|
|
|
logger.debug(f'Saved edge to Graph: {self.uuid}')
|
|
|
|
return result
|
|
|
|
@classmethod
|
|
async def get_by_uuid(cls, driver: GraphDriver, uuid: str):
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Entity)-[e:RELATES_TO {uuid: $uuid}]->(m:Entity)
|
|
"""
|
|
+ ENTITY_EDGE_RETURN,
|
|
uuid=uuid,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_entity_edge_from_record(record) for record in records]
|
|
|
|
if len(edges) == 0:
|
|
raise EdgeNotFoundError(uuid)
|
|
return edges[0]
|
|
|
|
@classmethod
|
|
async def get_by_uuids(cls, driver: GraphDriver, uuids: list[str]):
|
|
if len(uuids) == 0:
|
|
return []
|
|
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Entity)-[e:RELATES_TO]->(m:Entity)
|
|
WHERE e.uuid IN $uuids
|
|
"""
|
|
+ ENTITY_EDGE_RETURN,
|
|
uuids=uuids,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_entity_edge_from_record(record) for record in records]
|
|
|
|
return edges
|
|
|
|
@classmethod
|
|
async def get_by_group_ids(
|
|
cls,
|
|
driver: GraphDriver,
|
|
group_ids: list[str],
|
|
limit: int | None = None,
|
|
uuid_cursor: str | None = None,
|
|
):
|
|
cursor_query: LiteralString = 'AND e.uuid < $uuid' if uuid_cursor else ''
|
|
limit_query: LiteralString = 'LIMIT $limit' if limit is not None else ''
|
|
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Entity)-[e:RELATES_TO]->(m:Entity)
|
|
WHERE e.group_id IN $group_ids
|
|
"""
|
|
+ cursor_query
|
|
+ ENTITY_EDGE_RETURN
|
|
+ """
|
|
ORDER BY e.uuid DESC
|
|
"""
|
|
+ limit_query,
|
|
group_ids=group_ids,
|
|
uuid=uuid_cursor,
|
|
limit=limit,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_entity_edge_from_record(record) for record in records]
|
|
|
|
if len(edges) == 0:
|
|
raise GroupsEdgesNotFoundError(group_ids)
|
|
return edges
|
|
|
|
@classmethod
|
|
async def get_by_node_uuid(cls, driver: GraphDriver, node_uuid: str):
|
|
query: LiteralString = (
|
|
"""
|
|
MATCH (n:Entity {uuid: $node_uuid})-[e:RELATES_TO]-(m:Entity)
|
|
"""
|
|
+ ENTITY_EDGE_RETURN
|
|
)
|
|
records, _, _ = await driver.execute_query(
|
|
query, node_uuid=node_uuid, database_=DEFAULT_DATABASE, routing_='r'
|
|
)
|
|
|
|
edges = [get_entity_edge_from_record(record) for record in records]
|
|
|
|
return edges
|
|
|
|
|
|
class CommunityEdge(Edge):
|
|
async def save(self, driver: GraphDriver):
|
|
result = await driver.execute_query(
|
|
COMMUNITY_EDGE_SAVE,
|
|
community_uuid=self.source_node_uuid,
|
|
entity_uuid=self.target_node_uuid,
|
|
uuid=self.uuid,
|
|
group_id=self.group_id,
|
|
created_at=self.created_at,
|
|
database_=DEFAULT_DATABASE,
|
|
)
|
|
|
|
logger.debug(f'Saved edge to Graph: {self.uuid}')
|
|
|
|
return result
|
|
|
|
@classmethod
|
|
async def get_by_uuid(cls, driver: GraphDriver, uuid: str):
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Community)-[e:HAS_MEMBER {uuid: $uuid}]->(m:Entity | Community)
|
|
RETURN
|
|
e.uuid As uuid,
|
|
e.group_id AS group_id,
|
|
n.uuid AS source_node_uuid,
|
|
m.uuid AS target_node_uuid,
|
|
e.created_at AS created_at
|
|
""",
|
|
uuid=uuid,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_community_edge_from_record(record) for record in records]
|
|
|
|
return edges[0]
|
|
|
|
@classmethod
|
|
async def get_by_uuids(cls, driver: GraphDriver, uuids: list[str]):
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Community)-[e:HAS_MEMBER]->(m:Entity | Community)
|
|
WHERE e.uuid IN $uuids
|
|
RETURN
|
|
e.uuid As uuid,
|
|
e.group_id AS group_id,
|
|
n.uuid AS source_node_uuid,
|
|
m.uuid AS target_node_uuid,
|
|
e.created_at AS created_at
|
|
""",
|
|
uuids=uuids,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_community_edge_from_record(record) for record in records]
|
|
|
|
return edges
|
|
|
|
@classmethod
|
|
async def get_by_group_ids(
|
|
cls,
|
|
driver: GraphDriver,
|
|
group_ids: list[str],
|
|
limit: int | None = None,
|
|
uuid_cursor: str | None = None,
|
|
):
|
|
cursor_query: LiteralString = 'AND e.uuid < $uuid' if uuid_cursor else ''
|
|
limit_query: LiteralString = 'LIMIT $limit' if limit is not None else ''
|
|
|
|
records, _, _ = await driver.execute_query(
|
|
"""
|
|
MATCH (n:Community)-[e:HAS_MEMBER]->(m:Entity | Community)
|
|
WHERE e.group_id IN $group_ids
|
|
"""
|
|
+ cursor_query
|
|
+ """
|
|
RETURN
|
|
e.uuid As uuid,
|
|
e.group_id AS group_id,
|
|
n.uuid AS source_node_uuid,
|
|
m.uuid AS target_node_uuid,
|
|
e.created_at AS created_at
|
|
ORDER BY e.uuid DESC
|
|
"""
|
|
+ limit_query,
|
|
group_ids=group_ids,
|
|
uuid=uuid_cursor,
|
|
limit=limit,
|
|
database_=DEFAULT_DATABASE,
|
|
routing_='r',
|
|
)
|
|
|
|
edges = [get_community_edge_from_record(record) for record in records]
|
|
|
|
return edges
|
|
|
|
|
|
# Edge helpers
|
|
def get_episodic_edge_from_record(record: Any) -> EpisodicEdge:
|
|
return EpisodicEdge(
|
|
uuid=record['uuid'],
|
|
group_id=record['group_id'],
|
|
source_node_uuid=record['source_node_uuid'],
|
|
target_node_uuid=record['target_node_uuid'],
|
|
created_at=parse_db_date(record['created_at']), # type: ignore
|
|
)
|
|
|
|
|
|
def get_entity_edge_from_record(record: Any) -> EntityEdge:
|
|
edge = EntityEdge(
|
|
uuid=record['uuid'],
|
|
source_node_uuid=record['source_node_uuid'],
|
|
target_node_uuid=record['target_node_uuid'],
|
|
fact=record['fact'],
|
|
name=record['name'],
|
|
group_id=record['group_id'],
|
|
episodes=record['episodes'],
|
|
created_at=parse_db_date(record['created_at']), # type: ignore
|
|
expired_at=parse_db_date(record['expired_at']),
|
|
valid_at=parse_db_date(record['valid_at']),
|
|
invalid_at=parse_db_date(record['invalid_at']),
|
|
attributes=record['attributes'],
|
|
)
|
|
|
|
edge.attributes.pop('uuid', None)
|
|
edge.attributes.pop('source_node_uuid', None)
|
|
edge.attributes.pop('target_node_uuid', None)
|
|
edge.attributes.pop('fact', None)
|
|
edge.attributes.pop('name', None)
|
|
edge.attributes.pop('group_id', None)
|
|
edge.attributes.pop('episodes', None)
|
|
edge.attributes.pop('created_at', None)
|
|
edge.attributes.pop('expired_at', None)
|
|
edge.attributes.pop('valid_at', None)
|
|
edge.attributes.pop('invalid_at', None)
|
|
|
|
return edge
|
|
|
|
|
|
def get_community_edge_from_record(record: Any):
|
|
return CommunityEdge(
|
|
uuid=record['uuid'],
|
|
group_id=record['group_id'],
|
|
source_node_uuid=record['source_node_uuid'],
|
|
target_node_uuid=record['target_node_uuid'],
|
|
created_at=parse_db_date(record['created_at']), # type: ignore
|
|
)
|
|
|
|
|
|
async def create_entity_edge_embeddings(embedder: EmbedderClient, edges: list[EntityEdge]):
|
|
if len(edges) == 0:
|
|
return
|
|
fact_embeddings = await embedder.create_batch([edge.fact for edge in edges])
|
|
for edge, fact_embedding in zip(edges, fact_embeddings, strict=True):
|
|
edge.fact_embedding = fact_embedding
|