Skip to main content

📁 Setting up the catalog

A catalog is a collection of all the items that your organization offers. It needs to contain all the data required or the image recognition process.

To set up a catalog, you will need to create a new item for each entry in your catalog. Each item in the Neurolabs Catalog will receive its own unique identifier (UUID). However, we support two main fields that you might use to synchronize your catalog with the Neurolabs Catalog: a barcode field and a custom ID field. Each item should be accompanied by a thumbnail image representing the item, and ideally, a 3D asset of the item. Furthermore, you can add information such as brand, container type and size as properties of items, as well as the dimensions.

Here are the steps to set up a catalog:

Step 1: Gather information about your items​

Before you can set up your catalog, you need to gather information about all the items you want to include in it. This information must include:

  • Name
  • Thumbnail

Optionally, but strongly recommended, it should also include:

  • Barcode
  • 3D asset of the item or the images required to build a 3D asset, such as a print label.
  • Brand

❗The minimum required fields for creating an item are a name identifier and a thumbnail.

Step 2: Create a new item for each entry in your catalog​

Once you have all the information about your items, you can start creating new item for each entry in your catalog. This can be done through the web interface or programmatically through API.

Step 3: Upload 3D assets or image data​

For each item, you should upload 3D asset. In the event in which you don't have access to a 3D asset, we can build one for you, provided that you supply us the necessary image data. Images can be uploaded on the web interface or directly through the API by including them in the payload of the POST request.

See openapi docs for more details.

Step 4: Test and validate your catalog​

Once your catalog is set up, you should test it to make sure all the items have been added correctly. You can do this by visualizing the items online through the web platform. Alternatively, all catalog data should be available via APIs.

✔️ You should validate that all the items details are correct and that the barcode matches the thumbnail and 3D asset data.

Step 5: Keep your catalog up to date​

Your catalog is an ongoing project, you will need to keep it up to date as your items change. You can use the web interface to keep items updated or through APIs.

❗ Make sure that you always keep your catalog up to date, as it will be crucial for the accuracy of the Tasks and the success of your project.