Create Artifact using Custom Templates
- sneha.tripathi
Luma Knowledge allows the Curator to create Artifacts using organization-specific Knowledge Templates. These are the documents that may have predefined templates such as System guides, ‘How to’ documents, RCA documents, etc. You can import these documents into Luma Knowledge and create Artifacts to make the information easily accessible to end-users on different integrated platforms.
Using Custom Templates
A Curator / Administrator can use custom Templates to create artifacts manually or by importing documents. You can import one or more documents and create Artifacts with the information available in the files. The document is validated based on the Knowledge template to ensure that the information required to create the Artifact is available. Upon successful validation, a Knowledge Artifact is created in Luma Knowledge.
For more information on creating artifacts manually using Knowledge Templates, refer to Create Artifact using Templates | Using-Regular-Template.
Manual Artifact Creation:
Follow the below steps to Import a document and create an Artifact using a Knowledge Template:
On the Create Artifact window, navigate to the Using Template tab.
On the Template list, select the required custom template.
Select a Domain from the Domain list. This represents the area, department, region, or field the Artifact belongs to. The Domains available on the list are available out of the box. To update the list, refer to Adding a new domain on the Knowledge Graph.
Add Artifact Name.
Add Summary.
For Metadata Search enabled tenants, it is important that the Summary is well-formed and articulates the information in the document well. The NLP engine uses the text in this Summary field to generate Metadata. If the Language Model is enabled for the tenant, you may skip the Summary field.
For Semantic Search-enabled tenants, a Summary is not mandatory. This is because semantic search does not require metadata.
Add the Source of the artifact.
Now based on the selected template, add information in the Content fields.
Click on Create.
The selected documents are now queued for Artifact creation. Luma Knowledge validates the document based on the selected Knowledge template and creates an Artifact. The new Artifact(s) is linked to the selected template. Artifact details are extracted from the document. The information available in the various sections (text and media content) is mapped to the template fields.
The Artifact state is determined based on your tenant's Artifact Publishing Mode configuration and the identified ontology. Refer to Tenant Configurations for more information.
Points to Remember:
It is important to select the correct Knowledge Template. Your document must follow the structure of the Knowledge Template selected. If the uploaded document’s structure does not follow the selected template, artifact creation fails.
Your document section names or headings should be the same as the Template Fields or respective Aliases. Luma Knowledge identifies the section headings as the template fields.
You can upload .docx, .pdf, and .xlsx files to create Artifacts with Templates. To upload multiple files, you select the file one by one or upload a zip file.
For Metadata-based searches
Artifact Ontology is automatically generated from the text available in Template fields that are marked as Summary and with Ontology Type as ‘Main’ or ‘Suggested’.
If your document contains sections with Metadata and Topic Hierarchy, the Metadata Extraction script associated with the selected template will extract the information and add the metadata to the Artifact.
If Open AI is enabled for your Tenant, Metadata, Key phrases and Summary are automatically generated. Refer to Integrating Advanced Language Models for more details on Open AI features.
To ignore the Topic automatically generated from the text in the document, set Tenant configuration Skip Topic Generation to Yes. This ensures only the Topic hierarchy provided in the document is used to associate with the Artifact in Knowledge Graph.
If none of the fields in the Knowledge template is marked as Artifact Summary and Automatical Summarization is not enabled for your tenant, Luma Knowledge identifies the content in the first heading of the document as the artifact summary automatically. For correct ontology generation, ensure that the document begins with the summary of the Knowledge Artifact.
Bulk Artifact Upload
In addition to creating artifacts one at a time, Curators or Administrators can create multiple artifacts with a single file upload. Luma Knowledge supports Bulk Artifact upload using Knowledge Templates and an excel file.
To upload multiple artifacts, follow the below steps:
Build Excel file for upload
Select the Knowledge Template for your artifacts. Note that all the artifacts are created based on the select Knowledge Template.
Based on the Knowledge Template, build your excel sheet. Each field in the template should be available as a column in the sheet.
Now add each artifact as a row in the sheet. The Import process creates an Artifact for each row in the sheet.
Upload file
Once the file is ready, you can upload the document and create the artifacts. To do so,
Navigate to Create Artifact → Import Documents.
Select Documents With Template as Source.
Click on Choose File(s) and browse to the required file.
Select Template to Map. The selected template is used to validate and map the text to the template fields for Artifact and Ontology generation.
Select a domain from the Domain list.
Click on Import Documents.
Luma Knowledge reads and creates artifacts for each row in the sheet. You can view the artifact creation status in the Import status.