Skip to main content

AI Assistant

AI Assistant is a placeholder that asks the configured AI model to generate a content based on your instructions and optional input.

Requirements​

This feature requires an active internet connection (unless you are using a local model via a Custom API) to work and a configured AI in App Settings -> AI. See AI Configuration.

Parameters​

1️⃣ Input mode (default: Selection)​

You can use an optional input passed to the AI model. This parameter defines where the input comes from:

  • Selection: Selected text
  • Clipboard: Current Clipboard content
  • TextField: Manual text input
  • SelectionAndParam: Selected text and a prompt parameter
  • ClipboardAndParam: Clipboard content and a prompt parameter
  • None: No input required

When using SelectionAndParam or ClipboardAndParam, you can use %@ in the instructions to define where the parameter will be inserted when running the snippet. This is useful when you want to combine a selected text or clipboard content as an input with a customizable prompt.

Sample prompt with a parameter: Translate to %@.

You could also set the whole instruction as %@ to provide it later.

2️⃣ AI Instructions​

Instructions for the AI model.

3️⃣ AI Model (optional)​

You can select a specific AI model to use for this placeholder. If not set, the default model from the settings will be used.

Syntax​

{@ai|Selection|Translate text to English|GPT-4o mini@}

Notes​

The prompt is created using the following template:

Input: {input}
Instructions: {instructions}

Therefore, if you want to refer to the input in the instructions, you can use input keyword. Usually, you don't need to use the input keyword, as the AI model will figure that instructions are related to the input.

Use Cases​

The number of use cases is unlimited. You can use AI Assistant to generate any text based on your instructions. It can generate, transform, or improve text.

Some ideas:

  • Fix typos
  • Fix punctuation
  • Reply this email
  • Convert text to HTML
  • Translate to English
  • Make it sound more formal
  • Convert Swift code to Kotlin
  • Extract code to function
  • Write a short summary
  • Split each sentence into a new line
  • Replace numbers with text
  • Insert emoji into text
  • Generate a random English name

Video Example​