ctod 0.1.5 → 0.2.0

package/types/lib/index.d.ts

@@ -6,25 +6,32 @@ import { ValidateCallback } from './utils/validate';
 import { TextParser as _TextParser } from './core/parser';
 import { ChatGPT3 as _ChatGPT3 } from './service/chatgpt3';
 import { ChatGPT35 as _ChatGPT35 } from './service/chatgpt35';
+import { ChatGPT4 as _ChatGPT4 } from './service/chatgpt4';
 import { ChatGPT3Broker as _ChatGPT3Broker } from './broker/3';
 import { ChatGPT35Broker as _ChatGPT35Broker } from './broker/35';
+import { ChatGPT4Broker as _ChatGPT4Broker } from './broker/4';
 import { ImagesGenerations as _ImagesGenerations } from './service/images-generations';
 export declare type TextParser = _TextParser;
 export declare type Translator<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _Translator.Translator<S, O>;
 export declare type TranslatorParams<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _Translator.TranslatorParams<S, O>;
 export declare type ChatGPT3Broker<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _ChatGPT3Broker<S, O, any, any>;
 export declare type ChatGPT35Broker<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _ChatGPT35Broker<S, O, any, any>;
+export declare type ChatGPT4Broker<S extends ValidateCallback<any>, O extends ValidateCallback<any>> = _ChatGPT35Broker<S, O, any, any>;
 export declare type Broker3Plugin<T extends ValidateCallback<any>, R extends ValidateCallback<any>> = _Plugins.Broker3Plugin<T, R>;
 export declare type Broker35Plugin<T extends ValidateCallback<any>, R extends ValidateCallback<any>> = _Plugins.Broker35Plugin<T, R>;
+export declare type Broker4Plugin<T extends ValidateCallback<any>, R extends ValidateCallback<any>> = _Plugins.Broker35Plugin<T, R>;
 export declare type ImagesGenerations = _ImagesGenerations;
 export declare const TextParser: typeof _TextParser;
 export declare const Translator: typeof _Translator.Translator;
 export declare const ChatGPT3: typeof _ChatGPT3;
 export declare const ChatGPT35: typeof _ChatGPT35;
+export declare const ChatGPT4: typeof _ChatGPT4;
 export declare const ChatGPT3Broker: typeof _ChatGPT3Broker;
 export declare const ChatGPT35Broker: typeof _ChatGPT35Broker;
+export declare const ChatGPT4Broker: typeof _ChatGPT4Broker;
 export declare const Broker3Plugin: typeof _Plugins.Broker3Plugin;
 export declare const Broker35Plugin: typeof _Plugins.Broker35Plugin;
+export declare const Broker4Plugin: typeof _Plugins.Broker35Plugin;
 export declare const ImagesGenerations: typeof _ImagesGenerations;
 export declare const plugins: typeof _plugins;
 export declare const templates: typeof _templates;
@@ -33,12 +40,15 @@ export declare const ctod: {
     templates: typeof _templates;
     ChatGPT3: typeof _ChatGPT3;
     ChatGPT35: typeof _ChatGPT35;
+    ChatGPT4: typeof _ChatGPT4;
     Translator: typeof _Translator.Translator;
     TextParser: typeof _TextParser;
     Broker3Plugin: typeof _Plugins.Broker3Plugin;
     Broker35Plugin: typeof _Plugins.Broker35Plugin;
+    Broker4Plugin: typeof _Plugins.Broker35Plugin;
     ChatGPT3Broker: typeof _ChatGPT3Broker;
     ChatGPT35Broker: typeof _ChatGPT35Broker;
+    ChatGPT4Broker: typeof _ChatGPT4Broker;
     ImagesGenerations: typeof _ImagesGenerations;
 };
 export default ctod;

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

@@ -7,6 +7,9 @@ export declare const PrintLogPlugin: {
     ver35: import("../core/plugin").Broker35Plugin<(yup: typeof import("yup")) => {
         detail: import("yup").BooleanSchema<boolean, import("yup").AnyObject, false, "d">;
     }, () => {}>;
+    ver4: import("../core/plugin").Broker4Plugin<(yup: typeof import("yup")) => {
+        detail: import("yup").BooleanSchema<boolean, import("yup").AnyObject, false, "d">;
+    }, () => {}>;
 };
 /**
  * @zh 當解析失敗時，會自動重試的對話。
@@ -17,6 +20,10 @@ export declare const RetryPlugin: {
         retry: import("yup").NumberSchema<number, import("yup").AnyObject, 1, "d">;
         printWarn: import("yup").BooleanSchema<boolean, import("yup").AnyObject, true, "d">;
     }, () => {}>;
+    ver4: import("../core/plugin").Broker4Plugin<(yup: typeof import("yup")) => {
+        retry: import("yup").NumberSchema<number, import("yup").AnyObject, 1, "d">;
+        printWarn: import("yup").BooleanSchema<boolean, import("yup").AnyObject, true, "d">;
+    }, () => {}>;
 };
 /**
  * @zh 限制使用流量，這個 plugin 可以有效讓所有對話不會再限制內同時發送，可用於在開發過程中遭遇伺服器因頻率過高而阻擋請求。
@@ -37,6 +44,7 @@ export declare const LimiterPlugin: {
     };
     closeSchedule: () => void;
     ver35: import("../core/plugin").Broker35Plugin<() => {}, () => {}>;
+    ver4: import("../core/plugin").Broker4Plugin<() => {}, () => {}>;
 };
 /**
  * @zh 設定角色扮演。
@@ -46,4 +54,7 @@ export declare const RolePlugin: {
     ver35: import("../core/plugin").Broker35Plugin<(yup: typeof import("yup")) => {
         role: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
     }, () => {}>;
+    ver4: import("../core/plugin").Broker4Plugin<(yup: typeof import("yup")) => {
+        role: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
+    }, () => {}>;
 };

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

@@ -1,4 +1,4 @@
-import { Broker35Plugin } from '../core/plugin';
+import { Broker35Plugin, Broker4Plugin } from '../core/plugin';
 declare type Events = {
     run: {
         id: string;
@@ -31,5 +31,10 @@ declare const _default: {
      * @en The version for Broker35.
      */
     ver35: Broker35Plugin<() => {}, () => {}>;
