Package ai.extend.types

Class ClassifyRun

  • public final class ClassifyRun
extends java.lang.Object

    • Method Detail

      • getObject

        public java.lang.String getObject()
        Returns:
        The type of object. Will always be "classify_run".

      • getId

        public java.lang.String getId()
        Returns:
        The unique identifier for this classify run.

        Example: "clr_Xj8mK2pL9nR4vT7qY5wZ"

      • getClassifier

        public java.util.Optional<ClassifierSummary> getClassifier()
        Returns:
        The classifier that was used for this run.

        Availability: Present when a classifier reference was provided. Not present when using inline config.

      • getClassifierVersion

        public java.util.Optional<ClassifierVersionSummary> getClassifierVersion()
        Returns:
        The version of the classifier that was used for this run.

        Availability: Present when a classifier reference was provided. Not present when using inline config.

      • getOutput

        public java.util.Optional<ClassifyOutput> getOutput()
        Returns:
        The final output, either reviewed or initial.

        Availability: Present when status is "PROCESSED".

      • getInitialOutput

        public java.util.Optional<ClassifyOutput> getInitialOutput()
        Returns:
        The initial output from the classify run, before any review edits.

        Availability: Present when reviewed is true.

      • getReviewedOutput

        public java.util.Optional<ClassifyOutput> getReviewedOutput()
        Returns:
        The output after human review.

        Availability: Present when reviewed is true.

      • getFailureReason

        public java.util.Optional<java.lang.String> getFailureReason()
        Returns:
        The reason for failure.

        Availability: Present when status is "FAILED".

        Possible values include:

        • ABORTED - The run was aborted by the user
        • INTERNAL_ERROR - An unexpected internal error occurred
        • FAILED_TO_PROCESS_FILE - Failed to process the file (e.g., OCR failure, file access issues)
        • INVALID_PROCESSOR - The processor configuration is invalid
        • INVALID_CONFIGURATION - The provided configuration is incompatible with the selected model
        • PARSING_ERROR - Failed to parse the classification output
        • PRE_PROCESSING_FAILURE - An error occurred during preprocessing
        • POST_PROCESSING_FAILURE - An error occurred during postprocessing
        • OUT_OF_CREDITS - Insufficient credits to run the classification

        Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

      • getFailureMessage

        public java.util.Optional<java.lang.String> getFailureMessage()
        Returns:
        A detailed message about the failure.

        Availability: Present when status is "FAILED".

      • getMetadata

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> getMetadata()
        Returns:
        Any metadata that was provided when creating the classify run.

        Availability: Present when metadata was provided during creation.

      • getReviewed

        public boolean getReviewed()
        Returns:
        Indicates whether the run has been reviewed by a human.

      • getEdited

        public boolean getEdited()
        Returns:
        Indicates whether the run results have been edited during review.

      • getConfig

        public ClassifyConfig getConfig()
        Returns:
        The configuration used for this classify run.

      • getFile

        public FileSummary getFile()
        Returns:
        The file that was processed.

      • getParseRunId

        public java.util.Optional<java.lang.String> getParseRunId()
        Returns:
        The ID of the parse run that was used for this classify run.

        Availability: Present when a parse run was created.

      • getDashboardUrl

        public java.lang.String getDashboardUrl()
        Returns:
        The URL to view the classify run in the Extend dashboard.

      • getUsage

        public java.util.Optional<RunUsage> getUsage()
        Returns:
        Usage credits consumed by this run.

        Availability: This field will not be returned for:

        • Runs created before October 7, 2025
        • Customers on legacy billing systems

      • getCreatedAt

        public java.time.OffsetDateTime getCreatedAt()

      • getUpdatedAt

        public java.time.OffsetDateTime getUpdatedAt()

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object