https://github.com/hunterowens/frankenstein

https://github.com/hunterowens/frankenstein

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hunterowens/frankenstein
• Owner: hunterowens
• License: apache-2.0
• Created: 2017-11-25T20:51:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-11T07:14:46.000Z (about 6 years ago)
• Last Synced: 2024-10-19T11:28:22.240Z (2 months ago)
• Language: Python
• Size: 58.4 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# frankenstein

## Using the API 

To use the API, first call the `start-show` endpoint. This should return a `show_id` that you will use for the rest of the session. 

To send texts to the api, send a post to `interact`. Example in `curl`

```shell 

curl --header "Content-Type: application/json" \

  --request POST \

  --data '{"string":"bankds happy happy bands", "show_id": 1}' \

  http://frankenstein.hunterowens.net/interact

```

To get the most recent text plus Sentiment scores. 

```shell 

curl http://frankenstein.hunterowens.net/interact?show_id=$YOUR_SHOW_ID

```

To get the talk functions from the api. 

```shell

curl http://frankenstein.hunterowens.net/talk?show_id=$YOUR_SHOW_ID

```

To get the summary themes

```shell

curl http://frankenstein.hunterowens.net/summary?show_id$YOUR_SHOW_ID

```

Alternatively, you can provide multiple show_ids to `summary`, as a comma seperate list as such: `/summary?show_ids=1,2

To list all shows and show IDs 

```shell 

curl http://frankenstein.hunterowens.net/list-shows

```

To update a show

```shell

 curl --header "Content-Type: application/json" \

  --request POST \

  --data '{"show_status":"in_progress", "show_id": 1}' \

  http://frankenstein.hunterowens.net/update-show

```

show_status can be one of `preshow`, `in_progress`,`complete`.

To save a log

```shell

curl --header "Content-Type: application/json" \

  --request POST \

    --data '{"actor": "hunter", "show_id": 2, "text": "some text", "action": "intro"}' \

      http://localhost:5000/log

```