Page History

...

사용자 정의 프롬프트 메뉴를 추가합니다.
key, type, label, prompt 키를 가지는 객체의 배열을 설정합니다.

{ key: 'customPromptKey', type: 'prompt', // 또는

Key Type 필수 기본값 설명

url

string

O

''

요청을 보낼 URL을 설정합니다.
- OpenAI의 API 주소
- OpenAI의 API로 요청을 하도록 구현한 URL
- HyperCLOVA X API 주소
  Status
  colour Yellow
  title 릴리즈 2.18.0 이상
  HyperCLOVA X로 요청을 하도록 구현한 URL
  Status
  colour Yellow
  title 릴리즈 2.18.0 이상
설정이 되지 않으면 툴바에 플러그인 버튼이 표시되지 않습니다.

apiKey

string

''

OpenAI에서 발급받은 API Key를 설정합니다.
- https://platform.openai.com/account/api-keys
해당 설정을 사용하게 되면 브라우저에 Key 값이 노출되기 때문에, Key 값을 설정하지 않고 서버를 통해 요청을 할 수 있도록 하는 것이 안전합니다.

ai

string

'gpt'

Status

colour	Yellow
title	릴리즈 2.18.0 이상

사용할 AI를 설정합니다. 기본값은 'gpt'입니다.
- OpenAI GPT: 'gpt'
- NAVER HyperCLOVA X: 'hcx'

tokenUrlrequestBody

stringObject

''

Status

colour	Yellow
title	릴리즈 2.18.0 이상

토큰 발급 요청을 보낼 URL을 설정합니다.
HyperCLOVA 요청을 보낼 때 필요하며, GPT의 apiKey에 해당하는 설정입니다.
해당 설정을 사용할 경우 반드시 tokenUrl, clientID, clientSecret이 함께 설정되어야 합니다.
해당 설정을 사용하게 되면 브라우저에 Key 값이 노출되기 때문에, Key 값을 설정하지 않고 서버를 통해 요청을 할 수 있도록 하는 것이 안전합니다.

clientID

string

''

Status

colour	Yellow
title	릴리즈 2.18.0 이상

NAVER에서 발급받은 clientID를 설정합니다.
HyperCLOVA 요청을 보낼 때 필요하며, GPT의 apiKey에 해당하는 설정입니다.
해당 설정을 사용할 경우 반드시 tokenUrl, clientID, clientSecret이 함께 설정되어야 합니다.
해당 설정을 사용하게 되면 브라우저에 Key 값이 노출되기 때문에, Key 값을 설정하지 않고 서버를 통해 요청을 할 수 있도록 하는 것이 안전합니다.

clientSecret

string

''

Status

colour	Yellow
title	릴리즈 2.18.0 이상

NAVER에서 발급받은 clientSecret를 설정합니다.
HyperCLOVA 요청을 보낼 때 필요하며, GPT의 apiKey에 해당하는 설정입니다.
해당 설정을 사용할 경우 반드시 tokenUrl, clientID, clientSecret이 함께 설정되어야 합니다.
해당 설정을 사용하게 되면 브라우저에 Key 값이 노출되기 때문에, Key 값을 설정하지 않고 서버를 통해 요청을 할 수 있도록 하는 것이 안전합니다.

requestBody

Object

{}

추가로 API에 전송할 내용을 설정합니다.
- max_tokens
- temperature
- n
- ....
자세한 내용은 아래 링크를 참고해 주세요.
- https://platform.openai.com/docs/api-reference/completions/create

ocrUrl

string

''

OCR URL을 설정하면 초안 작성 메뉴에서 '이미지 첨부'메뉴가 활성화됩니다.
이미지를 첨부하면 이미지에 있는 텍스트를 추출해 추출된 텍스트와 프롬프트를 AI에 함께 전송합니다.

customPrompts

Object[]

[]

Code Block

language	js
theme	Emacs

{}

추가로 API에 전송할 내용을 설정합니다.
- max_tokens
- temperature
- n
- ....
자세한 내용은 아래 링크를 참고해 주세요.
- https://platform.openai.com/docs/api-reference/completions/create

ocrUrl

string

''

OCR URL을 설정하면 초안 작성 메뉴에서 '이미지 첨부'메뉴가 활성화됩니다.
이미지를 첨부하면 이미지에 있는 텍스트를 추출해 추출된 텍스트와 프롬프트를 AI에 함께 전송합니다.

customPrompts

Object[]

[]

사용자 정의 프롬프트 메뉴를 추가합니다.
key, type, label, prompt 키를 가지는 객체의 배열을 설정합니다.

Code Block

language	js
theme	Emacs

{
    key: 'customPromptKey',
    type: 'prompt', // 또는 'immediately'
    label: {
        ko: '메뉴에 보여지는 텍스트',
        en: 'Label shown in menu'
    },
    prompt: {
        ko: 'AI에게 전달될 프롬프트. 요약해줘, 내용을 늘려줘, ...',
        en: 'Prompts to be passed to the AI',
    }
}

Code Block

language	js
theme	Emacs

{
    key: 'customPromptKey',
    type: 'group',
    label: {
        ko: '하위 메뉴가 있는 메뉴',
        en: 'Menu with submenus'
    },
    items: ['summarize', 'explanation', ...]
}

key Type 필수 설명

key

string

O

프롬프트를 구분할 수 있는 유니크한 값을 설정합니다.

type

'prompt' | 'immediately' | 'group'

O

prompt: 프롬프트 입력칸에 prompt에 정의한 텍스트가 추가됩니다.
immediately: prompt에 정의한 텍스트가 메뉴를 실행 시 바로 전송됩니다.
group: 하위 메뉴를 가지는 경우 설정합니다.

label

Object

O

메뉴에 보일 텍스트를 설정합니다.

prompt

Object

type: 'prompt' 또는 type: 'immediately'일 때만 유효합니다.
프롬프트로 전송할 텍스트를 설정합니다.

items

string[]

type: 'group'일 때만 유효합니다.
하위 메뉴에 보일 프롬프트 메뉴의 key를 배열 형태로 설정합니다.

iconName

string

아이콘 이름을 설정합니다.
이름에 해당하는 아이콘이 에디터에 등록이 되어있으면 메뉴에 아이콘이 보입니다.

categoryConfig

Object

{}

카테고리 별 보일 프롬프트 메뉴를 설정합니다.
카테고리는 아래와 같습니다.
- favorite: 즐겨찾기
- draft: 초안 작성
- edit: 편집 또는 검토
- createByReference: 내용을 참고하여 생성
- write: 글쓰기

URL, API Key 설정

요청을 보낼 API의 URL, API Key를 설정합니다.

URL은 OpenAI의 API 주소 (https://api.openai.com/v1/chat/completions) 또는 OpenAI의 API로 요청을 하도록 한 URL을 설정합니다.

URL은 필수 값이기 때문에 설정을 하지 않으면 툴바나 메뉴 등에 플러그인의 'AI 요청하기' 버튼이 보이지 않습니다.

API Key에는 openAI에서 발급받은 키를 설정합니다. API Key를 클라이언트에 설정하게 되면 브라우저의 개발자 도구 > 네트워크 탭에 Key 값이 노출되기 때문에 안전하지 않습니다. Key 값을 보이지 않게 감추려면 해당 설정을 사용하지 않고, 서버에서 요청을 하도록 해야 합니다.

...

language	js
theme	Emacs
title	synapeditor.config.js

...

..]
}

