Cloud Vision V1 Client - Class Paragraph (1.9.4)

Reference documentation and code samples for the Cloud Vision V1 Client class Paragraph.

Structural unit of text representing a number of words in certain order.

Generated from protobuf message google.cloud.vision.v1.Paragraph

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ property
Google\Cloud\Vision\V1\TextAnnotation\TextProperty

Additional information detected for the paragraph.

↳ bounding_box
Google\Cloud\Vision\V1\BoundingPoly

The bounding box for the paragraph. 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).

↳ words
array< Google\Cloud\Vision\V1\Word >

List of all words in this paragraph.

↳ confidence
float

Confidence of the OCR results for the paragraph. Range [0, 1].

getProperty

Additional information detected for the paragraph.

hasProperty

clearProperty

setProperty

Additional information detected for the paragraph.

Returns
Type
Description
$this

getBoundingBox

The bounding box for the paragraph.

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).
Returns
Type
Description

hasBoundingBox

clearBoundingBox

setBoundingBox

The bounding box for the paragraph.

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).
Parameter
Name
Description
Returns
Type
Description
$this

getWords

List of all words in this paragraph.

Returns
Type
Description

setWords

List of all words in this paragraph.

Parameter
Name
Description
Returns
Type
Description
$this

getConfidence

Confidence of the OCR results for the paragraph. Range [0, 1].

Returns
Type
Description
float

setConfidence

Confidence of the OCR results for the paragraph. Range [0, 1].

Parameter
Name
Description
var
float
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: