Package com.deltaxml.deltaai

Class DeltaAI

java.lang.Object
com.deltaxml.deltaai.DeltaAI
public class DeltaAI extends Object
Generate an AI powered report that summarises a DeltaV2 output.

  • Constructor Details

    • DeltaAI

      public DeltaAI()

  • Method Details

    • generateReport

      public void generateReport(InputStream is, StreamResult result) throws AIProviderException, com.deltaxml.licensing.LicenseException
      This produces an AI generated HTML report summarising your delta output file. An AI provider, model name, and API key must be configured in the DeltaAI configuration file
      Parameters:
      is - the resulting delta file after running a comparison as an InputStream
      result - the StreamResult to write the HTML report to
      Throws:
      AIProviderException - if there is a problem connecting to the AI provider with the configured credentials, or if there is a problem generating the HTML report
      com.deltaxml.licensing.LicenseException

    • generateReport

      public void generateReport(File deltaOutputFile, File reportFile) throws AIProviderException, com.deltaxml.licensing.LicenseException
      This produces an AI generated HTML report summarising your delta output file. An AI provider, model name, and API key must be configured in the DeltaAI configuration file
      Parameters:
      deltaOutputFile - the resulting delta file after running a comparison
      reportFile - the location where the HTML report will be written
      Throws:
      AIProviderException - if there is a problem connecting to the AI provider with the configured credentials, or if there is a problem generating the HTML report
      com.deltaxml.licensing.LicenseException

    • generateReport

      public void generateReport(File deltaOutputFile) throws AIProviderException, com.deltaxml.licensing.LicenseException

      This produces an AI generated HTML report summarising your delta output file. An AI provider, model name, and API key must be configured in the DeltaAI configuration file.

      The report file generated will be written to the current working directory. To specify report file location and file name, use generateReport(File, File)

      Parameters:
      deltaOutputFile - the resulting delta file after running a comparison
      Throws:
      AIProviderException - if there is a problem connecting to the AI provider with the configured credentials, or if there is a problem generating the HTML report
      com.deltaxml.licensing.LicenseException

    • addLicenseFile

      public void addLicenseFile(File licenseFile) throws SecurityException, IOException, com.deltaxml.licensing.LicenseException
      Adds the license file for use with Flexera licensing.
      Parameters:
      licenseFile - the FlexLM format license file
      Throws:
      com.deltaxml.licensing.LicenseSecurityException - if the file cannot be accessed
      IOException - if there are problems reading the file
      com.deltaxml.licensing.LicenseException - if there is a problem using the license file
      SecurityException

    • addLicenseServer

      public void addLicenseServer(String hostname) throws com.deltaxml.licensing.LicenseException
      Adds a license server (for use with a flexera license server).
      Parameters:
      hostname - of the license server host or its ip address
      Throws:
      com.deltaxml.licensing.LicenseException - if there is a problem using the license server

    • addLicenseServer

      public void addLicenseServer(String hostname, int port) throws IllegalArgumentException, com.deltaxml.licensing.LicenseException
      Adds a license server and port (for use with a flexera license server).
      Parameters:
      hostname - of the license server host or its ip address
      port - the port number on the license server for the lmgrd
      Throws:
      IllegalArgumentException - if the port number is out of range
      com.deltaxml.licensing.LicenseException - if there is a problem using the license server