ctod 0.1.5 → 0.3.0

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

@@ -1,4 +1,4 @@
-import { Broker35Plugin } from '../core/plugin';
+import { ChatBrokerPlugin } from '../core/plugin';
 declare type Events = {
     run: {
         id: string;
@@ -27,9 +27,9 @@ declare const _default: {
      */
     closeSchedule: () => void;
     /**
-     * @zh 用於 Broker35 的版本。
-     * @en The version for Broker35.
+     * @zh Plugin 的接口
+     * @en Plugin interface
      */
-    ver35: Broker35Plugin<() => {}, () => {}>;
+    plugin: ChatBrokerPlugin<() => {}, () => {}>;
 };
 export default _default;

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

@@ -1,16 +1,5 @@
-import { Broker35Plugin, Broker3Plugin } from '../core/plugin';
-declare const _default: {
-    /**
-     * @zh 用於 Broker3 的版本。
-     * @en The version for Broker3.
-     */
-    ver3: Broker3Plugin<() => {}, () => {}>;
-    /**
-     * @zh 用於 Broker35 的版本。
-     * @en The version for Broker35.
-     */
-    ver35: Broker35Plugin<(yup: typeof import("yup")) => {
-        detail: import("yup").BooleanSchema<boolean, import("yup").AnyObject, false, "d">;
-    }, () => {}>;
-};
+import { ChatBrokerPlugin } from '../core/plugin';
+declare const _default: ChatBrokerPlugin<(yup: typeof import("yup")) => {
+    detail: import("yup").BooleanSchema<boolean, import("yup").AnyObject, false, "d">;
+}, () => {}>;
 export default _default;

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

@@ -1,12 +1,6 @@
-import { Broker35Plugin } from '../core/plugin';
-declare const _default: {
-    /**
-     * @zh 用於 Broker35 的版本。
-     * @en The version for Broker35.
-     */
-    ver35: Broker35Plugin<(yup: typeof import("yup")) => {
-        retry: import("yup").NumberSchema<number, import("yup").AnyObject, 1, "d">;
-        printWarn: import("yup").BooleanSchema<boolean, import("yup").AnyObject, true, "d">;
-    }, () => {}>;
-};
+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<boolean, import("yup").AnyObject, true, "d">;
+}, () => {}>;
 export default _default;

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

@@ -1,11 +1,5 @@
-import { Broker35Plugin } from '../core/plugin';
-declare const _default: {
-    /**
-     * @zh 用於 Broker35 的版本。
-     * @en The version for Broker35.
-     */
-    ver35: Broker35Plugin<(yup: typeof import("yup")) => {
-        role: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
-    }, () => {}>;
-};
+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/{chatgpt35.d.ts → openai/chat.d.ts}

@@ -1,6 +1,6 @@
-import { AxiosInstance } from 'axios';
-import { PromiseResponseType } from '../types';
-export declare type ChatGPT35Message = {
+import { OpenAI } from './index';
+import { PromiseResponseType } from '../../types';
+declare type ChatGPTMessage = {
     role: 'system' | 'user' | 'assistant';
     name?: string;
     content: string;
@@ -31,30 +31,20 @@ declare type Config = {
      */
     n: number;
     /**
-     * @zh 選擇運行的模型，16k意味著能處理長度為 16,384 的文本，而預設為 4096。
+     * @zh 選擇運行的模型，16k意味著能處理長度為 16,384 的文本，32k意味著能處理長度為 32768 的文本。
      * @en How many chat completion choices to generate for each input message.
      */
-    model: 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k';
+    model: 'gpt-4' | 'gpt-4-32k' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k';
     /**
      * @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;
 };
-export declare class ChatGPT35 {
-    private axios;
-    private apiKey;
-    private config;
-    /**
-     * @zh 如果你有需要特別設定 axios，請使用這方法
-     * @en If you need to set axios, use this method
-     */
-    setAxios(axios: AxiosInstance): void;
-    /**
-     * @zh 設定 api key
-     * @en Set api key
-     */
-    setConfiguration(apiKey: string): void;
+export declare class OpenAIChat {
+    openai: OpenAI;
+    config: Config;
+    constructor(openai: OpenAI);
     /**
      * @zh 改變對話的一些設定
      * @en Change some settings of the conversation
@@ -64,26 +54,26 @@ export declare class ChatGPT35 {
      * @zh 進行對話
      * @en Talk to the AI
      */
-    talk(messages?: ChatGPT35Message[]): Promise<{
+    talk(messages?: ChatGPTMessage[]): Promise<{
         id: string;
         text: string;
+        newMessages: ChatGPTMessage[];
         isDone: boolean;
-        newMessages: ChatGPT35Message[];
         apiReseponse: ApiResponse;
     }>;
     /**
      * @zh 開啟持續性對話
      */
-    chat(prompt: string | string[], oldMessages?: ChatGPT35Message[]): Promise<{
+    keepTalk(prompt: string | string[], oldMessages?: ChatGPTMessage[]): Promise<{
         result: {
             id: string;
             text: string;
+            newMessages: ChatGPTMessage[];
             isDone: boolean;
-            newMessages: ChatGPT35Message[];
             apiReseponse: ApiResponse;
         };
         nextTalk: (prompt: string | string[]) => Promise<any>;
     }>;
 }
-export declare type ChatGPT35TalkResponse = PromiseResponseType<ChatGPT35['talk']>;
+export declare type OpenAIChatTalkResponse = PromiseResponseType<OpenAIChat['talk']>;
 export {};

package/types/lib/service/{chatgpt3.d.ts → openai/completion.d.ts}

@@ -1,5 +1,5 @@
-import { AxiosInstance } from 'axios';
-import { PromiseResponseType } from '../types';
+import { OpenAI } from './index';
+import { PromiseResponseType } from '../../types';
 declare type Config = {
     /**
      * @zh 一次回應數量
@@ -35,35 +35,25 @@ declare type ApiResponse = {
         total_tokens: number;
     };
 };
-export declare class ChatGPT3 {
-    private axios;
-    private apiKey;
+export declare class OpenAICompletion {
+    private openai;
     private config;
-    /**
-     * @zh 如果你有需要特別設定 axios，請使用這方法。
-     * @en If you need to set axios, please use this method.
-     */
-    setAxios(axios: AxiosInstance): void;
-    /**
-     * @zh 設定 api key。
-     * @en Set api key.
-     */
-    setConfiguration(apiKey: string): void;
+    constructor(openai: OpenAI);
     /**
      * @zh 改變對話的一些設定。
      * @en Change some settings of the chat.
      */
     setConfig(options: Partial<Config>): void;
     /**
-     * @zh 進行對話。
-     * @en Talk to the chatbot.
+     * @zh 進行補文。
+     * @en Do completion.
      */
-    talk(prompt: string | string[]): Promise<{
+    run(prompt: string | string[]): Promise<{
         id: string;
         text: string;
         isDone: boolean;
         apiReseponse: ApiResponse;
     }>;
 }
-export declare type ChatGPT3TalkResponse = PromiseResponseType<ChatGPT3['talk']>;
+export declare type OpenAiOpenAICompletionResponse = PromiseResponseType<OpenAICompletion['run']>;
 export {};

package/types/lib/service/{images-generations.d.ts → openai/images-generation.d.ts}

@@ -1,4 +1,4 @@
-import { AxiosInstance } from 'axios';
+import { OpenAI } from './index';
 declare type ApiResponse = {
     created: string;
     data: {
@@ -17,20 +17,10 @@ declare type Config = {
      */
     size: `${number}x${number}`;
 };
-export declare class ImagesGenerations {
-    private axios;
-    private apiKey;
+export declare class OpenAIImagesGeneration {
+    private openai;
     private config;
-    /**
-     * @zh 如果你有需要特別設定 axios，請使用這方法
-     * @en If you need to set axios, use this method
-     */
-    setAxios(axios: AxiosInstance): void;
-    /**
-     * @zh 設定 api key
-     * @en Set api key
-     */
-    setConfiguration(apiKey: string): void;
+    constructor(openai: OpenAI);
     /**
      * @zh 改變對話的一些設定
      * @en Change some settings of the conversation

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

@@ -0,0 +1,22 @@
+import { OpenAIChat } from './chat';
+import { OpenAICompletion } from './completion';
+import { OpenAIImagesGeneration } from './images-generation';
+import { AxiosInstance } from 'axios';
+export declare class OpenAI {
+    _axios: AxiosInstance;
+    _apiKey: string;
+    constructor(apiKey?: string);
+    /**
+     * @zh 如果你有需要特別設定 axios，請使用這方法。
+     * @en If you need to set axios, please use this method.
+     */
+    setAxios(axios: AxiosInstance): void;
+    /**
+     * @zh 設定 api key。
+     * @en Set api key.
+     */
+    setConfiguration(apiKey: string): void;
+    createChat(): OpenAIChat;
+    createCompletion(): OpenAICompletion;
+    createImagesGeneration(): OpenAIImagesGeneration;
+}

package/README-TW.md

@@ -1,239 +0,0 @@
-<br>
-<p align="center"><img style="max-width: 300px" src="./logo.png"></p>
-<h1 align="center">CtoD</h1>
-<h3 align="center">Chat To Data</h3>
-
-<p align="center">
-    <a href="https://www.npmjs.com/package/ctod">
-        <img src="https://img.shields.io/npm/v/ctod.svg">
-    </a>
-    <a href="https://github.com/KHC-ZhiHao/ctod">
-        <img src="https://img.shields.io/github/stars/KHC-ZhiHao/ctod.svg?style=social">
-    </a>
-    <br>
-</p>
-
-<br>
-
-[English Version](./README.md)
-
-## Online Playground
-
-[Chat Of Requirement(織語)](https://cor.metalsheep.com/) 是為了 CtoD 建構的展示工具，你可以在這個工具中建構你與調適你的模板。
-
-## 摘要
-
-本工具是利用聊天機器人能夠讀懂自然語言的特性，將我們的需求與資料透過口語化的方式交付給他處理，並要求回應可序列化格式，例如：JSON。
-
-在對話過程中，本工具採用 [yup](https://github.com/jquense/yup) 來驗證請求與回復資料是否符合預期，以確保一致性，只要保持這個互動模式，就可以利用在 API 串接或是自動化系統上。
-
-我們還附帶了一些基礎的串接機器人方案，目前支援 `ChatGPT3` 與 `ChatGPT3.5`。
-
-## 安裝
-
-npm:
-
-```bash
-npm install ctod
-```
-
-yarn:
-
-```bash
-yarn add ctod
-```
-
-## 快速開始
-
-這個例子示範如何將藥物索引與客戶需求傳遞給聊天機器人，並返回最適合的結果，開發人員可以利用索引結果去資料庫搜尋最適合的藥物給消費者：
-
-> 關於型態定義，這裡有個有趣的議題，必須將 input 與 output 優先宣告才能讓型態正常運作。
-
-```ts
-import { ChatGPT35Broker, templates } from 'ctod'
-
-const API_KEY = 'openai api key'
-const broker = new ChatGPT35Broker({
-    /** 驗證輸入資料 */
-    input: yup => {
-        return {
-            indexs: yup.array(yup.string()).required(),
-            question: yup.string().required()
-        }
-    },
-    /** 驗證輸出資料 */
-    output: yup => {
-        return {
-            indexs: yup.array(yup.object({
-                name: yup.string().required(),
-                score: yup.number().required()
-            })).required()
-        }
-    },
-    /** 初始化系統，通常來植入或掛鉤生命週期 */
-    install: ({ bot }) => {
-        bot.setConfiguration(API_KEY)
-    },
-    /** 組裝與定義我們要向機器人發出的請求 */
-    question: async({ indexs, question }) => {
-        return templates.requireJsonResponse([
-            '我有以下索引',
-            `${JSON.stringify(indexs)}`,
-            `請幫我解析"${question}"可能是哪個索引`,
-            '且相關性由高到低排序並給予分數，分數由 0 ~ 1'
-        ], {
-            indexs: {
-                desc: '由高到低排序的索引',
-                example: [
-                    {
-                        name: '索引名稱',
-                        score: '評比分數，數字顯示'
-                    }
-                ]
-            }
-        })
-    }
-})
-
-broker.request({
-    indexs: ['胃痛', '腰痛', '頭痛', '喉嚨痛', '四肢疼痛'],
-    question: '喝咖啡，吃甜食，胃食道逆流'
-}).then(e => {
-    console.log('輸出結果：', e.indexs)
-    /*
-        [
-            {
-                name: '胃痛',
-                score: 1
-            },
-            {
-                name: '喉嚨痛',
-                score: 0.7
-            },
-            ...
-        ]
-     */
-})
-```
-
-### Examples
-
-1. [如何利用 ChatGPT35 持續聊天機器人對話](./examples/chatgpt3.5.ts)
-
-2. [如何利用 ChatGPT35Broker 來整合機器人回應](./examples/chatgpt3.5-broker.ts)
-
-##  Plugin
-
-雖然 Broker 本身已經能夠處理大部分的事務，但透過 Plugin 可以協助改善複雜的流程，幫助專案工程化。
-
-每次發送請求時，Broker 會觸發一系列的生命週期，你可以從[原始碼](./lib/broker/35.ts)中了解每個生命週期的參數與行為，並對其行為進行加工。
-
-現在，假設我們想要設計一個插件，它會在每次對話結束時將訊息備份到伺服器上：
-
-```ts
-import axios from 'axios'
-import { ChatGPT35Broker, Broker35Plugin } from 'ctod'
-const backupPlugin = new Broker35Plugin({
-    name: 'backup-plugin',
-    // 定義參數為 sendUrl
-    params: yup => {
-        return {
-            sendUrl: yup.string().required()
-        }
-    },
-    // 現階段你可以在執行過程中接收到資訊，資訊結構由這裡定義。
-    receiveData: yup => {
-        return {
-            character: yup.string().required()
-        }
-    },
-    onInstall({ params, attach, receive }) {
-        const store = new Map()
-        // 假設我們有更多的自訂義資訊需要被傳遞進來，可以在 talkFirst 階段透過 plugins[key].send({ ... }) 傳遞
-        // 可以從 Applications 分類中的 請機器人角色扮演 觀看案例
-        receive(({ id, context }) => {
-            store.get(id).context = context
-        })
-        // 第一次對話的時候初始化資料
-        attach('talkFirst', async({ id }) => {
-            store.set(id, {
-                messages: [],
-                context: null
-            })
-        })
-        // 每次對話完畢後把對話存入狀態
-        attach('talkAfter', async({ id, lastUserMessage }) => {
-            store.get(id).messages.push(lastUserMessage)
-        })
-        // 結束對話後備份資料
-        attach('done', async({ id }) => {
-            await axios.post(params.sendUrl, store.get(id))
-            store.delete(id)
-        })
-    }
-})
-
-const broker = new ChatGPT35Broker({
-    // ...
-    plugins: [
-        backupPlugin.use({
-            sendUrl: 'https://api/backup'
-        })
-    ],
-    // 以下方案也可以運行
-    // plugins: () => [
-    //     backupPlugin.use({
-    //         sendUrl: 'https://api/backup'
-    //     })
-    // ],
-    // ...
-})
-```
-
-### Examples
-
-1. 能夠印出執行流程：[Print Log Plugin](./lib/plugins/print-log.ts)
-2. 能夠限制發送流量：[Limiter Plugin](./lib/plugins/limiter.ts)
-3. 能夠在失敗的時候重試：[Retry Plugin](./lib/plugins/retry.ts)
-
-### Applications
-
-以下是一組應用範例，你可以參考這些範例來設計你的 AI System。
-
-> 你可以透過 clone 本專案，在根目錄中加入 .key file，並貼上你的 openai dev key 來快速試用這些使用範例。
-
-[解讀 BBC News](./examples/applications/bbc-news-reader.ts)
-[請機器人角色扮演](./examples/applications/cosplay.ts)
-[故事與封面生產器]('./examples/applications/story-generations.ts')
-[對話生產器]('./examples/applications/talk-generations.ts')
-
-## Version History
-
-### 0.1.x
-
-我們對 plugin 做了比較大的異動，主要是為了能夠實行資料交換。
-
-#### ChatGPT35 Service
-
-##### remove: getJailbrokenMessages
-
-方案已過時。
-
-#### Broker
-
-##### add: setPreMessages
-
-能夠讓使用者在對話開始前，先輸入一些訊息，並確保首要問題被組合至。
-
-##### fix: hook
-
-修改了綁定行為，現在是 Broker 的綁定優先，再來才是 plugins。
-
-##### change: assembly => question
-
-為了讓使用者更容易理解，我們將 assembly 改名為 question。
-
-### 0.1.3
-
-* 移除: max_token
-* 新增: model add 16k

package/TODO

@@ -1,6 +0,0 @@
-[] 單元測試
-[] 程式碼說明註解
-[] 其他單元的說明文件
-[] ChatGPT 4 版本
-[] ChatGPU 3 範例
-[] 可在前端透過介面的範本