Package ai.extend.types

Class EditRun

java.lang.Object

ai.extend.types.EditRun

public final class EditRun
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EditRun._FinalStage
static class	EditRun.Builder
static interface	EditRun.ConfigStage
static interface	EditRun.FileIdStage
static interface	EditRun.IdStage
static interface	EditRun.MetricsStage
static interface	EditRun.StatusStage

Method Summary

Modifier and Type	Method	Description
static EditRun.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
EditRunConfig	getConfig()
java.util.Optional<EditRunEditedFile>	getEditedFile()
java.util.Optional<java.lang.String>	getFailureReason()
java.lang.String	getFileId()
java.lang.String	getId()
EditRunMetrics	getMetrics()
java.lang.String	getObject()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getOutput()
EditRunStatus	getStatus()
java.util.Optional<EditRunUsage>	getUsage()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getObject

public java.lang.String getObject()

Returns:

The type of object. Will always be "edit_run".

getId

public java.lang.String getId()

Returns:

A unique identifier for the edit run. Will always start with "edit_run_"

Example: "edit_run_xK9mLPqRtN3vS8wF5hB2cQ"

getFileId

public java.lang.String getFileId()

Returns:

The identifier of the input file that was edited.

getEditedFile

public java.util.Optional<EditRunEditedFile> getEditedFile()

Returns:

Information about the edited output file. Only present when status is "PROCESSED".

getStatus

public EditRunStatus getStatus()

getFailureReason

public java.util.Optional<java.lang.String> getFailureReason()

Returns:

The reason for failure if status is "FAILED".

getConfig

public EditRunConfig getConfig()

Returns:

The configuration used for this edit run.

getOutput

public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getOutput()

Returns:

The extracted/detected field values from the edited document.

getMetrics

public EditRunMetrics getMetrics()

Returns:

Metrics about the editing process.

getUsage

public java.util.Optional<EditRunUsage> getUsage()

Returns:

Usage credits consumed by this edit run.

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

builder

public static EditRun.IdStage builder()