├── .gitignore
├── LICENSE.md
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | #
2 | # Ignore
3 | #
4 | 
5 | *.swp
6 | .DS_Store
7 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | &#169; 2024 Nicolò Diamante <hello@nicolodiamante.com>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 9 | of the Software, and to permit persons to whom the Software is furnished to do
10 | so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <picture>
  3 |     <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/997fc251-784f-4d84-bb99-87b2ccab8c11" draggable="false" ondragstart="return false;" alt="Notefy" title="Notefy" />
  4 |     <img src="https://github.com/user-attachments/assets/2be5555f-9f02-4982-aeca-4a0053c64665" draggable="false" ondragstart="return false; "alt="Notefy" title="Notefy" />
  5 |   </picture>
  6 | </p>
  7 | 
  8 | In an era where information overflows yet time remains scarce, Notefy aims to be an essential tool for efficient data management and processing. This shortcut integrates the intelligent conversation handling of [ChatGPT][chaGPT] with the precise audio transcription capabilities of [Whisper][whisper]. Notefy offers a new way to keep track of and process information amidst the deluge of meetings, lectures, and daily conversations. It skillfully converts spoken and written words into concise, organised summaries, transcending traditional note-taking methods. Notefy represents a transformative approach to processing and retaining information, serving a diverse range of users from professionals to students.
  9 | 
 10 | <br><br>
 11 | 
 12 | <p align="center">
 13 |   <picture>
 14 |     <img src="https://github.com/user-attachments/assets/43509fbb-ebde-47b8-9674-1e7dc9fbe1df" draggable="false" ondragstart="return false; "alt="Siri + ChatGPT" title="Siri + ChatGPT" width="700px" />
 15 |   </picture>
 16 | </p>
 17 | 
 18 | <br><br>
 19 | 
 20 | Integrating Notefy with Siri is a straightforward process, but it does require meeting specific prerequisites and establishing certain links to ensure smooth functionality.
 21 | <br><br>
 22 | 
 23 | ## Requirements to get Notefy to work
 24 | 
 25 | ### Get the Shortcut
 26 | 
 27 | To start, ensure you have the [Apple Shortcuts][apple-shortcuts-download] app installed. Next, download the [Notefy Shortcut][notefy-shortcut]. You're welcome to rename the shortcut to a title that suits you. Before you begin using it, though, make sure you continue reading.
 28 | 
 29 | <br><br>
 30 | 
 31 | <p align="center">
 32 |   <a href="https://www.icloud.com/shortcuts/219e814900024849845fd0f7e8d36592" target="_blank">
 33 |     <picture>
 34 |       <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/238bbb4c-2b15-42fc-aead-c556f714bd1b" draggable="false" ondragstart="return false;" alt="Download the Shortcut" title="Download Notefy" />
 35 |       <img src="https://github.com/user-attachments/assets/b7d36c95-3974-46e5-b9c0-68730818c908" draggable="false" ondragstart="return false; "alt="Download the Shortcut" title="Download Notefy" width="600" />
 36 |     </picture>
 37 |   </a>
 38 | </p>
 39 | 
 40 | <br>
 41 | 
 42 | > Please make sure to complete the following tasks when transitioning to the new version: Decode the API keys that were previously stored in an encrypted format in the Data Jar. To simplify this process, use the [DecodeMe][decode-key-shortcut] shortcut. Remember to complete this for each key of OpenAI's and ElevenLabs.
 43 | 
 44 | <br><br>
 45 | 
 46 | ### Create your OpenAI API Key
 47 | 
 48 | To utilise ChatGPT's services with Siri, it is essential to obtain an OpenAI API key. To acquire this key, you need to generate a new secret key from your existing OpenAI account. If you don't have an OpenAI account yet, you can easily sign up for one by visiting the OpenAI signup page [here][openai-signup]. This secret key plays a crucial role in verifying your authentication. Here are the steps on how to do it:
 49 | 
 50 | - Log in to your [OpenAI account][openai-account].
 51 | - Search for the ‘Create new secret key’ option and click on it.
 52 | 
 53 | <p align="center">
 54 |   <picture>
 55 |     <img src="https://github.com/user-attachments/assets/fbc4f2f3-add8-4a8a-9dd4-3cd98c1d8114" draggable="false" ondragstart="return false; "alt="Create new secret key" title="Create new secret key" width="750px" />
 56 |   </picture>
 57 | </p>
 58 | 
 59 | Once you obtain the [API Key][openai-API], incorporating ChatGPT's services with Siri is straightforward. It's important to remember, that after making a copy of the key and closing the pop-up, you won't have access to it again. Therefore, store the key securely in a safe location.
 60 | <br><br>
 61 | 
 62 | <p align="center">
 63 |   <picture>
 64 |     <img src="https://github.com/user-attachments/assets/09f6806f-91ba-4fd2-aca7-3e36204b8697" draggable="false" ondragstart="return false; "alt="OpenAI API Key" title="OpenAI API Key" width="750px" />
 65 |   </picture>
 66 | </p>
 67 | 
 68 | <br>
 69 | 
 70 | ## Setting Up the Shortcut
 71 | 
 72 | After downloading the shortcut and copying your API key, follow these steps to put it to use:
 73 | 
 74 | - Begin by opening the Shortcuts app and finding the downloaded Notefy shortcut.
 75 | 
 76 | - Next, proceed with the configuration process. Carefully follow each step to tailor the shortcut according to your unique preferences. After completing these steps, the shortcut will be ready for immediate use.
 77 | 
 78 | > Note on API Key Storage Options: You have the flexibility to store your OpenAI API key in two ways. Firstly, you can directly embed it within the Notefy shortcut for convenience. Alternatively, you may opt to use the Data Jar app to store the API key. If you decide on the latter, ensure that you have the Data Jar app installed. If not, or if you prefer a simpler approach, storing the API key directly in the shortcut remains a viable option.
 79 | 
 80 | <br>
 81 | 
 82 | <p align="center">
 83 |   <picture>
 84 |     <img src="https://github.com/user-attachments/assets/3207d92d-5315-4745-8785-ee6c6ce2d3cc" draggable="false" ondragstart="return false;" alt="Paste your API keys" title="Paste your API keys" width="600px" />
 85 |   </picture>
 86 | </p>
 87 | 
 88 | <br>
 89 | 
 90 | Once the setup is complete, you're all set! The shortcut is designed to be straightforward and user-friendly.
 91 | 
 92 | <br><br>
 93 | 
 94 | ## Using Notefy
 95 | 
 96 | Notefy offers multiple convenient activation methods:
 97 | 
 98 | - Activate with Siri: Begin by saying ‘Hey Siri’ followed by ‘Notefy’ to start the shortcut and it will begin listening straight away. Once you're done, tap the screen to indicate you've finished. The shortcut will then process the recorded audio and generate a concise summary.
 99 | 
