ctod 0.0.4 → 0.0.6

package/lib/broker/35.ts

@@ -1,43 +1,100 @@
 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>
-    > extends BaseBroker<S, O, {
+    > extends BaseBroker<S, O, Broker35Plugin<any>, {
+
+        /**
+         * @zh 第一次聊天的時候觸發
+         * @en Triggered when chatting for the first time
+         */
+
         talkFirst: {
+            id: string
             data: ValidateCallbackOutputs<S>
             messages: ChatGPT35Message[]
             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 question = await this.translator.compile(data)
         let messages: ChatGPT35Message[] = [
@@ -46,7 +103,8 @@ export class ChatGPT35Broker<
                 content: question.prompt
             }
         ]
-        await this.notify('talkFirst', {
+        await this.hook.notify('talkFirst', {
+            id,
             data,
             messages,
             changeMessages: ms => {
@@ -60,33 +118,45 @@ export class ChatGPT35Broker<
             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.notify('talkBefore', {
+                await this.hook.notify('talkBefore', {
+                    id,
                     data,
-                    messages
+                    messages,
+                    lastUserMessage
                 })
                 response = await this.bot.talk(messages)
                 parseText = response.text
-                await this.notify('talkAfter', {
+                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(response.text)).output
+                await this.hook.notify('succeeded', {
+                    id,
+                    output
+                })
+                await this.hook.notify('done', { id })
                 doBreak()
             } catch (error: any) {
                 // 如果解析錯誤，可以選擇是否重新解讀
                 if (error.isParserError) {
-                    await this.notify('parseFailed', {
+                    await this.hook.notify('parseFailed', {
+                        id,
                         error: error.error,
                         count,
                         response,
                         messages,
+                        lastUserMessage,
                         parserFails: error.parserFails,
                         retry: () => {
                             retryFlag = true
@@ -99,6 +169,7 @@ export class ChatGPT35Broker<
                         return doBreak()
                     }
                 }
+                await this.hook.notify('done', { id })
                 throw error
             }
         })

package/lib/broker/index.ts

@@ -4,15 +4,19 @@ 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>
+    C extends Record<string, any>,
+    P extends Broker3Plugin<any> | Broker35Plugin<any>
 > = Omit<TranslatorParams<S, O>, 'parsers'> & {
+    plugins?: ReturnType<P['use']>[]
     install: (context: {
         bot: ChatGPT3 | ChatGPT35
         attach: Hook<C>['attach']
+        attachAfter: Hook<C>['attachAfter']
         translator: Translator<S, O>
     }) => void
 }
@@ -20,15 +24,17 @@ export type Params<
 export class BaseBroker<
     S extends ValidateCallback<any>,
     O extends ValidateCallback<any>,
+    P extends Broker3Plugin<any> | Broker35Plugin<any>,
     C extends Record<string, any>
-> extends Hook<C> {
+> {
+    protected hook = new Hook<C>()
     protected bot!: ChatGPT3 | ChatGPT35
-    protected params: Params<S, O, C>
+    protected params: Params<S, O, C, P>
     protected installed = false
     protected translator: Translator<S, O>
+    protected __hookType!: C
 
-    constructor(params: Params<S, O, C>) {
-        super()
+    constructor(params: Params<S, O, C, P>) {
         this.params = params
         this.translator = new Translator({
             ...params,
@@ -42,11 +48,21 @@ export class BaseBroker<
         if (this.installed === false) {
             this.installed = true
             if (this.bot) {
-                this.params.install({
+                const context = {
                     bot: this.bot,
-                    attach: this.attach.bind(this),
+                    attach: this.hook.attach.bind(this.hook),
+                    attachAfter: this.hook.attachAfter.bind(this.hook),
                     translator: this.translator
-                })
+                }
+                if (this.params.plugins) {
+                    for (let plugin of this.params.plugins) {
+                        plugin.instance._params.onInstall({
+                            ...context as any,
+                            params: plugin.params
+                        })
+                    }
+                }
+                this.params.install(context)
             }
         }
     }

package/lib/core/parser.ts

@@ -2,11 +2,13 @@ import JSON5 from 'json5'
 
 type TextParserParams = {
     /**
-     * 解讀器名字 
+     * @zh 解讀器名字。
+     * @en The name of the parser. 
      */
     name: string
     /**
-     * 解讀文本
+     * @zh 解讀文本。
+     * @en Read the text.
      */
     handler: (text: string) => Promise<any>
 }
@@ -15,7 +17,8 @@ export class TextParser {
     private params: TextParserParams
 
     /**
-     * 盡可能將文字內的 json 解讀出來
+     * @zh 盡可能將文字內的 json 解讀出來。
+     * @en Try to read the json in the text as much as possible.
      */
 
     static JsonMessage() {
@@ -34,7 +37,8 @@ export class TextParser {
     }
 
     /**
-     * 解讀器名字 
+     * @zh 解讀器名字。
+     * @en The name of the parser. 
      */
 
     get name() {
@@ -42,7 +46,8 @@ export class TextParser {
     }
 
     /**
-     * 解讀文本
+     * @zh 解讀文本。
+     * @en Read the text.
      */
 
     async read(text: string) {

package/lib/core/plugin.ts

@@ -0,0 +1,64 @@
+import { Hook } from 'power-helper'
+import { ChatGPT3 } from '../service/chatgpt3'
+import { ChatGPT35 } from '../service/chatgpt35'
+import { ChatGPT3Broker } from '../broker/3'
+import { ChatGPT35Broker } from '../broker/35'
+import { Translator } from './translator'
+import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate'
+
+// 3
+
+type Broker3Hooks = ChatGPT3Broker<any, any>['__hookType']
+type Broker3PluginParams<T extends ValidateCallback<any>> = {
+    name: string
+    params: T
+    onInstall: (context: {
+        bot: ChatGPT3
+        params: ValidateCallbackOutputs<T>
+        attach: Hook<Broker3Hooks>['attach']
+        attachAfter: Hook<Broker3Hooks>['attachAfter']
+        translator: Translator<any, any>
+    }) => void
+}
+
+export class Broker3Plugin<T extends ValidateCallback<any>> {
+    _params: Broker3PluginParams<T>
+    constructor(params: Broker3PluginParams<T>) {
+        this._params = params
+    }
+    use(params: ValidateCallbackOutputs<T>) {
+        return {
+            instance: this as any,
+            params
+        }
+    }
+}
+
+// 3.5
+
+type Broker35Hooks = ChatGPT35Broker<any, any>['__hookType']
+type Broker35PluginParams<T extends ValidateCallback<any>> = {
+    name: string
+    params: T
+    onInstall: (context: {
+        bot: ChatGPT35
+        params: ValidateCallbackOutputs<T>
+        attach: Hook<Broker35Hooks>['attach']
+        attachAfter: Hook<Broker35Hooks>['attachAfter']
+        translator: Translator<any, any>
+    }) => void
+}
+
+export class Broker35Plugin<T extends ValidateCallback<any>> {
+    _params: Broker35PluginParams<T>
+    constructor(params: Broker35PluginParams<T>) {
+        this._params = params
+    }
+
+    use(params: ValidateCallbackOutputs<T>) {
+        return {
+            instance: this as any,
+            params
+        }
+    }
+}

package/lib/core/translator.ts

@@ -5,9 +5,25 @@ export type TranslatorParams<
     S extends ValidateCallback<any>,
     O extends ValidateCallback<any>
 > = {
-    scheme: S
+    /**
+     * @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.
+     */
     assembly: (data: ValidateCallbackOutputs<S>) => Promise<string>
 }
 
@@ -28,8 +44,13 @@ export class Translator<
         return null as any
     }
 
+    /**
+     * @zh 組合輸入資料成為提示文字。
+     * @en Combine the input data into a prompt.
+     */
+
     async compile(data: ValidateCallbackOutputs<S>) {
-        const scheme = validate(data, this.params.scheme)
+        const scheme = validate(data, this.params.input)
         const prompt = await this.params.assembly(scheme)
         return {
             scheme,
@@ -37,6 +58,11 @@ export class Translator<
         }
     }
 
+    /**
+     * @zh 將文字轉換成序列化資量。
+     * @en Convert text to serialized data.
+     */
+
     async parse(text: string) {
         let result: any = undefined
         let parserName = ''

package/lib/index.ts

@@ -1,5 +1,7 @@
 /* eslint-disable no-redeclare */
 
+import * as _Plugins from './core/plugin'
+import * as _plugins from './plugins'
 import * as _templates from './templates'
 import * as _Translator from './core/translator'
 import { ValidateCallback } from './utils/validate'
@@ -14,6 +16,8 @@ export type Translator<S extends ValidateCallback<any>, O extends ValidateCallba
 export type TranslatorParams<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _Translator.TranslatorParams<S, O>
 export type ChatGPT3Broker<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _ChatGPT3Broker<S, O>
 export type ChatGPT35Broker<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _ChatGPT35Broker<S, O>
+export type Broker3Plugin<T extends ValidateCallback<any>> = _Plugins.Broker3Plugin<T>
+export type Broker35Plugin<T extends ValidateCallback<any>> = _Plugins.Broker35Plugin<T>
 
 export const TextParser = _TextParser
 export const Translator = _Translator.Translator
@@ -21,14 +25,21 @@ export const ChatGPT3 = _ChatGPT3
 export const ChatGPT35 = _ChatGPT35
 export const ChatGPT3Broker = _ChatGPT3Broker
 export const ChatGPT35Broker = _ChatGPT35Broker
+export const Broker3Plugin = _Plugins.Broker3Plugin
+export const Broker35Plugin = _Plugins.Broker35Plugin
+
+export const plugins = _plugins
 export const templates = _templates
 
 export const ctod = {
+    plugins,
     templates,
     ChatGPT3,
     ChatGPT35,
     Translator,
     TextParser,
+    Broker3Plugin,
+    Broker35Plugin,
     ChatGPT3Broker,
     ChatGPT35Broker
 }

package/lib/plugins.ts

@@ -0,0 +1,72 @@
+import { Log } from 'power-helper'
+import { Broker35Plugin, Broker3Plugin } from './core/plugin'
+
+/**
+ * @zh 一個基於印出 log 的 plugin。
+ * @en A plugin based on printing log.
+ */
+
+export const PrintLogPlugin = {
+
+    /**
+     * @zh 用於 Broker3 的版本。
+     * @en The version for Broker3.
+     */
+
+    ver3: new Broker3Plugin({
+        name: 'print-log',
+        params: () => {
+            return {}
+        },
+        onInstall({ attach }) {
+            const log = new Log('print-log-plugin')
+            attach('talkBefore', async({ prompt }) => {
+                log.print('Send:', { color: 'green' })
+                log.print(prompt)
+            })
+            attach('talkAfter', async({ parseText }) => {
+                log.print('Receive:', { color: 'red' })
+                log.print(parseText)
+            })
+            attach('succeeded', async({ output }) => {
+                log.print('Output:', { color: 'yellow' })
+                try {
+                    log.print('\n' + JSON.stringify(output, null, 4))
+                } catch (error) {
+                    log.print('\n' + output)
+                }
+            })
+        }
+    }),
+
+    /**
+     * @zh 用於 Broker35 的版本。
+     * @en The version for Broker35.
+     */
+
+    ver35: new Broker35Plugin({
+        name: 'print-log',
+        params: () => {
+            return {}
+        },
+        onInstall({ attach }) {
+            const log = new Log('print-log-plugin')
+            attach('talkBefore', async({ lastUserMessage }) => {
+                log.print('Send:', { color: 'green' })
+                log.print('\n' + lastUserMessage)
+            })
+            attach('talkAfter', async({ parseText }) => {
+                log.print('Receive:', { color: 'cyan' })
+                log.print('\n' + parseText)
+            })
+            attach('succeeded', async({ output }) => {
+                log.print('Output:', { color: 'yellow' })
+                try {
+                    log.print('\n' + JSON.stringify(output, null, 4))
+                } catch (error) {
+                    log.print('\n' + output)
+                }
+            })
+        }
+    })
+}

package/lib/service/chatgpt3.ts

@@ -1,4 +1,4 @@
-import axios from 'axios'
+import axios, { AxiosInstance } from 'axios'
 import { PromiseResponseType } from '../types'
 
 type Config = {
@@ -6,7 +6,7 @@ type Config = {
      * @zh 一次回應數量
      * @en How many chat completion choices to generate for each input message.
      */
-    n: 1
+    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).
@@ -39,6 +39,7 @@ type ApiResponse = {
 }
 
 export class ChatGPT3 {
+    private axios = axios.create()
     private apiKey = ''
     private config: Config = {
         n: 1,
@@ -46,16 +47,40 @@ export class ChatGPT3 {
         temperature: 1
     }
 
+    /**
+     * @zh 如果你有需要特別設定 axios，請使用這方法。
+     * @en If you need to set axios, please use this method.
+     */
+
+    setAxios(axios: AxiosInstance) {
+        this.axios = axios
+    }
+
+    /**
+     * @zh 設定 api key。
+     * @en Set api key.
+     */
+
     setConfiguration(apiKey: string) {
         this.apiKey = apiKey
     }
 
+    /**
+     * @zh 改變對話的一些設定。 
+     * @en Change some settings of the chat.
+     */
+
     setConfig(options: Partial<Config>) {
         Object.assign(this.config, options)
     }
 
+    /**
+     * @zh 進行對話。
+     * @en Talk to the chatbot.
+     */
+
     async talk(prompt: string | string[]) {
-        const result = await axios.post<ApiResponse>('https://api.openai.com/v1/completions', {
+        const result = await this.axios.post<ApiResponse>('https://api.openai.com/v1/completions', {
             model: 'text-davinci-003',
             n: this.config.n,
             prompt: Array.isArray(prompt) ? prompt.join('\n') : prompt,

package/lib/service/chatgpt35.ts

@@ -1,4 +1,4 @@
-import axios from 'axios'
+import axios, { AxiosInstance } from 'axios'
 import { json } from 'power-helper'
 import { PromiseResponseType } from '../types'
 
@@ -31,7 +31,7 @@ type Config = {
      * @zh 一次回應數量
      * @en How many chat completion choices to generate for each input message.
      */
-    n: 1
+    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).
@@ -46,6 +46,7 @@ type Config = {
 }
 
 export class ChatGPT35 {
+    private axios = axios.create()
     private apiKey = ''
     private config: Config = {
         n: 1,
@@ -55,6 +56,7 @@ export class ChatGPT35 {
 
     /**
      * @zh 獲取 DAN 指令啟用的 message
+     * @en Get the message that enables the DAN command
      */
 
     static getJailbrokenMessages(): Array<ChatGPT35Message> {
@@ -83,8 +85,18 @@ export class ChatGPT35 {
         ]
     }
 
+    /**
+     * @zh 如果你有需要特別設定 axios，請使用這方法
+     * @en If you need to set axios, use this method
+     */
+
+    setAxios(axios: AxiosInstance) {
+        this.axios = axios
+    }
+
     /**
      * @zh 設定 api key
+     * @en Set api key
      */
 
     setConfiguration(apiKey: string) {
@@ -92,7 +104,8 @@ export class ChatGPT35 {
     }
 
     /**
-     * @zh 設定 api key
+     * @zh 改變對話的一些設定
+     * @en Change some settings of the conversation
      */
 
     setConfig(options: Partial<Config>) {
@@ -101,11 +114,12 @@ export class ChatGPT35 {
 
     /**
      * @zh 進行對話
+     * @en Talk to the AI
      */
 
     async talk(messages: ChatGPT35Message[] = []) {
         const newMessages = json.jpjs(messages)
-        const result = await axios.post<ApiResponse>('https://api.openai.com/v1/chat/completions', {
+        const result = await this.axios.post<ApiResponse>('https://api.openai.com/v1/chat/completions', {
             model: 'gpt-3.5-turbo',
             n: this.config.n,
             messages: newMessages,

package/lib/templates.ts

@@ -3,7 +3,7 @@ type JsonResponseFormat = {
     example: any
 }
 /**
- * @zh 協助使用者將格式需求轉成論敘語句
+ * @zh 協助使用者將格式需求轉成論敘語句。
  * @en Assist the user in converting the formatting requirements into declarative sentences.
  */