ctod 0.7.2 → 0.8.1

package/examples/plugin.ts

@@ -1,10 +1,7 @@
-// eslint-disable-next-line @typescript-eslint/triple-slash-reference
-/// <reference path="../lib/shims.d.ts" />
-
 import fs from 'fs'
 import { flow } from 'power-helper'
 import { prompt } from 'inquirer'
-import { CtoD, ChatBrokerPlugin, plugins, OpenAI } from '../lib/index'
+import { CtoD, ChatBrokerPlugin, plugins, OpenAICtodService } from '../lib/index'
 
 /**
  * @test npx esno ./examples/plugin.ts
@@ -71,7 +68,7 @@ flow.run(async () => {
                 })
             }
         },
-        request: OpenAI.createChatRequestWithJsonSchema({
+        request: OpenAICtodService.createChatRequestWithJsonSchema({
             apiKey,
             config: {
                 model: 'gpt-4o'

package/lib/core/parser.ts

@@ -3,7 +3,7 @@ import JSON5 from 'json5'
 type TextParserParams = {
     /**
      * @zh 解讀器名字。
-     * @en The name of the parser. 
+     * @en The name of the parser.
      */
     name: string
     /**
@@ -43,7 +43,7 @@ export class TextParser {
 
     /**
      * @zh 解讀器名字。
-     * @en The name of the parser. 
+     * @en The name of the parser.
      */
 
     get name() {

package/lib/core/translator.ts

@@ -13,7 +13,7 @@ export type TranslatorParams<
     input?: S
     /**
      * @zh 輸出的資料格式。
-     * @en The output data format. 
+     * @en The output data format.
      */
     output: O
     /**
@@ -46,6 +46,7 @@ export class Translator<
     get __schemeType(): ValidateCallbackOutputs<S> {
         return null as any
     }
+
     get __outputType(): ValidateCallbackOutputs<O> {
         return null as any
     }

package/lib/ctod.ts

@@ -39,7 +39,7 @@ export class CtoD<
                     P,
                     PS,
                     ChatBrokerHooks<() => I, () => O, P, PS>
-                        >({
+                >({
                             output: () => ({} as any),
                             install: (context) => {
                                 params?.install?.(context)
@@ -62,7 +62,7 @@ export class CtoD<
                                     changeOutputSchema(() => schema)
                                 })
                             },
-                            plugins: this.params.plugins ? (() => this.params.plugins!()) : undefined,
+                            plugins: this.params.plugins ? () => this.params.plugins!() : undefined,
                             request: this.params.request
                         })
             }

package/lib/index.ts

@@ -1,41 +1,17 @@
 export * as plugins from './plugins'
 export * as templates from './templates'
 export { CtoD } from './ctod'
-export { validateToJsonSchema, defineYupSchema, ValidateCallback } from './utils/validate'
-export { OpenAI } from './service/openai'
-export { Llama3Cpp } from './service/llama3.cpp'
+export { validateToJsonSchema, defineYupSchema } from './utils/validate'
+
+export { OpenAICtodService } from './service/openai'
+export { Llama3CppCtodService } from './service/llama3.cpp'
+export { GoogleCtodService } from './service/google'
+
 export { TextParser } from './core/parser'
-export { ChatGPTMessage } from './service/openai/chat'
 export { ChatBroker } from './broker/chat'
 export { ChatBrokerPlugin } from './core/plugin'
-export { Translator, TranslatorParams } from './core/translator'
-
-import * as plugins from './plugins'
-import * as templates from './templates'
-import { OpenAI } from './service/openai'
-import { CtoD } from './ctod'
-import { Llama3Cpp } from './service/llama3.cpp'
-import { Translator } from './core/translator'
-import { TextParser } from './core/parser'
-import { ChatBroker } from './broker/chat'
-import { ChatBrokerPlugin } from './core/plugin'
-import { validateToJsonSchema, defineYupSchema } from './utils/validate'
-
-export const ctod = {
-    CtoD,
-    OpenAI,
-    Llama3Cpp,
-    plugins,
-    templates,
-    ChatBroker,
-    Translator,
-    TextParser,
-    ChatBrokerPlugin,
-    defineYupSchema,
-    validateToJsonSchema
-}
-
-module.exports = ctod
-module.exports.ctod = ctod
+export { Translator } from './core/translator'
 
-export default ctod
+export type { ValidateCallback } from './utils/validate'
+export type { TranslatorParams } from './core/translator'
+export type { ChatGPTMessage } from './service/openai/chat'

package/lib/plugins/index.ts

@@ -35,4 +35,4 @@ export const LimiterPluginGlobState = Limiter
  * @en Set role play.
  */
 
-export const RolePlugin = Role
+export const RolePlugin = Role

package/lib/service/google/chat.ts

@@ -0,0 +1,110 @@
+import { json } from 'power-helper'
+import { GoogleCtodService } from './index'
+import { PromiseResponseType } from '../../types'
+
+/**
+ *  if data:
+ *  data: base64 string,
+ *  mimeType: image/jpeg,
+ */
+
+type Part = {
+    text: string
+} | {
+    inlineData: {
+        data: string
+        mimeType: string
+    }
+}
+
+export type GoogleMessage = {
+    role: 'model' | 'user'
+    parts: Part[]
+}
+
+export type Config = {
+    /**
+     * @zh 選擇運行的模型。
+     * @en What model to use.
+     */
+    model: string
+}
+
+export class GoogleChat {
+    google: GoogleCtodService
+    config: Config = {
+        model: 'gemini-1.5-flash'
+    }
+
+    constructor(google: GoogleCtodService) {
+        this.google = google
+    }
+
+    /**
+     * @zh 改變對話的一些設定
+     * @en Change some settings of the conversation
+     */
+
+    setConfig(options: Partial<Config>) {
+        Object.assign(this.config, options)
+    }
+
+    /**
+     * @zh 進行對話
+     * @en Talk to the AI
+     */
+
+    async talk(messages: GoogleMessage[] = []) {
+        const newMessages = json.jpjs(messages)
+        const model = this.google.generativeAI.getGenerativeModel({
+            model: this.config.model
+        })
+        const result = await model.generateContent({
+            contents: newMessages
+        })
+        const text = result.response.text()
+        return {
+            text,
+            newMessages: [
+                ...newMessages,
+                {
+                    role: 'model',
+                    parts: [
+                        {
+                            text
+                        }
+                    ]
+                }
+            ]
+        }
+    }
+
+    talkStream(params: {
+        messages: GoogleMessage[]
+        onMessage: (_message: string) => void
+        onEnd: () => void
+        onWarn: (_warn: any) => void
+        onError: (_error: any) => void
+    }) {
+        const model = this.google.generativeAI.getGenerativeModel({
+            model: this.config.model
+        })
+        const context = {
+            contents: params.messages
+        }
+        model
+            .generateContentStream(context)
+            .then(async({ stream }) => {
+                for await (const chunk of stream) {
+                    const chunkText = chunk.text()
+                    params.onMessage(chunkText)
+                }
+                params.onEnd()
+            })
+            .catch((error) => {
+                params.onError(error)
+            })
+    }
+}
+
+export type GoogleChatTalkResponse = PromiseResponseType<GoogleChat['talk']>

package/lib/service/google/index.ts

@@ -0,0 +1,101 @@
+import { validateToJsonSchema } from '../../utils/validate'
+import { GoogleMessage, GoogleChat } from './chat'
+import type { GoogleGenerativeAI } from '@google/generative-ai'
+
+type GPTContent = {
+    type: 'image_url' | 'text'
+    text?: string
+    image_url?: {
+        url: string
+        detail?: string
+    }
+}
+
+type GPTMessage = {
+    role: 'system' | 'user' | 'assistant'
+    content: string | GPTContent[]
+}
+
+export class GoogleCtodService {
+    generativeAI: GoogleGenerativeAI
+
+    constructor(generativeAI: GoogleGenerativeAI) {
+        this.generativeAI = generativeAI
+    }
+
+    static chatGPTMessageToGoogleChatMessage(messages: GPTMessage[]): GoogleMessage[] {
+        const contentToParts = (content: string | GPTMessage['content']): GoogleMessage['parts'] => {
+            if (typeof content === 'string') {
+                return [
+                    {
+                        text: content
+                    }
+                ]
+            } else if (Array.isArray(content)) {
+                return content.map(({ type, image_url, text }): GoogleMessage['parts'][number] => {
+                    if (type === 'image_url') {
+                        return {
+                            inlineData: {
+                                data: image_url?.url || '',
+                                mimeType: 'image/jpeg'
+                            }
+                        }
+                    } else {
+                        return {
+                            text: text || ''
+                        }
+                    }
+                })
+            }
+            return []
+        }
+        return messages.map((message) => {
+            if (message.role === 'user' || message.role === 'system') {
+                return {
+                    role: 'user',
+                    parts: contentToParts(message.content)
+                }
+            } else {
+                return {
+                    role: 'model',
+                    parts: contentToParts(message.content)
+                }
+            }
+        })
+    }
+
+    static createChatRequestWithJsonSchema(params: {
+        googleGenerativeAI: GoogleGenerativeAI
+        model: string
+    }) {
+        const removeAdditionalProperties = (schema: any) => {
+            if (schema.type === 'object') {
+                delete schema.additionalProperties
+                Object.keys(schema.properties).forEach((key) => {
+                    removeAdditionalProperties(schema.properties[key])
+                })
+            } else if (schema.type === 'array') {
+                removeAdditionalProperties(schema.items)
+            }
+            return schema
+        }
+        return async (messages: any[], { schema }: any) => {
+            const responseSchema = removeAdditionalProperties(validateToJsonSchema(schema.output))
+            const model = params.googleGenerativeAI.getGenerativeModel({
+                model: params.model,
+                generationConfig: {
+                    responseMimeType: 'application/json',
+                    responseSchema
+                }
+            })
+            const result = await model.generateContent({
+                contents: GoogleCtodService.chatGPTMessageToGoogleChatMessage(messages)
+            })
+            return result.response.text()
+        }
+    }
+
+    createChat() {
+        return new GoogleChat(this)
+    }
+}

package/lib/service/llama3.cpp/completion.ts

@@ -1,6 +1,6 @@
-import { Llama3Cpp } from './index'
+import { Llama3CppCtodService } from './index'
 import { flow } from 'power-helper'
-import { tify, sify } from 'chinese-conv'
+import { tify, sify } from 'chinese-conv/dist'
 
 type Message = {
     role: string
@@ -150,14 +150,14 @@ class Requester {
 }
 
 export class Llama3CppCompletion {
-    core: Llama3Cpp
+    core: Llama3CppCtodService
     config: Config = {
         baseUrl: '',
         headers: {},
         autoConvertTraditionalChinese: true
     }
 
-    constructor(core: Llama3Cpp) {
+    constructor(core: Llama3CppCtodService) {
         this.core = core
     }
 
@@ -248,7 +248,7 @@ export class Llama3CppCompletion {
         options?: Options
         messages: Message[]
         response_format?: {
-            type: 'json_object',
+            type: 'json_object'
             schema: any
         }
     }) {

package/lib/service/llama3.cpp/index.ts

@@ -1,17 +1,17 @@
 import axios, { AxiosInstance } from 'axios'
-import { sify } from 'chinese-conv'
+import { sify } from 'chinese-conv/dist'
 import { validateToJsonSchema } from '../../utils/validate'
 import { Llama3CppCompletion, Config } from './completion'
 
-export class Llama3Cpp {
+export class Llama3CppCtodService {
     _axios = axios.create()
 
-    static createChatRequest(params: {
+    static createChatRequestWithJsonSchema(params: {
         config: Partial<Config> | (() => Promise<Partial<Config>>)
         talkOptions?: any
     }) {
         return async(messages: any[], { schema, onCancel }: any) => {
-            const ll3cpp = new Llama3Cpp()
+            const ll3cpp = new Llama3CppCtodService()
             const chat = ll3cpp.createCompletion()
             const config = typeof params.config === 'function' ? await params.config() : params.config
             chat.setConfig(config)

package/lib/service/openai/chat.ts

@@ -1,5 +1,5 @@
 import { json } from 'power-helper'
-import { OpenAI } from './index'
+import { OpenAICtodService } from './index'
 import { PromiseResponseType } from '../../types'
 
 export type ChatGPTMessage = {
@@ -35,10 +35,10 @@ export type Config = {
      */
     n: number
     /**
-     * @zh 選擇運行的模型，16k意味著能處理長度為 16,384 的文本，32k意味著能處理長度為 32768 的文本。
-     * @en How many chat completion choices to generate for each input message.
+     * @zh 選擇運行的模型，建議: 'gpt-4' | 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'o1-preview' | 'o1' | 'o1-mini'
+     * @en What model to use, recommended: 'gpt-4' | 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'o1-preview' | 'o1' | 'o1-mini'
      */
-    model: 'gpt-4' | 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'o1-preview' | 'o1' | 'o1-mini'
+    model: string
     /**
      * @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.
@@ -57,7 +57,7 @@ export type Config = {
 }
 
 export class OpenAIChat {
-    openai: OpenAI
+    openai: OpenAICtodService
     config: Config = {
         n: 1,
         model: 'gpt-4o',
@@ -66,7 +66,7 @@ export class OpenAIChat {
         forceJsonFormat: true
     }
 
-    constructor(openai: OpenAI) {
+    constructor(openai: OpenAICtodService) {
         this.openai = openai
     }
 
@@ -110,7 +110,7 @@ export class OpenAIChat {
         abortController?: AbortController
     }) {
         const newMessages = json.jpjs(messages)
-        const isSupportJson =  [
+        const isSupportJson = [
             'gpt-4-turbo-preview',
             'gpt-4-turbo',
             'gpt-4o',
@@ -153,23 +153,23 @@ export class OpenAIChat {
             text: message.content as string,
             newMessages,
             isDone: choices[0]?.finish_reason === 'stop',
-            apiReseponse: result.data
+            apiResponse: result.data
         }
     }
 
     talkStream(params: {
         messages: any[]
-        onMessage: (message: string) => void
+        onMessage: (_message: string) => void
         onEnd: () => void
-        onWarn: (warn: any) => void
-        onError: (error: any) => void
+        onWarn: (_warn: any) => void
+        onError: (_error: any) => void
     }) {
         const controller = new AbortController()
         fetch('https://api.openai.com/v1/chat/completions', {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
-                Authorization: `Bearer ${this.openai._apiKey}`
+                'Authorization': `Bearer ${this.openai._apiKey}`
             },
             body: JSON.stringify({
                 model: this.config.model,
@@ -178,12 +178,11 @@ export class OpenAIChat {
             }),
             signal: controller.signal
         }).then(async response => {
-            // eslint-disable-next-line no-undef
             const reader = response.body?.pipeThrough(new TextDecoderStream()).getReader()
             if (!reader) {
                 throw new Error('Can not get reader')
             }
-            // eslint-disable-next-line no-constant-condition
+
             while (true) {
                 const { value, done } = await reader.read()
                 if (done) {

package/lib/service/openai/images-generation.ts

@@ -1,4 +1,4 @@
-import { OpenAI } from './index'
+import { OpenAICtodService } from './index'
 
 type ApiResponse = {
     created: string
@@ -21,13 +21,13 @@ type Config = {
 }
 
 export class OpenAIImagesGeneration {
-    private openai: OpenAI
+    private openai: OpenAICtodService
     private config: Config = {
         model: 'dall-e-2',
         size: '1024x1024'
     }
 
-    constructor(openai: OpenAI) {
+    constructor(openai: OpenAICtodService) {
         this.openai = openai
     }
 

package/lib/service/openai/index.ts

@@ -4,7 +4,7 @@ import { OpenAIChat, Config } from './chat'
 import { OpenAIImagesGeneration } from './images-generation'
 import { validateToJsonSchema } from '../../utils/validate'
 
-export class OpenAI {
+export class OpenAICtodService {
     _axios = axios.create()
     _apiKey = ''
 
@@ -13,10 +13,10 @@ export class OpenAI {
         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 openai = new OpenAICtodService(typeof apiKey === 'string' ? apiKey : await apiKey())
             const chat = openai.createChat()
             const abortController = new AbortController()
             if (options && options.axios) {
@@ -31,13 +31,13 @@ export class OpenAI {
         }
     }
 
-    static createChatRequestWithJsonSchema(params:{
-        axios?: any,
-        apiKey: string | (() => Promise<string>),
+    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 openai = new OpenAICtodService(typeof params.apiKey === 'string' ? params.apiKey : await params.apiKey())
             const chat = openai.createChat()
             const abortController = new AbortController()
             if (params.config) {
@@ -60,7 +60,6 @@ export class OpenAI {
         }
     }
 
-
     constructor(apiKey = '') {
         this._apiKey = apiKey
     }

package/lib/service/openai/vision.ts

@@ -1,4 +1,4 @@
-import { OpenAI } from './index'
+import { OpenAICtodService } from './index'
 import { PromiseResponseType } from '../../types'
 
 type ImageContent = {
@@ -10,7 +10,7 @@ type ImageContent = {
     }
 }
 
-type VisionMessage = {
+export type VisionMessage = {
     role: 'system' | 'user' | 'assistant'
     name?: string
     content: string | ImageContent[]
@@ -57,14 +57,14 @@ export type Config = {
 }
 
 export class OpenAIVision {
-    openai: OpenAI
+    openai: OpenAICtodService
     config: Config = {
         model: 'gpt-4-vision-preview',
         maxTokens: undefined,
         temperature: 1
     }
 
-    constructor(openai: OpenAI) {
+    constructor(openai: OpenAICtodService) {
         this.openai = openai
     }
 
@@ -103,7 +103,7 @@ export class OpenAIVision {
         return {
             id: result?.data.id as string,
             text: message.content as string,
-            apiReseponse: result.data
+            apiResponse: result.data
         }
     }
 }

package/lib/types.ts

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

package/lib/utils/validate.ts

@@ -10,7 +10,7 @@ export type ValidateCallbackOutputs<
     T extends ValidateCallback<any>,
     R = ReturnType<T>
 > = {
-    [K in keyof R]: R[K] extends { '__outputType': any } ? R[K]['__outputType'] : R[K]
+    [K in keyof R]: R[K] extends { __outputType: any } ? R[K]['__outputType'] : R[K]
 }
 
 export function definedValidateSchema<T extends ValidateCallback<any>>(cb: T): T {
@@ -22,7 +22,7 @@ export function validate<
     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]
+        [K in keyof R]: R[K] extends { __outputType: any } ? R[K]['__outputType'] : R[K]
     }
 }