Package ai.extend.resources.processorrun

Class AsyncProcessorRunClient

java.lang.Object

ai.extend.resources.processorrun.AsyncProcessorRunClient

public class AsyncProcessorRunClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncProcessorRunClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<ProcessorRunCancelResponse>	cancel(java.lang.String id)	Cancel a running processor run by its ID.
java.util.concurrent.CompletableFuture<ProcessorRunCancelResponse>	cancel(java.lang.String id, RequestOptions requestOptions)	Cancel a running processor run by its ID.
java.util.concurrent.CompletableFuture<ProcessorRunCreateResponse>	create(ProcessorRunCreateRequest request)	Run processors (extraction, classification, splitting, etc.) on a given document.
java.util.concurrent.CompletableFuture<ProcessorRunCreateResponse>	create(ProcessorRunCreateRequest request, RequestOptions requestOptions)	Run processors (extraction, classification, splitting, etc.) on a given document.
java.util.concurrent.CompletableFuture<ProcessorRunDeleteResponse>	delete(java.lang.String id)	Delete a processor run and all associated data from Extend.
java.util.concurrent.CompletableFuture<ProcessorRunDeleteResponse>	delete(java.lang.String id, RequestOptions requestOptions)	Delete a processor run and all associated data from Extend.
java.util.concurrent.CompletableFuture<ProcessorRunGetResponse>	get(java.lang.String id)	Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
java.util.concurrent.CompletableFuture<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.
java.util.concurrent.CompletableFuture<ProcessorRunListResponse>	list()	List runs of a Processor.
java.util.concurrent.CompletableFuture<ProcessorRunListResponse>	list(RequestOptions requestOptions)	List runs of a Processor.
java.util.concurrent.CompletableFuture<ProcessorRunListResponse>	list(ProcessorRunListRequest request)	List runs of a Processor.
java.util.concurrent.CompletableFuture<ProcessorRunListResponse>	list(ProcessorRunListRequest request, RequestOptions requestOptions)	List runs of a Processor.
AsyncRawProcessorRunClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

AsyncProcessorRunClient

public AsyncProcessorRunClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawProcessorRunClient withRawResponse()

Get responses with HTTP metadata like headers

list

public java.util.concurrent.CompletableFuture<ProcessorRunListResponse> list()

List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.

list

public java.util.concurrent.CompletableFuture<ProcessorRunListResponse> list(RequestOptions requestOptions)

List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.

list

public java.util.concurrent.CompletableFuture<ProcessorRunListResponse> list(ProcessorRunListRequest request)

List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.

list

public java.util.concurrent.CompletableFuture<ProcessorRunListResponse> list(ProcessorRunListRequest request,
                                                                             RequestOptions requestOptions)

List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.

create

public java.util.concurrent.CompletableFuture<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:

• You can configure webhooks to receive notifications when a processor run is complete or failed.
• Or you can poll the get endpoint for updates on the status of the processor run.

create

public java.util.concurrent.CompletableFuture<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:

• You can configure webhooks to receive notifications when a processor run is complete or failed.
• Or you can poll the get endpoint for updates on the status of the processor run.

get

public java.util.concurrent.CompletableFuture<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<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<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<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<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<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.