google_api_speech

# Copyright 2017 Google Inc.
#
# 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.


# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

defmodule GoogleApi.Speech.V1.Model.RecognitionConfig do
  @moduledoc """
  Provides information to the recognizer that specifies how to process the request.

  ## Attributes

  - enableWordTimeOffsets (Boolean): *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. Defaults to: `null`.
  - encoding (String): *Required* Encoding of audio data sent in all `RecognitionAudio` messages. Defaults to: `null`.
    - Enum - one of [ENCODING_UNSPECIFIED, LINEAR16, FLAC, MULAW, AMR, AMR_WB, OGG_OPUS, SPEEX_WITH_HEADER_BYTE]
  - languageCode (String): *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. Defaults to: `null`.
  - maxAlternatives (Integer): *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. Defaults to: `null`.
  - profanityFilter (Boolean): *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. \"f***\". If set to `false` or omitted, profanities won't be filtered out. Defaults to: `null`.
  - sampleRateHertz (Integer): *Required* Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). Defaults to: `null`.
  - speechContexts (List[SpeechContext]): *Optional* A means to provide context to assist the speech recognition. Defaults to: `null`.
  """

  defstruct [
    :"enableWordTimeOffsets",
    :"encoding",
    :"languageCode",
    :"maxAlternatives",
    :"profanityFilter",
    :"sampleRateHertz",
    :"speechContexts"
  ]
end

defimpl Poison.Decoder, for: GoogleApi.Speech.V1.Model.RecognitionConfig do
  import GoogleApi.Speech.V1.Deserializer
  def decode(value, options) do
    value
    |> deserialize(:"speechContexts", :list, GoogleApi.Speech.V1.Model.SpeechContext, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Speech.V1.Model.RecognitionConfig do
  def encode(value, options) do
    GoogleApi.Speech.V1.Deserializer.serialize_non_nil(value, options)
  end
end