landingai-ade 0.18.1__py3-none-any.whl → 0.18.3__py3-none-any.whl

landingai_ade/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "landingai_ade"
-__version__ = "0.18.1"  # x-release-please-version
+__version__ = "0.18.3"  # x-release-please-version

{landingai_ade-0.18.1.dist-info → landingai_ade-0.18.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: landingai-ade
-Version: 0.18.1
+Version: 0.18.3
 Summary: The official Python library for the landingai-ade API
 Project-URL: Homepage, https://github.com/landing-ai/ade-python
 Project-URL: Repository, https://github.com/landing-ai/ade-python
@@ -65,6 +65,7 @@ The full API of this library can be found in [api.md](https://github.com/landing
 
 ```python
 import os
+from pathlib import Path
 from landingai_ade import LandingAIADE
 
 client = LandingAIADE(
@@ -74,8 +75,8 @@ client = LandingAIADE(
 )
 
 response = client.parse(
-    # support document as File or document_url as local path/remote url
-    document_url="path/to/file",
+    # use document= for local files, document_url= for remote URLs
+    document=Path("path/to/file"),
     model="dpt-2-latest",
 )
 print(response.chunks)
@@ -86,36 +87,13 @@ we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
 to add `VISION_AGENT_API_KEY="My Apikey"` to your `.env` file
 so that your Apikey is not stored in source control.
 
-### Extract
-
-```python
-from landingai_ade import LandingAIADE
-from landingai_ade.lib import pydantic_to_json_schema
-from pydantic import BaseModel, Field
-from pathlib import Path
-
-# Define your schema
-class Person(BaseModel):
-    name: str = Field(description="Person's name")
-    age: int = Field(description="Person's age")
-
-# Convert to JSON schema
-schema = pydantic_to_json_schema(Person)
-# Use with the SDK
-client = LandingAIADE(apikey=os.environ.get("VISION_AGENT_API_KEY"))
-response = client.extract(
-    schema=schema,
-    # support markdown as File or markdown_url as local path/remote url
-    markdown=Path('path/to/file.md')
-)
-```
-
 ### Parse Jobs
 
-For processing large documents or batches of documents asynchronously:
+For processing large documents asynchronously:
 
 ```python
 import os
+from pathlib import Path
 from landingai_ade import LandingAIADE
 
 client = LandingAIADE(
@@ -124,7 +102,7 @@ client = LandingAIADE(
 
 # Create an async parse job
 job = client.parse_jobs.create(
-    document_url="path/to/large_file.pdf",
+    document=Path("path/to/large_file.pdf"),
     model="dpt-2-latest",
 )
 print(f"Job created with ID: {job.job_id}")
@@ -143,6 +121,31 @@ for job in response.jobs:
     print(f"Job {job.job_id}: {job.status}")
 ```
 
+### Extract
+
+```python
+import os
+from pathlib import Path
+from landingai_ade import LandingAIADE
+from landingai_ade.lib import pydantic_to_json_schema
+from pydantic import BaseModel, Field
+
+# Define your schema
+class Person(BaseModel):
+    name: str = Field(description="Person's name")
+    age: int = Field(description="Person's age")
+
+# Convert to JSON schema
+schema = pydantic_to_json_schema(Person)
+# Use with the SDK
+client = LandingAIADE(apikey=os.environ.get("VISION_AGENT_API_KEY"))
+response = client.extract(
+    schema=schema,
+    # use markdown= for local files, markdown_url= for remote URLs
+    markdown=Path('path/to/file.md')
+)
+```
+
 ## Async usage
 
 Simply import `AsyncLandingAIADE` instead of `LandingAIADE` and use `await` with each API call:
@@ -150,6 +153,7 @@ Simply import `AsyncLandingAIADE` instead of `LandingAIADE` and use `await` with
 ```python
 import os
 import asyncio
+from pathlib import Path
 from landingai_ade import AsyncLandingAIADE
 
 client = AsyncLandingAIADE(
@@ -161,7 +165,7 @@ client = AsyncLandingAIADE(
 
 async def main() -> None:
     response = await client.parse(
-        document_url="path/to/file",
+        document=Path("path/to/file"),
         model="dpt-2-latest",
     )
     print(response.chunks)
@@ -187,6 +191,7 @@ Then you can enable it by instantiating the client with `http_client=DefaultAioH
 
 ```python
 import asyncio
+from pathlib import Path
 from landingai_ade import DefaultAioHttpClient
 from landingai_ade import AsyncLandingAIADE
 
@@ -197,7 +202,7 @@ async def main() -> None:
         http_client=DefaultAioHttpClient(),
     ) as client:
         response = await client.parse(
-            document_url="path/to/file",
+            document=Path("path/to/file"),
             model="dpt-2-latest",
         )
         print(response.chunks)

{landingai_ade-0.18.1.dist-info → landingai_ade-0.18.3.dist-info}/RECORD

@@ -11,7 +11,7 @@ landingai_ade/_resource.py,sha256=fZFMI9zYnf0F6ACBB8teJVzhBelkymH2SMQripxfTvI,11
 landingai_ade/_response.py,sha256=qUH6kfV7CszYHyJKTrJXtJY5b2zPizEM6HyGgsisLtI,28858
 landingai_ade/_streaming.py,sha256=V4RaEBKfcNOdOfTAwMzlx_klsTLILvpnS7PvBWC5Exw,10124
 landingai_ade/_types.py,sha256=8of7ETx2GzlS0kq-JMky4iQt-ZtOQeppgwjQMFF85nw,7253
-landingai_ade/_version.py,sha256=J0nnSdAhAwIhIfQCi8w7YdO3y9QHkqbcM9bCD03XT6g,166
+landingai_ade/_version.py,sha256=pwLfShhGC5beob06aE9l9WrY1tOTrwF5wcGD1UyMLt0,166
 landingai_ade/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 landingai_ade/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
 landingai_ade/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
@@ -44,7 +44,7 @@ landingai_ade/types/parse_response.py,sha256=yr_IvBPWJBwK22FJ3spqcdvaD19enADGBZx
 landingai_ade/types/shared/__init__.py,sha256=n7dKpO8IQEstmlDczxcje4R_Kkg9EKn3UMejh8Q7_ns,218
 landingai_ade/types/shared/parse_grounding_box.py,sha256=tZ85sGAtkcTs-_jiVjD-hK8tHTn6vh6VHEW_ndmBB3w,260
 landingai_ade/types/shared/parse_metadata.py,sha256=r509Ig1rWW96pplh3PR25wNH40mGJBFENgsLvSFmHgY,384
-landingai_ade-0.18.1.dist-info/METADATA,sha256=bL72j-YFnz8_lHPdeluZ_hqIni-cd0KPgOJ6naF3xJ4,16003
-landingai_ade-0.18.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-landingai_ade-0.18.1.dist-info/licenses/LICENSE,sha256=xQsP4c8KA_Ov7OhSD-tj_2U8RQ8z9MQUy-WEjgbJdZU,11343
-landingai_ade-0.18.1.dist-info/RECORD,,
+landingai_ade-0.18.3.dist-info/METADATA,sha256=WcH63vjWEv-6DIqODfJBIV36QxQWvBUZz0dMtGbtqjM,16087
+landingai_ade-0.18.3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+landingai_ade-0.18.3.dist-info/licenses/LICENSE,sha256=xQsP4c8KA_Ov7OhSD-tj_2U8RQ8z9MQUy-WEjgbJdZU,11343
+landingai_ade-0.18.3.dist-info/RECORD,,