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

Class PictureDescriptionApi

java.lang.Object
ai.docling.serve.api.convert.request.options.PictureDescriptionApi
public class PictureDescriptionApi extends Object
Configuration options for picture description API integration. This class encapsulates settings for making API calls to describe pictures, including URL, headers, parameters, timeout, concurrency, and custom prompts.

  • Method Details

    • builder

      public static @NonNull PictureDescriptionApi.Builder builder()

    • toBuilder

      public @NonNull PictureDescriptionApi.Builder toBuilder()

    • getUrl

      @NonNull public @NonNull URI getUrl()
      Endpoint which accepts openai-api compatible requests.
      Returns:
      the API endpoint URL

    • getHeaders

      public Map<String,Object> getHeaders()
      Headers used for calling the API endpoint. For example, it could include authentication headers.
      Returns:
      the map of HTTP headers

    • getParams

      public Map<String,Object> getParams()
      Model parameters.
      Returns:
      the map of model parameters

    • getTimeout

      public @Nullable Duration getTimeout()
      Timeout for the API request.
      Returns:
      the timeout duration, or null if not specified

    • getConcurrency

      public @Nullable Integer getConcurrency()
      Maximum number of concurrent requests to the API.
      Returns:
      the maximum concurrency, or null if not specified

    • getPrompt

      public @Nullable String getPrompt()
      Prompt used when calling the vision-language model.
      Returns:
      the prompt text, or null if not specified

    • toString

      public @NonNull String toString()
      Overrides:
      toString in class Object