Package ai.docling.serve.api.convert.response

Class DocumentArtifactItem.Builder

java.lang.Object

ai.docling.serve.api.convert.response.DocumentArtifactItem.Builder

Enclosing class:

DocumentArtifactItem

public static class DocumentArtifactItem.Builder
extends Object

Builder for creating DocumentArtifactItem instances. Generated by Lombok's @Builder annotation.

Builder methods:

• sourceIndex(Integer) - Set the source index
• sourceUri(String) - Set the source URI
• filename(String) - Set the source filename
• status(ConversionStatus) - Set the conversion status
• errors(List<ErrorItem>) - Set the list of errors
• error(ErrorItem) - Add a single error (use with @Singular)
• timings(Map<String, ProfilingItem>) - Set the timings map
• timing(String, ProfilingItem) - Add a single timing entry (use with @Singular)
• artifacts(List<ArtifactRef>) - Set the list of artifact references
• artifact(ArtifactRef) - Add a single artifact reference (use with @Singular)

Method Summary

Modifier and Type	Method	Description
@NonNull DocumentArtifactItem.Builder	artifact(ArtifactRef artifact)
@NonNull DocumentArtifactItem.Builder	artifacts(@NonNull Collection<? extends ArtifactRef> artifacts)
@NonNull DocumentArtifactItem	build()
@NonNull DocumentArtifactItem.Builder	clearArtifacts()
@NonNull DocumentArtifactItem.Builder	clearErrors()
@NonNull DocumentArtifactItem.Builder	clearTimings()
@NonNull DocumentArtifactItem.Builder	error(ErrorItem error)
@NonNull DocumentArtifactItem.Builder	errors(@NonNull Collection<? extends ErrorItem> errors)
@NonNull DocumentArtifactItem.Builder	filename(@NonNull String filename)	Filename used as the stem of each output artifact.
@NonNull DocumentArtifactItem.Builder	sourceIndex(Integer sourceIndex)	Zero-based index of the source document within the originating task.
@NonNull DocumentArtifactItem.Builder	sourceUri(@NonNull String sourceUri)	Canonical identifier of the source document.
@NonNull DocumentArtifactItem.Builder	status(@NonNull ConversionStatus status)	Terminal conversion outcome for this document.
@NonNull DocumentArtifactItem.Builder	timing(String timingKey, ProfilingItem timingValue)
@NonNull DocumentArtifactItem.Builder	timings(@NonNull Map<? extends String,? extends ProfilingItem> timings)
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

sourceIndex

public @NonNull DocumentArtifactItem.Builder sourceIndex(Integer sourceIndex)

Zero-based index of the source document within the originating task.

Parameters:

sourceIndex - the source index

Returns:

this.

sourceUri

public @NonNull DocumentArtifactItem.Builder sourceUri(@NonNull
 @NonNull String sourceUri)

Canonical identifier of the source document.

Parameters:

sourceUri - the source URI

Returns:

this.

filename

public @NonNull DocumentArtifactItem.Builder filename(@NonNull
 @NonNull String filename)

Filename used as the stem of each output artifact.

Parameters:

filename - the source filename

Returns:

this.

status

public @NonNull DocumentArtifactItem.Builder status(@NonNull
 @NonNull ConversionStatus status)

Terminal conversion outcome for this document.

Parameters:

status - the conversion status

Returns:

this.

error

public @NonNull DocumentArtifactItem.Builder error(ErrorItem error)

errors

public @NonNull DocumentArtifactItem.Builder errors(@NonNull Collection<? extends ErrorItem> errors)

clearErrors

public @NonNull DocumentArtifactItem.Builder clearErrors()

timing

public @NonNull DocumentArtifactItem.Builder timing(String timingKey,
 ProfilingItem timingValue)

timings

public @NonNull DocumentArtifactItem.Builder timings(@NonNull Map<? extends String,? extends ProfilingItem> timings)

clearTimings

public @NonNull DocumentArtifactItem.Builder clearTimings()

artifact

public @NonNull DocumentArtifactItem.Builder artifact(ArtifactRef artifact)

artifacts

public @NonNull DocumentArtifactItem.Builder artifacts(@NonNull Collection<? extends ArtifactRef> artifacts)

clearArtifacts

public @NonNull DocumentArtifactItem.Builder clearArtifacts()

build

public @NonNull DocumentArtifactItem build()

toString

public @NonNull String toString()

Overrides:

toString in class Object