There is an administrative user interface for configuring the relevancy models in your system. In order to use it, your project must include the module called "relevancy." If it is installed, you can view the Relevancy Administration UI by going to the Attivio Business Center UI and clicking the Manage Relevancy button. (You can also access the Relevancy Administration UI directly from the Admin UI's navigation bar by clicking the Relevancy Model Administration link.)
Working with Relevancy Features
The Relevancy Features page shows a list of all of the features defined in your Attivio system. Here you can create new features as well as modify or delete the existing ones. You can view the Relevancy Features page by clicking the View Relevancy Features button (
) at the top of either the Relevancy Models page or the Compare Relevancy Models page.
The list of features is in the main part of the page. When you select a feature, the inspector on the right side of the page shows the details about that feature, including its name, its type, and any type-specific parameters. For category boost features, the inspector also shows the current list of features that are generated from it based on the unique values in the feature-specified field in your index's documents. For example, if you have a category boost feature called "table_" that is defined with the field "table," you may see generated features called "table_customer," "table_order," and "table_metadata" if your index contains documents with the values "customer," "order," and "metadata" in the table field. (Note that the list of generated features at the time of a model being trained dictates which ones will have weights assigned to them; the values at the time the features page is displayed dictate which ones will appear in this list.)
| Item | Description |
|---|---|
| Icon | An icon for the feature appears in the top-left corner of the inspector. If the feature is statically defined, a lock icon is overlaid over the icon's bottom-left corner. |
| Name | This is the name of the feature. |
| Edit Button | The Edit button, an icon in the shape of a pencil ( ) lets you edit the properties of the model. |
| Inspector Menu | A pop-up menu with additional commands to use on the feature is available under the gear ( ) icon. The commands available here will depend on the properties of the feature — only commands applicable to the feature being displayed are shown. |
| Type | This is type type of the feature. The feature's type will determine the remaining information shown by the inspector. |
| Type-specific Properties |
|
You can filter the list to find the features you're interested in by either choosing a type of feature from the list on the left-hand side of the screen or by using the search box to enter part of the feature's name in the search box; click the magnifying glass icon (
) or press the enter key to perform the search.
Creating Relevancy Features
To create a new relevancy feature, see the documentation for each feature type:
Editing Relevancy Features
To edit a relevancy feature, select it in the list so that it appears in the inspector on the right-hand side of the window.
Note
You can use the type-based filtering links or the feature name search bar to help locate the feature you want to edit.
or
You can then click the Edit () button at the top of the inspector to open the Edit Relevancy Feature wizard where you can modify its values, similarly to when creating new features, except that the name of a feature cannot be edited.
Note
You cannot edit statically defined features (i.e., those defined in your project's configuration XML files). You can, however, copy a statically defined feature, as described below, and then modify the copy.
Copying Relevancy Features
To copy an existing relevancy feature, select it in the list so that it appears in the inspector on the right-hand side of the window. Then choose the Copy command from the inspector's menu (the gear icon). The Copy Relevancy Feature dialog appears in which you can enter a name for the new feature. Click the Copy button to complete the process. The new feature will appear in the list.
Deleting Relevancy Features
To delete an existing relevancy feature, select it in the list so that it appears in the inspector on the right-hand side of the window. Then choose the Delete command from the inspector's menu (the gear icon). Confirm the deletion in the resulting dialog box and the feature will be removed from the system. Any models which were using this feature will ignore any weight it may have had assigned.
Note
You cannot delete statically defined features (i.e., those defined in your project's configuration XML files).