updateupdate

Author: jayscoder

example.txt

@@ -0,0 +1 @@
+这是一个测试文件，用于演示 Dify API 的文件上传功能。

examples/workflow_example.py

@@ -87,14 +87,38 @@ def example_run_workflow_blocking():
     """以阻塞模式运行工作流示例"""
     print("\n==== 以阻塞模式运行工作流 ====")
 
+    file = 'example.txt'
+    if not os.path.exists(file):
+        with open(file, 'w') as f:
+            f.write('这是一个测试文件，用于演示 Dify API 的文件上传功能。')
+    
+    file_id = client.upload_file(file, USER_ID)['id']
+    
     # 准备输入参数
     inputs = {
         "input": "请写一首关于人工智能的诗",
+        'file1': {
+                'type': 'document',
+                'transfer_method': 'local_file',
+                'upload_file_id': file_id
+            },
+        'files1': [
+            {
+                'type': 'document',
+                'transfer_method': 'local_file',
+                'upload_file_id': file_id
+            },
+            {
+                'type': 'document',
+                'transfer_method': 'local_file',
+                'upload_file_id': file_id
+            }
+        ]
     }
-
+    
     # 获取请求参数
     request_kwargs = get_request_kwargs()
-
+    
     try:
         # 执行工作流（阻塞模式）
         result = client.run(
@@ -103,7 +127,7 @@ def example_run_workflow_blocking():
             response_mode="blocking",
             **request_kwargs,  # 传递请求参数
         )
-
+        
         print("工作流执行结果:")
         pprint(result)
         return result
@@ -182,23 +206,94 @@ def on_workflow_finished(data):
 def example_upload_file():
     """上传文件示例"""
     print("\n==== 上传文件 ====")
-
-    # 确保文件存在
-    file_path = "example.txt"
-    if not os.path.exists(file_path):
-        with open(file_path, "w") as f:
-            f.write("这是一个测试文件，用于演示 Dify API 的文件上传功能。")
-
-    # 上传文件
+    
+    # 获取请求参数
+    request_kwargs = get_request_kwargs()
+    
     try:
-        result = client.upload_file(file_path, USER_ID)
+        # 1. 首先检查应用参数配置
+        params = client.get_parameters(**request_kwargs)
+        
+        # 创建一个带有特定内容的测试文件
+        file_path = "example.txt"
+        if not os.path.exists(file_path):
+            with open(file_path, "w") as f:
+                f.write("这是一个测试文件，用于演示 Dify API 的文件上传功能。")
+        
+        # 检查文件大小
+        file_size = os.path.getsize(file_path) / (1024 * 1024)  # 转换为MB
+        print(f"文件大小: {file_size:.2f}MB")
+        
+        system_params = params.get("system_parameters", {})
+        file_size_limit = system_params.get("file_size_limit", 15)  # 默认15MB
+        
+        print(f"系统文件上传限制: {file_size_limit}MB")
+        
+        if file_size > file_size_limit:
+            print(f"警告: 文件大小({file_size:.2f}MB)超过限制({file_size_limit}MB)")
+        
+        # 打印调试信息
+        print(f"API地址: {client.base_url}")
+        print(f"API密钥前缀: {client.api_key[:8]}...")
+        
+        # 尝试创建一个图片文件（某些API可能只接受图片）
+        try_image = True
+        if try_image:
+            print("创建测试图片文件...")
+            image_path = "test_image.png"
+            from PIL import Image
+            import numpy as np
+            
+            # 创建一个简单的彩色图片
+            try:
+                img = Image.new('RGB', (100, 100), color=(73, 109, 137))
+                img.save(image_path)
+                print(f"已创建测试图片: {image_path}")
+                file_path = image_path
+            except ImportError:
+                print("无法创建图片文件，将使用文本文件")
+            except Exception as e:
+                print(f"创建图片失败: {e}")
+        
+        # 上传文件，添加超时和重试参数
+        print(f"正在上传文件: {file_path}")
+        
+        # 增加超时时间，避免大文件上传超时
+        request_kwargs["timeout"] = 60
+        
+        result = client.upload_file(
+            file_path, 
+            USER_ID,
+            **request_kwargs  # 传递请求参数
+        )
+        
         print("文件上传成功:")
         pprint(result)
