ctod 0.6.3 → 0.7.1

package/types/examples/chat-demo.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="lib/shims" />
-export {};

package/types/examples/chat-for-llama.cpp-demo.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="lib/shims" />
-export {};

package/types/examples/chat-with-json-schema-demo.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="lib/shims" />
-export {};

package/types/examples/plugin-demo.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="lib/shims" />
-export {};

package/types/examples/stream-for-llama.cpp-demo.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="lib/shims" />
-export {};

package/types/examples/vision-demo.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="lib/shims" />
-export {};

package/types/lib/broker/chat.d.ts

@@ -1,142 +0,0 @@
-import { ChatBrokerPlugin } from '../core/plugin';
-import { Event, Hook, Log } from 'power-helper';
-import { Translator, TranslatorParams } from '../core/translator';
-import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate';
-type Message = {
-    role: 'system' | 'user' | 'assistant';
-    name?: string;
-    content: string;
-};
-export type ChatBrokerHooks<S extends ValidateCallback<any>, O extends ValidateCallback<any>, P extends ChatBrokerPlugin<any, any>, PS extends Record<string, ReturnType<P['use']>>> = {
-    /**
-     * @zh 第一次聊天的時候觸發
-     * @en Triggered when chatting for the first time
-     */
-    start: {
-        id: string;
-        data: ValidateCallbackOutputs<S>;
-        plugins: {
-            [K in keyof PS]: {
-                send: (data: PS[K]['__receiveData']) => void;
-            };
-        };
-        schema: {
-            input: S;
-            output: O;
-        };
-        messages: Message[];
-        setPreMessages: (messages: (Omit<Message, 'content'> & {
-            content: string | string[];
-        })[]) => void;
-        changeMessages: (messages: Message[]) => void;
-    };
-    /**
-     * @zh 發送聊天訊息給機器人前觸發
-     * @en Triggered before sending chat message to bot
-     */
-    talkBefore: {
-        id: string;
-        data: ValidateCallbackOutputs<S>;
-        messages: Message[];
-        lastUserMessage: string;
-    };
-    /**
-     * @zh 當聊天機器人回傳資料的時候觸發
-     * @en Triggered when the chatbot returns data
-     */
-    talkAfter: {
-        id: string;
-        data: ValidateCallbackOutputs<S>;
-        response: any;
-        messages: Message[];
-        parseText: string;
-        lastUserMessage: string;
-        /**
-         * @zh 宣告解析失敗
-         * @en Declare parsing failure
-         */
-        parseFail: (error: any) => void;
-        changeParseText: (text: string) => void;
-    };
-    /**
-     * @zh 當回傳資料符合規格時觸發
-     * @en Triggered when the returned data meets the specifications
-     */
-    succeeded: {
-        id: string;
-        output: ValidateCallbackOutputs<O>;
-    };
-    /**
-     * @zh 當回傳資料不符合規格，或是解析錯誤時觸發
-     * @en Triggered when the returned data does not meet the specifications or parsing errors
-     */
-    parseFailed: {
-        id: string;
-        error: any;
-        retry: () => void;
-        count: number;
-        response: any;
-        parserFails: {
-            name: string;
-            error: any;
-        }[];
-        messages: Message[];
-        lastUserMessage: string;
-        changeMessages: (messages: Message[]) => void;
-    };
-    /**
-     * @zh 不論成功失敗，執行結束的時候會執行。
-     * @en It will be executed when the execution is completed, regardless of success or failure.
-     */
-    done: {
-        id: string;
-    };
-};
-type RequestContext = {
-    count: number;
-    isRetry: boolean;
-    onCancel: (cb: () => void) => void;
-    schema: {
-        input: any;
-        output: any;
-    };
-};
-export type Params<S extends ValidateCallback<any>, O extends ValidateCallback<any>, C extends Record<string, any>, P extends ChatBrokerPlugin<any, any>, PS extends Record<string, ReturnType<P['use']>>> = Omit<TranslatorParams<S, O>, 'parsers'> & {
-    name?: string;
-    plugins?: PS | (() => PS);
-    request: (messages: Message[], context: RequestContext) => Promise<string>;
-    install?: (context: {
-        log: Log;
-        attach: Hook<C>['attach'];
-        attachAfter: Hook<C>['attachAfter'];
-        translator: Translator<S, O>;
-    }) => void;
-};
-export declare class ChatBroker<S extends ValidateCallback<any>, O extends ValidateCallback<any>, P extends ChatBrokerPlugin<any, any>, PS extends Record<string, ReturnType<P['use']>>, C extends ChatBrokerHooks<S, O, P, PS> = ChatBrokerHooks<S, O, P, PS>> {
-    protected __hookType: C;
-    protected log: Log;
-    protected hook: Hook<C>;
-    protected params: Params<S, O, C, P, PS>;
-    protected plugins: PS;
-    protected installed: boolean;
-    protected translator: Translator<S, O>;
-    protected event: Event<{
-        cancel: {
-            requestId: string;
-        };
-        cancelAll: any;
-    }>;
-    constructor(params: Params<S, O, C, P, PS>);
-    protected _install(): any;
-    cancel(requestId?: string): Promise<void>;
-    requestWithId<T extends Translator<S, O>>(data: T['__schemeType']): {
-        id: string;
-        request: Promise<T['__outputType']>;
-    };
-    /**
-     * @zh 將請求發出至聊天機器人。
-     * @en Send request to chatbot.
-     */
-    request<T extends Translator<S, O>>(data: T['__schemeType']): Promise<T['__outputType']>;
-}
-export {};

