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
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package ai.docling.serve.api;

import org.jspecify.annotations.Nullable;

/**
* Docling Serve API interface.
*/
Expand All @@ -23,6 +25,19 @@ public interface DoclingServeApi
* @param <B> the type of the concrete builder implementation.
*/
interface DoclingApiBuilder<T extends DoclingServeApi, B extends DoclingApiBuilder<T, B>> {
/**
* Sets the API key for authenticating requests made by the client being built.
*
* The provided API key will be used as a credential to authorize and authenticate
* API requests. This method updates the configuration of the builder with the specified
* API key and ensures that the API client includes it in its requests as required for
* secure access to the API.
*
* @param apiKey the API key to be used for authenticating API requests
* @return {@code this} builder instance for fluent API usage
*/
B apiKey(@Nullable String apiKey);

/**
* Enables logging of requests for the API client being built. This can be useful for
* debugging or monitoring the behavior of requests made to the API.
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@

import org.jspecify.annotations.Nullable;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;

import ai.docling.serve.api.auth.AuthenticatedRequest;
import ai.docling.serve.api.auth.Authentication;
import ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions;
import ai.docling.serve.api.convert.request.options.ConvertDocumentOptions;
import ai.docling.serve.api.convert.request.source.Source;
Expand All @@ -27,7 +24,7 @@
@lombok.Builder(toBuilder = true)
@lombok.Getter
@lombok.ToString
public class HierarchicalChunkDocumentRequest implements AuthenticatedRequest {
public class HierarchicalChunkDocumentRequest {

@JsonProperty("sources")
@JsonSetter(nulls = Nulls.AS_EMPTY)
Expand All @@ -51,11 +48,6 @@ public class HierarchicalChunkDocumentRequest implements AuthenticatedRequest {
@lombok.Builder.Default
private HierarchicalChunkerOptions chunkingOptions = HierarchicalChunkerOptions.builder().build();

@JsonIgnore
@lombok.NonNull
@lombok.Builder.Default
private Authentication authentication = Authentication.builder().build();

@tools.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder { }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@

import org.jspecify.annotations.Nullable;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;

import ai.docling.serve.api.auth.AuthenticatedRequest;
import ai.docling.serve.api.auth.Authentication;
import ai.docling.serve.api.chunk.request.options.HybridChunkerOptions;
import ai.docling.serve.api.convert.request.options.ConvertDocumentOptions;
import ai.docling.serve.api.convert.request.source.Source;
Expand All @@ -27,7 +24,7 @@
@lombok.Builder(toBuilder = true)
@lombok.Getter
@lombok.ToString
public class HybridChunkDocumentRequest implements AuthenticatedRequest {
public class HybridChunkDocumentRequest {

@JsonProperty("sources")
@JsonSetter(nulls = Nulls.AS_EMPTY)
Expand All @@ -51,11 +48,6 @@ public class HybridChunkDocumentRequest implements AuthenticatedRequest {
@lombok.Builder.Default
private HybridChunkerOptions chunkingOptions = HybridChunkerOptions.builder().build();

@JsonIgnore
@lombok.NonNull
@lombok.Builder.Default
private Authentication authentication = Authentication.builder().build();

@tools.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder { }

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
package ai.docling.serve.api.clear.request;

import com.fasterxml.jackson.annotation.JsonIgnore;

import ai.docling.serve.api.auth.AuthenticatedRequest;
import ai.docling.serve.api.auth.Authentication;

/**
* Represents a request to clear or reset configured converters using the Docling Serve API.
*
Expand All @@ -22,9 +17,5 @@
@lombok.Builder(toBuilder = true)
@lombok.Getter
@lombok.ToString
public class ClearConvertersRequest implements AuthenticatedRequest {
@JsonIgnore
@lombok.NonNull
@lombok.Builder.Default
private Authentication authentication = Authentication.builder().build();
public class ClearConvertersRequest {
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@

import java.time.Duration;

import com.fasterxml.jackson.annotation.JsonIgnore;

import ai.docling.serve.api.auth.AuthenticatedRequest;
import ai.docling.serve.api.auth.Authentication;

/**
* Represents a request to clear stale data via the Docling Serve Clear API.
* This class provides a mechanism to specify a threshold duration, after which data
Expand All @@ -22,7 +17,7 @@
@lombok.Builder(toBuilder = true)
@lombok.Getter
@lombok.ToString
public class ClearResultsRequest implements AuthenticatedRequest {
public class ClearResultsRequest {
/**
* Represents the default duration used as a threshold for clearing stale results
* or data in the Docling Serve Clear API. Results older than this duration
Expand All @@ -35,9 +30,4 @@ public class ClearResultsRequest implements AuthenticatedRequest {
@lombok.NonNull
@lombok.Builder.Default
private Duration olderThen = DEFAULT_OLDER_THAN;

@JsonIgnore
@lombok.NonNull
@lombok.Builder.Default
private Authentication authentication = Authentication.builder().build();
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@

import org.jspecify.annotations.Nullable;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;

import ai.docling.serve.api.auth.AuthenticatedRequest;
import ai.docling.serve.api.auth.Authentication;
import ai.docling.serve.api.convert.request.options.ConvertDocumentOptions;
import ai.docling.serve.api.convert.request.source.Source;
import ai.docling.serve.api.convert.request.target.Target;
Expand All @@ -30,7 +27,7 @@
@lombok.Builder(toBuilder = true)
@lombok.Getter
@lombok.ToString
public class ConvertDocumentRequest implements AuthenticatedRequest {
public class ConvertDocumentRequest {
@JsonProperty("sources")
@JsonSetter(nulls = Nulls.AS_EMPTY)
@lombok.Singular
Expand All @@ -45,11 +42,6 @@ public class ConvertDocumentRequest implements AuthenticatedRequest {
@Nullable
private Target target;

@JsonIgnore
@lombok.NonNull
@lombok.Builder.Default
private Authentication authentication = Authentication.builder().build();

@tools.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder { }
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
package ai.docling.serve.api.task.request;

import com.fasterxml.jackson.annotation.JsonIgnore;

import ai.docling.serve.api.auth.AuthenticatedRequest;
import ai.docling.serve.api.auth.Authentication;

/**
* Represents a request to retrieve the result of a task.
*
Expand All @@ -20,12 +15,7 @@
@lombok.Builder(toBuilder = true)
@lombok.Getter
@lombok.ToString
public class TaskResultRequest implements AuthenticatedRequest {
public class TaskResultRequest {
@lombok.NonNull
private String taskId;

@JsonIgnore
@lombok.NonNull
@lombok.Builder.Default
private Authentication authentication = Authentication.builder().build();
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@

import java.time.Duration;

import com.fasterxml.jackson.annotation.JsonIgnore;

import ai.docling.serve.api.auth.AuthenticatedRequest;
import ai.docling.serve.api.auth.Authentication;

/**
* Represents a request for polling the status of a task.
*
Expand All @@ -27,7 +22,7 @@
@lombok.Builder(toBuilder = true)
@lombok.Getter
@lombok.ToString
public class TaskStatusPollRequest implements AuthenticatedRequest {
public class TaskStatusPollRequest {
/**
* The default wait time between status polling attempts for a task.
* <p>
Expand All @@ -44,9 +39,4 @@ public class TaskStatusPollRequest implements AuthenticatedRequest {
@lombok.NonNull
@lombok.Builder.Default
private Duration waitTime = DEFAULT_STATUS_POLL_WAIT_TIME;

@JsonIgnore
@lombok.NonNull
@lombok.Builder.Default
private Authentication authentication = Authentication.builder().build();
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@
exports ai.docling.serve.api.health;
exports ai.docling.serve.api.util;

// Auth
exports ai.docling.serve.api.auth;

// Chunking API
exports ai.docling.serve.api.chunk.request;
exports ai.docling.serve.api.chunk.request.options;
Expand Down

This file was deleted.

Loading