README.md

Siri Ultra

This is a Siri Ultra that works with Apple Shortcuts removing the need for a dedicated hardware device.

How it works

The assistant is run on Cloudflare Workers and can work with any LLMs.

Siri Ultra Demo Video

Siri Ultra Vision Demo Video

Features

• Real-time dialogue 💬
• Real-time voice 🎙️
• Real-time Web Search 🔍
• Talk with pictures 🌄
• Talk with videos 📹

Usage

Method 1: Setting Up the Shortcut Directly

1. Install the Shortcut:

   • Click Siri Ultra for chat with LLMs to install.
   • Click Siri Ultra Vision for vision of LLMs to install.

2. Configure:

   • Open the Shortcut, follow prompts to input necessary variables.

Method 2: Setting Up the Self-Hosted Version

Getting Started

1. Clone the repository:

   • Clone this repository and navigate to the root directory.

2. Install dependencies:

   • Run npm install to install the necessary dependencies.

3. Authenticate with Cloudflare:

   • Run npx wrangler login to log in to your Cloudflare account.

4. Create KV namespaces:

   • Run npx wrangler kv:namespace create chats to create a KV namespace. Note down the ID.

5. Configure the project:

   • Update wrangler.toml with the namespace IDs:

      [[kv_namespaces]]
      binding = "siri_ai_chats"
      id = "<id>"

6. Set up API keys:

• Run npx wrangler secret put API_KEY to set the Groq or OpenAI API key.

• Run npx wrangler secret put SEARCH1API_KEY to set the Search1API API key.

  Note: You can only set API_KEY if you don't need search function

7. Update the LLMs Vars:

      [vars]
      API_BASE= "https://api.groq.com/openai/v1/"
      MODEL="llama3-70b-8192"
      SYSTEM_PROMPT="You are Siri Pro. Answer in 1-2 sentences. Be friendly, helpful and concise. Default to metric units when possible. Keep the conversation short and sweet. You only answer in text. Don't include links or any other extras. Don't respond with computer code, for example don't return user longitude."

Deploying the Worker

To deploy the worker, run npx wrangler deploy.

Setting Up the Shortcut

1. Install the shortcut:
   • Use Siri Ultra to install the chat shortcut.
   • Use Siri Ultra Vision to install the vision shortcut.
2. Configure the shortcut:
   • Open the shortcut and replace the URL field with your worker's URL.
   • If you didn't change the default name, the URL should be https://siri-ultra.<your-username>.workers.dev.