Package ai.extend.resources.splitruns

Class SplitRunsClient

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

    • Constructor Detail

      • SplitRunsClient

        public SplitRunsClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

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

      • list

        public SplitRunsListResponse list()
        List all split runs.

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

      • list

        public SplitRunsListResponse list​(RequestOptions requestOptions)
        List all split runs.

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

      • list

        public SplitRunsListResponse list​(SplitRunsListRequest request)
        List all split runs.

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

      • create

        public SplitRun create​(SplitRunsCreateRequest request)
        Split a document into multiple parts using an existing splitter or an inline configuration.

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

      • create

        public SplitRun create​(SplitRunsCreateRequest request,
                       RequestOptions requestOptions)
        Split a document into multiple parts using an existing splitter or an inline configuration.

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

      • retrieve

        public SplitRun retrieve​(java.lang.String id)
        Retrieve details about a specific split run, including its status and outputs.

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

      • retrieve

        public SplitRun retrieve​(java.lang.String id,
                         RequestOptions requestOptions)
        Retrieve details about a specific split run, including its status and outputs.

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

      • retrieve

        public SplitRun retrieve​(java.lang.String id,
                         SplitRunsRetrieveRequest request)
        Retrieve details about a specific split run, including its status and outputs.

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

      • retrieve

        public SplitRun retrieve​(java.lang.String id,
                         SplitRunsRetrieveRequest request,
                         RequestOptions requestOptions)
        Retrieve details about a specific split run, including its status and outputs.

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

      • delete

        public SplitRunsDeleteResponse delete​(java.lang.String id)
        Delete a split 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 SplitRunsDeleteResponse delete​(java.lang.String id,
                                      RequestOptions requestOptions)
        Delete a split 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 SplitRunsDeleteResponse delete​(java.lang.String id,
                                      SplitRunsDeleteRequest request)
        Delete a split 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 SplitRunsDeleteResponse delete​(java.lang.String id,
                                      SplitRunsDeleteRequest request,
                                      RequestOptions requestOptions)
        Delete a split 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 SplitRun cancel​(java.lang.String id)
        Cancel an in-progress split run.

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

      • cancel

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

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

      • cancel

        public SplitRun cancel​(java.lang.String id,
                       SplitRunsCancelRequest request)
        Cancel an in-progress split run.

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

      • cancel

        public SplitRun cancel​(java.lang.String id,
                       SplitRunsCancelRequest request,
                       RequestOptions requestOptions)
        Cancel an in-progress split run.

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

      • createBatch

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

        Unlike the single Split 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 /split_runs?batchId={id}.
        • Polling: Call GET /batch_runs/{id} to check the overall batch status, and use GET /split_runs filtered by batchId to retrieve individual run results.

        Notes:

        • A processor reference (splitter.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 splitter version and override config.
        • Raw text input (FileFromText) is not supported for split runs. Use a URL or file ID.

      • createBatch

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

        Unlike the single Split 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 /split_runs?batchId={id}.
        • Polling: Call GET /batch_runs/{id} to check the overall batch status, and use GET /split_runs filtered by batchId to retrieve individual run results.

        Notes:

        • A processor reference (splitter.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 splitter version and override config.
        • Raw text input (FileFromText) is not supported for split runs. Use a URL or file ID.