Skip to content

FEATURES.md

Latest commit

 

History

History
211 lines (159 loc) · 11.4 KB

FEATURES.md

File metadata and controls

211 lines (159 loc) · 11.4 KB

HeliboardL Features Guide

HeliboardL integrates with AI providers to offer advanced proofreading and translation capabilities directly within the keyboard. This guide explains how to set up the supported providers.

Index

  1. Summary of New Features - Quick overview of what's new.
  2. Supported AI Providers - Start here to choose your AI backend.
  3. Groq - Ultra-fast cloud inference.
  4. Google Gemini - Reliable general-purpose AI.
  5. HF/OpenAI-compatible - Use Mistral, DeepSeek, OpenRouter, or HuggingFace.
  6. Custom AI Keys & Keywords - New! Configure custom prompts and personas.
  7. Offline Proofreading - Privacy-first, on-device AI.

Summary of New Features

Feature Function Settings Location
Multi-Provider AI Uses Gemini, Groq, or OpenAI to proofread/rewrite text. AI Integration > Set AI Provider
Offline Proofreading Private, on-device AI for grammar (requires downloads). AI Integration > Offline Proofreading
Custom AI Keys 10 toolbar keys with customizable prompts (supports hashtags). AI Integration > Custom Keys
AI Translation Translates selected text via your configured AI provider. Toolbar > Translate Icon
Touchpad Mode Swipe up on Spacebar to control cursor like a touchpad. Gesture typing > Vertical spacebar swipe
Split Suggestions Separates suggestions from toolbar for quicker access. Appearance > Split toolbar & suggestions
Build Variants Choose Standard, Offline, or Offline Lite versions. GitHub Releases
Clear Incognito Shows a clear "Hat & Glasses" icon when Incognito is active. Automatic (when Incognito)
Clipboard Search Search through your clipboard history directly. Clipboard Toolbar > Search Icon
Dictionary Import Import personal words from Google Gboard/other keyboards. Text correction > Dictionary > Import
Force Auto-Caps Toggle to ensure automatic capitalization works reliably. Text correction > Auto-capitalization

Supported AI Providers

Provider Privacy Setup Free Tier Best For
Groq 🟡 Average 🟢 Easy High Speed
Google Gemini 🔴 Low 🟢 Easy Generous General Purpose
HF/OpenAI-compatible ⚙️ Varies 🟡 Medium Varies Fully Customizable
Offline (ONNX) 🟢 Best 🟡 Medium ∞ Unlimited Privacy

Tip

The HF/OpenAI-compatible option is fully customizable—you can change the API endpoint, token, and model to use any OpenAI-compatible service (OpenRouter, Mistral, DeepSeek, HuggingFace, etc.).

Privacy Links:

Important

Sensitive Data: Do not process sensitive information (passwords, credit card numbers, private addresses) using the AI Proofreading or Translation features.

Offline Version Guarantee: The Offline Version physically excludes all network code at build time. It is impossible for it to connect to the internet, making it safe for all data.

1. Groq

Groq is a cloud API provider that uses custom LPUs (Language Processing Units) to deliver extremely fast inference speeds, making it feel almost instant compared to other cloud providers.

Setup

  1. Get API Key: Visit Groq Console and create a key (starts with gsk_).
  2. Configure in HeliboardL:
    • Provider: Select Groq.
    • API Token: Paste your Groq API Key.

Available Models

Model ID Context Description
llama-3.3-70b-versatile 128k Best Overall. High intelligence.
llama-3.1-8b-instant 128k Fastest. Quick grammar fixes.
meta-llama/llama-4-scout-17b-16e-instruct 128k New scout model. Good balance.
qwen/qwen3-32b 128k Good speed and logic.
groq/compound-mini 128k Optimized internal model.

2. Google Gemini

Get an API Key

  1. Go to Google AI Studio.
  2. Click Create API Key.
  3. Copy the key.

Configuration

  1. Go to Settings > AI Integration > Gemini API Key.
  2. Paste your API key.
  3. Select a model.

Available Models

Model ID Description
gemini-flash-latest Default. Fast and capable.
gemma-3-27b-it Large Gemma model. High quality.
gemma-3n-e4b-it Efficient Gemma variant (4B).
gemma-3n-e2b-it Smallest Gemma variant (2B).

3. HF/OpenAI-compatible (Generic Provider)

This provider supports any service using the standard OpenAI Chat Completion API format.

A. HuggingFace Inference API

Setup

  1. Get Token: Go to HuggingFace Settings and create a 'Read' token.
    • Note: HuggingFace may require you to add a valid payment method to your account to "unlock" the Inference API, even for the free tier (to prevent abuse).
  2. Configure in HeliboardL:
    • Provider: Select HF/OpenAI-compatible.
    • API Token: Paste your HF Access Token.
    • API Endpoint: https://api-inference.huggingface.co/models/<USER>/<MODEL>/v1/chat/completions
    • Model Name: <USER>/<MODEL> (e.g., meta-llama/Meta-Llama-3-8B-Instruct).

