ctod 0.0.5 → 0.0.7

package/examples/applications/story-generations.ts

@@ -0,0 +1,129 @@
+import { flow, array } from 'power-helper'
+import { ImagesGenerations } from '../../lib/service/images-generations'
+import { definedOutputDir, getKey } from '../utils'
+import { ChatGPT35Broker, plugins, templates } from '../../lib/index'
+
+/**
+ * @invoke npx ts-node ./examples/applications/story-generations.ts
+ */
+
+const styles = ['Adventure', 'Romance', 'Horror', 'Science Fiction', 'Suspense', 'Comedy', 'Inspirational', 'Epic', 'Philosophical', 'Historical', 'Supernatural', 'Crime', 'Family', 'Classic', 'Fairy Tale', 'Animal', 'Science', 'War', 'Fantasy', 'Social', 'Romantic', 'Short Story', 'Novel', 'Narrative Poem', 'Lyric Poem', 'Epic Poem', 'Variations', 'Memoir', 'Autobiography', 'Fantasy Fiction', 'Political', 'Romantic Comedy', 'Science Fiction Adventure', 'Crime Thriller', 'Pure Love', 'Mythology', 'Supernatural Fiction', 'Horror Comedy', 'Epic Fantasy', 'Surrealism', 'Satire', 'Dystopian Fiction', 'Humorous Poetry', 'Philosophical Fiction', 'Suspense Thriller', 'Historical Epic', 'Romantic Suspense', 'Humor', 'Science Fiction Romance', 'Historical Romance']
+const ends = ['Happy ending', 'Tragic ending', 'Open ending', 'Bittersweet ending', 'Ambiguous ending', 'Surprise ending', 'Cathartic ending', 'Redemptive ending', 'Moral ending', 'Ironic ending', 'Deus ex machina', 'Twist ending', 'Epiphany ending', 'Mystery ending', 'Hopeful ending', 'Pessimistic ending', 'Revenge ending', 'Enigmatic ending', 'Metaphorical ending', 'Reflective ending', 'Satisfying ending', 'Unresolved ending', 'Transformation ending', 'Resolution ending', 'Sacrificial ending', 'Indeterminate ending', 'Existential ending', 'Nihilistic ending', 'Tragicomedy ending', 'Inconclusive ending', 'Climactic ending', 'Peripeteia ending', 'Prophetic ending', 'Heartwarming ending', 'Disillusioned ending', 'Sardonic ending', 'Revelatory ending', 'Comedic ending', 'Dramatic ending', 'Fateful ending', 'Introspective ending', 'Reconciling ending', 'Uplifting ending', 'Chaotic ending', 'Fatalistic ending', 'Epilogue ending', 'Foreboding ending', 'Satirical ending', 'Surreal ending']
+
+const genImage = async (params: {
+    style: string
+    title: string
+    apiKey: string
+    outline: string
+}) => {
+    const bot = new ImagesGenerations()
+    bot.setConfiguration(params.apiKey)
+    bot.setConfig({
+        n: 1,
+        size: '512x512'
+    })
+    const result = await bot.create(`is a ${params.style} style story, subject is ${params.title}, ${params.outline}`)
+    return result.data.map(e => e.b64_json)
+}
+
+const genStory = async (params: {
+    apiKey: string
+    style: string
+    ending: string
+}) => {
+    const broker = new ChatGPT35Broker({
+        input: yup => {
+            return {
+                ending: yup.string().required(),
+                style: yup.string().required()
+            }
+        },
+        output: yup => {
+            return {
+                enUsOutline: yup.string().required(),
+                zhTwOutline: yup.string().required(),
+                enUsTitle: yup.string().required(),
+                zhTwTitle: yup.string().required(),
+                enUsContent: yup.array(yup.string()).required(),
+                zhTwContent: yup.array(yup.string()).required()
+            }
+        },
+        plugins: [
+            plugins.PrintLogPlugin.ver35.use({})
+        ],
+        install: ({ bot, attach }) => {
+            bot.setConfiguration(params.apiKey)
+            attach('parseFailed', async({ count, retry, response, changeMessages }) => {
+                if (count <= 5) {
+                    console.log(`回傳錯誤，正在重試: ${count} 次`)
+                    changeMessages([response.newMessages[0]])
+                    retry()
+                }
+            })
+        },
+        assembly: async ({ style, ending }) => {
+            return templates.requireJsonResponse([
+                `生成一個 ${style} 風格的故事，必須是 ${ending} 結局`,
+                '內容請豐富精彩有深度，而且有起承轉合，符合電影的三段結構，必須1000字以上',
+                '有中英兩種版本，中文是繁體中文'
+            ], {
+                enUsOutline: {
+                    desc: '故事簡述，請用英文呈現',
+                    example: 'string'
+                },
+                zhTwOutline: {
+                    desc: '故事簡述，請用中文呈現',
+                    example: 'string'
+                },
+                enUsTitle: {
+                    desc: '英文標題',
+                    example: 'string'
+                },
+                zhTwTitle: {
+                    desc: '中文標題',
+                    example: 'string'
+                },
+                enUsContent: {
+                    desc: '英文內容，每一段為一個元素',
+                    example: 'string[]'
+                },
+                zhTwContent: {
+                    desc: '中文內容，每一段為一個元素',
+                    example: 'string[]'
+                }
+            })
+        }
+    })
+    const result = await broker.request(params)
+    return result
+}
+
+flow.run(async () => {
+    const apiKey = await getKey()
+    const style = array.randomPick(styles)
+    const ending = array.randomPick(ends)
+    try {
+        const result = await genStory({
+            style,
+            ending,
+            apiKey
+        })
+        const dir = definedOutputDir(`.output/stores/${result.zhTwTitle}`)
+        dir.write('story.json', result)
+        dir.write('story-config.json', {
+            style,
+            ending
+        })
+        for (let i = 0; i < 2; i++) {
+            const images = await genImage({
+                style,
+                apiKey,
+                title: result.enUsTitle,
+                outline: result.enUsOutline
+            })
+            dir.write(`cover-${i}.png`, images[0])
+        }
+    } catch (error: any) {
+        console.error('Error:', error?.response?.data?.error?.message ?? error)
+    }
+})

