About the Slyce SDK
The Slyce SDK allows you to build visual search, image matching, and barcode detection into your company's applications. The power of the Slyce SDK comes from our ability to ingest your companies product catalog and return results based on your products. The Slyce SDK uses a combination of on-device detectors and cloud-based operations to ensure quick and accurate results. Those workflows can be configured based on your use cases.
The Slyce SDK functions in three modes Full UI Mode, Tap Animation Mode, Headless mode. Full UI Mode allows you to quickly stand up an app to show your teams the power of visual search. The Full UI Mode is also fully customizable to ensure that the look and feel match your app. The Tap UI mode allows you to utilize the SlyceLensView which includes tap to search, and animations on over the camera. Using the SlyceLensView allows you to build your UI over the Slyce camera. The third mode is the headless mode which allows you to utilize the power of Slyce's computer vision and maintain full control of the user interface of your app. In the headless mode, you can initiate a Slyce visual search workflow with an image or utilize Slyce's on-device continuous barcode and image matching scanners and get product matches from your catalog.
As a developer working with the Slyce SDK, you will not need to set up your account, space, workflow, dataset, lens, or extension layer, but you will need to know the meaning of each. A Slyce solutions engineer will set up your account, space, workflow, dataset, lens, and extensions layers as needed and provide you with the keys to link your app.
An account represents the context in which all Slyce operations can be configured, managed, and performed. Accounts will be created and configured by Slyce solutions engineers. Your API key will be linked to your account, and define your access to spaces.
An account owns a space, and we recommend mapping one space to one cross-platform application. For example, you would utilize a space that would link to an Android and iPhone application and which use the same product catalog (dataset). Spaces are created and configured by Slyce solutions engineers. They are identified within the system by a unique system-generated “space id” and an account-wide unique user-defined “space name.”
Datasets are helpful when it is desirable to partition searchable data into isolated groups. Examples, when this might be useful, include splitting data by regions, distinct product feeds, inventory for special events, and more.
Workflows define the visual search processing steps a submitted image will go through in order to return the most relevant results quickly. A workflow configuration is loaded when the Slyce instance is initialized and contains all the information to render the appropriate views in full UI mode. In headless mode, you will select the appropriate workflow and utilize that when starting visual search operations. A workflow is identified within the system by an account-wide unique workflow name and referenced by an automatically generated account-wide unique workflow ID.
Lenses (Full UI Mode)
A lens defines the device level functionality and features based on the types of operations available in a workflow. Lenses help optimize the detection process by performing more simple detection on the device when available. For example, barcode scanning can be done natively on both Android and iOS, so when a workflow includes barcode scanning in a workflow, it will enable the barcode scanning lens on the device which will continuously scan the image for barcodes.
Extension Layers (Full UI Mode)
Layers are a way to define how results and other information is displayed information is successfully returned. Examples of Layers could be a product results page or a search history panel.