Package ai.extend.resources.extractruns

Class ExtractRunsClient

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

    • Constructor Detail

      • ExtractRunsClient

        public ExtractRunsClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

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

      • list

        public ExtractRunsListResponse list()
        List all extract runs.

        Returns a summary of each run. Use GET /extract_runs/{id} to retrieve the full object including output and config.

      • list

        public ExtractRunsListResponse list​(RequestOptions requestOptions)
        List all extract runs.

        Returns a summary of each run. Use GET /extract_runs/{id} to retrieve the full object including output and config.

      • create

        public ExtractRun create​(ExtractRunsCreateRequest request)
        Extract structured data from a file using an existing extractor or an inline configuration.

        The request returns immediately with a PROCESSING status. Use webhooks or poll the Get Extract Run endpoint for results.

      • create

        public ExtractRun create​(ExtractRunsCreateRequest request,
                         RequestOptions requestOptions)
        Extract structured data from a file using an existing extractor or an inline configuration.

        The request returns immediately with a PROCESSING status. Use webhooks or poll the Get Extract Run endpoint for results.

      • retrieve

        public ExtractRun retrieve​(java.lang.String id)
        Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.

        A common use case for this endpoint is to poll for the status and final output of an extract run when using the Create Extract Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • retrieve

        public ExtractRun retrieve​(java.lang.String id,
                           RequestOptions requestOptions)
        Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.

        A common use case for this endpoint is to poll for the status and final output of an extract run when using the Create Extract Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • retrieve

        public ExtractRun retrieve​(java.lang.String id,
                           ExtractRunsRetrieveRequest request)
        Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.

        A common use case for this endpoint is to poll for the status and final output of an extract run when using the Create Extract Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • retrieve

        public ExtractRun retrieve​(java.lang.String id,
                           ExtractRunsRetrieveRequest request,
                           RequestOptions requestOptions)
        Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.

        A common use case for this endpoint is to poll for the status and final output of an extract run when using the Create Extract Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • delete

        public ExtractRunsDeleteResponse delete​(java.lang.String id)
        Delete an extract run and all associated data from Extend. This operation is permanent and cannot be undone.

        This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.

      • delete

        public ExtractRunsDeleteResponse delete​(java.lang.String id,
                                        RequestOptions requestOptions)
        Delete an extract run and all associated data from Extend. This operation is permanent and cannot be undone.

        This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.

      • delete

        public ExtractRunsDeleteResponse delete​(java.lang.String id,
                                        ExtractRunsDeleteRequest request)
        Delete an extract run and all associated data from Extend. This operation is permanent and cannot be undone.

        This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.

      • delete

        public ExtractRunsDeleteResponse delete​(java.lang.String id,
                                        ExtractRunsDeleteRequest request,
                                        RequestOptions requestOptions)
        Delete an extract run and all associated data from Extend. This operation is permanent and cannot be undone.

        This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.

      • cancel

        public ExtractRun cancel​(java.lang.String id)
        Cancel an in-progress extract run.

        Note: Only extract runs with a status of "PROCESSING" can be cancelled. Extractor runs that have already completed, failed, or been cancelled cannot be cancelled again.

      • cancel

        public ExtractRun cancel​(java.lang.String id,
                         RequestOptions requestOptions)
        Cancel an in-progress extract run.

        Note: Only extract runs with a status of "PROCESSING" can be cancelled. Extractor runs that have already completed, failed, or been cancelled cannot be cancelled again.

      • cancel

        public ExtractRun cancel​(java.lang.String id,
                         ExtractRunsCancelRequest request)
        Cancel an in-progress extract run.

        Note: Only extract runs with a status of "PROCESSING" can be cancelled. Extractor runs that have already completed, failed, or been cancelled cannot be cancelled again.

      • cancel

        public ExtractRun cancel​(java.lang.String id,
                         ExtractRunsCancelRequest request,
                         RequestOptions requestOptions)
        Cancel an in-progress extract run.

        Note: Only extract runs with a status of "PROCESSING" can be cancelled. Extractor runs that have already completed, failed, or been cancelled cannot be cancelled again.

      • createBatch

        public BatchRun createBatch​(ExtractRunsCreateBatchRequest request)
        Submit up to 1,000 files for extraction in a single request. Each file is processed as an independent extract run using the same extractor and configuration.

        Unlike the single Extract File (Async) endpoint, this batch endpoint accepts an inputs array and immediately returns a BatchRun object containing a batch id and a PENDING status. The individual runs are then queued and processed asynchronously.

        Monitoring results:

        • Webhooks (recommended): Subscribe to batch_processor_run.processed and batch_processor_run.failed events. The webhook payload indicates the batch has finished — fetch individual run results using GET /extract_runs?batchId={id}.
        • Polling: Call GET /batch_runs/{id} to check the overall batch status, and use GET /extract_runs filtered by batchId to retrieve individual run results.

        Notes:

        • A processor reference (extractor.id) is required — inline config is not supported for batch requests.
        • inputs must contain between 1 and 1,000 items.
        • All inputs in a batch use the same extractor version and override config.

      • createBatch

        public BatchRun createBatch​(ExtractRunsCreateBatchRequest request,
                            RequestOptions requestOptions)
        Submit up to 1,000 files for extraction in a single request. Each file is processed as an independent extract run using the same extractor and configuration.

        Unlike the single Extract File (Async) endpoint, this batch endpoint accepts an inputs array and immediately returns a BatchRun object containing a batch id and a PENDING status. The individual runs are then queued and processed asynchronously.

        Monitoring results:

        • Webhooks (recommended): Subscribe to batch_processor_run.processed and batch_processor_run.failed events. The webhook payload indicates the batch has finished — fetch individual run results using GET /extract_runs?batchId={id}.
        • Polling: Call GET /batch_runs/{id} to check the overall batch status, and use GET /extract_runs filtered by batchId to retrieve individual run results.

        Notes:

        • A processor reference (extractor.id) is required — inline config is not supported for batch requests.
        • inputs must contain between 1 and 1,000 items.
        • All inputs in a batch use the same extractor version and override config.