Skip to Content
Previous

Topic Detection example with SAPUI5

By Abdel DADOUCHE

Discover how to implement SAP Leonardo Machine Learning Foundation service in a SAPUI5 application

Details

You will learn

In this tutorial, you will learn how to quickly integrate the Topic Detection SAP Leonardo Machine Learning Functional Services published from the SAP API Business Hub sandbox in a SAPUI5 application.

The Topic Detection service allows you to extracts topics from documents and scores them according to the most relevant topics.

You will then be able to substitute the Topic Detection services with any other SAP Leonardo Machine Learning Functional Services that consumes text content.

Step 1: Get The API Sandbox URL And API Key

In order to consume the Topic Detection SAP Leonardo Machine Learning Foundation service, you will first need to get the service URI and your API key, request and response parameters.

Go to https://api.sap.com/.

SAP API Business Hub

Then you will be able to search for the SAP Leonardo Machine Learning - Functional Services, then click on the package found.

SAP API Business Hub

Select Inference Service for Topic Detection.

SAP API Business Hub

You can also access the page directly from the following address:

SAP API Business Hub

To get to your API Sandbox URL, click on the Details tab.

The API Sandbox URL should be:

https://sandbox.api.sap.com/ml/topicdetection

To get to your API key, click on the Show API Key button.

You will be prompted to login if you are not yet.

Then, the following pop-up should appear. Click on the Copy Key and Close button and save it in a text editor.

SAP API Business Hub
Please log in to access this content.
Step 2: Analyze the service

As you can notice the API has only one resource (or service): /topic-detection.

Now click on the /topic-detection link to expand the section.

Note: the term inference refers to the application phase (scoring) an existing model (as opposed to the training or inception phase) and sync for synchronous.

As stated in the description, the service accepts either:

  • an archive file with a zip/tar extensions containing multiple text files
  • a single text file
  • a list of text files as input

The service returns a list of detected topic with the associated keywords and scores (confidence).

The supported text file formats is plain text only.

The input file, files or archive file will be sent as a FormData query parameter in the service request.

A series of options are also required for the following parameters:

  • numTopics: Total number of topics to be detected
  • numTopicsPerDoc: Number of most relevant topics to be listed per document
  • numKeywordsPerTopic: Number of keywords to be listed per topic
  • numFeatures: Maximum number of keywords to be extracted from documents in total
Please log in to access this content.
Step 3: Access the SAP Cloud Platform Cockpit

Log into the SAP Cloud Platform Cockpit Neo Trial with your free trial account on Europe (Rot) - Trial and access Your Personal Developer Account.

Click on your SAP Cloud Platform Account identifier (which ends with trial by default) as highlighted on the below screenshot.

SAP Cloud Platform Cockpit

You are now in your SAP Cloud Platform developer account!

Your Personal Developer Account

If you are unclear with what is your SAP Cloud Platform account name, you can refer to the following blog entry: SAP Cloud Platform login, user name, account id, name or display name: you are lost? Not anymore!

Please log in to access this content.
Step 4: Configure your destination

You will need to create a destination in your SAP Cloud Platform account that allow will your applications to connect to external APIs such as the SAP API Business Hub.

On the left side bar, you can navigate in Connectivity > Destinations.

On the Destinations overview page, click on New Destination

Destinations

Enter the following information:

Field Name Value
Name sapui5ml-api
Type HTTP
Description SAP Leonardo Machine Learning APIs
URL https://sandbox.api.sap.com/ml
Proxy Type Internet
Authentication NoAuthentication

Then you will need to add the following properties to the destination:

Property Name Value
WebIDEEnabled true

Click on Save

New Destinations

You can use the Check Connectivity button HTML5 Applications next to the new Destination to validate that the URL can be accessed.

You should receive a connection established message with potentially a 404: Not Found response which is normal.

Please log in to access this content.
Step 5: Open the Web IDE

On the left side bar, you can navigate in Services, then using the search box enter Web IDE.

Web IDE

Click on the tile, then click on Go to Service.

