Skip to content

Commit

Permalink
improved the shortcut and made minor changes to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolodiamante committed Jun 29, 2023
1 parent 224a076 commit be807f4
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 33 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
SOFTWARE.
142 changes: 110 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,61 @@
<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/0567143d-bb72-4bb3-9fba-f49eb4b6545b" draggable="false" ondragstart="return false;" alt="SiriGPT Title" title="SiriGPT" /></a></p>
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/nicolodiamante/SiriGPT/assets/48920263/8620df70-0f82-4804-bd13-1b939c752680" draggable="false" ondragstart="return false;" alt="SiriGPT" title="SiriGPT" />
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/27d01f39-55fe-477f-9f77-684b4b72a17f" draggable="false" ondragstart="return false; "alt="SiriGPT" title="SiriGPT" />
</picture>
</p>

The technologies driving the new wave of chatbots have been brewing for years, taking the world by storm. The release of ChatGPT has triggered a Silicon Valley arms race, pitting the best minds against each other to push the limits of what chatbots can do. But while voice assistants like [Siri][apple-siri] have been around for a while, they don't pack the same punch as [ChatGPT][chaGPT]. That's where the real magic happens, by combining the best of both worlds, we can give Siri a significant IQ boost and take chatbots to new heights. The integration of ChatGPT into Siri represents a new unique way to interact and boost our devices. This shortcut allows you to access the immense intelligence of ChatGPT and the creativity of [DALL·E][dalle] within Siri, giving you a chatbot experience like never before.

<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/f34a0375-c6e9-4b4f-906f-3eaed6ec31d4" draggable="false" ondragstart="return false;" alt="IMG show Siri conbined with ChatGPT" title="Siri conbined with ChatGPT" width="700px" /></a></p>
<br><br>

<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/bfde2412-e906-4cfd-aaaa-c547b3b7479f" draggable="false" ondragstart="return false; "alt="Siri + ChatGPT" title="Siri + ChatGPT" width="700px" />
</picture>
</p>

<br><br>

Combining ChatGPT with Siri is relatively straightforward, but it does require a few specific requirements and links to ensure everything works smoothly.
<br/><br/>
<br><br>

## Requirements to get ChatGPT to work with Siri

### Get the Shortcut

To get started, all you need is the [Apple Shortcuts app][apple-shortcuts-download]. Once you have [downloaded the shortcut][sirigpt-shortcut], look for the "Chatty" button. You can even customise the shortcut name to suit your preferences. However, once downloaded don't run it yet, keep reading.
<br/><br/>

<p align="center"><a href="https://www.icloud.com/shortcuts/fa31a1a4b9f64be3bff0940043aeb382"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/827ea7bf-1db8-4d65-a877-d2a7e60e8327" draggable="false" ondragstart="return false;" alt="Download theShortcut" title="Download Shortcut" width="600px" /></a></p><br/>
<br><br>

<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/284a8d55-a765-4ddd-a030-043a76dca6be" draggable="false" ondragstart="return false;" alt="Download Shortcut" title="Download Shortcut" width="600px" />
</picture>
</p>

<br><br>

### Create your OpenAI API Key

To use ChatGPT's services with Siri, you'll first need to obtain the API key. This can be done by generating a new secret key from your OpenAI account, which will be required for authentication. To get started, you can obtain the key by following these steps. First, log in to your [OpenAI account][open-ai-account]. Next, look for the "Create new secret key" option and click on it.

<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/7763c24a-4e19-4ac4-913d-da1f7eb29ee9" draggable="false" ondragstart="return false;" alt="IMG show how to create new secret key" title="Create new secret key" width="750px" /></a></p>
<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/85fa277a-2137-4ef6-b96f-4d7de18c316a" draggable="false" ondragstart="return false; "alt="Create new secret key" title="Create new secret key" width="750px" />
</picture>
</p>

Once you have the [API Key][open-ai-API], integrating ChatGPT's services with Siri is a breeze. It's important to note that once you copy the key and close the pop-up, you won't be able to view it again, so it's crucial to keep the key in a safe and secure location.
<br/><br/>
<br><br>

