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

Class DocumentArtifactItem

java.lang.Object

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

public class DocumentArtifactItem
extends Object

Represents the conversion outcome and artifact references for a single source document.

Serialization uses JsonInclude.Include.NON_EMPTY, so nulls and empty collections are omitted from JSON output.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentArtifactItem.Builder	Builder for creating DocumentArtifactItem instances.

Method Summary

Modifier and Type	Method	Description
static @NonNull DocumentArtifactItem.Builder	builder()
List<ArtifactRef>	getArtifacts()	Presigned URLs for each requested output format.
List<ErrorItem>	getErrors()	Errors encountered while converting this document.
@NonNull String	getFilename()	Filename used as the stem of each output artifact.
Integer	getSourceIndex()	Zero-based index of the source document within the originating task.
@NonNull String	getSourceUri()	Canonical identifier of the source document.
@NonNull ConversionStatus	getStatus()	Terminal conversion outcome for this document.
Map<String,ProfilingItem>	getTimings()	Per-stage timing breakdown keyed by stage name.
@NonNull DocumentArtifactItem.Builder	toBuilder()
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static @NonNull DocumentArtifactItem.Builder builder()

toBuilder

public @NonNull DocumentArtifactItem.Builder toBuilder()

getSourceIndex

public Integer getSourceIndex()

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

Returns:

the source index

getSourceUri

@NonNull
public @NonNull String getSourceUri()

Canonical identifier of the source document.

Returns:

the source URI

getFilename

@NonNull
public @NonNull String getFilename()

Filename used as the stem of each output artifact.

Returns:

the source filename

getStatus

@NonNull
public @NonNull ConversionStatus getStatus()

Terminal conversion outcome for this document.

Returns:

the conversion status

getErrors

public List<ErrorItem> getErrors()

Errors encountered while converting this document.

Returns:

the list of errors

getTimings

public Map<String,ProfilingItem> getTimings()

Per-stage timing breakdown keyed by stage name.

Returns:

the timings map

getArtifacts

public List<ArtifactRef> getArtifacts()

Presigned URLs for each requested output format.

Returns:

the list of artifact references

toString

public @NonNull String toString()

Overrides:

toString in class Object