搜图引擎Javasdk

groot 823e78658c Deprecate topK for search/hybridSearch/iterator, replaced with limit (#1438) 1 mēnesi atpakaļ
.github 9dd6d230f0 Add checkHealth/getPersistentSegmentInfo/getQuerySegmentInfo/transferNode interfaces (#1373) 3 mēneši atpakaļ
doc 96874ab954 Update doc (#1035) 11 mēneši atpakaļ
examples 823e78658c Deprecate topK for search/hybridSearch/iterator, replaced with limit (#1438) 1 mēnesi atpakaļ
sdk-bulkwriter 7bb6977653 Avoid an exception of LocalBulkWriter in Java 24 env (#1391) 2 mēneši atpakaļ
sdk-core 823e78658c Deprecate topK for search/hybridSearch/iterator, replaced with limit (#1438) 1 mēnesi atpakaļ
tests 98775b9029 Make CreateSchema() to be static (#1398) 2 mēneši atpakaļ
.gitignore 1044dc68d9 Change example code path (#1295) 5 mēneši atpakaļ
.gitmodules a14f8e93cd Split to 2 packages (#1224) 7 mēneši atpakaļ
CHANGELOG.md 9224f2fe90 Prepare for v2.6.0 (#1431) 1 mēnesi atpakaļ
CODE_REVIEW.md d041eef7f7 Add code review.md (#216) 3 gadi atpakaļ
CONTRIBUTING.md 38971b3c3c add CONTRIBUTING.md 5 gadi atpakaļ
DEVELOPMENT.md a14f8e93cd Split to 2 packages (#1224) 7 mēneši atpakaļ
LICENSE d986181d72 Initial commit 5 gadi atpakaļ
OWNERS 166b8381de Add maintainer member (#327) 3 gadi atpakaļ
README.md 9224f2fe90 Prepare for v2.6.0 (#1431) 1 mēnesi atpakaļ
docker-compose.yml ad315101c8 Support addCollectionField() (#1424) 1 mēnesi atpakaļ
pom.xml 9224f2fe90 Prepare for v2.6.0 (#1431) 1 mēnesi atpakaļ

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.10
2.6.x 2.6.0

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.6.0</version>
        </dependency>
    
  • Gradle/Groovy

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

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

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.6.0</version>
     </dependency>
    
  • Gradle/Groovy

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

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

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")
    ```