<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/af9b460c-824e-456d-ac91-a26a24f2c425" draggable="false" ondragstart="return false; "alt="OpenAI API Key" title="OpenAI API Key" width="750px" />
</picture>
</p>

<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/62ca5fce-40fd-4057-9759-d011aba93ca0" draggable="false" ondragstart="return false;" alt="IMG show an example of a OpenAI API Key" title="OpenAI API Key" width="750px" /></a></p><br/>
<br>

## How to set up and use ChatGPT with Siri

Expand All @@ -38,34 +68,60 @@ Once you have downloaded the shortcut and copied the API key, it’s time to mak
- Once you launch the Chatty shortcut, you will be prompted to set your API key. You have two options for storing your API key: within the shortcut or inside Data Jar. To clarify, if you choose "Yes" your OpenAI API key will be stored in Data Jar, which is a third-party app for storing data in iOS. If you select "No" your API key will be kept within the Siri shortcut. It's important to note that if you choose to keep your API key in the shortcut, you should take extra care to keep your shortcut secure and not share it with anyone, as this could potentially expose your API key.

- The OpenAI API is powered by a range of models that have different capabilities and pricing plans to suit various use cases. These models include GPT-3, GPT-4. The default model used by SiriGPT is GPT-3.5-turbo. However, users are free to choose the model version they want to use based on their specific needs and requirements. Keep in mind GPT-4 is currently in a limited beta and only accessible to those who have been granted access.
<br/><br/>

<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/cd0942d0-b2ba-48bd-a908-757b4a785c68" draggable="false" ondragstart="return false;" alt="IMG show where paste your OpenAI API key" title="Paste your OpenAI API key here" width="600px" /></a></p><br/><br/>
<br>

<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/da6f04eb-d298-4941-88ae-afd7066ab299" draggable="false" ondragstart="return false;" alt="Paste your API keys" title="Paste your API keys" width="600px" />
</picture>
</p>

<br>

All done! Once the integration is complete, you can launch the shortcut by tapping it within the app or from the menu bar on your Mac. Alternatively, when ready to use the shortcut, simply activate Siri and say "Chatty" followed by your question or prompt. The shortcut will then generate a response and read it back to you.
<br/><br/><br/>

<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/7989a213-f8ac-4a0c-b267-46ca72c771a5" draggable="false" ondragstart="return false;" alt="SiriGPT launched" title="SiriGPT launched" width="900px" /></a></p>
<br><br>

<br/>
<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/b825d5d1-a952-4c9b-a680-ff7950654a83" draggable="false" ondragstart="return false;" alt="SiriGPT launched" title="SiriGPT launched" width="900px" />
</picture>
</p>

<br><br>

### Considerations

ChatGPT is one of the most advanced chatbots available today, with the ability to generate human-like responses to a wide range of questions and inputs. However, like any technology, it has limitations and requires specific usage patterns to produce the desired output. If you have not found SiriGPT useful, it may be because you are not providing it with specific enough input. The key to obtaining precise and accurate responses from SiriGPT is to be as specific as possible about the desired output. A vague input will likely produce a vague answer, while a well-defined input will yield a more targeted and useful response.

In summary, to make the most of SiriGPT, it is essential to be specific about the desired output and provide clear instructions on what to avoid. With these guidelines in mind, you can unlock the full potential of this powerful chatbot and streamline your daily tasks.
<br/><br/>

<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/af51ec37-a7e8-4162-9ddc-f2b4c2eb97ca" draggable="false" ondragstart="return false;" alt="Example SiriGPT Output" title="Example SiriGPT Output" width="1000x" /></a></p>
<br><br>

<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/89f7d87a-91f0-41d4-82df-0a320c0f9b63" draggable="false" ondragstart="return false;" alt="SiriGPT Output" title="WSiriGPT Output" width="1000px" />
</picture>
</p>

<br/>
<br><br>

