Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ jobs:
- 21
- 25
module:
- api
- client
- testing
- testcontainers
- docling-serve-api
- docling-serve-client
- docling-testing
- docling-testcontainers
name: jvm-build-test-${{ matrix.module }}-java${{ matrix.java }}
steps:
- uses: actions/checkout@v5
Expand All @@ -46,7 +46,7 @@ jobs:
- name: build-test-${{ matrix.module }}-java${{ matrix.java }}
run: |
./gradlew --no-daemon -Pjava.version=${{ matrix.java }} \
:docling-${{ matrix.module }}:clean :docling-${{ matrix.module }}:build
:${{ matrix.module }}:clean :${{ matrix.module }}:build

docs:
runs-on: ubuntu-latest
Expand All @@ -68,4 +68,4 @@ jobs:
cache: gradle

- name: Generate documentation
run: ./gradlew --console=plain clean :docling-docs:mkdocsBuild
run: ./gradlew --console=plain clean :docs:mkdocsBuild
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
cache: gradle

- name: Generate documentation
run: ./gradlew --console=plain clean :docling-docs:mkdocsBuild
run: ./gradlew --console=plain clean :docs:mkdocsBuild

- name: Setup pages
uses: actions/configure-pages@v5
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,31 +26,32 @@ This is repository for Docling Java, a Java API for using [Docling](https://gith

This project aims to provide the following artifacts:

* [`docling-api`](api): The core API for interacting with Docling. Should be framework-agnostic.
* [`docling-client`](client): A reference implementation of the [`docling-api`](api) using Java's [`HttpClient`](https://openjdk.org/groups/net/httpclient/intro.html) and [Jackson](https://github.com/FasterXML/jackson).
* [`docling-testing`](testing): Utilities for testing Docling
* [`docling-testcontainers`](testcontainers): A [Testcontainers module](https://testcontainers.com/) for running Docling in a Docker container.
* [`docling-serve-api`](docling-serve/docling-serve-api): The core API for interacting with Docling. Should be framework-agnostic.
* [`docling-serve-client`](docling-serve/docling-serve-client): A reference implementation of the [`docling-serve-api`](docling-serve/docling-serve-api) using Java's [`HttpClient`](https://openjdk.org/groups/net/httpclient/intro.html) and [Jackson](https://github.com/FasterXML/jackson) to connect to a [Docling Serve](https://github.com/docling-project/docling-serve) endpoint.
* [`docling-testing`](docling-testing): Utilities for testing Docling integration.
* [`docling-testcontainers`](docling-testcontainers): A [Testcontainers module](https://testcontainers.com/) for running Docling in a Docker container.

## Getting started

Use `DoclingApi.convertSource()` to convert individual documents. For example:

```java
import ai.docling.api.DoclingApi;
import ai.docling.api.convert.request.ConvertDocumentRequest;
import ai.docling.api.convert.response.ConvertDocumentResponse;
import ai.docling.client.DoclingClient;

DoclingApi doclingApi = DoclingClient.builder()
.baseUrl("<location of docling server>")
import ai.docling.api.serve.DoclingServeApi;
import ai.docling.api.serve.convert.request.ConvertDocumentRequest;
import ai.docling.api.serve.convert.request.source.HttpSource;
import ai.docling.api.serve.convert.response.ConvertDocumentResponse;
import ai.docling.client.serve.DoclingServeClientBuilderFactory;

DoclingServeApi doclingServeApi = DoclingServeClientBuilderFactory.newBuilder()
.baseUrl("<location of docling serve instance>")
.build();

ConvertDocumentRequest request = ConvertDocumentRequest.builder()
.addHttpSources(URI.create("https://arxiv.org/pdf/2408.09869"))
ConvertDocumentRequest request = new ConvertDocumentRequest()
.withSources(List.of(new HttpSource().withUrl(URI.create("https://arxiv.org/pdf/2408.09869"))))
.build();

ConvertDocumentResponse response = doclingApi.convertSource(request);
System.out.println(response.document().markdownContent());
System.out.println(response.getDocument().getMarkdownContent());
```

More [usage information](https://docling-project.github.io/docling-java) are available in the docs.
Expand All @@ -59,7 +60,6 @@ More [usage information](https://docling-project.github.io/docling-java) are ava

Please feel free to connect with us using the [discussion section](https://github.com/docling-project/docling-java/discussions).


## Contributing

Please read [Contributing to Docling Java](CONTRIBUTING.md) for details.
Expand Down
9 changes: 0 additions & 9 deletions api/build.gradle.kts

This file was deleted.

16 changes: 0 additions & 16 deletions api/src/main/java/ai/docling/api/DoclingApi.java

This file was deleted.

7 changes: 0 additions & 7 deletions api/src/main/java/ai/docling/api/convert/package-info.java

This file was deleted.

This file was deleted.

Loading