Package ai.docling.serve.api

Interface DoclingServeClearApi

All Known Subinterfaces:
DoclingServeApi
public interface DoclingServeClearApi
Interface representing the Docling Serve Clear API. This API provides functionality for managing and cleaning up converters and stale data retained by the service. It includes methods for clearing registered converters and stored results based on specified thresholds or default configurations.

  • Method Details

    • clearConverters

      ClearResponse clearConverters(ClearConvertersRequest request)
      Clears all currently configured converters within the Docling Serve API. This operation removes any registered converters, effectively resetting the system to a state without active converter configurations.
      Parameters:
      request - an instance of ClearConvertersRequest containing the authentication details required to authorize this operation.
      Returns:
      a ClearResponse object indicating the status of the clear operation, such as success or failure.

    • clearResults

      ClearResponse clearResults(ClearResultsRequest request)
      Clears stored results based on the specified ClearResultsRequest. This method removes results that match the criteria provided in the request, such as results older than a specified duration.
      Parameters:
      request - an instance of ClearResultsRequest containing the criteria for clearing stored results, including the duration threshold or other parameters.
      Returns:
      a ClearResponse object indicating the status of the clear operation, such as success or failure.
      Throws:
      ValidationException - If request validation fails for any reason.