ExtractStructuredBoxFileMetadata 2025.10.9.21

Bundle

org.apache.nifi | nifi-box-nar

Description

Extracts metadata from a Box file using Box AI. The extraction can use either a template or a list of fields. The extracted metadata is written to the FlowFile content as JSON.

Tags

ai, box, extract, metadata, storage

Input Requirement

REQUIRED

Supports Sensitive Dynamic Properties

false

Properties

PropertyDescription
Box Client ServiceController Service used to obtain a Box API connection.
Extraction MethodThe method to use for extracting metadata. TEMPLATE uses a Box metadata template for extraction. FIELDS uses a JSON schema of fields (read from FlowFile content) for extraction.
File IDThe ID of the file from which to extract metadata.
Record ReaderThe Record Reader to use for parsing the incoming data. Required when Extraction Method is FIELDS.
Template KeyThe key of the metadata template to use for extraction. Required when Extraction Method is TEMPLATE.

Relationships

NameDescription
failureA FlowFile is routed to this relationship if an error occurs during metadata extraction.
file not foundFlowFiles for which the specified Box file was not found will be routed to this relationship.
successA FlowFile is routed to this relationship after metadata has been successfully extracted.
template not foundFlowFiles for which the specified metadata template was not found will be routed to this relationship.

Writes attributes

NameDescription
box.idThe ID of the file from which metadata was extracted
box.ai.template.keyThe template key used for extraction (when using TEMPLATE extraction method)
box.ai.extraction.methodThe extraction method used (TEMPLATE or FIELDS)
box.ai.completion.reasonThe completion reason from the AI extraction
mime.typeSet to ‘application/json’ for the JSON content
error.codeThe error code returned by Box
error.messageThe error message returned by Box

See also