Web IDE

You will get access to the SAP Web IDE main page:

Web IDE
Please log in to access this content.
Step 6: Create a project using the SAPUI5 template

Click on New Project from Template in the Create Project section or use the File > New > Project from Template.

Project

Select the SAPUI5 Application tile, then click on Next

Project

Enter the following information, then click on Next

Field Name Value
Project Name sapui5ml-topicdetection
Namespace demo
Project

Enter the following information, then click on Finish

Field Name Value
View Type XML
View Name demo
Project
Please log in to access this content.
Step 7: Extend the application resource roots

In order to ease the use of the provided code, we will add a new SAPUI5 resource roots. The main reason for this is that the rule used to generate the initial resource root by the project template has change many time over the time.

Edit the index.html file located under Workspace > sapui5ml > webapp and add the below element to the existing data-sap-ui-resourceroots property around line 15 (don’t forget the comma in between the existing element and the new one).

"sapui5ml": ""

It should eventually look something like this:

data-sap-ui-resourceroots='{"xxxx": "", "sapui5ml": ""}'

Click on the Save Button button (or press CTRL+S).

Please log in to access this content.
Step 8: Configure your SAPUI5 application

In order to use the previously configured destination, we need to add its declaration into the neo-app.json file along with the header white list configuration that will prevent HTTP header parameters to be filtered out.

Edit the neo-app.json file located under Workspace > sapui5ml-topicdetection and replace the current content with the below code.

Then click on the Save Button button (or press CTRL+S).

{
  "welcomeFile": "/webapp/index.html",
  "routes": [{
    "path": "/resources",
    "target": {
      "type": "service",
      "name": "sapui5",
      "entryPath": "/resources"
    },
    "description": "SAPUI5 Resources"
  }, {
    "path": "/test-resources",
    "target": {
      "type": "service",
      "name": "sapui5",
      "entryPath": "/test-resources"
    },
    "description": "SAPUI5 Test Resources"
  }, {
    "path": "/ml-dest",
    "target": {
      "type": "destination",
      "name": "sapui5ml-api"
    },
    "description": "ML API destination"
  }],
  "sendWelcomeFileRedirect": true,
  "headerWhiteList": [
    "APIKey"
  ]
}

Note: headerWhiteList

By default, headers element like the APIKey will be blocked when used in a SAPUI5 control like the FileUploader. This is the reason why we add it to the white list.

 

Please log in to access this content.
Step 9: Store your API setting in a JSON model

There are multiple options to achieve this goal. Here we will use a pre-loaded JSON model configured in the manifest.json file.

Create a new file named demo.json under Workspace > sapui5ml-topicdetection > webapp > model, copy the below code and make sure you replace <<<<< COPY YOUR API KEY >>>>> by your the API key we retrieved in step 2.

Then click on the Save Button button (or press CTRL+S).

{
  "url": "/ml-dest/topicdetection/topic-detection",
  "APIKey": "<<<<< COPY YOUR API KEY >>>>>",
  "options": {
    "numTopics": 3,
    "numTopicsPerDoc": 3,
    "numKeywordsPerTopic": 15,
    "numFeatures" : 20
  },
  "optionsJs": "{\"numTopics\":3,\"numTopicsPerDoc\":1, \"numKeywordsPerTopic\":15}"
}

Edit the manifest.json file located under Workspace > sapui5ml-topicdetection > webapp and locate the models section (around line 55), and update the section like this:

Then click on the Save Button button (or press CTRL+S).

"models": {
  "i18n": {
    "type": "sap.ui.model.resource.ResourceModel",
    "settings": {
      "bundleName": "demosapui5ml-topicdetection.i18n.i18n"
    }
  },
  "demo": {
    "type": "sap.ui.model.json.JSONModel",
    "preload": true,
    "uri": "model/demo.json"
  }
}
Please log in to access this content.
Step 10: Extend the main SAPUI5 view

The view will contain a table to display the results along with a canvas to display the selected image (if a single one is selected) and 2 buttons, one to import a snapshot and the other one to take snapshot using the webcam (if any, this button won’t be visible on mobile device because it is not supported).

