From 71d976acb26645565200a7f2244aaf5f562cf2fd Mon Sep 17 00:00:00 2001 From: militarpancho Date: Tue, 24 Jan 2017 13:03:38 +0100 Subject: [PATCH] Added documentation to meaningCloud plugin --- meaningCloud/README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/meaningCloud/README.md b/meaningCloud/README.md index 4278276..70575ce 100644 --- a/meaningCloud/README.md +++ b/meaningCloud/README.md @@ -1,9 +1,24 @@ # Senpy Plugin MeaningCloud - -To use this plugin, you need to obtain an API_KEY from meaningCloud signing up here: https://www.meaningcloud.com/developer/login -Then run Senpy docker image with the path to this plugin as follows: - +MeaningCloud plugin uses API from Meaning Cloud to perform sentiment analysis. + +For more information about Meaning Cloud and its services, please visit: https://www.meaningcloud.com/developer/apis + +## Usage + +To use this plugin, you need to obtain an API key from meaningCloud signing up here: https://www.meaningcloud.com/developer/login + +When you had obtained the meaningCloud API Key, you have to provide it to the plugin, using the param **apiKey**. + +Params: +- Language: English (en) and Spanish (es) +- API Key: the API key from Meaning Cloud. Aliases: ["apiKey","meaningCloud-key"] +- Input: text to analyse. +- Model: model provided to Meaning Cloud API (for general domain) + +## Example of Usage + +Example requests: +``` +https://senpy.gsi.dit.upm.es/api/?algo=meaningCloud&language=en&apiKey=&input=I%20love%20Madrid ``` -$ docker run -ti -p 5000:5000 -e DAEDALUS_KEY=API_KEY -v $PWD:/plugins gsiupm/senpy --host 0.0.0.0 -f /plugins -``` \ No newline at end of file