Skip to main content

Official Python SDK for MeaningCloud API

Project description

This is MeaningCloud’s official Python client, designed to enable you to use MeaningCloud’s services easily from your own applications.

MeaningCloud

MeaningCloud is a cloud-based text analytics service that through APIs allows you extract meaning from all kind of unstructured content: social conversation, articles, documents… You can check our demos here: https://www.meaningcloud.com/demos

The different APIs provide easy access to many NLP tasks such as automatic classification, sentiment analysis, topic extraction, etc. To be able to use the service you just have to log into MeaningCloud (by registering or using other services to log in: https://www.meaningcloud.com/developer/login), and you will receive a license key associated to a basic Free plan.

You can read more about the plans and the features available here.

Getting started

Installation

You can load meaningcloud-python into your project by using:

pip install MeaningCloud-python

You can also clone the code and type the following on your shell:

python setup.py install

Configuration

The only thing you need to start using MeaningCloud’s APIs is to log into MeaningCloud (by registering or using other services to log in). Once you’ve done that, you will be given a license key (https://www.meaningcloud.com/developer/account/subscription). Copy it and paste it in the corresponding place in the code, select the API you want to use and the parameters you want to use, and that’s it.

You can find all the technical documentation about the APIs in the API section of the website.

And we are always available at support@meaningcloud.com

Functionality

This SDK currently contains the following:

  • Request: manages requests to any of MeaningCloud’s APIS. It can also be used to directly generate requests without using specific classes .
    • LanguageRequest: models a request to MeaningCloud Language Identification API.
    • TopicsRequest: models a request to MeaningCloud TopicsExtraction API.
    • ClassRequest: models a request to MeaningCloud Text Classification API.
    • SentimentRequest: models a request to MeaningCloud Sentiment Analysis API.
    • ParserRequest: models a request to Meaningcloud Lemmatization, PoS and Parsing API.
  • Response: models a generic response from the MeaningCloud API.
    • TopicsResponse: models a response from the Topic Extraction API, providing auxiliary functions to work with the response, extracting the different types of topics and some of the most used fields in them.
    • ClassResponse: models a response from the Text Classification API, providing auxiliary functions to work with the response and extract the different fields in each category.
    • SentimentResponse: models a response from the Sentiment Analysis API, providing auxiliary functions to work with the response and extract the sentiment detected at different levels and for different elements.
    • LanguageResponse: models a response from the Language Identification API, providing auxiliary functions to work with the response and extract the sentiment detected at different levels and for different elements.
    • ParserResponse: models a response from the Lemmatization, PoS and Parsing API, providing auxiliary functions to work with the response and extract the lemmatization and PoS tagging of the text provided.

Usage

This is an example on how to use this client (also included in the _example_ folder):

#! /usr/bin/env python

# Created by MeaningCloud Support Team
# Date: 26/02/18

import sys
import meaningcloud

# @param model str - Name of the model to use. Example: "IAB_en" by default = "IPTC_en"
model = 'IAB_en'

# @param license_key - Your license key (found in the subscription section in https://www.meaningcloud.com/developer/)
license_key = '<your_license_key>'

# @param text - Text to use for different API calls
text = 'London is a very nice city but I also love Madrid.'




try:
    # We are going to make a request to the Topics Extraction API
    topics_response =  meaningcloud.TopicsResponse(meaningcloud.TopicsRequest(license_key, txt=text, lang='en', topicType='e').sendReq())

    # If there are no errors in the request, we print the output
    if (topics_response.isSuccessful()):
        print("\nThe request to 'Topics Extraction' finished successfully!\n")

        entities =  topics_response.getEntities()
        if (entities):
            print("\tEntities detected (" + str(len(entities)) + "):\n")
            for entity in entities:
                print("\t\t" + topics_response.getTopicForm(entity) + ' --> ' + topics_response.getTypeLastNode(topics_response.getOntoType(entity)) + "\n")

        else:
            print("\nOh no! There was the following error: " + topics_response.getStatusMsg() + "\n")
    else:
        if(topics_response.getResponse() is None):
            print("\nOh no! The request sent did not return a Json\n")
        else:
            print("\nOh no! There was the following error: " + topics_response.getStatusMsg() + "\n")



    #CLASS API CALL
    #class_response = meaningcloud.ClassResponse(meaningcloud.ClassRequest(license_key, txt=text, model=model).sendReq())


    #SENTIMENT API CALL
    #sentiment_response = meaningcloud.SentimentResponse(meaningcloud.SentimentRequest(license_key, lang='en', txt=text, txtf='plain').sendReq())


    #GENERIC API CALL
    #generic = meaningcloud.Request(url="url_of_specific_API",key=key)
    #generic.addParam('parameter','value')
    #generic_result = generic.sendRequest()
    #generic_response = meaningcloud.Response(generic_result)


    #We are going to make a request to the Language Identification API
    lang_response = meaningcloud.LanguageResponse(meaningcloud.LanguageRequest(license_key, txt=text).sendReq())


    #If there are no errors in the request, we will use the language detected to make a request to Sentiment and Topics
    if(lang_response.isSuccessful()):
        print("\nThe request to 'Language Identification' finished successfully!\n")

        results = lang_response.getResults()
        if('language_list' in results.keys() and results['language_list']):
            language = results['language_list'][0]['language']
            print("\tLanguage detected: " + results['language_list'][0]['name'] + ' (' + language + ")\n")

    # We are going to make a request to the Lemmatization, PoS and Parsing API
    parser_response = meaningcloud.ParserResponse(
        meaningcloud.ParserRequest(license_key, txt=text, lang='en').sendReq())

    # If there are no errors in the request, print tokenization and lemmatization
    if parser_response.isSuccessful():
        print("\nThe request to 'Lemmatization, PoS and Parsing' finished successfully!\n")
        lemmatization = parser_response.getLemmatization(True)
        print("\tLemmatization and PoS Tagging:\n")
        for token, analyses in lemmatization.items():
            print("\t\tToken -->", token)
            for analysis in analyses:
                print("\t\t\tLemma -->", analysis['lemma'])
                print("\t\t\tPoS Tag -->", analysis['pos'], "\n")



except ValueError:
    e = sys.exc_info()[0]
    print("\nException: " + str(e))

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
MeaningCloud_python-1.1.1-py2.py3-none-any.whl (17.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 11, 2018
MeaningCloud-python-1.1.1.tar.gz (10.0 kB) Copy SHA256 hash SHA256 Source None Jul 11, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page