Edit the demo.view.xml file located under Workspace > sapui5ml-topicdetection > webapp > view and replace the existing code with the below code.

Then click on the Save Button button (or press CTRL+S).

<mvc:View xmlns:html="http://www.w3.org/1999/xhtml" xmlns:mvc="sap.ui.core.mvc" xmlns:form="sap.ui.layout.form" xmlns:table="sap.ui.table"
	xmlns:u="sap.ui.unified" xmlns="sap.m" controllerName="sapui5ml.controller.demo" displayBlock="true">
	<App>
		<pages>
			<Page title="Topic Detection">
				<content>
					<Table>
						<columns>
							<Column vAlign="Middle"/>
							<Column vAlign="Middle"/>
						</columns>
						<items>
							<ColumnListItem >
								<cells>
									<Label text="Total number of topics to be detected"/>
									<StepInput value="{demo>/options/numTopics}" required="true"/>
								</cells>
							</ColumnListItem>
							<ColumnListItem>
								<cells>
									<Label text="Number of most relevant topics to be listed per document"/>
									<StepInput value="{demo>/options/numTopicsPerDoc}" required="true"/>
								</cells>
							</ColumnListItem>
							<ColumnListItem>
								<cells>
									<Label text="Number of keywords to be listed per topic"/>
									<StepInput value="{demo>/options/numKeywordsPerTopic}" required="true"/>
								</cells>
							</ColumnListItem>
							<ColumnListItem>
								<cells>
									<Label text="Maximum number of keywords to be extracted from documents in total"/>
									<StepInput value="{demo>/options/numFeatures}"/>
								</cells>
							</ColumnListItem>
						</items>
					</Table>
					<VBox width="100%" direction="Column" alignItems="Center">
						<Carousel pages="{demo>/result}" width="100%" visible="{= ${demo>/resultVisible} === true}">
							<pages>
								<VBox width="100%" direction="Column" alignItems="Center">
									<ScrollContainer height="100%" width="100%" horizontal="true" vertical="true" focusable="true">
										<Label text="File name: {demo>name}" class="sapUiLargeMargin"></Label>
										<table:Table rows="{demo>topics}" enableBusyIndicator="true" selectionMode="Single" visibleRowCount="5">
											<table:columns>
												<table:Column sortProperty="rank" filterProperty="rank">
													<Label text="Topic id"/>
													<table:template>
														<Text text="{demo>id}"/>
													</table:template>
												</table:Column>
												<table:Column sortProperty="rank" filterProperty="rank">
													<Label text="Rank"/>
													<table:template>
														<Text text="{demo>rank}"/>
													</table:template>
												</table:Column>
												<table:Column sortProperty="score" filterProperty="score">
													<Label text="Score"/>
													<table:template>
														<Text text="{demo>score}"/>
													</table:template>
												</table:Column>
												<table:Column>
													<Label text="Keywords"/>
													<table:template>
														<Text text="{demo>keywords}"/>
													</table:template>
												</table:Column>
											</table:columns>
										</table:Table>
									</ScrollContainer>
								</VBox>
							</pages>
						</Carousel>
					</VBox>
				</content>
				<footer>
					<Toolbar width="100%">
						<content>
							<u:FileUploader id="idFileUpload" buttonOnly="true" buttonText="Upload Text File Archive" name="files" uploadUrl="{demo>/url}"
								sameFilenameAllowed="true" useMultipart="true" sendXHR="true" uploadOnChange="true" accept="zip,tar" change="fileUploadChange"
								uploadComplete="fileUploadComplete">
								<u:headerParameters>
									<u:FileUploaderParameter name="APIKey" value="{demo>/APIKey}"/>
									<u:FileUploaderParameter name="Accept" value="application/json"/>
								</u:headerParameters>
								<u:parameters>
									<u:FileUploaderParameter name="options" value="{demo>/optionsJs}"/>
								</u:parameters>
							</u:FileUploader>
						</content>
					</Toolbar>
				</footer>
			</Page>
		</pages>
	</App>