-
+        
         # 返回上传的文件ID，可用于后续调用
         return result.get("id")
     except Exception as e:
         print(f"文件上传失败: {e}")
+        
+        # 添加更详细的错误分析
+        if "400" in str(e):
+            print("\n可能的原因:")
+            print("1. API密钥权限不足 - 确保您的密钥有文件上传权限")
+            print("2. 应用模式不支持 - 确认您的应用是Workflow模式且支持文件操作")
+            print("3. 文件格式不支持 - 尝试上传其他格式的文件，如PDF或图片")
+            print("4. API地址不正确 - 检查BASE_URL是否正确")
+            
+            # 尝试获取支持的文件类型
+            try:
+                if "file_upload" in params:
+                    print("\n支持的文件上传配置:")
+                    pprint(params.get("file_upload", {}))
+            except:
+                pass
+        
+        # 打印完整错误堆栈
+        import traceback
+        traceback.print_exc()
         return None
 
 
@@ -384,11 +479,12 @@ def validate_workflow_app():
         # 运行基本示例
         example_get_app_info()
         example_get_app_parameters()
+        example_upload_file()
         # 如果是Workflow应用，或者用户选择继续运行，则执行以下示例
         example_run_workflow_blocking()
-        example_run_workflow_streaming()
-        example_get_logs()
-
+        # example_run_workflow_streaming()
+        # example_get_logs()
+        
         # 运行文件相关示例和停止任务示例默认不启用
         # if is_workflow_app:
         #    example_workflow_with_file()

pydify/common.py