B. OpenRouter / Other Providers

  1. API Endpoint: Enter the provider's completion URL.
    • OpenRouter: https://openrouter.ai/api/v1/chat/completions
    • DeepSeek: https://api.deepseek.com/chat/completions
    • Mistral: https://api.mistral.ai/v1/chat/completions
    • OpenAI: https://api.openai.com/v1/chat/completions (Default)
  2. API Token: Enter your API Key from that provider.
  3. Model Name: Enter the exact model ID from the provider's documentation (e.g., deepseek-chat, mistral-large-latest, gpt-4o-mini).

4. Custom AI Keys & Keywords

You can assign custom prompts to 10 specific keys in the toolbar. These keys can "act" differently based on the keywords (hashtags) you include in your prompt.

How to Use

  1. Go to Settings > AI Integration > Custom Keys.
  2. Tap a key (1-10) to configure it.
  3. Enter your instructions. You can use the following hashtags to control the AI's behavior and output format.

AI Persona Keywords

Add these to your prompt to enforce a specific role.

Keyword Persona / Behavior System Instruction Added
#editor Text Editor "Output ONLY the edited text. Do not add any conversational filler."
#outputonly Strict Output "Output ONLY the result. Do not add introductions or explanations."
#proofread Proofreader "Fix grammar and spelling errors. Output ONLY the fixed text."
#paraphrase Rewriter "Rewrite using different words while keeping the meaning."
#summarize Summarizer "Provide a concise summary."
#expand Writer "Expand on the text with more details."
#toneshift Tone Adjuster "Adjust the tone as requested."
#generate Content Generator "You are a creative content generator. Output ONLY content."

Input Handling Keywords

Control how the result is inserted.

Keyword Behavior Use Case
(Default) Replace: The AI output replaces the selected text or the entire text field content. Proofreading, rewriting, summarizing.
#append Append: The AI output is added to the end of the text field (or selection) instead of replacing it. Generating replies, continuing a story, adding a sign-off.

Examples

1. Standard Proofreading (Replace)

Prompt: Fix grammar #proofread Result: Replaces your text with the corrected version.

2. Generate a Reply (Append)

Prompt: Generate a polite decline to this invitation #generate #append Result: Keeps the original invitation text and adds your polite decline at the end.

3. Strict Rewriting

Prompt: Rewrite this to be more professional #editor Result: Replaces text with professional version, guaranteeing no "Here is the text:" prefixes.

4. Tone Shift

Prompt: Make this sound more enthusiastic #toneshift Result: Rewrites the text with high energy and exclamation points, keeping the core message.

Tip

Hashtags are Optional: You can write purely custom prompts (e.g., "Translate to French"). However, without a hashtag like #outputonly or #editor, the AI might act like a chatbot (e.g., responding with "Sure! Here is the translation: ..."). Using these keywords automatically injects strict system instructions to ensure you get only the result you want.

Privacy

  • Data: Text is sent directly from your device to the chosen API provider. No intermediate servers are used.

5. Offline Proofreading (Privacy Focused)

Note: This feature is only available in the "Offline" build flavor of HeliboardL.

Offline proofreading runs entirely on your device using the ONNX Runtime engine. No data leaves your device.

Note

Status: Beta / Experimental This feature is in a test phase. The engine is designed to be compatible with various T5-based ONNX models (Basic, Quantized, KV-Cache). We encourage you to experiment with different models to find the best balance of speed and accuracy for your device.

Setup Instructions

  1. Download Model Files: Download the Encoder, Decoder, and Tokenizer for your chosen model from the table below.
  2. Configure App:
    • Go to Settings > Advanced.
    • Encoder Model: Select the downloaded .onnx encoder file.
    • Decoder Model: Select the downloaded .onnx decoder file.
    • Tokenizer: Select the tokenizer.json file.
    • System Instruction: Enter the text specified in the "System Instruction" column for your model (leave empty if specified).

Recommended Models

Model & Purpose Performance / Size System Instruction Download Links (Direct)
Visheratin T5 Tiny
(Grammar Correction Only)		 ⚡ Fastest
~35 MB
Low RAM usage		 Empty
(Leave blank)		 • Encoder
• Decoder
• Tokenizer
Flan-T5 Small
(Translation & General)		 🐢 Slower
~300 MB
Higher accuracy		 Required
fix grammar:
or
translate English to Spanish: 		• Encoder
• Decoder
• Tokenizer

Note: For Flan-T5, the quantized models linked above are standard recommendations. Users have also reported success with bnb4 quantized variants if available.