Interact with Platform

Introduction

To interact with a Platform instance from Studio, you must first create a connection session to the Platform instance.

Note

The connection is dropped when Studio is closed, so you have to re-establish it when you start Studio again.

Once connected, you primarily interact with Platform projects using two tools:

The Platform Projects window
(If you previously linked the current Studio project module to Platform projects) The Project on Platform window

To open the Platform Projects window:

Select View Platform Projects on the main toolbar.

Or:

Select Studio > View Platform Projects on the main menu.

To open the Project on Platform window:

Select View Project on Platform on the main toolbar.

Or:

Select Studio > View Project on Platform on the main menu.

Manage projects

Sort projects

To change the sort order of projects, select a column heading. The first selection causes sorting on the values of the selected column, each further selection reverses the sorting order, from ascending to descending and vice versa.

Create a new Platform project

To create a Platform project based on your Studio project module:

Select Publish to new Platform project on the project list toolbar.
Type the project name under Name.
Select the technology version under Tech Version.

Note

The NL Core version is also reported with the technology version.
Select the project type from the Type of project drop-down menu.
Type an optional description under Description
Select Create.

You can see the operation progress:

Through the progress bar in the lower right corner of the Studio main window.

Or:

Under the Status column of the new project row.

Note

A gear icon indicates the operation progress.

Info

If your Studio project performs both extraction and categorization, you may need to create two Platform projects, a categorization project and an extraction project.

The new Platform project will contain:

In the case of a categorization project, the Studio project taxonomy and a generic library containing a "Welcome to Studio" sample document.
In the case of an extraction project, classes corresponding to Studio project templates and fields and a generic library containing a "Welcome to Studio" sample document.

Create and delete links

A link between your Studio project module and a Platform project, represented by the chain icon under the Linked column, is automatically created when you create a new Platform project from your Studio project module.

To manually link a Platform project to your Studio project module, select the Platform project from the list, then select Link Module on the project list toolbar.
To delete an existing link between your Studio project module and a Platform project, select the linked Platform project from the list, then select Delete Platform Link on the project list toolbar.

Info

Linked projects that have been deleted in Platform continue to be listed, with an "open chain" icon under the Linked column, in the Platform Projects window until you delete the link. You can't delete a Platform project from Studio.

To delete a link from the Project tool window:

Right-click in the tool window and select Platform Action > Unlink from Platform project.
Select Unlink.

Filter projects

To filter projects according to their type, select the type from the Type drop-down menu on the project list toolbar. Possible choices are:

All to show all types of projects identified by the "C" and "E" icons .
Categorization to show only categorization projects, identified by the "C" icon under the Type column.
Extraction to show only extraction projects, identified by the "E" icon under the Type column.

Open Platform projects

To open a linked Platform project, select the project, then select Open Platform project on the project list toolbar.

To open any project, double-click anywhere on the project row.

Refresh the list of projects

To refresh the list of Platform projects, select Refresh List on the project list toolbar.

View Platform project information

To show information about a linked Platform project, select View Platform Project Info . The Project on Platform window will appear.

Manage libraries

Sort libraries

To change the sort order of project libraries, select a column heading of the Libraries tab. The first selection causes sorting on the values of the selected column, each further selection reverses the sorting order, from ascending to descending and vice versa.

Upload a Studio library to a Platform project

To upload a Studio library to a Platform project:

Select the Platform project, then select Upload Studio library on the Libraries tab toolbar.

In the Studio Libraries dialog select an existing library.

Or:

Select Create Studio library .
Proceed as for importing a library.
When done, the new library is listed in Studio Libraries: select it.

The Studio Libraries dialog lists Studio project module libraries in a table with the following columns:

Name	Description
File	Library name
Description	Library description
Project	Project name
Module	Module name
Language	Language
Creation Date	Creation date and time
File Size	Library size
Test Files	Number of documents
Annotated Files	Number of annotated documents

Select the column headers to change the sort order.

Select Upload.
Type a name for the Platform project library and select Yes.

You can see the operation progress:

Through the progress bar in the lower right corner of the Studio main window.

Or:

Under the Status column.

Note

A gear icon indicates the operation progress.

The Platform library type will be "generic", so neither "training" nor "test".

To upload a library from the Project:

Right-click the .zip file and select Platform Actions > Upload Studio library. The Upload Library dialog will appear.
Select the module associated to your profile name in the Platform Project drop-down menu.
Give the library a name and select Upload. The upload will occur as a background task. At the end of the task, a notification will warn you.

