ctod 0.7.1 → 0.7.2

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

@@ -0,0 +1,67 @@
+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: ValidateCallbackOutputs<S, ReturnType<S>>;
+        prompt: string;
+    }>;
+    getValidate(): {
+        input: S | undefined;
+        output: O;
+    };
+    changeOutputSchema(schema: O): void;
+    /**
+     * @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"] : ReturnType<O>[K]; } : never;
+        parserName: string;
+        parserFails: {
+            name: string;
+            error: any;
+        }[];
+    }>;
+}

package/types/lib/ctod.d.ts

@@ -0,0 +1,32 @@
+import { ChatBroker, Message, Params as ChatBrokerParams, ChatBrokerHooks, RequestContext } from './broker/chat';
+import { ChatBrokerPlugin } from './core/plugin';
+import { Schema } from 'yup';
+import * as Yup from 'yup';
+type IO = any;
+export declare class CtoD<P extends ChatBrokerPlugin<IO, IO>, PS extends Record<string, ReturnType<P['use']>>> {
+    params: {
+        request: (messages: Message[], context: RequestContext) => Promise<string>;
+        plugins?: (() => PS) | undefined;
+    };
+    constructor(params: {
+        request: (messages: Message[], context: RequestContext) => Promise<string>;
+        plugins?: () => PS;
+    });
+    createBrokerBuilder<I extends Record<string, any>>(params?: {
+        install?: ChatBrokerParams<() => I, IO, ChatBrokerHooks<() => I, IO, P, PS>, P, PS>['install'];
+    }): {
+        create: <O extends Record<string, Schema<any, any, any, "">>>(install: (context: {
+            id: string;
+            yup: typeof Yup;
+            data: I;
+            plugins: { [K in keyof PS]: {
+                send: (data: PS[K]["__receiveData"]) => void;
+            }; };
+            setMessages: (messages: (Omit<Message, 'content'> & {
+                content: string | string[];
+            })[]) => void;
+            metadata: Map<string, any>;
+        }) => Promise<O>) => ChatBroker<() => I, () => O, P, PS, ChatBrokerHooks<() => I, () => O, P, PS>>;
+    };
+}
+export {};

package/types/lib/index.d.ts

@@ -0,0 +1,34 @@
+export * as plugins from './plugins';
+export * as templates from './templates';
+export { CtoD } from './ctod';
+export { validateToJsonSchema, defineYupSchema, ValidateCallback } 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 { CtoD } from './ctod';
+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: {
+    CtoD: typeof 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

@@ -0,0 +1,47 @@
+/**
+ * @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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,61 @@
+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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,110 @@
+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 {};

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

@@ -0,0 +1,59 @@
+import { OpenAI } from './index';
+import { PromiseResponseType } from '../../types';
+declare type Config = {
+    /**
+     * @zh 一次回應數量
+     * @en How many chat completion choices to generate for each input message.
+     */
+    n: number;
+    /**
+     * @zh 最長回應長度，最大值為 4096。
+     * @en The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096).
+     * @see https://platform.openai.com/tokenizer
+     */
+    maxTokens: number;
+    /**
+     * @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;
+};
+declare type ApiResponse = {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: Array<{
+        text: string;
+        index: number;
+        logprobs: any;
+        finish_reason: string;
+    }>;
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+};
+export declare class OpenAICompletion {
+    private openai;
+    private config;
+    constructor(openai: OpenAI);
+    /**
+     * @zh 改變對話的一些設定。
+     * @en Change some settings of the chat.
+     */
+    setConfig(options: Partial<Config>): void;
+    /**
+     * @zh 進行補文。
+     * @en Do completion.
+     */
+    run(prompt: string | string[]): Promise<{
+        id: string;
+        text: string;
+        isDone: boolean;
+        apiReseponse: ApiResponse;
+    }>;
+}
+export declare type OpenAiOpenAICompletionResponse = PromiseResponseType<OpenAICompletion['run']>;
+export {};

package/types/lib/service/openai/images-generation.d.ts

@@ -0,0 +1,35 @@
+import { OpenAI } from './index';
+type ApiResponse = {
+    created: string;
+    data: {
+        b64_json: string;
+    }[];
+};
+type Config = {
+    /**
+     * @zh 模型，支援 dall-e-2 和 dall-e-3
+     * @en Model, support dall-e-2 and dall-e-3
+     */
+    model: 'dall-e-2' | 'dall-e-3';
+    /**
+     * @zh 解析度，例如 1024x1024
+     * @en Resolution, for example 1024x1024
+     */
+    size: `${number}x${number}`;
+};
+export declare class OpenAIImagesGeneration {
+    private openai;
+    private config;
+    constructor(openai: OpenAI);
+    /**
+     * @zh 改變對話的一些設定
+     * @en Change some settings of the conversation
+     */
+    setConfig(options: Partial<Config>): void;
+    /**
+     * @zh 產生圖片
+     * @en Generate image
+     */
+    create(prompt: string): Promise<ApiResponse>;
+}
+export {};

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

