Source code for watson_developer_cloud.tone_analyzer_v3

# Copyright 2016 IBM All Rights Reserved.
#
# 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.

"""
The v3 Tone Analyzer service
(https://www.ibm.com/watson/developercloud/tone-analyzer.html)
"""

from watson_developer_cloud.watson_developer_cloud_service import \
    WatsonDeveloperCloudService


class ToneAnalyzerV3(WatsonDeveloperCloudService):
    default_url = 'https://gateway.watsonplatform.net/tone-analyzer/api'
    latest_version = '2016-05-19'

    def __init__(self, version, url=default_url, **kwargs):
        WatsonDeveloperCloudService.__init__(self, 'tone_analyzer', url,
                                             **kwargs)
        self.version = version

    def tone(self, text, tones=None, sentences=None):
        """
        The tone API is the main API call: it analyzes the "tone" of a piece
        of text. The message is analyzed from
        several tones (social tone, emotional tone, writing tone), and for
        each of them various traits are derived
        (such as conscientiousness, agreeableness, openness).
        :param text: Text to analyze
        :param sentences: If "false", sentence-level analysis is omitted
        :param tones: Can be one or more of 'social', 'language', 'emotion';
        comma-separated.
        """
        params = {'version': self.version}
        if tones is not None:
            params['tones'] = tones
        if sentences is not None:
            params['sentences'] = str(
                sentences).lower()  # Cast boolean to "false" / "true"
        data = {'text': text}
        return self.request(method='POST', url='/v3/tone', params=params,
                            json=data, accept_json=True)