datalab-python-sdk 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

datalab_python_sdk-0.6.0.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.5
+Name: datalab-python-sdk
+Version: 0.6.0
+Summary: SDK for the Datalab document intelligence API
+Project-URL: Homepage, https://www.datalab.to
+Project-URL: Documentation, https://documentation.datalab.to
+Project-URL: Repository, https://github.com/datalab-to/sdk
+Author-email: Datalab Team <hi@datalab.to>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,datalab,document-intelligence,sdk
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.12.14
+Requires-Dist: click>=8.2.1
+Requires-Dist: ijson>=3.3.0
+Requires-Dist: pydantic-settings>=2.10.1
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: tenacity>=8.2.3
+Requires-Dist: tqdm>=4.66.0
+Description-Content-Type: text/markdown
+
+# Datalab SDK
+
+A Python SDK for the [Datalab API](https://www.datalab.to/?utm_source=gh-sdk) - it turns documents into verifiable knowledge your agents act on. Datalab is the team behind [Chandra](https://github.com/datalab-to/chandra), [marker](https://github.com/datalab-to/marker), [surya](https://github.com/datalab-to/surya), and [lift](https://github.com/datalab-to/lift).
+
+See the full documentation at [https://documentation.datalab.to](https://documentation.datalab.to).
+
+## Installation
+
+```bash
+pip install datalab-python-sdk
+```
+
+## Quick Start
+
+### Authentication
+
+[Sign up](https://www.datalab.to/?utm_source=gh-sdk), then get your API key from [https://www.datalab.to/app/keys](https://www.datalab.to/app/keys):
+
+```bash
+export DATALAB_API_KEY="your_api_key_here"
+```
+
+### Basic Usage
+
+```python
+from datalab_sdk import DatalabClient
+
+client = DatalabClient() # use env var from above, or pass api_key="your_api_key_here"
+
+# Convert PDF to markdown
+result = client.convert("document.pdf")
+print(result.markdown)
+```
+
+`AsyncDatalabClient` has the same methods as `DatalabClient`, as coroutines.
+
+## Conversion options
+
+```python
+from datalab_sdk import ConvertOptions
+
+options = ConvertOptions(
+    mode="balanced",               # lite, fast, balanced, accurate (SDK default: fast)
+    output_format="markdown,html", # markdown, html, json, chunks (comma-separated)
+    page_range="0-4",
+    extras="chart_understanding,table_cell_bboxes",
+    merge_cross_page=True,         # merge tables, paragraphs and lists split across pages
+    word_bboxes=True,              # per-word bounding boxes in the HTML output
+    save_checkpoint=True,          # reuse the parse in extract() or segment()
+)
+result = client.convert("document.pdf", options=options)
+```
+
+Other options include `paginate`, `add_block_ids`, `disable_html_prettify`, `exact_transcription`, `token_efficient_markdown`, `include_markdown_in_chunks`, `disable_image_extraction`, `disable_image_captions`, `fence_synthetic_captions`, `keep_spreadsheet_formatting`, `keep_pageheader_in_output`, `keep_pagefooter_in_output`, `additional_config`, `webhook_url`, `skip_cache` and `processing_location`. The [API reference](https://documentation.datalab.to/api-reference/convert-document) describes each option.
+
+## Structured extraction
+
+```python
+from datalab_sdk import ExtractOptions
+
+result = client.extract(
+    "invoice.pdf",
+    options=ExtractOptions(
+        page_schema='{"properties": {"total": {"type": "number"}}}',  # or schema_id="sch_..."
+        extraction_mode="balanced",  # turbo, fast, balanced, accurate
+    ),
+)
+print(result.extraction_schema_json, result.extraction_score_average)
+```
+
+When you do not set the parse `mode`, the API picks the parse mode that matches `extraction_mode`.
+
+## Other endpoints
+
+| Method | Endpoint |
+| --- | --- |
+| `run_agent()` | **Beta:** run an existing published processor (`AgentOptions(processor="cp_...")`) |
+| `segment()` | Split a document into sections (`SegmentOptions`) |
+| `fill()` | Fill a PDF or image form (`FormFillingOptions`) |
+| `form_fields()` | Find the fillable fields in a PDF or image |
+| `track_changes()` | Read tracked changes and comments from DOCX or PDF |
+| `create_document()` | Make a DOCX from markdown with track changes markup |
+| `generate_extraction_schemas()` | Suggest extraction schemas for a saved checkpoint |
+| `delete_result()` | Result deletion, by `result.request_id` |
+| `upload_files()`, `list_files()`, ... | File storage. Pass the returned `datalab://file-...` reference as `file_url` |
+| `create_extraction_schema()`, ... | Saved extraction schemas |
+| `create_pipeline()`, `run_pipeline()`, ... | [Pipelines](https://documentation.datalab.to/docs/welcome/sdk/pipelines) |
+
+`run_custom_processor()` and `ocr()` call deprecated API endpoints. Use `run_agent()` and `convert()` instead.
+
+Published-agent execution is in open beta; the API may change. Processor design and raw-prompt execution are not included.
+
+## Inputs, polling and errors
+
+- Send a local file with `file_path`, or a URL or a `datalab://file-...` reference with `file_url`. When you set `processing_location`, send the document as `file_url`.
+- Processing methods poll until the result is ready. Set `max_polls` and `poll_interval` to change the limit (default: 300 polls, 1 second apart). Use `stream_response_to` to write a large result straight to disk.
+- The SDK retries a submission that gets HTTP 429 or 503, and polls that get 408, 429, 5xx or a connection error. It waits for the `Retry-After` header when the API sends one.
+- API errors raise `DatalabAPIError` (with `status_code` and `response_data`) or one of its subclasses: `DatalabAuthenticationError` (401, 403), `DatalabPaymentRequiredError` (402), `DatalabNotFoundError` (404), `DatalabRateLimitError` (429) and `DatalabServerError` (5xx). Invalid arguments raise `DatalabValidationError`, which is also a `ValueError`.
+
+## Workflows
+
+The Datalab API removed the Workflows API. The workflow methods and CLI commands in this SDK are deprecated, and the API does not answer them. Use pipelines instead.
+
+## CLI Usage
+
+The SDK includes a command-line interface:
+
+```bash
+# Convert a document or a directory of documents
+datalab convert document.pdf --mode balanced --format markdown,html
+
+# Extract with a saved schema
+datalab extract invoice.pdf --schema_id sch_XXXXX --extraction_mode fast
+
+# Other commands
+datalab agent --help
+datalab segment --help
+datalab fill --help
+datalab form-fields --help
+datalab track-changes --help
+datalab create-document --help
+```
+
+## Contributing
+
+Issues and bug reports are welcome here. We develop the SDK in a private repository and mirror each release to this one, so we do not merge pull requests here directly. Open an issue, or open a pull request to show the change, and we will port it and credit you.
+
+## License
+
+MIT License

datalab_python_sdk-0.6.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+datalab_sdk/__init__.py,sha256=BLAqVuqjxhdjKabkDUePLSmGeVMo0BnWfVbLDt8haP4,2397
+datalab_sdk/cli.py,sha256=DAI7fzs_1cqEctp9N_rw9VPuiIFHgN75w41FG55HxrM,52427
+datalab_sdk/client.py,sha256=PvcNA7ff6yqIKvLkspG2XzSYMStYKlvAIkZRNDNblWg,125551
+datalab_sdk/exceptions.py,sha256=5-lzlfvB7FKGOhvgyacceTFRRUxton_JqcIyuB8k_mU,2625
+datalab_sdk/mimetypes.py,sha256=a4ULJmHxoR_RMsD0j51hx0t2Q7In_PzNm7UlWX07eEE,932
+datalab_sdk/models.py,sha256=OpiIAdOVcL2tdfBkzRNHZ8MjGjRiBSjaKtFVf_U1l8w,32494
+datalab_sdk/settings.py,sha256=B_B42QQADAz6ePXQTOqENZllcppFR4JpwonEk2vlzhw,693
+datalab_python_sdk-0.6.0.dist-info/METADATA,sha256=E2qTxFzvZarV8CeVwvGR7UW-EA6lUn_iLG9NlIT450s,6582
+datalab_python_sdk-0.6.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+datalab_python_sdk-0.6.0.dist-info/entry_points.txt,sha256=rqWxO21UV57JxxyeF20iBTxHpzBYOA69hCHIqwdn-Ok,48
+datalab_python_sdk-0.6.0.dist-info/licenses/LICENSE,sha256=XGjT-Uz6t7UZzr3JCZfilsGcZEgMm_1aONcRunohxWg,1064
+datalab_python_sdk-0.6.0.dist-info/RECORD,,

{datalab_python_sdk-0.4.0.dist-info → datalab_python_sdk-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.29.0
+Generator: hatchling 1.32.4
 Root-Is-Purelib: true
 Tag: py3-none-any

datalab_sdk/__init__.py

@@ -6,7 +6,18 @@ supporting document conversion, extraction, segmentation, and more.
 """
 
 from .client import DatalabClient, AsyncDatalabClient
-from .exceptions import DatalabError, DatalabAPIError, DatalabTimeoutError
+from .exceptions import (
+    DatalabError,
+    DatalabAPIError,
+    DatalabAuthenticationError,
+    DatalabPaymentRequiredError,
+    DatalabNotFoundError,
+    DatalabRateLimitError,
+    DatalabServerError,
+    DatalabTimeoutError,
+    DatalabFileError,
+    DatalabValidationError,
+)
 from .models import (
     ConversionResult,
     CreateDocumentResult,
@@ -15,16 +26,30 @@ from .models import (
     ConvertOptions,
     ExtractOptions,
     SegmentOptions,
+    CustomProcessorOptions,
     CustomPipelineOptions,
     TrackChangesOptions,
     OCROptions,
     FormFillingOptions,
     FormFillingResult,
+    FormFieldsOptions,
+    FormFieldsResult,
+    AgentOptions,
+    AgentResult,
+    ExtractionSchemaSuggestions,
     Workflow,
     WorkflowStep,
     WorkflowExecution,
     InputConfig,
     UploadedFileMetadata,
+    ExtractionSchema,
+    PipelineProcessor,
+    PipelineConfig,
+    PipelineVersion,
+    PipelineExecution,
+    PipelineExecutionStepResult,
+    CustomProcessor,
+    CustomProcessorVersion,
 )
 from .settings import settings
 
@@ -34,7 +59,14 @@ __all__ = [
     "AsyncDatalabClient",
     "DatalabError",
     "DatalabAPIError",
+    "DatalabAuthenticationError",
+    "DatalabPaymentRequiredError",
+    "DatalabNotFoundError",
+    "DatalabRateLimitError",
+    "DatalabServerError",
     "DatalabTimeoutError",
+    "DatalabFileError",
+    "DatalabValidationError",
     "ConversionResult",
     "CreateDocumentResult",
     "FileResult",
@@ -42,14 +74,28 @@ __all__ = [
     "ConvertOptions",
     "ExtractOptions",
     "SegmentOptions",
+    "CustomProcessorOptions",
     "CustomPipelineOptions",
     "TrackChangesOptions",
     "OCROptions",
     "FormFillingOptions",
     "FormFillingResult",
+    "FormFieldsOptions",
+    "FormFieldsResult",
+    "AgentOptions",
+    "AgentResult",
+    "ExtractionSchemaSuggestions",
     "Workflow",
     "WorkflowStep",
     "WorkflowExecution",
     "InputConfig",
     "UploadedFileMetadata",
+    "ExtractionSchema",
+    "PipelineProcessor",
+    "PipelineConfig",
+    "PipelineVersion",
+    "PipelineExecution",
+    "PipelineExecutionStepResult",
+    "CustomProcessor",
+    "CustomProcessorVersion",
 ]