langchain_community.graphs.tigergraph_graph.TigerGraph

class langchain_community.graphs.tigergraph_graph.TigerGraph(conn: Any)

图操作用TigerGraph包装器。

安全提示：确保数据库连接使用的是具有窄范围权限的凭据。

否则可能会导致数据损坏或丢失，因为调用代码可能会尝试执行会导致数据删除、修改或读取敏感数据的命令。避免这类负面结果的最佳方法是（根据需要）限制与此工具一起使用的凭据的权限。

更多信息请参阅https://python.langchain.ac.cn/docs/security。

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

属性

conn
get_structured_schema	返回Graph数据库的模式
schema

方法

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

参数

conn (Any) –

__init__(conn: Any) → None

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

参数

conn (Any) –

返回类型

None

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

接受GraphDocument作为输入，并使用它构建图。

参数

• graph_documents (列表[GraphDocument]) –

• include_source (布尔) –

返回类型

None

generate_schema() → 字典[字符串, 列表[字典[字符串, 任意]]]

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

返回类型

字典[字符串, 列表[字典[字符串, 任意]]]

get_schema() → 字符串

返回Graph数据库的模式

返回类型

字符串

query(query: 字符串) → 字典[字符串, 任意]

查询TigerGraph数据库。

参数

query (字符串) –

返回类型

字典[字符串, 任意]

refresh_schema

刷新图模式信息。

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

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

参数

• function_header (str) –

• description (str) –

• docstring (str) –

• param_types (dict) –

返回类型

[]

set_connection(conn: Any) → None

参数

conn (Any) –

返回类型

None

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

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

参数

schema (Optional[Dict[str, Any]]) –

返回类型

None

使用 TigerGraph 的示例

• TigerGraph