package/types/lib/core/parser.d.ts

@@ -1,32 +0,0 @@
-type TextParserParams = {
-    /**
-     * @zh 解讀器名字。
-     * @en The name of the parser.
-     */
-    name: string;
-    /**
-     * @zh 解讀文本。
-     * @en Read the text.
-     */
-    handler: (text: string) => Promise<any>;
-};
-export declare class TextParser {
-    private params;
-    /**
-     * @zh 盡可能將文字內的 json 解讀出來。
-     * @en Try to read the json in the text as much as possible.
-     */
-    static JsonMessage(): TextParser;
-    constructor(params: TextParserParams);
-    /**
-     * @zh 解讀器名字。
-     * @en The name of the parser.
-     */
-    get name(): string;
-    /**
-     * @zh 解讀文本。
-     * @en Read the text.
-     */
-    read(text: string): Promise<any>;
-}
-export {};

package/types/lib/core/plugin.d.ts

@@ -1,34 +0,0 @@
-import { Translator } from './translator';
-import { ChatBrokerHooks } from '../broker/chat';
-import { Log, Hook, Event } from 'power-helper';
-import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate';
-type BrokerHooks = ChatBrokerHooks<any, any, any, any>;
-type BrokerPluginParams<T extends ValidateCallback<any>, R extends ValidateCallback<any>> = {
-    name: string;
-    params: T;
-    receiveData: R;
-    onInstall: (context: {
-        log: Log;
-        params: ValidateCallbackOutputs<T>;
-        attach: Hook<BrokerHooks>['attach'];
-        attachAfter: Hook<BrokerHooks>['attachAfter'];
-        translator: Translator<any, any>;
-        receive: (callback: (params: {
-            id: string;
-            data: ValidateCallbackOutputs<R>;
-        }) => void) => void;
-    }) => void;
-};
-export declare class ChatBrokerPlugin<T extends ValidateCallback<any>, R extends ValidateCallback<any>> {
-    _event: Event<Record<string, Record<string, any>>>;
-    _params: BrokerPluginParams<T, R>;
-    constructor(params: BrokerPluginParams<T, R>);
-    use(params: ValidateCallbackOutputs<T>): {
-        instance: any;
-        params: ValidateCallbackOutputs<T, ReturnType<T>>;
-        send: (data: ValidateCallbackOutputs<R>) => void;
-        receive: (callback: any) => void;
-        __receiveData: ValidateCallbackOutputs<R, ReturnType<R>>;
-    };
-}
-export {};

package/types/lib/core/translator.d.ts

