File size: 2,852 Bytes
fcaa164 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# 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.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
from abc import ABC, abstractmethod
from typing import Any, Dict, List, Optional
class BaseGraphStorage(ABC):
r"""An abstract base class for graph storage systems."""
@property
@abstractmethod
def get_client(self) -> Any:
r"""Get the underlying graph storage client."""
pass
@property
@abstractmethod
def get_schema(self) -> str:
r"""Get the schema of the graph storage"""
pass
@property
@abstractmethod
def get_structured_schema(self) -> Dict[str, Any]:
r"""Get the structured schema of the graph storage"""
pass
@abstractmethod
def refresh_schema(self) -> None:
r"""Refreshes the graph schema information."""
pass
@abstractmethod
def add_triplet(self, subj: str, obj: str, rel: str) -> None:
r"""Adds a relationship (triplet) between two entities in the database.
Args:
subj (str): The identifier for the subject entity.
obj (str): The identifier for the object entity.
rel (str): The relationship between the subject and object.
"""
pass
@abstractmethod
def delete_triplet(self, subj: str, obj: str, rel: str) -> None:
r"""Deletes a specific triplet from the graph, comprising a subject,
object and relationship.
Args:
subj (str): The identifier for the subject entity.
obj (str): The identifier for the object entity.
rel (str): The relationship between the subject and object.
"""
pass
@abstractmethod
def query(
self, query: str, params: Optional[Dict[str, Any]] = None
) -> List[Dict[str, Any]]:
r"""Query the graph store with statement and parameters.
Args:
query (str): The query to be executed.
params (Optional[Dict[str, Any]]): A dictionary of parameters to
be used in the query. Defaults to `None`.
Returns:
List[Dict[str, Any]]: A list of dictionaries, each
dictionary represents a row of results from the query.
"""
pass
|