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

Class ZipArchiveConvertDocumentResponse

java.lang.Object
ai.docling.serve.api.convert.response.ConvertDocumentResponse
ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse
public final class ZipArchiveConvertDocumentResponse extends ConvertDocumentResponse
Response for document conversions delivered as a ZIP archive.

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

  • The conversion request contains multiple source files with InBodyTarget/li>
  • The target type is ZipTarget

The response includes the ZIP file name and an input stream to read the archive contents. All converted documents and their associated assets are packaged together in the ZIP file.

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

See Also:

  • 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 ZipArchiveConvertDocumentResponse.Builder builder()

    • toBuilder

      public @NonNull ZipArchiveConvertDocumentResponse.Builder toBuilder()

    • getFileName

      public String getFileName()
      Name of the ZIP archive file containing the converted documents.

      This is the suggested filename for saving the ZIP archive locally.

      Returns:
      the ZIP archive file name

    • getInputStream

      public InputStream getInputStream()
      Input stream for reading the ZIP archive contents.

      This stream provides access to the binary ZIP file data containing all converted documents and their assets. The stream should be properly closed after reading to release resources.

      Note: This field is typically not serialized to JSON as it represents binary data. It's used for programmatic access to the ZIP archive contents.

      Returns:
      the input stream for the ZIP archive

    • toString

      public @NonNull String toString()
      Overrides:
      toString in class Object