ctod 0.1.5 → 0.3.0

package/examples/chatgpt3.5.ts

@@ -1,42 +0,0 @@
-import { flow } from 'power-helper'
-import { prompt } from 'inquirer'
-import { ChatGPT35 } from '../lib/index'
-
-/**
- * @zh 這裡示範如何透過 ChatGPT35 持續對話
- * @en Here is a demonstration of how to use ChatGPT35Broker to obtain the best index from the user's queries.
- * @test npx ts-node ./examples/chatgpt3.5.ts
- */
-
-flow.run(async() => {
-    const { apiKey } = await prompt([
-        {
-            type: 'input',
-            name: 'apiKey',
-            message: 'Please enter API key.',
-            default: ''
-        }
-    ])
-    if (!apiKey) {
-        throw new Error('Unable to find API key.')
-    }
-    let bot = new ChatGPT35()
-    let talk = bot.chat.bind(bot)
-    bot.setConfiguration(apiKey)
-    await flow.asyncWhile(async({ count, doBreak }) => {
-        if (count >= 99) {
-            return doBreak()
-        }
-        const { text } = await prompt([
-            {
-                type: 'input',
-                name: 'text',
-                message: 'Please enter what you want to say.',
-                default: ''
-            }
-        ])
-        const response = await talk(text)
-        talk = response.nextTalk
-        console.log('AI:', response.result.text)
-    })
-})

package/examples/utils/index.ts

@@ -1,56 +0,0 @@
-import fs from 'fs'
-import { Buffer } from 'buffer'
-import { prompt } from 'inquirer'
-
-type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'latin1' | 'binary' | 'hex'
-
-/**
- * @zh 你可以透過在根目錄中加入 .key 檔案，來自動讀取 API key
- * @en You can automatically read the API key by adding the .key file in the root directory.
- */
-
-export const getKey = async() => {
-    let apiKey = ''
-    let keyFile = './.key'
-    if (fs.existsSync(keyFile)) {
-        apiKey = fs.readFileSync('./.key').toString()
-    }
-    if (!apiKey) {
-        const { inputApiKey } = await prompt([
-            {
-                type: 'input',
-                name: 'inputApiKey',
-                message: 'Please enter API key.',
-                default: ''
-            }
-        ])
-        apiKey = inputApiKey
-    }
-    if (!apiKey) {
-        throw new Error('Unable to find API key.')
-    }
-    return apiKey
-}
-
-/**
- * @zh 定義輸出資料夾位置
- * @en Define the output folder location
- */
-
-export const definedOutputDir = (dirName: string) => {
-    let dir = `.output/${dirName}`
-    if (fs.existsSync(dir) === false) {
-        fs.mkdirSync(dir, {
-            recursive: true
-        })
-    }
-    return {
-        write(fileName: string, content: Buffer | string | Record<any, any>, encode: BufferEncoding = 'utf-8') {
-            let data = content
-            if (Buffer.isBuffer(content) === false && typeof content !== 'string') {
-                data = JSON.stringify(content, null, 4)
-            }
-            fs.writeFileSync(`${dir}/${fileName}`, data, encode)
-        }
-    }
-}

package/lib/broker/3.ts

