copilot-js v1.1.0

copilot-js

copilot-js is a library that provides an autocompletion for LLM.

Background

LLM has changed people's work and lives significantly. However, it does not always return the correct answer and has limited applications. Copilot UI dramatically expands the applications of LLM by allowing collaboration between LLM and humans. For this, high-quality Copilot components are essential for the development of humans with LLM.

Features

• Easy-to-use UI specialized for natural language input
• Support for text-only or text-containing HTML
• Provide helpers

Remark

This library converts pure DOM element into copilot. If you want to use it with React, use copilot-react.

Demo

See /packages/demo

Guide for users

normal state:

completion state:

Unlike Github copilot, you can perform operations such as arrow keys, copy, and paste even during completion.

Guide for developers

Installation

To install copilot-js, you can use npm:

npm i copilot-js

Step 1 Create a completion handler.

Use helpers in "./dist/helper/*" or write a handler by yourself. See samples in files:

Step 2 Create a copilot object.

const copilot = new CopilotEngine({
  handler: callCompletion, // handler to completion API
  onChange: (text) => console.log(text), // event handler to get content
  value: value, // initial value
  container: document.getElementById("#container"),
})

Step 3 Change parameter in runtime (if needed)

All constructor parameters except container can be changed in runtime.

copilot.handler = newHandler;
copilot.onChange =  (text) => console.log("new event handler", text);
copilot.value = value;

When value changes, the cursor and completion state will be reset.

Examples

See /packages/demo/src/index.tsx

API Reference

CopilotEngine

Engine to handle completion. You can convert any DIV element to a completion-enabled editor.

Constructor

new CopilotEngine(params: {
  value: string;
  textOnly?: boolean = true;
  onChange?: (value: string) => void;
  delay?: number;
  handler: CompletionHandler;
  errorHandler?: ErrorHandler;
  element: HTMLDivElement
}): CopilotEngine

interface CopilotEngine {
  value: string;
  textOnly?: boolean;
  onChange?: (value: string) => void;
  delay?: number;
  handler: CompletionHandler;
  errorHandler?: ErrorHandler;
}

type CompletionHandler = (params: {
  precedingText?: string | undefined;
  followingText?: string | undefined;
  callback: (output: string) => void;
}) => StreamState;

type StreamState = {
  abort: () => void;
  promise: Promise<void>;
};

type ErrorHandler = (error: any) => void;

Parameters

• params: An object with the following properties:
  • handler: Completion handler.
  • element The DIV element to be converted to a completion-enabled editor
  • value: Initial value.
  • textOnly (optional): If true, only text can be inserted. Default true.
  • onChange (optional): Callback when the value is changed.
  • delay (optional): Delay to start automatic completion. If not specified, completion will not start automatically.
  • errorHandler (optional): Error handler, callback error in CompletionHandler.

Fields

• handler: Completion handler.
• element The DIV element to be converted to a completion-enabled editor
• value: Initial value.
• textOnly (optional): If true, only text can be inserted. Default true.
• onChange (optional): Callback when the value is changed.
• delay (optional): Delay to start automatic completion. If not specified, completion will not start automatically.
• errorHandler (optional): Error handler, callback error in CompletionHandler.