Package ai.extend.resources.extractruns

Class ExtractRunsClient

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

    • Constructor Detail

      • ExtractRunsClient

        public ExtractRunsClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

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

      • list

        public ExtractRunsListResponse list()
        List all extract runs.

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

      • list

        public ExtractRunsListResponse list​(RequestOptions requestOptions)
        List all extract runs.

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

      • create

        public ExtractRun create​(ExtractRunsCreateRequest request)
        Extract structured data from a file using an existing extractor or an inline configuration.

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

      • create

        public ExtractRun create​(ExtractRunsCreateRequest request,
                         RequestOptions requestOptions)
        Extract structured data from a file using an existing extractor or an inline configuration.

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

      • retrieve

        public ExtractRun retrieve​(java.lang.String id)
        Retrieve details about a specific extract 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 extract run when using the Create Extract Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • retrieve

        public ExtractRun retrieve​(java.lang.String id,
                           RequestOptions requestOptions)
        Retrieve details about a specific extract 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 extract run when using the Create Extract Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

      • delete

        public ExtractRunsDeleteResponse delete​(java.lang.String id)
        Delete an extract 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 ExtractRunsDeleteResponse delete​(java.lang.String id,
                                        RequestOptions requestOptions)
        Delete an extract 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 ExtractRun cancel​(java.lang.String id)
        Cancel an in-progress extract run.

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

      • cancel

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

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