sahuang/milvus-sdk-java

Milvus is an open source vector search engine.

JavaApache-2.0

Milvus Java SDK

Java SDK for Milvus. To contribute to this project, please read our contribution guidelines first.

Getting started

Prerequisites

-   Java 8 or higher
-   Apache Maven or Gradle/Grails

The following table shows compatibilities between Milvus and Java SDK.

Milvus version	Java SDK version
0.10.1	0.8.3
0.10.0	0.8.2
0.9.1	0.8.1
0.9.0	0.8.0
0.8.0	0.7.0
0.7.1	0.6.0
0.7.0	0.5.0
0.6.0	0.4.1
0.5.3	0.3.0

Install Java SDK

You can use Apache Maven or Gradle/Grails to download the SDK.

Apache Maven

 <dependency>
     <groupId>io.milvus</groupId>
     <artifactId>milvus-sdk-java</artifactId>
     <version>0.8.3</version>
 </dependency>

Gradle/Grails

compile 'io.milvus:milvus-sdk-java:0.8.3'

Examples

Please refer to examples folder for Java SDK examples.

Documentation

Javadoc

Troubleshooting

If you encounter the following error when running your application:
```
Exception in thread "main" java.lang.NoClassDefFoundError: org/slf4j/LoggerFactory
```
This is because SLF4J jar files need to be added into your application's classpath. SLF4J is required by Java SDK for logging purpose.

To fix this issue, you can use Apache Maven or Gradle/Grails to download the required jar files.
- Apache Maven
```
 <dependency>
     <groupId>org.slf4j</groupId>
     <artifactId>slf4j-api</artifactId>
     <version>1.7.30</version>
 </dependency>
```
- Gradle/Grails
```
compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.30'
```