昇腾社区首页
中文
注册

retrieve_graph

功能

调用该接口检索返回相关文档片段。

函数原型

def retrieve_graph(graph_name, graph_type, question, **kwargs)

输入参数说明

参数名

数据类型

是否必选

说明

graph_name

str

知识图谱名称,默认为“graph”,其取值范围为[1, 255]。

graph_type

str

图数据库类型,只能取以下两个值中的一个【'networkx', 'opengauss'】

question

str

用户问题,字符串长度范围[1, 1000*1000]

kwargs

dict

扩展参数列表:
  • use_text:布尔类型,默认为True,表示在检索子图时仅使用文本类型的节点包含的文本构建上下文。
  • batch_size:整数类型,默认为512,表示在对节点向量化时的批次大小,其范围为[1, 1024]。
  • similarity_tail_threshold:向量相似阈值,默认为0.0,低于该值将被过滤,其范围为[0.0, 1.0]。
  • retrieval_top_k:整数类型,默认为40,根据实体从节点向量数据库检索相似节点时的topk,其范围为[1, 1000]。
  • reranker_top_k:reranker需要的topk,默认为20,其范围为[1, 1000]。
  • subgraph_depth:整数类型,默认为2,图检索最大探索的深度,其取值范围为[1, 5]。

返回值说明

数据类型

说明

List[str]

检索到的上下文片段。