xparse-client 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

example/run_pipeline_test.py

@@ -0,0 +1,458 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+'''
+Pipeline 运行脚本
+快速启动和运行 Pipeline 的示例
+'''
+
+from datetime import datetime, timezone
+from xparse_client import create_pipeline_from_config, S3Source, LocalSource, MilvusDestination, LocalDestination, Pipeline, SmbSource, S3Destination, FtpSource
+
+
+# ============================================================================
+# 常量配置
+# ============================================================================
+
+# API 请求头配置
+API_HEADERS = {
+    'x-ti-app-id': '4c0032d9e4d93b0ad674cac0d75256e7',
+    'x-ti-secret-code': '7104f599ad02b8468fc619f7605d2d8d'
+}
+
+
+# ============================================================================
+# 方式 1: 使用配置字典
+# ============================================================================
+
+def run_with_config():
+    """使用配置字典运行 pipeline"""
+    
+    config = {
+        'source': {
+            'type': 's3',
+            'endpoint': 'https://textin-minio-api.ai.intsig.net',
+            'access_key': 'IEQspf8C7fVcgmp3AZWl',
+            'secret_key': 'kLj96I8FGbIrPFW08meXivCy4AVdzBijOJWKWOt1',
+            'bucket': 'textin-test',
+            'prefix': '',  # 留空处理所有文件，或指定如 'milvus/'
+            'region': 'us-east-1'
+        },
+        'destination': {
+            'type': 'milvus',
+            'db_path': './milvus_pipeline.db',
+            'collection_name': 'pipeline_collection',
+            'dimension': 1024
+        },
+        'api_base_url': 'https://api.textin.com/api/xparse',
+        'api_headers': API_HEADERS,
+        # Stages 配置
+        'stages': [
+            {
+                'type': 'parse',
+                'config': {
+                    'provider': 'textin'
+                }
+            },
+            {
+                'type': 'chunk',
+                'config': {
+                    'strategy': 'basic',              # 分块策略: 'basic' | 'by_title' | 'by_page'
+                    'include_orig_elements': False,   # 是否包含原始元素
+                    'new_after_n_chars': 512,         # 多少字符后创建新块
+                    'max_characters': 1024,           # 最大字符数
+                    'overlap': 0                      # 重叠字符数
+                }
+            },
+            {
+                'type': 'embed',
+                'config': {
+                    'provider': 'qwen',                    # 向量化供应商: 'qwen'
+                    'model_name': 'text-embedding-v3'      # 模型名称: 'text-embedding-v3' | 'text-embedding-v4'
+                }
+            }
+        ]
+    }
+    
+    pipeline = create_pipeline_from_config(config)
+    pipeline.run()
+
+
+# ============================================================================
+# 方式 2: 手动创建组件
+# ============================================================================
+
+def run_with_manual_setup():
+    """手动创建 Source、Destination 和 Pipeline"""
+    from xparse_client import ChunkConfig, EmbedConfig, ParseConfig, Stage
+    
+    # 创建 S3 数据源
+    # source = S3Source(
+    #     endpoint='https://textin-minio-api.ai.intsig.net',
+    #     access_key='IEQspf8C7fVcgmp3AZWl',
+    #     secret_key='kLj96I8FGbIrPFW08meXivCy4AVdzBijOJWKWOt1',
+    #     bucket='textin-test',
+    #     prefix='',
+    #     region='us-east-1'
+    # )
+    source = S3Source(
+        endpoint='https://s3.oss-cn-shanghai.aliyuncs.com',
+        access_key='LTAI5tBgsaVfkbh9rbPyuB17',
+        secret_key='JFIIaTGiXelv7DgBYNIBSStofF0S98',
+        bucket='textin',
+        prefix='',
+        region='cn-shanghai',
+        pattern='*.png'
+    )
+    # source = S3Source(
+    #     endpoint='https://cos.ap-shanghai.myqcloud.com',
+    #     access_key='AKIDRnwsa4JLAl8GBspcAVcU9anlUzHLAmAJ',
+    #     secret_key='we7KJ4buxlLhogJm0zkFUUKxWu3yeDZi',
+    #     bucket='textin-1300705866',
+    #     prefix='',
+    #     region='ap-shanghai'
+    # )
+    # source = S3Source(
+    #     endpoint='https://tos-s3-cn-shanghai.volces.com',
+    #     access_key='AKLTMzNkZjk1OGM3MzBjNGQ1ZjhkMGQ4MThlNjBjYjZjYzA',
+    #     secret_key='TnpWaE0yRTVaamRqTmpSbU5EY3pObUZrTTJVNE5qUm1NR0ppWkRrMFlqVQ==',
+    #     bucket='textin',
+    #     prefix='',
+    #     region='cn-shanghai'
+    # )
+    # source = S3Source(
+    #     endpoint='https://obs.cn-east-3.myhuaweicloud.com',
+    #     access_key='HPUAL646UCQ1YAT7JMWY',
+    #     secret_key='z9cm95UXCw0R4J3AEig9siqGpZNbwDYz8PVoBGDI',
+    #     bucket='textin',
+    #     prefix='',
+    #     region='cn-east-3'
+    # )
+    # source = S3Source(
+    #     endpoint='https://s3.us-east-1.amazonaws.com',
+    #     access_key='AKIA6QUE3TVZADUWA4PO',
+    #     secret_key='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',
+    #     bucket='textin-xparse',
+    #     prefix='',
+    #     region='us-east-1'
+    # )
+    # source = S3Source(
+    #     endpoint='http://127.0.0.1:9000',
+    #     access_key='ldvOkKVZrsHW8ruqhwVG',
+    #     secret_key='sH665Q2DKgQxyLOpObXTb088SD2hvP0Rtg1dGTiT',
+    #     bucket='textin',
+    #     prefix='',
+    #     region='us-east-1'
+    # )
+    # source = SmbSource(
+    #     host='internal-storage.intsig.net',
+    #     share_name='ke_wang',
+    #     username='ke_wang',
+    #     password='Hhxxblj!4',
+    #     domain='INTSIG.COM'
+    # )
+    # source = FtpSource(
+    #     host='127.0.0.1',
+    #     port=21,
+    #     username='', # 用户名，按照实际填写
+    #     password=''  # 密码，按照实际填写
+    # )
+    # source = LocalSource(
+    #     directory='/Users/ke_wang/Documents/doc',
+    #     pattern='*.pdf'  # 支持通配符: *.pdf, *.docx, **/*.txt
+    # )
+    
+    # 创建 Milvus 目的地
+    destination = MilvusDestination(
+        db_path='./milvus_pipeline1.db',
+        collection_name='pipeline_collection',
+        dimension=1024
+    )
+
+    # destination = S3Destination(
+    #     endpoint='https://cos.ap-shanghai.myqcloud.com',
+    #     access_key='AKIDRnwsa4JLAl8GBspcAVcU9anlUzHLAmAJ',
+    #     secret_key='we7KJ4buxlLhogJm0zkFUUKxWu3yeDZi',
+    #     bucket='textin-1300705866',
+    #     prefix='result',
+    #     region='ap-shanghai'
+    # )
+    
+    # 使用新的 stages 格式创建配置
+    stages = [
+        Stage(
+            type='parse',
+            config=ParseConfig(provider='textin')
+        ),
+        Stage(
+            type='chunk',
+            config=ChunkConfig(
+                strategy='by_title',           # 按标题分块
+                include_orig_elements=False,
+                new_after_n_chars=512,
+                max_characters=1024,
+                overlap=50                     # 块之间重叠 50 字符
+            )
+        )
+        # 如果需要 embed，取消下面的注释
+        # Stage(
+        #     type='embed',
+        #     config=EmbedConfig(
+        #         provider='qwen',
+        #         model_name='text-embedding-v3'
+        #     )
+        # )
+    ]
+    
+    # 创建 Pipeline
+    pipeline = Pipeline(
+        source=source,
+        destination=destination,
+        api_base_url='https://textin-api-go-pre.ai.intsig.net/api/xparse',
+        api_headers=API_HEADERS,
+        stages=stages
+    )
+    
+    # 运行
+    pipeline.run()
+
+
+# ============================================================================
+# 方式 3: 本地测试（本地文件 -> 本地输出）
+# ============================================================================
+
+def run_local_test():
+    """使用本地文件进行测试"""
+    
+    config = {
+        'source': {
+            'type': 'local',
+            'directory': '/Users/ke_wang/Documents/doc',
+            'pattern': '*.pdf'
+        },
+        'destination': {
+            'type': 's3',
+            'endpoint': 'https://textin-minio-api.ai.intsig.net',
+            'access_key': 'IEQspf8C7fVcgmp3AZWl',
+            'secret_key': 'kLj96I8FGbIrPFW08meXivCy4AVdzBijOJWKWOt1',
+            'bucket': 'textin-test',
+            'prefix': '',
+            'region': 'us-east-1'
+        },
+        'api_base_url': 'https://api.textin.com/api/xparse',
+        'api_headers': API_HEADERS,
+        # Stages 配置
+        'stages': [
+            {
+                'type': 'parse',
+                'config': {
+                    'provider': 'textin'
+                }
+            },
+            {
+                'type': 'embed',
+                'config': {
+                    'provider': 'qwen',
+                    'model_name': 'text-embedding-v3'
+                }
+            }
+        ]
+    }
+    
+    pipeline = create_pipeline_from_config(config)
+    pipeline.run()
+
+
+# ============================================================================
+# 方式 4: 处理单个文件
+# ============================================================================
+
+def run_single_file():
+    """只处理单个文件"""
+    from xparse_client import ChunkConfig, EmbedConfig, ParseConfig, Stage
+    
+    # 创建 pipeline
+    source = LocalSource(directory='/Users/ke_wang/Documents/doc', pattern='*.pdf')
+    destination = LocalDestination(output_dir='./output')
+    
+    # 使用新的 stages 格式创建配置
+    stages = [
+        Stage(
+            type='parse',
+            config=ParseConfig(provider='textin')
+        ),
+        Stage(
+            type='chunk',
+            config=ChunkConfig(
+                strategy='by_page',            # 按页面分块
+                max_characters=2048,           # 增大块大小
+                overlap=100
+            )
+        ),
+        Stage(
+            type='embed',
+            config=EmbedConfig(
+                provider='qwen',
+                model_name='text-embedding-v4'  # 使用更高精度的模型
+            )
+        )
+    ]
+    
+    pipeline = Pipeline(
+        source=source,
+        destination=destination,
+        api_base_url='https://api.textin.com/api/xparse',
+        api_headers=API_HEADERS,
+        stages=stages
+    )
+    
+    # 只处理指定文件
+    file_path = '4e3250f00210431fb29ca0c808.pdf'  # 相对于 source directory 的路径
+    success = pipeline.process_file(file_path)
+    
+    if success:
+        print(f"\n✅ 文件 {file_path} 处理成功！")
+    else:
+        print(f"\n❌ 文件 {file_path} 处理失败！")
+
+
+# ============================================================================
+# 方式 5: 自定义处理流程
+# ============================================================================
+
+def run_custom_flow():
+    """自定义处理流程，手动控制文件处理"""
+    from xparse_client import ChunkConfig, EmbedConfig, ParseConfig, Stage
+    
+    # 创建组件
+    source = S3Source(
+        endpoint='https://textin-minio-api.ai.intsig.net',
+        access_key='IEQspf8C7fVcgmp3AZWl',
+        secret_key='kLj96I8FGbIrPFW08meXivCy4AVdzBijOJWKWOt1',
+        bucket='textin-test',
+        prefix='',
+        region='us-east-1',
+        pattern='*.pdf'
+    )
+    
+    destination = MilvusDestination(
+        db_path='./milvus_custom.db',
+        collection_name='custom_collection',
+        dimension=1024
+    )
+    
+    # 使用新的 stages 格式创建配置
+    stages = [
+        Stage(
+            type='parse',
+            config=ParseConfig(provider='textin')
+        ),
+        Stage(
+            type='chunk',
+            config=ChunkConfig(
+                strategy='by_title',
+                include_orig_elements=True,
+                max_characters=1536,
+                overlap=80
+            )
+        ),
+        Stage(
+            type='embed',
+            config=EmbedConfig(
+                provider='qwen',
+                model_name='text-embedding-v4'
+            )
+        )
+    ]
+    
+    pipeline = Pipeline(
+        source=source,
+        destination=destination,
+        api_base_url='https://api.textin.com/api/xparse',
+        api_headers=API_HEADERS,
+        stages=stages
+    )
+    
+    # 手动控制文件处理
+    files = source.list_files()
+    
+    for file_path in files[:2]:  # 只处理前2个文件
+        print(f"\n处理: {file_path}")
+        file_bytes, data_source = source.read_file(file_path)
+        data_source['date_processed'] = datetime.now(timezone.utc).timestamp()
+
+        # 使用 pipeline 接口处理
+        result = pipeline.process_with_pipeline(file_bytes, file_path, data_source)
+        
+        if result:
+            embedded, stats = result
+            print(f"  - 原始元素: {stats.original_elements}")
+            print(f"  - 分块后: {stats.chunked_elements}")
+            print(f"  - 向量化: {stats.embedded_elements}")
+            
+            # 写入
+            metadata = {
+                'file_name': file_path,
+                'data_source': data_source,
+                'stats': {
+                    'original_elements': stats.original_elements,
+                    'chunked_elements': stats.chunked_elements,
+                    'embedded_elements': stats.embedded_elements
+                }
+            }
+            destination.write(embedded, metadata)
+            print(f"✓ 完成: {file_path}")
+        else:
+            print(f"✗ 失败: {file_path}")
+
+
+# ============================================================================
+# 主函数
+# ============================================================================
+
+def main():
+    """主函数 - 选择运行方式"""
+    
+    print("=" * 60)
+    print("Pipeline 运行脚本")
+    print("=" * 60)
+    print("\n请选择运行方式：")
+    print("1. 使用配置字典 (S3 -> Milvus) [基础配置]")
+    print("2. 手动创建组件 (S3 -> Milvus) [按标题分块 + 自定义配置]")
+    print("3. 本地测试 (本地文件 -> 本地输出) [基础配置]")
+    print("4. 处理单个文件 [按页面分块 + V4模型]")
+    print("5. 自定义处理流程 [手动控制 + 统计信息]")
+    print()
+    
+    try:
+        choice = input("请输入选项 (1-5) [默认: 1]: ").strip() or '1'
+        
+        if choice == '1':
+            print("\n使用配置字典运行...")
+            run_with_config()
+        elif choice == '2':
+            print("\n手动创建组件运行...")
+            run_with_manual_setup()
+        elif choice == '3':
+            print("\n本地测试模式...")
+            run_local_test()
+        elif choice == '4':
+            print("\n处理单个文件...")
+            run_single_file()
+        elif choice == '5':
+            print("\n自定义处理流程...")
+            run_custom_flow()
+        else:
+            print("无效的选项，使用默认方式运行...")
+            run_with_config()
+    
+    except KeyboardInterrupt:
+        print("\n\n用户中断执行")
+    except Exception as e:
+        print(f"\n程序异常: {str(e)}")
+        import traceback
+        traceback.print_exc()
+
+
+if __name__ == '__main__':
+    main()
+

