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

Class ArtifactRef

java.lang.Object

ai.docling.serve.api.convert.response.ArtifactRef

public class ArtifactRef
extends Object

Represents a reference to a single output artifact returned as a presigned URL.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NonNull ArtifactRef.Builder	builder()
@NonNull ArtifactType	getArtifactType()	Export format of the artifact.
@NonNull String	getMimeType()	MIME type of the artifact content.
@NonNull URI	getUri()	Presigned URL used to download the artifact.
@Nullable Instant	getUrlExpiresAt()	Instant at which the presigned URL signature stops being valid.
@NonNull ArtifactRef.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 ArtifactRef.Builder builder()

toBuilder

public @NonNull ArtifactRef.Builder toBuilder()

getArtifactType

@NonNull
public @NonNull ArtifactType getArtifactType()

Export format of the artifact.

Returns:

the artifact type

getMimeType

@NonNull
public @NonNull String getMimeType()

MIME type of the artifact content.

Returns:

the MIME type

getUri

@NonNull
public @NonNull URI getUri()

Presigned URL used to download the artifact.

Returns:

the presigned URL

getUrlExpiresAt

public @Nullable Instant getUrlExpiresAt()

Instant at which the presigned URL signature stops being valid.

Returns:

the expiry timestamp

toString

public @NonNull String toString()

Overrides:

toString in class Object