ctod 0.7.1 → 0.7.2

package/lib/service/openai/index.ts

@@ -0,0 +1,97 @@
+import axios from 'axios'
+import { OpenAIVision } from './vision'
+import { OpenAIChat, Config } from './chat'
+import { OpenAIImagesGeneration } from './images-generation'
+import { validateToJsonSchema } from '../../utils/validate'
+
+export class OpenAI {
+    _axios = axios.create()
+    _apiKey = ''
+
+    static createChatRequest(
+        apiKey: string | (() => Promise<string>),
+        config: Partial<Config> | (() => Promise<Partial<Config>>) = {},
+        options?: {
+            axios?: any
+        }    
+    ) {
+        return async(messages: any[], { onCancel }: any) => {
+            const openai = new OpenAI(typeof apiKey === 'string' ? apiKey : await apiKey())
+            const chat = openai.createChat()
+            const abortController = new AbortController()
+            if (options && options.axios) {
+                openai.setAxios(options.axios)
+            }
+            chat.setConfig(typeof config === 'function' ? await config() : config)
+            onCancel(() => abortController.abort())
+            const { text } = await chat.talk(messages, {
+                abortController
+            })
+            return text
+        }
+    }
+
+    static createChatRequestWithJsonSchema(params:{
+        axios?: any,
+        apiKey: string | (() => Promise<string>),
+        config?: Partial<Pick<Config, 'model' | 'temperature'>> | (() => Promise<Partial<Pick<Config, 'model' | 'temperature'>>>)
+    }) {
+        return async(messages: any[], { schema, onCancel }: any) => {
+            const openai = new OpenAI(typeof params.apiKey === 'string' ? params.apiKey : await params.apiKey())
+            const chat = openai.createChat()
+            const abortController = new AbortController()
+            if (params.config) {
+                chat.setConfig(typeof params.config === 'function' ? await params.config() : params.config)
+            }
+            if (params.axios) {
+                openai.setAxios(params.axios)
+            }
+            onCancel(() => abortController.abort())
+            const jsonSchema = validateToJsonSchema(schema.output)
+            const { text } = await chat.talk(messages, {
+                abortController,
+                jsonSchema: {
+                    name: 'data',
+                    strict: true,
+                    schema: jsonSchema
+                }
+            })
+            return text
+        }
+    }
+
+
+    constructor(apiKey = '') {
+        this._apiKey = apiKey
+    }
+
+    /**
+     * @zh 如果你有需要特別設定 axios，請使用這方法。
+     * @en If you need to set axios, please use this method.
+     */
+
+    setAxios(axios: any) {
+        this._axios = axios
+    }
+
+    /**
+     * @zh 設定 api key。
+     * @en Set api key.
+     */
+
+    setConfiguration(apiKey: string) {
+        this._apiKey = apiKey
+    }
+
+    createChat() {
+        return new OpenAIChat(this)
+    }
+
+    createVision() {
+        return new OpenAIVision(this)
+    }
+
+    createImagesGeneration() {
+        return new OpenAIImagesGeneration(this)
+    }
+}

package/lib/service/openai/vision.ts