</mvc:View>

Please log in to access this content.
Step 11: Extend the main SAPUI5 controller

Edit the demo.controller.js file located under Workspace > sapui5ml-topicdetection > webapp > controller and replace the existing code with the below code.

Then click on the Save Button button (or press CTRL+S).

sap.ui.define([
  "sap/ui/core/mvc/Controller",
  "sap/m/MessageBox",
  "sap/m/Image"
], function(Controller, MessageBox, Image) {
  "use strict";
  return Controller.extend("sapui5ml.controller.demo", {

    fileUploadChange: function(oControlEvent) {
      // get the current view
      var oView = this.getView();

      // start the busy indicator
      var oBusyIndicator = new sap.m.BusyDialog();
      oBusyIndicator.open();

      // generate the options and stringify
      var options = {
        "numTopics": oView.getModel("demo").getProperty("/options/numTopics"),
        "numTopicsPerDoc": oView.getModel("demo").getProperty("/options/numTopicsPerDoc"),
        "numKeywordsPerTopic": oView.getModel("demo").getProperty("/options/numKeywordsPerTopic"),
        "numFeatures": oView.getModel("demo").getProperty("/options/numFeatures")
      };
      oView.getModel("demo").setProperty("/optionsJs", JSON.stringify(options));

      // keep a reference in the view to close it later
      this.oBusyIndicator = oBusyIndicator;
    },
    fileUploadComplete: function(oControlEvent) {
      // get the current view
      var oView = this.getView();

      if (oControlEvent.getParameters().status === 200) {
        // get the resvice respnse as JSON
        var oTopicDetection = JSON.parse(oControlEvent.getParameters().responseRaw).topicDetection;

        // create a JSON model
        var documents = new Array(oTopicDetection.length);
        for (var iTopicDetection = 0; iTopicDetection < oTopicDetection.length; iTopicDetection++) {
          var oTopicDetectionDocument = {
            "name": oTopicDetection[iTopicDetection].docName
          };
          oTopicDetectionDocument.topics = [];

          for (var iTopics = 0; iTopics < oTopicDetection[iTopicDetection].topics.length; iTopics++) {
            var oTopicDetectionTopic = {
              "rank": iTopics,
              "id": oTopicDetection[iTopicDetection].topics[iTopics],
              "score": oTopicDetection[iTopicDetection].scores[iTopics],
              "keywords": oTopicDetection[iTopicDetection].keywords[iTopics]
            };
            oTopicDetectionDocument.topics.push(oTopicDetectionTopic);
          }
          documents.push(oTopicDetectionDocument);
        }
        oView.getModel("demo").setProperty("/result", documents);
        // display the result table
        oView.getModel("demo").setProperty("/resultVisible", true);
      } else {
        oView.getModel("demo").setProperty("/resultVisible", false);
        MessageBox.show("Error " + oControlEvent.getParameters().status + " : " + JSON.parse(oControlEvent.getParameters().responseRaw).error_description);
      }
      this.oBusyIndicator.close();
    }
  });
});
Please log in to access this content.
Step 12: Test the application

Click on the Run icon Run Applications or press ALT+F5.

In the bar at the bottom, click on Upload Text File Archive to pick your local zip archive that contains plain text files.

The service will be called, and the result displayed in a table.

Result
Please log in to access this content.
Step 13: Validation

Provide an answer to the question below then click on Validate.

What message is displayed if you run the topic detection application with only 2 documents in the
archive but requesting 4 as a total number of detected topics?
×
Step 14: Project files

In case you are having problems when running the application, the complete project code can be found on the SAP Tutorial public GitHub repository.

However, this is not a repository you can clone and run the code.

You have to import the sapui5ml-imageclassifier directory content into your existing project directory.

Make sure you check the LICENSE before starting using its content.

Please log in to access this content.

Next Steps

Updated 08/22/2018

Time to Complete

15 Min

Beginner

Next Steps

Next
Back to top