feat+fix(changelogs+relationships&retrieve): added changelogs and fixed duplicated relationships creation with change to lowercase node properties instead of capitalized

Author: ChrisCoder9000

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "brainapi2"
-version = "1.6.16-dev"
+version = "1.7.0-dev"
 description = "Version 1.x.x of the BrainAPI memory layer."
 authors = [
     {name = "Christian",email = "[email protected]"}

src/adapters/data.py

@@ -10,7 +10,7 @@
 
 from typing import List, Tuple
 from src.adapters.interfaces.data import DataClient, SearchResult
-from src.constants.data import Brain, Observation, StructuredData, TextChunk
+from src.constants.data import Brain, KGChanges, Observation, StructuredData, TextChunk
 
 
 class DataAdapter:
@@ -82,3 +82,11 @@ def get_brains_list(self) -> List[Brain]:
         Get the list of brains from the data client.
         """
         return self.data.get_brains_list()
+
+    def save_kg_changes(
+        self, kg_changes: KGChanges, brain_id: str = "default"
+    ) -> KGChanges:
+        """
+        Save a KG changes to the data client.
+        """
+        return self.data.save_kg_changes(kg_changes, brain_id)

src/adapters/embeddings.py

@@ -68,16 +68,16 @@ def get_by_ids(
     def search_similar_by_ids(
         self,
         vector_ids: list[str],
+        brain_id: str,
         store: str,
         min_similarity: float,
         limit: int = 10,
-        brain_id: str = "default",
     ) -> list[Vector]:
         """
         Search similar vectors by their IDs.
         """
         return self.vector_store.search_similar_by_ids(
-            vector_ids, store, min_similarity, limit, brain_id
+            vector_ids, brain_id, store, min_similarity, limit
         )
 
 

src/adapters/graph.py

@@ -8,7 +8,7 @@
 -----
 """
 
-from typing import Optional, Tuple
+from typing import Literal, Optional, Tuple
 from src.adapters.interfaces.graph import GraphClient
 from src.constants.kg import (
     IdentificationParams,
@@ -247,5 +247,32 @@ def search_entities(
             brain_id, limit, skip, node_labels, node_uuids, query_text
         )
 
+    def deprecate_relationship(
+        self,
+        subject: Node,
+        predicate: Predicate,
+        object: Node,
+        brain_id: str = "default",
+    ) -> Tuple[Node, Predicate, Node] | None:
+        """
+        Deprecate a relationship from the graph.
+        """
+        return self.graph.deprecate_relationship(subject, predicate, object, brain_id)
+
+    def update_properties(
+        self,
+        uuid: str,
+        updating: Literal["node", "relationship"],
+        brain_id: str = "default",
+        new_properties: dict = {},
+        properties_to_remove: list[str] = [],
+    ) -> Node | Predicate | None:
+        """
+        Update the properties of a node or relationship in the graph.
+        """
+        return self.graph.update_properties(
+            uuid, updating, brain_id, new_properties, properties_to_remove
+        )
+
 
 _graph_adapter = GraphAdapter()

src/adapters/interfaces/data.py

@@ -13,7 +13,7 @@
 
 from pydantic import BaseModel
 
-from src.constants.data import Brain, Observation, StructuredData, TextChunk
+from src.constants.data import Brain, KGChanges, Observation, StructuredData, TextChunk
 
 
 class SearchResult(BaseModel):
@@ -91,3 +91,10 @@ def get_brains_list(self) -> List[Brain]:
         Get the list of brains from the data client.
         """
         raise NotImplementedError("get_brains_list method not implemented")
+
+    @abstractmethod
+    def save_kg_changes(self, kg_changes: KGChanges, brain_id: str) -> KGChanges:
+        """
+        Save a KG changes to the data client.
+        """
+        raise NotImplementedError("save_kg_changes method not implemented")

src/adapters/interfaces/graph.py

@@ -9,7 +9,7 @@
 """
 
 from abc import ABC, abstractmethod
-from typing import Optional, Tuple
+from typing import Literal, Optional, Tuple
 
 from src.constants.kg import (
     IdentificationParams,
@@ -245,3 +245,30 @@ def search_entities(
         Search the entities of the graph.
         """
         raise NotImplementedError("search_entities method not implemented")
+
+    @abstractmethod
+    def deprecate_relationship(
+        self,
+        subject: Node,
+        predicate: Predicate,
+        object: Node,
+        brain_id: str,
+    ) -> Tuple[Node, Predicate, Node] | None:
+        """
+        Deprecate a relationship from the graph.
+        """
+        raise NotImplementedError("deprecate_relationship method not implemented")
+
+    @abstractmethod
+    def update_properties(
+        self,
+        uuid: str,
+        updating: Literal["node", "relationship"],
+        brain_id: str,
+        new_properties: dict,
+        properties_to_remove: list[str],
+    ) -> Node | Predicate | None:
+        """
+        Update the properties of a node or relationship in the graph.
+        """
+        raise NotImplementedError("update_properties method not implemented")

src/constants/data.py

@@ -9,7 +9,8 @@
 """
 
 from datetime import datetime
-from typing import List, Optional
+from enum import Enum
+from typing import Annotated, Any, List, Literal, Optional, Union
 import uuid
 from pydantic import BaseModel, Field
 
@@ -62,24 +63,138 @@ class Observation(BaseModel):
     )
 
 
-class KGChanges(BaseModel):
+class KGChangesType(Enum):
     """
-    KG changes model.
+    KG changes type.
     """
 
-    id: str = Field(default_factory=lambda: str(uuid.uuid4()))
+    RELATIONSHIP_CREATED = "relationship_created"
+    RELATIONSHIP_DEPRECATED = "relationship_deprecated"
+    NODE_PROPERTIES_UPDATED = "node_properties_updated"
+    RELATIONSHIP_PROPERTIES_UPDATED = "relationship_properties_updated"
+
+
+class PartialNode(BaseModel):
+    """
+    Partial node model.
+    """
 
-    node_ids: Optional[List[str]] = Field(
-        default=None, description="The id of the node that was changed."
+    uuid: str = Field(description="The id of the node.")
+    name: str = Field(description="The name of the node.")
+    labels: List[str] = Field(description="The labels of the node.")
+    description: Optional[str] = Field(description="The description of the node.")
+    properties: dict = Field(description="The properties of the node.")
+
+
+class PartialPredicate(BaseModel):
+    """
+    Partial relationship model.
+    """
+
+    uuid: str = Field(description="The id of the relationship.")
+    name: str = Field(description="The name of the relationship.")
+    description: Optional[str] = Field(
+        description="The description of the relationship."
+    )
+    properties: Optional[dict] = Field(
+        default=None, description="The properties of the relationship."
+    )
+
+
+class KGChangeLogRelationshipCreated(BaseModel):
+    """
+    KG change log relationship created model.
+    """
+
+    type: Literal[KGChangesType.RELATIONSHIP_CREATED] = Field(
+        default=KGChangesType.RELATIONSHIP_CREATED,
+        description="The type of the change.",
+    )
+    subject: PartialNode = Field(description="The subject of the relationship.")
+    predicate: PartialPredicate = Field(
+        description="The predicate of the relationship."
+    )
+    object: PartialNode = Field(description="The object of the relationship.")
+
+
+class KGChangeLogRelationshipDeprecated(BaseModel):
+    """
+    KG change log relationship deprecated model.
+    """
+
+    type: Literal[KGChangesType.RELATIONSHIP_DEPRECATED] = Field(
+        default=KGChangesType.RELATIONSHIP_DEPRECATED,
+        description="The type of the change.",
+    )
+    subject: PartialNode = Field(description="The subject of the relationship.")
+    predicate: PartialPredicate = Field(
+        description="The predicate of the relationship."
     )
-    predicate_id: Optional[str] = Field(
-        default=None, description="The id of the predicate that was changed."
+    object: PartialNode = Field(description="The object of the relationship.")
+    new_predicate: Optional[PartialPredicate] = Field(
+        description="The new predicate of the relationship."
     )
 
-    changelog: List[dict] = Field(description="The changelog of the changes.")
-    date: datetime = Field(
+
+class KGChangeLogPredicateUpdatedProperty(BaseModel):
+    """
+    KG change log relationship updated property model.
+    """
+
+    property: str = Field(description="The property that was updated.")
+    previous_value: Any = Field(description="The previous value of the property.")
+    new_value: Any = Field(description="The new value of the property.")
+
+
+class KGChangeLogNodePropertiesUpdated(BaseModel):
+    """
+    KG change log node properties updated model.
+    """
+
+    type: Literal[KGChangesType.NODE_PROPERTIES_UPDATED] = Field(
+        default=KGChangesType.NODE_PROPERTIES_UPDATED,
+        description="The type of the change.",
+    )
+    node: PartialNode = Field(description="The node that was updated.")
+    properties: List[KGChangeLogPredicateUpdatedProperty] = Field(
+        description="The properties that were updated."
+    )
+
+
+class KGChangeLogPredicatePropertiesUpdated(BaseModel):
+    """
+    KG change log relationship properties updated model.
+    """
+
+    type: Literal[KGChangesType.RELATIONSHIP_PROPERTIES_UPDATED] = Field(
+        default=KGChangesType.RELATIONSHIP_PROPERTIES_UPDATED,
+        description="The type of the change.",
+    )
+    predicate: PartialPredicate = Field(description="The predicate that was updated.")
+    properties: List[KGChangeLogPredicateUpdatedProperty] = Field(
+        description="The properties that were updated."
+    )
+
+
+class KGChanges(BaseModel):
+    """
+    KG changes model.
+    """
+
+    id: str = Field(default_factory=lambda: str(uuid.uuid4()))
+    type: KGChangesType = Field(description="The type of the changes.")
+    change: Annotated[
+        Union[
+            KGChangeLogRelationshipCreated,
+            KGChangeLogRelationshipDeprecated,
+            KGChangeLogNodePropertiesUpdated,
+            KGChangeLogPredicatePropertiesUpdated,
+        ],
+        Field(discriminator="type"),
+    ] = Field(description="The change data, discriminated by type.")
+    timestamp: datetime = Field(
         default_factory=datetime.now,
-        description="The date and time the changes were made.",
+        description="The timestamp of the changes.",
     )
 
 

src/constants/kg.py

@@ -48,6 +48,7 @@ class Predicate(BaseModel):
     Predicate model.
     """
 
+    uuid: str = Field(default_factory=lambda: str(uuid.uuid4()))
     name: str
     description: str
     last_updated: datetime = Field(