automl.html

<!--
Copyright 2020 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<script type="text/html" data-template-name="google-cloud-automl">
    <div class="form-row">
        <label for="node-input-account"><i class="fa fa-user"></i> Credentials</label>
        <input type="text" id="node-input-account">
    </div>
    <div class="form-row">
        <label for="node-input-keyFilename"><i class="fa fa-user"></i> Key File</label>
        <input type="text" id="node-input-keyFilename">
    </div>
    <div class="form-row">
        <label for="node-input-projectId"><i class="fa fa-object-group"></i> Project</label>
        <input type="text" id="node-input-projectId">
    </div>
    <div class="form-row">
        <label for="node-input-location"><i class="fa fa-map-signs"></i> Location</label>
        <input type="text" id="node-input-location">
    </div>
    <div class="form-row">
        <label for="node-input-modelId"><i class="fa fa-table"></i> Model ID</label>
        <input type="text" id="node-input-modelId">
    </div>
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name">
    </div>
</script>

<script type="text/html" data-help-name="google-cloud-automl">
    <p>Perform an AutoML prediction.</p>
    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>msg.payload.payload
            <span class="property-type">object</span>
        </dt>
        <dd>The data to predict against.</dd>
        <dt>msg.payload.params
            <span class="property-type">object</span>
        </dt>
        <dd>Optional parameters</dd>
    </dl>  

    <h3>Details</h3>
    <p>
    The GCP AutoML service allows us to train custom models and then run predictions against them.  The Node-RED AutoML node allows us to execute
    a prediction request.  It encapsulates the predict API documented
    <a href="https://cloud.google.com/automl/docs/reference/rest/v1/projects.locations.models/predict">here</a>.  On execution the msg.payload is expected to have child nodes of:
    </p>
    <ul>
        <li>msg.payload.payload</li>
        <li>msg.payload.params (optional)</li>
    </ul>
    <p>corresponding to the payload and params data requested by the API.  The response is found in <code>msg.payload</code>.
    </p>
    <p>
    The configuration of the node requires:
    </p>
    <ul>
        <li><code>Project</code> - The project containing the model.</li>
        <li><code>Region</code> - The region containing the model.</li>
        <li><code>Model ID</code> - The API key for the model (usually TCN…..).</li>
    </ul>
</script>

<script type="text/javascript">
RED.nodes.registerType("google-cloud-automl", {
    category: "GCP",
    defaults: {
        account: { type: "google-cloud-credentials", required: false },
        keyFilename: {value: "", required: false },
        projectId: { value: "", required: true },
        location: { value: "us-central1", required: true },
        modelId: { value: "", required: true },
        name: { value: "", required: false }
    },
    inputs: 1,
    outputs: 1,
    icon: "nl-api.png",
    align: "left",
    color: "#3FADB5",
    label: function () {
        return this.name || "automl";
    },
    paletteLabel: "automl"
});
</script>