...
| Key | Type | 필수 | 기본값 | 설명 |
|---|
| url | string | O | '' | - 요청을 보낼 URL을 설정합니다.
- OpenAI의 API 주소
- OpenAI의 API로 요청을 하도록 구현한 URL
- HyperCLOVA X로 요청을 하도록 구현한 URL
- 설정이 되지 않으면 툴바에 플러그인 버튼이 표시되지 않습니다.
|
| apiKey | string |
| '' | - OpenAI에서 발급받은 API Key를 설정합니다.
- 해당 설정을 사용하게 되면 브라우저에 Key 값이 노출되기 때문에, Key 값을 설정하지 않고 서버를 통해 요청을 할 수 있도록 하는 것이 안전합니다.
|
| string | | 'gpt' | - 사용할 AI를 설정합니다. 기본값은 'gpt'입니다.
- OpenAI GPT: 'gpt'
- NAVER HyperCLOVA X: 'hcx'
|
| requestBody | Object |
| {} | - 추가로 API에 전송할 내용을 설정합니다.
- max_tokens
- temperature
- n
- ....
- 자세한 내용은 아래 링크를 참고해 주세요.
|
| ocrUrl | string |
| '' | - OCR URL을 설정하면 초안 작성 메뉴에서 '이미지 첨부'메뉴가 활성화됩니다.
- 이미지를 첨부하면 이미지에 있는 텍스트를 추출해 추출된 텍스트와 프롬프트를 AI에 함께 전송합니다.
|
customPrompts | Object[] |
| [] | - 사용자 정의 프롬프트 메뉴를 추가합니다.
- key, type, label, prompt 키를 가지는 객체의 배열을 설정합니다.
| Code Block |
|---|
| {
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 |
|---|
| {
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 |
| | | items | string[] |
| type: 'group'일 때만 유효합니다.
- 하위 메뉴에 보일 프롬프트 메뉴의 key를 배열 형태로 설정합니다.
| | iconName | string |
| - 아이콘 이름을 설정합니다.
- 이름에 해당하는 아이콘이 에디터에 등록이 되어있으면 메뉴에 아이콘이 보입니다.
|
|
| categoryConfig | Object |
| {} | - 카테고리 별 보일 프롬프트 메뉴를 설정합니다.
- 카테고리는 아래와 같습니다.
- favorite: 즐겨찾기
- draft: 초안 작성
- edit: 편집 또는 검토
- createByReference: 내용을 참고하여 생성
- write: 글쓰기
|
| areaSize | Object |
| { width: 380, height: 260 } | - 프롬프트 및 미리보기 창 기본 사이즈를 설정합니다. (단위: px)
- 최소 사이즈 이하로 설정 시 최소 사이즈로 표현됩니다.
- 최소 사이즈: { width: 370, height: 120 }
|
URL, API Key 설정
요청을 보낼 API의 URL, API Key를 설정합니다.
...
| 적용된 모습 | 설정 |
|---|
|
| Code Block |
|---|
| language | js |
|---|
| theme | Emacs |
|---|
| title | synapeditor.config.js |
|---|
| // 즐겨찾기 카테고리에 커스텀 메뉴 추가
'aiWriteSupporter.config': {
text: {
categoryConfig: {
favorites: ['my-custom-menu1', 'my-custom-menu2', 'my-custom-menu3']
},
customPrompts: [
{
key: 'my-custom-menu1',
type: 'prompt',
label: {
ko: '나의 커스텀 메뉴 1',
en: 'My custom menu'
},
prompt: {
ko: '바나나를 영어로',
en: 'banana in english',
}
},
{
key: 'my-custom-menu2',
type: 'immediately',
label: {
ko: '나의 커스텀 메뉴 2',
en: 'My custom menu'
},
prompt: {
ko: '포도를 영어로',
en: 'grape in english',
}
},
{
key: 'my-custom-menu3',
type: 'group',
label: {
ko: '내가 제일 자주쓰는 메뉴 모음',
en: 'My most used menu'
},
items: ['englishTranslation', 'tabularFormat']
}
]
}
} |
|
프롬프트 및 미리보기 창 기본 사이즈 설정
| Code Block |
|---|
| language | js |
|---|
| theme | Emacs |
|---|
| title | synapeditor.config.js |
|---|
|
'aiWriteSupporter.config': {
text: {
url: '/request',
areaSize: { width: 400, height: 400 }
//...
}
} |
