apoc.nlp.azure.keyPhrases.graph

过程 Apoc 扩展

为提供的文本创建（虚拟）关键短语图

签名

apoc.nlp.azure.keyPhrases.graph(source :: ANY?, config = {} :: MAP?) :: (graph :: MAP?)

输入参数

名称	类型	默认
source	ANY?	null
config	MAP?	{}

名称

类型

默认

source

ANY?

null

config

MAP?

{}

输出参数

名称	类型
graph（图）	MAP?

名称

类型

graph（图）

MAP?

安装依赖

NLP 过程依赖于 Kotlin 和客户端库，这些库未包含在 APOC Extended 库中。

这些依赖项包含在 apoc-nlp-dependencies-2025.10.0-all.jar 中，可从发布页面下载。下载该文件后，应将其放入 plugins 目录并重启 Neo4j 服务器。

设置 API 密钥

我们可以按照快速入门：使用文本分析客户端库文章中的说明生成 API 密钥和 URL。完成后，我们应该能看到一个列出凭据的页面，类似于下面的截图

图 1. Azure 文本分析凭据

在本例中，我们的 API URL 是 https://neo4j-nlp-text-analytics.cognitiveservices.azure.com/，我们可以使用其中任一隐藏的密钥。

让我们填充并执行以下命令来创建包含这些详细信息的参数。

以下定义了 apiKey 和 apiSecret 参数

:param apiKey => ("<api-key-here>");
:param apiUrl => ("<api-url-here>");

或者，我们可以将这些凭据添加到 apoc.conf 中，并使用静态值存储函数来检索它们。

apoc.conf

apoc.static.azure.apiKey=<api-key-here>
apoc.static.azure.apiUrl=<api-url-here>

以下从 apoc.conf 中检索 AWS 凭据

RETURN apoc.static.getAll("azure") AS azure;

表 1. 结果
azure
{apiKey: "<api-key-here>", apiUrl: "<api-url-here>"}

使用示例

本节中的示例基于以下示例图

CREATE (:Article {
  uri: "/blog/pokegraph-gotta-graph-em-all/",
  body: "These days I’m rarely more than a few feet away from my Nintendo Switch and I play board games, card games and role playing games with friends at least once or twice a week. I’ve even organised lunch-time Mario Kart 8 tournaments between the Neo4j European offices!"
});

CREATE (:Article {
  uri: "https://en.wikipedia.org/wiki/Nintendo_Switch",
  body: "The Nintendo Switch is a video game console developed by Nintendo, released worldwide in most regions on March 3, 2017. It is a hybrid console that can be used as a home console and portable device. The Nintendo Switch was unveiled on October 20, 2016. Nintendo offers a Joy-Con Wheel, a small steering wheel-like unit that a Joy-Con can slot into, allowing it to be used for racing games such as Mario Kart 8."
});

我们可以使用此过程自动创建一个关键短语图谱。系统将为提取出的每个关键短语创建一个带有 KeyPhrase 标签的节点。

默认情况下，返回一个虚拟图，但可以通过指定 write: true 配置来持久化该图。

以下返回 Pokemon 文章的关键短语图

MATCH (a:Article {uri: "/blog/pokegraph-gotta-graph-em-all/"})
CALL apoc.nlp.azure.keyPhrases.graph(a, {
  key: $apiKey,
  url: $apiUrl,
  nodeProperty: "body",
  writeRelationshipType: "KEY_PHRASE",
  write: true
})
YIELD graph AS g
RETURN g;

我们可以在宝可梦关键短语图谱中查看该虚拟图谱的 Neo4j 浏览器可视化效果。

图 2. 宝可梦关键短语图谱

然后，我们可以编写一个查询来返回已创建的关键短语。

以下返回文章及其对应的实体

MATCH (a:Article {uri: "/blog/pokegraph-gotta-graph-em-all/"})
RETURN a.uri AS article,
       [(a)-[:KEY_PHRASE]->(k:KeyPhrase) | k.text] AS keyPhrases;

表 2. 结果
article	keyPhrases
"/blog/pokegraph-gotta-graph-em-all/"	["卡牌游戏", "棋盘游戏", "朋友", "脚", "任天堂 Switch", "日子", "午餐时间组织的马里奥赛车", "锦标赛", "Neo4j 欧洲办事处", "角色"]

如果我们希望流式传输返回的关键短语并对结果应用自定义逻辑，请参阅 apoc.nlp.azure.keyPhrases.stream。