@@ -1,68 +0,0 @@
-import { TextParser } from './parser';
-import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate';
-export type TranslatorParams<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = {
-    /**
-     * @zh 輸入的資料格式。
-     * @en The input data format.
-     */
-    input: S;
-    /**
-     * @zh 輸出的資料格式。
-     * @en The output data format.
-     */
-    output: O;
-    /**
-     * @zh 註冊解讀文字的解析器。
-     * @en Register the parser to interpret the text.
-     */
-    parsers: TextParser[];
-    /**
-     * @zh 組合輸入資料成為提示文字。
-     * @en Combine the input data into a prompt.
-     */
-    question: (data: ValidateCallbackOutputs<S>, context: {
-        schema: {
-            input: S;
-            output: O;
-        };
-    }) => Promise<string | string[]>;
-};
-export declare class Translator<S extends ValidateCallback<any>, O extends ValidateCallback<any>> {
-    private params;
-    constructor(params: TranslatorParams<S, O>);
-    get __schemeType(): ValidateCallbackOutputs<S>;
-    get __outputType(): ValidateCallbackOutputs<O>;
-    /**
-     * @zh 組合輸入資料成為提示文字。
-     * @en Combine the input data into a prompt.
-     */
-    compile(data: ValidateCallbackOutputs<S>, context: {
-        schema: {
-            input: S;
-            output: O;
-        };
-    }): Promise<{
-        scheme: ReturnType<S> extends infer T ? { [K in keyof T]: ReturnType<S>[K] extends {
-            __outputType: any;
-        } ? ReturnType<S>[K]["__outputType"] : unknown; } : never;
-        prompt: string;
-    }>;
-    getValidate(): {
-        input: S;
-        output: O;
-    };
-    /**
-     * @zh 將文字轉換成序列化資料。
-     * @en Convert text to serialized data.
-     */
-    parse(text: string): Promise<{
-        output: ReturnType<O> extends infer T ? { [K in keyof T]: ReturnType<O>[K] extends {
-            __outputType: any;
-        } ? ReturnType<O>[K]["__outputType"] : unknown; } : never;
-        parserName: string;
-        parserFails: {
-            name: string;
-            error: any;
-        }[];
-    }>;
-}

package/types/lib/index.d.ts

@@ -1,31 +0,0 @@
-export * as plugins from './plugins';
-export * as templates from './templates';
-export { validateToJsonSchema, defineYupSchema } from './utils/validate';
-export { OpenAI } from './service/openai';
-export { Llama3Cpp } from './service/llama3.cpp';
-export { TextParser } from './core/parser';
-export { ChatGPTMessage } from './service/openai/chat';
-export { ChatBroker } from './broker/chat';
-export { ChatBrokerPlugin } from './core/plugin';
-export { Translator, TranslatorParams } from './core/translator';
-import * as plugins from './plugins';
-import * as templates from './templates';
-import { OpenAI } from './service/openai';
-import { Llama3Cpp } from './service/llama3.cpp';
-import { Translator } from './core/translator';
-import { TextParser } from './core/parser';
-import { ChatBroker } from './broker/chat';
-import { ChatBrokerPlugin } from './core/plugin';
-export declare const ctod: {
-    OpenAI: typeof OpenAI;
-    Llama3Cpp: typeof Llama3Cpp;
-    plugins: typeof plugins;
-    templates: typeof templates;
-    ChatBroker: typeof ChatBroker;
-    Translator: typeof Translator;
-    TextParser: typeof TextParser;
-    ChatBrokerPlugin: typeof ChatBrokerPlugin;
-    defineYupSchema: <T extends Record<string, import("yup").Schema<any, any, any, "">>>(cb: import("./utils/validate").ValidateCallback<T>) => T;
-    validateToJsonSchema: <T_1 extends import("./utils/validate").ValidateCallback<any>>(cb: T_1) => import("json-schema").JSONSchema7;
-};
-export default ctod;

package/types/lib/plugins/index.d.ts

@@ -1,47 +0,0 @@
-/**
- * @zh 一個基於印出 log 的 plugin。
- * @en A plugin based on printing log.
- */
-export declare const PrintLogPlugin: import("..").ChatBrokerPlugin<(yup: typeof import("yup")) => {
-    detail: import("yup").BooleanSchema<boolean | undefined, import("yup").AnyObject, false, "d">;
-}, () => {}>;
-/**
- * @zh 當解析失敗時，會自動重試的對話。
- * @en A conversation that will automatically retry when parsing fails.
- */
-export declare const RetryPlugin: import("..").ChatBrokerPlugin<(yup: typeof import("yup")) => {
-    retry: import("yup").NumberSchema<number, import("yup").AnyObject, 1, "d">;
-    printWarn: import("yup").BooleanSchema<NonNullable<boolean | undefined>, import("yup").AnyObject, true, "d">;
-}, () => {}>;
-/**
- * @zh 限制使用流量，這個 plugin 可以有效讓所有對話不會再限制內同時發送，可用於在開發過程中遭遇伺服器因頻率過高而阻擋請求。
- * @en Limit the use of traffic. This plugin can effectively prevent all conversations from being sent at the same time within the limit, and can be used when the server blocks requests due to high frequency during development.
- */
-export declare const LimiterPlugin: import("..").ChatBrokerPlugin<() => {}, () => {}>;
-/**
- * @zh 排程系統將全域託管，有什麼必要設定可以來更動它的狀態，例如：關閉排程。
- * @en The scheduling system will be globally hosted. What is necessary to set can come to change its status, for example: close the schedule.
- */
-export declare const LimiterPluginGlobState: {
-    event: import("power-helper").Event<{
-        run: {
-            id: string;
-        };
-        waitTimeChange: {
-            waitTime: number;
-        };
-    }>;
-    config: {
-        limit: number;
-        interval: number;
-    };
-    closeSchedule: () => void;
-    plugin: import("..").ChatBrokerPlugin<() => {}, () => {}>;
-};
-/**
- * @zh 設定角色扮演。
- * @en Set role play.
- */
-export declare const RolePlugin: import("..").ChatBrokerPlugin<(yup: typeof import("yup")) => {
-    role: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
-}, () => {}>;