@@ -0,0 +1,29 @@
+import { OpenAIVision } from './vision';
+import { OpenAIChat, Config } from './chat';
+import { OpenAIImagesGeneration } from './images-generation';
+export declare class OpenAI {
+    _axios: import("axios").AxiosInstance;
+    _apiKey: string;
+    static createChatRequest(apiKey: string | (() => Promise<string>), config?: Partial<Config> | (() => Promise<Partial<Config>>), options?: {
+        axios?: any;
+    }): (messages: any[], { onCancel }: any) => Promise<string>;
+    static createChatRequestWithJsonSchema(params: {
+        axios?: any;
+        apiKey: string | (() => Promise<string>);
+        config?: Partial<Pick<Config, 'model' | 'temperature'>> | (() => Promise<Partial<Pick<Config, 'model' | 'temperature'>>>);
+    }): (messages: any[], { schema, onCancel }: any) => Promise<string>;
+    constructor(apiKey?: string);
+    /**
+     * @zh 如果你有需要特別設定 axios，請使用這方法。
+     * @en If you need to set axios, please use this method.
+     */
+    setAxios(axios: any): void;
+    /**
+     * @zh 設定 api key。
+     * @en Set api key.
+     */
+    setConfiguration(apiKey: string): void;
+    createChat(): OpenAIChat;
+    createVision(): OpenAIVision;
+    createImagesGeneration(): OpenAIImagesGeneration;
+}

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

@@ -0,0 +1,74 @@
+import { OpenAI } from './index';
+import { PromiseResponseType } from '../../types';
+type ImageContent = {
+    type: 'image_url' | 'text';
+    text?: string;
+    image_url?: {
+        url: string;
+        detail?: string;
+    };
+};
+type VisionMessage = {
+    role: 'system' | 'user' | 'assistant';
+    name?: string;
+    content: string | ImageContent[];
+};
+type ApiResponse = {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+    choices: Array<{
+        message: {
+            role: string;
+            content: string;
+        };
+        finish_details: {
+            type: string;
+        };
+        index: number;
+    }>;
+};
+export type Config = {
+    /**
+     * @zh 選擇運行的模型。
+     * @en How many chat completion choices to generate for each input message.
+     */
+    model: 'gpt-4-vision-preview';
+    /**
+     * @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 每次對話最多產生幾個 tokens。
+     * @en How many tokens to complete to.
+     */
+    maxTokens?: number;
+};
+export declare class OpenAIVision {
+    openai: OpenAI;
+    config: Config;
+    constructor(openai: OpenAI);
+    /**
+     * @zh 改變對話的一些設定
+     * @en Change some settings of the conversation
+     */
+    setConfig(options: Partial<Config>): void;
+    /**
+     * @zh 辨識圖片
+     * @en Recognize images
+     */
+    view(messages: VisionMessage[]): Promise<{
+        id: string;
+        text: string;
+        apiReseponse: ApiResponse;
+    }>;
+}
+export type OpenAIChatVisionResponse = PromiseResponseType<OpenAIVision['view']>;
+export {};

package/types/lib/templates.d.ts

@@ -0,0 +1,20 @@
+type JsonResponseFormat = {
+    desc: string;
+    example: any;
+};
+/**
+ * @zh 協助使用者將格式需求轉成論敘語句。
+ * @en Assist the user in converting the formatting requirements into declarative sentences.
+ */
+export declare const requireJsonResponse: (question: string | string[], format: Record<string, JsonResponseFormat>) => string;
+/**
+ * @zh 協助使用者將格式需求轉成論敘語句，支援 Handlebars。
+ * @en Assist the user in converting the formatting requirements into declarative sentences, support Handlebars.
+ */
+export declare const requireJsonResponseWithHandlebars: (value: Record<string, any>, question: string | string[], format: Record<string, JsonResponseFormat>) => string;
+/**
+ * @zh 協助使用者將格式需求轉成論敘語句，並支援 Json Schema。
+ * @en Assist the user in converting the formatting requirements into declarative sentences, and support Json Schema.
+ */
+export declare const requireJsonResponseWithJsonSchema: (question: string | string[], format: Record<string, any>) => string;
+export {};

package/types/lib/types.d.ts

@@ -0,0 +1 @@
+export type PromiseResponseType<T extends (...args: any) => Promise<any>, R = Parameters<ReturnType<T>['then']>[0]> = R extends (value: infer P) => any ? P : never;

package/types/lib/utils/error.d.ts

@@ -0,0 +1,11 @@
+type ParserFail = {
+    name: string;
+    error: any;
+};
+export declare class ParserError {
+    isParserError: boolean;
+    parserFails: ParserFail[];
+    error: any;
+    constructor(error: any, parserFails: ParserFail[]);
+}
+export {};