[ChatGPT][chaGPT] and [DALL·E][dalle] are two of the most powerful AI tools developed in recent years. They have the potential to revolutionise the way we interact with our devices and make our lives easier. However, it's important to remember that they have their limitations, and may not always be able to deliver the desired output due to external factors such as server overload or lack of data. In conclusion, SiriGPT is a powerful tool that has the potential to revolutionise the way we interact with our devices. By being clear and specific in our requests, we can help these tools deliver more accurate and relevant responses.

<br/>
<br>

## What's new in SiriGPT

### v1.3.5

Release Highlights:

- Improved the prompt to give a better output.
- Improved the call-out for upcoming calendar events and reminders. Typing the phrase "check my schedule" or its equivalent in supported languages (such as überprüfen sie meinen zeitplan, consultar mi horario, consulter mon emploi du temps, controlla i miei impegni, スケジュールを確認する, 내 일정 확인, confira minha agenda, verificar o meu horário, Проверить мое расписание, تحقق من جدولي الزمني, 查看我的日程安排) will give a summary of upcoming calendar events and reminders. Please note that this feature is still in beta.

<br>

### v1.3

Release Highlights:
Expand All @@ -76,34 +132,39 @@ Release Highlights:
- Added URL summary to generate instant overviews of website articles when pasting a URL.
- Introduced the DAN Mode (Do Anything Now). When enabled, SiriGPT will act as an alter ego of itself.

<br/>
<br>

### v1.2

Release Highlights:

- Added support for continuous chatting.
- Users can easily continue their conversation without any interruption.
- Users can start a new conversation and exit chatting whenever required.
To start a new chat, simply say "New chat" during the conversation, and Siri will initiate a fresh round of chat. It's important to note that you won't be able to continue the previous conversation with the same information. If you wish to exit SiriGPT, you can say "Goodbye". Alternatively, you can close SiriGPT directly and reopen it, but it's more natural to use the provided command to exit.
- Users can initiate a new conversation and exit SiriGPT at any time.
- To start a fresh chat, say "New chat" or its respective phrase in a supported language. Keep in mind that you won't be able to continue the previous conversation with the same information. To exit SiriGPT, say "Goodbye" or its equivalent in a supported language. You can also close SiriGPT directly but it's more natural to use the provided command.
- Integration with DALL·E to generate an image.
- Users can generate an image by including the word "image" in their prompt.
- Users can generate an image by including the word "image" or its equivalent in supported languages in their prompt.
- Multi-language start prompt.
- The prompt language will automatically change based on the language set in the user's device. Users can choose from a variety of languages including English, Deutsch, Español, Français, Italiano, 日本, 한국인, Português, Русский, عربي, 中国人. This ensures that the user receives prompts in a language they are comfortable with and can easily understand.
- Customisable API key storage location.
- Prompt system messages can be customised to user preference.
- The hint message can be tailored to the user's preferences. These prompts are created to suit various situations and contexts, including general AI, accountant, AI-assisted doctor, career counsellor, editor, essay writer, interviewer, mental health advisor, motivational coach, personal trainer, and social media manager.

<br/>
<br>

## SiriGPT Privacy

Privacy is a user's right, which is why SiriGPT allows you to choose what personal data to share during setup. SiriGPT 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 API is required for SiriGPT to function. If you don't want to share information with a third-party service, you won't be able to use SiriGPT. If you choose to give SiriGPT a try, make sure to read through [OpenAI][openai-privacy]'s Privacy Policies beforehand.
<br/><br/><br/>

<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/a59fb2fb-d306-41e0-bc1c-e2cd309799dc" draggable="false" ondragstart="return false;" alt="Shortcut Privacy" title="Shortcut Privacy" width="900px" /></a></p>
<br><br>

<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/4b395ded-178b-43ca-b0ab-e3dc79b2b23e" draggable="false" ondragstart="return false;" alt="Shortcut Privacy" title="Shortcut Privacy" width="900px" />
</picture>
</p>

<br/>
<br><br>

## Notes

Expand All @@ -126,9 +187,13 @@ Try these steps to troubleshoot the issue:
3. Reset Siri to recognise your voice
4. Check the microphone functions correctly

