AI Write Supporter

Release 2.17.0+

Note: For Release 2.18.0 / 3.0.0 and above, see the new setup format: Setup for 2.18.0 / 3.0.0+.

A plugin that integrates generative AI for automated content authoring. Generate draft business content or edit text efficiently from within the editor.

Sub-pages

• Predefined Prompt Menu
• Setup for 2.18.0 / 3.0.0+
• Image Generation AI
• Node Express Server Example
• Java Spring Server Example
• Plugin API

Supported Browsers

• Microsoft Edge (latest)
• Google Chrome (latest)
• Apple Safari (latest)
• Other browsers may work but not all features are guaranteed.
• Internet Explorer is not supported.

Setup

<script src="url of aiWriteSupporter.min.js"></script>
<link rel="stylesheet" href="url of aiWriteSupporter.min.css">

UI

Toolbar

// synapeditor.config.js
'editor.toolbar': [ /* ... */ 'openAIInteraction' ]

Quick Insert

// synapeditor.config.js
'editor.quickInsert': [ /* ... */ 'openAIInteraction' ]

Configuration Keys

URL & API Key

// URL + API key (key visible in browser — unsafe)
'aiWriteSupporter.config': {
  url: 'https://api.openai.com/v1/chat/completions',
  apiKey: 'sk-abc123...456xyz'
}

// URL only (recommended — proxy through your server)
'aiWriteSupporter.config': {
  url: '/request'
}

OpenAI GPT

'aiWriteSupporter.config': {
  ai: 'gpt',
  url: 'https://api.openai.com/v1/chat/completions',
  apiKey: 'sk-abc123...456xyz'
}

NAVER HyperCLOVA X

'aiWriteSupporter.config': {
  ai: 'hcx',
  url: '/request'
}

Request Body

For GPT options see https://platform.openai.com/docs/api-reference/completions/create.

'aiWriteSupporter.config': {
  url: 'url',
  apiKey: 'apiKey',
  requestBody: {
    temperature: 2,
    presence_penalty: 2
    // ...
  }
}

HyperCLOVA X options:

Image Attachment

Available when the underlying AI is Gemini or GPT-4+ (3.0.2407+). Gemini supports up to 1 image; GPT-4+ supports up to 10.

OCR URL — "Attach Image"

When ocrUrl is set, the draft-creation menu shows an Attach Image option. The plugin OCRs the image and sends the extracted text together with the prompt.

'aiWriteSupporter.config': {
  ocrUrl: 'https://ailab.synap.co.kr/sdk',   // promotional usage
  ocrApiKey: 'issued-api-key'
}

ocrUrl not set	ocrUrl set

Custom Prompts

Add prompt menu items:

'aiWriteSupporter.config': {
  customPrompts: [
    {
      key: 'my-custom-menu1',
      type: 'prompt',         // 'prompt' | 'immediately' | 'group'
      label: { ko: '나의 커스텀 메뉴 1', en: 'My custom menu 1' },
      prompt: { ko: '바나나를 영어로', en: 'banana in english' }
    },
    {
      key: 'my-custom-menu2',
      type: 'immediately',
      label: { ko: '나의 커스텀 메뉴 2', en: 'My custom menu 2' },
      prompt: { ko: '포도를 영어로', en: 'grape in english' }
    },
    {
      key: 'my-custom-menu3',
      type: 'group',
      label: { ko: '내가 제일 자주쓰는 메뉴 모음', en: 'My most used menu' },
      items: ['englishTranslation', 'tabularFormat']
    }
  ]
}

Item keys

Category Config

Categories: favorites, draft, edit, createByReference, write.

Overriding the draft category

'aiWriteSupporter.config': {
  categoryConfig: {
    draft: ['meetingRequestEmail', 'salesEmail', 'jobAnnouncement']
  }
}

Hiding categories

// Hide edit and createByReference categories
'aiWriteSupporter.config': {
  categoryConfig: {
    edit: [],
    createByReference: []
  }
}

Adding custom menus to favorites

'aiWriteSupporter.config': {
  categoryConfig: {
    favorites: ['my-custom-menu1', 'my-custom-menu2', 'my-custom-menu3']
  },
  customPrompts: [ /* ... see Custom Prompts above ... */ ]
}