Package io.milvus.param.dml

Class SearchIteratorParam.Builder

    • Method Detail

      • withDatabaseName

        public SearchIteratorParam.Builder withDatabaseName​(java.lang.String databaseName)
        Sets the database name. database name can be nil.
        Parameters:
        databaseName - database name
        Returns:
        Builder

      • withCollectionName

        public SearchIteratorParam.Builder withCollectionName​(@NonNull
                                                      @NonNull java.lang.String collectionName)
        Sets the collection name. Collection name cannot be empty or null.
        Parameters:
        collectionName - collection name
        Returns:
        Builder

      • withPartitionNames

        public SearchIteratorParam.Builder withPartitionNames​(@NonNull
                                                      @NonNull java.util.List<java.lang.String> partitionNames)
        Sets partition names list to specify search scope (Optional).
        Parameters:
        partitionNames - partition names list
        Returns:
        Builder

      • addPartitionName

        public SearchIteratorParam.Builder addPartitionName​(@NonNull
                                                    @NonNull java.lang.String partitionName)
        Adds a partition to specify search scope (Optional).
        Parameters:
        partitionName - partition name
        Returns:
        Builder

      • withMetricType

        public SearchIteratorParam.Builder withMetricType​(@NonNull
                                                  @NonNull MetricType metricType)
        Sets metric type of ANN searching.
        Parameters:
        metricType - metric type
        Returns:
        Builder

      • withVectorFieldName

        public SearchIteratorParam.Builder withVectorFieldName​(@NonNull
                                                       @NonNull java.lang.String vectorFieldName)
        Sets target vector field by name. Field name cannot be empty or null.
        Parameters:
        vectorFieldName - vector field name
        Returns:
        Builder

      • withTopK

        public SearchIteratorParam.Builder withTopK​(@NonNull
                                            @NonNull java.lang.Integer topK)
        Sets topK value of ANN search.
        Parameters:
        topK - topK value
        Returns:
        Builder

      • withExpr

        public SearchIteratorParam.Builder withExpr​(@NonNull
                                            @NonNull java.lang.String expr)
        Sets expression to filter out entities before searching (Optional).
        Parameters:
        expr - filtering expression
        Returns:
        Builder
        See Also:
        Boolean Expression Rules

      • withOutFields

        public SearchIteratorParam.Builder withOutFields​(@NonNull
                                                 @NonNull java.util.List<java.lang.String> outFields)
        Specifies output fields (Optional).
        Parameters:
        outFields - output fields
        Returns:
        Builder

      • addOutField

        public SearchIteratorParam.Builder addOutField​(@NonNull
                                               @NonNull java.lang.String fieldName)
        Specifies an output field (Optional).
        Parameters:
        fieldName - filed name
        Returns:
        Builder

      • withVectors

        public SearchIteratorParam.Builder withVectors​(@NonNull
                                               @NonNull java.util.List<?> vectors)
        Sets the target vectors.
        Parameters:
        vectors - list of target vectors: if vector type is FloatVector, vectors is List of List Float; if vector type is BinaryVector, vectors is List of ByteBuffer;
        Returns:
        Builder

      • withRoundDecimal

        public SearchIteratorParam.Builder withRoundDecimal​(@NonNull
                                                    @NonNull java.lang.Integer decimal)
        Specifies the decimal place of the returned results.
        Parameters:
        decimal - how many digits after the decimal point
        Returns:
        Builder

      • withParams

        public SearchIteratorParam.Builder withParams​(@NonNull
                                              @NonNull java.lang.String params)
        Sets the search parameters specific to the index type. For example: IVF index, the search parameters can be "{\"nprobe\":10}" For more information: @see Index Selection
        Parameters:
        params - extra parameters in json format
        Returns:
        Builder

      • withIgnoreGrowing

        public SearchIteratorParam.Builder withIgnoreGrowing​(@NonNull
                                                     @NonNull java.lang.Boolean ignoreGrowing)
        Ignore the growing segments to get best search performance. Default is False. For the user case that don't require data visibility.
        Parameters:
        ignoreGrowing - Boolean.TRUE ignore, Boolean.FALSE is not
        Returns:
        Builder

      • withBatchSize

        public SearchIteratorParam.Builder withBatchSize​(@NotNull
                                                 java.lang.Long batchSize)
        Specify a value to control the number of entities returned per batch. Must be a positive value. Default value is 1000, will return without batchSize.
        Parameters:
        batchSize - a value to define the number of entities returned per batch
        Returns:
        Builder