# Copyright 2019 Google LLC
#
# 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 file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageFormField do
@moduledoc """
A form field detected on the page.
## Attributes
* `correctedKeyText` (*type:* `String.t`, *default:* `nil`) - Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
* `correctedValueText` (*type:* `String.t`, *default:* `nil`) - Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
* `fieldName` (*type:* `GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageLayout.t`, *default:* `nil`) - Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
* `fieldValue` (*type:* `GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageLayout.t`, *default:* `nil`) - Layout for the FormField value.
* `nameDetectedLanguages` (*type:* `list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage.t)`, *default:* `nil`) - A list of detected languages for name together with confidence.
* `provenance` (*type:* `GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentProvenance.t`, *default:* `nil`) - The history of this annotation.
* `valueDetectedLanguages` (*type:* `list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage.t)`, *default:* `nil`) - A list of detected languages for value together with confidence.
* `valueType` (*type:* `String.t`, *default:* `nil`) - If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - "unfilled_checkbox" - "filled_checkbox"
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:correctedKeyText => String.t() | nil,
:correctedValueText => String.t() | nil,
:fieldName =>
GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageLayout.t() | nil,
:fieldValue =>
GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageLayout.t() | nil,
:nameDetectedLanguages =>
list(
GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage.t()
)
| nil,
:provenance =>
GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentProvenance.t() | nil,
:valueDetectedLanguages =>
list(
GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage.t()
)
| nil,
:valueType => String.t() | nil
}
field(:correctedKeyText)
field(:correctedValueText)
field(:fieldName,
as: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageLayout
)
field(:fieldValue,
as: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageLayout
)
field(:nameDetectedLanguages,
as: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage,
type: :list
)
field(:provenance,
as: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentProvenance
)
field(:valueDetectedLanguages,
as: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage,
type: :list
)
field(:valueType)
end
defimpl Poison.Decoder,
for: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageFormField do
def decode(value, options) do
GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageFormField.decode(
value,
options
)
end
end
defimpl Poison.Encoder,
for: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageFormField do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end