View Source GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageFormField (google_api_document_ai v0.39.0)

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

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageFormField{
    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:
      [
        GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage.t()
      ]
      | nil,
    provenance:
      GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentProvenance.t()
      | nil,
    valueDetectedLanguages:
      [
        GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage.t()
      ]
      | nil,
    valueType: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.