Package ai.extend.types

Class ParserRun.Builder

java.lang.Object

ai.extend.types.ParserRun.Builder

All Implemented Interfaces:

ParserRun._FinalStage, ParserRun.ConfigStage, ParserRun.FileIdStage, ParserRun.IdStage, ParserRun.MetricsStage, ParserRun.StatusStage

Enclosing class:

ParserRun

public static final class ParserRun.Builder
extends java.lang.Object
implements ParserRun.IdStage, ParserRun.FileIdStage, ParserRun.StatusStage, ParserRun.MetricsStage, ParserRun.ConfigStage, ParserRun._FinalStage

Method Summary

Modifier and Type	Method	Description
ParserRun._FinalStage	addAllChunks(java.util.List<Chunk> chunks)	An array of chunks that were parsed from the file.
ParserRun._FinalStage	addChunks(Chunk chunks)	An array of chunks that were parsed from the file.
ParserRun	build()
ParserRun._FinalStage	chunks(java.util.List<Chunk> chunks)	An array of chunks that were parsed from the file.
ParserRun._FinalStage	config(ParseConfig config)	The configuration used for the parsing process, including any default values that were applied.
ParserRun._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure if status is "FAILED".
ParserRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure if status is "FAILED".
ParserRun.StatusStage	fileId(java.lang.String fileId)	The identifier of the file that was parsed.
ParserRun.Builder	from(ParserRun other)
ParserRun.FileIdStage	id(java.lang.String id)	A unique identifier for the parser run.
ParserRun.ConfigStage	metrics(ParserRunMetrics metrics)	Metrics about the parsing process.
ParserRun._FinalStage	ocr(ParserRunOcr ocr)	Raw OCR data from the parsing process.
ParserRun._FinalStage	ocr(java.util.Optional<ParserRunOcr> ocr)	Raw OCR data from the parsing process.
ParserRun.MetricsStage	status(ParserRunStatusEnum status)	The status of the parser run:
ParserRun._FinalStage	usage(ParserRunCredits usage)
ParserRun._FinalStage	usage(java.util.Optional<ParserRunCredits> usage)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public ParserRun.Builder from(ParserRun other)

Specified by:

from in interface ParserRun.IdStage

id

public ParserRun.FileIdStage id(@NotNull
                                java.lang.String id)

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

Example: "parser_run_xK9mLPqRtN3vS8wF5hB2cQ"

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

Example: "parser_run_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface ParserRun.IdStage

Returns:

Reference to this so that method calls can be chained together.

fileId

public ParserRun.StatusStage fileId(@NotNull
                                    java.lang.String fileId)

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

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

Specified by:

fileId in interface ParserRun.FileIdStage

Returns:

Reference to this so that method calls can be chained together.

status

public ParserRun.MetricsStage status(@NotNull
                                     ParserRunStatusEnum status)

The status of the parser run:

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

The status of the parser run:

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

Specified by:

status in interface ParserRun.StatusStage

Returns:

Reference to this so that method calls can be chained together.

metrics

public ParserRun.ConfigStage metrics(@NotNull
                                     ParserRunMetrics metrics)

Metrics about the parsing process.

Metrics about the parsing process.

Specified by:

metrics in interface ParserRun.MetricsStage

Returns:

Reference to this so that method calls can be chained together.

config

public ParserRun._FinalStage config(@NotNull
                                    ParseConfig config)

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

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

Specified by:

config in interface ParserRun.ConfigStage

Returns:

Reference to this so that method calls can be chained together.

usage

public ParserRun._FinalStage usage(ParserRunCredits usage)

Specified by:

usage in interface ParserRun._FinalStage

usage

public ParserRun._FinalStage usage(java.util.Optional<ParserRunCredits> usage)

Specified by:

usage in interface ParserRun._FinalStage

failureReason

public ParserRun._FinalStage failureReason(java.lang.String failureReason)

The reason for failure if status is "FAILED".

Specified by:

failureReason in interface ParserRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureReason

public ParserRun._FinalStage failureReason(java.util.Optional<java.lang.String> failureReason)

The reason for failure if status is "FAILED".

Specified by:

failureReason in interface ParserRun._FinalStage

ocr

public ParserRun._FinalStage ocr(ParserRunOcr ocr)

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

Specified by:

ocr in interface ParserRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

ocr

public ParserRun._FinalStage ocr(java.util.Optional<ParserRunOcr> ocr)

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

Specified by:

ocr in interface ParserRun._FinalStage

addAllChunks

public ParserRun._FinalStage addAllChunks(java.util.List<Chunk> chunks)

An array of chunks that were parsed from the file.

Specified by:

addAllChunks in interface ParserRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

addChunks

public ParserRun._FinalStage addChunks(Chunk chunks)

An array of chunks that were parsed from the file.

Specified by:

addChunks in interface ParserRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

chunks

public ParserRun._FinalStage chunks(java.util.List<Chunk> chunks)

An array of chunks that were parsed from the file.

Specified by:

chunks in interface ParserRun._FinalStage

build

public ParserRun build()

Specified by:

build in interface ParserRun._FinalStage