xparse-client 0.3.0b9__tar.gz → 0.3.0b11__tar.gz

{xparse_client-0.3.0b9/xparse_client.egg-info → xparse_client-0.3.0b11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xparse-client
-Version: 0.3.0b9
+Version: 0.3.0b11
 Summary: 面向 Agent 和 RAG 的文档处理 Pipeline 客户端
 Author-email: INTSIG-TEXTIN <support@textin.com>
 License-Expression: MIT
@@ -223,6 +223,7 @@ with open("document.pdf", "rb") as f:
         extract_config=ExtractConfig(schema=schema)
     )
 
+# Extract API 返回的结构化数据在 result.result 中
 print(result.result)
 ```
 
@@ -277,22 +278,11 @@ result = client.parse.wait_for_result(
     poll_interval=5.0
 )
 
-print(f"任务完成，解析出 {len(result.result.elements)} 个元素")
-```
-
-### 同步 vs 异步
-
-```python
-# 同步调用（适合小文件）
-result = client.parse.partition(file=f, filename="doc.pdf")
-
-# 异步调用（相同接口，加上 _async 后缀）
-import asyncio
-
-async def main():
-    result = await client.parse.partition_async(file=f, filename="doc.pdf")
-
-asyncio.run(main())
+if result.is_completed:
+    print(f"任务完成，结果 URL: {result.result_url}")
+    print("💡 异步任务返回的是 result_url，需要另外下载来获取解析结果")
+elif result.is_failed:
+    print(f"任务失败: {result.error_message}")
 ```
 
 ---
@@ -326,7 +316,17 @@ result = client.pipeline.execute(
 
 ### 📊 详细的处理统计
 
+Pipeline API 返回详细的处理统计信息：
+
 ```python
+# 使用 Pipeline API 时可以获取统计信息
+result = client.pipeline.execute(
+    file=f,
+    filename="document.pdf",
+    stages=[ParseStage(...), ChunkStage(...), EmbedStage(...)]
+)
+
+# 访问统计信息
 print(f"原始元素: {result.stats.original_elements}")
 print(f"分块后: {result.stats.chunked_elements}")
 print(f"向量化: {result.stats.embedded_elements}")
@@ -750,11 +750,15 @@ job = client.parse.create_async_job(file=f, filename="large.pdf")
 
 # 方式 1：自动等待完成
 result = client.parse.wait_for_result(job_id=job.job_id, timeout=300)
+if result.is_completed:
+    print(f"任务完成，结果 URL: {result.result_url}")
+    # 注意：异步任务返回的是 result_url，需要另外下载来获取解析结果
 
 # 方式 2：手动轮询
 while True:
     status = client.parse.get_result(job_id=job.job_id)
-    if status.status == "completed":
+    if status.is_completed:
+        print(f"结果 URL: {status.result_url}")
         break
     time.sleep(5)
 ```

{xparse_client-0.3.0b9 → xparse_client-0.3.0b11}/README.md

@@ -174,6 +174,7 @@ with open("document.pdf", "rb") as f:
         extract_config=ExtractConfig(schema=schema)
     )
 
+# Extract API 返回的结构化数据在 result.result 中
 print(result.result)
 ```
 
@@ -228,22 +229,11 @@ result = client.parse.wait_for_result(
     poll_interval=5.0
 )
 
-print(f"任务完成，解析出 {len(result.result.elements)} 个元素")
-```
-
-### 同步 vs 异步
-
-```python
-# 同步调用（适合小文件）
-result = client.parse.partition(file=f, filename="doc.pdf")
-
-# 异步调用（相同接口，加上 _async 后缀）
-import asyncio
-
-async def main():
-    result = await client.parse.partition_async(file=f, filename="doc.pdf")
-
-asyncio.run(main())
+if result.is_completed:
+    print(f"任务完成，结果 URL: {result.result_url}")
+    print("💡 异步任务返回的是 result_url，需要另外下载来获取解析结果")
+elif result.is_failed:
+    print(f"任务失败: {result.error_message}")
 ```
 
 ---
@@ -277,7 +267,17 @@ result = client.pipeline.execute(
 
 ### 📊 详细的处理统计
 
+Pipeline API 返回详细的处理统计信息：
+
 ```python
+# 使用 Pipeline API 时可以获取统计信息
+result = client.pipeline.execute(
+    file=f,
+    filename="document.pdf",
+    stages=[ParseStage(...), ChunkStage(...), EmbedStage(...)]
+)
+
+# 访问统计信息
 print(f"原始元素: {result.stats.original_elements}")
 print(f"分块后: {result.stats.chunked_elements}")
 print(f"向量化: {result.stats.embedded_elements}")
@@ -701,11 +701,15 @@ job = client.parse.create_async_job(file=f, filename="large.pdf")
 
 # 方式 1：自动等待完成
 result = client.parse.wait_for_result(job_id=job.job_id, timeout=300)
+if result.is_completed:
+    print(f"任务完成，结果 URL: {result.result_url}")
+    # 注意：异步任务返回的是 result_url，需要另外下载来获取解析结果
 
 # 方式 2：手动轮询
 while True:
     status = client.parse.get_result(job_id=job.job_id)
-    if status.status == "completed":
+    if status.is_completed:
+        print(f"结果 URL: {status.result_url}")
         break
     time.sleep(5)
 ```

{xparse_client-0.3.0b9 → xparse_client-0.3.0b11}/example/1_basic_api_usage.py

@@ -95,9 +95,9 @@ def example_2_extract_structured_data():
             )
 
         print("\n✅ 提取成功!")
