Package ai.extend.types
Class ClassifyRunSummary
- java.lang.Object
-
- ai.extend.types.ClassifyRunSummary
-
public final class ClassifyRunSummary extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceClassifyRunSummary._FinalStagestatic classClassifyRunSummary.Builderstatic interfaceClassifyRunSummary.CreatedAtStagestatic interfaceClassifyRunSummary.DashboardUrlStagestatic interfaceClassifyRunSummary.EditedStagestatic interfaceClassifyRunSummary.FileStagestatic interfaceClassifyRunSummary.IdStagestatic interfaceClassifyRunSummary.ReviewedStagestatic interfaceClassifyRunSummary.StatusStagestatic interfaceClassifyRunSummary.UpdatedAtStage
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ClassifyRunSummary.IdStagebuilder()booleanequals(java.lang.Object other)java.util.Map<java.lang.String,java.lang.Object>getAdditionalProperties()java.util.Optional<ClassifierSummary>getClassifier()java.util.Optional<ClassifierVersionSummary>getClassifierVersion()java.time.OffsetDateTimegetCreatedAt()java.lang.StringgetDashboardUrl()booleangetEdited()java.util.Optional<java.lang.String>getFailureMessage()java.util.Optional<java.lang.String>getFailureReason()FileSummarygetFile()java.lang.StringgetId()java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>getMetadata()java.lang.StringgetObject()java.util.Optional<java.lang.String>getParseRunId()booleangetReviewed()ProcessorRunStatusgetStatus()java.time.OffsetDateTimegetUpdatedAt()java.util.Optional<RunUsageSummary>getUsage()inthashCode()java.lang.StringtoString()
-
-
-
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.
-
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.
-
getStatus
public ProcessorRunStatus getStatus()
-
getFailureReason
public java.util.Optional<java.lang.String> getFailureReason()
- Returns:
- The reason for failure.
Availability: Present when
statusis"FAILED".
-
getFailureMessage
public java.util.Optional<java.lang.String> getFailureMessage()
- Returns:
- A detailed message about the failure.
Availability: Present when
statusis"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.
-
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<RunUsageSummary> getUsage()
- Returns:
- Usage credits consumed by this classify run. Omits
breakdown— fetch the full classify run by id to see the per-line items.Availability: Present when
statusis"PROCESSED". Will not be returned for runs created before October 7, 2025 or for 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:
equalsin classjava.lang.Object
-
getAdditionalProperties
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
builder
public static ClassifyRunSummary.IdStage builder()
-
-