Package org.apache.camel.builder.component.dsl

Interface DoclingComponentBuilderFactory.DoclingComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.docling.DoclingComponent>
All Known Implementing Classes:
DoclingComponentBuilderFactory.DoclingComponentBuilderImpl
Enclosing interface:
DoclingComponentBuilderFactory
public static interface DoclingComponentBuilderFactory.DoclingComponentBuilder extends ComponentBuilder<org.apache.camel.component.docling.DoclingComponent>
Builder for the Docling component.

  • Method Details

    • configuration

      default DoclingComponentBuilderFactory.DoclingComponentBuilder configuration(org.apache.camel.component.docling.DoclingConfiguration configuration)
      The configuration for the Docling Endpoint. The option is a: <code>org.apache.camel.component.docling.DoclingConfiguration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • contentInBody

      default DoclingComponentBuilderFactory.DoclingComponentBuilder contentInBody(boolean contentInBody)
      Include the content of the output file in the exchange body and delete the output file. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      contentInBody - the value to set
      Returns:
      the dsl builder

    • doclingServeUrl

      default DoclingComponentBuilderFactory.DoclingComponentBuilder doclingServeUrl(String doclingServeUrl)
      Docling-serve API URL (e.g., http://localhost:5001). The option is a: <code>java.lang.String</code> type. Default: http://localhost:5001 Group: producer
      Parameters:
      doclingServeUrl - the value to set
      Returns:
      the dsl builder

    • enableOCR

      default DoclingComponentBuilderFactory.DoclingComponentBuilder enableOCR(boolean enableOCR)
      Enable OCR processing for scanned documents. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      enableOCR - the value to set
      Returns:
      the dsl builder

    • includeLayoutInfo

      default DoclingComponentBuilderFactory.DoclingComponentBuilder includeLayoutInfo(boolean includeLayoutInfo)
      Show layout information with bounding boxes. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      includeLayoutInfo - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default DoclingComponentBuilderFactory.DoclingComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • ocrLanguage

      default DoclingComponentBuilderFactory.DoclingComponentBuilder ocrLanguage(String ocrLanguage)
      Language code for OCR processing. The option is a: <code>java.lang.String</code> type. Default: en Group: producer
      Parameters:
      ocrLanguage - the value to set
      Returns:
      the dsl builder

    • operation

      default DoclingComponentBuilderFactory.DoclingComponentBuilder operation(org.apache.camel.component.docling.DoclingOperations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.docling.DoclingOperations</code> type. Default: CONVERT_TO_MARKDOWN Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • outputFormat

      default DoclingComponentBuilderFactory.DoclingComponentBuilder outputFormat(String outputFormat)
      Output format for document conversion. The option is a: <code>java.lang.String</code> type. Default: markdown Group: producer
      Parameters:
      outputFormat - the value to set
      Returns:
      the dsl builder

    • useDoclingServe

      default DoclingComponentBuilderFactory.DoclingComponentBuilder useDoclingServe(boolean useDoclingServe)
      Use docling-serve API instead of CLI command. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      useDoclingServe - the value to set
      Returns:
      the dsl builder

    • apiTimeout

      default DoclingComponentBuilderFactory.DoclingComponentBuilder apiTimeout(long apiTimeout)
      API request timeout in milliseconds. The option is a: <code>long</code> type. Default: 60000 Group: advanced
      Parameters:
      apiTimeout - the value to set
      Returns:
      the dsl builder

    • asyncPollInterval

      default DoclingComponentBuilderFactory.DoclingComponentBuilder asyncPollInterval(long asyncPollInterval)
      Polling interval for async conversion status in milliseconds. The option is a: <code>long</code> type. Default: 2000 Group: advanced
      Parameters:
      asyncPollInterval - the value to set
      Returns:
      the dsl builder

    • asyncTimeout

      default DoclingComponentBuilderFactory.DoclingComponentBuilder asyncTimeout(long asyncTimeout)
      Maximum time to wait for async conversion completion in milliseconds. The option is a: <code>long</code> type. Default: 300000 Group: advanced
      Parameters:
      asyncTimeout - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default DoclingComponentBuilderFactory.DoclingComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • connectionRequestTimeout

      default DoclingComponentBuilderFactory.DoclingComponentBuilder connectionRequestTimeout(int connectionRequestTimeout)
      Connection request timeout in milliseconds (timeout when requesting connection from pool). The option is a: <code>int</code> type. Default: 30000 Group: advanced
      Parameters:
      connectionRequestTimeout - the value to set
      Returns:
      the dsl builder

    • connectionTimeout

      default DoclingComponentBuilderFactory.DoclingComponentBuilder connectionTimeout(int connectionTimeout)
      Connection timeout in milliseconds. The option is a: <code>int</code> type. Default: 30000 Group: advanced
      Parameters:
      connectionTimeout - the value to set
      Returns:
      the dsl builder

    • connectionTimeToLive

      default DoclingComponentBuilderFactory.DoclingComponentBuilder connectionTimeToLive(long connectionTimeToLive)
      Time to live for connections in milliseconds (-1 for infinite). The option is a: <code>long</code> type. Default: -1 Group: advanced
      Parameters:
      connectionTimeToLive - the value to set
      Returns:
      the dsl builder

    • convertEndpoint

      default DoclingComponentBuilderFactory.DoclingComponentBuilder convertEndpoint(String convertEndpoint)
      Docling-serve API convert endpoint path. The option is a: <code>java.lang.String</code> type. Default: /v1/convert/source Group: advanced
      Parameters:
      convertEndpoint - the value to set
      Returns:
      the dsl builder

    • doclingCommand

      default DoclingComponentBuilderFactory.DoclingComponentBuilder doclingCommand(String doclingCommand)
      Path to Docling Python executable or command. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      doclingCommand - the value to set
      Returns:
      the dsl builder

    • evictIdleConnections

      default DoclingComponentBuilderFactory.DoclingComponentBuilder evictIdleConnections(boolean evictIdleConnections)
      Enable eviction of idle connections from the pool. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      evictIdleConnections - the value to set
      Returns:
      the dsl builder

    • maxConnectionsPerRoute

      default DoclingComponentBuilderFactory.DoclingComponentBuilder maxConnectionsPerRoute(int maxConnectionsPerRoute)
      Maximum connections per route in the connection pool. The option is a: <code>int</code> type. Default: 10 Group: advanced
      Parameters:
      maxConnectionsPerRoute - the value to set
      Returns:
      the dsl builder

    • maxIdleTime

      default DoclingComponentBuilderFactory.DoclingComponentBuilder maxIdleTime(long maxIdleTime)
      Maximum idle time for connections in milliseconds before eviction. The option is a: <code>long</code> type. Default: 60000 Group: advanced
      Parameters:
      maxIdleTime - the value to set
      Returns:
      the dsl builder

    • maxTotalConnections

      default DoclingComponentBuilderFactory.DoclingComponentBuilder maxTotalConnections(int maxTotalConnections)
      Maximum total connections in the connection pool. The option is a: <code>int</code> type. Default: 20 Group: advanced
      Parameters:
      maxTotalConnections - the value to set
      Returns:
      the dsl builder

    • processTimeout

      default DoclingComponentBuilderFactory.DoclingComponentBuilder processTimeout(long processTimeout)
      Timeout for Docling process execution in milliseconds. The option is a: <code>long</code> type. Default: 30000 Group: advanced
      Parameters:
      processTimeout - the value to set
      Returns:
      the dsl builder

    • socketTimeout

      default DoclingComponentBuilderFactory.DoclingComponentBuilder socketTimeout(int socketTimeout)
      Socket timeout in milliseconds. The option is a: <code>int</code> type. Default: 60000 Group: advanced
      Parameters:
      socketTimeout - the value to set
      Returns:
      the dsl builder

    • useAsyncMode

      default DoclingComponentBuilderFactory.DoclingComponentBuilder useAsyncMode(boolean useAsyncMode)
      Use asynchronous conversion mode (docling-serve API only). The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      useAsyncMode - the value to set
      Returns:
      the dsl builder

    • validateAfterInactivity

      default DoclingComponentBuilderFactory.DoclingComponentBuilder validateAfterInactivity(int validateAfterInactivity)
      Validate connections after inactivity in milliseconds. The option is a: <code>int</code> type. Default: 2000 Group: advanced
      Parameters:
      validateAfterInactivity - the value to set
      Returns:
      the dsl builder

    • workingDirectory

      default DoclingComponentBuilderFactory.DoclingComponentBuilder workingDirectory(String workingDirectory)
      Working directory for Docling execution. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      workingDirectory - the value to set
      Returns:
      the dsl builder

    • batchFailOnFirstError

      default DoclingComponentBuilderFactory.DoclingComponentBuilder batchFailOnFirstError(boolean batchFailOnFirstError)
      Fail entire batch on first error (true) or continue processing remaining documents (false). The option is a: <code>boolean</code> type. Default: true Group: batch
      Parameters:
      batchFailOnFirstError - the value to set
      Returns:
      the dsl builder

    • batchParallelism

      default DoclingComponentBuilderFactory.DoclingComponentBuilder batchParallelism(int batchParallelism)
      Number of parallel threads for batch processing. The option is a: <code>int</code> type. Default: 4 Group: batch
      Parameters:
      batchParallelism - the value to set
      Returns:
      the dsl builder

    • batchSize

      default DoclingComponentBuilderFactory.DoclingComponentBuilder batchSize(int batchSize)
      Maximum number of documents to process in a single batch (batch operations only). The option is a: <code>int</code> type. Default: 10 Group: batch
      Parameters:
      batchSize - the value to set
      Returns:
      the dsl builder

    • batchTimeout

      default DoclingComponentBuilderFactory.DoclingComponentBuilder batchTimeout(long batchTimeout)
      Maximum time to wait for batch completion in milliseconds. The option is a: <code>long</code> type. Default: 300000 Group: batch
      Parameters:
      batchTimeout - the value to set
      Returns:
      the dsl builder

    • splitBatchResults

      default DoclingComponentBuilderFactory.DoclingComponentBuilder splitBatchResults(boolean splitBatchResults)
      Split batch results into individual exchanges (one per document) instead of single BatchProcessingResults. The option is a: <code>boolean</code> type. Default: false Group: batch
      Parameters:
      splitBatchResults - the value to set
      Returns:
      the dsl builder

    • extractAllMetadata

      default DoclingComponentBuilderFactory.DoclingComponentBuilder extractAllMetadata(boolean extractAllMetadata)
      Extract all available metadata fields including custom/raw fields. The option is a: <code>boolean</code> type. Default: false Group: metadata
      Parameters:
      extractAllMetadata - the value to set
      Returns:
      the dsl builder

    • includeMetadataInHeaders

      default DoclingComponentBuilderFactory.DoclingComponentBuilder includeMetadataInHeaders(boolean includeMetadataInHeaders)
      Include metadata in message headers when extracting metadata. The option is a: <code>boolean</code> type. Default: true Group: metadata
      Parameters:
      includeMetadataInHeaders - the value to set
      Returns:
      the dsl builder

    • includeRawMetadata

      default DoclingComponentBuilderFactory.DoclingComponentBuilder includeRawMetadata(boolean includeRawMetadata)
      Include raw metadata as returned by the parser. The option is a: <code>boolean</code> type. Default: false Group: metadata
      Parameters:
      includeRawMetadata - the value to set
      Returns:
      the dsl builder

    • apiKeyHeader

      default DoclingComponentBuilderFactory.DoclingComponentBuilder apiKeyHeader(String apiKeyHeader)
      Header name for API key authentication. The option is a: <code>java.lang.String</code> type. Default: X-API-Key Group: security
      Parameters:
      apiKeyHeader - the value to set
      Returns:
      the dsl builder

    • authenticationScheme

      default DoclingComponentBuilderFactory.DoclingComponentBuilder authenticationScheme(org.apache.camel.component.docling.AuthenticationScheme authenticationScheme)
      Authentication scheme (BEARER, API_KEY, NONE). The option is a: <code>org.apache.camel.component.docling.AuthenticationScheme</code> type. Default: NONE Group: security
      Parameters:
      authenticationScheme - the value to set
      Returns:
      the dsl builder

    • authenticationToken

      default DoclingComponentBuilderFactory.DoclingComponentBuilder authenticationToken(String authenticationToken)
      Authentication token for docling-serve API (Bearer token or API key). The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      authenticationToken - the value to set
      Returns:
      the dsl builder

    • maxFileSize

      default DoclingComponentBuilderFactory.DoclingComponentBuilder maxFileSize(long maxFileSize)
      Maximum file size in bytes for processing. The option is a: <code>long</code> type. Default: 52428800 Group: security
      Parameters:
      maxFileSize - the value to set
      Returns:
      the dsl builder