unsiloed-apimatic-sdk 0.0.2__py3-none-any.whl

unsiloed_ai_document_processing_api/__init__.py

@@ -0,0 +1,14 @@
+from . import models
+from .async_client import AsyncClient, AsyncUnsiloedAiDocumentProcessingApiClient
+from .client import Client, UnsiloedAiDocumentProcessingApiClient
+from .server import Environment, ServerConfig
+
+__all__ = [
+    "models",
+    "AsyncClient",
+    "AsyncUnsiloedAiDocumentProcessingApiClient",
+    "Client",
+    "Environment",
+    "ServerConfig",
+    "UnsiloedAiDocumentProcessingApiClient",
+]

unsiloed_ai_document_processing_api/apis/__init__.py

@@ -0,0 +1,24 @@
+from .classify import AsyncClassify, Classify
+from .extract import AsyncExtract, Extract
+from .health import AsyncHealth, Health
+from .organization import AsyncOrganization, Organization
+from .parse_v2_presigned_upload import AsyncParseV2PresignedUpload, ParseV2PresignedUpload
+from .parse_vision_api_compatible import AsyncParseVisionApiCompatible, ParseVisionApiCompatible
+from .split import AsyncSplit, Split
+
+__all__ = [
+    "AsyncClassify",
+    "AsyncExtract",
+    "AsyncHealth",
+    "AsyncOrganization",
+    "AsyncParseV2PresignedUpload",
+    "AsyncParseVisionApiCompatible",
+    "AsyncSplit",
+    "Classify",
+    "Extract",
+    "Health",
+    "Organization",
+    "ParseV2PresignedUpload",
+    "ParseVisionApiCompatible",
+    "Split",
+]

unsiloed_ai_document_processing_api/apis/classify.py

