Skip to content

Latest commit

History

482 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

ViSearch Java SDK

Coverage Status


  • Current stable version: 1.15.0
  • Minimum JDK version: 1.6

This SDK provides two sets of APIs for image search and product discovery:

APIDashboardDescription
ViSearchdashboard.visenze.comLegacy image search API. Index images and search by image, color, or metadata.
Product Searchms.console.rezolve.comModern product discovery API with catalog-level aggregation, recommendations, and visual analytics.

Setup

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"

Quick Start

ViSearch API

// Default endpointViSearchclient = newViSearch("access_key", "secret_key");
// Custom endpointViSearchclient = newViSearch("https://custom-visearch.yourdomain.com", "access_key", "secret_key");

For full documentation see docs/visearch-api.md.

Product Search API

// Default endpointProductSearchapi = newProductSearch.Builder(APP_KEY, PLACEMENT_ID).build();
// AWS endpointProductSearchapi = newProductSearch.Builder(APP_KEY, PLACEMENT_ID)
.useAws()
.build();
// Azure endpointProductSearchapi = newProductSearch.Builder(APP_KEY, PLACEMENT_ID)
.useAzure()
.build();
// Custom endpointProductSearchapi = newProductSearch.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:

MethodDescription
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.

About

No description, website, or topics provided.

Resources

Stars

8 stars

Watchers

17 watching

Forks

Releases

Packages

Used by

Contributors

Languages