ExtractStructuredBoxFileMetadata

文档中心 › 组件索引 › ExtractStructuredBoxFileMetadata

ExtractStructuredBoxFileMetadata Processor

类型全限定名:cn.org.acal.lynxus.processors.box.ExtractStructuredBoxFileMetadata

所属 Bundle:cn.org.acal.lynxus:lynxus-box-nar:2.11.8

描述

使用 Box AI 从 Box 文件中提取元数据。 提取可以使用模板或字段列表。 提取的元数据以 JSON 形式写入 FlowFile 内容。

标签

boxstoragemetadataaiextract

属性

下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。

名称默认值可选值描述
Box Client Service控制器服务 API:
BoxClientService
cn.org.acal.lynxus-lynxus-box-services-api-nar-2.11.8
Controller Service用于获取 Box API 连接。
File ID${box.id}要从中提取元数据的文件的 ID。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Extraction MethodTEMPLATE
  • Template — 使用 Box 元数据模板进行提取。
  • Fields — 使用字段的 JSON schema 从 FlowFile 内容中提取。 schema 应包含 'key'(必填);'type'、'description'、'displayName'、'prompt' 和 'options' 字段为可选。 这遵循 BOX API 的字段 schema。
用于提取元数据的方法。TEMPLATE 使用 Box 元数据模板进行提取。FIELDS 使用字段的 JSON 模式(从 FlowFile 内容中读取)进行提取。
Template Key用于提取的元数据模板的键。 当提取方法为 TEMPLATE 时需要。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Record Reader控制器服务 API:
RecordReaderFactory
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8
用于解析传入数据的记录读取器。当提取方法为 FIELDS 时必填。

关系 (Relationships)

名称描述自动终止
failure如果在元数据提取期间发生错误,则 FlowFile 将路由到此关系。否
file not found未找到指定 Box 文件的 FlowFile 将被路由到此关系。否
success成功提取元数据后,FlowFile 将路由到此关系。否
template not found未找到指定元数据模板的 FlowFile 将被路由到此关系。否

写入的 FlowFile 属性

名称描述
box.id从中提取元数据的文件的 ID
box.ai.template.key用于提取的模板密钥(使用 TEMPLATE 提取方法时)
box.ai.extraction.method使用的提取方法(模板或字段)
box.ai.completion.reasonAI提取完成原因
mime.typeJSON 内容设置为“application/json”
error.codeBox 返回的错误代码
error.messageBox 返回的错误消息

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件要求有传入连接。