`langchain_community.graphs.tigergraph_graph`.TigerGraph¶

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

TigerGraph图操作的包装器。

安全提示：确保数据库连接使用的凭据范围狭窄，仅包括必要的权限。

如果未这样做，可能会导致数据损坏或丢失，因为调用代码可能会尝试执行会导致删除、变异数据（如果适当提示）或读取敏感数据（如果数据库中存在此类数据）的命令。防范这些负面结果的最佳方法是（根据情况）限制授予此工具使用的凭据的权限。

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

Attributes

Methods

`__init__`(conn)	创建一个新的TigerGraph图包装器实例。
`add_graph_documents`(graph_documents[, ...])	将GraphDocument作为输入，并使用它来构建图。
`generate_schema`()	生成TigerGraph数据库的模式并返回用户可以指定一个 sample_ratio （0到1）来确定用于呈现每个Collection模式的文档/边的比例（相对于Collection大小）。
`get_schema`()	返回图数据库的模式
`query`(query)	查询TigerGraph数据库。
`refresh_schema`()	刷新图形模式信息。
`register_query`(function_header, description, ...)	包装函数，用于将自定义的GSQL查询注册到TigerGraph NLQS。
`set_connection`(conn)
`set_schema`([schema])	设置TigerGraph数据库的模式。如果 schema 为None，则自动生成模式。

__init__(conn: Any) → None[source]¶

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

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

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

Parameters

Return type

None

generate_schema() → Dict[str, List[Dict[str, Any]]][source]¶

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

get_schema() → str[source]¶

返回图数据库的模式

query(query: str) → Dict[str, Any][source]¶

查询TigerGraph数据库。

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

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

Parameters

Return type

List[str]

set_connection(conn: Any) → None[source]¶

set_schema(schema: Optional[Dict[str, Any]] = None) → None[source]¶

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

Examples using TigerGraph¶