Apple Intelligence Actions

Future release

The output of Apple Intelligence actions may be unpredictable. Ensure any hard-coded prompts are not overly complex and iteratively test that their output is relatively consistent with what you expect.

Table of contents

1. Image Playground
   1. Create Image using Image Playground
2. Language Models
   1. Ask Chat GPT
   2. Ask LLM
   3. Ask On-Device LLM
   4. Ask Private Cloud Compute LLM
3. Writing Tools
   1. Adjust Text Tone
   2. Make List From Text
   3. Make Table From Text
   4. Proofread Text
   5. Rewrite Text
   6. Summarize Text
   7. Summarize Text Key Points

---

To use actions in this category, use this include statement:

#include 'actions/intelligence'

These actions are currently not in the main source as they require beta software. As the release draws near, they may be merged early. To try these actions now, pull the apple-intelligence-actions branch.

Image Playground

Create Image using Image Playground

Generate an Image with a prompt using the Image Playground app.

enum imagePlaygroundStyle {
    'animation',
    'illustration',
    'sketch',
    'chatgpt',
    'chatgpt_oil_painting',
    'chatgpt_watercolor',
    'chatgpt_vector',
    'chatgpt_anime',
    'chatgpt_print',
}

enum saveToPlaygroundBehavior {
    'always',
    'askWhenRun',
    'never',
}

generateImage(text prompt, variable ?image, imagePlaygroundStyle ?style = "animation", saveToPlaygroundBehavior ?saveToPlayground = "always")

Language Models

Ask Chat GPT

Ask Chat GPT using a prompt. Follow up will open a follow-up prompt to the model.

enum generativeResultType {
    'Text',
    'Number',
    'Date',
    'Boolean',
    'List',
    'Dictionary',
}

askChatGPT(text prompt, bool ?followUp = false, generativeResultType ?resultType = "Automatic")

---

Ask LLM

Ask a specific LLM using a prompt. Follow up will open a follow-up prompt to the model.

enum LLMModel {
    'Private Cloud Compute',
    'Apple Intelligence on Device',
    'ChatGPT',
}

enum generativeResultType {
    'Text',
    'Number',
    'Date',
    'Boolean',
    'List',
    'Dictionary',
}

askLLM(text prompt, LLMModel ?model = "Private Cloud Compute", bool ?followUp = false, generativeResultType ?resultType = "Automatic")

---

Ask On-Device LLM

Ask an On-Device LLM using a prompt. Follow up will open a follow-up prompt to the model.

enum generativeResultType {
    'Text',
    'Number',
    'Date',
    'Boolean',
    'List',
    'Dictionary',
}

askDeviceLLM(text prompt, bool ?followUp = false, generativeResultType ?resultType = "Automatic")

---

Ask Private Cloud Compute LLM

Ask a private cloud compute LLM using a prompt. Follow up will open a follow-up prompt to the model.

enum generativeResultType {
    'Text',
    'Number',
    'Date',
    'Boolean',
    'List',
    'Dictionary',
}

askCloudLLM(text prompt, bool ?followUp = false, generativeResultType ?resultType = "Automatic")

Writing Tools

Adjust Text Tone

Adjust the tone of the text using Apple Intelligence Writing Tools.

enum textTone {
    'friendly',
    'professional',
    'concise',
}

adjustTextTone(text text, textTone tone): text

---

Make List From Text

Generate list from text using Apple Intelligence Writing Tools.

generateList(text text): text

---

Make Table From Text

Generate table from text using Apple Intelligence Writing Tools.

generateTable(text text): text

---

Proofread Text

Generate a proofread version of text using Apple Intelligence Writing Tools.

generateProofread(text text): text

---

Rewrite Text

Generate a rewritten version of text using Apple Intelligence Writing Tools.

generateRewrite(text text): text

---

Summarize Text

Generate a summarized version of text using Apple Intelligence Writing Tools.

generateSummary(text text): text

---

Summarize Text Key Points

Generate a summary of key points of text using Apple Intelligence Writing Tools.

generateKeyPoints(text text): text