Google Cloud Datalabeling V1beta1 Client - Class Example (0.3.1)

Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class Example.

An Example is a piece of data and its annotation. For example, an image with label "house".

Generated from protobuf message google.cloud.datalabeling.v1beta1.Example

Namespace

Google \ Cloud \ DataLabeling \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ image_payload Google\Cloud\DataLabeling\V1beta1\ImagePayload

The image payload, a container of the image bytes/uri.

↳ text_payload Google\Cloud\DataLabeling\V1beta1\TextPayload

The text payload, a container of the text content.

↳ video_payload Google\Cloud\DataLabeling\V1beta1\VideoPayload

The video payload, a container of the video uri.

↳ name string

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

↳ annotations array<Google\Cloud\DataLabeling\V1beta1\Annotation>

Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

getImagePayload

The image payload, a container of the image bytes/uri.

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\ImagePayload|null

hasImagePayload

setImagePayload

The image payload, a container of the image bytes/uri.

Parameter
NameDescription
var Google\Cloud\DataLabeling\V1beta1\ImagePayload
Returns
TypeDescription
$this

getTextPayload

The text payload, a container of the text content.

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\TextPayload|null

hasTextPayload

setTextPayload

The text payload, a container of the text content.

Parameter
NameDescription
var Google\Cloud\DataLabeling\V1beta1\TextPayload
Returns
TypeDescription
$this

getVideoPayload

The video payload, a container of the video uri.

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\VideoPayload|null

hasVideoPayload

setVideoPayload

The video payload, a container of the video uri.

Parameter
NameDescription
var Google\Cloud\DataLabeling\V1beta1\VideoPayload
Returns
TypeDescription
$this

getName

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

Returns
TypeDescription
string

setName

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAnnotations

Output only. Annotations for the piece of data in Example.

One piece of data can have multiple annotations.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAnnotations

Output only. Annotations for the piece of data in Example.

One piece of data can have multiple annotations.

Parameter
NameDescription
var array<Google\Cloud\DataLabeling\V1beta1\Annotation>
Returns
TypeDescription
$this

getPayload

Returns
TypeDescription
string