Cloud Vision plugins will allow users to use pre-trained Vision API models to detect emotion, understand text, and more. They will be useful in enriching data with additional attributes such as labels, faces, etc.
NOTE: These plugins will incur additional cost of the Cloud Vision APIs.
Use case(s)
As a user, I want to various features in my images and documents using the Cloud Vision API, so that I can add ML-driven enrichments to my Data Fusion pipelines that process unstructured data
As a user, I want easy, UI-driven ways of manipulating and understanding the output of the Cloud Vision API, so that I do not need to write any code for parsing it.
User Storie(s)
Plugin Type
Batch Source
Batch Sink
Real-time Source
Real-time Sink
Transform
Action
Post-Run Action
Aggregate
Join
Spark Model
Spark Compute
Configurables
File Path Batch Source
This source will read a directory, and instead of emitting records from files in the directory, it will emit all the file names as records. It should work for object stores as well.
Section
User Facing Name
Type
Description
Optional
Default
Basic
Path
textbox
The path to the directory where the files whose paths are to be emitted are located
No
Recursive
toggle
Whether the plugin should recursively traverse the directory for subdirectories
Yes
False
Last Modified After
date-time picker
A way to filter files to be returned based on their last modified timestamp
Yes
1/1/1970 (epoch)
Advanced
Split by
radio button
Determines splitting mechanisms. Choose amongst default (uses the default splitting mechanism of file input format), batch size (by number of files in a batch), directory (by each sub directory)
Yes
default
Batch size
number
Specifies the number of files to process in a single batch. Only required when Split By is set to batch size.
Image Extractor transform
The image extractor transform can be used in conjunction with the file path batch source to extract enrichments from each image based on selected features.
It should send all errors to the error port.
Section
User Facing Name
Type
Description
Optional
Default
Basic
Access Token
Password
Authentication token for Cloud Vision API.
No
Field containing path
Text
Field in the input schema containing the path to the image. Defaults to 'path'
Yes
Path
Features
checkboxes
The features to extract from documents. Select from Text, Handwriting, Crop Hints, Faces, Image properties, Labels, Landmarks, Logos, Multiple Objects, Explicit Content
No
Advanced
Language Hints
multi-select
Optional hints to provide to Cloud Vision API in case it has trouble detecting the language of the text in the images. Only shown when the Text feature is selected. Select from supported languages
Yes
None/Empty
Aspect Ratios
multi-select
Aspect ratios as a decimal number, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. Only shown when Crop Hints is selected as a feature. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.
Yes
None
Include Geo Results
toggle
Whether to include results derived from the geo information in the image. Only shown when Web Detection is selected as a feature
Yes
false
File Extractor transform
Section
User Facing Name
Type
Description
Constraints
Basic
Access Token
Features
checkboxes
The features to extract from documents
Design / Implementation Tips
Tip #1
Tip #2
Design
Approach(s)
Properties
Security
Limitation(s)
Future Work
Some future work – HYDRATOR-99999
Another future work – HYDRATOR-99999
Test Case(s)
Test case #1
Test case #2
Sample Pipeline
Please attach one or more sample pipeline(s) and associated data.