-        # Extract API 返回的数据在 extract_result.extracted_schema 中
-        if result.extract_result and "extracted_schema" in result.extract_result:
-            print(f"  提取的数据: {result.extract_result['extracted_schema']}")
+        # Extract API 返回的数据在 result.result 中
+        if result.result:
+            print(f"  提取的数据: {result.result}")
         else:
             print("  未提取到数据")
 

{xparse_client-0.3.0b9 → xparse_client-0.3.0b11}/example/2_async_job.py

@@ -52,7 +52,8 @@ def example_1_create_and_wait():
             print(f"  - 任务 ID: {result.job_id}")
             print(f"  - 文件 ID: {result.file_id}")
             print(f"  - 结果 URL: {result.result_url}")
-            print("\n  💡 提示: 需要下载 result_url 来获取解析结果")
+            print("\n  💡 提示: 异步任务只返回 result_url，需要另外下载来获取解析结果")
+            print("           result_url 是一个可以下载的 JSON 文件 URL")
         elif result.is_failed:
             print(f"\n❌ 任务失败: {result.error_message}")
         else:

{xparse_client-0.3.0b9 → xparse_client-0.3.0b11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xparse-client"
-version = "0.3.0b9"
+version = "0.3.0b11"
 description = "面向 Agent 和 RAG 的文档处理 Pipeline 客户端"
 readme = "README.md"
 license = "MIT"

{xparse_client-0.3.0b9 → xparse_client-0.3.0b11}/xparse_client/api/extract.py

@@ -96,7 +96,7 @@ class Extract(BaseAPI):
         # 处理 extract_config
         if extract_config:
             data["extract_config"] = json.dumps(
-                extract_config.model_dump(), ensure_ascii=False
+                extract_config.model_dump(by_alias=True), ensure_ascii=False
             )
         else:
             raise ValueError("extract_config is required")

{xparse_client-0.3.0b9 → xparse_client-0.3.0b11/xparse_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xparse-client
-Version: 0.3.0b9
+Version: 0.3.0b11
 Summary: 面向 Agent 和 RAG 的文档处理 Pipeline 客户端
 Author-email: INTSIG-TEXTIN <support@textin.com>
 License-Expression: MIT
@@ -223,6 +223,7 @@ with open("document.pdf", "rb") as f:
         extract_config=ExtractConfig(schema=schema)
     )
 
+# Extract API 返回的结构化数据在 result.result 中
 print(result.result)
 ```
 
@@ -277,22 +278,11 @@ result = client.parse.wait_for_result(
     poll_interval=5.0
 )
 
-print(f"任务完成，解析出 {len(result.result.elements)} 个元素")
-```
-
-### 同步 vs 异步
-
-```python
-# 同步调用（适合小文件）
-result = client.parse.partition(file=f, filename="doc.pdf")
-
-# 异步调用（相同接口，加上 _async 后缀）
-import asyncio
-
-async def main():
-    result = await client.parse.partition_async(file=f, filename="doc.pdf")
-
-asyncio.run(main())
+if result.is_completed:
+    print(f"任务完成，结果 URL: {result.result_url}")
+    print("💡 异步任务返回的是 result_url，需要另外下载来获取解析结果")
+elif result.is_failed:
+    print(f"任务失败: {result.error_message}")
 ```
 
 ---
@@ -326,7 +316,17 @@ result = client.pipeline.execute(
 
 ### 📊 详细的处理统计
 
+Pipeline API 返回详细的处理统计信息：
+
 ```python
+# 使用 Pipeline API 时可以获取统计信息
+result = client.pipeline.execute(
+    file=f,
+    filename="document.pdf",
+    stages=[ParseStage(...), ChunkStage(...), EmbedStage(...)]
+)
+
+# 访问统计信息
 print(f"原始元素: {result.stats.original_elements}")
 print(f"分块后: {result.stats.chunked_elements}")
 print(f"向量化: {result.stats.embedded_elements}")
@@ -750,11 +750,15 @@ job = client.parse.create_async_job(file=f, filename="large.pdf")
 
 # 方式 1：自动等待完成
 result = client.parse.wait_for_result(job_id=job.job_id, timeout=300)
+if result.is_completed:
+    print(f"任务完成，结果 URL: {result.result_url}")
+    # 注意：异步任务返回的是 result_url，需要另外下载来获取解析结果
 
 # 方式 2：手动轮询
 while True:
     status = client.parse.get_result(job_id=job.job_id)
-    if status.status == "completed":
+    if status.is_completed:
+        print(f"结果 URL: {status.result_url}")
         break
     time.sleep(5)
 ```