@@ -0,0 +1,111 @@
+import { OpenAI } from './index'
+import { PromiseResponseType } from '../../types'
+
+type ImageContent = {
+    type: 'image_url' | 'text'
+    text?: string
+    image_url?: {
+        url: string
+        detail?: string
+    }
+}
+
+type VisionMessage = {
+    role: 'system' | 'user' | 'assistant'
+    name?: string
+    content: string | ImageContent[]
+}
+
+type ApiResponse = {
+    id: string
+    object: string
+    created: number
+    model: string
+    usage: {
+        prompt_tokens: number
+        completion_tokens: number
+        total_tokens: number
+    }
+    choices: Array<{
+        message: {
+            role: string
+            content: string
+        }
+        finish_details: {
+            type: string
+        }
+        index: number
+    }>
+}
+
+export type Config = {
+    /**
+     * @zh 選擇運行的模型。
+     * @en How many chat completion choices to generate for each input message.
+     */
+    model: 'gpt-4-vision-preview'
+    /**
+     * @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
+    /**
+     * @zh 每次對話最多產生幾個 tokens。
+     * @en How many tokens to complete to.
+     */
+    maxTokens?: number
+}
+
+export class OpenAIVision {
+    openai: OpenAI
+    config: Config = {
+        model: 'gpt-4-vision-preview',
+        maxTokens: undefined,
+        temperature: 1
+    }
+
+    constructor(openai: OpenAI) {
+        this.openai = openai
+    }
+
+    /**
+     * @zh 改變對話的一些設定
+     * @en Change some settings of the conversation
+     */
+
+    setConfig(options: Partial<Config>) {
+        Object.assign(this.config, options)
+    }
+
+    /**
+     * @zh 辨識圖片
+     * @en Recognize images
+     */
+
+    async view(messages: VisionMessage[]) {
+        const result = await this.openai._axios.post<ApiResponse>('https://api.openai.com/v1/chat/completions', {
+            model: this.config.model,
+            n: 1,
+            messages,
+            max_tokens: this.config.maxTokens,
+            temperature: this.config.temperature
+        }, {
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': `Bearer ${this.openai._apiKey}`
+            }
+        })
+        const choices = result.data.choices || []
+        const message = choices[0]?.message || {
+            role: 'assistant',
+            content: ''
+        }
+        return {
+            id: result?.data.id as string,
+            text: message.content as string,
+            apiReseponse: result.data
+        }
+    }
+}
+
+export type OpenAIChatVisionResponse = PromiseResponseType<OpenAIVision['view']>

package/lib/shims.d.ts

@@ -0,0 +1,4 @@
+declare module 'chinese-conv' {
+    export function tify(text: string): string
+    export function sify(text: string): string
+}

package/lib/templates.ts

@@ -0,0 +1,71 @@
+import Handlebars from 'handlebars'
+import { record } from 'power-helper'
+
+type JsonResponseFormat = {
+    desc: string
+    example: any
+}
+
+/**
+ * @zh 協助使用者將格式需求轉成論敘語句。
+ * @en Assist the user in converting the formatting requirements into declarative sentences.
+ */
+
+export const requireJsonResponse = (question: string | string[], format: Record<string, JsonResponseFormat>) => {
+    return [
+        ...(Array.isArray(question) ? question : [question]),
+        'Please respond using the following JSON format and minify the JSON without including any explanation: ',
+        '{',
+        Object.entries(format).map(([key, value]) => {
+            return [
+                `/* ${value.desc} */`,
+                `"${key}": ${JSON.stringify(value.example)}`,
+            ].join('\n')
+        }).join(',\n'),
+        '}'
+    ].join('\n')
+}
+
+/**
+ * @zh 協助使用者將格式需求轉成論敘語句，支援 Handlebars。
+ * @en Assist the user in converting the formatting requirements into declarative sentences, support Handlebars.
+ */
+
+export const requireJsonResponseWithHandlebars = (
+    value: Record<string, any>,
+    question: string | string[],
+    format: Record<string, JsonResponseFormat>
+) => {
+    const handlebars = Handlebars.create()
+
+    handlebars.registerHelper('DATA', function(this: any, value) {
+        return JSON.stringify(value)
+    })
+
+    handlebars.registerHelper('ENV', function(this: any, value) {
+        return this.__envs && value ? this.__envs[value] : ''
+    })
+
+    handlebars.registerHelper('INPUT', function(this: any) {
+        return JSON.stringify(record.omit(this, ['__envs']))
+    })
+
+    handlebars.registerHelper('JOIN', function(this: any, value) {
+        return Array.isArray(value) ? value.join() : JSON.stringify(value)
+    })
+
+    return handlebars.compile(requireJsonResponse(question, format))(value)
+}
+
+/**
+ * @zh 協助使用者將格式需求轉成論敘語句，並支援 Json Schema。
+ * @en Assist the user in converting the formatting requirements into declarative sentences, and support Json Schema.
+ */
+
+export const requireJsonResponseWithJsonSchema = (question: string | string[], format: Record<string, any>) => {
+    return [
+        ...(Array.isArray(question) ? question : [question]),
+        'Please provide JSON data according to the following JSON Schema format:',
+        JSON.stringify(format)
+    ].join('\n')
+}

