Page tree

Versions Compared

Key

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

...

Code Block
languagejs
themeEmacs
titlesynapeditor.config.js
//...
'editor.quickInsert': [
	// AI 요청하기 버튼
    'openAIInteraction',
	//...
],
// ...

벌룬에 추가, 바로삽입에 추가, 메뉴에 추가

플러그인 설정하기

URL, API Key 및 request body 설정

api key 노출을 하지 않으려면 서버 구현해야된다 내용. 서버 예제 페이지 따로 작성해서 링크하기 

OCR URL 설정

...



플러그인 설정하기

사용가능한 키

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

customPrompts

Object[]
  • 사용자 정의 프롬프트 메뉴를 추가합니다.
categoryConfigObject
  • 카테고리 별 나타날 프롬프트 메뉴를 설정합니다.

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 값을 보이지 않게 감추려면 해당 설정을 사용하지 않고, 서버에서 요청을 하도록 해야 합니다.

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

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


Request Body 설정

API 요청시 추가로 필요한 값들을 설정합니다. 설정할 수 있는 값들은 아래 링크에서 확인할 수 있습니다.

https://platform.openai.com/docs/api-reference/completions/create

Code Block
languagejs
themeEmacs
titlesynapeditor.config.js
// Request body 설정
'aiWriteSupporter.config': {
    url: 'url',
    apiKey: 'apiKey',
    requestBody: {
        temperature: 2,
        presence_penalty: 2, 
        ...
    }
}




OCR URL 설정: '이미지 첨부' 기능 사용

ocrUrl을 설정하면 초안 작성 메뉴에서 '이미지 첨부' 메뉴가 활성화 됩니다.

'이미지 첨부' 기능은 이미지의 텍스트를 추출한 후 입력한 프롬프트와 함께 AI에게 전송하는 기능입니다.

사용 예시) 보도 자료 이미지 첨부 → '요약해줘' 프롬프트 입력 → 전송

Code Block
languagejs
themeEmacs
titlesynapeditor.config.js
'aiWriteSupporter.config': {
    ocrUrl: 'ocr URL'
}


'ocrUrl'을 설정하지 않음: 초안 작성시 '이미지 첨부'메뉴 보여지지 않음'ocrUrl'을 설정: 초안 작성시 '이미지 첨부'메뉴 보여짐

Image Added

Image Added


커스텀 프롬프트 설정



카테고리 별 보여질 프롬프트 메뉴 설정

...