Module ai.docling.serve.client
Package ai.docling.serve.client.operations

Class ClearOperations

java.lang.Object
ai.docling.serve.client.operations.ClearOperations
All Implemented Interfaces:
ai.docling.serve.api.DoclingServeClearApi
public final class ClearOperations extends Object implements ai.docling.serve.api.DoclingServeClearApi
Base class for clear API operations. Provides functionality for managing and cleaning up converters and stale data retained by the service.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClearOperations(HttpOperations httpOperations)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    ai.docling.serve.api.clear.response.ClearResponse
    clearConverters(ai.docling.serve.api.clear.request.ClearConvertersRequest request)
    Clears all configured converters using the Docling Serve API.
    ai.docling.serve.api.clear.response.ClearResponse
    clearResults(ai.docling.serve.api.clear.request.ClearResultsRequest request)
    Clears stale results retained by the service, based on the specified threshold duration.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ClearOperations

      public ClearOperations(HttpOperations httpOperations)

  • Method Details

    • clearConverters

      public ai.docling.serve.api.clear.response.ClearResponse clearConverters(ai.docling.serve.api.clear.request.ClearConvertersRequest request)
      Clears all configured converters using the Docling Serve API. This method performs an HTTP GET request to reset or clear any converters that have been configured in the current session. The request may include authentication details required to authorize the operation.
      Specified by:
      clearConverters in interface ai.docling.serve.api.DoclingServeClearApi
      Parameters:
      request - the ClearConvertersRequest object containing the parameters for the clear operation. This request object must not be null.
      Returns:
      a ClearResponse object representing the result of the clear operation, including details such as the status of the operation.

    • clearResults

      public ai.docling.serve.api.clear.response.ClearResponse clearResults(ai.docling.serve.api.clear.request.ClearResultsRequest request)
      Clears stale results retained by the service, based on the specified threshold duration. Results older than the duration specified in the ClearResultsRequest parameter will be removed.
      Specified by:
      clearResults in interface ai.docling.serve.api.DoclingServeClearApi
      Parameters:
      request - the ClearResultsRequest object containing the threshold duration for clearing results; must not be null.
      Returns:
      a ClearResponse object representing the result of the clear operation, including the status of the operation.