package/lib/types.ts

@@ -0,0 +1,4 @@
+export type PromiseResponseType<
+    T extends (...args: any) => Promise<any>,
+    R = Parameters<ReturnType<T>['then']>[0]
+> =  R extends (value: infer P) => any ? P : never

package/lib/utils/error.ts

@@ -0,0 +1,14 @@
+type ParserFail = {
+    name: string
+    error: any
+}
+
+export class ParserError {
+    isParserError = true
+    parserFails: ParserFail[] = []
+    error: any
+    constructor(error: any, parserFails: ParserFail[]) {
+        this.error = error
+        this.parserFails = parserFails
+    }
+}

package/lib/utils/validate.ts

@@ -0,0 +1,64 @@
+import * as Yup from 'yup'
+import { convertSchema } from '@sodaru/yup-to-json-schema'
+import { Schema } from 'yup'
+
+export type ValidateCallback<T extends Record<string, Schema>> = (_yup: typeof Yup) => {
+    [K in keyof T]: T[K]
+}
+
+export type ValidateCallbackOutputs<
+    T extends ValidateCallback<any>,
+    R = ReturnType<T>
+> = {
+    [K in keyof R]: R[K] extends { '__outputType': any } ? R[K]['__outputType'] : R[K]
+}
+
+export function definedValidateSchema<T extends ValidateCallback<any>>(cb: T): T {
+    return cb
+}
+
+export function validate<
+    T extends ValidateCallback<any>,
+    R = ReturnType<T>
+>(target: any, schemaCallback: T) {
+    return Yup.object(schemaCallback(Yup)).required().validateSync(target || {}) as {
+        [K in keyof R]: R[K] extends { '__outputType': any } ? R[K]['__outputType'] : R[K]
+    }
+}
+
+export const defineYupSchema = <T extends Record<string, Schema>>(cb: ValidateCallback<T>): T => {
+    return cb(Yup)
+}
+
+export const validateToJsonSchema = <T extends ValidateCallback<any>>(cb: T) => {
+    const removeAllDefault = (schema: any) => {
+        if (schema.default) {
+            delete schema.default
+        }
+        if (schema.properties) {
+            for (let key in schema.properties) {
+                if (schema.properties[key].default) {
+                    delete schema.properties[key].default
+                }
+                removeAllDefault(schema.properties[key])
+            }
+        }
+        if (schema.items) {
+            removeAllDefault(schema.items)
+        }
+    }
+    const addAllAdditionalProperties = (jsonSchema: any) => {
+        if (jsonSchema.type === 'object') {
+            jsonSchema.additionalProperties = false
+            for (const key in jsonSchema.properties) {
+                addAllAdditionalProperties(jsonSchema.properties[key])
+            }
+        } else if (jsonSchema.type === 'array') {
+            addAllAdditionalProperties(jsonSchema.items)
+        }
+    }
+    const jsonSchema = convertSchema(Yup.object(cb(Yup)))
+    removeAllDefault(jsonSchema)
+    addAllAdditionalProperties(jsonSchema)
+    return jsonSchema
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ctod",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "CtoD Is Chat To Data Utils.",
   "main": "./dist/index.js",
   "scripts": {

package/types/examples/basic.d.ts

@@ -0,0 +1 @@
+export {};

package/types/examples/chat-demo.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

package/types/examples/chat-for-llama.cpp-demo.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

package/types/examples/chat-with-json-schema-demo.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

package/types/examples/llama.cpp.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

package/types/examples/plugin-demo.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

package/types/examples/plugin.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

package/types/examples/stream-for-llama.cpp-demo.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

package/types/examples/vision-demo.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="lib/shims" />
+export {};

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

@@ -0,0 +1,150 @@
+import { ChatBrokerPlugin } from '../core/plugin';
+import { Event, Hook, Log } from 'power-helper';
+import { Translator, TranslatorParams } from '../core/translator';
+import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate';
+export type Message = {
+    role: 'system' | 'user' | 'assistant' | (string & Record<string, unknown>);
+    name?: string;
+    content: string;
+};
+export type ChatBrokerHooks<S extends ValidateCallback<any>, O extends ValidateCallback<any>, P extends ChatBrokerPlugin<any, any>, PS extends Record<string, ReturnType<P['use']>>> = {
+    /**
+     * @zh 第一次聊天的時候觸發
+     * @en Triggered when chatting for the first time
+     */
+    start: {
+        id: string;
+        data: ValidateCallbackOutputs<S>;
+        metadata: Map<string, any>;
+        plugins: {
+            [K in keyof PS]: {
+                send: (data: PS[K]['__receiveData']) => void;
+            };
+        };
+        schema: {
+            input?: S;
+            output: O;
+        };
+        messages: Message[];
+        setPreMessages: (messages: (Omit<Message, 'content'> & {
+            content: string | string[];
+        })[]) => void;
+        changeMessages: (messages: Message[]) => void;
+        changeOutputSchema: (output: O) => void;
+    };
+    /**
+     * @zh 發送聊天訊息給機器人前觸發
+     * @en Triggered before sending chat message to bot
+     */
+    talkBefore: {
+        id: string;
+        data: ValidateCallbackOutputs<S>;
+        messages: Message[];
+        metadata: Map<string, any>;
+        lastUserMessage: string;
+    };
+    /**
+     * @zh 當聊天機器人回傳資料的時候觸發
+     * @en Triggered when the chatbot returns data
+     */
+    talkAfter: {
+        id: string;
+        data: ValidateCallbackOutputs<S>;
+        response: any;
+        messages: Message[];
+        parseText: string;
+        metadata: Map<string, any>;
+        lastUserMessage: string;
+        /**
+         * @zh 宣告解析失敗
+         * @en Declare parsing failure
+         */
+        parseFail: (error: any) => void;
+        changeParseText: (text: string) => void;
+    };
+    /**
+     * @zh 當回傳資料符合規格時觸發
+     * @en Triggered when the returned data meets the specifications
+     */
+    succeeded: {
+        id: string;
+        metadata: Map<string, any>;
+        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: any;
+        metadata: Map<string, any>;
+        parserFails: {
+            name: string;
+            error: any;
+        }[];
+        messages: Message[];
+        lastUserMessage: string;
+        changeMessages: (messages: Message[]) => void;
+    };
+    /**
+     * @zh 不論成功失敗，執行結束的時候會執行。
+     * @en It will be executed when the execution is completed, regardless of success or failure.
+     */
+    done: {
+        id: string;
+        metadata: Map<string, any>;
+    };
+};
+export type RequestContext = {
+    id: string;
+    count: number;
+    isRetry: boolean;
+    metadata: Map<string, any>;
+    onCancel: (cb: () => void) => void;
+    schema: {
+        input: any;
+        output: any;
+    };
+};
+export type Params<S extends ValidateCallback<any>, O extends ValidateCallback<any>, C extends Record<string, any>, P extends ChatBrokerPlugin<any, any>, PS extends Record<string, ReturnType<P['use']>>> = Omit<TranslatorParams<S, O>, 'parsers'> & {
+    name?: string;
+    plugins?: PS | (() => PS);
+    request: (messages: Message[], context: RequestContext) => Promise<string>;
+    install?: (context: {
+        log: Log;
+        attach: Hook<C>['attach'];
+        attachAfter: Hook<C>['attachAfter'];
+        translator: Translator<S, O>;
+    }) => void;
+};
+export declare class ChatBroker<S extends ValidateCallback<any>, O extends ValidateCallback<any>, P extends ChatBrokerPlugin<any, any>, PS extends Record<string, ReturnType<P['use']>>, C extends ChatBrokerHooks<S, O, P, PS> = ChatBrokerHooks<S, O, P, PS>> {
+    protected __hookType: C;
+    protected log: Log;
+    protected hook: Hook<C>;
+    protected params: Params<S, O, C, P, PS>;
+    protected plugins: PS;
+    protected installed: boolean;
+    protected translator: Translator<S, O>;
+    protected event: Event<{
+        cancel: {
+            requestId: string;
+        };
+        cancelAll: any;
+    }>;
+    constructor(params: Params<S, O, C, P, PS>);
+    protected _install(): any;
+    cancel(requestId?: string): Promise<void>;
+    requestWithId<T extends Translator<S, O>>(data: T['__schemeType']): {
+        id: string;
+        request: Promise<T['__outputType']>;
+    };
+    /**
+     * @zh 將請求發出至聊天機器人。
+     * @en Send request to chatbot.
+     */
+    request<T extends Translator<S, O>>(data: T['__schemeType']): Promise<T['__outputType']>;
+}

package/types/lib/core/parser.d.ts

@@ -0,0 +1,32 @@
+type TextParserParams = {
+    /**
+     * @zh 解讀器名字。
+     * @en The name of the parser.
+     */
+    name: string;
+    /**
+     * @zh 解讀文本。
+     * @en Read the text.
+     */
+    handler: (text: string) => Promise<any>;
+};
+export declare class TextParser {
+    private params;
+    /**
+     * @zh 盡可能將文字內的 json 解讀出來。
+     * @en Try to read the json in the text as much as possible.
+     */
+    static JsonMessage(): TextParser;
+    constructor(params: TextParserParams);
+    /**
+     * @zh 解讀器名字。
+     * @en The name of the parser.
+     */
+    get name(): string;
+    /**
+     * @zh 解讀文本。
+     * @en Read the text.
+     */
+    read(text: string): Promise<any>;
+}
+export {};

package/types/lib/core/plugin.d.ts

@@ -0,0 +1,34 @@
+import { Translator } from './translator';
+import { ChatBrokerHooks } from '../broker/chat';
+import { Log, Hook, Event } from 'power-helper';
+import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate';
+type BrokerHooks = ChatBrokerHooks<any, any, any, any>;
+type BrokerPluginParams<T extends ValidateCallback<any>, R extends ValidateCallback<any>> = {
+    name: string;
+    params: T;
+    receiveData: R;
+    onInstall: (context: {
+        log: Log;
+        params: ValidateCallbackOutputs<T>;
+        attach: Hook<BrokerHooks>['attach'];
+        attachAfter: Hook<BrokerHooks>['attachAfter'];
+        translator: Translator<any, any>;
+        receive: (callback: (params: {
+            id: string;
+            data: ValidateCallbackOutputs<R>;
+        }) => void) => void;
+    }) => void;
+};
+export declare class ChatBrokerPlugin<T extends ValidateCallback<any>, R extends ValidateCallback<any>> {
+    _event: Event<Record<string, Record<string, any>>>;
+    _params: BrokerPluginParams<T, R>;
+    constructor(params: BrokerPluginParams<T, R>);
+    use(params: ValidateCallbackOutputs<T>): {
+        instance: any;
+        params: ValidateCallbackOutputs<T, ReturnType<T>>;
+        send: (data: ValidateCallbackOutputs<R>) => void;
+        receive: (callback: any) => void;
+        __receiveData: ValidateCallbackOutputs<R, ReturnType<R>>;
+    };
+}
+export {};