@@ -379,29 +379,38 @@ def post_stream(
 
     # 通用方法 - 这些方法在多个子类中重复出现，可以移到基类
 
-    def upload_file(self, file_path: str, user: str) -> Dict[str, Any]:
+    def upload_file(self, file_path: str, user: str, **kwargs) -> Dict[str, Any]:
         """
         上传文件到Dify API。
 
         Args:
             file_path (str): 要上传的文件路径
             user (str): 用户标识
-
+            **kwargs: 额外的请求参数，如timeout、max_retries等
         Returns:
             Dict[str, Any]: 上传文件的响应数据
 
         Raises:
             FileNotFoundError: 当文件不存在时
-            DifyAPIError: 当API请求失败时
+            DifyAPIError: 当API请求失败时，可能的错误包括：
+                - 400 no_file_uploaded: 必须提供文件
+                - 400 too_many_files: 目前只接受一个文件
+                - 400 unsupported_preview: 该文件不支持预览
+                - 400 unsupported_estimate: 该文件不支持估算
+                - 413 file_too_large: 文件太大
+                - 415 unsupported_file_type: 不支持的扩展名，当前只接受文档类文件
+                - 503 s3_connection_failed: 无法连接到 S3 服务
+                - 503 s3_permission_denied: 无权限上传文件到 S3
+                - 503 s3_file_too_large: 文件超出 S3 大小限制
         """
         if not os.path.exists(file_path):
-            raise FileNotFoundError(f"File not found: {file_path}")
+            raise FileNotFoundError(f"文件未找到: {file_path}")
 
         with open(file_path, "rb") as file:
-            return self.upload_file_obj(file, os.path.basename(file_path), user)
+            return self.upload_file_obj(file, os.path.basename(file_path), user, **kwargs)
 
     def upload_file_obj(
-        self, file_obj: BinaryIO, filename: str, user: str
+        self, file_obj: BinaryIO, filename: str, user: str, **kwargs
     ) -> Dict[str, Any]:
         """
         使用文件对象上传文件到Dify API。
@@ -410,25 +419,100 @@ def upload_file_obj(
             file_obj (BinaryIO): 文件对象
             filename (str): 文件名
             user (str): 用户标识
+            **kwargs: 额外的请求参数，如timeout、max_retries等
 
         Returns:
-            Dict[str, Any]: 上传文件的响应数据
-
+            Dict[str, Any]: 上传文件的响应数据，包含以下字段：
+                - id (str): 文件ID
+                - name (str): 文件名
+                - size (int): 文件大小（字节）
+                - extension (str): 文件扩展名
+                - mime_type (str): 文件MIME类型
+                - created_at (int): 创建时间戳
+                - created_by (uuid): 创建者ID
+            例子:
+            ```
+            {
+                'created_at': 1742181534,
+                'created_by': 'df217b97-2203-4fb9-a4b6-ebe74ac6a315',
+                'extension': 'png',
+                'id': '88fb21ea-e0b9-48a9-a315-e44e6cfcbcb7',
+                'mime_type': 'image/png',
+                'name': 'test_image.png',
+                'size': 289
+            }
+            ```
+        
         Raises:
-            DifyAPIError: 当API请求失败时
-        """
-        files = {"file": (filename, file_obj)}
-        data = {"user": user}
-
-        headers = self._get_headers()
-        # 移除Content-Type，让requests自动设置multipart/form-data
-        headers.pop("Content-Type", None)
-
-        response = self._request(
-            "POST", "files/upload", headers=headers, files=files, data=data
-        )
-        return response.json()
-
+            DifyAPIError: 当API请求失败时，可能的错误包括：
+                - 400 bad_request_key_error: 请求格式错误
+                - 400 no_file_uploaded: 必须提供文件
+                - 413 file_too_large: 文件太大
+                - 415 unsupported_file_type: 不支持的文件类型
+        """
+        # 根据文件扩展名推断MIME类型
+        import mimetypes
+        mime_type = mimetypes.guess_type(filename)[0] or 'application/octet-stream'
+        
+        # 直接使用requests库进行请求，而不是通过_request方法
+        try:
+            url = urljoin(self.base_url, "files/upload")
+            
+            # 打印调试信息
+            print(f"文件上传请求URL: {url}")
+            print(f"文件名: {filename}, MIME类型: {mime_type}")
+            
+            # 准备请求头（不包含Content-Type，让requests自动处理)
+            headers = {
+                "Authorization": f"Bearer {self.api_key}",
+            }
+            
+            # 准备文件和表单数据
+            files = {
+                "file": (filename, file_obj, mime_type)
+            }
+            data = {
+                "user": user
+            }
+            
+            # 设置超时参数
+            timeout = kwargs.pop("timeout", 30)
+            
+            # 直接发送请求
+            response = requests.post(
+                url, 
+                headers=headers, 
+                files=files, 
+                data=data,
+                timeout=timeout,
+            )
+            
+            # 检查响应状态
+            if not response.ok:
+                error_msg = f"API request failed: {response.status_code}"
+                error_data = {}
+                try:
+                    error_data = response.json()
+                    error_msg = f"{error_msg} - {json.dumps(error_data)}"
+                except:
+                    if response.text:
+                        error_msg = f"{error_msg} - {response.text[:100]}"
+                
+                raise DifyAPIError(
+                    error_msg, 
+                    status_code=response.status_code,
+                    error_data=error_data
+                )
+            
+            return response.json()
+        
+        except requests.RequestException as e:
+            raise DifyAPIError(f"文件上传网络错误: {str(e)}")
+        except Exception as e:
+            if isinstance(e, DifyAPIError):
+                raise
+            raise DifyAPIError(f"文件上传失败: {str(e)}")
+    
     def text_to_audio(
         self,
         user: str,
@@ -665,7 +749,7 @@ def get_parameters(self, raw: bool = False, **kwargs) -> Dict[str, Any]:
             ```
         """
         params = self.get("parameters", **kwargs)
-
+        
         if raw:
             return params
 
@@ -862,7 +946,7 @@ def __init__(self, message: str, status_code: int = None, error_data: Dict = Non
 
     def __str__(self) -> str:
         if self.status_code:
-            return f"[{self.status_code}] {self.message}"
+            return f"[{self.status_code}] {self.message} {self.error_data}"
         return self.message