package/examples/applications/talk-generations.ts

@@ -0,0 +1,255 @@
+import { flow, array } from 'power-helper'
+import { ImagesGenerations } from '../../lib/service/images-generations'
+import { definedOutputDir, getKey } from '../utils'
+import { ChatGPT35Broker, plugins, templates } from '../../lib/index'
+
+/**
+ * @invoke npx ts-node ./examples/applications/talk-generations.ts
+ */
+
+const situations = [
+    {
+        'en-US': 'Brainstorming session between marketing team',
+        'zh-TW': '行銷團隊頭腦風暴會議'
+    },
+    {
+        'en-US': 'Customer service representative handling a complaint',
+        'zh-TW': '客服代表處理客訴'
+    },
+    {
+        'en-US': 'Job interview for a software engineer position',
+        'zh-TW': '軟體工程師職位面試'
+    },
+    {
+        'en-US': 'Negotiation between a vendor and a client',
+        'zh-TW': '供應商與客戶的談判'
+    },
+    {
+        'en-US': 'Meeting between a designer and a developer',
+        'zh-TW': '設計師與開發人員的會議'
+    },
+    {
+        'en-US': 'Team huddle before a sports game',
+        'zh-TW': '比賽前的團隊集合'
+    },
+    {
+        'en-US': 'Consultation with a financial advisor',
+        'zh-TW': '財務顧問諮詢'
+    },
+    {
+        'en-US': 'Parent-teacher conference',
+        'zh-TW': '家長教師會議'
+    },
+    {
+        'en-US': 'Discussion between a doctor and a patient',
+        'zh-TW': '醫生與病人的討論'
+    },
+    {
+        'en-US': 'Debate between political candidates',
+        'zh-TW': '政治候選人辯論'
+    }
+]
+
+const tones = [
+    {
+        'en-US': 'Angry',
+        'zh-TW': '憤怒'
+    },
+    {
+        'en-US': 'Excited',
+        'zh-TW': '興奮'
+    },
+    {
+        'en-US': 'Bored',
+        'zh-TW': '無聊'
+    },
+    {
+        'en-US': 'Sad',
+        'zh-TW': '悲傷'
+    },
+    {
+        'en-US': 'Happy',
+        'zh-TW': '快樂'
+    },
+    {
+        'en-US': 'Confused',
+        'zh-TW': '困惑'
+    },
+    {
+        'en-US': 'Frustrated',
+        'zh-TW': '挫敗'
+    },
+    {
+        'en-US': 'Curious',
+        'zh-TW': '好奇'
+    },
+    {
+        'en-US': 'Nervous',
+        'zh-TW': '緊張'
+    },
+    {
+        'en-US': 'Relaxed',
+        'zh-TW': '輕鬆'
+    }
+]
+
+const styles = [
+    {
+        'en-US': 'Humorous',
+        'zh-TW': '幽默'
+    },
+    {
+        'en-US': 'Formal',
+        'zh-TW': '正式'
+    },
+    {
+        'en-US': 'Casual',
+        'zh-TW': '隨意'
+    },
+    {
+        'en-US': 'Professional',
+        'zh-TW': '專業'
+    },
+    {
+        'en-US': 'Friendly',
+        'zh-TW': '友善'
+    },
+    {
+        'en-US': 'Serious',
+        'zh-TW': '嚴肅'
+    },
+    {
+        'en-US': 'Sarcastic',
+        'zh-TW': '諷刺'
+    },
+    {
+        'en-US': 'Inquisitive',
+        'zh-TW': '探究'
+    },
+    {
+        'en-US': 'Persuasive',
+        'zh-TW': '說服'
+    },
+    {
+        'en-US': 'Encouraging',
+        'zh-TW': '鼓勵'
+    }
+]
+
+const genImage = async (params: {
+    tone: string
+    apiKey: string,
+    style: string
+    situation: string
+}) => {
+    const bot = new ImagesGenerations()
+    bot.setConfiguration(params.apiKey)
+    bot.setConfig({
+        n: 1,
+        size: '512x512'
+    })
+    const result = await bot.create(`two people ${params.tone} ${params.situation}, ${params.style}`)
+    return result.data.map(e => e.b64_json)
+}
+
+const genTalk = async (params: {
+    apiKey: string
+    tone: string
+    style: string
+    situation: string
+}) => {
+    const broker = new ChatGPT35Broker({
+        input: yup => {
+            return {
+                tone: yup.string().required(),
+                style: yup.string().required(),
+                situation: yup.string().required()
+            }
+        },
+        output: yup => {
+            return {
+                enUsOutline: yup.string().required(),
+                zhTwOutline: yup.string().required(),
+                enUsTitle: yup.string().required(),
+                zhTwTitle: yup.string().required(),
+                enUsContent: yup.array(yup.string()).required(),
+                zhTwContent: yup.array(yup.string()).required()
+            }
+        },
+        plugins: [
+            plugins.PrintLogPlugin.ver35.use({})
+        ],
+        install: ({ bot, attach }) => {
+            bot.setConfiguration(params.apiKey)
+            attach('parseFailed', async ({ count, retry, response, changeMessages }) => {
+                if (count <= 5) {
+                    console.log(`回傳錯誤，正在重試: ${count} 次`)
+                    changeMessages([response.newMessages[0]])
+                    retry()
+                }
+            })
+        },
+        assembly: async ({ situation, style, tone }) => {
+            return templates.requireJsonResponse([
+                `幫我生成一組以${style}為出發點的對話`,
+                `是兩個 ${tone} 的人進行，${situation}`,
+                '有中英兩種版本，中文是繁體中文'
+            ], {
+                enUsOutline: {
+                    desc: '故事簡述，請用英文呈現',
+                    example: 'string'
+                },
+                zhTwOutline: {
+                    desc: '故事簡述，請用中文呈現',
+                    example: 'string'
+                },
+                enUsTitle: {
+                    desc: '英文標題',
+                    example: 'string'
+                },
+                zhTwTitle: {
+                    desc: '中文標題',
+                    example: 'string'
+                },
+                enUsContent: {
+                    desc: '英文內容，每一段為一個元素',
+                    example: 'string[]'
+                },
+                zhTwContent: {
+                    desc: '中文內容，每一段為一個元素',
+                    example: 'string[]'
+                }
+            })
+        }
+    })
+    const result = await broker.request(params)
+    return result
+}
+
+flow.run(async () => {
+    const apiKey = await getKey()
+    const tone = array.randomPick(tones)
+    const style = array.randomPick(styles)
+    const situation = array.randomPick(situations)
+    try {
+        const result = await genTalk({
+            tone: tone['en-US'],
+            situation: situation['en-US'],
+            style: style['en-US'],
+            apiKey
+        })
+        const images = await genImage({
+            tone: tone['en-US'],
+            situation: situation['en-US'],
+            style: style['en-US'],
+            apiKey
+        })
+        const dir = definedOutputDir(`.output/talks/${result.zhTwTitle}`)
+        dir.write('content.json', result)
+        for (let image of images) {
+            dir.write(`cover-${Date.now()}.png`, image, 'base64')
+        }
+    } catch (error: any) {
+        console.error('Error:', error?.response?.data?.error?.message ?? error)
+    }
+})

