[AIWriteSupporter] 플러그인 API

목차

• 2.21.0 버전부터 지원, 3.3.0 버전부터 지원
  • EVENT_TYPE
    • TEXT_STREAM_UPDATED
  • on(eventType, listener)
    • 매개변수
  • off(eventType, listener)
    • 매개변수

2.21.0 버전부터 지원, 3.3.0 버전부터 지원

EVENT_TYPE

AIWriteSupporter 플러그인에서 사용할 수 있는 이벤트 타입은 다음과 같습니다.

on() 및 off() 메서드를 사용하여 이벤트에 대한 리스너를 등록하거나 제거할 수 있습니다.

TEXT_STREAM_UPDATED

AI 응답 스트림이 도착할 때마다 발생합니다.

리스너 매개변수로 전달되는 값:

{
    aiType: string,                             // AI type
    data: Object,                               // response received via stream
    setContent: (content: string) => void       // sets the response content
}

• setContent(content): 응답 데이터를 UI에 누적하여 표시합니다.

예시

var editor = new SynapEditor(id, synapEditorConfig);
var aiWriteSupporter = editor.plugins.aiWriteSupporter;
var EVENT_TYPE = aiWriteSupporter.EVENT_TYPE;

aiWriteSupporter.on(EVENT_TYPE.TEXT_STREAM_UPDATED, function (event) {
    const data = event.data;
    event.setContent(data.choices[0].delta.content); // GPT-based response setting example
});

on(eventType, listener)

AIWriteSupporter 플러그인에서 발생하는 이벤트에 대한 리스너를 등록합니다.

매개변수

예시

var editor = new SynapEditor(id, synapEditorConfig);
var aiWriteSupporter = editor.plugins.aiWriteSupporter;
var EVENT_TYPE = aiWriteSupporter.EVENT_TYPE;
var eventListener = function () {};

aiWriteSupporter.on(EVENT_TYPE.TEXT_STREAM_UPDATED, eventListener);

off(eventType, listener)

AIWriteSupporter 플러그인에서 발생하는 이벤트에 대한 리스너를 제거합니다.

매개변수

예시

var editor = new SynapEditor(id, synapEditorConfig);
var aiWriteSupporter = editor.plugins.aiWriteSupporter;
var EVENT_TYPE = aiWriteSupporter.EVENT_TYPE;
var eventListener = function () {};

aiWriteSupporter.off(EVENT_TYPE.TEXT_STREAM_UPDATED, eventListener);