Package ai.extend

Class ExtendClientBase

  • Direct Known Subclasses:
    ExtendClient
    public class ExtendClientBase
extends java.lang.Object

    • Field Detail

      • filesClient

        protected final java.util.function.Supplier<FilesClient> filesClient

      • parseRunsClient

        protected final java.util.function.Supplier<ParseRunsClient> parseRunsClient

      • editRunsClient

        protected final java.util.function.Supplier<EditRunsClient> editRunsClient

      • editTemplatesClient

        protected final java.util.function.Supplier<EditTemplatesClient> editTemplatesClient

      • editSchemasClient

        protected final java.util.function.Supplier<EditSchemasClient> editSchemasClient

      • extractRunsClient

        protected final java.util.function.Supplier<ExtractRunsClient> extractRunsClient

      • extractorsClient

        protected final java.util.function.Supplier<ExtractorsClient> extractorsClient

      • extractorVersionsClient

        protected final java.util.function.Supplier<ExtractorVersionsClient> extractorVersionsClient

      • classifyRunsClient

        protected final java.util.function.Supplier<ClassifyRunsClient> classifyRunsClient

      • classifiersClient

        protected final java.util.function.Supplier<ClassifiersClient> classifiersClient

      • classifierVersionsClient

        protected final java.util.function.Supplier<ClassifierVersionsClient> classifierVersionsClient

      • splitRunsClient

        protected final java.util.function.Supplier<SplitRunsClient> splitRunsClient

      • splittersClient

        protected final java.util.function.Supplier<SplittersClient> splittersClient

      • splitterVersionsClient

        protected final java.util.function.Supplier<SplitterVersionsClient> splitterVersionsClient

      • workflowsClient

        protected final java.util.function.Supplier<WorkflowsClient> workflowsClient

      • workflowVersionsClient

        protected final java.util.function.Supplier<WorkflowVersionsClient> workflowVersionsClient

      • workflowRunsClient

        protected final java.util.function.Supplier<WorkflowRunsClient> workflowRunsClient

      • processorRunClient

        protected final java.util.function.Supplier<ProcessorRunClient> processorRunClient

      • processorClient

        protected final java.util.function.Supplier<ProcessorClient> processorClient

      • processorVersionClient

        protected final java.util.function.Supplier<ProcessorVersionClient> processorVersionClient

      • batchProcessorRunClient

        protected final java.util.function.Supplier<BatchProcessorRunClient> batchProcessorRunClient

      • batchRunsClient

        protected final java.util.function.Supplier<BatchRunsClient> batchRunsClient

      • evaluationSetsClient

        protected final java.util.function.Supplier<EvaluationSetsClient> evaluationSetsClient

      • evaluationSetItemsClient

        protected final java.util.function.Supplier<EvaluationSetItemsClient> evaluationSetItemsClient

      • evaluationSetRunsClient

        protected final java.util.function.Supplier<EvaluationSetRunsClient> evaluationSetRunsClient

      • webhookEndpointsClient

        protected final java.util.function.Supplier<WebhookEndpointsClient> webhookEndpointsClient

    • Constructor Detail

      • ExtendClientBase

        public ExtendClientBase​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

        public RawExtendClientBase withRawResponse()
        Get responses with HTTP metadata like headers

      • parse

        public 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 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 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.

      • edit

        public 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.

      • extract

        public 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 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 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 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 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 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 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 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.