key	Type	필수	설명
key	string	O	프롬프트를 구분할 수 있는 유니크한 값을 설정합니다.
type	'prompt' \| 'immediately' \| 'group'	O	prompt: 프롬프트 입력칸에 prompt에 정의한 텍스트가 추가됩니다. immediately: prompt에 정의한 텍스트가 메뉴를 실행 시 바로 전송됩니다. group: 하위 메뉴를 가지는 경우 설정합니다.
label	Object	O	메뉴에 보일 텍스트를 설정합니다.
prompt	Object		`type: 'prompt'` 또는 `type: 'immediately'`일 때만 유효합니다. 프롬프트로 전송할 텍스트를 설정합니다.
items	string[]		`type: 'group'`일 때만 유효합니다. 하위 메뉴에 보일 프롬프트 메뉴의 key를 배열 형태로 설정합니다.
iconName	string		아이콘 이름을 설정합니다. 이름에 해당하는 아이콘이 에디터에 등록이 되어있으면 메뉴에 아이콘이 보입니다.

categoryConfig

Object

{}

카테고리 별 보일 프롬프트 메뉴를 설정합니다.
카테고리는 아래와 같습니다.
- favorite: 즐겨찾기
- draft: 초안 작성
- edit: 편집 또는 검토
- createByReference: 내용을 참고하여 생성
- write: 글쓰기

