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

Class PreSignedUrlConvertDocumentResponse

java.lang.Object

ai.docling.serve.api.convert.response.ConvertDocumentResponse

ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse

public final class PreSignedUrlConvertDocumentResponse
extends ConvertDocumentResponse

Response for document conversions with S3 or PUT target types.

This response type is returned when the conversion request specifies an S3 target or PUT target. The converted documents are stored in the specified location. The response includes processing statistics and conversion metrics.

This response type is returned in any one the following scenarios:

• Target type is PutTarget
• Target type is S3Target

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

See Also:

• ConvertDocumentResponse
• ResponseType.PRE_SIGNED_URL
• S3Target
• PutTarget

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NonNull PreSignedUrlConvertDocumentResponse.Builder	builder()
Integer	getNumConverted()	Number of attempted conversions
Integer	getNumFailed()	Number of failed conversions
Integer	getNumSucceeded()	Number of successful conversions
Double	getProcessingTime()	Total processing time in seconds.
ResponseType	getResponseType()	Type of response
@NonNull PreSignedUrlConvertDocumentResponse.Builder	toBuilder()
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getResponseType

public ResponseType getResponseType()

Description copied from class: ConvertDocumentResponse

Type of response

Specified by:

getResponseType in class ConvertDocumentResponse

Returns:

the response type

builder

public static @NonNull PreSignedUrlConvertDocumentResponse.Builder builder()

toBuilder

public @NonNull PreSignedUrlConvertDocumentResponse.Builder toBuilder()

getProcessingTime

public Double getProcessingTime()

Total processing time in seconds.

Returns:

the processing time in seconds

getNumConverted

public Integer getNumConverted()

Number of attempted conversions

Returns:

the number of attempted conversions

getNumSucceeded

public Integer getNumSucceeded()

Number of successful conversions

Returns:

the number of successful conversions

getNumFailed

public Integer getNumFailed()

Number of failed conversions

Returns:

the number of failed conversions

toString

public @NonNull String toString()

Overrides:

toString in class Object