@@ -1,160 +0,0 @@
-import { flow } from 'power-helper'
-import { Translator } from '../core/translator'
-import { BaseBroker } from './index'
-import { Broker3Plugin } from '../core/plugin'
-import { ChatGPT3, ChatGPT3TalkResponse } from '../service/chatgpt3'
-import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate'
-
-export class ChatGPT3Broker<
-    S extends ValidateCallback<any>,
-    O extends ValidateCallback<any>,
-    P extends Broker3Plugin<any, any>,
-    PS extends Record<string, ReturnType<P['use']>>
-    > extends BaseBroker<S, O, P, PS, {
-
-        /**
-         * @zh 發送聊天訊息給機器人前觸發
-         * @en Triggered before sending chat message to bot
-         */
-
-        talkBefore: {
-            id: string
-            data: ValidateCallbackOutputs<S>
-            prompt: string
-            plugins: {
-                [K in keyof PS]: {
-                    send: (data: PS[K]['__receiveData']) => void
-                }
-            }
-        }
-
-        /**
-         * @zh 當聊天機器人回傳資料的時候觸發
-         * @en Triggered when the chatbot returns data
-         */
-
-        talkAfter: {
-            id: string
-            data: ValidateCallbackOutputs<S>
-            prompt: string
-            response: ChatGPT3TalkResponse
-            parseText: string
-            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
-            count: number
-            retry: () => void
-            response: ChatGPT3TalkResponse
-            parserFails: { name: string, error: any }[]
-            changePrompt: (text: string) => void
-        }
-
-        /**
-         * @zh 不論成功失敗，執行結束的時候會執行。
-         * @en It will be executed when the execution is completed, regardless of success or failure.
-         */
-
-        done: {
-            id: string
-        }
-    }> {
-
-    bot: ChatGPT3 = new ChatGPT3()
-
-    /**
-     * @zh 將請求發出至聊天機器人。
-     * @en Send request to chatbot.
-     */
-
-    async request<T extends Translator<S, O>>(data: T['__schemeType']): Promise<T['__outputType']> {
-        this._install()
-        let id = flow.createUuid()
-        let output: any = null
-        let question = await this.translator.compile(data)
-        await flow.asyncWhile(async ({ count, doBreak }) => {
-            if (count >= 10) {
-                return doBreak()
-            }
-            let response: ChatGPT3TalkResponse = null as any
-            let parseText = ''
-            let retryFlag = false
-            let plugins = {} as any
-            for (let key in this.plugins) {
-                plugins[key] = {
-                    send: (data: any) => this.plugins[key].send({
-                        id,
-                        data
-                    })
-                }
-            }
-            try {
-                await this.hook.notify('talkBefore', {
-                    id,
-                    data,
-                    plugins,
-                    prompt: question.prompt
-                })
-                response = await this.bot.talk(question.prompt)
-                parseText = response.text
-                await this.hook.notify('talkAfter', {
-                    id,
-                    data,
-                    prompt: question.prompt,
-                    response,
-                    parseText,
-                    changeParseText: text => {
-                        parseText = text
-                    }
-                })
-                output = (await this.translator.parse(parseText)).output
-                await this.hook.notify('succeeded', {
-                    id,
-                    output
-                })
-                await this.hook.notify('done', { id })
-                doBreak()
-            } catch (error: any) {
-                // 如果解析錯誤，可以選擇是否重新解讀
-                if (error.isParserError) {
-                    await this.hook.notify('parseFailed', {
-                        id,
-                        error: error.error,
-                        count,
-                        response,
-                        parserFails: error.parserFails,
-                        retry: () => {
-                            retryFlag = true
-                        },
-                        changePrompt: (text) => {
-                            question.prompt = text
-                        }
-                    })
-                    if (retryFlag === false) {
-                        return doBreak()
-                    }
-                }
-                await this.hook.notify('done', { id })
-                throw error
-            }
-        })
-        return output
-    }
-}

package/lib/broker/35.ts

