eu.id3.document

## Class DocumentLibrary

- java.lang.Object
- - eu.id3.document.DocumentLibrary

-     public class DocumentLibrary
      extends java.lang.Object

  Initializes the SDK library.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `DocumentLibrary()`

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static java.lang.String` | `getVersion()` Retrieves the library version as a 'X.Y.Z' formatted string.
    `static LibVersion` | `getVersionEx()` Retrieves the library version as a structure.
    `static void` | `loadDocumentTemplate(java.lang.String path)` Loads the specified document template from a file.
    `static void` | `loadDocumentTemplateBuffer(byte[] buffer)` Loads a document template from a data buffer.
    `static void` | `loadModel(java.lang.String modelPath, DocumentModel documentModel, ProcessingUnit processingUnit)` Loads a model into memory from the specified directory.
    `static void` | `loadModelBuffer(byte[] modelBuffer, DocumentModel documentModel, ProcessingUnit processingUnit)` Loads a model into memory from the specified buffer.
    `static void` | `unloadDocumentTemplate(java.lang.String documentName)` Unloads a document template.
    `static void` | `unloadModel(DocumentModel documentModel, ProcessingUnit processingUnit)` Unloads a model from memory.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DocumentLibrary

          public DocumentLibrary()

  - ### Method Detail

    - #### getVersion

          public static java.lang.String getVersion()
                                             throws DocumentException

      Retrieves the library version as a 'X.Y.Z' formatted string.
      Returns:
        A string that identifies the library version.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### getVersionEx

          public static LibVersion getVersionEx()
                                         throws DocumentException

      Retrieves the library version as a structure.
      Returns:
        The version.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### loadDocumentTemplate

          public static void loadDocumentTemplate(java.lang.String path)
                                           throws DocumentException

      Loads the specified document template from a file.
      Parameters:
        `path` - A string that contains the full path to the document template.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### loadDocumentTemplateBuffer

          public static void loadDocumentTemplateBuffer(byte[] buffer)
                                                 throws DocumentException

      Loads a document template from a data buffer.
      Parameters:
        `buffer` - A buffer containing the document template data.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### loadModel

          public static void loadModel(java.lang.String modelPath,
                                       DocumentModel documentModel,
                                       ProcessingUnit processingUnit)
                                throws DocumentException

      Loads a model into memory from the specified directory.
      Parameters:
        `modelPath` - The path to directory containing the AI model files.
        `documentModel` - The AI model to be loaded.
        `processingUnit` - Processing unit to load the model into.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### loadModelBuffer

          public static void loadModelBuffer(byte[] modelBuffer,
                                             DocumentModel documentModel,
                                             ProcessingUnit processingUnit)
                                      throws DocumentException

      Loads a model into memory from the specified buffer.
      Parameters:
        `modelBuffer` - A buffer containing the AI model to be loaded.
        `documentModel` - Doc model to load.
        `processingUnit` - The processing unit to use for the model.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### unloadDocumentTemplate

          public static void unloadDocumentTemplate(java.lang.String documentName)
                                             throws DocumentException

      Unloads a document template.
      Parameters:
        `documentName` - The document name.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### unloadModel

          public static void unloadModel(DocumentModel documentModel,
                                         ProcessingUnit processingUnit)
                                  throws DocumentException

      Unloads a model from memory.
      Parameters:
        `documentModel` - The AI model to be unloaded.
        `processingUnit` - The processing unit used for the model.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

Copyright © 2020-2030, id3 Technologies. All rights reserved. eu.id3.document