跳到主要内容

agentchat.contrib.graph_rag.graph_query_engine

GraphStoreQueryResult

@dataclass
class GraphStoreQueryResult()

图存储查询结果的封装器。

答案:人类可读的问题/查询的答案。 结果:问题/查询的中间结果,例如节点实体。

GraphQueryEngine

class GraphQueryEngine(Protocol)

一个抽象基类,表示在底层图数据库之上的图查询引擎。

该接口定义了图rag的基本方法。

初始化数据库

def init_db(input_doc: List[Document] | None = None)

此方法使用输入的文档或记录初始化图数据库。通常,它需要执行以下步骤:

  1. 连接到图数据库。
  2. 基于输入数据、图模式等提取图节点、边。
  3. 构建索引等。

参数:

  • input_doc - 用于在数据库中构建图的输入文档列表。

  • 返回 - GraphStore

添加记录

def add_records(new_records: List) -> bool

向底层数据库添加新记录,并根据需要添加到图表中。

查询

def query(question: str,
n_results: int = 1,
**kwargs) -> GraphStoreQueryResult

该方法将字符串格式的问题转换为数据库查询并返回结果。