搜图引擎Javasdk

groot 6c2eab8242 Bump com.google.protobuf:protobuf-java from 3.24.0 to 3.25.5 (#1073) (#1385) 2 mesiacov pred
.github fa514edce6 Add checkHealth/getPersistentSegmentInfo/getQuerySegmentInfo/transferNode interfaces (#1372) 3 mesiacov pred
doc 96874ab954 Update doc (#1035) 11 mesiacov pred
examples ce2c862f83 Prepare for v2.5.8 (#1376) 3 mesiacov pred
sdk-bulkwriter 0ac1c8e57f Add options parameter for bulk_import interface (#1362) 3 mesiacov pred
sdk-core c7790278c9 Fix a bug that index property was not correctly passed (#1378) 2 mesiacov pred
tests 6c2eab8242 Bump com.google.protobuf:protobuf-java from 3.24.0 to 3.25.5 (#1073) (#1385) 2 mesiacov pred
.gitignore b452c61651 Change example code path (#1294) 5 mesiacov pred
.gitmodules d7a0fba84a Split to 2 packages (#1223) 7 mesiacov pred
CHANGELOG.md ce2c862f83 Prepare for v2.5.8 (#1376) 3 mesiacov pred
CODE_REVIEW.md d041eef7f7 Add code review.md (#216) 3 rokov pred
CONTRIBUTING.md 38971b3c3c add CONTRIBUTING.md 5 rokov pred
DEVELOPMENT.md d7a0fba84a Split to 2 packages (#1223) 7 mesiacov pred
LICENSE d986181d72 Initial commit 5 rokov pred
OWNERS 166b8381de Add maintainer member (#327) 3 rokov pred
README.md ce2c862f83 Prepare for v2.5.8 (#1376) 3 mesiacov pred
docker-compose.yml 34500d3925 Fix a bug of nullable Array type (#1366) 3 mesiacov pred
pom.xml 6c2eab8242 Bump com.google.protobuf:protobuf-java from 3.24.0 to 3.25.5 (#1073) (#1385) 2 mesiacov pred

README.md

Milvus Java SDK

Maven Central

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

The following table shows compatibilities between Milvus and Java SDK.

Milvus version Java SDK version
2.0 2.0.4
2.1 2.1.0-beta4
2.2.0 ~ 2.2.8 2.2.0 ~ 2.2.5
>= 2.2.9 2.2.7 ~ 2.2.15
2.3.x 2.3.11
2.4.x 2.4.11
2.5.x 2.5.8

Install Java SDK

You can use Apache Maven or Gradle add Milvus SDK to your project.

  • Apache Maven

        <dependency>
            <groupId>io.milvus</groupId>
            <artifactId>milvus-sdk-java</artifactId>
            <version>2.5.8</version>
        </dependency>
    
  • Gradle/Groovy

    ```groovy
    implementation 'io.milvus:milvus-sdk-java:2.5.8'
    ```
    
  • Gradle/Kotlin

    ```kotlin
    implementation("io.milvus:milvus-sdk-java:2.5.8")
    ```
    

From v2.5.2, milvus Java SDK is split into two packages: milvus-sdk-java and milvus-sdk-java-bulkwriter, because BulkWriter requires quite a lot of dependencies. If you don't need BulkWriter tool, you can ignore the milvus-sdk-java-bulkwriter package. To use BulkWriter, import milvus-sdk-java-bulkwriter to your project.

  • Apache Maven

     <dependency>
         <groupId>io.milvus</groupId>
         <artifactId>milvus-sdk-java-bulkwriter</artifactId>
         <version>2.5.8</version>
     </dependency>
    
  • Gradle/Groovy

     implementation 'io.milvus:milvus-sdk-java-bulkwriter:2.5.8'
    
  • Gradle/Kotlin

     implementation("io.milvus:milvus-sdk-java-bulkwriter:2.5.8")
    

Examples

Please refer to examples folder for Java SDK examples.

Documentation

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 to download the required jar files.

- Apache Maven

    ```xml
     <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
         <version>1.7.30</version>
     </dependency>
    ```

- Gradle/Groovy

     ```groovy
     compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.30'
     ```
- Gradle/Kotlin

    ```kotlin
    implementation("org.slf4j:slf4j-api:1.7.30")
    ```