If you have Custom Supervision tasks in your flows, and you would like your keyers to be able to select from a validated list of items in a particular Custom Supervision task, you can store those items in the Knowledge Store in the Hyperscience application. For example, if a task requires a keyer to select the name of the employee that a particular form relates to, you can store a list of your employees in the Knowledge Store. Then, you can configure the Custom Supervision task to display each employee's name as a potential choice.
You can think of the Knowledge Store as a database that you can retrieve data from without having to connect to an external data source via a Custom Code Block. You define the schema, or list of properties, for each type of item you want to store in the Knowledge Store. Each type of item is called a collection (e.g., Employees, Offices, Addresses).
Knowledge Store limitations
As you add items to the Knowledge Store and configure your Custom Supervision tasks, keep the following limitations in mind.
Collections, items, and properties
You can have up to 100 collections.
Each item can have up to 100 properties.
You can store up to 1 million items in the Knowledge Store.
Use cases
The Knowledge Store can only be used to enrich or validate data during Custom Supervision tasks. If you want keyers to perform data validation during other Supervision tasks, you can configure your flow to retrieve data from an external data source (e.g., via a Custom Code Block, Database Block, etc.).
Custom Supervision tasks
When a keyer searches for an item during a Custom Supervision task, up to 50 results are returned.
Data validations
As you add items to the Knowledge Store, the application does not perform data validations on the item to ensure that its structure matches that of other items in the collection. To prevent unexpected behavior in decisions during Custom Supervision tasks, ensure that each item in a collection has the same structure.
Viewing a collection’s items
To view the items in a collection, click on Storage in the left-hand sidebar of the application, and click on the name of the collection whose items you want to view.
Modifying a collection's items / Creating a new collection
In the application, you can add and edit collections of items by uploading their data in CSV format.
If the uploaded CSV file for a collection contains items not currently stored in the collection, those items will be added to the collection.
If the uploaded CSV file for a collection contains different versions of items currently stored in the collection, those items will be updated with the data in the CSV file.
Each uploaded CSV file can contain a maximum of 10,000 rows.
You can delete collections, but not individual items, in the application. Individual items must be deleted via our API. The Knowledge Store API endpoints also allow you to modify Knowledge Store data at the item level rather than the collection level. To learn more, see our API documentation.
To modify a collection’s items or create a collection in the application:
Create a CSV file that has one row for each item and one column for each property. The header row (first row) must have external_id in the first column. Each item’s external_id should match the item’s ID in the external data source (“source of truth”) where you’re currently storing the item’s data at your organization (e.g., record numbers, SKUs). Each of the following columns in the header row must contain the name of a property.
Example
If you had Name and Country properties, your CSV might look like the one shown below.
external_id
name
country
1234
Sam Steele
USA
1235
Pat O’Malley
Ireland
In the application, click Storage in the left-hand sidebar, and then click Import.
In the dialog that appears, enter the name of the collection that you want to create or modify in the Apply Collection Definition text box.
If you currently have collections, collection names that match your entered text will appear under the text box. Click on a collection name to select it.
Do one of the following:
Drag and drop the collection’s CSV file into the dialog box.
Click Choose Files, and find and open the collection’s CSV file on your machine.
Click Upload.
If the upload was successful, a confirmation message appears, letting you know how many rows (items) were processed. If the upload was not successful, an error message appears.
Click Done.
Deleting a collection
To delete a collection in the application:
Click Storage in the left-hand sidebar, and click the trash can icon (
) in the collection’s row in the table.In the confirmation dialog, click Delete.
Configuring Custom Supervision tasks to use Knowledge Store data
You can integrate Knowledge Store data into Search components of Custom Supervision tasks. Keyers can then search for the item that they would like to choose for relevant fields.
For more information, see our Flows SDK documentation.