Showcase #

Content #

For the user documentation go to: Explainable Similarity Detector - User Documentation

Demo Video #

Download video from GitHub

Login #

At the login page you can either login with your existing credentials, then you can land on the Similarity Search page or you can register with new credentials and land on the Registration page.

Registration #

Here you can register with new login data. You can either sign up as user with the button Register As User or as admin with the button Register As Admin. Now you can go back to the Login page and log in with the new credentials.

Similarity Search #

The Similarity Search page is the main page for the similarity search.

To do a similarity search follow the steps below:

1. Select the desired component type from the dropdown field Component Type. In this example Capacitors.
2. To search for a specific component name enter the name or a substring in the Component Name field. To get suggestions for all available names leave the field empty and click directly on the ▷ Start Similarity Search button. In this example we searched for _2 which returns all names that contain the substring _2.
3. In the popup you can select the name of the component with the Use button. You can load further suggestions if you click on the Load more... button. In this example we selected the component name Capacitor_23.

To start the similarity search click on the ▷ Start Similarity Search button.
The results found are then displayed in the Search Results table below.

The left column (Component IDs) contains the IDs of the component.
The similarity type column contains the similarity types sorted in descending order by the degree of similarity. The following table shows the similarity degree sorted in descending order where A/Upgrade has the highest degree and C the lowest:

• A/Upgrade
• A
• A/Downgrade
• B/Upgrade
• B
• B/Downgrade
• C

The third column Difference In lists the differences between the two components.

On the righthand side there are three buttons.

• Info button: Show all attributes for this component (see: Show All Attributes)
• PDF button: Show manufacturer data sheet
• Edit button: Edit similarity type or comment (No functionality stored for this button at this time)

Apply Filters #

1. To apply filters you add first an attribute to the Attribute field. In the Attribute section it is explained in more detail.
2. Select the comparison operator in the Operator dropdown.
3. Enter a value in the Value field.

If you are fine with the filter you can click on the + button.

Attribute #

This field has an auto complete. If you type for example he it complete it to height if you use the Tab key.

Now your added filters are applied and saved in the Currently added filters list. On the top left you can see, that 1 filter was applied.
On the right you can edit or delete individual filters.
You can also remove all filters with the Remove all filters button.

If all filters you want are applied click on the ▷ Start Similarity Search button to start the similarity search with the applied filters.
In this case, all components similar to Capacitor_23 are searched that have a height > 2.

The output of the similarity search is displayed in the table below:

You can see more information for the request in the collapsible Properties section.
For example that it took 1.16 seconds to perform the similarity request. Also the used request URL is displayed: https://apim-similarity-detector.azure-api.net/v1/componentTypes/resistors/21/similarities/?differenceInAsString=true&ordering=type.

Show All Attributes #

With a click on the i button you can see all available attributes for the actual component compared with the similar component in the Detailed View Component popup.

In the left column is the name of the attribute.
The column in the middle Component 1 is the capacitor you searched for (in this example Capacitor_23). The right column Component 2 is the similar component in the list that is compared to the Component 1.

Add Similarity Suggestion #

To add a missing similarity suggestion for existing components or edit existing suggestions you can use the Suggest Similar Component button. It opens the Add Match to component Database popup.

Add New Component (Select Component Type) #

To add a complete new component click on the Add New Component button. It opens the Select Component Type popup where you can select the type of the component you want to add. Click then on the ✓ Go button. Now it opens the Add New Component popup.

Add New Component #

To add the new component and add a name (required) and the other optional attributes. When you are done click on the Save button.

The added component will saved in the Mendix Database. If the Admin approves it on the Added Components page it will be send to the real database. This ensures that only valid data will be send to the real database.

Added Component Page #

The page Added Components shows an overview over the Added Similarities and Added Components.

Here you can edit delete or send the items to the real database. You can also send all entries in the list to the database with the Send all to database button.