Skip to content

UmarFBajwa/Sentimail-API

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SentiMail Logo

Travis

Sentimail - The Better Way to Write Emails!

Sentimail is a web application, soon to be chrome extension that reduces the pains of writing emails. Utilizing the Watson API via a decoupled Rails App, anyone can now instantly analyze their email drafts, rather than wasting HOURS going back and forth, unsure of the effectiveness of their messages.

Table of Contents

Why?

Why create Sentimail?

Before Sentimail, we spent countless hours revising an email draft, not knowing whether it was too long, conveyed the wrong emotions, or if the message was clear. The User Experience of writing emails can really be painful. That all changes with Sentimail...

Team Members

Live Project Demo

Sentimail API

Instructions

Sentimail API-Available API Endpoints

/tone /sentiment /keywords

Each endpoint is a post request and requires a param with a content key:

{ content: "Example string" }

Each one returns a JSON. Example response for tone:

{
  "document_tone": {
    "tone_categories": [
      {
        "tones": [
          {
            "score": 0.25482,
            "tone_id": "anger",
            "tone_name": "Anger"
          },
          {
            "score": 0.345816,
            "tone_id": "disgust",
            "tone_name": "Disgust"
          },
          {
            "score": 0.121116,
            "tone_id": "fear",
            "tone_name": "Fear"
          },
          {
            "score": 0.078903,
            "tone_id": "joy",
            "tone_name": "Joy"
          },
          {
            "score": 0.199345,
            "tone_id": "sadness",
            "tone_name": "Sadness"
          }
        ],
        "category_id": "emotion_tone",
        "category_name": "Emotion Tone"
      },
      {
        "tones": [
          {
            "score": 0.999,
            "tone_id": "analytical",
            "tone_name": "Analytical"
          },
          {
            "score": 0.999,
            "tone_id": "confident",
            "tone_name": "Confident"
          },
          {
            "score": 0.694,
            "tone_id": "tentative",
            "tone_name": "Tentative"
          }
        ],
        "category_id": "language_tone",
        "category_name": "Language Tone"
      },
      {
        "tones": [
          {
            "score": 0.271,
            "tone_id": "openness_big5",
            "tone_name": "Openness"
          },
          {
            "score": 0.11,
            "tone_id": "conscientiousness_big5",
            "tone_name": "Conscientiousness"
          },
          {
            "score": 0.844,
            "tone_id": "extraversion_big5",
            "tone_name": "Extraversion"
          },
          {
            "score": 0.257,
            "tone_id": "agreeableness_big5",
            "tone_name": "Agreeableness"
          },
          {
            "score": 0.497,
            "tone_id": "emotional_range_big5",
            "tone_name": "Emotional Range"
          }
        ],
        "category_id": "social_tone",
        "category_name": "Social Tone"
      }
    ]
  }
}

Example response for sentiment:

  {
    "status": "OK",
    "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
    "totalTransactions": "1",
    "language": "english",
    "docSentiment": {
      "mixed": "1",
      "score": "-0.183631",
      "type": "negative"
    }
  }

Example response for keywords:

  {
    "status": "OK",
    "usage": "By accessing AlchemyAPI or using information generated by AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html",
    "totalTransactions": "1",
    "language": "english",
    "keywords": [
      {
        "relevance": "0.936546",
        "text": "Watson"
      },
      {
        "relevance": "0.823589",
        "text": "Watson Developer Cloud"
      }
    ]
  }

About

Back-end API for Sentimail

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 64.6%
  • HTML 34.4%
  • CSS 1.0%