Index

DEFAULT_PERSIST_DIR module-attribute

DEFAULT_PERSIST_DIR = './storage'

DEFAULT_PERSIST_FNAME module-attribute

DEFAULT_PERSIST_FNAME = 'graph_store.json'

GraphStore

Bases: Protocol

抽象图存储协议。

该协议定义了图存储的接口，负责存储和检索知识图数据。

属性

client: Any: 用于连接到图存储的客户端。 get: Callable[[str], List[List[str]]]: 获取给定主题的三元组。 get_rel_map: Callable[[Optional[List[str]], int], Dict[str, List[List[str]]]]: 获取最大深度内主题的关系映射。 upsert_triplet: Callable[[str, str, str], None]: 更新三元组。 delete: Callable[[str, str, str], None]: 删除三元组。 persist: Callable[[str, Optional[fsspec.AbstractFileSystem]], None]: 将图存储持久化到文件。 get_schema: Callable[[bool], str]: 获取图存储的模式。

Source code in llama_index/core/graph_stores/types.py

@runtime_checkable
class GraphStore(Protocol):
    """抽象图存储协议。

    该协议定义了图存储的接口，负责存储和检索知识图数据。

    属性:
        client: Any: 用于连接到图存储的客户端。
        get: Callable[[str], List[List[str]]]: 获取给定主题的三元组。
        get_rel_map: Callable[[Optional[List[str]], int], Dict[str, List[List[str]]]]:
            获取最大深度内主题的关系映射。
        upsert_triplet: Callable[[str, str, str], None]: 更新三元组。
        delete: Callable[[str, str, str], None]: 删除三元组。
        persist: Callable[[str, Optional[fsspec.AbstractFileSystem]], None]:
            将图存储持久化到文件。
        get_schema: Callable[[bool], str]: 获取图存储的模式。"""

    schema: str = ""

    @property
    def client(self) -> Any:
        """获取客户端。"""
        ...

    def get(self, subj: str) -> List[List[str]]:
        """获取三元组。"""
        ...

    def get_rel_map(
        self, subjs: Optional[List[str]] = None, depth: int = 2, limit: int = 30
    ) -> Dict[str, List[List[str]]]:
        """获取深度感知的相对地图。"""
        ...

    def upsert_triplet(self, subj: str, rel: str, obj: str) -> None:
        """添加三元组。"""
        ...

    def delete(self, subj: str, rel: str, obj: str) -> None:
        """删除三元组。"""
        ...

    def persist(
        self, persist_path: str, fs: Optional[fsspec.AbstractFileSystem] = None
    ) -> None:
        """将图形存储持久化到文件中。"""
        return

    def get_schema(self, refresh: bool = False) -> str:
        """获取图存储的模式。"""
        ...

    def query(self, query: str, param_map: Optional[Dict[str, Any]] = {}) -> Any:
        """使用语句和参数查询图存储。"""
        ...

client property

client: Any

获取客户端。

get

get(subj: str) -> List[List[str]]

获取三元组。

Source code in llama_index/core/graph_stores/types.py

def get(self, subj: str) -> List[List[str]]:
    """获取三元组。"""
    ...

get_rel_map

get_rel_map(
    subjs: Optional[List[str]] = None,
    depth: int = 2,
    limit: int = 30,
) -> Dict[str, List[List[str]]]

获取深度感知的相对地图。

Source code in llama_index/core/graph_stores/types.py

def get_rel_map(
    self, subjs: Optional[List[str]] = None, depth: int = 2, limit: int = 30
) -> Dict[str, List[List[str]]]:
    """获取深度感知的相对地图。"""
    ...

upsert_triplet

upsert_triplet(subj: str, rel: str, obj: str) -> None

添加三元组。

Source code in llama_index/core/graph_stores/types.py

def upsert_triplet(self, subj: str, rel: str, obj: str) -> None:
    """添加三元组。"""
    ...

delete

delete(subj: str, rel: str, obj: str) -> None

删除三元组。

Source code in llama_index/core/graph_stores/types.py

def delete(self, subj: str, rel: str, obj: str) -> None:
    """删除三元组。"""
    ...

persist

persist(
    persist_path: str,
    fs: Optional[AbstractFileSystem] = None,
) -> None

将图形存储持久化到文件中。

Source code in llama_index/core/graph_stores/types.py

def persist(
    self, persist_path: str, fs: Optional[fsspec.AbstractFileSystem] = None
) -> None:
    """将图形存储持久化到文件中。"""
    return

get_schema

get_schema(refresh: bool = False) -> str

获取图存储的模式。

Source code in llama_index/core/graph_stores/types.py

def get_schema(self, refresh: bool = False) -> str:
    """获取图存储的模式。"""
    ...

query

query(
    query: str, param_map: Optional[Dict[str, Any]] = {}
) -> Any

使用语句和参数查询图存储。

Source code in llama_index/core/graph_stores/types.py

def query(self, query: str, param_map: Optional[Dict[str, Any]] = {}) -> Any:
    """使用语句和参数查询图存储。"""
    ...