Package ai.docling.serve.api

Interface DoclingServeHealthApi

All Known Subinterfaces:
DoclingServeApi
public interface DoclingServeHealthApi
Interface for performing health checks on the Docling service API. This API is designed to verify and report the operational status of the service.

  • Method Summary

    Modifier and Type
    Method
    Description
    HealthCheckResponse
    health()
    Executes a health check for the API and retrieves the health status of the service.

  • Method Details

    • health

      HealthCheckResponse health()
      Executes a health check for the API and retrieves the health status of the service.
      Returns:
      a HealthCheckResponse object containing the health status of the API.