@@ -1,207 +0,0 @@
-import { flow } from 'power-helper'
-import { BaseBroker } from './index'
-import { Translator } from '../core/translator'
-import { Broker35Plugin } from '../core/plugin'
-import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate'
-import { ChatGPT35, ChatGPT35Message, ChatGPT35TalkResponse } from '../service/chatgpt35'
-
-export class ChatGPT35Broker<
-    S extends ValidateCallback<any>,
-    O extends ValidateCallback<any>,
-    P extends Broker35Plugin<any, any>,
-    PS extends Record<string, ReturnType<P['use']>>
-    > extends BaseBroker<S, O, P, PS, {
-
-        /**
-         * @zh 第一次聊天的時候觸發
-         * @en Triggered when chatting for the first time
-         */
-
-        talkFirst: {
-            id: string
-            data: ValidateCallbackOutputs<S>
-            plugins: {
-                [K in keyof PS]: {
-                    send: (data: PS[K]['__receiveData']) => void
-                }
-            }
-            messages: ChatGPT35Message[]
-            setPreMessages: (messages: ChatGPT35Message[]) => void
-            changeMessages: (messages: ChatGPT35Message[]) => void
-        }
-
-        /**
-         * @zh 發送聊天訊息給機器人前觸發
-         * @en Triggered before sending chat message to bot
-         */
-
-        talkBefore: {
-            id: string
-            data: ValidateCallbackOutputs<S>
-            messages: ChatGPT35Message[]
-            lastUserMessage: string
-        }
-
-        /**
-         * @zh 當聊天機器人回傳資料的時候觸發
-         * @en Triggered when the chatbot returns data
-         */
-
-        talkAfter: {
-            id: string
-            data: ValidateCallbackOutputs<S>
-            response: ChatGPT35TalkResponse
-            messages: ChatGPT35Message[]
-            parseText: string
-            lastUserMessage: string
-            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: ChatGPT35TalkResponse
-            parserFails: { name: string, error: any }[]
-            messages: ChatGPT35Message[]
-            lastUserMessage: string
-            changeMessages: (messages: ChatGPT35Message[]) => void
-        }
-
-        /**
-         * @zh 不論成功失敗，執行結束的時候會執行。
-         * @en It will be executed when the execution is completed, regardless of success or failure.
-         */
-
-        done: {
-            id: string
-        }
-    }> {
-    bot: ChatGPT35 = new ChatGPT35()
-
-    /**
-     * @zh 將請求發出至聊天機器人。
-     * @en Send request to chatbot.
-     */
-
-    async request<T extends Translator<S, O>>(data: T['__schemeType']): Promise<T['__outputType']> {
-        this._install()
-        let id = flow.createUuid()
-        let output: any = null
-        let plugins = {} as any
-        let question = await this.translator.compile(data)
-        let messages: ChatGPT35Message[] = [
-            {
-                role: 'user',
-                content: question.prompt
-            }
-        ]
-        for (let key in this.plugins) {
-            plugins[key] = {
-                send: (data: any) => this.plugins[key].send({
-                    id,
-                    data
-                })
-            }
-        }
-        await this.hook.notify('talkFirst', {
-            id,
-            data,
-            plugins,
-            messages,
-            setPreMessages: ms => {
-                messages = [
-                    ...ms,
-                    {
-                        role: 'user',
-                        content: question.prompt
-                    }
-                ]
-            },
-            changeMessages: ms => {
-                messages = ms
-            }
-        })
-        await flow.asyncWhile(async ({ count, doBreak }) => {
-            if (count >= 10) {
-                return doBreak()
-            }
-            let response: ChatGPT35TalkResponse = null as any
-            let parseText = ''
-            let retryFlag = false
-            let lastUserMessage = messages.filter(e => e.role === 'user').slice(-1)[0]?.content || ''
-            try {
-                await this.hook.notify('talkBefore', {
-                    id,
-                    data,
-                    messages,
-                    lastUserMessage
-                })
-                response = await this.bot.talk(messages)
-                parseText = response.text
-                await this.hook.notify('talkAfter', {
-                    id,
-                    data,
-                    response,
-                    parseText,
-                    messages: response.newMessages,
-                    lastUserMessage,
-                    changeParseText: text => {
-                        parseText = text
-                    }
-                })
-                messages = response.newMessages
-                output = (await this.translator.parse(parseText)).output
-                await this.hook.notify('succeeded', {
-                    id,
-                    output
-                })
-                await this.hook.notify('done', { id })
-                doBreak()
-            } catch (error: any) {
-                // 如果解析錯誤，可以選擇是否重新解讀
-                if (error.isParserError) {
-                    await this.hook.notify('parseFailed', {
-                        id,
-                        error: error.error,
-                        count,
-                        response,
-                        messages,
-                        lastUserMessage,
-                        parserFails: error.parserFails,
-                        retry: () => {
-                            retryFlag = true
-                        },
-                        changeMessages: ms => {
-                            messages = ms
-                        }
-                    })
-                    if (retryFlag === false) {
-                        await this.hook.notify('done', { id })
-                        throw error
-                    }
-                } else {
-                    await this.hook.notify('done', { id })
-                    throw error
-                }
-            }
-        })
-        return output
-    }
-}

package/lib/broker/index.ts

@@ -1,83 +0,0 @@
-import { Hook, Log } from 'power-helper'
-import { ChatGPT3 } from '../service/chatgpt3'
-import { ChatGPT35 } from '../service/chatgpt35'
-import { TextParser } from '../core/parser'
-import { ValidateCallback } from '../utils/validate'
-import { Translator, TranslatorParams } from '../core/translator'
-import { Broker3Plugin, Broker35Plugin } from '../core/plugin'
-
-export type Params<
-    S extends ValidateCallback<any>,
-    O extends ValidateCallback<any>,
-    C extends Record<string, any>,
-    P extends Broker3Plugin<any, any> | Broker35Plugin<any, any>,
-    PS extends Record<string, ReturnType<P['use']>>
-> = Omit<TranslatorParams<S, O>, 'parsers'> & {
-    name?: string
-    plugins?: PS | (() => PS)
-    install: (context: {
-        log: Log
-        bot: ChatGPT3 | ChatGPT35
-        attach: Hook<C>['attach']
-        attachAfter: Hook<C>['attachAfter']
-        translator: Translator<S, O>
-    }) => void
-}
-
-export class BaseBroker<
-    S extends ValidateCallback<any>,
-    O extends ValidateCallback<any>,
-    P extends Broker3Plugin<any, any> | Broker35Plugin<any, any>,
-    PS extends Record<string, ReturnType<P['use']>>,
-    C extends Record<string, any>
-> {
-    protected __hookType!: C
-    protected log: Log
-    protected hook = new Hook<C>()
-    protected bot!: ChatGPT3 | ChatGPT35
-    protected params: Params<S, O, C, P, PS>
-    protected plugins = {} as PS
-    protected installed = false
-    protected translator: Translator<S, O>
-
-    constructor(params: Params<S, O, C, P, PS>) {
-        this.log = new Log(params.name ?? 'no name')
-        this.params = params
-        this.translator = new Translator({
-            ...params,
-            parsers: [
-                TextParser.JsonMessage()
-            ]
-        })
-    }
-
-    protected _install(): any {
-        if (this.installed === false) {
-            this.installed = true
-            if (this.bot) {
-                const context = {
-                    bot: this.bot,
-                    log: this.log,
-                    attach: this.hook.attach.bind(this.hook),
-                    attachAfter: this.hook.attachAfter.bind(this.hook),
-                    translator: this.translator
-                }
-                this.params.install(context)
-                if (this.params.plugins) {
-                    this.plugins = typeof this.params.plugins === 'function' ? this.params.plugins() : this.params.plugins
-                    for (let key in this.plugins) {
-                        this.plugins[key].instance._params.onInstall({
-                            ...context,
-                            params: this.plugins[key].params,
-                            receive: this.plugins[key].receive
-                        })
-                    }
-                }
-            }
-        }
-    }
-
-    protected request(_data: any): any {
-        throw Error('DON\'T CALL THIS!')
-    }
-}

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