If after these steps the problem persists, another solution is deleting Siri & Dictionary History from the Settings menu. Go to Settings <a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/6256c23b-689b-4ee9-8986-f8399fde573f" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /></a> Siri & Search <a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/6256c23b-689b-4ee9-8986-f8399fde573f" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /></a> Siri & Dictionary History <a href="#"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/6256c23b-689b-4ee9-8986-f8399fde573f" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /></a> Delete Siri & Dictionary History.
If after these steps the problem persists, another solution is deleting Siri & Dictionary History from the Settings menu. Go to Settings <img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/6256c23b-689b-4ee9-8986-f8399fde573f" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /> Siri & Search <img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/6256c23b-689b-4ee9-8986-f8399fde573f" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /> Siri & Dictionary History <img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/6256c23b-689b-4ee9-8986-f8399fde573f" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /> Delete Siri & Dictionary History.

#### 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".

<br/>
<br>

### Resources

Expand All @@ -151,21 +216,34 @@ If after these steps the problem persists, another solution is deleting Siri & D

### Contribution

Thank you for taking the time to consider using this shortcut. If you would like to contribute to improving SiriGPT's integration with the Apple ecosystem, your feedback would be appreciated to make this shortcut even better. If you encounter any issues or bugs, please report them on the [issues page][issues].<br/><br/>
Thank you for taking the time to consider using this shortcut. If you would like to contribute to improving SiriGPT's integration with the Apple ecosystem, your feedback would be appreciated to make this shortcut even better. If you encounter any issues or bugs, please report them on the [issues page][issues].

<p align="center"><a href="#"><img src="https://user-images.githubusercontent.com/48920263/113406768-5a164900-93ac-11eb-94a7-09377a52bf53.png" draggable="false" ondragstart="return false;" /></a></p>
<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/5dc77e2d-8ee2-475e-968b-554664a02b42" draggable="false" ondragstart="return false;" /></>
</picture>
</p>

<p align="center"><a href="https://github.com/nicolodiamante" target="_blank"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/16a90fa7-c0b4-4689-a3ce-af905c390684" draggable="false" ondragstart="return false;" alt="Nicol&#242; Diamante Portfolio" title="Nicol&#242; Diamante" width="11px" /></a></p>
<p align="center">
<picture>
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/6d27be79-b840-49a0-8dc3-da626333f6f2" draggable="false" ondragstart="return false;" alt="Nicol&#242; Diamante" title="Nicol&#242; Diamante" width="17px" />
</picture>
</p>

<p align="center"><a href="https://github.com/nicolodiamante/SiriGPT/blob/main/LICENSE.md" target="_blank"><img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/fa42b331-be41-437c-b32d-894c759d4457" draggable="false" ondragstart="return false;" alt="The MIT License" title="The MIT License (MIT)" width="90px" /></a></p>
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/nicolodiamante/SiriGPT/assets/48920263/22b8f78c-ca08-45b0-b2e0-a431344ada13" draggable="false" ondragstart="return false;" alt="MIT License" title="MIT License" />
<img src="https://github.com/nicolodiamante/SiriGPT/assets/48920263/4017f8a9-753e-42ab-a950-829aca8b01f6" draggable="false" ondragstart="return false; "alt="MIT License" title="MIT License" width="95px" />
</picture>
</p>

<!-- Link labels: -->
[open-ai-account]: https://chat.openai.com/auth/login
[open-ai-API]: https://beta.openai.com/account/api-keys
[open-ai-models]: https://platform.openai.com/docs/models
[apple-shortcuts-guide]: https://support.apple.com/en-gb/guide/shortcuts/apd58d46713f/ios
[apple-shortcuts-download]: https://apps.apple.com/us/app/shortcuts/id915249334
[sirigpt-shortcut]: https://www.icloud.com/shortcuts/fa31a1a4b9f64be3bff0940043aeb382
[sirigpt-shortcut]: https://www.icloud.com/shortcuts/ec2a9c0084234df7b30099e3b322c43b
[gpt-4-wwaitlist]: https://openai.com/waitlist/gpt-4-api
[openai-privacy]: https://openai.com/policies/privacy-policy
[apple-siri]: https://www.apple.com/siri/
Expand Down

0 comments on commit be807f4

Please sign in to comment.