/**
 * (C) Copyright IBM Corp. 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

import Foundation

/**
 An alternative value for the recognized entity.
 */
public struct RuntimeEntityAlternative: Codable, Equatable {

    /**
     The entity value that was recognized in the user input.
     */
    public var value: String?

    /**
     A decimal percentage that represents Watson's confidence in the recognized entity.
     */
    public var confidence: Double?

    // Map each property name to the key that shall be used for encoding/decoding.
    private enum CodingKeys: String, CodingKey {
        case value = "value"
        case confidence = "confidence"
    }

    /**
      Initialize a `RuntimeEntityAlternative` with member variables.

      - parameter value: The entity value that was recognized in the user input.
      - parameter confidence: A decimal percentage that represents Watson's confidence in the recognized entity.

      - returns: An initialized `RuntimeEntityAlternative`.
     */
    public init(
        value: String? = nil,
        confidence: Double? = nil
    )
    {
        self.value = value
        self.confidence = confidence
    }

}