package/types/lib/plugins/limiter.d.ts

@@ -1,36 +0,0 @@
-import { ChatBrokerPlugin } from '../core/plugin';
-import { Event } from 'power-helper';
-type Events = {
-    run: {
-        id: string;
-    };
-    waitTimeChange: {
-        waitTime: number;
-    };
-};
-declare const _default: {
-    /**
-     * @zh 你可以監聽一些事件行為，例如還需要等待多少時間。
-     * @en You can listen for some event behaviors, such as how long you still need to wait.
-     */
-    event: Event<Events>;
-    /**
-     * @zh 預設是每分鐘限制3次，你可以在設定中改變限制流量。
-     * @en By default, the limit is 3 times per minute, and you can change the limit flow in the settings.
-     */
-    config: {
-        limit: number;
-        interval: number;
-    };
-    /**
-     * @zh 由於排程會在背景持續倒數，如果有關閉程式的需求，需要手動進行移除。
-     * @en Since the schedule will continue to count down in the background, if there is a need to close the program, you need to manually remove it.
-     */
-    closeSchedule: () => void;
-    /**
-     * @zh Plugin 的接口
-     * @en Plugin interface
-     */
-    plugin: ChatBrokerPlugin<() => {}, () => {}>;
-};
-export default _default;

package/types/lib/plugins/print-log.d.ts

@@ -1,5 +0,0 @@
-import { ChatBrokerPlugin } from '../core/plugin';
-declare const _default: ChatBrokerPlugin<(yup: typeof import("yup")) => {
-    detail: import("yup").BooleanSchema<boolean | undefined, import("yup").AnyObject, false, "d">;
-}, () => {}>;
-export default _default;

package/types/lib/plugins/retry.d.ts

@@ -1,6 +0,0 @@
-import { ChatBrokerPlugin } from '../core/plugin';
-declare const _default: ChatBrokerPlugin<(yup: typeof import("yup")) => {
-    retry: import("yup").NumberSchema<number, import("yup").AnyObject, 1, "d">;
-    printWarn: import("yup").BooleanSchema<NonNullable<boolean | undefined>, import("yup").AnyObject, true, "d">;
-}, () => {}>;
-export default _default;

package/types/lib/plugins/role.d.ts

@@ -1,5 +0,0 @@
-import { ChatBrokerPlugin } from '../core/plugin';
-declare const _default: ChatBrokerPlugin<(yup: typeof import("yup")) => {
-    role: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
-}, () => {}>;
-export default _default;

package/types/lib/service/llama3.cpp/completion.d.ts

@@ -1,61 +0,0 @@
-import { Llama3Cpp } from './index';
-type Message = {
-    role: string;
-    content: string;
-};
-type Options = any;
-export type Config = {
-    baseUrl: string;
-    headers: Record<string, string>;
-    autoConvertTraditionalChinese: boolean;
-};
-type Stream = {
-    onMessage: (data: {
-        message: string;
-    }) => void;
-    onEnd?: () => void;
-    onWarn?: (error: any) => void;
-    onError?: (error: any) => void;
-};
-export declare class Llama3CppCompletion {
-    core: Llama3Cpp;
-    config: Config;
-    constructor(core: Llama3Cpp);
-    setConfig(config: Partial<Config>): void;
-    completion(params: {
-        options?: Options;
-        messages: Message[];
-    }): {
-        run: () => Promise<{
-            message: string;
-            fullMessage: string;
-        }>;
-        cancel: () => void;
-    };
-    completionStream(params: Stream & {
-        messages: Message[];
-        options?: Options;
-    }): {
-        cancel: () => void;
-    };
-    talk(params: {
-        options?: Options;
-        messages: Message[];
-        response_format?: {
-            type: 'json_object';
-            schema: any;
-        };
-    }): {
-        run: () => Promise<{
-            message: string;
-        }>;
-        cancel: () => void;
-    };
-    talkStream(params: Stream & {
-        options?: Options;
-        messages: Message[];
-    }): {
-        cancel: () => void;
-    };
-}
-export {};

