Package ai.extend

Class AsyncRawExtendClientBase

  • Direct Known Subclasses:
    AsyncRawExtendClient
    public class AsyncRawExtendClientBase
extends java.lang.Object

    • Constructor Detail

      • AsyncRawExtendClientBase

        public AsyncRawExtendClientBase​(ClientOptions clientOptions)

    • Method Detail

      • parse

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ParseRun>> parse​(ParseRequest request)
        Parse a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /parse_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Parse endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.

        For more details, see the Parse File guide.

      • parse

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ParseRun>> parse​(ParseRequest request,
                                                                                            RequestOptions requestOptions)
        Parse a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /parse_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Parse endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.

        For more details, see the Parse File guide.

      • edit

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<EditRun>> edit​(EditRequest request)
        Edit a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /edit_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Edit endpoint allows you to detect and fill form fields in PDF documents.

        For more details, see the Edit File guide. See Editing Error Handling for HTTP errors and run failure reasons.

      • edit

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<EditRun>> edit​(EditRequest request,
                                                                                          RequestOptions requestOptions)
        Edit a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /edit_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Edit endpoint allows you to detect and fill form fields in PDF documents.

        For more details, see the Edit File guide. See Editing Error Handling for HTTP errors and run failure reasons.

      • detectForm

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<FormDetectionRun>> detectForm​(DetectFormRequest request)
        Detect fields in a PDF form and wait for the generated edit schema before returning. This endpoint has a 5-minute timeout.

        For production workloads, use POST /form_detection_runs and poll GET /form_detection_runs/{id} instead. The response is a completed form_detection_run; its output.schema can be passed directly to POST /edit or POST /edit_runs.

      • detectForm

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<FormDetectionRun>> detectForm​(DetectFormRequest request,
                                                                                                         RequestOptions requestOptions)
        Detect fields in a PDF form and wait for the generated edit schema before returning. This endpoint has a 5-minute timeout.

        For production workloads, use POST /form_detection_runs and poll GET /form_detection_runs/{id} instead. The response is a completed form_detection_run; its output.schema can be passed directly to POST /edit or POST /edit_runs.

      • extract

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ExtractRun>> extract()
        Extract structured data from a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /extract_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Extract endpoint allows you to extract structured data from files using an existing extractor, an inline configuration, or no configuration at all. When neither is provided, Extend automatically infers a schema from the document before extraction — no extractor or schema is required.

        Pass file for a single document, or package to extract from multiple files in a single run. Exactly one of file or package must be provided.

        For more details, see the Extract File guide.

      • extract

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ExtractRun>> extract​(RequestOptions requestOptions)
        Extract structured data from a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /extract_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Extract endpoint allows you to extract structured data from files using an existing extractor, an inline configuration, or no configuration at all. When neither is provided, Extend automatically infers a schema from the document before extraction — no extractor or schema is required.

        Pass file for a single document, or package to extract from multiple files in a single run. Exactly one of file or package must be provided.

        For more details, see the Extract File guide.

      • extract

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ExtractRun>> extract​(ExtractRequest request)
        Extract structured data from a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /extract_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Extract endpoint allows you to extract structured data from files using an existing extractor, an inline configuration, or no configuration at all. When neither is provided, Extend automatically infers a schema from the document before extraction — no extractor or schema is required.

        Pass file for a single document, or package to extract from multiple files in a single run. Exactly one of file or package must be provided.

        For more details, see the Extract File guide.

      • extract

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ExtractRun>> extract​(ExtractRequest request,
                                                                                                RequestOptions requestOptions)
        Extract structured data from a file synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /extract_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Extract endpoint allows you to extract structured data from files using an existing extractor, an inline configuration, or no configuration at all. When neither is provided, Extend automatically infers a schema from the document before extraction — no extractor or schema is required.

        Pass file for a single document, or package to extract from multiple files in a single run. Exactly one of file or package must be provided.

        For more details, see the Extract File guide.

      • classify

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ClassifyRun>> classify​(ClassifyRequest request)
        Classify a document synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /classify_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Classify endpoint allows you to classify documents using an existing classifier or an inline configuration.

        For more details, see the Classify File guide.

      • classify

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<ClassifyRun>> classify​(ClassifyRequest request,
                                                                                                  RequestOptions requestOptions)
        Classify a document synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /classify_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Classify endpoint allows you to classify documents using an existing classifier or an inline configuration.

        For more details, see the Classify File guide.

      • split

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<SplitRun>> split​(SplitRequest request)
        Split a document synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /split_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Split endpoint allows you to split documents into multiple parts using an existing splitter or an inline configuration.

        For more details, see the Split File guide.

      • split

        public java.util.concurrent.CompletableFuture<ExtendClientBaseHttpResponse<SplitRun>> split​(SplitRequest request,
                                                                                            RequestOptions requestOptions)
        Split a document synchronously, waiting for the result before returning. This endpoint has a 5-minute timeout — if processing takes longer, the request will fail.

        Note: This endpoint is intended for onboarding and testing only. For production workloads, use POST /split_runs with polling or webhooks instead, as it provides better reliability for large files and avoids timeout issues.

        The Split endpoint allows you to split documents into multiple parts using an existing splitter or an inline configuration.

        For more details, see the Split File guide.