alignai/dist/events.d.ts

Server-side Align AI SDK for Node.js

import { Event as PBEvent } from './buf/event_pb';
export interface Event {
    toPB(): PBEvent;
}
export type CustomPropertyValue = string;
export type CustomProperties = Record<string, CustomPropertyValue>;
export interface OpenSessionEventProps {
    sessionId: string;
    userId: string;
    assistantId?: string;
    sessionTitle?: string;
    customProperties?: CustomProperties;
}
export declare class OpenSessionEvent implements Event {
    private readonly event;
    constructor(props: OpenSessionEventProps);
    toPB(): PBEvent;
}
export interface CreateMessageEventProps {
    sessionId: string;
    messageIndex: number;
    messageRole: 'user' | 'assistant';
    messageContent: string;
    customProperties?: CustomProperties;
}
export declare class CreateMessageEvent implements Event {
    private readonly event;
    constructor(props: CreateMessageEventProps);
    toPB(): PBEvent;
}
export interface CloseSessionEventProps {
    sessionId: string;
}
export declare class CloseSessionEvent implements Event {
    private readonly event;
    constructor(props: CloseSessionEventProps);
    toPB(): PBEvent;
}
export interface IdentifyUserEventProps {
    userId: string;
    userDisplayName?: string;
    userEmail?: string;
    userIp?: string;
    userCountryCode?: string;
    userCreateTime?: Date;
    customProperties?: CustomProperties;
}
export declare class IdentifyUserEvent implements Event {
    private readonly event;
    constructor(props: IdentifyUserEventProps);
    toPB(): PBEvent;
}
export interface CreateMessageFeedbackEventProps {
    sessionId: string;
    messageIndex: number;
    feedbackType: 'thumbs_up' | 'thumbs_down';
}
export declare class CreateMessageFeedbackEvent implements Event {
    private readonly event;
    constructor(props: CreateMessageFeedbackEventProps);
    toPB(): PBEvent;
}
export interface CreateSessionFeedbackEventProps {
    sessionId: string;
    feedbackType: 'thumbs_up' | 'thumbs_down';
}
export declare class CreateSessionFeedbackEvent implements Event {
    private readonly event;
    constructor(props: CreateSessionFeedbackEventProps);
    toPB(): PBEvent;
}