com.microsoft.azure.cognitiveservices.vision.faceapi.models.IdentifyOptionalParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-cognitiveservices-faceapi Show documentation

This package contains Microsoft Cognitive Service Face API SDK.

There is a newer version: 1.0.1-beta

Show newest version

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 */

package com.microsoft.azure.cognitiveservices.vision.faceapi.models;

/**
 * The optional parameters class for "identify" method.
 */
public class IdentifyOptionalParameter {
    /**
    * The range of maxNumOfCandidatesReturned is between 1 and 5 (default is 1).
    */
    private Integer maxNumOfCandidatesReturned;

    /**
    * Confidence threshold of identification, used to judge whether one face belong to one person. The range of
    * confidenceThreshold is [0, 1] (default specified by algorithm).
    */
    private Double confidenceThreshold;

    /**
    * Get the maxNumOfCandidatesReturned value.
    *
    * @return the maxNumOfCandidatesReturned value
    */
    public Integer maxNumOfCandidatesReturned() {
        return this.maxNumOfCandidatesReturned;
    }

    /**
    * Get the confidenceThreshold value.
    *
    * @return the confidenceThreshold value
    */
    public Double confidenceThreshold() {
        return this.confidenceThreshold;
    }

    /**
    * Set the maxNumOfCandidatesReturned value.
    * 
    * The range of maxNumOfCandidatesReturned is between 1 and 5 (default is 1).
    *
    * @param maxNumOfCandidatesReturned the maxNumOfCandidatesReturned value to set
    * @return the identifyOptionalParameter object itself.
    */
    public IdentifyOptionalParameter withMaxNumOfCandidatesReturned(int maxNumOfCandidatesReturned) {
        this.maxNumOfCandidatesReturned = maxNumOfCandidatesReturned;
        return this;
    }

    /**
    * Set the confidenceThreshold value.
    * 
    * Confidence threshold of identification, used to judge whether one face belong to one person. The range of
    * confidenceThreshold is [0, 1] (default specified by algorithm).
    *
    * @param confidenceThreshold the confidenceThreshold value to set
    * @return the identifyOptionalParameter object itself.
    */
    public IdentifyOptionalParameter withConfidenceThreshold(double confidenceThreshold) {
        this.confidenceThreshold = confidenceThreshold;
        return this;
    }

    }