100 | <br>
101 | 
102 | <p align="center">
103 |   <picture>
104 |     <img src="https://github.com/user-attachments/assets/fe4f4299-aae1-4b9b-b8d2-04efe1f46e07" draggable="false" ondragstart="return false;" alt="Notefy Output" title="Notefy Output" width="1000px" />
105 |   </picture>
106 | </p>
107 | 
108 | <br>
109 | 
110 | - Summarise Text and Audio: Instantly understand the core of any text or audio content. Just send it to Notefy. The app promptly analyses and condenses the material into a brief, coherent summary. Whether it's a Safari text, a note, or a lengthy audio message from WhatsApp, Notefy seamlessly transforms any text or audio into a concise summary.
111 | 
112 |   Notes:
113 | 
114 |   - Click the Share icon (in the right top corner). &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/4b0f8126-fce0-4fcc-88d5-f24b392cf7e6" draggable="false" ondragstart="return false;" alt="Share Icon" title="Share Icon" width="18px" />
115 |   - Select ‘Send a Copy’. &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/5d185726-4636-43e6-9580-e2096f826d15" draggable="false" ondragstart="return false;" alt="Send a Copy Icon" title="Send a Copy Icon" width="14px" />
116 |   - Scroll down and select Noefy. &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/dbc8a4b4-a974-4489-9680-2f2ad82ae32e" draggable="false" ondragstart="return false;" alt="Notefy Icon" title="Notefy Icon" width="16px" />
117 | 
118 |   Safari:
119 | 
120 |   - Click the Share icon (in the bottom). &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/5d185726-4636-43e6-9580-e2096f826d15" draggable="false" ondragstart="return false;" alt="Share Icon" title="Share Icon" width="14px" />
121 |   - Scroll down and select Noefy. &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/dbc8a4b4-a974-4489-9680-2f2ad82ae32e" draggable="false" ondragstart="return false;" alt="Notefy Icon" title="Notefy Icon" width="16px" />
122 | 
123 |   WhatsApp:
124 | 
125 |   - Hover over the audio message you wish to summarise.
126 |   - Click ‘Forward’ in the appearing menu. &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/ca754e6f-317e-49a8-b0c8-25f843776f71" draggable="false" ondragstart="return false;" alt="Forward Icon" title="Forward Icon" width="19px" />
127 |   - Choose the individual chat you want to summarise. &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/2aba602c-3d1d-416e-bbb2-be3d04cccfb5" draggable="false" ondragstart="return false;" alt="Done Icon" title="Done Icon" width="18px" />
128 |   - Click the Share icon (in the right bottom corner). &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/5d185726-4636-43e6-9580-e2096f826d15" draggable="false" ondragstart="return false;" alt="Share Icon" title="Share Icon" width="14px" />
129 |   - Select Notefy. &nbsp;&nbsp;<img src="https://github.com/user-attachments/assets/dbc8a4b4-a974-4489-9680-2f2ad82ae32e" draggable="false" ondragstart="return false;" alt="Notefy Icon" title="Notefy Icon" width="16px" />
130 | 
131 | - Mac Integration: Notefy integrates smoothly with the Mac workflow. Whether the text is in Notes or online, just highlight it and access Notefy via the Services menu with a right-click. This allows for the rapid conversion of lengthy texts into summaries.
132 | 
133 | <br><br><br>
134 | 
135 | <p align="center">
136 |   <picture>
137 |     <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/9bb8c414-0007-4b0f-bf21-66620ce25ced" draggable="false" ondragstart="return false;" alt="Quick Actions Menu" title="Quick Actions Menu" />
138 |     <img src="https://github.com/user-attachments/assets/1c391377-d324-4565-b7c9-ed9772339839" draggable="false" ondragstart="return false; "alt="Quick Actions Menu" title="Quick Actions Menu" width="600px" />
139 |   </picture>
140 | </p>
141 | 
142 | <br><br><br>
143 | 
144 | Notefy streamlines summarising, transforming it into a straightforward and enjoyable activity. Crafted as a shortcut for efficiency, it guarantees reliability and simplicity in use. Ideal for busy schedules or focused work sessions.
145 | 
146 | <br><br>
147 | 
148 | ## What's new in Notefy
149 | 
150 | ### v1.1.3
151 | 
152 | Release Highlights:
153 | 
154 | - New Model Introduction: GPT-4o mini (‘o’ for ‘omni’): The most advanced and affordable model in the small models category. It boasts higher intelligence than gpt-3.5-turbo while maintaining the same speed. GPT-4o mini is designed for smaller tasks. It is recommended to choose GPT-4o mini where gpt-3.5-turbo would have been used previously, as this model is more capable and economical.
155 | 
156 | <br>
157 | 
158 | ### v1.1.2
159 | 
160 | Release Highlights:
161 | 
162 | - API Key Storage Enhancement: To resolve issues with script readability, API keys will no longer be encrypted in Data Jar. Previously, encryption caused errors that prevented the Shortcut from reading the API key. Storing keys unencrypted will ensure seamless script functionality.
163 | 
164 | <br>
165 | 
166 | ### v1.1.1
167 | 
168 | Release Highlights:
169 | 
170 | - New Model Integration: This update simplifies the model options from 4 to 3. Users now have three distinct models to choose from: ChatGPT-3.5-Turbo, which now points to ChatGPT-3.5-Turbo-0125; ChatGPT-4 has been upgraded to ChatGPT-4-Turbo; and the newly introduced ChatGPT-4o is now available. This adjustment aims to simplify model selection while maintaining advanced capabilities.
171 | 
172 | <br>
173 | 
174 | ## Notefy Privacy
175 | 
176 | As a shortcut within the Apple ecosystem, Notefy automatically enjoys certain built-in security features. This inherent protection extends to its interactions with external service providers. However, it's important to note that the full functionality of this shortcut depends on the OpenAI API. This means that if you have reservations about sharing your data with third-party services, Notefy might not be the ideal choice for you. For those considering using Notefy, it's recommend reviewing the [OpenAI Privacy Policy][openai-privacy] to make an informed decision.
177 | 
178 | <br><br>
179 | 
180 | <p align="center">
181 |   <picture>
182 |     <img src="https://github.com/user-attachments/assets/b6ee1daa-4815-4bc4-abf4-ee2ff6164e9b" draggable="false" ondragstart="return false;" alt="Shortcut Privacy" title="Shortcut Privacy" width="900px" />
183 |   </picture>
184 | </p>
185 | 
186 | <br><br>
187 | 
188 | ## Notes
189 | 
190 | ### Creating Folders: Step-by-Step Guide
191 | 
192 | On iPhone & iPad:
193 | 
194 | - Access Folders List: If you're currently viewing the Notes list, begin by tapping the back arrow icon &nbsp;<img src="https://github.com/user-attachments/assets/376c0372-fbc4-433c-835c-52a20b85df11" draggable="false" ondragstart="return false;" alt="Back Arrow Icon" title="Back Arrow Icon" width="9px" />&nbsp; to return to the previous screen. This action will bring you to your Folders list.
195 | 
196 | - New Folder Creation: Once you're in the Folders list, look for the New Folder button &nbsp;<img src="https://github.com/user-attachments/assets/06792649-1c65-42c4-8ac6-ca500d0b4f53" draggable="false" ondragstart="return false;" alt="New Folder Icon" title="New Folder Icon" width="24px" />&nbsp; and tap on it to start creating a new folder.
197 | 
198 | - Naming and Saving: Give your new folder a name. After naming it, tap the 'Save' button to finalise the creation of your folder.
199 | 
200 | - Select Folder Location: Decide where you want to place your new folder. If you aim to create a subfolder within an existing main folder, simply drag the new folder towards the main folder. It will automatically position itself beneath the main folder and will be slightly indented to the right, indicating its status as a subfolder.
201 | 
202 | On Mac:
203 | 
204 | - Select an Existing Folder: Firstly, locate and select one of the existing folders on your Mac. Upon selection, you'll notice an icon with three dots &nbsp;<img src="https://github.com/user-attachments/assets/4b0f8126-fce0-4fcc-88d5-f24b392cf7e6" draggable="false" ondragstart="return false;" alt="Share Icon" title="Share Icon" width="18px" />&nbsp; appearing on the right side of the folder.
205 | 
206 | - New Folder Creation: Click on the three-dot icon &nbsp;<img src="https://github.com/user-attachments/assets/4b0f8126-fce0-4fcc-88d5-f24b392cf7e6" draggable="false" ondragstart="return false;" alt="Share Icon" title="Share Icon" width="18px" />&nbsp;. A menu will appear. From this menu, select ‘New Folder’. This action will create a new folder in the current location.
207 | 
208 | - Prepare to Rename the New Folder: Now, select the newly created folder. After selecting it, click on the three-dot icon &nbsp;<img src="https://github.com/user-attachments/assets/4b0f8126-fce0-4fcc-88d5-f24b392cf7e6" draggable="false" ondragstart="return false;" alt="Share Icon" title="Share Icon" width="18px" />&nbsp; again to access additional options.
209 | 
210 | - Rename Your Folder: In the options menu, choose the ‘Rename’ function. You can then type in the desired name for your folder. Once you've entered the new name, confirm your choice to complete the renaming process.
211 | 
212 | By following these steps, you can efficiently organise your notes and documents into new folders and subfolders, enhancing your overall productivity and ease of access.
213 | 
214 | <br>
215 | 
216 | ### Resources
217 | 
218 | #### Apple
219 | 
220 | - [Apple Notes][apple-notes-app]
221 | - [Apple Siri][apple-siri]
222 | - [Apple Shortcuts User Guide][apple-shortcuts-guide]
223 | 
224 | #### OpenAI
225 | 
226 | - [OpenAI Documentation][intro]
227 | - [OpenAI Examples][examples]
228 | - [OpenAI Playground][playground]
229 | - [OpenAI Models][openai-models]
230 | - [OpenAI Chat Completions][chat-completions]
231 | - [OpenAI Whisper][whisper]
232 | 
233 | #### Data Jar
234 | 
235 | - [Data Jar][data-jar]
236 | 
237 | ### Contribution
238 | 
239 | Thank you for your interest in this shortcut. Your feedback would be much appreciated. If you encounter any issues or bugs, please feel free to report them on the [issues page][issues].
240 | 
241 | <br><br>
242 | 
243 | <p align="center">
244 |   <picture>
245 |     <img src="https://github.com/user-attachments/assets/e388e417-b074-4238-a711-a73c9351269e" draggable="false" ondragstart="return false;" /></>
246 |   </picture>
247 | </p>
248 | 
249 | <p align="center">
250 |   <a href="https://nicolodiamante.com" target="_blank">
251 |     <img src="https://github.com/user-attachments/assets/ac8d0101-c428-4fd8-979c-77af1c0371da" draggable="false" ondragstart="return false;" alt="Nicol&#242; Diamante Portfolio" title="Nicol&#242; Diamante" width="17px" />
252 |   </a>
253 | </p>
254 | 
255 | <p align="center">
256 |   <picture>
257 |     <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/484d1cd0-f5c7-49c0-9736-33bb34667d99" draggable="false" ondragstart="return false;" alt="MIT License" title="MIT License" />
258 |     <img src="https://github.com/user-attachments/assets/af1ec5bb-87ec-4c1e-9e97-c01e419dc6aa" draggable="false" ondragstart="return false; "alt="MIT License" title="MIT License" width="95px" />
259 |   </picture>
260 | </p>
261 | 
262 | <!-- Link labels: -->
263 | 
264 | [openai-account]: https://auth0.openai.com/u/login/identifier?state=hKFo2SBWNUdMbnRYYTFTeFdkNW1rUEY5cHNyUVMxdE9FdjdxYqFur3VuaXZlcnNhbC1sb2dpbqN0aWTZIDJVOVBFOWdJZkw4WEdpbmsxQ1JRRTEydWY5LXlzYUxFo2NpZNkgRFJpdnNubTJNdTQyVDNLT3BxZHR3QjNOWXZpSFl6d0Q
265 | [openai-signup]: https://auth0.openai.com/u/signup/identifier?state=hKFo2SBjY3ExRFozSEdJRVhCQ0hnYkRETjRzM3p3TlV4bjl6a6Fur3VuaXZlcnNhbC1sb2dpbqN0aWTZIFNPWE1oRVdWMm1ZZjU2Rm5UVHcybF9ya3JlU1hCaGd5o2NpZNkgRFJpdnNubTJNdTQyVDNLT3BxZHR3QjNOWXZpSFl6d0Q
266 | [openai-API]: https://beta.openai.com/account/api-keys
267 | [openai-models]: https://platform.openai.com/docs/models
268 | [apple-shortcuts-guide]: https://support.apple.com/en-gb/guide/shortcuts/apd58d46713f/ios
269 | [apple-shortcuts-download]: https://apps.apple.com/us/app/shortcuts/id915249334
270 | [apple-notes-app]: https://support.apple.com/en-us/HT205773
271 | [notefy-shortcut]: https://www.icloud.com/shortcuts/219e814900024849845fd0f7e8d36592
272 | [openai-privacy]: https://openai.com/policies/privacy-policy
273 | [apple-siri]: https://www.apple.com/siri/
274 | [chaGPT]: https://openai.com/blog/chatgpt
275 | [whisper]: https://openai.com/research/whisper
276 | [playground]: https://platform.openai.com/playground
277 | [examples]: https://platform.openai.com/examples
278 | [intro]: https://platform.openai.com/docs/introduction
279 | [chat-completions]: https://platform.openai.com/docs/guides/chat
280 | [data-jar]: https://datajar.app
281 | [decode-key-shortcut]: https://www.icloud.com/shortcuts/0ce3c6d5944a42d4951576620d75f8fe
282 | [issues]: https://github.com/nicolodiamante/notefy/issues
283 | 


--------------------------------------------------------------------------------