Packages

Google Cloud Vision API client library.

Current section

Files

Jump to
googly_cloud_vision lib googly cloud_vision model block.ex
Raw

lib/googly/cloud_vision/model/block.ex

# NOTE: This file is auto generated by googly. Do not edit it manually.
defmodule Googly.CloudVision.Model.Block do
@moduledoc """
Logical element on the page.
## Attributes
* `block_type` (*type:* `String.t()`) - Detected block type (text, image etc) for this block.
* `bounding_box` (*type:* `Googly.CloudVision.Model.BoundingPoly.t()`) - The bounding box for the block. 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 on the block. Range [0, 1].
* `paragraphs` (*type:* `list(Googly.CloudVision.Model.Paragraph.t())`) - List of paragraphs in this block (if this blocks is of type text).
* `property` (*type:* `Googly.CloudVision.Model.TextProperty.t()`) - Additional information detected for the block.
"""
defstruct [:block_type, :bounding_box, :confidence, :paragraphs, :property]
@type t :: %__MODULE__{
block_type: String.t() | nil,
bounding_box: Googly.CloudVision.Model.BoundingPoly.t() | nil,
confidence: number() | nil,
paragraphs: list(Googly.CloudVision.Model.Paragraph.t()) | nil,
property: Googly.CloudVision.Model.TextProperty.t() | nil
}
@wire %{block_type: "blockType", 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__{
block_type: m["blockType"],
bounding_box: Googly.CloudVision.Model.BoundingPoly.decode(m["boundingBox"]),
confidence: m["confidence"],
paragraphs: Googly.CloudVision.Model.Paragraph.decode(m["paragraphs"]),
property: Googly.CloudVision.Model.TextProperty.decode(m["property"])
}
end
end