ctod 0.7.0 → 0.7.1

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

@@ -1,110 +0,0 @@
-import { OpenAI } from './index';
-import { PromiseResponseType } from '../../types';
-export type ChatGPTMessage = {
-    role: 'system' | 'user' | 'assistant';
-    name?: string;
-    content: string;
-};
-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;
-    };
-};
-export type Config = {
-    /**
-     * @zh 一次回應數量
-     * @en How many chat completion choices to generate for each input message.
-     */
-    n: number;
-    /**
-     * @zh 選擇運行的模型，16k意味著能處理長度為 16,384 的文本，32k意味著能處理長度為 32768 的文本。
-     * @en How many chat completion choices to generate for each input message.
-     */
-    model: 'gpt-4' | 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'o1-preview' | 'o1' | 'o1-mini';
-    /**
-     * @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 是否強制要回傳 JSON 格式的資料
-     * @en Whether to force the return of JSON format data
-     */
-    forceJsonFormat: boolean;
-    /**
-     * @zh 每次對話最多產生幾個 tokens。
-     * @en How many tokens to complete to.
-     */
-    maxTokens?: number;
-};
-export declare class OpenAIChat {
-    openai: OpenAI;
-    config: Config;
-    constructor(openai: OpenAI);
-    /**
-     * @zh 改變對話的一些設定
-     * @en Change some settings of the conversation
-     */
-    setConfig(options: Partial<Config>): void;
-    /**
-     * @zh 檢視內容是否符合 OpenAI 的審查
-     * @en View content for OpenAI moderation
-     */
-    moderations(input: string): Promise<{
-        isSafe: boolean;
-        result: any;
-    }>;
-    /**
-     * @zh 進行對話
-     * @en Talk to the AI
-     */
-    talk(messages?: ChatGPTMessage[], options?: {
-        /** 要 forceJsonFormat 為 true 才會生效 */
-        jsonSchema?: any;
-        abortController?: AbortController;
-    }): Promise<{
-        id: string;
-        text: string;
-        newMessages: ChatGPTMessage[];
-        isDone: boolean;
-        apiReseponse: ApiResponse;
-    }>;
-    talkStream(params: {
-        messages: any[];
-        onMessage: (message: string) => void;
-        onEnd: () => void;
-        onWarn: (warn: any) => void;
-        onError: (error: any) => void;
-    }): {
-        cancel: () => void;
-    };
-    /**
-     * @zh 開啟持續性對話
-     */
-    keepTalk(prompt: string | string[], oldMessages?: ChatGPTMessage[]): Promise<{
-        result: {
-            id: string;
-            text: string;
-            newMessages: ChatGPTMessage[];
-            isDone: boolean;
-            apiReseponse: ApiResponse;
-        };
-        nextTalk: (prompt: string | string[]) => Promise<any>;
-    }>;
-}
-export type OpenAIChatTalkResponse = PromiseResponseType<OpenAIChat['talk']>;
-export {};

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

@@ -1,59 +0,0 @@
-import { OpenAI } from './index';
-import { PromiseResponseType } from '../../types';
-declare type Config = {
-    /**
-     * @zh 一次回應數量
-     * @en How many chat completion choices to generate for each input message.
-     */
-    n: number;
-    /**
-     * @zh 最長回應長度，最大值為 4096。
-     * @en The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096).
-     * @see https://platform.openai.com/tokenizer
-     */
-    maxTokens: number;
-    /**
-     * @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;
-};
-declare type ApiResponse = {
-    id: string;
-    object: string;
-    created: number;
-    model: string;
-    choices: Array<{
-        text: string;
-        index: number;
-        logprobs: any;
-        finish_reason: string;
-    }>;
-    usage: {
-        prompt_tokens: number;
-        completion_tokens: number;
-        total_tokens: number;
-    };
-};
-export declare class OpenAICompletion {
-    private openai;
-    private config;
-    constructor(openai: OpenAI);
-    /**
-     * @zh 改變對話的一些設定。
-     * @en Change some settings of the chat.
-     */
-    setConfig(options: Partial<Config>): void;
-    /**
-     * @zh 進行補文。
-     * @en Do completion.
-     */
-    run(prompt: string | string[]): Promise<{
-        id: string;
-        text: string;
-        isDone: boolean;
-        apiReseponse: ApiResponse;
-    }>;
-}
-export declare type OpenAiOpenAICompletionResponse = PromiseResponseType<OpenAICompletion['run']>;
-export {};

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

