- Current stable version: 1.15.0
- Minimum JDK version: 1.6
This SDK provides two sets of APIs for image search and product discovery:
| API | Dashboard | Description |
|---|---|---|
| ViSearch | dashboard.visenze.com | Legacy image search API. Index images and search by image, color, or metadata. |
| Product Search | ms.console.rezolve.com | Modern product discovery API with catalog-level aggregation, recommendations, and visual analytics. |
Add the dependency for your build tool. Replace the version with the latest available.
Maven (pom.xml):
<dependency>
<groupId>com.visenze</groupId>
<artifactId>visearch-java-sdk</artifactId>
<version>1.15.0</version>
</dependency>Gradle (build.gradle):
compile 'com.visenze:visearch-java-sdk:1.15.0'SBT (build.sbt):
libraryDependencies += "com.visenze" % "visearch-java-sdk" % "1.15.0"// Default endpoint
ViSearch client = new ViSearch("access_key", "secret_key");
// Custom endpoint
ViSearch client = new ViSearch("https://custom-visearch.yourdomain.com", "access_key", "secret_key");For full documentation see docs/visearch-api.md.
// Default endpoint
ProductSearch api = new ProductSearch.Builder(APP_KEY, PLACEMENT_ID).build();
// AWS endpoint
ProductSearch api = new ProductSearch.Builder(APP_KEY, PLACEMENT_ID)
.useAws()
.build();
// Azure endpoint
ProductSearch api = new ProductSearch.Builder(APP_KEY, PLACEMENT_ID)
.useAzure()
.build();
// Custom endpoint
ProductSearch api = new ProductSearch.Builder(APP_KEY, PLACEMENT_ID)
.setApiEndPoint("https://custom.endpoint.example.com")
.build();APP_KEY and PLACEMENT_ID can be found in the Rezolve Console under your app's Integration section.
Available methods:
| Method | Description |
|---|---|
api.imageSearch(params) |
Search by image (URL, file, or image ID) |
api.multiSearch(params) |
Combine visual and text signals |
api.multiSearchAutocomplete(params) |
Autocomplete suggestions for multisearch |
api.outfitRecommendations(params) |
Find products that complete an outfit |
api.complementarySearch(params) |
Find products that complement a query product |
api.recommendations(params) |
Recommendations for a known product ID |
For full documentation see docs/product-search-api.md.