xparse_client/__init__.py

@@ -1,4 +1,6 @@
 import logging
+from pathlib import Path
+import re
 
 logging.basicConfig(
     level=logging.INFO,
@@ -31,4 +33,22 @@ __all__ = [
     'create_pipeline_from_config',
 ]
 
-__version__ = '0.2.2'
+# 自动从 pyproject.toml 读取版本号
+def _get_version():
+    """从 pyproject.toml 读取版本号"""
+    try:
+        # 优先尝试从已安装的包中读取版本
+        from importlib.metadata import version
+        return version('xparse-client')
+    except Exception:
+        # 如果包未安装，从 pyproject.toml 读取
+        pyproject_path = Path(__file__).parent.parent / 'pyproject.toml'
+        if pyproject_path.exists():
+            content = pyproject_path.read_text(encoding='utf-8')
+            # 使用正则表达式匹配 version = "x.x.x"
+            match = re.search(r'version\s*=\s*["\']([^"\']+)["\']', content)
+            if match:
+                return match.group(1)
+        return '0.0.0'
+
+__version__ = _get_version()

xparse_client/pipeline/__init__.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+

xparse_client/pipeline/config.py

@@ -0,0 +1,128 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from dataclasses import dataclass, asdict
+from typing import Dict, Any, Optional, Literal, List, Union
+from .destinations import Destination
+
+
+class ParseConfig:
+    """Parse 配置，支持动态字段"""
+
+    def __init__(self, provider: Literal["textin", "mineru", "paddle"] = "textin", **kwargs):
+        self.provider = provider
+        for key, value in kwargs.items():
+            setattr(self, key, value)
+
+    def to_dict(self) -> Dict[str, Any]:
+        result = {'provider': self.provider}
+        for key, value in self.__dict__.items():
+            if not key.startswith('_') and key != 'provider':
+                result[key] = value
+        return result
+
+    def __repr__(self) -> str:
+        attrs = ', '.join(f'{k}={v!r}' for k, v in sorted(self.__dict__.items()) if not k.startswith('_'))
+        return f'ParseConfig({attrs})'
+
+
+@dataclass
+class ChunkConfig:
+    """Chunk 配置"""
+    strategy: Literal["basic", "by_title", "by_page"] = "basic"
+    include_orig_elements: bool = False
+    new_after_n_chars: int = 512
+    max_characters: int = 1024
+    overlap: int = 0
+    overlap_all: bool = False
+
+    def to_dict(self) -> Dict[str, Any]:
+        return asdict(self)
+
+
+@dataclass
+class EmbedConfig:
+    """Embed 配置"""
+    provider: Literal["qwen", "doubao"] = "qwen"
+    model_name: Literal[
+        "text-embedding-v3",
+        "text-embedding-v4",
+        "doubao-embedding-large-text-250515",
+        "doubao-embedding-text-240715"
+    ] = "text-embedding-v3"
+
+    def to_dict(self) -> Dict[str, Any]:
+        return asdict(self)
+
+    def validate(self) -> None:
+        provider_models = {
+            "qwen": ["text-embedding-v3", "text-embedding-v4"],
+            "doubao": ["doubao-embedding-large-text-250515", "doubao-embedding-text-240715"]
+        }
+        if self.provider not in provider_models:
+            raise ValueError(f"不支持的 provider: {self.provider}, 支持的有: {list(provider_models.keys())}")
+        if self.model_name not in provider_models[self.provider]:
+            raise ValueError(
+                f"provider '{self.provider}' 不支持模型 '{self.model_name}', 支持的模型: {provider_models[self.provider]}"
+            )
+
+
+@dataclass
+class Stage:
+    """Pipeline Stage 配置"""
+    type: Literal["parse", "chunk", "embed"]
+    config: Union[ParseConfig, ChunkConfig, EmbedConfig, Dict[str, Any]]
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典格式，用于 API 请求"""
+        if isinstance(self.config, (ParseConfig, ChunkConfig, EmbedConfig)):
+            return {
+                'type': self.type,
+                'config': self.config.to_dict()
+            }
+        else:
+            # 如果 config 已经是字典，直接使用
+            return {
+                'type': self.type,
+                'config': self.config
+            }
+
+    def __repr__(self) -> str:
+        return f"Stage(type={self.type!r}, config={self.config!r})"
+
+
+@dataclass
+class PipelineStats:
+    """Pipeline 统计信息"""
+    original_elements: int = 0
+    chunked_elements: int = 0
+    embedded_elements: int = 0
+    stages: Optional[List[Stage]] = None  # 存储实际执行的 stages
+
+
+@dataclass
+class PipelineConfig:
+    """Pipeline 配置"""
+    include_intermediate_results: bool = False
+    intermediate_results_destination: Optional[Destination] = None  # 支持 Destination 类型，如 LocalDestination、S3Destination 等
+
+    def __post_init__(self):
+        """验证配置"""
+        if self.include_intermediate_results and not self.intermediate_results_destination:
+            raise ValueError("当 include_intermediate_results 为 True 时，必须设置 intermediate_results_destination")
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            'include_intermediate_results': self.include_intermediate_results,
+        }
+
+
+__all__ = [
+    'ParseConfig',
+    'ChunkConfig',
+    'EmbedConfig',
+    'Stage',
+    'PipelineStats',
+    'PipelineConfig',
+]
+