yanmengs-rag-package 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,203 @@
+interface RagClientConfig {
+    /** rag-server 地址，默认 http://localhost:7100 */
+    ragServerUrl?: string;
+    /** 鉴权用的 app_key */
+    appKey: string;
+}
+interface OssTokenResult {
+    code: number;
+    data: {
+        token: string;
+    };
+    message: string;
+}
+interface QiniuUploadOptions {
+    /** 要上传的文件 */
+    file: File | Blob;
+    /** 七牛存储的 key（路径） */
+    key: string;
+    /** 直接传入七牛上传 token */
+    token?: string;
+    /** 异步获取 token 的函数（与 token 二选一） */
+    getToken?: () => Promise<string>;
+    /** 七牛区域，默认 z2 */
+    region?: string;
+    /** 上传进度回调 */
+    onProgress?: (percent: number) => void;
+    /** 上传成功回调 */
+    onSuccess?: (res: any) => void;
+    /** 上传失败回调 */
+    onError?: (err: Error) => void;
+}
+interface QiniuBatchUploadOptions {
+    /** 要上传的文件列表 */
+    files: Array<{
+        file: File | Blob;
+        key: string;
+    }>;
+    /** 直接传入七牛上传 token */
+    token?: string;
+    /** 异步获取 token 的函数 */
+    getToken?: () => Promise<string>;
+    /** 最大并发数，默认 3 */
+    maxConcurrency?: number;
+    /** 七牛区域，默认 z2 */
+    region?: string;
+    /** 单文件进度回调 */
+    onItemProgress?: (key: string, percent: number) => void;
+    /** 单文件成功回调 */
+    onItemSuccess?: (key: string, res: any) => void;
+    /** 单文件失败回调 */
+    onItemError?: (key: string, err: Error) => void;
+    /** 全部完成回调 */
+    onAllComplete?: () => void;
+}
+interface UploadItem {
+    id: string;
+    file: File | Blob;
+    name: string;
+    percent: number;
+    status: "pending" | "uploading" | "error" | "success";
+    key: string;
+    error?: string;
+}
+interface ProcessUrlParams {
+    /** 用户 ID */
+    userID: string;
+    /** 远程文件地址 */
+    fileUrl: string;
+    /** 业务文件 ID（可选，用于回调） */
+    fileID?: string;
+}
+interface ProcessUrlResult {
+    message: string;
+    filename: string;
+    total_chunks: number;
+    weaviate_index: string;
+}
+interface UploadDocumentParams {
+    /** 用户 ID */
+    userID: string;
+    /** 要上传的文件 */
+    file: File;
+}
+interface UploadDocumentResult {
+    message: string;
+    filename: string;
+    total_chunks: number;
+    weaviate_index: string;
+}
+interface DeleteDocumentParams {
+    /** 用户 ID */
+    userID: string;
+    /** 业务文件 ID */
+    fileID?: string;
+    /** 文件名 */
+    filename?: string;
+}
+interface AskParams {
+    /** 用户 ID */
+    userId: string;
+    /** 问题内容 */
+    query: string;
+    /** 检索 top K，默认 3 */
+    topK?: number;
+}
+interface AskStreamOptions extends AskParams {
+    /** 每次收到 SSE 数据块时的回调 */
+    onChunk: (chunk: string) => void;
+    /** 流结束后的回调 */
+    onDone?: (fullAnswer: string) => void;
+    /** 错误回调 */
+    onError?: (err: Error) => void;
+}
+interface AskResult {
+    answer: string;
+    retrieved_context: string[];
+}
+interface TtsStreamParams {
+    /** 需要合成语音的文本 */
+    text: string;
+    /** 可选的 AbortSignal，用于取消请求 */
+    signal?: AbortSignal;
+}
+interface TranscribeResult {
+    code: number;
+    data: {
+        text: string;
+    };
+}
+interface GenerateKeyResult {
+    app_name: string;
+    app_key: string;
+    message: string;
+}
+
+/**
+ * 创建 RAG 客户端实例
+ *
+ * @example
+ * ```ts
+ * import { createRagClient } from 'yanmengs-rag-package';
+ *
+ * const rag = createRagClient({
+ *   ragServerUrl: 'http://localhost:7100',
+ *   appKey: 'your_app_key',
+ * });
+ *
+ * // 获取七牛上传 Token
+ * const tokenRes = await rag.oss.getPutPolicy();
+ *
+ * // 七牛上传
+ * rag.qiniu.upload({ file, key: 'xxx.pdf', token: tokenRes.data.token, onSuccess: (res) => {} });
+ *
+ * // 知识库
+ * await rag.knowledge.processUrl({ userID: 'u1', fileUrl: 'https://...' });
+ *
+ * // AI 问答（SSE 流式）
+ * rag.chat.askStream({ userId: 'u1', query: '...', onChunk: (c) => console.log(c) });
+ *
+ * // TTS
+ * const audioRes = await rag.tts.stream({ text: '...' });
+ *
+ * const result = await rag.asr.transcribe(audioFile);
+ * ```
+ */
+declare function createRagClient(config?: RagClientConfig): {
+    /**七牛上传依赖的凭证接口模块 */
+    oss: {
+        getUploadCode: () => Promise<OssTokenResult>;
+        getPutPolicy: () => Promise<OssTokenResult>;
+    };
+    /** 七牛上传模块 */
+    qiniu: {
+        upload: (options: QiniuUploadOptions) => void;
+        batchUpload: (options: QiniuBatchUploadOptions) => void;
+        getUploadList: () => UploadItem[];
+    };
+    /** 知识库模块 */
+    knowledge: {
+        processUrl: (params: ProcessUrlParams) => Promise<ProcessUrlResult>;
+        uploadDocument: (params: UploadDocumentParams) => Promise<UploadDocumentResult>;
+        deleteDocument: (params: DeleteDocumentParams) => Promise<void>;
+    };
+    /** AI 问答模块（支持 SSE 流式） */
+    chat: {
+        askStream: (options: AskStreamOptions) => Promise<void>;
+        ask: (params: AskParams) => Promise<AskResult>;
+    };
+    /** TTS 语音合成模块 */
+    tts: {
+        stream: (params: TtsStreamParams) => Promise<Response>;
+    };
+    /** ASR 语音转写模块 */
+    asr: {
+        transcribe: (file: File | Blob) => Promise<TranscribeResult>;
+    };
+    /** 应用管理模块 */
+    app: {
+        generateKey: (appName: string) => Promise<GenerateKeyResult>;
+    };
+};
+
+export { type AskParams, type AskResult, type AskStreamOptions, type DeleteDocumentParams, type GenerateKeyResult, type OssTokenResult, type ProcessUrlParams, type ProcessUrlResult, type QiniuBatchUploadOptions, type QiniuUploadOptions, type RagClientConfig, type TranscribeResult, type TtsStreamParams, type UploadDocumentParams, type UploadDocumentResult, type UploadItem, createRagClient };

