Package ai.extend.types

Class ParserRun

java.lang.Object

ai.extend.types.ParserRun

public final class ParserRun
extends java.lang.Object

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ParserRun.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.List<Chunk>	getChunks()
ParseConfig	getConfig()
java.util.Optional<java.lang.String>	getFailureReason()
java.lang.String	getFileId()
java.lang.String	getId()
ParserRunMetrics	getMetrics()
java.lang.String	getObject()
java.util.Optional<ParserRunOcr>	getOcr()
ParserRunStatusEnum	getStatus()
java.util.Optional<ParserRunCredits>	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 "parser_run".

getId

public java.lang.String getId()

Returns:

A unique identifier for the parser run. Will always start with "parser_run_"

Example: "parser_run_xK9mLPqRtN3vS8wF5hB2cQ"

getFileId

public java.lang.String getFileId()

Returns:

The identifier of the file that was parsed. This can be used as a parameter to other Extend endpoints, such as processor runs.

getChunks

public java.util.List<Chunk> getChunks()

Returns:

An array of chunks that were parsed from the file.

getOcr

public java.util.Optional<ParserRunOcr> getOcr()

Returns:

Raw OCR data from the parsing process. Only included when returnOcr is configured in the parse config's advanced options.

getStatus

public ParserRunStatusEnum getStatus()

Returns:

The status of the parser run:

• "PROCESSED" - The file was successfully processed
• "FAILED" - The processing failed (see failureReason for details)

getFailureReason

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

Returns:

The reason for failure if status is "FAILED".

getMetrics

public ParserRunMetrics getMetrics()

Returns:

Metrics about the parsing process.

getConfig

public ParseConfig getConfig()

Returns:

The configuration used for the parsing process, including any default values that were applied.

getUsage

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

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 ParserRun.IdStage builder()