From 37b130abaa6bebc90658580c1f4b91edc1b0ed25 Mon Sep 17 00:00:00 2001 From: militarpancho Date: Wed, 25 Jan 2017 11:41:57 +0100 Subject: [PATCH] Documentation improved meaningCloud --- meaningCloud/README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/meaningCloud/README.md b/meaningCloud/README.md index 9a7e002..bb133f7 100644 --- a/meaningCloud/README.md +++ b/meaningCloud/README.md @@ -10,20 +10,22 @@ To use this plugin, you need to obtain an API key from meaningCloud signing up h When you had obtained the meaningCloud API Key, you have to provide it to the plugin, using the param **apiKey**. +To use this plugin, you should use a GET Requests with the following possible params: 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) +- Language: English (en) and Spanish (es). (default: en) +- API Key: the API key from Meaning Cloud. Aliases: ["apiKey","meaningCloud-key"]. (required) +- Input: text to analyse.(required) +- Model: model provided to Meaning Cloud API (for general domain). (default: general) ## Example of Usage Example request: ``` -https://senpy.gsi.dit.upm.es/api/?algo=meaningCloud&language=en&apiKey=&input=I%20love%20Madrid +http://senpy.cluster.gsi.dit.upm.es/api/?algo=meaningCloud&language=en&apiKey=&input=I%20love%20Madrid ``` ![alt GSI Logo][logoGSI] [logoGSI]: http://www.gsi.dit.upm.es/images/stories/logos/gsi.png "GSI Logo" +Example respond: This plugin follows the standard for the senpy plugin response. For more information, please visit [senpy documentation](senpy.readthedocs.io). Specifically, NIF API section.