001/*
002 * Copyright 2024 Vonage
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package com.vonage.client.voice;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.JsonableBaseObject;
020
021/**
022 * Represents speech to text data contained in {@link SpeechResults#getResults()}.
023 *
024 * @since 8.2.0
025 */
026public class SpeechTranscript extends JsonableBaseObject {
027    private String text;
028    private Double confidence;
029
030    /**
031     * Transcript text representing the words that the user spoke.
032     *
033     * @return The transcript text.
034     */
035    @JsonProperty("text")
036    public String getText() {
037        return text;
038    }
039
040    /**
041     * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater
042     * likelihood that the recognized words are correct.
043     *
044     * @return The confidence estimate between 0.0 and 1.0 as a Double.
045     */
046    public Double getConfidence() {
047        return confidence;
048    }
049}