Skip to content

WCM Content AI Analysis

This topic describes how to enable AI analysis for a WCM Content in the traditional on-premise deployment. This also discusses steps on how to configure a content AI provider to be used for AI analysis. The AI analysis for a WCM Content feature is available from HCL Digital Experience 9.5 Container Update CF213 and higher.

Note

OpenAI ChatGPT is the supported content AI provider from CF213 and higher. Custom AI implementation is supported from CF214 and higher.

Content AI Provider Overview

OpenAI ChatGPT Overview

OpenAI is the AI research and deployment company behind ChatGPT. When you sign up with ChatGPT, it provides API access via an API key. After signing up at https://platform.openai.com/playground, you can create a personal account with limited access or a corporate account. The playground can be used to experiment with the API as well. A highlight of the API is that it accepts natural language commands similar to the ChatGPT chatbot.

For privacy and API availability and other conditions, see the OpenAI website or contact the OpenAI team.

Config Engine Task for enabling Content AI analysis

To enable content AI analysis:

  1. Connect to DX Core and run the following specified config engine task.

    /opt/HCL/wp_profile/ConfigEngine/ConfigEngine.sh action-configure-wcm-content-ai-service -DContentAIProvider=CUSTOM -DCustomAIClassName={CustomerAIClass} -DContentAIProviderAPIKey={APIKey} -DWasPassword=wpsadmin -DPortalAdminPwd=wpsadmin

    Note

    • Possible values for ContentAIProvider parameter are OPEN_AI or CUSTOM.
    • If ContentAIProvider value is set as OPEN_AI, the value set for the parameter CustomAIClassName is ignored.
    • If ContentAIProvider value is set as CUSTOM, set the custom content AI provider implementation class in the parameter CustomAIClassName. For example, com.ai.sample.CustomerAI. Refer to Configuring AI Class for Custom Content AI Provider for more information on how to implement a custom content AI provider class.
    • Depending on the ContentAIProvider, set the correct API key of the respective provider in the ContentAIProviderAPIKey parameter.

  2. Validate that all the required configurations are added.

    1. Log in to WAS console.

    2. Verify that the AI_CLASS configuration property is added in WCM Config Service by going to Resource > Resource Environment > Resource Environment Providers > WCM_WCMConfigService > Custom Properties. Possible values for AI_CLASS are:

      • com.hcl.workplace.wcm.restv2.ai.ChatGPTAnalyzerService (if ContentAIProvider value is set as OPEN_AI)
      • Value set in parameter CustomAIClassName (if ContentAIProvider value is set as CUSTOM)

    3. Log in to the DX Portal.

    4. Verify that the Credential Vault with the Vault slot Name ai.auth is configured using the AI content provider's API key by going to Administration > Security > Credential Vault > Manage System Vault Slot.

Configuring AI Class for Custom Content AI Provider

Only administrators can configure an AI class to use a custom content AI provider.

  1. Write the Custom Content AI Provider class by implementing the com.hcl.workplace.wcm.restv2.ai.IAIGeneration interface.

    1. Create the JAR file.

    2. Put the JAR file either at a custom-shared library or in /opt/HCL/wp_profile/PortalServer/sharedLibrary.

    3. Restart JVM.

    The following example of a Custom Content AI Provider class can be used to call Custom AI services for AI analysis.

    package com.ai.sample;

import java.util.ArrayList;
import java.util.List;
import com.hcl.workplace.wcm.restv2.ai.IAIGeneration;
import com.ibm.workplace.wcm.rest.exception.AIGenerationException;

public class CustomerAI implements IAIGeneration {

    @Override
    public String generateSummary(List<String> values) throws AIGenerationException {
        // Call the custom AI Service to get the custom AI generated summary
        return "AIAnalysisSummary";
    }

    @Override
    public List<String> generateKeywords(List<String> values) throws AIGenerationException {
        // Call the custom AI Service to get the custom AI generated keywords
        List<String> keyWordList = new ArrayList<String>();
        keyWordList.add("keyword1");
        return keyWordList;
    }

    @Override
    public Sentiment generateSentiment(List<String> values) throws AIGenerationException {
        // Call the custom AI Service to get the custom AI generated sentiment
        return Sentiment.POSITIVE;
    }

}

  2. Run the following config engine task.

    /opt/HCL/wp_profile/ConfigEngine/ConfigEngine.sh action-configure-wcm-content-ai-service -DContentAIProvider=CUSTOM -DCustomAIClassName={CustomerAIClass} -DContentAIProviderAPIKey={APIKey} -DWasPassword=wpsadmin -DPortalAdminPwd=wpsadmin

Config Engine Task for disabling Content AI analysis

To disable content AI analysis:

  1. Connect to DX Core and run the following specified config engine task.

    /opt/HCL/wp_profile/ConfigEngine/ConfigEngine.sh action-remove-wcm-content-ai-service -DWasPassword=wpsadmin -DPortalAdminPwd=wpsadmin

  2. Validate that all the required configurations are deleted.

    1. Log in to WAS console.
    2. Verify that the AI_CLASS configuration property is deleted from WCM Config Service.
    3. Log in to the DX Portal.
    4. Verify that the Credential Vault with the Vault slot Name ai.auth is deleted.

Custom Configurations for AI Analysis

If AI analysis-related configurations needs customization, log in to WAS console for customizing any of the custom properties in WCM Config Service (Resource > Resource Environment > Resource Environment Providers > WCM_WCMConfigService > Custom Properties).

OpenAI ChatGPT specific custom configurations

  1. OPENAI_MODEL: Currently supported AI model is text-davinci-003. However, AI model can be overriden by overriding this property.
  2. OPENAI_MAX_TOKENS: Set any positive integer values between 1 and 2048 for GPT-3 models like text-davinci-003. It specifies the maximum number of tokens that the model can output in its response.
  3. OPENAI_TEMPERATURE: Set any positive float values ranging from 0.0 to 1.0. This parameter in OpenAI's GPT-3 API controls the randomness and creativity of the generated text, with higher values producing more diverse and random output and lower values producing more focused and deterministic output.

After enabling the Content AI analysis in DX deployment, use the WCM REST V2 AI Analysis API to call the AI Analyzer APIs of the configured Content AI Provider.