Package ai.extend.resources.splitruns

Class AsyncSplitRunsClient

  • public class AsyncSplitRunsClient
extends java.lang.Object

    • Constructor Detail

      • AsyncSplitRunsClient

        public AsyncSplitRunsClient​(ClientOptions clientOptions)

    • Method Detail

      • list

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

      • list

        public java.util.concurrent.CompletableFuture<SplitRunsListResponse> list​(SplitRunsListRequest request,
                                                                          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.

      • create

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

      • delete

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

      • cancel

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