Configure Template

Luma Knowledge provides several OOTB Templates that enable a curator to create Artifacts. However, if the existing knowledge documents do not conform with the OOTB templates, you can configure custom templates in Luma Knowledge. These templates can be used to create Artifacts manually or by importing documents into the system. Such Artifacts bypass the QnA generation process and are created with Knowledge and Ontology extracted from the information available in the documents.

Templates are used to validate the document and extract the information required to create Artifact in Luma Knowledge such as Summary, Ontology. Therefore, it is important that the Template correctly represent the Knowledge documents for successful Artifact creation.

Follow the below steps to create a custom Template in Luma Knowledge:

  1. Navigate to Curation → Templates.

  2. Click on Add Template.

  3. On the Create Template page, add the following Template details

    1. Add Template Name. This is the name used to identify the template while creating the artifact or uploading the document.

    2. Add Description.

    3. Click on Add Field to add Template Fields. These are the fields that are available to the curator when creating the artifacts manually. When a document is being uploaded, Luma Knowledge parses the document sections or Headings with the Field name and uses the information to create Artifact.

      1. Add Field Name.

      2. Select Field type to indicate the type of text that will be added to the field. For example, use Rich Text if the field holds formatted text.

      3. Add the Default Value. If the document does not contain any information under the section/field, the default value is used for the Artifact.

      4. Add Aliases to the field. These are the alternative field names that can be used in the documents to represent the field.

      5. Select the Ontology Type to determine if Artifact Ontology should be generated from the text in the field. Below are available options:

        1. Use Main to generate ontology and add the identified phrases to the main artifact metadata such as Topic, Subjects, Actions, Motivation, and Keywords.

        2. Use Suggested to generate ontology and add the identified phrases to the Suggested metadata field.

        3. Use None if the text in the field should not be parsed to generate Ontology.

      6. Select the other Field Options:

        1. Required if the field is mandatory for Artifact creation

        2. Summary, if the text in the field should be used as the Artifact Summary.

        3. Hidden, if the field should not be available during manual artifact creation and Artifact details screen. Hidden fields are only used when creating an Artifact using document import. However, the field is not displayed on the Artifact details screen.

        4. Redirect Link, if the artifact should redirect to the source article. Use the field to add the URL of the original article.

    4. The next step is to enable Metadata Extraction. This section is used to enable Luma Knowledge to read and process the Sections or Headings in your document that may contain Keywords, Metadata, or Topic Hierarchy for the Knowledge Artifact. If the uploaded documents contain sections with Keywords and Topic Hierarchy,

      1. Select Your documents may contain Keywords, Topic Hierarchy.’

      2. Select the metadata extraction script in Select Script.

        1. Use the Default script to use the OOTB extraction script. You can view the script in the script editor.

        2. In case the OOTB script cannot be used to extract metadata from your documents, you can click on Create Script to create a new script.

        3. Add the new script name, code and click Create.

  4. Click on Create Template to complete the Template creation.

The custom template is now available and can be used to create artifacts.

  • Field names and Aliases in a Knowledge template should be unique.

  • A Summary field is automatically marked Required.

  • Hidden fields are not available when creating Artifact manually. In case one of the Hidden fields is marked as Summary in the template, the Summary field on Create Artifact screen becomes mandatory and is used to hold Artifact Summary and Ontology generation.

  • Add a 'Redirect Link' field to your template to redirect the user to the source article when an artifact associated with the template is accessed through Luma Virtual Agent.