@kevisual/ai 0.0.4 → 0.0.6

package/dist/ai-provider-browser.d.ts

@@ -0,0 +1,434 @@
+import * as openai_resources_index_mjs from 'openai/resources/index.mjs';
+import OpenAI, { OpenAI as OpenAI$1 } from 'openai';
+import * as openai_resources_embeddings_mjs from 'openai/resources/embeddings.mjs';
+import * as _kevisual_permission from '@kevisual/permission';
+import { Permission } from '@kevisual/permission';
+
+type ChatMessage = OpenAI.Chat.Completions.ChatCompletionMessageParam;
+type ChatMessageOptions = Partial<OpenAI.Chat.Completions.ChatCompletionCreateParams>;
+type ChatMessageComplete = OpenAI.Chat.Completions.ChatCompletion;
+type ChatMessageStream = OpenAI.Chat.Completions.ChatCompletion;
+type EmbeddingMessage = Partial<OpenAI.Embeddings.EmbeddingCreateParams>;
+type EmbeddingMessageComplete = OpenAI.Embeddings.CreateEmbeddingResponse;
+interface BaseChatInterface {
+    chat(messages: ChatMessage[], options?: ChatMessageOptions): Promise<ChatMessageComplete>;
+}
+interface BaseChatUsageInterface {
+    /**
+     * 提示词令牌
+     */
+    prompt_tokens: number;
+    /**
+     *  总令牌
+     */
+    total_tokens: number;
+    /**
+     * 完成令牌
+     */
+    completion_tokens: number;
+}
+type ChatStream = AsyncGenerator<ChatMessageComplete, void, unknown>;
+
+type BaseChatOptions<T = Record<string, any>> = {
+    /**
+     * 默认baseURL
+     */
+    baseURL?: string;
+    /**
+     * 默认模型
+     */
+    model?: string;
+    /**
+     * 默认apiKey
+     */
+    apiKey: string;
+    /**
+     * 是否在浏览器中使用
+     */
+    isBrowser?: boolean;
+    /**
+     * 是否流式输出， 默认 false
+     */
+    stream?: boolean;
+} & T;
+declare const getIsBrowser: () => any;
+declare class BaseChat implements BaseChatInterface, BaseChatUsageInterface {
+    /**
+     * 默认baseURL
+     */
+    baseURL: string;
+    /**
+     * 默认模型
+     */
+    model: string;
+    /**
+     * 默认apiKey
+     */
+    apiKey: string;
+    /**
+     * 是否在浏览器中使用
+     */
+    isBrowser: boolean;
+    /**
+     * openai实例
+     */
+    openai: OpenAI$1;
+    prompt_tokens: number;
+    total_tokens: number;
+    completion_tokens: number;
+    constructor(options: BaseChatOptions);
+    /**
+     * 聊天
+     */
+    chat(messages: ChatMessage[], options?: ChatMessageOptions): Promise<ChatMessageComplete>;
+    chatStream(messages: ChatMessage[], options?: ChatMessageOptions): Promise<ChatStream>;
+    /**
+     * 测试
+     */
+    test(): Promise<OpenAI$1.Chat.Completions.ChatCompletion>;
+    /**
+     * 获取聊天使用情况
+     * @returns
+     */
+    getChatUsage(): {
+        prompt_tokens: number;
+        total_tokens: number;
+        completion_tokens: number;
+    };
+    getHeaders(headers?: Record<string, string>): {
+        'Content-Type': string;
+        Authorization: string;
+    };
+    /**
+     * 生成embedding 内部
+     * @param text
+     * @returns
+     */
+    generateEmbeddingCore(text: string | string[], options?: EmbeddingMessage): Promise<EmbeddingMessageComplete>;
+}
+
+/**
+ *  for await (const chunk of chatStream) {
+ *   console.log(chunk);
+ *  }
+ * @param chatStream
+ */
+declare const readStream: (chatStream: ChatStream) => Promise<void>;
+
+type OllamaOptions$1 = Partial<BaseChatOptions>;
+type OllamaModel = {
+    name: string;
+    model: string;
+    modified_at: string;
+    size: number;
+    digest: string;
+    details: {
+        parent_model: string;
+        format: string;
+        family: string;
+        families: string[];
+        parameter_size: string;
+        quantization_level: string;
+    };
+};
+declare class Ollama extends BaseChat {
+    static BASE_URL: string;
+    constructor(options: OllamaOptions$1);
+    chat(messages: ChatMessage[], options?: ChatMessageOptions): Promise<openai_resources_index_mjs.ChatCompletion>;
+    /**
+     * 获取模型列表
+     * @returns
+     */
+    listModels(): Promise<{
+        models: OllamaModel[];
+    }>;
+    listRunModels(): Promise<{
+        models: OllamaModel[];
+    }>;
+}
+
+type SiliconFlowOptions = Partial<BaseChatOptions>;
+type SiliconFlowUsageData = {
+    id: string;
+    name: string;
+    image: string;
+    email: string;
+    isAdmin: boolean;
+    balance: string;
+    status: 'normal' | 'suspended' | 'expired' | string;
+    introduce: string;
+    role: string;
+    chargeBalance: string;
+    totalBalance: string;
+    category: string;
+};
+type SiliconFlowUsageResponse = {
+    code: number;
+    message: string;
+    status: boolean;
+    data: SiliconFlowUsageData;
+};
+declare class SiliconFlow extends BaseChat {
+    static BASE_URL: string;
+    constructor(options: SiliconFlowOptions);
+    getUsageInfo(): Promise<SiliconFlowUsageResponse>;
+    chat(messages: OpenAI$1.Chat.Completions.ChatCompletionMessageParam[], options?: Partial<OpenAI$1.Chat.Completions.ChatCompletionCreateParams>): Promise<OpenAI$1.Chat.Completions.ChatCompletion>;
+}
+
+type OllamaOptions = BaseChatOptions;
+/**
+ * 自定义模型
+ */
+declare class Custom extends BaseChat {
+    static BASE_URL: string;
+    constructor(options: OllamaOptions);
+}
+
+type VolcesOptions = Partial<BaseChatOptions>;
+declare class Volces extends BaseChat {
+    static BASE_URL: string;
+    constructor(options: VolcesOptions);
+}
+
+type DeepSeekOptions = Partial<BaseChatOptions>;
+declare class DeepSeek extends BaseChat {
+    static BASE_URL: string;
+    constructor(options: DeepSeekOptions);
+}
+
+type ModelScopeOptions = Partial<BaseChatOptions>;
+declare class ModelScope extends BaseChat {
+    static BASE_URL: string;
+    constructor(options: ModelScopeOptions);
+}
+
+declare const OllamaProvider: typeof Ollama;
+declare const SiliconFlowProvider: typeof SiliconFlow;
+declare const CustomProvider: typeof Custom;
+declare const VolcesProvider: typeof Volces;
+declare const DeepSeekProvider: typeof DeepSeek;
+declare const ModelScopeProvider: typeof ModelScope;
+declare const ChatProviderMap: {
+    Ollama: typeof Ollama;
+    SiliconFlow: typeof SiliconFlow;
+    Custom: typeof Custom;
+    Volces: typeof Volces;
+    DeepSeek: typeof DeepSeek;
+    ModelScope: typeof ModelScope;
+    BaseChat: typeof BaseChat;
+};
+type ProviderManagerConfig = {
+    provider: string;
+    model: string;
+    apiKey: string;
+    baseURL?: string;
+};
+declare class ProviderManager {
+    provider: BaseChat;
+    constructor(config: ProviderManagerConfig);
+    static createProvider(config: ProviderManagerConfig): Promise<BaseChat>;
+    chat(messages: ChatMessage[]): Promise<openai_resources_index_mjs.ChatCompletion>;
+}
+
+type KnowledgeOptions<T = Record<string, any>> = BaseChatOptions<{
+    embeddingModel?: string;
+    splitSize?: number;
+    splitOverlap?: number;
+    batchSize?: number;
+} & T>;
+/**
+ * 知识库构建
+ * 1. Embedding generate
+ * 2. retriever
+ * 3. reranker
+ */
+declare class KnowledgeBase extends BaseChat {
+    embeddingModel: string;
+    splitSize: number;
+    splitOverlap: number;
+    batchSize: number;
+    constructor(options: KnowledgeOptions);
+    /**
+     * 生成embedding
+     * @param text
+     * @returns
+     */
+    generateEmbedding(text: string | string[]): Promise<{
+        code: number;
+        data: openai_resources_embeddings_mjs.Embedding[];
+        message?: undefined;
+    } | {
+        code: any;
+        message: string;
+        data?: undefined;
+    }>;
+    /**
+     * 批量生成embedding
+     * @param text
+     * @returns
+     */
+    generateEmbeddingBatch(textArray: string[]): Promise<number[][]>;
+    /**
+     * 分割长文本, 生成对应的embedding
+     * @param text
+     * @returns
+     */
+    splitLongText(text: string): Promise<{
+        text: string;
+        embedding: number[];
+    }[]>;
+}
+
+declare class SiliconFlowKnowledge extends KnowledgeBase {
+    static BASE_URL: string;
+    constructor(options: KnowledgeOptions);
+    rerank(data: RerankOptions): Promise<any>;
+}
+type RerankOptions = {
+    model: string;
+    query: string;
+    documents: string[];
+    top_n?: number;
+    return_documents?: boolean;
+    max_chunks_per_doc?: number;
+    overlap_tokens?: number;
+};
+
+type AIModel = {
+    /**
+     * 提供商
+     */
+    provider: string;
+    /**
+     * 模型名称
+     */
+    model: string;
+    /**
+     * 模型组
+     */
+    group: string;
+    /**
+     * 每日请求频率限制
+     */
+    dayLimit?: number;
+    /**
+     * 总的token限制
+     */
+    tokenLimit?: number;
+};
+type SecretKey = {
+    /**
+     * 组
+     */
+    group: string;
+    /**
+     * API密钥
+     */
+    apiKey: string;
+    /**
+     * 解密密钥
+     */
+    decryptKey?: string;
+};
+type AIConfig = {
+    title?: string;
+    description?: string;
+    models: AIModel[];
+    secretKeys: SecretKey[];
+    permission?: Permission;
+    filter?: {
+        objectKey: string;
+        type: 'array' | 'object';
+        operate: 'removeAttribute' | 'remove';
+        attribute: string[];
+    }[];
+};
+
+declare function encryptAES(plainText: string, secretKey: string): string;
+declare function decryptAES(cipherText: string, secretKey: string): string;
+type GetProviderOpts = {
+    model: string;
+    group: string;
+    decryptKey?: string;
+};
+type ProviderResult = {
+    provider: string;
+    model: string;
+    group: string;
+    apiKey: string;
+    dayLimit?: number;
+    tokenLimit?: number;
+    baseURL?: string;
+    /**
+     * 解密密钥
+     */
+    decryptKey?: string;
+};
+declare class AIConfigParser {
+    private config;
+    result: ProviderResult;
+    constructor(config: AIConfig);
+    /**
+     * 获取模型配置
+     * @param opts
+     * @returns
+     */
+    getProvider(opts: GetProviderOpts): ProviderResult;
+    /**
+     * 获取解密密钥
+     * @param opts
+     * @returns
+     */
+    getSecretKey(opts?: {
+        getCache?: (key: string) => Promise<string>;
+        setCache?: (key: string, value: string) => Promise<void>;
+        providerResult?: ProviderResult;
+    }): Promise<string>;
+    /**
+     * 加密
+     * @param plainText
+     * @param secretKey
+     * @returns
+     */
+    encrypt(plainText: string, secretKey: string): string;
+    /**
+     * 解密
+     * @param cipherText
+     * @param secretKey
+     * @returns
+     */
+    decrypt(cipherText: string, secretKey: string): string;
+    /**
+     * 获取模型配置
+     * @returns
+     */
+    getSelectOpts(): {
+        group: string;
+        apiKey: string;
+        decryptKey?: string;
+        provider: string;
+        model: string;
+        dayLimit?: number;
+        tokenLimit?: number;
+    }[];
+    getConfig(keepSecret?: boolean, config?: AIConfig): AIConfig | {
+        secretKeys: {
+            apiKey: any;
+            decryptKey: any;
+            group: string;
+        }[];
+        title?: string;
+        description?: string;
+        models?: AIModel[];
+        permission?: _kevisual_permission.Permission;
+        filter?: {
+            objectKey: string;
+            type: "array" | "object";
+            operate: "removeAttribute" | "remove";
+            attribute: string[];
+        }[];
+    };
+}
+
+export { AIConfigParser, BaseChat, ChatProviderMap, CustomProvider, DeepSeekProvider, KnowledgeBase, ModelScopeProvider, OllamaProvider, ProviderManager, SiliconFlowKnowledge, SiliconFlowProvider, VolcesProvider, decryptAES, encryptAES, getIsBrowser, readStream };
+export type { AIConfig, AIModel, BaseChatInterface, BaseChatOptions, BaseChatUsageInterface, ChatMessage, ChatMessageComplete, ChatMessageOptions, ChatMessageStream, ChatStream, EmbeddingMessage, EmbeddingMessageComplete, GetProviderOpts, KnowledgeOptions, ProviderResult, RerankOptions, SecretKey };