language-sentiment.html

<!--
Copyright 2019 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-language-sentiment">
    <!--Name-->
    <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>

    <!--Credentials-->
    <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>

    <!--Key File-->
    <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>

    <!--Language-->
    <div class="form-row">
        <label for="node-input-languageCode"><i class="fa fa-language"></i> Language</label>
        <input type="text" id="node-input-languageCode">
    </div>
</script>

<script type="text/html" data-help-name="google-cloud-language-sentiment">
    <p>Perform sentiment analysis on the document.</p>
    <p>Additional information on sentiment analysis can be found in the <a href="https://cloud.google.com/natural-language/docs/basics#sentiment_analysis">Google Cloud Docs</a>.</p>
    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>msg.payload
            <span class="property-type">string</span>
        </dt>
        <dd>The document on which to perform senitment analysis.</dd>
    </dl>

    <h3>Outputs</h3>
    <dl class="message-properties">
        <dt>msg.sentiment.score
            <span class="property-type">number</span>
        </dt>
        <dd>The sentiment score.</dd>
        <dt>msg.sentiment.magnitude
            <span class="property-type">number</span>
        </dt>
        <dd>The sentiment magnitude.</dd>        
    </dl>        

    <h3>Details</h3>
    <p><code>msg.payload</code> is used as the document to perform sentiment analysis upon.</p>
    <p>The language field defines the language to be used for processing.  It must be one
        of the <a href="https://cloud.google.com/natural-language/docs/languages#sentiment_analysis">supported</a> languages</p>
</script>

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