package/examples/chatgpt3.5-broker.ts

@@ -8,6 +8,7 @@ import { ChatGPT35Broker, plugins, templates } from '../lib/index'
  * @test npx ts-node ./examples/chatgpt3.5-broker.ts
  */
 
+
 flow.run(async() => {
     const { apiKey } = await prompt([
         {

package/examples/utils/index.ts

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

@@ -9,21 +9,49 @@ export class ChatGPT3Broker<
     S extends ValidateCallback<any>,
     O extends ValidateCallback<any>,
     > extends BaseBroker<S, O, Broker3Plugin<any>, {
+
+        /**
+         * @zh 發送聊天訊息給機器人前觸發
+         * @en Triggered before sending chat message to bot
+         */
+
         talkBefore: {
+            id: string
             data: ValidateCallbackOutputs<S>
             prompt: string
         }
+
+        /**
+         * @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
@@ -31,12 +59,27 @@ export class ChatGPT3Broker<
             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 }) => {
@@ -48,12 +91,14 @@ export class ChatGPT3Broker<
             let retryFlag = false
             try {
                 await this.hook.notify('talkBefore', {
+                    id,
                     data,
                     prompt: question.prompt
                 })
                 response = await this.bot.talk(question.prompt)
                 parseText = response.text
                 await this.hook.notify('talkAfter', {
+                    id,
                     data,
                     prompt: question.prompt,
                     response,
@@ -64,13 +109,16 @@ export class ChatGPT3Broker<
                 })
                 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,
@@ -86,6 +134,7 @@ export class ChatGPT3Broker<
                         return doBreak()
                     }
                 }
+                await this.hook.notify('done', { id })
                 throw error
             }
         })