@@ -0,0 +1,264 @@
+from __future__ import annotations
+
+from uuid import UUID, uuid4
+
+from ..auth import AsyncAuthSchemes, AuthSchemes
+from ..core import (
+    ApiResult,
+    AsyncFileInput,
+    AsyncRawClient,
+    FileInput,
+    RawClient,
+    RequestOptionsOrDict,
+    SecuredRawResponse,
+    file_part,
+    json_decoder,
+    multipart_body,
+    param,
+)
+from ..errors.classify_document_error import ClassifyDocumentErrorBody, classify_document_error_mapper
+from ..errors.get_classification_job_status_error import (
+    GetClassificationJobStatusErrorBody,
+    get_classification_job_status_error_mapper,
+)
+from ..models.classify_response import ClassifyResponse
+from ..models.classify_response1 import ClassifyResponse1
+from ..server.server import Server
+
+
+class Classify:
+    def __init__(self, client: RawClient, server: Server, auth: AuthSchemes) -> None:
+        self._with_raw_response = ClassifyWithRawResponse(client, server, auth)
+
+    def classify_document(
+        self,
+        categories: str,
+        *,
+        pdf_file: FileInput | None = None,
+        file_url: str | None = None,
+        request_options: RequestOptionsOrDict | None = None,
+    ) -> ClassifyResponse:
+        """Classify PDF and image documents into predefined categories
+
+        Args:
+            categories: JSON string containing an array of category objects with a required name. Example:
+                [{"name":"invoice"},{"name":"contract"},{"name":"receipt"}]. A "description" key is accepted for
+                compatibility but is not used by classification.
+            pdf_file: The document to classify: a PDF or an image (JPG, PNG, GIF, WebP, BMP, TIFF). Provide either
+                pdf_file or file_url, not both. Maximum file size: 500MB.
+            file_url: URL to a document to classify (PDF or image). Provide either pdf_file or file_url, not both.
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            Accepted - classification job started
+
+        Raises:
+            ApiError: Bad request, e.g. neither ``pdf_file`` nor ``file_url`` provided, or invalid schema. Missing or
+                invalid API key. Insufficient quota. Missing or malformed form fields. Rate limit exceeded. Service
+                unavailable. Either the job queue is full (``error.details.reason`` = ``queue_full``, ``Retry-After``
+                5-60 s) or the platform-wide capacity limit was hit (``Retry-After: 5``, no ``details``). ``error`` is
+                ``DetailError | Classify402Error1 | ErrorEnvelope | RawError``."""
+        return self._with_raw_response.classify_document(
+            categories, pdf_file=pdf_file, file_url=file_url, request_options=request_options
+        ).unwrap()
+
+    def get_classification_job_status(
+        self, job_id: str, *, request_options: RequestOptionsOrDict | None = None
+    ) -> ClassifyResponse1:
+        """Check the status and progress of classification jobs and retrieve results
+
+        Args:
+            job_id: The unique identifier of the classification job
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            Classification job status retrieved successfully
+
+        Raises:
+            ApiError: Job not found. Service unavailable: platform-wide capacity limit reached. Retry after the
+                ``Retry-After`` header (5 s). ``error`` is ``DetailError | ErrorEnvelope | RawError``."""
+        return self._with_raw_response.get_classification_job_status(job_id, request_options=request_options).unwrap()
+
+    @property
+    def with_raw_response(self) -> ClassifyWithRawResponse:
+        return self._with_raw_response
+
+
+class AsyncClassify:
+    def __init__(self, client: AsyncRawClient, server: Server, auth: AsyncAuthSchemes) -> None:
+        self._with_raw_response = AsyncClassifyWithRawResponse(client, server, auth)
+
+    async def classify_document(
+        self,
+        categories: str,
+        *,
+        pdf_file: AsyncFileInput | None = None,
+        file_url: str | None = None,
+        request_options: RequestOptionsOrDict | None = None,
+    ) -> ClassifyResponse:
+        """Classify PDF and image documents into predefined categories
+
+        Args:
+            categories: JSON string containing an array of category objects with a required name. Example:
+                [{"name":"invoice"},{"name":"contract"},{"name":"receipt"}]. A "description" key is accepted for
+                compatibility but is not used by classification.
+            pdf_file: The document to classify: a PDF or an image (JPG, PNG, GIF, WebP, BMP, TIFF). Provide either
+                pdf_file or file_url, not both. Maximum file size: 500MB.
+            file_url: URL to a document to classify (PDF or image). Provide either pdf_file or file_url, not both.
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            Accepted - classification job started
+
+        Raises:
+            ApiError: Bad request, e.g. neither ``pdf_file`` nor ``file_url`` provided, or invalid schema. Missing or
+                invalid API key. Insufficient quota. Missing or malformed form fields. Rate limit exceeded. Service
+                unavailable. Either the job queue is full (``error.details.reason`` = ``queue_full``, ``Retry-After``
+                5-60 s) or the platform-wide capacity limit was hit (``Retry-After: 5``, no ``details``). ``error`` is
+                ``DetailError | Classify402Error1 | ErrorEnvelope | RawError``."""
+        return (
+            await self._with_raw_response.classify_document(
+                categories, pdf_file=pdf_file, file_url=file_url, request_options=request_options
+            )
+        ).unwrap()
+
+    async def get_classification_job_status(
+        self, job_id: str, *, request_options: RequestOptionsOrDict | None = None
+    ) -> ClassifyResponse1:
+        """Check the status and progress of classification jobs and retrieve results
+
+        Args:
+            job_id: The unique identifier of the classification job
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            Classification job status retrieved successfully
+
+        Raises:
+            ApiError: Job not found. Service unavailable: platform-wide capacity limit reached. Retry after the
+                ``Retry-After`` header (5 s). ``error`` is ``DetailError | ErrorEnvelope | RawError``."""
+        return (
+            await self._with_raw_response.get_classification_job_status(job_id, request_options=request_options)
+        ).unwrap()
+
+    @property
+    def with_raw_response(self) -> AsyncClassifyWithRawResponse:
+        return self._with_raw_response
+
+
+class ClassifyWithRawResponse(SecuredRawResponse[RawClient, Server, AuthSchemes]):
+    def classify_document(
+        self,
+        categories: str,
+        *,
+        pdf_file: FileInput | None = None,
+        file_url: str | None = None,
+        request_options: RequestOptionsOrDict | None = None,
+    ) -> ApiResult[ClassifyResponse, ClassifyDocumentErrorBody]:
+        """Classify PDF and image documents into predefined categories
+
+        Args:
+            categories: JSON string containing an array of category objects with a required name. Example:
+                [{"name":"invoice"},{"name":"contract"},{"name":"receipt"}]. A "description" key is accepted for
+                compatibility but is not used by classification.
+            pdf_file: The document to classify: a PDF or an image (JPG, PNG, GIF, WebP, BMP, TIFF). Provide either
+                pdf_file or file_url, not both. Maximum file size: 500MB.
+            file_url: URL to a document to classify (PDF or image). Provide either pdf_file or file_url, not both.
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            An ``ApiResult`` holding the deserialized response or the error body."""
+        return self._client.execute(
+            http_method="POST",
+            url_template=self._server.default("/classify"),
+            headers=[param[UUID]("Idempotency-Key", uuid4())],
+            body=multipart_body(
+                param[str]("categories", categories),
+                file_part("pdf_file", pdf_file) if pdf_file is not None else None,
+                param[str | None]("file_url", file_url),
+            ),
+            auth_scheme=self._auth.api_key_auth,
+            decoder=json_decoder[ClassifyResponse],
+            error_mapper=classify_document_error_mapper,
+            request_options=request_options,
+        )
+
+    def get_classification_job_status(
+        self, job_id: str, *, request_options: RequestOptionsOrDict | None = None
+    ) -> ApiResult[ClassifyResponse1, GetClassificationJobStatusErrorBody]:
+        """Check the status and progress of classification jobs and retrieve results
+
+        Args:
+            job_id: The unique identifier of the classification job
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            An ``ApiResult`` holding the deserialized response or the error body."""
+        return self._client.execute(
+            http_method="GET",
+            url_template=self._server.default("/classify/{job_id}"),
+            path_params=[param[str]("job_id", job_id)],
+            auth_scheme=self._auth.api_key_auth,
+            decoder=json_decoder[ClassifyResponse1],
+            error_mapper=get_classification_job_status_error_mapper,
+            request_options=request_options,
+        )
+
+
+class AsyncClassifyWithRawResponse(SecuredRawResponse[AsyncRawClient, Server, AsyncAuthSchemes]):
+    async def classify_document(
+        self,
+        categories: str,
+        *,
+        pdf_file: AsyncFileInput | None = None,
+        file_url: str | None = None,
+        request_options: RequestOptionsOrDict | None = None,
+    ) -> ApiResult[ClassifyResponse, ClassifyDocumentErrorBody]:
+        """Classify PDF and image documents into predefined categories
+
+        Args:
+            categories: JSON string containing an array of category objects with a required name. Example:
+                [{"name":"invoice"},{"name":"contract"},{"name":"receipt"}]. A "description" key is accepted for
+                compatibility but is not used by classification.
+            pdf_file: The document to classify: a PDF or an image (JPG, PNG, GIF, WebP, BMP, TIFF). Provide either
+                pdf_file or file_url, not both. Maximum file size: 500MB.
+            file_url: URL to a document to classify (PDF or image). Provide either pdf_file or file_url, not both.
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            An ``ApiResult`` holding the deserialized response or the error body."""
+        return await self._client.execute(
+            http_method="POST",
+            url_template=self._server.default("/classify"),
+            headers=[param[UUID]("Idempotency-Key", uuid4())],
+            body=multipart_body(
+                param[str]("categories", categories),
+                file_part("pdf_file", pdf_file) if pdf_file is not None else None,
+                param[str | None]("file_url", file_url),
+            ),
+            auth_scheme=self._auth.api_key_auth,
+            decoder=json_decoder[ClassifyResponse],
+            error_mapper=classify_document_error_mapper,
+            request_options=request_options,
+        )
+
+    async def get_classification_job_status(
+        self, job_id: str, *, request_options: RequestOptionsOrDict | None = None
+    ) -> ApiResult[ClassifyResponse1, GetClassificationJobStatusErrorBody]:
+        """Check the status and progress of classification jobs and retrieve results
+
+        Args:
+            job_id: The unique identifier of the classification job
+            request_options: Per-call overrides for this one request, such as a timeout or extra headers.
+
+        Returns:
+            An ``ApiResult`` holding the deserialized response or the error body."""
+        return await self._client.execute(
+            http_method="GET",
+            url_template=self._server.default("/classify/{job_id}"),
+            path_params=[param[str]("job_id", job_id)],
+            auth_scheme=self._auth.api_key_auth,
+            decoder=json_decoder[ClassifyResponse1],
+            error_mapper=get_classification_job_status_error_mapper,
+            request_options=request_options,
+        )