nyris is a high performance visual product search, object detection and visual recommendations engine for retail and industry.
For more information please see nyris.io
We provide a new SDK with better error handling and reactive programming support. The SDK is written in Kotlin and compatible with Java.
The old SDK is offering only image matching services and based on asynchronous callback system. This new SDK offers:
- Support of Reactive programming paradigm
- No more asynchronous callback/asyncTask
- Better multithreading handling
- Better error handling
- Type-safe HTTP client
- Unified response
- All the different nyris services
We offer :
- Visual search
- Similarity search by image
- Object detection
- Manual matching
- Text Search
- Similarity search by SKU
- Android >= 4.0
- Images in JPEG format
- The minimum dimensions of the image are
512x512 px - The maximum size of the image is less than or equal to
500 KB
Add the dependencies
repositories {
maven {
url "https://dl.bintray.com/nyris/maven"
}
}
dependencies {
implementation 'io.nyris:sdk:1.x.x'
implementation "android.arch.lifecycle:extensions:1.x.x" //Optional
}- Get instance
- Destroy the instance
- Match your first image
- Extract objects from your image
- Mark sent image as not found
- Text Match Search
- Dex Count Methods Info
First, initialize an instance of INyris with your API Key :
java
class DemoApp{
private INyris nyris;
@Override
public onCreate(){
nyris = Nyris.createInstance("YOUR_API_KEY");
// OR
nyris = Nyris.createInstance("YOUR_API_KEY", /*Enable debug output*/true);
}
public INyris getNyrisInstance(){
return nyris;
}
}kotlin
class DemoApp : Application(){
private var nyris : INyris
override fun onCreate() {
super.onCreate()
nyris = Nyris.createInstance(BuildConfig.API_KEY, true)
// OR
nyris = Nyris.createInstance("YOUR_API_KEY", /* Enable debug output */true)
}
}You can easily free all the created instances by adding nyris to the lifecyle of your main activity
or by calling destroy() of the sdk
kotlin
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_sample)
lifecycle.addObserver(nyris)
}
// OR
override fun onDestroy(){
super.onDestroy()
nyris.destroy()
}
}NOTE : to make the SDK fully compatible with lifecycle-aware components you will need to add the missing dependecy
dependencies {
implementation "android.arch.lifecycle:extensions:1.x.x"
}java
byte[] imageByteArray = /*Your byte array*/;
nyris
.imageMatching()
.match(imageByteArray)
.subscribe(offerResponseBody -> {
// Handle your response
List<Offer> offers = offerResponseBody.offers
}, throwable -> {
if(throwable instanceof HttpException){
...
}else if(throwable instanceof IOException){
...
}else {
// Unknown
}
});kotlin
val imageByteArray : ByteArray = /*Your byte array*/
nyris
.imageMatching()
.match(imageByteArray)
.subscribe({/*it:OfferResponseBody*/
// Handle your response
val offers = it.offers
},{/* it:Throwable */
when (it) {
is HttpException -> {
...
}
is IOException -> {
...
}
else -> {
// Unknown
}
}
})kotlin
//For more details about available feed attributes please check our documentation : http://docs.nyris.io/#available-feed-attributes.
val imageByteArray : ByteArray = /* Your byte array */
nyris
.imageMatching()
.outputFormat("PROVIDED_OUTPUT_FORMAT") // Set the desired OUTPUT_FORMAT
.language("de") // Return only offers with language "de".
.exact({
enabled = false // disable exact matching
})
.similarity({//Performs similarity matching
threshold = 0.5F // The lower limit of confidences to be considered good from similarity
limit = 10 // The upper limit for the number of results to be returned from similarity
})
.ocr({//Performs optical character recognition on the images
enabled = false // disable OCR
})
.regroup({
enabled = false // This mode enables regrouping of the items
threshold = 0.5F // The lower limit of confidences to be considered good from similarity
})
.recommendations() // Enables recommendation type searches that return all discovered results regardless of their score.
.categoryPrediction({
enabled = true // Enables the output of predicted categories.
threshold = 0.5F // Sets the cutoff threshold for category predictions (range 0..1).
limit = 10 // Limits the number of categories to return.
})
.limit(10) // Limit returned offers
.match(imageTestBytes)
.subscribe({/* it:OfferResponseBody */
// Handle your response
val offers = it.offers
},{/* it:Throwable */
...
})The response is an object of type OfferResponseBody that contains list of offers.
- If you specified a custom output format, you should use this call to get response as
JSONformat :
kotlin
val imageByteArray : ByteArray = /*Your byte array*/
nyris
.imageMatching()
.match<JsonResponseBody>(imageByteArray, JsonResponseBody::class.java)
.subscribe({/* it:JsonResponseBody */
// Handle your response
val json = it.json
},{/*it:Throwable*/
...
})Extract objects from an image
kotlin
nyris
.objectProposal()
.extractObjects(imageByteArray)
.subscribe({/* it:List<ObjectProposal> */
// Handle your response
val objects = it
},{/* it:Throwable */
...
})Returned response is a List of ObjectProposal.
The extracted object has:
confidenceis the probability of the top item. Value range between :0-1.regionis a Bounding box. It represents the location and the size of the object in the sent image.
It may happen that our service can't recognize or match an image. This is why we provide you a service to notify us about the unrecognized image.
Before you mark an image as not found, you will need to extract the requestId.
kotlin
nyris
.imageMatching()
.match<OfferResponse>(imageByteArray, OfferResponse::class.java)
.subscribe({/* it:OfferResponse */
// Handle your response
requestId = it.getRequestId()
},{/* it:Throwable */
...
})After getting the requestId you can mark the image as not found.
kotlin
nyris
.notFoundMatching()
.markAsNotFound(requestId)
.subscribe({/* it:ResponseBody */
...
},{/* it:Throwable */
...
})nyris offers a service that helps you to search offers by text, SKU, barcode, etc.
you can use the text search service the same way as image matching service
kotlin
nyris
.textSearch()
.searchOffers("YOUR_TEXT")
.subscribe({/*it:OfferResponseBody*/
// Handle your response
val offers = it.offers
},{/* it:Throwable */
...
})kotlin
nyris
.textSearch()
.outputFormat("PROVIDED_OUTPUT_FORMAT") // Set the desired OUTPUT_FORMAT
.language("de") // Return only offer with language "de"
.regroup({
enabled = true // This mode enables regrouping of the items
threshold = 0.5F // The lower limit of confidences for the regroup
})
.limit(10) // Limit returned offers
.searchOffers<JsonResponseBody>("YOUR_TEXT", JsonResponseBody::class.java)
.subscribe({/* it:JsonResponseBody */
//Handle your response
val json = it.json
},{/* it:Throwable */
...
})The dex count for the SDK is around 580 methods which mean around 1% of 64k methods Limit.
Total methods in library: 652 (0.99% used)
Total fields in library: 265 (0.40% used)
Total classes in library: 136 (0.21% used)
Copyright 2018 nyris GmbH
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.