remix-nlux/packages/shared/src/types/chatSegment/chatSegmentController.ts

Remix IDE NLUX integration. Remix IDE is the leading IDE for building and deploying smart contracts on Ethereum. NLUX is a JavaScript and React library for building conversational AI experiences.

import {MessageStatus} from '../../components/Message/props';
import {DataTransferMode} from '../adapters/chat/chatAdapter';

/**
 * The interface for a controller that can be used to change a chat segment.
 */
export interface ChatSegmentController<ResponseType> {
    addAiMessage: (
        status: MessageStatus,
        dataTransferMode: DataTransferMode,
        content?: ResponseType,
    ) => string,
    addUserMessage: (
        status: MessageStatus,
        content?: string,
    ) => string;
    chunk: (chunk: ResponseType) => void,
    complete: () => void,
    error: (error: Error) => void,
    updateMessage: (
        id: string,
        status: MessageStatus,
        content?: string,
    ) => void,
}