Package ai.extend.resources.processorrun

Class AsyncRawProcessorRunClient

  • public class AsyncRawProcessorRunClient
extends java.lang.Object

    • Constructor Detail

      • AsyncRawProcessorRunClient

        public AsyncRawProcessorRunClient​(ClientOptions clientOptions)

    • Method Detail

      • create

        public java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunCreateResponse>> create​(ProcessorRunCreateRequest request)
        Run processors (extraction, classification, splitting, etc.) on a given document.

        Synchronous vs Asynchronous Processing:

        • Asynchronous (default): Returns immediately with PROCESSING status. Use webhooks or polling to get results.
        • Synchronous: Set sync: true to wait for completion and get final results in the response (5-minute timeout).

        For asynchronous processing:

      • create

        public java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunCreateResponse>> create​(ProcessorRunCreateRequest request,
                                                                                                           RequestOptions requestOptions)
        Run processors (extraction, classification, splitting, etc.) on a given document.

        Synchronous vs Asynchronous Processing:

        • Asynchronous (default): Returns immediately with PROCESSING status. Use webhooks or polling to get results.
        • Synchronous: Set sync: true to wait for completion and get final results in the response (5-minute timeout).

        For asynchronous processing:

      • get

        public java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunGetResponse>> get​(java.lang.String id)
        Retrieve details about a specific processor 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 async processor run when using the Run Processor endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • get

        public java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunGetResponse>> get​(java.lang.String id,
                                                                                                     RequestOptions requestOptions)
        Retrieve details about a specific processor 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 async processor run when using the Run Processor endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • delete

        public java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunDeleteResponse>> delete​(java.lang.String id)
        Delete a processor 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 java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunDeleteResponse>> delete​(java.lang.String id,
                                                                                                           RequestOptions requestOptions)
        Delete a processor 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 java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunCancelResponse>> cancel​(java.lang.String id)
        Cancel a running processor run by its ID. This endpoint allows you to stop a processor run that is currently in progress.

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

      • cancel

        public java.util.concurrent.CompletableFuture<ExtendClientHttpResponse<ProcessorRunCancelResponse>> cancel​(java.lang.String id,
                                                                                                           RequestOptions requestOptions)
        Cancel a running processor run by its ID. This endpoint allows you to stop a processor run that is currently in progress.

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