Skip to main content

StartGcpVisionAnnotateFilesOperation

Description​

Trigger a Vision operation on file input. It should be followed by GetGcpVisionAnnotateFilesOperationStatus processor in order to monitor operation status.

Tags​

Cloud, Google, Machine Learning, Vision

Properties​

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
JSON Payloadjson-payload{
"requests": [
{
"inputConfig": {
"gcsSource": {
"uri": "gs://${gcs.bucket}/${filename}"
},
"mimeType": "application/pdf"
},
"features": [{
"type": "${vision-feature-type}",
"maxResults": 4
}],
"outputConfig": {
"gcsDestination": {
"uri": "gs://${output-bucket}/${filename}/"
},
"batchSize": 2
}
}]
}
JSON request for AWS Machine Learning services. The Processor will use FlowFile content for the request when this property is not specified.

Supports Expression Language, using FlowFile attributes and Environment variables.
GCP Credentials Provider Service *gcp-credentials-provider-serviceController Service:
GCPCredentialsService

Implementations:
GCPCredentialsControllerService
The Controller Service used to obtain Google Cloud Platform credentials.
Output Bucketoutput-bucketName of the GCS bucket where the output of the Vision job will be persisted. The value of this property applies when the JSON Payload property is configured. The JSON Payload property value can use Expression Language to reference the value of ${output-bucket}

Supports Expression Language, using FlowFile attributes and Environment variables.
Vision Feature Typevision-feature-typeTEXT_DETECTIONType of GCP Vision Feature. The value of this property applies when the JSON Payload property is configured. The JSON Payload property value can use Expression Language to reference the value of ${vision-feature-type}

Supports Expression Language, using FlowFile attributes and Environment variables.

Dynamic Properties​

This component does not support dynamic properties.

Relationships​

NameDescription
failureFlowFiles are routed to failure relationship
successFlowFiles are routed to success relationship

Reads Attributes​

This processor does not read attributes.

Writes Attributes​

NameDescription
operationKeyA unique identifier of the operation returned by the Vision server.

State Management​

This component does not store state.

Restricted​

This component is not restricted.

Input Requirement​

Input requirements are not specified for this component.

System Resource Considerations​

This component does not specify system resource considerations.

See Also​

GetGcpVisionAnnotateFilesOperationStatus