AuraGraphDataScience

class graphdatascience.session.AuraGraphDataScience

用于与 Neo4j 数据库及图数据科学 (GDS) 会话交互的主要 API 类。请始终将此对象绑定到名为 gds 的变量。

arrow_client() → GdsArrowClient

返回一个经过身份验证的 GdsArrowClient，用于与 Aura 图分析会话进行通信。此客户端可用于直接访问特定会话的 Arrow Flight 服务器。

返回:

GdsArrowClient

返回类型:

GdsArrowClient

---

bookmarks() → Any | None

获取定义当前执行 Cypher 查询所需状态的 Neo4j 书签

返回类型:

定义当前所需状态的（可能为 None 的）Neo4j 书签

close() → None

关闭 GraphDataScience 对象并释放其持有的任何资源。

返回类型:

None

database() → str | None

获取执行 Cypher 查询所针对的数据库。

返回:

数据库名称。

返回类型:

str | None

delete() → bool

删除 GDS 会话。

返回类型:

bool

driver_config() → dict[str, Any]

获取用于创建底层驱动程序的配置，该驱动程序用于向 Neo4j 发送查询。

返回:

以字典形式返回的配置。

返回类型:

dict[str, Any]

find_node_id(labels: list[str] = [], properties: dict[str, Any] = {}) → int

查找具有给定标签和属性的节点的节点 ID。

参数:

• labels (list[str]) – 要查找的节点的标签。

• properties (dict[str, Any]) – 要查找的节点的属性。

返回:

具有给定标签和属性的节点的节点 ID。

返回类型:

int

last_bookmarks() → Any | None

获取定义最近一次调用查询后状态的 Neo4j 书签

返回类型:

定义最近一次调用查询后状态的（可能为 None 的）Neo4j 书签

list() → DataFrame

列出所有可用的 GDS 过程。

返回:

包含所有可用 GDS 过程的 DataFrame。

返回类型:

DataFrame

lp_pipe(name: str) → LPTrainingPipeline

创建一个采用所有默认设置的链路预测 (Link Prediction) 训练流水线。

参数:

name (str) – 给流水线起的名称。在流水线目录中必须是唯一的。

返回:

一个新的链路预测流水线对象实例。

返回类型:

LPTrainingPipeline

nc_pipe(name: str) → NCTrainingPipeline

创建一个采用所有默认设置的节点分类 (Node Classification) 训练流水线。

参数:

name (str) – 给流水线起的名称。在流水线目录中必须是唯一的。

返回:

一个新的节点分类流水线对象实例。

返回类型:

NCTrainingPipeline

nr_pipe(name: str) → NRTrainingPipeline

创建一个采用所有默认设置的节点回归 (Node Regression) 训练流水线。

参数:

name (str) – 给流水线起的名称。在流水线目录中必须是唯一的。

返回:

一个新的节点回归流水线对象实例。

返回类型:

NRTrainingPipeline

run_cypher(query: str, params: dict[str, Any] | None = None, database: str | None = None, retryable: bool = False, mode: QueryMode = QueryMode.WRITE) → DataFrame

针对 Neo4j 数据库运行 Cypher 查询。

参数:

• query (str) – Cypher 查询语句

• params (dict[str, Any]) – 查询参数

• database (str) – 要在其上运行查询的数据库

• retryable (bool) – 查询是否可以自动重试。如果设置为 True，请确保查询是幂等的。

• mode (QueryMode) – 要使用的查询模式（READ 或 WRITE）。根据查询中执行的操作进行设置。

返回:

以 DataFrame 形式返回查询结果

返回类型:

DataFrame

server_version() → ServerVersion

获取 GDS 库的版本。

返回:

GDS 库的版本。

返回类型:

ServerVersion

set_bookmarks(bookmarks: Any) → None

设置 Neo4j 书签，要求在执行下一个查询之前达到特定状态

参数:

bookmarks (Bookmark(s)) – 定义所需状态的 Neo4j 书签

返回类型:

None

set_database(database: str) → None

设置执行 Cypher 查询所针对的数据库。

参数:

database (str) – 要在其上运行查询的数据库名称。

返回类型:

None

set_show_progress(show_progress: bool) → None

设置是否显示正在运行过程的进度。

参数:

show_progress (bool) – 是否显示过程的进度。

返回类型:

None

property v2: SessionV2Endpoints

返回预览版 v2 端点。这些端点可能会在没有预警的情况下发生变更。这些端点是本库下一主要版本 API 的预览。

verify_connectivity() → None

验证 Aura 图分析会话是否就绪，以及能否建立与 Aura 图分析会话的连接。如果指定了数据库，还会验证到 Neo4j 数据库的连接。

抛出异常:

Exception – 如果会话不再运行、无法访问会话或数据库驱动程序无法连接到远程环境，则会引发异常。

返回类型:

None

version() → str

获取 GDS 库的版本。

返回:

GDS 库的版本。

返回类型:

str