Google Cloud Datalabeling V1beta1 Client - Class Example (0.1.14)

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

Methods

__construct

Constructor.

Parameters
Name
Description
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
Type
Description

hasImagePayload

setImagePayload

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

Parameter
Name
Description
Returns
Type
Description
$this

getTextPayload

The text payload, a container of the text content.

Returns
Type
Description

hasTextPayload

setTextPayload

The text payload, a container of the text content.

Parameter
Name
Description
Returns
Type
Description
$this

getVideoPayload

The video payload, a container of the video uri.

Returns
Type
Description

hasVideoPayload

setVideoPayload

The video payload, a container of the video uri.

Parameter
Name
Description
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this

getAnnotations

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

One piece of data can have multiple annotations.

Returns
Type
Description

setAnnotations

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

One piece of data can have multiple annotations.

Parameter
Name
Description
Returns
Type
Description
$this

getPayload

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: