Package ai.extend.resources.classifyruns

Class ClassifyRunsClient

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

    • Constructor Detail

      • ClassifyRunsClient

        public ClassifyRunsClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

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

      • list

        public ClassifyRunsListResponse list()
        List all classify runs.

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

      • list

        public ClassifyRunsListResponse list​(RequestOptions requestOptions)
        List all classify runs.

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

      • create

        public ClassifyRun create​(ClassifyRunsCreateRequest request)
        Classify a document using an existing classifier or an inline configuration.

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

      • create

        public ClassifyRun create​(ClassifyRunsCreateRequest request,
                          RequestOptions requestOptions)
        Classify a document using an existing classifier or an inline configuration.

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

      • retrieve

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

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

      • retrieve

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

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

      • retrieve

        public ClassifyRun retrieve​(java.lang.String id,
                            ClassifyRunsRetrieveRequest request)
        Retrieve details about a specific classify run, including its status and outputs.

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

      • retrieve

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

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

      • delete

        public ClassifyRunsDeleteResponse delete​(java.lang.String id)
        Delete a classify 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 ClassifyRunsDeleteResponse delete​(java.lang.String id,
                                         RequestOptions requestOptions)
        Delete a classify 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 ClassifyRunsDeleteResponse delete​(java.lang.String id,
                                         ClassifyRunsDeleteRequest request)
        Delete a classify 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 ClassifyRunsDeleteResponse delete​(java.lang.String id,
                                         ClassifyRunsDeleteRequest request,
                                         RequestOptions requestOptions)
        Delete a classify 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 ClassifyRun cancel​(java.lang.String id)
        Cancel an in-progress classify run.

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

      • cancel

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

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

      • cancel

        public ClassifyRun cancel​(java.lang.String id,
                          ClassifyRunsCancelRequest request)
        Cancel an in-progress classify run.

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

      • cancel

        public ClassifyRun cancel​(java.lang.String id,
                          ClassifyRunsCancelRequest request,
                          RequestOptions requestOptions)
        Cancel an in-progress classify run.

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

      • createBatch

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

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

        Notes:

        • A processor reference (classifier.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 classifier version and override config.

      • createBatch

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

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

        Notes:

        • A processor reference (classifier.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 classifier version and override config.