Interface BlockOrBuilder (3.25.0)

public interface BlockOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBlockType()

public abstract Block.BlockType getBlockType()

Detected block type (text, image etc) for this block.

.google.cloud.vision.v1.Block.BlockType block_type = 4;

Returns
TypeDescription
Block.BlockType

The blockType.

getBlockTypeValue()

public abstract int getBlockTypeValue()

Detected block type (text, image etc) for this block.

.google.cloud.vision.v1.Block.BlockType block_type = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for blockType.

getBoundingBox()

public abstract BoundingPoly getBoundingBox()

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).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPoly

The boundingBox.

getBoundingBoxOrBuilder()

public abstract BoundingPolyOrBuilder getBoundingBoxOrBuilder()

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).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public abstract float getConfidence()

Confidence of the OCR results on the block. Range [0, 1].

float confidence = 5;

Returns
TypeDescription
float

The confidence.

getParagraphs(int index)

public abstract Paragraph getParagraphs(int index)

List of paragraphs in this block (if this blocks is of type text).

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Paragraph

getParagraphsCount()

public abstract int getParagraphsCount()

List of paragraphs in this block (if this blocks is of type text).

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Returns
TypeDescription
int

getParagraphsList()

public abstract List<Paragraph> getParagraphsList()

List of paragraphs in this block (if this blocks is of type text).

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Returns
TypeDescription
List<Paragraph>

getParagraphsOrBuilder(int index)

public abstract ParagraphOrBuilder getParagraphsOrBuilder(int index)

List of paragraphs in this block (if this blocks is of type text).

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
ParagraphOrBuilder

getParagraphsOrBuilderList()

public abstract List<? extends ParagraphOrBuilder> getParagraphsOrBuilderList()

List of paragraphs in this block (if this blocks is of type text).

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1.ParagraphOrBuilder>

getProperty()

public abstract TextAnnotation.TextProperty getProperty()

Additional information detected for the block.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
TextAnnotation.TextProperty

The property.

getPropertyOrBuilder()

public abstract TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the block.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
TextAnnotation.TextPropertyOrBuilder

hasBoundingBox()

public abstract boolean hasBoundingBox()

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).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
boolean

Whether the boundingBox field is set.

hasProperty()

public abstract boolean hasProperty()

Additional information detected for the block.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
boolean

Whether the property field is set.