googly_cloud_vision

# NOTE: This file is auto generated by googly. Do not edit it manually.

defmodule Googly.CloudVision.Model.Word do
  @moduledoc """
  A word representation.

  ## Attributes

  *   `bounding_box` (*type:* `Googly.CloudVision.Model.BoundingPoly.t()`) - The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).
  *   `confidence` (*type:* `number()`) - Confidence of the OCR results for the word. Range [0, 1].
  *   `property` (*type:* `Googly.CloudVision.Model.TextProperty.t()`) - Additional information detected for the word.
  *   `symbols` (*type:* `list(Googly.CloudVision.Model.Symbol.t())`) - List of symbols in the word. The order of the symbols follows the natural reading order.
  """

  defstruct [:bounding_box, :confidence, :property, :symbols]

  @type t :: %__MODULE__{
          bounding_box: Googly.CloudVision.Model.BoundingPoly.t() | nil,
          confidence: number() | nil,
          property: Googly.CloudVision.Model.TextProperty.t() | nil,
          symbols: list(Googly.CloudVision.Model.Symbol.t()) | nil
        }

  @wire %{bounding_box: "boundingBox"}
  @doc false
  def __wire__, do: @wire

  @doc false
  def decode(nil), do: nil
  def decode(list) when is_list(list), do: Enum.map(list, &decode/1)

  def decode(m) do
    %__MODULE__{
      bounding_box: Googly.CloudVision.Model.BoundingPoly.decode(m["boundingBox"]),
      confidence: m["confidence"],
      property: Googly.CloudVision.Model.TextProperty.decode(m["property"]),
      symbols: Googly.CloudVision.Model.Symbol.decode(m["symbols"])
    }
  end
end