mirror of
https://github.com/gsi-upm/senpy
synced 2024-11-13 04:02:29 +00:00
Added documentation to meaningCloud plugin
This commit is contained in:
parent
c57cfff0cc
commit
71d976acb2
@ -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=<put here your API key>&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
|
||||
```
|
Loading…
Reference in New Issue
Block a user