package/dist/index.d.ts

@@ -0,0 +1,203 @@
+interface RagClientConfig {
+    /** rag-server 地址，默认 http://localhost:7100 */
+    ragServerUrl?: string;
+    /** 鉴权用的 app_key */
+    appKey: string;
+}
+interface OssTokenResult {
+    code: number;
+    data: {
+        token: string;
+    };
+    message: string;
+}
+interface QiniuUploadOptions {
+    /** 要上传的文件 */
+    file: File | Blob;
+    /** 七牛存储的 key（路径） */
+    key: string;
+    /** 直接传入七牛上传 token */
+    token?: string;
+    /** 异步获取 token 的函数（与 token 二选一） */
+    getToken?: () => Promise<string>;
+    /** 七牛区域，默认 z2 */
+    region?: string;
+    /** 上传进度回调 */
+    onProgress?: (percent: number) => void;
+    /** 上传成功回调 */
+    onSuccess?: (res: any) => void;
+    /** 上传失败回调 */
+    onError?: (err: Error) => void;
+}
+interface QiniuBatchUploadOptions {
+    /** 要上传的文件列表 */
+    files: Array<{
+        file: File | Blob;
+        key: string;
+    }>;
+    /** 直接传入七牛上传 token */
+    token?: string;
+    /** 异步获取 token 的函数 */
+    getToken?: () => Promise<string>;
+    /** 最大并发数，默认 3 */
+    maxConcurrency?: number;
+    /** 七牛区域，默认 z2 */
+    region?: string;
+    /** 单文件进度回调 */
+    onItemProgress?: (key: string, percent: number) => void;
+    /** 单文件成功回调 */
+    onItemSuccess?: (key: string, res: any) => void;
+    /** 单文件失败回调 */
+    onItemError?: (key: string, err: Error) => void;
+    /** 全部完成回调 */
+    onAllComplete?: () => void;
+}
+interface UploadItem {
+    id: string;
+    file: File | Blob;
+    name: string;
+    percent: number;
+    status: "pending" | "uploading" | "error" | "success";
+    key: string;
+    error?: string;
+}
+interface ProcessUrlParams {
+    /** 用户 ID */
+    userID: string;
+    /** 远程文件地址 */
+    fileUrl: string;
+    /** 业务文件 ID（可选，用于回调） */
+    fileID?: string;
+}
+interface ProcessUrlResult {
+    message: string;
+    filename: string;
+    total_chunks: number;
+    weaviate_index: string;
+}
+interface UploadDocumentParams {
+    /** 用户 ID */
+    userID: string;
+    /** 要上传的文件 */
+    file: File;
+}
+interface UploadDocumentResult {
+    message: string;
+    filename: string;
+    total_chunks: number;
+    weaviate_index: string;
+}
+interface DeleteDocumentParams {
+    /** 用户 ID */
+    userID: string;
+    /** 业务文件 ID */
+    fileID?: string;
+    /** 文件名 */
+    filename?: string;
+}
+interface AskParams {
+    /** 用户 ID */
+    userId: string;
+    /** 问题内容 */
+    query: string;
+    /** 检索 top K，默认 3 */
+    topK?: number;
+}
+interface AskStreamOptions extends AskParams {
+    /** 每次收到 SSE 数据块时的回调 */
+    onChunk: (chunk: string) => void;
+    /** 流结束后的回调 */
+    onDone?: (fullAnswer: string) => void;
+    /** 错误回调 */
+    onError?: (err: Error) => void;
+}
+interface AskResult {
+    answer: string;
+    retrieved_context: string[];
+}
+interface TtsStreamParams {
+    /** 需要合成语音的文本 */
+    text: string;
+    /** 可选的 AbortSignal，用于取消请求 */
+    signal?: AbortSignal;
+}
+interface TranscribeResult {
+    code: number;
+    data: {
+        text: string;
+    };
+}
+interface GenerateKeyResult {
+    app_name: string;
+    app_key: string;
+    message: string;
+}
+
+/**
+ * 创建 RAG 客户端实例
+ *
+ * @example
+ * ```ts
+ * import { createRagClient } from 'yanmengs-rag-package';
+ *
+ * const rag = createRagClient({
+ *   ragServerUrl: 'http://localhost:7100',
+ *   appKey: 'your_app_key',
+ * });
+ *
+ * // 获取七牛上传 Token
+ * const tokenRes = await rag.oss.getPutPolicy();
+ *
+ * // 七牛上传
+ * rag.qiniu.upload({ file, key: 'xxx.pdf', token: tokenRes.data.token, onSuccess: (res) => {} });
+ *
+ * // 知识库
+ * await rag.knowledge.processUrl({ userID: 'u1', fileUrl: 'https://...' });
+ *
+ * // AI 问答（SSE 流式）
+ * rag.chat.askStream({ userId: 'u1', query: '...', onChunk: (c) => console.log(c) });
+ *
+ * // TTS
+ * const audioRes = await rag.tts.stream({ text: '...' });
+ *
+ * const result = await rag.asr.transcribe(audioFile);
+ * ```
+ */
+declare function createRagClient(config?: RagClientConfig): {
+    /**七牛上传依赖的凭证接口模块 */
+    oss: {
+        getUploadCode: () => Promise<OssTokenResult>;
+        getPutPolicy: () => Promise<OssTokenResult>;
+    };
+    /** 七牛上传模块 */
+    qiniu: {
+        upload: (options: QiniuUploadOptions) => void;
+        batchUpload: (options: QiniuBatchUploadOptions) => void;
+        getUploadList: () => UploadItem[];
+    };
+    /** 知识库模块 */
+    knowledge: {
+        processUrl: (params: ProcessUrlParams) => Promise<ProcessUrlResult>;
+        uploadDocument: (params: UploadDocumentParams) => Promise<UploadDocumentResult>;
+        deleteDocument: (params: DeleteDocumentParams) => Promise<void>;
+    };
+    /** AI 问答模块（支持 SSE 流式） */
+    chat: {
+        askStream: (options: AskStreamOptions) => Promise<void>;
+        ask: (params: AskParams) => Promise<AskResult>;
+    };
+    /** TTS 语音合成模块 */
+    tts: {
+        stream: (params: TtsStreamParams) => Promise<Response>;
+    };
+    /** ASR 语音转写模块 */
+    asr: {
+        transcribe: (file: File | Blob) => Promise<TranscribeResult>;
+    };
+    /** 应用管理模块 */
+    app: {
+        generateKey: (appName: string) => Promise<GenerateKeyResult>;
+    };
+};
+
+export { type AskParams, type AskResult, type AskStreamOptions, type DeleteDocumentParams, type GenerateKeyResult, type OssTokenResult, type ProcessUrlParams, type ProcessUrlResult, type QiniuBatchUploadOptions, type QiniuUploadOptions, type RagClientConfig, type TranscribeResult, type TtsStreamParams, type UploadDocumentParams, type UploadDocumentResult, type UploadItem, createRagClient };