+    /**
+     * @zh 用於 Broker4 的版本。
+     * @en The version for Broker4.
+     */
+    ver4: Broker4Plugin<() => {}, () => {}>;
 };
 export default _default;

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

@@ -1,4 +1,4 @@
-import { Broker35Plugin, Broker3Plugin } from '../core/plugin';
+import { Broker35Plugin, Broker3Plugin, Broker4Plugin } from '../core/plugin';
 declare const _default: {
     /**
      * @zh 用於 Broker3 的版本。
@@ -12,5 +12,12 @@ declare const _default: {
     ver35: Broker35Plugin<(yup: typeof import("yup")) => {
         detail: import("yup").BooleanSchema<boolean, import("yup").AnyObject, false, "d">;
     }, () => {}>;
+    /**
+     * @zh 用於 Broker4 的版本。
+     * @en The version for Broker4.
+     */
+    ver4: Broker4Plugin<(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,4 +1,4 @@
-import { Broker35Plugin } from '../core/plugin';
+import { Broker35Plugin, Broker4Plugin } from '../core/plugin';
 declare const _default: {
     /**
      * @zh 用於 Broker35 的版本。
@@ -8,5 +8,13 @@ declare const _default: {
         retry: import("yup").NumberSchema<number, import("yup").AnyObject, 1, "d">;
         printWarn: import("yup").BooleanSchema<boolean, import("yup").AnyObject, true, "d">;
     }, () => {}>;
+    /**
+     * @zh 用於 Broker4 的版本。
+     * @en The version for Broker4.
+     */
+    ver4: Broker4Plugin<(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,4 +1,4 @@
-import { Broker35Plugin } from '../core/plugin';
+import { Broker35Plugin, Broker4Plugin } from '../core/plugin';
 declare const _default: {
     /**
      * @zh 用於 Broker35 的版本。
@@ -7,5 +7,12 @@ declare const _default: {
     ver35: Broker35Plugin<(yup: typeof import("yup")) => {
         role: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
     }, () => {}>;
+    /**
+     * @zh 用於 Broker4 的版本。
+     * @en The version for Broker4.
+     */
+    ver4: Broker4Plugin<(yup: typeof import("yup")) => {
+        role: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
+    }, () => {}>;
 };
 export default _default;

package/types/lib/service/chatgpt35.d.ts

@@ -42,9 +42,9 @@ declare type Config = {
     temperature: number;
 };
 export declare class ChatGPT35 {
-    private axios;
-    private apiKey;
-    private config;
+    axios: AxiosInstance;
+    apiKey: string;
+    config: Config;
     /**
      * @zh 如果你有需要特別設定 axios，請使用這方法
      * @en If you need to set axios, use this method

package/types/lib/service/chatgpt4.d.ts

@@ -0,0 +1,89 @@
+import { AxiosInstance } from 'axios';
+import { PromiseResponseType } from '../types';
+export declare type ChatGPT4Message = {
+    role: 'system' | 'user' | 'assistant';
+    name?: string;
+    content: string;
+};
+declare 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;
+    };
+};
+declare type Config = {
+    /**
+     * @zh 一次回應數量
+     * @en How many chat completion choices to generate for each input message.
+     */
+    n: number;
+    /**
+     * @zh 選擇運行的模型，32k意味著能處理長度為 32768 的文本，而預設為 8192。
+     * @en How many chat completion choices to generate for each input message.
+     */
+    model: 'gpt-4' | 'gpt-4-32k';
+    /**
+     * @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 ChatGPT4 {
+    axios: AxiosInstance;
+    apiKey: string;
+    config: 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;
+    /**
+     * @zh 改變對話的一些設定
+     * @en Change some settings of the conversation
+     */
+    setConfig(options: Partial<Config>): void;
+    /**
+     * @zh 進行對話
+     * @en Talk to the AI
+     */
+    talk(messages?: ChatGPT4Message[]): Promise<{
+        id: string;
+        text: string;
+        isDone: boolean;
+        newMessages: ChatGPT4Message[];
+        apiReseponse: ApiResponse;
+    }>;
+    /**
+     * @zh 開啟持續性對話
+     */
+    chat(prompt: string | string[], oldMessages?: ChatGPT4Message[]): Promise<{
+        result: {
+            id: string;
+            text: string;
+            isDone: boolean;
+            newMessages: ChatGPT4Message[];
+            apiReseponse: ApiResponse;
+        };
+        nextTalk: (prompt: string | string[]) => Promise<any>;
+    }>;
+}
+export declare type ChatGPT4TalkResponse = PromiseResponseType<ChatGPT4['talk']>;
+export {};