Skip to content

nicolodiamante/dispatch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 

Repository files navigation

Dispatch

Artificial Intelligence (AI) already plays a significant role in numerous aspects of your daily life that you may not be aware of. For instance, AI assists in sorting your emails, providing driving directions, and delivering your favourite music. Now, consider the advancement of this integration with the use of Wake Me Up an interactive shortcut. This service is enhanced by two prominent AI technologies – ChatGPT and ElevenLabs, specialising respectively in natural language processing and realistic speech recordings. Wake Me Up serves as a personal assistant, managing your schedule and offering a summary of your daily tasks through a lifelike vocal tone.



OpenAI + ElevenLabs



In order to effectively integrate ChatGPT with ElevenLabs, you must fulfil specified prerequisites and establish the necessary connections. Fortunately, this sequence of steps is relatively straightforward.



Requirements for the dispatch to work

Get the Shortcut

To initiate, first download the Apple Shortcuts app followed by the Wake Me Up shortcut. Feel free to rename the shortcut to a title of your preference. However, before you begin using it, ensure that you continue reading for further instructions.



Download the Shortcut



Create your OpenAI API Key

In order to utilise the services provided by OpenAI, an API key is required. You can procure this key by creating a new secret key through your existing OpenAI account. Commence the process by following these instructions. The initial step requires you to sign in to your OpenAI account. Subsequently, search for the 'Create new secret key' option and select that.

Create new secret key

After acquiring the API Key, integration with SiriGPT's services becomes simple. Please remember, once you have copied the key and closed the pop-up, it will not be visible again. Therefore, it is vital to store the key in a secure place.

OpenAI API Key


Get ElevenLabs API key

To commence utilising the ElevenLabs API, you are required to sign up for an API key via their official website. Once you have successfully logged in, navigate to the upper right corner and click on your profile picture. Subsequently, choose Profile from the options available.



Create new secret key



Once you've opened the profile settings, you can then obtain an API key, which will allow you to start using their text-to-speech service.

ElevenLabs API Key



Setting Up

After you've successfully downloaded the shortcut and copied the API key, it's time to engage its functionality and see it in action:



Paste your API keys



  • Start by launching the Shortcuts app on your device and select the Wake Me Up shortcut that you've previously downloaded.

  • Upon activating the Wake Me Up shortcut, you'll need to enter your OpenAI and ElevenLabs API keys. You can choose to store these keys either directly in the shortcut or in the Data Jar app. However, if you choose to store the keys in the shortcut, it's crucial to ensure their privacy. Any inadvertent exposure could compromise your security and potentially result in a breach.

  • Next, proceed with the setup process. Carefully follow every required step to tailor the output prompt and voice to meet your specific preferences for the shortcut. Once completed, Wake Me Up can be put to use immediately.



Shortcut Automation



When you wish to use the shortcut, just turn on Siri and utter the command Wake Me Up. Upon doing this, your daily schedules will be generated and read out to you. For further simplicity, you can establish an automation in the Shortcuts application. This will be triggered each time you silence your wake-up alarm, eliminating the need for you to manually activate it.



Wake Me Up Output



What's new in Dispatch

v1.2

Release Highlights:

  • Models Integrations: Integrated the ChatGPT-4-Turbo model, combining GPT-4's advanced reasoning with enhanced processing speed for quicker, more efficient responses, also added the ChatGPT-3.5-Turbo-1106 variant, which offers an upgraded performance on the 3.5-Turbo model for scenarios requiring incremental improvements in response quality while maintaining high efficiency and speed.

  • Prompt Output Enhancement: Improved the prompt's output for more human-like interactions, ensuring users receive more valuable and relevant information.

  • Flexible Speech Output Provider Options: Introduced the option to choose between OpenAI and ElevenLabs for voice output, giving users the flexibility to select their preferred text-to-speech provider.

  • ElevenLabs Voice Setting Enhancements: Added the ability to customise voice style and speaker boost feature, providing users greater control and a more enriched audio experience.

  • Expanded ElevenLabs Voice Selection: Added new voices for speech output customisation.

    Available Voices:

    • American: American: Bill, Drew, Paul
    • British: George, Lily
    • Special: Santa Claus

v1.1.2

Release Highlights:

  • Enhanced Podcast Selection Logic: Upgraded the podcast selection mechanism in the shortcut, coupled with improvements in the customisation process, resulting in a more intuitive and user-friendly experience for users.

  • Prompt Output Enhancement: Improved the prompt's output for more human-like interactions, ensuring users receive more valuable and relevant information.


v1.1.1

Release Highlights:

  • Shortcut Actions Revision: Streamlined the Shortcut actions for increased efficiency.

  • Prompt Clarity Improvement: Enhanced the prompt for clearer and more understandable output.


v1.1.0