All annotations found in the Studio library will be re-created in the Platform library.
Folders with more than 30000 files will be skipped and files greater than 500 KB will be ignored during Platform analyses.

Download a library from a Platform project

To download a library from a Platform project:

Select a Platform project then select one of its libraries.
Select Download Platform library on the Libraries tab toolbar.
In the dialog, type a name or accept the suggested one.
When documents are uploaded, the text that is analyzed and indexed can undergo changes such as merging consecutive spaces. To export texts with their original spacing, check Include original text spaced documents.
Select:
- All documents to download the entire library.
Or:
- Filtered documents to download the filtered document list based on annotated documents.

You can see the operation progress in the lower right corner of the Studio main window or in the Status column of the Libraries tab.
In the notification in the lower right corner, select Import Library to proceed with the library import.

Note

Once you select Import Library, you will be at the step 3 of the import procedure described in the dedicated page.

Refresh the list of libraries

To refresh the list of libraries for a Platform project, select the project from the list then select Refresh List on the Libraries tab toolbar.

Start an experiment on Platform

To start an experiment on Platform, using one of the project's CPKs:

Select a Platform project then select Experiment on Platform on the project list toolbar.
In the dialog, type an optional name for the Platform experiment corresponding to the analysis, then select a library and a CPK from the drop-down menus.
Select Start.

You can see the operation progress in the lower right corner of the Studio main window.
Inside the notification in the lower right corner of the main Studio window, select View on Platform to open experiment results inside Platform.

According to the experiment type—performed either on Studio or on Platform—the Type column will show these icons:

Icon	Name	Description
	Studio Model	Experiment based on a Studio CPK (both for categorization and extraction)
	Explainable Model	Experiment based on explainable model types (both for categorization and extraction)
	Bootstrapped Model	Experiment based on a simplified version of the Explainable Categorization engine

Manage models

Sort models

To change the sort order of project models, select a column heading of the Models tab. The first selection causes sorting on the values of the selected column, each further selection reverses the sorting order, from ascending to descending and vice versa.

Upload a model

Any CPK you deploy in Studio is a symbolic model you can upload to a Platform project. Once there, Platform users can make experiments with it and publish it to NL Flow to to use it in workflows.

To upload a CPK to a Platform project:

Select the destination Platform project:
- (Only if the current module of the Studio project has been linked to Platform projects) Open the Project on Platform window as described in the introduction and select the project from the Linked Project drop-down list.
Or:
- Open the Platform projects window as described in the introduction and select the project from the list. If the project if not linked, link it.
In the lower part of the window—either Platform Projects or Project on Platform—select the Models tab.
Select Update Platform project : the Studio cpk dialog will appear, showing the list of the CPK packages previously deployed under the package folder of the current Studio project module.
Select an existing CPK from the list.
If the list is empty or you want to use a fresh deployment select Deploy new package on the toolbar. The deployment procedure will start and at the end the newly created CPK will be listed.
Select Upload.

Or:

In the Project tool window open the package folder and then the cpk folder under it: the CPKs that have been previously deployed are shown.
Right-click a CPK file and select Platform Actions > Upload Studio cpk... on the context menu: a dialog appears.
Select the destination Platform project from the drop-down list and select Upload. Only linked projects are listed: select it.

If the destination is a categorization project, the upload operation adapts the resources of the Platform project to those of the CPK:

Categories that are only in the Platform project are deleted from the Platform project.

Warning

When excess categories are deleted, all their annotations in the entire Platform project are deleted too.
Categories that are only in the CPK are added to the Platform project.
If the label of a category in the Platform project differs from that of the CPK, the label of the category in the Platform project is made equal to that in the CPK.
Categories that have a different parent are moved in the Platform project so to have the same parent they have in the CPK.

During the upload operation a dialog will appear showing the preview of the taxonomy reconciliation activities. You can choose to cancel the upload operation at that point.

The upload operation is performed in the background. The progress is shown in the lower right corner of the Studio main window.

Download a model

To download a model from a Platform project and create a new Studio project out of it:

Select the Platform project.
Select the model then select Download Knowledge Model .

You can see the operation progress in the lower right corner of the Studio main window.
The model file will be downloaded in a sub-folder of the operating system temporary folder.
Inside the notification in the lower right corner of the main Studio window, select Create new Project to create a new Studio project out of the CPK.

Refresh the list of models

To refresh the list of models for a Platform project, select the project from the list, then select Refresh List in the Models tab toolbar.