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

Class InBodyConvertDocumentResponse

java.lang.Object

ai.docling.serve.api.response.ProcessedDocumentResponse

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

ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse

public final class InBodyConvertDocumentResponse
extends ConvertDocumentResponse

Response for single document conversions with in-body content delivery.

This response type is returned when both the following conditions hold:

• The conversion request contains a single source
• The target type is InBodyTarget

The converted document content is included directly in the response body, along with conversion status, processing time, errors, and detailed timing information for each processing stage.

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

See Also:

• ConvertDocumentResponse
• ResponseType.IN_BODY
• InBodyTarget
• DocumentResponse

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NonNull InBodyConvertDocumentResponse.Builder	builder()
DocumentResponse	getDocument()	Converted document content.
List<ErrorItem>	getErrors()	List of errors that occurred during conversion.
Double	getProcessingTime()	Total processing time in seconds.
ResponseType	getResponseType()	Type of response
String	getStatus()	Conversion status (success, failure, partial_success, etc.).
Map<String,Object>	getTimings()	Detailed timing information for processing stages.
@NonNull InBodyConvertDocumentResponse.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 InBodyConvertDocumentResponse.Builder builder()

toBuilder

public @NonNull InBodyConvertDocumentResponse.Builder toBuilder()

getDocument

public DocumentResponse getDocument()

Converted document content.

Returns:

the converted document

getErrors

public List<ErrorItem> getErrors()

List of errors that occurred during conversion.

Returns:

the list of errors

getProcessingTime

public Double getProcessingTime()

Total processing time in seconds.

Returns:

the processing time in seconds

getStatus

public String getStatus()

Conversion status (success, failure, partial_success, etc.).

Returns:

the conversion status

getTimings

public Map<String,Object> getTimings()

Detailed timing information for processing stages.

Returns:

the map of timing information

toString

public @NonNull String toString()

Overrides:

toString in class Object