Release Highlights:

  • Token Customisation Option: Introduced the ability for users to customise the number of tokens used in content generation. Note: The maximum token count is shared between the prompt and completion sections, and the limit varies depending on the model. On average, one token equals about 4 characters in standard English.

  • Expanded Voice Selection: Added new voices for speech output customisation. Remember, testing these voices counts towards the 10,000-character limit on free accounts.

    Available Voices:

    • American: Adam, Antoni, Arnold, Bella, Callum, Clyde, Daniel, Dave, Domi, Elli, Emily, Ethan, Freya, Gigi, Glinda, Grace (American-Southern), Harry, Jeremy (American-Irish), Jessie, Josh, Liam, Matilda, Michael, Nicole, Patrick, Rachel, Ryan, Sam, Serena, Thomas
    • Australian: Charlie, James
    • British: Dave (Essex), Dorothy, Joseph, Matthew
    • Irish: Fin
    • Italian (English): Giovanni
    • Swedish (English): Charlotte, Mimi

v1.0.7

Release Highlights:

  • Language Model Choices: Users can now choose between Monolingual and Multilingual models from ElevenLabs. The Monolingual model focuses on standard English, while the Multilingual model offers diverse dialogue in several languages. Note: The Multilingual model is in beta and may produce unpredictable results for long texts.

  • Latency Optimisation Settings: Implemented new settings for controlling latency with potential trade-offs in quality.

    • 0: Default (no optimisations)
    • 1: Normal latency optimisations
    • 2: Strong latency optimisations
    • 3: Maximum latency optimisations
    • 4: Maximum optimisations with text normaliser off (may affect pronunciation accuracy)
  • Voice Quality Improvements: Adjusted stability and similarity parameters for better voice output.


v1.0.6

Release Highlights:

  • Enhanced Customization Settings: Users can now fine-tune settings like Temperature, Top P, Frequency Penalty, and Presence Penalty, as well as Voice Stability and Similarity.

  • Audio Content Options Post-Summary: Added the option to enjoy a favourite playlist or podcast following the daily summary.


v1.0.5

Release Highlights:

  • Work Departure Time Reminder: Added a feature to remind users of optimal departure times for work.

  • Podcast Listening Post-Summary: Enabled the option to listen to a favourite podcast at the end of the summary.

  • API Key Storage Customisation: Users can now choose where to store their API keys.

  • Configurable Summary Output: Provided options for users to tailor the output summary to their preferences.


Dispatch Privacy

Privacy is a user right, which is why Dispatch gives you the ability to choose which personal data to disclose during setup. Dispatch is a shortcut within the Apple ecosystem that already provides protection, including when third-party service providers are acting on behalf of Apple. However, OpenAI and ElevenLabs APIs are required for the shortcut to function. If you don't want to give out any information to third-party services, you won't be able to use Dispatch. However, if you consider using it, you should read the OpenAI's and ElevenLabs' Privacy Policies first.



Shortcut Privacy



Notes

GPT-4

This shortcut is primarily programmed to operate on the GPT-4 model by default. When we compare the operations of GPT-4 model with the GPT-3.5 model, there is little to distinguish between them in terms of performance for relatively straightforward tasks. However, the GPT-4 model outperforms the previous versions, especially when encountering complex reasoning scenarios. If you wish to access the GPT-4-serviced API, it's crucial to note that this privilege is limited to APIs with a history of successful transactions. If an API isn't eligible to run on the GPT-4 model, for instance, if it doesn't meet ChatGPT-4's qualification criteria, it's recommended to default to the GPT-3.5-Turbo model. If you're looking to explore the various subscription packages, you can review the available options here.


OpenAI Text to Speech

The TTS model generally follows the Whisper model in terms of language support. Whisper supports the following languages and performs well despite the current voices being optimised for English:

Afrikaans, Arabic, Armenian, Azerbaijani, Belarusian, Bosnian, Bulgarian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, English, Estonian, Finnish, French, Galician, German, Greek, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Macedonian, Malay, Marathi, Maori, Nepali, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovenian, Spanish, Swahili, Swedish, Tagalog, Tamil, Thai, Turkish, Ukrainian, Urdu, Vietnamese, and Welsh.

It can generate spoken audio in these languages with the input text in the language of your choice.


ElevenLabs

Signing up to ElevenLabs gives you a free subscription, which includes 10,000 characters per month. Nonetheless, you may exhaust your limit before the month ends. When this happens, you'll automatically switch to Siri's voice unless you choose to enhance your subscription for additional characters. Also when you try out the ElevenLabs voices to identify the voice that suits you best they will use the 10,000 characters of the free account. For information about upgrade your account, see the subscription options here.


Language & Region (Number Separator)

The decimal point used when setting decimal numbers is determined by the region settings of the device; for example, a decimal can be set as 0.1 or 0.1.


Resources

Apple

OpenAI

ElevenLabs

Data Jar

Contribution

Thank you for considering the use of this shortcut. Your collaboration in improving Dispatch would be of immense value and your feedback would be much appreciated. In case you run into any issues or bugs, please report them on the issues page.

Nicolò Diamante Portfolio

MIT License