balkian/senpy
1
0
Fork 0
mirror of https://github.com/gsi-upm/senpy synced 2024-11-22 16:12:29 +00:00
Code Issues Releases Wiki Activity

Documentation improved meaningCloud

Browse Source
This commit is contained in:
militarpancho 2017-01-25 11:41:57 +01:00
parent 99e13f32e5
commit 37b130abaa
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
meaningCloud/README.md
View File

@ -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**. 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: Params:
- Language: English (en) and Spanish (es) - Language: English (en) and Spanish (es). (default: en)
- API Key: the API key from Meaning Cloud. Aliases: ["apiKey","meaningCloud-key"] - API Key: the API key from Meaning Cloud. Aliases: ["apiKey","meaningCloud-key"]. (required)
- Input: text to analyse. - Input: text to analyse.(required)
- Model: model provided to Meaning Cloud API (for general domain) - Model: model provided to Meaning Cloud API (for general domain). (default: general)
## Example of Usage ## Example of Usage
Example request: Example request:
``` ```
https://senpy.gsi.dit.upm.es/api/?algo=meaningCloud&language=en&apiKey=<put here your API key>&input=I%20love%20Madrid http://senpy.cluster.gsi.dit.upm.es/api/?algo=meaningCloud&language=en&apiKey=<put here your API key>&input=I%20love%20Madrid
``` ```
![alt GSI Logo][logoGSI] ![alt GSI Logo][logoGSI]
[logoGSI]: http://www.gsi.dit.upm.es/images/stories/logos/gsi.png "GSI Logo" [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.