TigerGraph#

class langchain_community.graphs.tigergraph_graph.TigerGraph(conn: Any)[source]#

TigerGraph图操作封装器。

Security note: Make sure that the database connection uses credentials

这些权限范围狭窄,仅包含必要的权限。 未能这样做可能会导致数据损坏或丢失,因为调用代码可能会尝试执行导致数据删除、变异的命令,如果被适当提示,或者读取敏感数据,如果这些数据存在于数据库中。 防止这种负面结果的最佳方法是(适当地)限制授予与此工具一起使用的凭据的权限。

查看 https://python.langchain.com/docs/security 获取更多信息。

创建一个新的TigerGraph图包装器实例。

属性

conn

get_structured_schema

返回图数据库的模式

schema

方法

__init__(conn)

创建一个新的TigerGraph图包装器实例。

add_graph_documents(graph_documents[, ...])

将GraphDocument作为输入并使用它来构建图。

generate_schema()

生成TigerGraph数据库的模式并返回。用户可以指定一个sample_ratio(0到1)来确定用于渲染每个集合模式的文档/边的比例(相对于集合大小)。

get_schema()

返回图数据库的模式

query(query)

查询TigerGraph数据库。

refresh_schema()

刷新图模式信息。

register_query(function_header, description, ...)

用于将自定义GSQL查询注册到TigerGraph NLQS的包装函数。

set_connection(conn)

set_schema([schema])

设置TigerGraph数据库的模式。

Parameters:

conn (任意)

__init__(conn: Any) None[source]#

创建一个新的TigerGraph图包装器实例。

Parameters:

conn (任意)

Return type:

abstract add_graph_documents(graph_documents: List[GraphDocument], include_source: bool = False) None#

将GraphDocument作为输入并使用它来构建图形。

Parameters:
Return type:

generate_schema() Dict[str, List[Dict[str, Any]]][source]#

生成TigerGraph数据库的模式并返回它 用户可以指定一个sample_ratio(0到1)来确定 用于呈现每个集合模式的文档/边的比例(相对于集合大小)。

Return type:

Dict[str, List[Dict[str, Any]]]

get_schema() str[source]#

返回图数据库的模式

Return type:

字符串

query(query: str) Dict[str, Any][来源]#

查询TigerGraph数据库。

Parameters:

query (str)

Return type:

Dict[str, Any]

refresh_schema()[source]#

刷新图形模式信息。

register_query(function_header: str, description: str, docstring: str, param_types: dict = {}) List[str][source]#

用于将自定义GSQL查询注册到TigerGraph NLQS的包装函数。

Parameters:
  • function_header (str)

  • 描述 (str)

  • docstring (str)

  • param_types (dict)

Return type:

列表[str]

set_connection(conn: Any) None[source]#
Parameters:

conn (任意)

Return type:

set_schema(schema: Dict[str, Any] | None = None) None[source]#

设置TigerGraph数据库的模式。 如果schema为None,则自动生成模式。

Parameters:

schema (Dict[str, Any] | None)

Return type:

使用TigerGraph的示例