FirstSpirit函数服务器示例模块|Confluence
此项目演示了如何为实现自定义Function Server FirstSpirit AI. Function Server通过注册AI在提示执行期间可以自主调用的自定义函数来扩展FirstSpirit AI的功能。 这使AI能够访问外部数据源、执行业务逻辑或将复杂的计算委托给自己的代码。 在处理用户请求时,AI会分析可用功能,并根据其定义和请求的上下文自动选择和调用适当的功能。
此示例模块说明了如何创建自己的Confluence连接器,该连接器可以从Confluence实例中检索信息。
参考文献
FirstSpirit API文档)
- 生成AI代理 (
FirstSpirit API文档)
需求
- FirstSpirit 2025.11或更新版本
- Java 17
- Gradle 8.11或更新版本
- 汇流
- 您需要一个有权访问Confluence实例的技术用户。
必须设置以下Gradle属性才能构建模块。 确保将它们添加到文件中 ~/.gradle/gradle.properties 在您的本地主目录中:
artifactory_hosting_username=CLOUD_USERNAME
artifactory_hosting_password=CLOUD_ENCRYPTED_PASSWORD加密的云密码可以通过以下方式检索 一 工件REST API调用 (要求 经过身份验证的会话)。
用法
- 使用以下命令构建模块
./gradlew build并将其安装到您的FirstSpirit服务器中
- 您可以在以下位置找到FSM文件 build/fsm/fs-ai-function-server-example-confluence-.fsm
- 为要使用的Confluence用户添加API令牌。
给它一个指示性名称,并可选择一个到期日期。
- 在ServerManager中,打开“Confluence | Function Server配置服务”的配置。
添加您要使用的Confluence的API令牌和电子邮件地址,并设置Confluence URL。 - 可选:将特殊页面定义为JSON,可用于向AI提供特定信息。该模块将 自动为这些页面创建匹配函数。例如。:
[
{
"id" : "2848522241",
"functionName" : "glossary",
"description" : "provides a term register for technical terms to use in writing"
},
{
"id" : "2848260211",
"functionName" : "writing-guidelines",
"description" : "provides set of mandatory writing guidelines to follow when creating texts"
}
]将为两个Confluence页面创建两个名为“词汇表”和“写作指南”的AI功能。AI将自动 在需要时调用这些函数来获取这些页面。
- 在FirstSpirit AI配置中,定义一个新提示。
- 在提示符的配置对话框中,只需添加
插件 ConfluenceExampleFunctionServerPlugin 到允许的功能列表。
- 在FirstSpirit ContentAssistant中执行提示操作以查看结果。
如果函数适合当前请求,FirstSpirit AI将自动调用该函数。
