@cpzxrobot/sdk 1.3.115 → 1.3.116

package/AIFORM_GATEWAY.md

@@ -12,6 +12,8 @@ AI报表模板接口用于管理工厂的AI报表模板，包括查询模板列
 
 通过 `cpzxrobot().aiform.template` 访问AI报表模板相关功能。
 
+通过 `cpzxrobot().aiform.record` 访问文件上传和记录相关功能。
+
 ## 可用方法
 
 ### 1. 查询模板列表
@@ -130,6 +132,180 @@ if (response.code === 200) {
 }
 ```
 
+### 3. 上传表格图片
+
+**方法**: `upload(file: File, templateId: number): Promise<AiformFileUploadResponse>`
+
+**接口路径**: `POST /api/v2/aiform/file/upload`
+
+**功能**: 上传表格图片到 MinIO，并关联到指定的模板。上传成功后自动异步触发大模型解析。
+
+**参数**:
+- `file` (File): 表格图片文件，必填
+- `templateId` (number): 关联的模板ID，必填
+
+**返回值**:
+```typescript
+interface AiformFileUploadResponse {
+  code: number;    // 状态码
+  message: string; // 提示信息
+  data: File;      // 文件记录
+}
+
+interface File {
+  id: number;           // 文件记录ID
+  code?: string;        // 业务编码
+  tableKey: number;     // 关联业务ID（模板ID）
+  tableName: string;    // 关联业务表名（固定值 aiform_template）
+  fileName: string;     // 原始文件名
+  storageName: string;  // 存储文件名
+  fileUrl: string;      // MinIO存储路径
+  accessUrl: string;    // 预签名访问链接
+  fileExt: string;      // 文件扩展名
+  server: string;       // 存储服务（minio）
+  type: string;         // 文件类型（image）
+  status: number;       // 状态：0-已上传 1-解析中 2-已解析
+  createTime: string;   // 创建时间
+  updateTime: string;   // 更新时间
+}
+```
+
+**使用示例**:
+
+```javascript
+// HTML文件输入示例
+<input type="file" id="fileInput" accept="image/*">
+
+// 上传文件
+async function uploadFile() {
+  const fileInput = document.getElementById('fileInput');
+  const file = fileInput.files[0];
+  const templateId = 1; // 模板ID
+  
+  if (!file) {
+    alert('请选择文件');
+    return;
+  }
+  
+  try {
+    const response = await cpzxrobot().aiform.record.upload(file, templateId);
+    console.log('上传成功:', response.data);
+    console.log('文件状态:', getFileStatusText(response.data.status));
+    console.log('访问链接:', response.data.accessUrl);
+    
+    // 可以开始轮询状态
+    trackFileStatus(templateId, response.data.id);
+  } catch (error) {
+    console.error('上传失败:', error.message);
+  }
+}
+
+function getFileStatusText(status) {
+  const statusMap = {
+    0: '已上传',
+    1: '解析中',
+    2: '已解析'
+  };
+  return statusMap[status] || '未知';
+}
+
+// 绑定事件
+ document.getElementById('fileInput').addEventListener('change', uploadFile);
+```
+
+### 4. 根据模板ID查询上传记录
+
+**方法**: `list(templateId: number): Promise<AiformFileListResponse>`
+
+**接口路径**: `GET /api/v2/aiform/file/list/{templateId}`
+
+**功能**: 根据模板ID查询该模板下所有上传的文件记录，按创建时间倒序排列。
+
+**参数**:
+- `templateId` (number): 模板ID，必填
+
+**返回值**:
+```typescript
+interface AiformFileListResponse {
+  code: number;    // 状态码
+  message: string; // 提示信息
+  data: File[];    // 文件记录列表
+}
+```
+
+**使用示例**:
+
+```javascript
+// 获取模板的上传记录
+async function getTemplateRecords(templateId) {
+  try {
+    const response = await cpzxrobot().aiform.record.list(templateId);
+    
+    if (response.code === 200) {
+      const records = response.data;
+      console.log(`找到 ${records.length} 条上传记录:`);
+      
+      records.forEach((record, index) => {
+        console.log(`\n记录 ${index + 1}:`);
+        console.log(`文件名: ${record.fileName}`);
+        console.log(`状态: ${getFileStatusText(record.status)}`);
+        console.log(`创建时间: ${record.createTime}`);
+        console.log(`访问链接: ${record.accessUrl}`);
+      });
+    }
+  } catch (error) {
+    console.error('获取记录失败:', error.message);
+  }
+}
+
+// 调用示例
+getTemplateRecords(1); // 查询模板ID为1的上传记录
+```
+
+### 5. 轮询文件解析状态
+
+**功能**: 上传文件后，需要轮询文件状态以确认解析进度。
+
+**使用示例**:
+
+```javascript
+async function trackFileStatus(templateId, fileId) {
+  let status = 0; // 初始状态
+  let attempts = 0;
+  const maxAttempts = 30; // 最多轮询30次
+  
+  console.log('开始跟踪文件解析状态...');
+  
+  while (status !== 2 && attempts < maxAttempts) {
+    try {
+      const response = await cpzxrobot().aiform.record.list(templateId);
+      const fileRecord = response.data.find(record => record.id === fileId);
+      
+      if (fileRecord) {
+        status = fileRecord.status;
+        console.log(`当前状态: ${getFileStatusText(status)}`);
+        
+        if (status === 2) {
+          console.log('文件已成功解析！');
+          return;
+        }
+      }
+      
+      await new Promise(resolve => setTimeout(resolve, 5000)); // 每5秒轮询一次
+      attempts++;
+    } catch (error) {
+      console.error('轮询失败:', error.message);
+      await new Promise(resolve => setTimeout(resolve, 5000));
+      attempts++;
+    }
+  }
+  
+  if (attempts >= maxAttempts) {
+    console.log('解析超时，请稍后手动检查状态');
+  }
+}
+```
+
 ## 错误处理
 
 ### 常见错误
@@ -138,6 +314,8 @@ if (response.code === 200) {
    - `工厂ID不能为空` - 未提供factoryId参数
    - `模板名称不能为空` - 未提供name参数
    - `模板内容不能为空` - 未提供content参数
+   - `文件不能为空` - 未提供file参数
+   - `模板ID不能为空` - 未提供templateId参数
 
 2. **API错误**:
    - 当API返回非200状态码时，会抛出包含错误信息的异常
@@ -164,6 +342,23 @@ try {
 } catch (error) {
   console.error('保存失败:', error.message);
 }
+
+try {
+  // 尝试上传文件
+  const file = document.getElementById('fileInput').files[0];
+  const response = await cpzxrobot().aiform.record.upload(file, 1);
+  console.log('上传成功:', response.data);
+} catch (error) {
+  console.error('上传失败:', error.message);
+}
+
+try {
+  // 尝试获取上传记录
+  const response = await cpzxrobot().aiform.record.list(1);
+  console.log('上传记录:', response.data);
+} catch (error) {
+  console.error('获取记录失败:', error.message);
+}
 ```
 
 ## 完整使用示例
