Short tutorial on building a Sentiment Analysis Shortcut.

Intro to Shortcuts on iPhone and iPad

What’s a shortcut?

A shortcut provides a simple way to add features or actions within apps or by asking Siri. Shortcuts can automate a wide variety of things—in example, analyzing text for sentiment.

Build a Modzy Shortcut

1. In My Shortcuts in the Shortcuts app on iPhone or iPad, tap + in the upper-right corner. An empty shortcut called New Shortcut appears in the shortcut editor.

2. Tap [...] Shortcut Name, type the name of your shortcut, and select where you'd like your shortcut to work, then tap Done. For this example turn on Share Sheet and select only Rich Text, Safari pages and Text.

3. Tap Add Action, search for URL and tap the blue URL action. Type in the Jobs URL for your instance of Modzy (such as https://trial.app.modzy.com/api/jobs).

4. Tap Add Action again and select "Get Contents of URL", then type Show More.

• Choose POST as the Method

• Add two new header fields:

  1. Key of Authorization with Text ApiKey <paste your key here>
  2. Key is Content Type with Text application/json

• The Request Body should be JSON. Now add two new fields:

  1. Add a Dictionary field with Key model. Tap the '0 items' and add a Text item with key identifier and Text of ed542963de, then a key 'version' and a Text of 1.0.1 This is our sentiment analysis model.
  2. Add another Dictionary field with key input Tap the '0 items' and add a Text with key type and Text text, then add another Dictionary field with key sources and tap the 0 items to add another Dictionary field of key my-text and a text item with key input.txt and the Text you can click the Shortcut Input variable.
  3. Click Done until you are back in the main shortcut editing screen. You should have a Request body with fields model and input with 2 items each.

5. This action will call a Modzy model with the payload of the shortcut input!

6. Modzy is asynchronous so now we need to retrieve the results of the job. When creating the job, Modzy will return a job identifier we can use to retrieve the results. To get this jobId, tap + and select Get Item from list. This should autofill to Get First Item from Contents of URL.

7. Tap + and select Get Dictionary Value. Tap key and type jobIdentifier

8. Tap + and select the blue URL. Edit this to include the URL of the Get results endpoint your instance of Modzy (such as https://trial.app.modzy.com/api/results/) and then tap the Dictionary Value variable.

9. This is the location our results are stored. To retrieve the results, add a Get Contents of URL action, this time leave the method as GET but enter the Authorization and Content type as before.

10. This will retrieve the results of the analysis job, which we must now parse by walking through the JSON object tree.

11. Add a Get Dictionary Value action, tap key and type results

12. Add a Get Dictionary Value action, tap key and type my-text

13. Add a Get Dictionary Value action, tap key and type results.json

14. Add a Get Dictionary Value action, tap key and type data

15. Add a Get Dictionary Value action, tap key and type result

16. Add a Get Dictionary Value action, tap key and type classPredictions

17. Finally, we are at our results!

18. From here, let's just display an alert with the results and not parse them further. Add a Show Alert action with the Dictionary Value from the previous step, and the Shortcut Input as the Title.

20. That's all! It was a lot of steps to parse through that JSON object, but that is just how Shortcuts works.
21. Let's try it out: go find some text, select it, click Share... in the popup menu, then scroll down until you see your Shortcut in the actions menu.