package/types/lib/service/llama3.cpp/index.d.ts

@@ -1,19 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { Llama3CppCompletion, Config } from './completion';
-export declare class Llama3Cpp {
-    _axios: AxiosInstance;
-    static createChatRequest(params: {
-        config: Partial<Config> | (() => Promise<Partial<Config>>);
-        talkOptions?: any;
-    }): (messages: any[], { schema, onCancel }: any) => Promise<string>;
-    /**
-     * @zh 如果你有需要特別設定 axios，請使用這方法。
-     * @en If you need to set axios, please use this method.
-     */
-    setAxios(axios: AxiosInstance): void;
-    /**
-     * @zh 建立 補強/ 對話物件。
-     * @en Create completion object.
-     */
-    createCompletion(): Llama3CppCompletion;
-}

package/types/lib/service/openai/chat.d.ts

@@ -1,110 +0,0 @@
-import { OpenAI } from './index';
-import { PromiseResponseType } from '../../types';
-export type ChatGPTMessage = {
-    role: 'system' | 'user' | 'assistant';
-    name?: string;
-    content: string;
-};
-type ApiResponse = {
-    id: string;
-    object: string;
-    created: number;
-    choices: Array<{
-        index: number;
-        finish_reason: string;
-        message: {
-            role: 'system' | 'user' | 'assistant';
-            name?: string;
-            content: string;
-        };
-    }>;
-    usage: {
-        prompt_tokens: number;
-        completion_tokens: number;
-        total_tokens: number;
-    };
-};
-export type Config = {
-    /**
-     * @zh 一次回應數量
-     * @en How many chat completion choices to generate for each input message.
-     */
-    n: number;
-    /**
-     * @zh 選擇運行的模型，16k意味著能處理長度為 16,384 的文本，32k意味著能處理長度為 32768 的文本。
-     * @en How many chat completion choices to generate for each input message.
-     */
-    model: 'gpt-4' | 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'o1-preview' | 'o1' | 'o1-mini';
-    /**
-     * @zh 冒險指數，數值由 0 ~ 2 之間，越低回應越穩定。
-     * @en What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
-     */
-    temperature: number;
-    /**
-     * @zh 是否強制要回傳 JSON 格式的資料
-     * @en Whether to force the return of JSON format data
-     */
-    forceJsonFormat: boolean;
-    /**
-     * @zh 每次對話最多產生幾個 tokens。
-     * @en How many tokens to complete to.
-     */
-    maxTokens?: number;
-};
-export declare class OpenAIChat {
-    openai: OpenAI;
-    config: Config;
-    constructor(openai: OpenAI);
-    /**
-     * @zh 改變對話的一些設定
-     * @en Change some settings of the conversation
-     */
-    setConfig(options: Partial<Config>): void;
-    /**
-     * @zh 檢視內容是否符合 OpenAI 的審查
-     * @en View content for OpenAI moderation
-     */
-    moderations(input: string): Promise<{
-        isSafe: boolean;
-        result: any;
-    }>;
-    /**
-     * @zh 進行對話
-     * @en Talk to the AI
-     */
-    talk(messages?: ChatGPTMessage[], options?: {
-        /** 要 forceJsonFormat 為 true 才會生效 */
-        jsonSchema?: any;
-        abortController?: AbortController;
-    }): Promise<{
-        id: string;
-        text: string;
-        newMessages: ChatGPTMessage[];
-        isDone: boolean;
-        apiReseponse: ApiResponse;
-    }>;
-    talkStream(params: {
-        messages: any[];
-        onMessage: (message: string) => void;
-        onEnd: () => void;
-        onWarn: (warn: any) => void;
-        onError: (error: any) => void;
-    }): {
-        cancel: () => void;
-    };
-    /**
-     * @zh 開啟持續性對話
-     */
-    keepTalk(prompt: string | string[], oldMessages?: ChatGPTMessage[]): Promise<{
-        result: {
-            id: string;
-            text: string;
-            newMessages: ChatGPTMessage[];
-            isDone: boolean;
-            apiReseponse: ApiResponse;
-        };
-        nextTalk: (prompt: string | string[]) => Promise<any>;
-    }>;
-}
-export type OpenAIChatTalkResponse = PromiseResponseType<OpenAIChat['talk']>;
-export {};