Package ai.extend.resources.parseruns

Class AsyncParseRunsClient

  • public class AsyncParseRunsClient
extends java.lang.Object

    • Constructor Detail

      • AsyncParseRunsClient

        public AsyncParseRunsClient​(ClientOptions clientOptions)

    • Method Detail

      • list

        public java.util.concurrent.CompletableFuture<ParseRunsListResponse> list()
        List parse runs, with optional filters for status, batch ID, source, and file name.

        Returns a paginated list of parse runs. Use GET /parse_runs/{id} to retrieve the full result including output for a specific run.

      • list

        public java.util.concurrent.CompletableFuture<ParseRunsListResponse> list​(RequestOptions requestOptions)
        List parse runs, with optional filters for status, batch ID, source, and file name.

        Returns a paginated list of parse runs. Use GET /parse_runs/{id} to retrieve the full result including output for a specific run.

      • list

        public java.util.concurrent.CompletableFuture<ParseRunsListResponse> list​(ParseRunsListRequest request)
        List parse runs, with optional filters for status, batch ID, source, and file name.

        Returns a paginated list of parse runs. Use GET /parse_runs/{id} to retrieve the full result including output for a specific run.

      • list

        public java.util.concurrent.CompletableFuture<ParseRunsListResponse> list​(ParseRunsListRequest request,
                                                                          RequestOptions requestOptions)
        List parse runs, with optional filters for status, batch ID, source, and file name.

        Returns a paginated list of parse runs. Use GET /parse_runs/{id} to retrieve the full result including output for a specific run.

      • create

        public java.util.concurrent.CompletableFuture<ParseRun> create​(ParseRunsCreateRequest request)
        Parse files to get cleaned, chunked target content (e.g. markdown).

        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.

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

      • create

        public java.util.concurrent.CompletableFuture<ParseRun> create​(ParseRunsCreateRequest request,
                                                               RequestOptions requestOptions)
        Parse files to get cleaned, chunked target content (e.g. markdown).

        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.

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

      • retrieve

        public java.util.concurrent.CompletableFuture<ParseRun> retrieve​(java.lang.String id)
        Retrieve the status and results of a parse run.

        Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

      • retrieve

        public java.util.concurrent.CompletableFuture<ParseRun> retrieve​(java.lang.String id,
                                                                 RequestOptions requestOptions)
        Retrieve the status and results of a parse run.

        Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

      • retrieve

        public java.util.concurrent.CompletableFuture<ParseRun> retrieve​(java.lang.String id,
                                                                 ParseRunsRetrieveRequest request)
        Retrieve the status and results of a parse run.

        Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

      • retrieve

        public java.util.concurrent.CompletableFuture<ParseRun> retrieve​(java.lang.String id,
                                                                 ParseRunsRetrieveRequest request,
                                                                 RequestOptions requestOptions)
        Retrieve the status and results of a parse run.

        Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

      • delete

        public java.util.concurrent.CompletableFuture<ParseRunsDeleteResponse> delete​(java.lang.String id)
        Delete a parse 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<ParseRunsDeleteResponse> delete​(java.lang.String id,
                                                                              RequestOptions requestOptions)
        Delete a parse 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<ParseRunsDeleteResponse> delete​(java.lang.String id,
                                                                              ParseRunsDeleteRequest request)
        Delete a parse 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<ParseRunsDeleteResponse> delete​(java.lang.String id,
                                                                              ParseRunsDeleteRequest request,
                                                                              RequestOptions requestOptions)
        Delete a parse 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.

      • createBatch

        public java.util.concurrent.CompletableFuture<BatchRun> createBatch​(ParseRunsCreateBatchRequest request)
        Submit up to 1,000 files for parsing in a single request. Each file is processed as an independent parse run using the same configuration.

        Unlike the single Parse 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_parse_run.processed and batch_parse_run.failed events. The webhook payload indicates the batch has finished — fetch individual run results using GET /parse_runs?batchId={id}.
        • Polling: Call GET /batch_runs/{id} to check the overall batch status, and use GET /parse_runs?batchId={id} to retrieve individual run results.

        Notes:

        • inputs must contain between 1 and 1,000 items.
        • File input supports URLs, Extend file IDs, and raw text strings.

      • createBatch

        public java.util.concurrent.CompletableFuture<BatchRun> createBatch​(ParseRunsCreateBatchRequest request,
                                                                    RequestOptions requestOptions)
        Submit up to 1,000 files for parsing in a single request. Each file is processed as an independent parse run using the same configuration.

        Unlike the single Parse 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_parse_run.processed and batch_parse_run.failed events. The webhook payload indicates the batch has finished — fetch individual run results using GET /parse_runs?batchId={id}.
        • Polling: Call GET /batch_runs/{id} to check the overall batch status, and use GET /parse_runs?batchId={id} to retrieve individual run results.

        Notes:

        • inputs must contain between 1 and 1,000 items.
        • File input supports URLs, Extend file IDs, and raw text strings.