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

Class PictureDescriptionApi.Builder

java.lang.Object

ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder

Enclosing class:

PictureDescriptionApi

public static class PictureDescriptionApi.Builder
extends Object

Builder for creating PictureDescriptionApi instances. Generated by Lombok's @Builder annotation.

Builder methods:

• url(URI) - Set the API endpoint URL
• header(String, Object) - Add a single HTTP header (use with @Singular)
• headers(Map<String, Object>) - Set the map of HTTP headers
• param(String, Object) - Add a single parameter (use with @Singular)
• params(Map<String, Object>) - Set the map of model parameters
• timeout(Duration) - Set the timeout duration
• concurrency(Integer) - Set the maximum concurrency
• prompt(String) - Set the prompt text

Method Summary

Modifier and Type	Method	Description
@NonNull PictureDescriptionApi	build()
@NonNull PictureDescriptionApi.Builder	clearHeaders()
@NonNull PictureDescriptionApi.Builder	clearParams()
@NonNull PictureDescriptionApi.Builder	concurrency(@Nullable Integer concurrency)	Maximum number of concurrent requests to the API.
@NonNull PictureDescriptionApi.Builder	header(String headerKey, Object headerValue)
@NonNull PictureDescriptionApi.Builder	headers(@NonNull Map<? extends String,? extends Object> headers)
@NonNull PictureDescriptionApi.Builder	param(String paramKey, Object paramValue)
@NonNull PictureDescriptionApi.Builder	params(@NonNull Map<? extends String,? extends Object> params)
@NonNull PictureDescriptionApi.Builder	prompt(@Nullable String prompt)	Prompt used when calling the vision-language model.
@NonNull PictureDescriptionApi.Builder	timeout(@Nullable Duration timeout)	Timeout for the API request.
@NonNull String	toString()
@NonNull PictureDescriptionApi.Builder	url(@NonNull URI url)	Endpoint which accepts openai-api compatible requests.

Methods inherited from class java.lang.Object

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

Method Details

url

public @NonNull PictureDescriptionApi.Builder url(@NonNull
 @NonNull URI url)

Endpoint which accepts openai-api compatible requests.

Parameters:

url - the API endpoint URL

Returns:

this.

header

public @NonNull PictureDescriptionApi.Builder header(String headerKey,
 Object headerValue)

headers

public @NonNull PictureDescriptionApi.Builder headers(@NonNull Map<? extends String,? extends Object> headers)

clearHeaders

public @NonNull PictureDescriptionApi.Builder clearHeaders()

param

public @NonNull PictureDescriptionApi.Builder param(String paramKey,
 Object paramValue)

params

public @NonNull PictureDescriptionApi.Builder params(@NonNull Map<? extends String,? extends Object> params)

clearParams

public @NonNull PictureDescriptionApi.Builder clearParams()

timeout

public @NonNull PictureDescriptionApi.Builder timeout(@Nullable Duration timeout)

Timeout for the API request.

Parameters:

timeout - the timeout duration, or null if not specified

Returns:

this.

concurrency

public @NonNull PictureDescriptionApi.Builder concurrency(@Nullable Integer concurrency)

Maximum number of concurrent requests to the API.

Parameters:

concurrency - the maximum concurrency, or null if not specified

Returns:

this.

prompt

public @NonNull PictureDescriptionApi.Builder prompt(@Nullable String prompt)

Prompt used when calling the vision-language model.

Parameters:

prompt - the prompt text, or null if not specified

Returns:

this.

build

public @NonNull PictureDescriptionApi build()

toString

public @NonNull String toString()

Overrides:

toString in class Object