@kevisual/ai 0.0.4 → 0.0.5

package/dist/ai-provider.d.ts

@@ -1,5 +1,7 @@
 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 { Permission } from '@kevisual/permission';
 
 type ChatMessage = OpenAI.Chat.Completions.ChatCompletionMessageParam;
 type ChatMessageOptions = Partial<OpenAI.Chat.Completions.ChatCompletionCreateParams>;
@@ -204,7 +206,7 @@ declare const CustomProvider: typeof Custom;
 declare const VolcesProvider: typeof Volces;
 declare const DeepSeekProvider: typeof DeepSeek;
 declare const ModelScopeProvider: typeof ModelScope;
-declare const ProviderMap: {
+declare const ChatProviderMap: {
     Ollama: typeof Ollama;
     SiliconFlow: typeof SiliconFlow;
     Custom: typeof Custom;
@@ -226,5 +228,205 @@ declare class ProviderManager {
     chat(messages: ChatMessage[]): Promise<openai_resources_index_mjs.ChatCompletion>;
 }
 
-export { BaseChat, CustomProvider, DeepSeekProvider, ModelScopeProvider, OllamaProvider, ProviderManager, ProviderMap, SiliconFlowProvider, VolcesProvider, readStream };
-export type { BaseChatInterface, BaseChatOptions, BaseChatUsageInterface, ChatMessage, ChatMessageComplete, ChatMessageOptions, ChatMessageStream, ChatStream, EmbeddingMessage, EmbeddingMessageComplete };
+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?: 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, readStream };
+export type { AIConfig, AIModel, BaseChatInterface, BaseChatOptions, BaseChatUsageInterface, ChatMessage, ChatMessageComplete, ChatMessageOptions, ChatMessageStream, ChatStream, EmbeddingMessage, EmbeddingMessageComplete, GetProviderOpts, KnowledgeOptions, ProviderResult, RerankOptions, SecretKey };