Class Example (1.6.0)

Example(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
image_payload google.cloud.datalabeling_v1beta1.types.ImagePayload
The image payload, a container of the image bytes/uri. This field is a member of `oneof`_ ``payload``.
text_payload google.cloud.datalabeling_v1beta1.types.TextPayload
The text payload, a container of the text content. This field is a member of `oneof`_ ``payload``.
video_payload google.cloud.datalabeling_v1beta1.types.VideoPayload
The video payload, a container of the video uri. This field is a member of `oneof`_ ``payload``.
name str
Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
annotations Sequence[google.cloud.datalabeling_v1beta1.types.Annotation]
Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

Inheritance

builtins.object > proto.message.Message > Example