@@ -1,35 +0,0 @@
-import { OpenAI } from './index';
-type ApiResponse = {
-    created: string;
-    data: {
-        b64_json: string;
-    }[];
-};
-type Config = {
-    /**
-     * @zh 模型，支援 dall-e-2 和 dall-e-3
-     * @en Model, support dall-e-2 and dall-e-3
-     */
-    model: 'dall-e-2' | 'dall-e-3';
-    /**
-     * @zh 解析度，例如 1024x1024
-     * @en Resolution, for example 1024x1024
-     */
-    size: `${number}x${number}`;
-};
-export declare class OpenAIImagesGeneration {
-    private openai;
-    private config;
-    constructor(openai: OpenAI);
-    /**
-     * @zh 改變對話的一些設定
-     * @en Change some settings of the conversation
-     */
-    setConfig(options: Partial<Config>): void;
-    /**
-     * @zh 產生圖片
-     * @en Generate image
-     */
-    create(prompt: string): Promise<ApiResponse>;
-}
-export {};

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

@@ -1,29 +0,0 @@
-import { OpenAIVision } from './vision';
-import { OpenAIChat, Config } from './chat';
-import { OpenAIImagesGeneration } from './images-generation';
-export declare class OpenAI {
-    _axios: import("axios").AxiosInstance;
-    _apiKey: string;
-    static createChatRequest(apiKey: string | (() => Promise<string>), config?: Partial<Config> | (() => Promise<Partial<Config>>), options?: {
-        axios?: any;
-    }): (messages: any[], { onCancel }: any) => Promise<string>;
-    static createChatRequestWithJsonSchema(params: {
-        axios?: any;
-        apiKey: string | (() => Promise<string>);
-        config?: Partial<Pick<Config, 'model' | 'temperature'>> | (() => Promise<Partial<Pick<Config, 'model' | 'temperature'>>>);
-    }): (messages: any[], { schema, onCancel }: any) => Promise<string>;
-    constructor(apiKey?: string);
-    /**
-     * @zh 如果你有需要特別設定 axios，請使用這方法。
-     * @en If you need to set axios, please use this method.
-     */
-    setAxios(axios: any): void;
-    /**
-     * @zh 設定 api key。
-     * @en Set api key.
-     */
-    setConfiguration(apiKey: string): void;
-    createChat(): OpenAIChat;
-    createVision(): OpenAIVision;
-    createImagesGeneration(): OpenAIImagesGeneration;
-}

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

@@ -1,74 +0,0 @@
-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 declare class OpenAIVision {
-    openai: OpenAI;
-    config: Config;
-    constructor(openai: OpenAI);
-    /**
-     * @zh 改變對話的一些設定
-     * @en Change some settings of the conversation
-     */
-    setConfig(options: Partial<Config>): void;
-    /**
-     * @zh 辨識圖片
-     * @en Recognize images
-     */
-    view(messages: VisionMessage[]): Promise<{
-        id: string;
-        text: string;
-        apiReseponse: ApiResponse;
-    }>;
-}
-export type OpenAIChatVisionResponse = PromiseResponseType<OpenAIVision['view']>;
-export {};

package/types/lib/templates.d.ts

@@ -1,20 +0,0 @@
-type JsonResponseFormat = {
-    desc: string;
-    example: any;
-};
-/**
- * @zh 協助使用者將格式需求轉成論敘語句。
- * @en Assist the user in converting the formatting requirements into declarative sentences.
- */
-export declare const requireJsonResponse: (question: string | string[], format: Record<string, JsonResponseFormat>) => string;
-/**
- * @zh 協助使用者將格式需求轉成論敘語句，支援 Handlebars。
- * @en Assist the user in converting the formatting requirements into declarative sentences, support Handlebars.
- */
-export declare const requireJsonResponseWithHandlebars: (value: Record<string, any>, question: string | string[], format: Record<string, JsonResponseFormat>) => string;
-/**
- * @zh 協助使用者將格式需求轉成論敘語句，並支援 Json Schema。
- * @en Assist the user in converting the formatting requirements into declarative sentences, and support Json Schema.
- */
-export declare const requireJsonResponseWithJsonSchema: (question: string | string[], format: Record<string, any>) => string;
-export {};

package/types/lib/types.d.ts

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

package/types/lib/utils/error.d.ts

@@ -1,11 +0,0 @@
-type ParserFail = {
-    name: string;
-    error: any;
-};
-export declare class ParserError {
-    isParserError: boolean;
-    parserFails: ParserFail[];
-    error: any;
-    constructor(error: any, parserFails: ParserFail[]);
-}
-export {};

package/types/lib/utils/validate.d.ts

@@ -1,16 +0,0 @@
-import * as Yup from 'yup';
-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 declare function definedValidateSchema<T extends ValidateCallback<any>>(cb: T): T;
-export declare function validate<T extends ValidateCallback<any>, R = ReturnType<T>>(target: any, schemaCallback: T): { [K in keyof R]: R[K] extends {
-    __outputType: any;
-} ? R[K]["__outputType"] : R[K]; };
-export declare const defineYupSchema: <T extends Record<string, Yup.Schema<any, any, any, "">>>(cb: ValidateCallback<T>) => T;
-export declare const validateToJsonSchema: <T extends ValidateCallback<any>>(cb: T) => import("json-schema").JSONSchema7;