Skip to content

test: Add more tests for conversion API options #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Abmarne wants to merge 1 commit into
base: main
Choose a base branch
from
Open

test: Add more tests for conversion API options #375

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
294 changes: 294 additions & 0 deletions ...g-serve-client/src/test/java/ai/docling/serve/client/AbstractDoclingServeClientTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@
import ai.docling.serve.api.clear.response.ClearResponse;
import ai.docling.serve.api.convert.request.ConvertDocumentRequest;
import ai.docling.serve.api.convert.request.options.ConvertDocumentOptions;
import ai.docling.serve.api.convert.request.options.OcrEngine;
import ai.docling.serve.api.convert.request.options.OutputFormat;
import ai.docling.serve.api.convert.request.options.PdfBackend;
import ai.docling.serve.api.convert.request.options.TableFormerMode;
import ai.docling.serve.api.convert.request.source.HttpSource;
import ai.docling.serve.api.convert.request.source.S3Source;
Expand Down Expand Up @@ -707,6 +709,298 @@ void convertAsyncFilesNotRegularFile() {
.isThrownBy(() -> getDoclingClient().convertFilesAsync(Path.of("src", "test", "resources")))
.withMessage("File (src/test/resources) is not a regular file");
}

@Test
void shouldConvertToHtmlFormat() {
var options = ConvertDocumentOptions.builder()
.toFormat(OutputFormat.HTML)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
assertThat(response.getDocument().getHtmlContent()).isNotEmpty();
}

@Test
void shouldConvertToTextFormat() {
var options = ConvertDocumentOptions.builder()
.toFormat(OutputFormat.TEXT)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
assertThat(response.getDocument().getTextContent()).isNotEmpty();
}

@Test
void shouldConvertWithPdfBackend() {
var options = ConvertDocumentOptions.builder()
.pdfBackend(PdfBackend.PYPDFIUM2)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithOcrEngine() {
var options = ConvertDocumentOptions.builder()
.ocrEngine(OcrEngine.TESSERACT)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithForceOcr() {
var options = ConvertDocumentOptions.builder()
.forceOcr(true)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithTableDisabled() {
var options = ConvertDocumentOptions.builder()
.doTableStructure(false)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithImagesExcluded() {
var options = ConvertDocumentOptions.builder()
.includeImages(false)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithPageRange() {
var options = ConvertDocumentOptions.builder()
.pageRange(1, 2)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithAbortOnError() {
var options = ConvertDocumentOptions.builder()
.abortOnError(true)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithCodeEnrichment() {
var options = ConvertDocumentOptions.builder()
.doCodeEnrichment(true)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithFormulaEnrichment() {
var options = ConvertDocumentOptions.builder()
.doFormulaEnrichment(true)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithPictureClassification() {
var options = ConvertDocumentOptions.builder()
.doPictureClassification(true)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithMultipleOutputFormats() {
var options = ConvertDocumentOptions.builder()
.toFormats(List.of(OutputFormat.MARKDOWN, OutputFormat.JSON))
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
assertThat(response.getDocument().getMarkdownContent()).isNotEmpty();
assertThat(response.getDocument().getJsonContent()).isNotNull();
}

@Test
void shouldConvertWithImageScale() {
var options = ConvertDocumentOptions.builder()
.imagesScale(1.5)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithMdPageBreakPlaceholder() {
var options = ConvertDocumentOptions.builder()
.mdPageBreakPlaceholder("---BREAK---")
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}

@Test
void shouldConvertWithTableCellMatchingDisabled() {
var options = ConvertDocumentOptions.builder()
.tableCellMatching(false)
.build();

var request = ConvertDocumentRequest.builder()
.source(HttpSource.builder().url(URI.create("https://docs.arconia.io/arconia-cli/latest/development/dev/")).build())
.options(options)
.build();

var response = getDoclingClient().convertSource(request);

assertThat(response).isNotNull();
assertThat(response.getStatus()).isNotEmpty();
assertThat(response.getDocument()).isNotNull();
}
}

@Nested
Expand Down
Loading