사이냅 에디터 문서
Space shortcuts
Page tree

Versions Compared

Old Version 21

changes.mady.by.user 김혜진

Saved on

compared with

New Version 22

changes.mady.by.user 김혜진

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

KeyType필수설명
urlstringO
  • 요청을 보낼 URL을 설정합니다.
    • OpenAI의 API 주소
    • OpenAI의 API로 요청을 하도록 구현한 URL
  • 설정이 되지 않으면 툴바에 플러그인 버튼이 표시되지 않습니다.
apiKeystring
  • OpenAI에서 발급받은 API Key를 설정합니다.
  • 해당 설정을 사용하게 되면 브라우저에 Key 값이 노출되기 때문에, Key 값을 설정하지 않고 서버를 통해 요청을 할 수 있도록 하는 것이 안전합니다. 
requestBodyObject
ocrUrlstring
  • OCR URL을 설정하면 초안 작성 메뉴에서 '이미지 첨부'메뉴가 활성화됩니다.
  • 이미지를 첨부하면 이미지에 있는 텍스트를 추출해 추출된 텍스트와 프롬프트를 AI에 함께 전송합니다.

customPrompts

Object[]
  • 사용자 정의 프롬프트 메뉴를 추가합니다.
  • key, type, label, prompt 키를 가지는 객체의 배열을 설정합니다.
Code Block
languagejs
themeEmacs
{
    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
languagejs
themeEmacs
{
    key: 'customPromptKey',
    type: 'group',
    label: {
        ko: '하위 메뉴가 있는 메뉴',
        en: 'Menu with submenus'
    },
    items: ['summarize', 'explanation', ...]
}


keyType필수설명
keystringO
  • 프롬프트를 구분할 수 있는 유니크한 값을 설정합니다.
type'prompt' | 'immediately' | 'group'O
  • prompt: 프롬프트 입력칸에 prompt에 정의한 텍스트가 추가됩니다.
  • immediately: prompt에 정의한 텍스트가 메뉴를 실행 시 바로 전송됩니다.
  • group: 하위 메뉴를 가지는 경우 설정합니다.
labelObjectO
  • 메뉴에 보여질 보일 텍스트를 설정합니다.
promptObject

  • type: 'prompt' 또는 type: 'immediately'일 때만 유효합니다.

  • 프롬프트로 전송할 텍스트를 설정합니다.
itemsstring[]

  • type: 'group'일 때만 유효합니다.

  • 하위 메뉴에 보여질 보일 프롬프트 메뉴의 key를 배열 형태로 설정합니다.
iconNamestring
  • 아이콘 이름을 설정합니다.
  • 이름에 해당하는 아이콘이 에디터에 등록이 되어있으면 메뉴에 아이콘이 보입니다.


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

...

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


카테고리 별

...

보일 프롬프트 메뉴 설정

카테고리 별 보여질 보일 프롬프트 메뉴를 설정합니다.

카테고리는 'favorites', 'draft', 'edit', 'createByReference', 'write'가 있고, 아래는 각각의 카테고리에 대한 설명입니다.

...

초안 작성(draft) 카테고리 메뉴 재정의 하기

카테고리에 보여질 보일 메뉴를 재정의할 수 있습니다. 

플러그인에 미리 정의된 프롬프트 메뉴 Key는 미리 정의된 프롬프트 메뉴에서 확인할 수 있습니다.

...