URL, API Key 설정

요청을 보낼 API의 URL, API Key를 설정합니다.

URL은 OpenAI의 API 주소 (https://api.openai.com/v1/chat/completions

...

Status

colour	Yellow
title	릴리즈 2.18.0 이상

사용할 생성형 AI에 맞춰 아래와 같이 설정합니다.

OpenAI GPT 설정

) 또는 OpenAI의 API로 요청을 하도록 한 URL을 설정합니다.

URL은 필수 값이기 때문에 설정을 하지 않으면 툴바나 메뉴 등에 플러그인의 'AI 요청하기' 버튼이 보이지 않습니다.

API Key에는 openAI에서 발급받은 키를 설정합니다. API Key를 클라이언트에 설정하게 되면 브라우저의 개발자 도구 > 네트워크 탭에 Key 값이 노출되기 때문에 안전하지 않습니다. Key 값을 보이지 않게 감추려면 해당 설정을 사용하지 않고, 서버에서 요청을 하도록 해야 합니다.

Code Block

language	js
theme	Emacs
title	synapeditor.config.js

// URL과 API Key를 설정하는 경우
'aiWriteSupporter.config': {
    ai: 'gpt',
    url: 'https://api.openai.com/v1/chat/completions',
    apiKey: 'sk-abc123...456xyz' // 브라우저에 노출되므로 안전하지 않음
}

// URL만 설정하는 경우
'aiWriteSupporter.config': {
	ai:
'gpt',aiWriteSupporter.config': {
    url: '/request'
}

...

Status

colour	Yellow
title	릴리즈 2.18.0 이상

사용할 생성형 AI에 맞춰 아래와 같이 설정합니다.

OpenAI GPT 설정

Code Block

language	js
theme	Emacs
title	synapeditor.config.js

// URL과 API Key를 설정하는 경우
'aiWriteSupporter.config': {
    ai: 'gpt',
    url: 'hcxhttps://api.openai.com/v1/chat/completions',
    tokenUrlapiKey: 'https://api.hyperclova.ai/v1/tokens',sk-abc123...456xyz' // 토큰브라우저에 발급노출되므로 요청안전하지 API않음
URL}

// URL만 설정하는 url:경우
'https://api.hyperclova.ai/v1/chat-completions/HCX-001',
    clientID: '2029ae...97b72aiWriteSupporter.config': {
	ai: 'gpt',
    clientSecreturl: '8gsetc...0bges3' // 브라우저에 노출되므로 안전하지 않음
}
 
// URL만 설정하는 경우'/request'
}

Naver HyperCLOVA X 설정

Code Block

language	js
theme	Emacs
title	synapeditor.config.js

// url: HyperCLOVA X로 요청을 하도록 구현한 URL
'aiWriteSupporter.config': {
    ai: 'hcx',
    url: '/request',
}

...

Space shortcuts

Page tree

Versions Compared

Old Version 34

New Version 35

Key

URL, API Key 설정

URL, API Key 설정