@@ -1,71 +0,0 @@
-import { Translator } from '../core/translator';
-import { BaseBroker } from './index';
-import { Broker3Plugin } from '../core/plugin';
-import { ChatGPT3, ChatGPT3TalkResponse } from '../service/chatgpt3';
-import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate';
-export declare class ChatGPT3Broker<S extends ValidateCallback<any>, O extends ValidateCallback<any>, P extends Broker3Plugin<any, any>, PS extends Record<string, ReturnType<P['use']>>> extends BaseBroker<S, O, P, PS, {
-    /**
-     * @zh 發送聊天訊息給機器人前觸發
-     * @en Triggered before sending chat message to bot
-     */
-    talkBefore: {
-        id: string;
-        data: ValidateCallbackOutputs<S>;
-        prompt: string;
-        plugins: {
-            [K in keyof PS]: {
-                send: (data: PS[K]['__receiveData']) => void;
-            };
-        };
-    };
-    /**
-     * @zh 當聊天機器人回傳資料的時候觸發
-     * @en Triggered when the chatbot returns data
-     */
-    talkAfter: {
-        id: string;
-        data: ValidateCallbackOutputs<S>;
-        prompt: string;
-        response: ChatGPT3TalkResponse;
-        parseText: string;
-        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;
-        count: number;
-        retry: () => void;
-        response: ChatGPT3TalkResponse;
-        parserFails: {
-            name: string;
-            error: any;
-        }[];
-        changePrompt: (text: string) => void;
-    };
-    /**
-     * @zh 不論成功失敗，執行結束的時候會執行。
-     * @en It will be executed when the execution is completed, regardless of success or failure.
-     */
-    done: {
-        id: string;
-    };
-}> {
-    bot: ChatGPT3;
-    /**
-     * @zh 將請求發出至聊天機器人。
-     * @en Send request to chatbot.
-     */
-    request<T extends Translator<S, O>>(data: T['__schemeType']): Promise<T['__outputType']>;
-}

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

@@ -1,30 +0,0 @@
-import { Hook, Log } from 'power-helper';
-import { ChatGPT3 } from '../service/chatgpt3';
-import { ChatGPT35 } from '../service/chatgpt35';
-import { ValidateCallback } from '../utils/validate';
-import { Translator, TranslatorParams } from '../core/translator';
-import { Broker3Plugin, Broker35Plugin } from '../core/plugin';
-export declare type Params<S extends ValidateCallback<any>, O extends ValidateCallback<any>, C extends Record<string, any>, P extends Broker3Plugin<any, any> | Broker35Plugin<any, any>, PS extends Record<string, ReturnType<P['use']>>> = Omit<TranslatorParams<S, O>, 'parsers'> & {
-    name?: string;
-    plugins?: PS | (() => PS);
-    install: (context: {
-        log: Log;
-        bot: ChatGPT3 | ChatGPT35;
-        attach: Hook<C>['attach'];
-        attachAfter: Hook<C>['attachAfter'];
-        translator: Translator<S, O>;
-    }) => void;
-};
-export declare class BaseBroker<S extends ValidateCallback<any>, O extends ValidateCallback<any>, P extends Broker3Plugin<any, any> | Broker35Plugin<any, any>, PS extends Record<string, ReturnType<P['use']>>, C extends Record<string, any>> {
-    protected __hookType: C;
-    protected log: Log;
-    protected hook: import("power-helper/dist/modules/hook").Hook<C>;
-    protected bot: ChatGPT3 | ChatGPT35;
-    protected params: Params<S, O, C, P, PS>;
-    protected plugins: PS;
-    protected installed: boolean;
-    protected translator: Translator<S, O>;
-    constructor(params: Params<S, O, C, P, PS>);
-    protected _install(): any;
-    protected request(_data: any): any;
-}