helpingai/dist/types.d.ts

The official JavaScript/TypeScript library for the HelpingAI API - Advanced AI with Emotional Intelligence

/**
 * Type definitions for the HelpingAI SDK
 */
export interface HelpingAIConfig {
    apiKey?: string;
    baseURL?: string;
    timeout?: number;
    organization?: string;
    defaultHeaders?: Record<string, string>;
}
export interface ChatMessage {
    role: 'system' | 'user' | 'assistant' | 'tool';
    content: string;
    name?: string;
    tool_call_id?: string;
    tool_calls?: ToolCall[];
}
export interface ToolCall {
    id: string;
    type: 'function';
    function: {
        name: string;
        arguments: string;
    };
}
export interface Tool {
    type: 'function';
    function: {
        name: string;
        description: string;
        parameters: Record<string, any>;
    };
}
export interface MCPServerConfig {
    command?: string;
    args?: string[];
    env?: Record<string, string>;
    url?: string;
    headers?: Record<string, string>;
    type?: 'stdio' | 'sse' | 'streamable-http';
    sse_read_timeout?: number;
}
export interface MCPServersConfig {
    mcpServers: Record<string, MCPServerConfig>;
}
export type ToolDefinition = Tool | MCPServersConfig | string;
export interface ChatCompletionRequest {
    model: string;
    messages: ChatMessage[];
    tools?: ToolDefinition[];
    tool_choice?: 'auto' | 'none' | {
        type: 'function';
        function: {
            name: string;
        };
    };
    temperature?: number;
    max_tokens?: number;
    top_p?: number;
    frequency_penalty?: number;
    presence_penalty?: number;
    stream?: boolean;
    hide_think?: boolean;
    stop?: string | string[];
    user?: string;
}
export interface ChatCompletionChoice {
    index: number;
    message: ChatMessage;
    finish_reason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | null;
}
export interface ChatCompletionResponse {
    id: string;
    object: 'chat.completion';
    created: number;
    model: string;
    choices: ChatCompletionChoice[];
    usage?: {
        prompt_tokens: number;
        completion_tokens: number;
        total_tokens: number;
    };
}
export interface ChatCompletionChunk {
    id: string;
    object: 'chat.completion.chunk';
    created: number;
    model: string;
    choices: Array<{
        index: number;
        delta: Partial<ChatMessage>;
        finish_reason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | null;
    }>;
}
export interface Model {
    id: string;
    object: 'model';
    created: number;
    owned_by: string;
    description?: string;
    name?: string;
}
export interface ModelList {
    object: 'list';
    data: Model[];
}
export interface ToolFunction {
    (...args: any[]): any;
    _toolSchema?: Tool;
}
export interface ToolRegistry {
    register(name: string, tool: Tool, fn: Function): void;
    get(name: string): {
        tool: Tool;
        fn: Function;
    } | undefined;
    list(): Array<{
        name: string;
        tool: Tool;
        fn: Function;
    }>;
    clear(): void;
    has(name: string): boolean;
    size(): number;
}
export interface StreamEvent {
    data: string;
    event?: string;
    id?: string;
    retry?: number;
}
//# sourceMappingURL=types.d.ts.map