@@ -250,5 +445,5 @@ manageAITemplates();
 
 ## 版本信息
 
-- **SDK版本**: 1.3.113+
+- **SDK版本**: 1.3.114+
 - **接口版本**: v2

package/aiform_gateway.ts

@@ -77,17 +77,13 @@ export class AiformGateway extends Object {
        * @param templateId 关联的模板ID
        * @returns Promise 包含文件记录信息
        */
-      upload: async (file: File, templateId: number): Promise<AiformFileUploadResponse> => {
+      upload: async (templateId: number): Promise<AiformFileUploadResponse> => {
         const axios = await this.context.ready;
 
-        // 参数验证
-        if (!file) {
-          throw new Error('文件不能为空');
-        }
         if (!templateId) {
           throw new Error('模板ID不能为空');
         }
-        
+
         return axios.upload(`/api/v2/aiform/file/upload`,{
           title: "请选择要解析的表格图片",
           data: {

package/dist/aiform_gateway.js

@@ -71,12 +71,8 @@ class AiformGateway extends Object {
              * @param templateId 关联的模板ID
              * @returns Promise 包含文件记录信息
              */
-            upload: (file, templateId) => __awaiter(this, void 0, void 0, function* () {
+            upload: (templateId) => __awaiter(this, void 0, void 0, function* () {
                 const axios = yield this.context.ready;
-                // 参数验证
-                if (!file) {
-                    throw new Error('文件不能为空');
-                }
                 if (!templateId) {
                     throw new Error('模板ID不能为空');
                 }

package/dist/production_gateway.js

@@ -52,6 +52,8 @@ class ProductionGateway extends Object {
                     params: {
                         factory_id: factoryId
                     }
+                }).then((res) => {
+                    return res.data;
                 });
             }),
             create: (request) => __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cpzxrobot/sdk",
-  "version": "1.3.115",
+  "version": "1.3.116",
   "description": "提供给上海正芯数智APP第三方H5应用使用的SDK",
   "main": "dist/index.js",
   "scripts": {

package/production_gateway.ts

@@ -48,6 +48,8 @@ export class ProductionGateway extends Object {
           params: {
             factory_id: factoryId
           }
+        }).then((res) => {
+          return res.data;
         });
       },
       create: async (request: {