Graphdb cypher

GraphDBCypherReader

Bases: BaseReader

图数据库 Cypher 阅读器。

将所有 Cypher 查询结果组合成 LlamaIndex 使用的 Document 类型。

参数

名称	类型	描述	默认值
uri	str	图数据库 URI	必需
username	str	用户名	必需
password	str	密码	必需

源代码位于 llama-index-integrations/readers/llama-index-readers-graphdb-cypher/llama_index/readers/graphdb_cypher/base.py 中

class GraphDBCypherReader(BaseReader):
    """
    Graph database Cypher reader.

    Combines all Cypher query results into the Document type used by LlamaIndex.

    Args:
        uri (str): Graph Database URI
        username (str): Username
        password (str): Password

    """

    def __init__(self, uri: str, username: str, password: str, database: str) -> None:
        """Initialize with parameters."""
        try:
            from neo4j import GraphDatabase, basic_auth

        except ImportError:
            raise ImportError(
                "`neo4j` package not found, please run `pip install neo4j`"
            )
        if uri:
            if uri is None:
                raise ValueError("`uri` must be provided.")
            self.client = GraphDatabase.driver(
                uri=uri, auth=basic_auth(username, password)
            )
            self.database = database

    def load_data(
        self, query: str, parameters: Optional[Dict] = None
    ) -> List[Document]:
        """
        Run the Cypher with optional parameters and turn results into documents.

        Args:
            query (str): Graph Cypher query string.
            parameters (Optional[Dict]): optional query parameters.

        Returns:
            List[Document]: A list of documents.

        """
        if parameters is None:
            parameters = {}

        records, summary, keys = self.client.execute_query(
            query, parameters, database_=self.database
        )

        return [Document(text=yaml.dump(entry.data())) for entry in records]

load_data

load_data(query: str, parameters: Optional[Dict] = None) -> List[Document]

使用可选参数运行 Cypher 并将结果转换为文档。

参数

名称	类型	描述	默认值
query	str	图 Cypher 查询字符串。	必需
parameters	Optional[Dict]	可选查询参数。	工作流程运行检查点

返回

类型	描述
List[Document]	List[Document]：文档列表。

源代码位于 llama-index-integrations/readers/llama-index-readers-graphdb-cypher/llama_index/readers/graphdb_cypher/base.py 中

def load_data(
    self, query: str, parameters: Optional[Dict] = None
) -> List[Document]:
    """
    Run the Cypher with optional parameters and turn results into documents.

    Args:
        query (str): Graph Cypher query string.
        parameters (Optional[Dict]): optional query parameters.

    Returns:
        List[Document]: A list of documents.

    """
    if parameters is None:
        parameters = {}

    records, summary, keys = self.client.execute_query(
        query, parameters, database_=self.database
    )

    return [Document(text=yaml.dump(entry.data())) for entry in records]