Package ai.docling.serve.api.convert.request.source

Class FileSource

java.lang.Object

ai.docling.serve.api.convert.request.source.Source

ai.docling.serve.api.convert.request.source.FileSource

public final class FileSource
extends Source

Represents a file-based data source. This class provides functionality to handle Base64-encoded file content and filenames for file sources. Inherits from Source.

JSON serialization/deserialization:

• base64_string - Represents the Base64-encoded content of the file.
• filename - Represents the name of the uploaded file.

By default, JSON includes non-empty fields only.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NonNull FileSource.Builder	builder()
@NonNull String	getBase64String()	Content of the file serialized in base64.
@NonNull String	getFilename()	Filename of the uploaded document.
@NonNull FileSource.Builder	toBuilder()
@NonNull String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

builder

public static @NonNull FileSource.Builder builder()

toBuilder

public @NonNull FileSource.Builder toBuilder()

getBase64String

@NonNull
public @NonNull String getBase64String()

Content of the file serialized in base64. For example it can be obtained via `base64 -w 0 /path/to/file/pdf-to-convert.pdf`.

Returns:

the base64-encoded file content

getFilename

@NonNull
public @NonNull String getFilename()

Filename of the uploaded document.

Returns:

the filename

toString

public @NonNull String toString()

Overrides:

toString in class Source