Types for Data Labeling API Client#

class google.cloud.datalabeling_v1beta1.types.AnnotatedDataset#

AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.

name#

Output only. AnnotatedDataset resource name in format of: proj ects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

display_name#

Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.

description#

Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.

annotation_source#

Output only. Source of the annotation.

annotation_type#

Output only. Type of the annotation. It is specified when starting labeling task.

example_count#

Output only. Number of examples in the annotated dataset.

completed_example_count#

Output only. Number of examples that have annotation in the annotated dataset.

label_stats#

Output only. Per label statistics.

create_time#

Output only. Time the AnnotatedDataset was created.

metadata#

Output only. Additional information about AnnotatedDataset.

blocking_resources#

Output only. The names of any related resources that are blocking changes to the annotated dataset.

annotation_source

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.annotation_source

annotation_type

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.annotation_type

blocking_resources

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.blocking_resources

completed_example_count

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.completed_example_count

create_time

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.create_time

description

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.description

display_name

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.display_name

example_count

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.example_count

label_stats

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.label_stats

metadata

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.metadata

name

Field google.cloud.datalabeling.v1beta1.AnnotatedDataset.name

class google.cloud.datalabeling_v1beta1.types.AnnotatedDatasetMetadata#

Metadata on AnnotatedDataset.

annotation_request_config#

Specific request configuration used when requesting the labeling task.

image_classification_config#

Configuration for image classification task.

bounding_poly_config#

Configuration for image bounding box and bounding poly task.

polyline_config#

Configuration for image polyline task.

segmentation_config#

Configuration for image segmentation task.

video_classification_config#

Configuration for video classification task.

object_detection_config#

Configuration for video object detection task.

object_tracking_config#

Configuration for video object tracking task.

event_config#

Configuration for video event labeling task.

text_classification_config#

Configuration for text classification task.

text_entity_extraction_config#

Configuration for text entity extraction task.

human_annotation_config#

HumanAnnotationConfig used when requesting the human labeling task for this AnnotatedDataset.

bounding_poly_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.bounding_poly_config

event_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.event_config

human_annotation_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.human_annotation_config

image_classification_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.image_classification_config

object_detection_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.object_detection_config

object_tracking_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.object_tracking_config

polyline_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.polyline_config

segmentation_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.segmentation_config

text_classification_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.text_classification_config

text_entity_extraction_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.text_entity_extraction_config

video_classification_config

Field google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata.video_classification_config

class google.cloud.datalabeling_v1beta1.types.Annotation#

Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.

name#

Output only. Unique name of this annotation, format is: proje cts/{project_id}/datasets/{dataset_id}/annotatedDatasets/{an notated_dataset}/examples/{example_id}/annotations/{annotati on_id}

annotation_source#

Output only. The source of the annotation.

annotation_value#

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

annotation_metadata#

Output only. Annotation metadata, including information like votes for labels.

annotation_sentiment#

Output only. Sentiment for this annotation.

annotation_metadata

Field google.cloud.datalabeling.v1beta1.Annotation.annotation_metadata

annotation_sentiment

Field google.cloud.datalabeling.v1beta1.Annotation.annotation_sentiment

annotation_source

Field google.cloud.datalabeling.v1beta1.Annotation.annotation_source

annotation_value

Field google.cloud.datalabeling.v1beta1.Annotation.annotation_value

name

Field google.cloud.datalabeling.v1beta1.Annotation.name

class google.cloud.datalabeling_v1beta1.types.AnnotationMetadata#

Additional information associated with the annotation.

operator_metadata#

Metadata related to human labeling.

operator_metadata

Field google.cloud.datalabeling.v1beta1.AnnotationMetadata.operator_metadata

class google.cloud.datalabeling_v1beta1.types.AnnotationSpec#

Container of information related to one annotation spec.

display_name#

Required. The display name of the AnnotationSpec. Maximum of 64 characters.

description#

Optional. User-provided description of the annotation specification. The description can be up to 10000 characters long.

description

Field google.cloud.datalabeling.v1beta1.AnnotationSpec.description

display_name

Field google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name

class google.cloud.datalabeling_v1beta1.types.AnnotationSpecSet#

AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, we define a set of labels, this set is called AnnotationSpecSet. AnnotationSpecSet is immutable upon creation.

name#

Output only. AnnotationSpecSet resource name, format: projects /{project_id}/annotationSpecSets/{annotation_spec_set_id}

display_name#

Required. The display name for AnnotationSpecSet defined by user. Maximum of 64 characters.

description#

Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.

annotation_specs#

Required. The actual spec set defined by the users.

blocking_resources#

Output only. The names of any related resources that are blocking changes to the annotation spec set.

annotation_specs

Field google.cloud.datalabeling.v1beta1.AnnotationSpecSet.annotation_specs

blocking_resources

Field google.cloud.datalabeling.v1beta1.AnnotationSpecSet.blocking_resources

description

Field google.cloud.datalabeling.v1beta1.AnnotationSpecSet.description

display_name

Field google.cloud.datalabeling.v1beta1.AnnotationSpecSet.display_name

name

Field google.cloud.datalabeling.v1beta1.AnnotationSpecSet.name

class google.cloud.datalabeling_v1beta1.types.AnnotationValue#

Annotation value for an example.

image_classification_annotation#

Annotation value for image classification case.

image_bounding_poly_annotation#

Annotation value for image bounding box, oriented bounding box and polygon cases.

image_polyline_annotation#

Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other.

image_segmentation_annotation#

Annotation value for image segmentation.

text_classification_annotation#

Annotation value for text classification case.

text_entity_extraction_annotation#

Annotation value for text entity extraction case.

video_classification_annotation#

Annotation value for video classification case.

video_object_tracking_annotation#

Annotation value for video object detection and tracking case.

video_event_annotation#

Annotation value for video event case.

image_bounding_poly_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.image_bounding_poly_annotation

image_classification_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.image_classification_annotation

image_polyline_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.image_polyline_annotation

image_segmentation_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.image_segmentation_annotation

text_classification_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.text_classification_annotation

text_entity_extraction_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.text_entity_extraction_annotation

video_classification_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.video_classification_annotation

video_event_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.video_event_annotation

video_object_tracking_annotation

Field google.cloud.datalabeling.v1beta1.AnnotationValue.video_object_tracking_annotation

class google.cloud.datalabeling_v1beta1.types.Any#
type_url#

Field google.protobuf.Any.type_url

value#

Field google.protobuf.Any.value

class google.cloud.datalabeling_v1beta1.types.Attempt#

Records a failed attempt.

attempt_time#

Field google.cloud.datalabeling.v1beta1.Attempt.attempt_time

partial_failures#

Field google.cloud.datalabeling.v1beta1.Attempt.partial_failures

class google.cloud.datalabeling_v1beta1.types.BigQuerySource#

The BigQuery location for the input content.

input_uri#

Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: BigQuery gs path e.g. bq://projectId.bqDatasetId.bqTableId

input_uri

Field google.cloud.datalabeling.v1beta1.BigQuerySource.input_uri

class google.cloud.datalabeling_v1beta1.types.BoundingBoxEvaluationOptions#

Options regarding evaluation between bounding boxes.

iou_threshold#

Minimize IoU required to consider 2 bounding boxes are matched.

iou_threshold

Field google.cloud.datalabeling.v1beta1.BoundingBoxEvaluationOptions.iou_threshold

class google.cloud.datalabeling_v1beta1.types.BoundingPoly#

A bounding polygon in the image.

vertices#

The bounding polygon vertices.

vertices

Field google.cloud.datalabeling.v1beta1.BoundingPoly.vertices

class google.cloud.datalabeling_v1beta1.types.BoundingPolyConfig#

Config for image bounding poly (and bounding box) human labeling task.

annotation_spec_set#

Required. Annotation spec set resource name.

instruction_message#

Optional. Instruction message showed on contributors UI.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.BoundingPolyConfig.annotation_spec_set

instruction_message

Field google.cloud.datalabeling.v1beta1.BoundingPolyConfig.instruction_message

class google.cloud.datalabeling_v1beta1.types.CancelOperationRequest#
name#

Field google.longrunning.CancelOperationRequest.name

class google.cloud.datalabeling_v1beta1.types.ClassificationMetadata#

Metadata for classification annotations.

is_multi_label#

Whether the classification task is multi-label or not.

is_multi_label

Field google.cloud.datalabeling.v1beta1.ClassificationMetadata.is_multi_label

class google.cloud.datalabeling_v1beta1.types.ClassificationMetrics#
pr_curve#

Precision-recall curve.

confusion_matrix#

Field google.cloud.datalabeling.v1beta1.ClassificationMetrics.confusion_matrix

pr_curve

Field google.cloud.datalabeling.v1beta1.ClassificationMetrics.pr_curve

class google.cloud.datalabeling_v1beta1.types.ConfusionMatrix#

Confusion matrix of the model running the classification. Not applicable when label filtering is specified in evaluation option.

class ConfusionMatrixEntry#
annotation_spec#

The predicted annotation spec.

item_count#

Number of items being predicted as this label.

annotation_spec

Field google.cloud.datalabeling.v1beta1.ConfusionMatrix.ConfusionMatrixEntry.annotation_spec

item_count

Field google.cloud.datalabeling.v1beta1.ConfusionMatrix.ConfusionMatrixEntry.item_count

class Row#

A row in the confusion matrix.

annotation_spec#

the original annotation spec of this row.

entries#

Info describing predicted label distribution.

annotation_spec

Field google.cloud.datalabeling.v1beta1.ConfusionMatrix.Row.annotation_spec

entries

Field google.cloud.datalabeling.v1beta1.ConfusionMatrix.Row.entries

row#

Field google.cloud.datalabeling.v1beta1.ConfusionMatrix.row

class google.cloud.datalabeling_v1beta1.types.CreateAnnotationSpecSetRequest#

Request message for CreateAnnotationSpecSet.

parent#

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

annotation_spec_set#

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.CreateAnnotationSpecSetRequest.annotation_spec_set

parent

Field google.cloud.datalabeling.v1beta1.CreateAnnotationSpecSetRequest.parent

class google.cloud.datalabeling_v1beta1.types.CreateDatasetRequest#

Request message for CreateDataset.

parent#

Required. Dataset resource parent, format: projects/{project_id}

dataset#

Required. The dataset to be created.

dataset

Field google.cloud.datalabeling.v1beta1.CreateDatasetRequest.dataset

parent

Field google.cloud.datalabeling.v1beta1.CreateDatasetRequest.parent

class google.cloud.datalabeling_v1beta1.types.CreateEvaluationJobRequest#

Request message for CreateEvaluationJob.

parent#

Required. Evaluation job resource parent, format: projects/{project_id}.

job#

Required. The evaluation job to create.

job

Field google.cloud.datalabeling.v1beta1.CreateEvaluationJobRequest.job

parent

Field google.cloud.datalabeling.v1beta1.CreateEvaluationJobRequest.parent

class google.cloud.datalabeling_v1beta1.types.CreateInstructionMetadata#

Metadata of a CreateInstruction operation.

instruction#

The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}

partial_failures#

Partial failures encountered. E.g. single files that couldn’t be read. Status details field will contain standard GCP error details.

create_time#

Timestamp when create instruction request was created.

create_time

Field google.cloud.datalabeling.v1beta1.CreateInstructionMetadata.create_time

instruction

Field google.cloud.datalabeling.v1beta1.CreateInstructionMetadata.instruction

partial_failures

Field google.cloud.datalabeling.v1beta1.CreateInstructionMetadata.partial_failures

class google.cloud.datalabeling_v1beta1.types.CreateInstructionRequest#

Request message for CreateInstruction.

parent#

Required. Instruction resource parent, format: projects/{project_id}

instruction#

Required. Instruction of how to perform the labeling task.

instruction

Field google.cloud.datalabeling.v1beta1.CreateInstructionRequest.instruction

parent

Field google.cloud.datalabeling.v1beta1.CreateInstructionRequest.parent

class google.cloud.datalabeling_v1beta1.types.CsvInstruction#

Instruction from a CSV file.

gcs_file_uri#

CSV file for the instruction. Only gcs path is allowed.

gcs_file_uri

Field google.cloud.datalabeling.v1beta1.CsvInstruction.gcs_file_uri

class google.cloud.datalabeling_v1beta1.types.DataItem#

DataItem is a piece of data, without annotation. For example, an image.

payload#

Output only.

image_payload#

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

text_payload#

The text payload, a container of text content.

video_payload#

The video payload, a container of the video uri.

name#

Output only. Name of the data item, in format of: projects/{pr oject_id}/datasets/{dataset_id}/dataItems/{data_item_id}

image_payload

Field google.cloud.datalabeling.v1beta1.DataItem.image_payload

name

Field google.cloud.datalabeling.v1beta1.DataItem.name

text_payload

Field google.cloud.datalabeling.v1beta1.DataItem.text_payload

video_payload

Field google.cloud.datalabeling.v1beta1.DataItem.video_payload

class google.cloud.datalabeling_v1beta1.types.Dataset#

Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.

name#

Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}

display_name#

Required. The display name of the dataset. Maximum of 64 characters.

description#

Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.

create_time#

Output only. Time the dataset is created.

input_configs#

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

blocking_resources#

Output only. The names of any related resources that are blocking changes to the dataset.

data_item_count#

Output only. The number of data items in the dataset.

blocking_resources

Field google.cloud.datalabeling.v1beta1.Dataset.blocking_resources

create_time

Field google.cloud.datalabeling.v1beta1.Dataset.create_time

data_item_count

Field google.cloud.datalabeling.v1beta1.Dataset.data_item_count

description

Field google.cloud.datalabeling.v1beta1.Dataset.description

display_name

Field google.cloud.datalabeling.v1beta1.Dataset.display_name

input_configs

Field google.cloud.datalabeling.v1beta1.Dataset.input_configs

name

Field google.cloud.datalabeling.v1beta1.Dataset.name

class google.cloud.datalabeling_v1beta1.types.DeleteAnnotatedDatasetRequest#

Request message for DeleteAnnotatedDataset.

name#

Required. Name of the annotated dataset to delete, format: pro jects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

name

Field google.cloud.datalabeling.v1beta1.DeleteAnnotatedDatasetRequest.name

class google.cloud.datalabeling_v1beta1.types.DeleteAnnotationSpecSetRequest#

Request message for DeleteAnnotationSpecSet.

name#

Required. AnnotationSpec resource name, format: projects/{pr oject_id}/annotationSpecSets/{annotation_spec_set_id}.

name

Field google.cloud.datalabeling.v1beta1.DeleteAnnotationSpecSetRequest.name

class google.cloud.datalabeling_v1beta1.types.DeleteDatasetRequest#

Request message for DeleteDataset.

name#

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

name

Field google.cloud.datalabeling.v1beta1.DeleteDatasetRequest.name

class google.cloud.datalabeling_v1beta1.types.DeleteEvaluationJobRequest#

Request message DeleteEvaluationJob.

name#

Required. Name of the evaluation job that is going to be deleted. Format: ‘projects/{project_id}/evaluationJobs/{evaluation_job_id}’

name

Field google.cloud.datalabeling.v1beta1.DeleteEvaluationJobRequest.name

class google.cloud.datalabeling_v1beta1.types.DeleteInstructionRequest#

Request message for DeleteInstruction.

name#

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

name

Field google.cloud.datalabeling.v1beta1.DeleteInstructionRequest.name

class google.cloud.datalabeling_v1beta1.types.DeleteOperationRequest#
name#

Field google.longrunning.DeleteOperationRequest.name

class google.cloud.datalabeling_v1beta1.types.Duration#
nanos#

Field google.protobuf.Duration.nanos

seconds#

Field google.protobuf.Duration.seconds

class google.cloud.datalabeling_v1beta1.types.Empty#
class google.cloud.datalabeling_v1beta1.types.Evaluation#

Describes an evaluation between 2 annotated datasets. Created by an evaluation plan.

name#

Resource name of an evaluation. Format: ‘projects/{project_id }/datasets/{dataset_id}/evaluations/{evaluation_id}’

config#

Options used in evaluation plan for creating the evaluation.

evaluation_job_run_time#

Output only. Timestamp when the evaluation plan triggered this evaluation flow.

create_time#

Output only. Timestamp when this model evaluation was created.

evaluation_metrics#

Output only. Metrics of the evaluation.

annotation_type#

Type of the annotation to compute metrics for in the groundtruth and annotation labeled dataset. Required for creation.

evaluated_item_count#

Output only. Count of items in groundtruth dataset included in this evaluation. Will be unset if annotation type is not applicable.

annotation_type

Field google.cloud.datalabeling.v1beta1.Evaluation.annotation_type

config

Field google.cloud.datalabeling.v1beta1.Evaluation.config

create_time

Field google.cloud.datalabeling.v1beta1.Evaluation.create_time

evaluated_item_count

Field google.cloud.datalabeling.v1beta1.Evaluation.evaluated_item_count

evaluation_job_run_time

Field google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time

evaluation_metrics

Field google.cloud.datalabeling.v1beta1.Evaluation.evaluation_metrics

name

Field google.cloud.datalabeling.v1beta1.Evaluation.name

class google.cloud.datalabeling_v1beta1.types.EvaluationConfig#
vertical_option#

Vertical specific options for general metrics.

bounding_box_evaluation_options#

Field google.cloud.datalabeling.v1beta1.EvaluationConfig.bounding_box_evaluation_options

class google.cloud.datalabeling_v1beta1.types.EvaluationJob#

Defines an evaluation job that is triggered periodically to generate evaluations.

name#

Format: ‘projects/{project_id}/evaluationJobs/{evaluation_job_id}’

description#

Description of the job. The description can be up to 25000 characters long.

schedule#

Describes the schedule on which the job will be executed. Minimum schedule unit is 1 day. The schedule can be either of the following types: * Crontab * English- like schedule

model_version#

The versioned model that is being evaluated here. Only one job is allowed for each model name. Format: ‘projects//models//versions/*’

evaluation_job_config#

Detailed config for running this eval job.

annotation_spec_set#

Name of the AnnotationSpecSet.

label_missing_ground_truth#

If a human annotation should be requested when some data don’t have ground truth.

attempts#

Output only. Any attempts with errors happening in evaluation job runs each time will be recorded here incrementally.

create_time#

Timestamp when this evaluation job was created.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.EvaluationJob.annotation_spec_set

attempts

Field google.cloud.datalabeling.v1beta1.EvaluationJob.attempts

create_time

Field google.cloud.datalabeling.v1beta1.EvaluationJob.create_time

description

Field google.cloud.datalabeling.v1beta1.EvaluationJob.description

evaluation_job_config

Field google.cloud.datalabeling.v1beta1.EvaluationJob.evaluation_job_config

label_missing_ground_truth

Field google.cloud.datalabeling.v1beta1.EvaluationJob.label_missing_ground_truth

model_version

Field google.cloud.datalabeling.v1beta1.EvaluationJob.model_version

name

Field google.cloud.datalabeling.v1beta1.EvaluationJob.name

schedule

Field google.cloud.datalabeling.v1beta1.EvaluationJob.schedule

state#

Field google.cloud.datalabeling.v1beta1.EvaluationJob.state

class google.cloud.datalabeling_v1beta1.types.EvaluationJobAlertConfig#
email#

Required. Email of the user who will be receiving the alert.

min_acceptable_mean_average_precision#

If a single evaluation run’s aggregate mean average precision is lower than this threshold, the alert will be triggered.

email

Field google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig.email

min_acceptable_mean_average_precision

Field google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig.min_acceptable_mean_average_precision

class google.cloud.datalabeling_v1beta1.types.EvaluationJobConfig#
human_annotation_request_config#

config specific to different supported human annotation use cases.

input_config#

Input config for data, gcs_source in the config will be the root path for data. Data should be organzied chronically under that path.

evaluation_config#

Config used to create evaluation.

bigquery_import_keys#

Mappings between reserved keys for bigquery import and customized tensor names. Key is the reserved key, value is tensor name in the bigquery table. Different annotation type has different required key mapping. See user manual for more details: https: //docs.google.com/document/d/1bg1meMIBGY // 9I5QEoFoHSX6u9LsZQYBSmPt6E9SxqHZc/edit#heading=h.tfyjhxhvsqem

example_count#

Max number of examples to collect in each period.

example_sample_percentage#

Percentage of examples to collect in each period. 0.1 means 10% of total examples will be collected, and 0.0 means no collection.

evaluation_job_alert_config#

Alert config for the evaluation job. The alert will be triggered when its criteria is met.

class BigqueryImportKeysEntry#
key#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.BigqueryImportKeysEntry.key

value#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.BigqueryImportKeysEntry.value

bigquery_import_keys

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.bigquery_import_keys

bounding_poly_config#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.bounding_poly_config

evaluation_config

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.evaluation_config

evaluation_job_alert_config

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.evaluation_job_alert_config

example_count

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.example_count

example_sample_percentage

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.example_sample_percentage

human_annotation_config#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.human_annotation_config

image_classification_config#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.image_classification_config

input_config

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.input_config

object_detection_config#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.object_detection_config

object_tracking_config#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.object_tracking_config

text_classification_config#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.text_classification_config

video_classification_config#

Field google.cloud.datalabeling.v1beta1.EvaluationJobConfig.video_classification_config

class google.cloud.datalabeling_v1beta1.types.EvaluationMetrics#
metrics#

Common metrics covering most genernal cases.

classification_metrics#

Field google.cloud.datalabeling.v1beta1.EvaluationMetrics.classification_metrics

object_detection_metrics#

Field google.cloud.datalabeling.v1beta1.EvaluationMetrics.object_detection_metrics

class google.cloud.datalabeling_v1beta1.types.EventConfig#

Config for video event human labeling task.

annotation_spec_sets#

Required. The list of annotation spec set resource name. Similar to video classification, we support selecting event from multiple AnnotationSpecSet at the same time.

annotation_spec_sets

Field google.cloud.datalabeling.v1beta1.EventConfig.annotation_spec_sets

class google.cloud.datalabeling_v1beta1.types.Example#

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

payload#

Output only. The data part of Example.

image_payload#

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

text_payload#

The text payload, a container of the text content.

video_payload#

The video payload, a container of the video uri.

name#

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

annotations#

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

annotations

Field google.cloud.datalabeling.v1beta1.Example.annotations

image_payload

Field google.cloud.datalabeling.v1beta1.Example.image_payload

name

Field google.cloud.datalabeling.v1beta1.Example.name

text_payload

Field google.cloud.datalabeling.v1beta1.Example.text_payload

video_payload

Field google.cloud.datalabeling.v1beta1.Example.video_payload

class google.cloud.datalabeling_v1beta1.types.ExportDataOperationMetadata#

Metadata of an ExportData operation.

dataset#

Output only. The name of dataset to be exported. “projects//datasets//Datasets/*”

partial_failures#

Output only. Partial failures encountered. E.g. single files that couldn’t be read. Status details field will contain standard GCP error details.

create_time#

Output only. Timestamp when export dataset request was created.

create_time

Field google.cloud.datalabeling.v1beta1.ExportDataOperationMetadata.create_time

dataset

Field google.cloud.datalabeling.v1beta1.ExportDataOperationMetadata.dataset

partial_failures

Field google.cloud.datalabeling.v1beta1.ExportDataOperationMetadata.partial_failures

class google.cloud.datalabeling_v1beta1.types.ExportDataOperationResponse#

Response used for ExportDataset longrunning operation.

dataset#

Ouptut only. The name of dataset. “projects//datasets//Datasets/*”

total_count#

Output only. Total number of examples requested to export

export_count#

Output only. Number of examples exported successfully.

label_stats#

Output only. Statistic infos of labels in the exported dataset.

output_config#

Output only. output_config in the ExportData request.

dataset

Field google.cloud.datalabeling.v1beta1.ExportDataOperationResponse.dataset

export_count

Field google.cloud.datalabeling.v1beta1.ExportDataOperationResponse.export_count

label_stats

Field google.cloud.datalabeling.v1beta1.ExportDataOperationResponse.label_stats

output_config

Field google.cloud.datalabeling.v1beta1.ExportDataOperationResponse.output_config

total_count

Field google.cloud.datalabeling.v1beta1.ExportDataOperationResponse.total_count

class google.cloud.datalabeling_v1beta1.types.ExportDataRequest#

Request message for ExportData API.

name#

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

annotated_dataset#

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It’s in format of projects/{project_id}/datasets/{d ataset_id}/annotatedDatasets/ {annotated_dataset_id}

filter#

Optional. Filter is not supported at this moment.

output_config#

Required. Specify the output destination.

user_email_address#

Email of the user who started the export task and should be notified by email. If empty no notification will be sent.

annotated_dataset

Field google.cloud.datalabeling.v1beta1.ExportDataRequest.annotated_dataset

filter

Field google.cloud.datalabeling.v1beta1.ExportDataRequest.filter

name

Field google.cloud.datalabeling.v1beta1.ExportDataRequest.name

output_config

Field google.cloud.datalabeling.v1beta1.ExportDataRequest.output_config

user_email_address

Field google.cloud.datalabeling.v1beta1.ExportDataRequest.user_email_address

class google.cloud.datalabeling_v1beta1.types.FieldMask#
paths#

Field google.protobuf.FieldMask.paths

class google.cloud.datalabeling_v1beta1.types.GcsDestination#

Export destination of the data.Only gcs path is allowed in output_uri.

output_uri#

Required. The output uri of destination file.

mime_type#

Required. The format of the gcs destination. Only “text/csv” and “application/json” are supported.

mime_type

Field google.cloud.datalabeling.v1beta1.GcsDestination.mime_type

output_uri

Field google.cloud.datalabeling.v1beta1.GcsDestination.output_uri

class google.cloud.datalabeling_v1beta1.types.GcsFolderDestination#

Export folder destination of the data.

output_folder_uri#

Required. Cloud Storage directory to export data to.

output_folder_uri

Field google.cloud.datalabeling.v1beta1.GcsFolderDestination.output_folder_uri

class google.cloud.datalabeling_v1beta1.types.GcsSource#

Source of the Cloud Storage file to be imported.

input_uri#

Required. The input URI of source file. This must be a Cloud Storage path (gs://...).

mime_type#

Required. The format of the source file. Only “text/csv” is supported.

input_uri

Field google.cloud.datalabeling.v1beta1.GcsSource.input_uri

mime_type

Field google.cloud.datalabeling.v1beta1.GcsSource.mime_type

class google.cloud.datalabeling_v1beta1.types.GetAnnotatedDatasetRequest#

Request message for GetAnnotatedDataset.

name#

Required. Name of the annotated dataset to get, format: projec ts/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

name

Field google.cloud.datalabeling.v1beta1.GetAnnotatedDatasetRequest.name

class google.cloud.datalabeling_v1beta1.types.GetAnnotationSpecSetRequest#

Request message for GetAnnotationSpecSet.

name#

Required. AnnotationSpecSet resource name, format: projects/{p roject_id}/annotationSpecSets/{annotation_spec_set_id}

name

Field google.cloud.datalabeling.v1beta1.GetAnnotationSpecSetRequest.name

class google.cloud.datalabeling_v1beta1.types.GetDataItemRequest#

Request message for GetDataItem.

name#

Required. The name of the data item to get, format: projects/{ project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

name

Field google.cloud.datalabeling.v1beta1.GetDataItemRequest.name

class google.cloud.datalabeling_v1beta1.types.GetDatasetRequest#

Request message for GetDataSet.

name#

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

name

Field google.cloud.datalabeling.v1beta1.GetDatasetRequest.name

class google.cloud.datalabeling_v1beta1.types.GetEvaluationJobRequest#

Request message for GetEvaluationJob.

name#

Required. Name of the evaluation job. Format: ‘projects/{project_id}/evaluationJobs/{evaluation_job_id}’

name

Field google.cloud.datalabeling.v1beta1.GetEvaluationJobRequest.name

class google.cloud.datalabeling_v1beta1.types.GetEvaluationRequest#

Request message for GetEvaluation.

name#

Required. Name of the evaluation. Format: ‘projects/{project_ id}/datasets/{dataset_id}/evaluations/{evaluation_id}’

name

Field google.cloud.datalabeling.v1beta1.GetEvaluationRequest.name

class google.cloud.datalabeling_v1beta1.types.GetExampleRequest#

Request message for GetExample

name#

Required. Name of example, format: projects/{project_id}/data sets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

filter#

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format “annotation_spec.display_name = {display_name}”

filter

Field google.cloud.datalabeling.v1beta1.GetExampleRequest.filter

name

Field google.cloud.datalabeling.v1beta1.GetExampleRequest.name

class google.cloud.datalabeling_v1beta1.types.GetInstructionRequest#

Request message for GetInstruction.

name#

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

name

Field google.cloud.datalabeling.v1beta1.GetInstructionRequest.name

class google.cloud.datalabeling_v1beta1.types.GetOperationRequest#
name#

Field google.longrunning.GetOperationRequest.name

class google.cloud.datalabeling_v1beta1.types.HumanAnnotationConfig#

Configuration for how human labeling task should be done.

instruction#

Required except for LabelAudio case. Instruction resource name.

annotated_dataset_display_name#

Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .

annotated_dataset_description#

Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.

label_group#

Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression [a-zA-Z\d_-]{0,128}.

language_code#

Optional. The Language of this question, as a BCP-47. Default value is en-US. Only need to set this when task is language related. For example, French text classification or Chinese audio transcription.

replica_count#

Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.

question_duration#

Optional. Maximum duration for contributors to answer a question. Default is 1800 seconds.

contributor_emails#

Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd- compute.appspot.com/

user_email_address#

Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.

annotated_dataset_description

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.annotated_dataset_description

annotated_dataset_display_name

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.annotated_dataset_display_name

contributor_emails

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.contributor_emails

instruction

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.instruction

label_group

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.label_group

language_code

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.language_code

question_duration

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.question_duration

replica_count

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.replica_count

user_email_address

Field google.cloud.datalabeling.v1beta1.HumanAnnotationConfig.user_email_address

class google.cloud.datalabeling_v1beta1.types.ImageBoundingPolyAnnotation#

Image bounding poly annotation. It represents a polygon including bounding box in the image.

bounded_area#

The region of the polygon. If it is a bounding box, it is guaranteed to be four points.

annotation_spec#

Label of object in this bounding polygon.

annotation_spec

Field google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation.annotation_spec

bounding_poly#

Field google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation.bounding_poly

normalized_bounding_poly#

Field google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation.normalized_bounding_poly

class google.cloud.datalabeling_v1beta1.types.ImageClassificationAnnotation#

Image classification annotation definition.

annotation_spec#

Label of image.

annotation_spec

Field google.cloud.datalabeling.v1beta1.ImageClassificationAnnotation.annotation_spec

class google.cloud.datalabeling_v1beta1.types.ImageClassificationConfig#

Config for image classification human labeling task.

annotation_spec_set#

Required. Annotation spec set resource name.

allow_multi_label#

Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image.

answer_aggregation_type#

Optional. The type of how to aggregate answers.

allow_multi_label

Field google.cloud.datalabeling.v1beta1.ImageClassificationConfig.allow_multi_label

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.ImageClassificationConfig.annotation_spec_set

answer_aggregation_type

Field google.cloud.datalabeling.v1beta1.ImageClassificationConfig.answer_aggregation_type

class google.cloud.datalabeling_v1beta1.types.ImagePayload#

Container of information about an image.

mime_type#

Image format.

image_thumbnail#

A byte string of a thumbnail image.

image_uri#

Image uri from the user bucket.

signed_uri#

Signed uri of the image file in the service bucket.

image_thumbnail

Field google.cloud.datalabeling.v1beta1.ImagePayload.image_thumbnail

image_uri

Field google.cloud.datalabeling.v1beta1.ImagePayload.image_uri

mime_type

Field google.cloud.datalabeling.v1beta1.ImagePayload.mime_type

signed_uri

Field google.cloud.datalabeling.v1beta1.ImagePayload.signed_uri

class google.cloud.datalabeling_v1beta1.types.ImagePolylineAnnotation#

A polyline for the image annotation.

annotation_spec#

Label of this polyline.

annotation_spec

Field google.cloud.datalabeling.v1beta1.ImagePolylineAnnotation.annotation_spec

normalized_polyline#

Field google.cloud.datalabeling.v1beta1.ImagePolylineAnnotation.normalized_polyline

polyline#

Field google.cloud.datalabeling.v1beta1.ImagePolylineAnnotation.polyline

class google.cloud.datalabeling_v1beta1.types.ImageSegmentationAnnotation#

Image segmentation annotation.

annotation_colors#

The mapping between rgb color and annotation spec. The key is the rgb color represented in format of rgb(0, 0, 0). The value is the AnnotationSpec.

mime_type#

Image format.

image_bytes#

A byte string of a full image’s color map.

class AnnotationColorsEntry#
key#

Field google.cloud.datalabeling.v1beta1.ImageSegmentationAnnotation.AnnotationColorsEntry.key

value#

Field google.cloud.datalabeling.v1beta1.ImageSegmentationAnnotation.AnnotationColorsEntry.value

annotation_colors

Field google.cloud.datalabeling.v1beta1.ImageSegmentationAnnotation.annotation_colors

image_bytes

Field google.cloud.datalabeling.v1beta1.ImageSegmentationAnnotation.image_bytes

mime_type

Field google.cloud.datalabeling.v1beta1.ImageSegmentationAnnotation.mime_type

class google.cloud.datalabeling_v1beta1.types.ImportDataOperationMetadata#

Metadata of an ImportData operation.

dataset#

Ouptut only. The name of imported dataset. “projects//datasets/

partial_failures#

Output only. Partial failures encountered. E.g. single files that couldn’t be read. Status details field will contain standard GCP error details.

create_time#

Output only. Timestamp when import dataset request was created.

create_time

Field google.cloud.datalabeling.v1beta1.ImportDataOperationMetadata.create_time

dataset

Field google.cloud.datalabeling.v1beta1.ImportDataOperationMetadata.dataset

partial_failures

Field google.cloud.datalabeling.v1beta1.ImportDataOperationMetadata.partial_failures

class google.cloud.datalabeling_v1beta1.types.ImportDataOperationResponse#

Response used for ImportData longrunning operation.

dataset#

Ouptut only. The name of imported dataset.

total_count#

Output only. Total number of examples requested to import

import_count#

Output only. Number of examples imported successfully.

dataset

Field google.cloud.datalabeling.v1beta1.ImportDataOperationResponse.dataset

import_count

Field google.cloud.datalabeling.v1beta1.ImportDataOperationResponse.import_count

total_count

Field google.cloud.datalabeling.v1beta1.ImportDataOperationResponse.total_count

class google.cloud.datalabeling_v1beta1.types.ImportDataRequest#

Request message for ImportData API.

name#

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

input_config#

Required. Specify the input source of the data.

user_email_address#

Email of the user who started the import task and should be notified by email. If empty no notification will be sent.

input_config

Field google.cloud.datalabeling.v1beta1.ImportDataRequest.input_config

name

Field google.cloud.datalabeling.v1beta1.ImportDataRequest.name

user_email_address

Field google.cloud.datalabeling.v1beta1.ImportDataRequest.user_email_address

class google.cloud.datalabeling_v1beta1.types.InputConfig#

The configuration of input data, including data type, location, etc.

data_type_metadata#

Optional. The metadata associated with each data type.

text_metadata#

Required for text import, as language code must be specified.

source#

Required. Where the data is from.

gcs_source#

Source located in Cloud Storage.

data_type#

Required. Data type must be specifed when user tries to import data.

annotation_type#

Optional. If input contains annotation, user needs to specify the type and metadata of the annotation when creating it as an annotated dataset.

classification_metadata#

Optional. Metadata about annotations in the input. Each annotation type may have different metadata. Metadata for classification problem.

annotation_type

Field google.cloud.datalabeling.v1beta1.InputConfig.annotation_type

bigquery_source#

Field google.cloud.datalabeling.v1beta1.InputConfig.bigquery_source

classification_metadata

Field google.cloud.datalabeling.v1beta1.InputConfig.classification_metadata

data_type

Field google.cloud.datalabeling.v1beta1.InputConfig.data_type

gcs_source

Field google.cloud.datalabeling.v1beta1.InputConfig.gcs_source

text_metadata

Field google.cloud.datalabeling.v1beta1.InputConfig.text_metadata

class google.cloud.datalabeling_v1beta1.types.Instruction#

Instruction of how to perform the labeling task for human operators. Currently two types of instruction are supported - CSV file and PDF. One of the two types instruction must be provided. CSV file is only supported for image classification task. Instructions for other task should be provided as PDF. For image classification, CSV and PDF can be provided at the same time.

name#

Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

display_name#

Required. The display name of the instruction. Maximum of 64 characters.

description#

Optional. User-provided description of the instruction. The description can be up to 10000 characters long.

create_time#

Output only. Creation time of instruction.

update_time#

Output only. Last update time of instruction.

data_type#

Required. The data type of this instruction.

csv_instruction#

One of CSV or PDF instruction is required. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: - The first column is labeled data, such as an image reference, text. - The second column is comma separated labels associated with data.

pdf_instruction#

One of CSV or PDF instruction is required. Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.

blocking_resources#

Output only. The names of any related resources that are blocking changes to the instruction.

blocking_resources

Field google.cloud.datalabeling.v1beta1.Instruction.blocking_resources

create_time

Field google.cloud.datalabeling.v1beta1.Instruction.create_time

csv_instruction

Field google.cloud.datalabeling.v1beta1.Instruction.csv_instruction

data_type

Field google.cloud.datalabeling.v1beta1.Instruction.data_type

description

Field google.cloud.datalabeling.v1beta1.Instruction.description

display_name

Field google.cloud.datalabeling.v1beta1.Instruction.display_name

name

Field google.cloud.datalabeling.v1beta1.Instruction.name

pdf_instruction

Field google.cloud.datalabeling.v1beta1.Instruction.pdf_instruction

update_time

Field google.cloud.datalabeling.v1beta1.Instruction.update_time

class google.cloud.datalabeling_v1beta1.types.LabelImageBoundingBoxOperationMetadata#

Details of a LabelImageBoundingBox operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelImageBoundingBoxOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelImageBoundingPolyOperationMetadata#

Details of LabelImageBoundingPoly operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelImageBoundingPolyOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelImageClassificationOperationMetadata#

Metadata of a LabelImageClassification operation.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelImageClassificationOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelImageOrientedBoundingBoxOperationMetadata#

Details of a LabelImageOrientedBoundingBox operation metadata.

basic_config#

Basic human annotation config.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelImageOrientedBoundingBoxOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelImagePolylineOperationMetadata#

Details of LabelImagePolyline operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelImagePolylineOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelImageRequest#

Request message for starting an image labeling task.

request_config#

Required. Config for labeling tasks. The type of request config must match the selected feature.

image_classification_config#

Configuration for image classification task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.

bounding_poly_config#

Configuration for bounding box and bounding poly task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.

polyline_config#

Configuration for polyline task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.

segmentation_config#

Configuration for segmentation task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.

parent#

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

basic_config#

Required. Basic human annotation config.

feature#

Required. The type of image labeling task.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelImageRequest.basic_config

bounding_poly_config

Field google.cloud.datalabeling.v1beta1.LabelImageRequest.bounding_poly_config

feature

Field google.cloud.datalabeling.v1beta1.LabelImageRequest.feature

image_classification_config

Field google.cloud.datalabeling.v1beta1.LabelImageRequest.image_classification_config

parent

Field google.cloud.datalabeling.v1beta1.LabelImageRequest.parent

polyline_config

Field google.cloud.datalabeling.v1beta1.LabelImageRequest.polyline_config

segmentation_config

Field google.cloud.datalabeling.v1beta1.LabelImageRequest.segmentation_config

class google.cloud.datalabeling_v1beta1.types.LabelImageSegmentationOperationMetadata#

Details of a LabelImageSegmentation operation metadata.

basic_config#

Basic human annotation config.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelImageSegmentationOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelOperationMetadata#

Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 18

details#

Ouptut only. Details of specific label operation.

image_classification_details#

Details of label image classification operation.

image_bounding_box_details#

Details of label image bounding box operation.

image_bounding_poly_details#

Details of label image bounding poly operation.

image_oriented_bounding_box_details#

Details of label image oriented bounding box operation.

image_polyline_details#

Details of label image polyline operation.

image_segmentation_details#

Details of label image segmentation operation.

video_classification_details#

Details of label video classification operation.

video_object_detection_details#

Details of label video object detection operation.

video_object_tracking_details#

Details of label video object tracking operation.

video_event_details#

Details of label video event operation.

text_classification_details#

Details of label text classification operation.

text_entity_extraction_details#

Details of label text entity extraction operation.

progress_percent#

Output only. Progress of label operation. Range: [0, 100].

partial_failures#

Output only. Partial failures encountered. E.g. single files that couldn’t be read. Status details field will contain standard GCP error details.

create_time#

Output only. Timestamp when labeling request was created.

create_time

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.create_time

image_bounding_box_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.image_bounding_box_details

image_bounding_poly_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.image_bounding_poly_details

image_classification_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.image_classification_details

image_oriented_bounding_box_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.image_oriented_bounding_box_details

image_polyline_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.image_polyline_details

image_segmentation_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.image_segmentation_details

partial_failures

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.partial_failures

progress_percent

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.progress_percent

text_classification_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.text_classification_details

text_entity_extraction_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.text_entity_extraction_details

video_classification_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.video_classification_details

video_event_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.video_event_details

video_object_detection_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.video_object_detection_details

video_object_tracking_details

Field google.cloud.datalabeling.v1beta1.LabelOperationMetadata.video_object_tracking_details

class google.cloud.datalabeling_v1beta1.types.LabelStats#

Statistics about annotation specs.

example_count#

Map of each annotation spec’s example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.

class ExampleCountEntry#
key#

Field google.cloud.datalabeling.v1beta1.LabelStats.ExampleCountEntry.key

value#

Field google.cloud.datalabeling.v1beta1.LabelStats.ExampleCountEntry.value

example_count

Field google.cloud.datalabeling.v1beta1.LabelStats.example_count

class google.cloud.datalabeling_v1beta1.types.LabelTextClassificationOperationMetadata#

Details of a LabelTextClassification operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelTextClassificationOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelTextEntityExtractionOperationMetadata#

Details of a LabelTextEntityExtraction operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelTextEntityExtractionOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelTextRequest#

Request message for LabelText.

request_config#

Required. Config for labeling tasks. The type of request config must match the selected feature.

text_classification_config#

Configuration for text classification task. One of text_classification_config and text_entity_extraction_config is required.

text_entity_extraction_config#

Configuration for entity extraction task. One of text_classification_config and text_entity_extraction_config is required.

parent#

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

basic_config#

Required. Basic human annotation config.

feature#

Required. The type of text labeling task.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelTextRequest.basic_config

feature

Field google.cloud.datalabeling.v1beta1.LabelTextRequest.feature

parent

Field google.cloud.datalabeling.v1beta1.LabelTextRequest.parent

text_classification_config

Field google.cloud.datalabeling.v1beta1.LabelTextRequest.text_classification_config

text_entity_extraction_config

Field google.cloud.datalabeling.v1beta1.LabelTextRequest.text_entity_extraction_config

class google.cloud.datalabeling_v1beta1.types.LabelVideoClassificationOperationMetadata#

Details of a LabelVideoClassification operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelVideoClassificationOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelVideoEventOperationMetadata#

Details of a LabelVideoEvent operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelVideoEventOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelVideoObjectDetectionOperationMetadata#

Details of a LabelVideoObjectDetection operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelVideoObjectDetectionOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelVideoObjectTrackingOperationMetadata#

Details of a LabelVideoObjectTracking operation metadata.

basic_config#

Basic human annotation config used in labeling request.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelVideoObjectTrackingOperationMetadata.basic_config

class google.cloud.datalabeling_v1beta1.types.LabelVideoRequest#

Request message for LabelVideo.

request_config#

Required. Config for labeling tasks. The type of request config must match the selected feature.

video_classification_config#

Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.

object_detection_config#

Configuration for video object detection task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.

object_tracking_config#

Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.

event_config#

Configuration for video event task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.

parent#

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

basic_config#

Required. Basic human annotation config.

feature#

Required. The type of video labeling task.

basic_config

Field google.cloud.datalabeling.v1beta1.LabelVideoRequest.basic_config

event_config

Field google.cloud.datalabeling.v1beta1.LabelVideoRequest.event_config

feature

Field google.cloud.datalabeling.v1beta1.LabelVideoRequest.feature

object_detection_config

Field google.cloud.datalabeling.v1beta1.LabelVideoRequest.object_detection_config

object_tracking_config

Field google.cloud.datalabeling.v1beta1.LabelVideoRequest.object_tracking_config

parent

Field google.cloud.datalabeling.v1beta1.LabelVideoRequest.parent

video_classification_config

Field google.cloud.datalabeling.v1beta1.LabelVideoRequest.video_classification_config

class google.cloud.datalabeling_v1beta1.types.ListAnnotatedDatasetsRequest#

Request message for ListAnnotatedDatasets.

parent#

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}

filter#

Optional. Filter is not supported at this moment.

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [ListAnnotatedDatasetsRespons e.next_page_token][google.cloud.datalabeling.v1beta1.ListAnn otatedDatasetsResponse.next_page_token] of the previous [DataLabelingService.ListAnnotatedDatasets] call. Return first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsRequest.parent

class google.cloud.datalabeling_v1beta1.types.ListAnnotatedDatasetsResponse#

Results of listing annotated datasets for a dataset.

annotated_datasets#

The list of annotated datasets to return.

next_page_token#

A token to retrieve next page of results.

annotated_datasets

Field google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.annotated_datasets

next_page_token

Field google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.ListAnnotationSpecSetsRequest#

Request message for ListAnnotationSpecSets.

parent#

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}

filter#

Optional. Filter is not supported at this moment.

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [ListAnnotationSpecSetsRespon se.next_page_token][google.cloud.datalabeling.v1beta1.ListAn notationSpecSetsResponse.next_page_token] of the previous [DataLabelingService.ListAnnotationSpecSets] call. Return first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsRequest.parent

class google.cloud.datalabeling_v1beta1.types.ListAnnotationSpecSetsResponse#

Results of listing annotation spec set under a project.

annotation_spec_sets#

The list of annotation spec sets.

next_page_token#

A token to retrieve next page of results.

annotation_spec_sets

Field google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.annotation_spec_sets

next_page_token

Field google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.ListDataItemsRequest#

Request message for ListDataItems.

parent#

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

filter#

Optional. Filter is not supported at this moment.

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [ListDataItemsResponse.next_ page_token][google.cloud.datalabeling.v1beta1.ListDataItemsRe sponse.next_page_token] of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.ListDataItemsRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.ListDataItemsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.ListDataItemsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.ListDataItemsRequest.parent

class google.cloud.datalabeling_v1beta1.types.ListDataItemsResponse#

Results of listing data items in a dataset.

data_items#

The list of data items to return.

next_page_token#

A token to retrieve next page of results.

data_items

Field google.cloud.datalabeling.v1beta1.ListDataItemsResponse.data_items

next_page_token

Field google.cloud.datalabeling.v1beta1.ListDataItemsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.ListDatasetsRequest#

Request message for ListDataset.

parent#

Required. Dataset resource parent, format: projects/{project_id}

filter#

Optional. Filter on dataset is not supported at this moment.

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [ListDatasetsResponse.next_p age_token][google.cloud.datalabeling.v1beta1.ListDatasetsResp onse.next_page_token] of the previous [DataLabelingService.ListDatasets] call. Returns the first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.ListDatasetsRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.ListDatasetsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.ListDatasetsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.ListDatasetsRequest.parent

class google.cloud.datalabeling_v1beta1.types.ListDatasetsResponse#

Results of listing datasets within a project.

datasets#

The list of datasets to return.

next_page_token#

A token to retrieve next page of results.

datasets

Field google.cloud.datalabeling.v1beta1.ListDatasetsResponse.datasets

next_page_token

Field google.cloud.datalabeling.v1beta1.ListDatasetsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.ListEvaluationJobsRequest#

Request message for ListEvaluationJobs.

parent#

Required. Evaluation resource parent. Format: “projects/{project_id}”

filter#

Optional. Only support filter by model id and job state. Format: “evaluation_job.model_id = {model_id} AND evaluation_job.state = {EvaluationJob::State}”

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [ListEvaluationJobs.next_page_token][] of the previous [DataLabelingService.ListEvaluationJobs] call. Return first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.ListEvaluationJobsRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.ListEvaluationJobsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.ListEvaluationJobsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.ListEvaluationJobsRequest.parent

class google.cloud.datalabeling_v1beta1.types.ListEvaluationJobsResponse#

Results for listing evaluation jobs.

evaluation_jobs#

The list of evaluation jobs to return.

next_page_token#

A token to retrieve next page of results.

evaluation_jobs

Field google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.evaluation_jobs

next_page_token

Field google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.ListExamplesRequest#

Request message for ListExamples.

parent#

Required. Example resource parent.

filter#

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format “annotation_spec.display_name = {display_name}”

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [ListExamplesResponse.next_p age_token][google.cloud.datalabeling.v1beta1.ListExamplesResp onse.next_page_token] of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.ListExamplesRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.ListExamplesRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.ListExamplesRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.ListExamplesRequest.parent

class google.cloud.datalabeling_v1beta1.types.ListExamplesResponse#

Results of listing Examples in and annotated dataset.

examples#

The list of examples to return.

next_page_token#

A token to retrieve next page of results.

examples

Field google.cloud.datalabeling.v1beta1.ListExamplesResponse.examples

next_page_token

Field google.cloud.datalabeling.v1beta1.ListExamplesResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.ListInstructionsRequest#

Request message for ListInstructions.

parent#

Required. Instruction resource parent, format: projects/{project_id}

filter#

Optional. Filter is not supported at this moment.

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [ListInstructionsResponse.nex t_page_token][google.cloud.datalabeling.v1beta1.ListInstruct ionsResponse.next_page_token] of the previous [DataLabelingService.ListInstructions] call. Return first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.ListInstructionsRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.ListInstructionsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.ListInstructionsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.ListInstructionsRequest.parent

class google.cloud.datalabeling_v1beta1.types.ListInstructionsResponse#

Results of listing instructions under a project.

instructions#

The list of Instructions to return.

next_page_token#

A token to retrieve next page of results.

instructions

Field google.cloud.datalabeling.v1beta1.ListInstructionsResponse.instructions

next_page_token

Field google.cloud.datalabeling.v1beta1.ListInstructionsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.ListOperationsRequest#
filter#

Field google.longrunning.ListOperationsRequest.filter

name#

Field google.longrunning.ListOperationsRequest.name

page_size#

Field google.longrunning.ListOperationsRequest.page_size

page_token#

Field google.longrunning.ListOperationsRequest.page_token

class google.cloud.datalabeling_v1beta1.types.ListOperationsResponse#
next_page_token#

Field google.longrunning.ListOperationsResponse.next_page_token

operations#

Field google.longrunning.ListOperationsResponse.operations

class google.cloud.datalabeling_v1beta1.types.NormalizedBoundingPoly#

Normalized bounding polygon.

normalized_vertices#

The bounding polygon normalized vertices.

normalized_vertices

Field google.cloud.datalabeling.v1beta1.NormalizedBoundingPoly.normalized_vertices

class google.cloud.datalabeling_v1beta1.types.NormalizedPolyline#

Normalized polyline.

normalized_vertices#

The normalized polyline vertices.

normalized_vertices

Field google.cloud.datalabeling.v1beta1.NormalizedPolyline.normalized_vertices

class google.cloud.datalabeling_v1beta1.types.NormalizedVertex#

X coordinate.

y#

Y coordinate.

x#

Field google.cloud.datalabeling.v1beta1.NormalizedVertex.x

y

Field google.cloud.datalabeling.v1beta1.NormalizedVertex.y

class google.cloud.datalabeling_v1beta1.types.ObjectDetectionConfig#

Config for video object detection human labeling task. Object detection will be conducted on the images extracted from the video, and those objects will be labeled with bounding boxes. User need to specify the number of images to be extracted per second as the extraction frame rate.

annotation_spec_set#

Required. Annotation spec set resource name.

extraction_frame_rate#

Required. Number of frames per second to be extracted from the video.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.ObjectDetectionConfig.annotation_spec_set

extraction_frame_rate

Field google.cloud.datalabeling.v1beta1.ObjectDetectionConfig.extraction_frame_rate

class google.cloud.datalabeling_v1beta1.types.ObjectDetectionMetrics#
pr_curve#

Precision-recall curve.

pr_curve

Field google.cloud.datalabeling.v1beta1.ObjectDetectionMetrics.pr_curve

class google.cloud.datalabeling_v1beta1.types.ObjectTrackingConfig#

Config for video object tracking human labeling task.

annotation_spec_set#

Required. Annotation spec set resource name.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.ObjectTrackingConfig.annotation_spec_set

class google.cloud.datalabeling_v1beta1.types.ObjectTrackingFrame#

Video frame level annotation for object detection and tracking.

bounded_area#

The bounding box location of this object track for the frame.

time_offset#

The time offset of this frame relative to the beginning of the video.

bounding_poly#

Field google.cloud.datalabeling.v1beta1.ObjectTrackingFrame.bounding_poly

normalized_bounding_poly#

Field google.cloud.datalabeling.v1beta1.ObjectTrackingFrame.normalized_bounding_poly

time_offset

Field google.cloud.datalabeling.v1beta1.ObjectTrackingFrame.time_offset

class google.cloud.datalabeling_v1beta1.types.Operation#
deserialize()#

Creates new method instance from given serialized data.

done#

Field google.longrunning.Operation.done

error#

Field google.longrunning.Operation.error

metadata#

Field google.longrunning.Operation.metadata

name#

Field google.longrunning.Operation.name

response#

Field google.longrunning.Operation.response

class google.cloud.datalabeling_v1beta1.types.OperationInfo#
metadata_type#

Field google.longrunning.OperationInfo.metadata_type

response_type#

Field google.longrunning.OperationInfo.response_type

class google.cloud.datalabeling_v1beta1.types.OperatorMetadata#

General information useful for labels coming from contributors.

score#

Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).

total_votes#

The total number of contributors that answer this question.

label_votes#

The total number of contributors that choose this label.

comments#

Comments from contributors.

comments

Field google.cloud.datalabeling.v1beta1.OperatorMetadata.comments

label_votes

Field google.cloud.datalabeling.v1beta1.OperatorMetadata.label_votes

score

Field google.cloud.datalabeling.v1beta1.OperatorMetadata.score

total_votes

Field google.cloud.datalabeling.v1beta1.OperatorMetadata.total_votes

class google.cloud.datalabeling_v1beta1.types.OutputConfig#

The configuration of output data.

destination#

Required. Location to output data to.

gcs_destination#

Output to a file in Cloud Storage. Should be used for labeling output other thanimage segmentation.

gcs_folder_destination#

Output to a folder in Cloud Storage. Should be used for image segmentation labeling output.

gcs_destination

Field google.cloud.datalabeling.v1beta1.OutputConfig.gcs_destination

gcs_folder_destination

Field google.cloud.datalabeling.v1beta1.OutputConfig.gcs_folder_destination

class google.cloud.datalabeling_v1beta1.types.PauseEvaluationJobRequest#

Request message for PauseEvaluationJob.

name#

Required. Name of the evaluation job that is going to be paused. Format: ‘projects/{project_id}/evaluationJobs/{evaluation_job_id}’

name

Field google.cloud.datalabeling.v1beta1.PauseEvaluationJobRequest.name

class google.cloud.datalabeling_v1beta1.types.PdfInstruction#

Instruction from a PDF file.

gcs_file_uri#

PDF file for the instruction. Only gcs path is allowed.

gcs_file_uri

Field google.cloud.datalabeling.v1beta1.PdfInstruction.gcs_file_uri

class google.cloud.datalabeling_v1beta1.types.Polyline#

A line with multiple line segments.

vertices#

The polyline vertices.

vertices

Field google.cloud.datalabeling.v1beta1.Polyline.vertices

class google.cloud.datalabeling_v1beta1.types.PolylineConfig#

Config for image polyline human labeling task.

annotation_spec_set#

Required. Annotation spec set resource name.

instruction_message#

Optional. Instruction message showed on contributors UI.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.PolylineConfig.annotation_spec_set

instruction_message

Field google.cloud.datalabeling.v1beta1.PolylineConfig.instruction_message

class google.cloud.datalabeling_v1beta1.types.PrCurve#
annotation_spec#

PR curve against which annotation spec. Could be empty.

area_under_curve#

Area under precision recall curve.

confidence_metrics_entries#

entries to draw PR graph.

mean_average_precision#

mean average prcision of this curve.

class ConfidenceMetricsEntry#
confidence_threshold#

Threshold used for this entry, for example, IoU threshold for bounding box problem, or detection threshold for classification.

recall#

Recall value.

precision#

Precision value.

f1_score#

Harmonic mean of recall and precision.

recall_at1#

Recall value for entries with label that has highest score.

precision_at1#

Precision value for entries with label that has highest score.

f1_score_at1#

The harmonic mean of [recall_at1][google.cloud.datalabeling.v 1beta1.PrCurve.ConfidenceMetricsEntry.recall_at1] and [precis ion_at1][google.cloud.datalabeling.v1beta1.PrCurve.Confidence MetricsEntry.precision_at1].

recall_at5#

Recall value for entries with label that has highest 5 scores.

precision_at5#

Precision value for entries with label that has highest 5 scores.

f1_score_at5#

The harmonic mean of [recall_at5][google.cloud.datalabeling.v 1beta1.PrCurve.ConfidenceMetricsEntry.recall_at5] and [precis ion_at5][google.cloud.datalabeling.v1beta1.PrCurve.Confidence MetricsEntry.precision_at5].

confidence_threshold

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.confidence_threshold

f1_score

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.f1_score

f1_score_at1

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.f1_score_at1

f1_score_at5

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.f1_score_at5

precision

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.precision

precision_at1

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.precision_at1

precision_at5

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.precision_at5

recall

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.recall

recall_at1

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.recall_at1

recall_at5

Field google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry.recall_at5

annotation_spec

Field google.cloud.datalabeling.v1beta1.PrCurve.annotation_spec

area_under_curve

Field google.cloud.datalabeling.v1beta1.PrCurve.area_under_curve

confidence_metrics_entries

Field google.cloud.datalabeling.v1beta1.PrCurve.confidence_metrics_entries

mean_average_precision

Field google.cloud.datalabeling.v1beta1.PrCurve.mean_average_precision

class google.cloud.datalabeling_v1beta1.types.ResumeEvaluationJobRequest#

Request message ResumeEvaluationJob.

name#

Required. Name of the evaluation job that is going to be resumed. Format: ‘projects/{project_id}/evaluationJobs/{evaluation_job_id}’

name

Field google.cloud.datalabeling.v1beta1.ResumeEvaluationJobRequest.name

class google.cloud.datalabeling_v1beta1.types.SearchEvaluationsRequest#

Request message for SearchEvaluation.

parent#

Required. Evaluation search parent. Format: projects/{project_id}

filter#

Optional. Support filtering by model id, job state, start and end time. Format: “evaluation_job.evaluation_job_id = {evaluation_job_id} AND evaluation_job.evaluation_job_run_time_start = {timestamp} AND evaluation_job.evaluation_job_run_time_end = {timestamp} AND annotation_spec.display_name = {display_name}”

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [SearchEvaluationsResponse.ne xt_page_token][google.cloud.datalabeling.v1beta1.SearchEvalu ationsResponse.next_page_token] of the previous [DataLabelingService.SearchEvaluations] call. Return first page if empty.

filter

Field google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest.filter

page_size

Field google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest.parent

class google.cloud.datalabeling_v1beta1.types.SearchEvaluationsResponse#

Results of searching evaluations.

evaluations#

The list of evaluations to return.

next_page_token#

A token to retrieve next page of results.

evaluations

Field google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.evaluations

next_page_token

Field google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.SearchExampleComparisonsRequest#

Request message of SearchExampleComparisons.

parent#

Required. Name of the Evaluation resource to search example comparison from. Format: projects/{project_id}/datasets/{data set_id}/evaluations/{evaluation_id}

page_size#

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

page_token#

Optional. A token identifying a page of results for the server to return. Typically obtained by [SearchExampleComparisons.next_page_token][] of the previous [DataLabelingService.SearchExampleComparisons] call. Return first page if empty.

page_size

Field google.cloud.datalabeling.v1beta1.SearchExampleComparisonsRequest.page_size

page_token

Field google.cloud.datalabeling.v1beta1.SearchExampleComparisonsRequest.page_token

parent

Field google.cloud.datalabeling.v1beta1.SearchExampleComparisonsRequest.parent

class google.cloud.datalabeling_v1beta1.types.SearchExampleComparisonsResponse#

Results of searching example comparisons.

next_page_token#

A token to retrieve next page of results.

class ExampleComparison#

Example comparisons containing annotation comparison between groundtruth and predictions.

ground_truth_example#

Field google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison.ground_truth_example

model_created_examples#

Field google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison.model_created_examples

example_comparisons#

Field google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.example_comparisons

next_page_token

Field google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.next_page_token

class google.cloud.datalabeling_v1beta1.types.SegmentationConfig#

Config for image segmentation

annotation_spec_set#

Required. Annotation spec set resource name. format: projects/ {project_id}/annotationSpecSets/{annotation_spec_set_id}

instruction_message#

Instruction message showed on labelers UI.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.SegmentationConfig.annotation_spec_set

instruction_message

Field google.cloud.datalabeling.v1beta1.SegmentationConfig.instruction_message

class google.cloud.datalabeling_v1beta1.types.SentimentConfig#

Config for setting up sentiments.

enable_label_sentiment_selection#

If set to true, contributors will have the option to select sentiment of the label they selected, to mark it as negative or positive label. Default is false.

enable_label_sentiment_selection

Field google.cloud.datalabeling.v1beta1.SentimentConfig.enable_label_sentiment_selection

class google.cloud.datalabeling_v1beta1.types.SequentialSegment#

Start and end position in a sequence (e.g. text segment).

start#

Start position (inclusive).

end#

End position (exclusive).

end

Field google.cloud.datalabeling.v1beta1.SequentialSegment.end

start

Field google.cloud.datalabeling.v1beta1.SequentialSegment.start

class google.cloud.datalabeling_v1beta1.types.Status#
code#

Field google.rpc.Status.code

details#

Field google.rpc.Status.details

message#

Field google.rpc.Status.message

class google.cloud.datalabeling_v1beta1.types.TextClassificationAnnotation#

Text classification annotation.

annotation_spec#

Label of the text.

annotation_spec

Field google.cloud.datalabeling.v1beta1.TextClassificationAnnotation.annotation_spec

class google.cloud.datalabeling_v1beta1.types.TextClassificationConfig#

Config for text classification human labeling task.

allow_multi_label#

Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one text segment.

annotation_spec_set#

Required. Annotation spec set resource name.

sentiment_config#

Optional. Configs for sentiment selection.

allow_multi_label

Field google.cloud.datalabeling.v1beta1.TextClassificationConfig.allow_multi_label

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.TextClassificationConfig.annotation_spec_set

sentiment_config

Field google.cloud.datalabeling.v1beta1.TextClassificationConfig.sentiment_config

class google.cloud.datalabeling_v1beta1.types.TextEntityExtractionAnnotation#

Text entity extraction annotation.

annotation_spec#

Label of the text entities.

sequential_segment#

Position of the entity.

annotation_spec

Field google.cloud.datalabeling.v1beta1.TextEntityExtractionAnnotation.annotation_spec

sequential_segment

Field google.cloud.datalabeling.v1beta1.TextEntityExtractionAnnotation.sequential_segment

class google.cloud.datalabeling_v1beta1.types.TextEntityExtractionConfig#

Config for text entity extraction human labeling task.

annotation_spec_set#

Required. Annotation spec set resource name.

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.TextEntityExtractionConfig.annotation_spec_set

class google.cloud.datalabeling_v1beta1.types.TextMetadata#

Metadata for the text.

language_code#

The language of this text, as a BCP-47. Default value is en-US.

language_code

Field google.cloud.datalabeling.v1beta1.TextMetadata.language_code

class google.cloud.datalabeling_v1beta1.types.TextPayload#

Container of information about a piece of text.

text_content#

Text content.

text_content

Field google.cloud.datalabeling.v1beta1.TextPayload.text_content

class google.cloud.datalabeling_v1beta1.types.TimeSegment#

A time period inside of an example that has a time dimension (e.g. video).

start_time_offset#

Start of the time segment (inclusive), represented as the duration since the example start.

end_time_offset#

End of the time segment (exclusive), represented as the duration since the example start.

end_time_offset

Field google.cloud.datalabeling.v1beta1.TimeSegment.end_time_offset

start_time_offset

Field google.cloud.datalabeling.v1beta1.TimeSegment.start_time_offset

class google.cloud.datalabeling_v1beta1.types.Timestamp#
nanos#

Field google.protobuf.Timestamp.nanos

seconds#

Field google.protobuf.Timestamp.seconds

class google.cloud.datalabeling_v1beta1.types.UpdateEvaluationJobRequest#

Request message for UpdateEvaluationJob.

evaluation_job#

Required. Evaluation job that is going to be updated.

update_mask#

Optional. Mask for which field in evaluation_job should be updated.

evaluation_job

Field google.cloud.datalabeling.v1beta1.UpdateEvaluationJobRequest.evaluation_job

update_mask

Field google.cloud.datalabeling.v1beta1.UpdateEvaluationJobRequest.update_mask

class google.cloud.datalabeling_v1beta1.types.Vertex#

X coordinate.

y#

Y coordinate.

x#

Field google.cloud.datalabeling.v1beta1.Vertex.x

y

Field google.cloud.datalabeling.v1beta1.Vertex.y

class google.cloud.datalabeling_v1beta1.types.VideoClassificationAnnotation#

Video classification annotation.

time_segment#

The time segment of the video to which the annotation applies.

annotation_spec#

Label of the segment specified by time_segment.

annotation_spec

Field google.cloud.datalabeling.v1beta1.VideoClassificationAnnotation.annotation_spec

time_segment

Field google.cloud.datalabeling.v1beta1.VideoClassificationAnnotation.time_segment

class google.cloud.datalabeling_v1beta1.types.VideoClassificationConfig#

Config for video classification human labeling task. Currently two types of video classification are supported: 1. Assign labels on the entire video. 2. Split the video into multiple video clips based on camera shot, and assign labels on each video clip.

annotation_spec_set_configs#

Required. The list of annotation spec set configs. Since watching a video clip takes much longer time than an image, we support label with multiple AnnotationSpecSet at the same time. Labels in each AnnotationSpecSet will be shown in a group to contributors. Contributors can select one or more (depending on whether to allow multi label) from each group.

apply_shot_detection#

Optional. Option to apply shot detection on the video.

class AnnotationSpecSetConfig#

Annotation spec set with the setting of allowing multi labels or not.

annotation_spec_set#

Required. Annotation spec set resource name.

allow_multi_label#

Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set.

allow_multi_label

Field google.cloud.datalabeling.v1beta1.VideoClassificationConfig.AnnotationSpecSetConfig.allow_multi_label

annotation_spec_set

Field google.cloud.datalabeling.v1beta1.VideoClassificationConfig.AnnotationSpecSetConfig.annotation_spec_set

annotation_spec_set_configs

Field google.cloud.datalabeling.v1beta1.VideoClassificationConfig.annotation_spec_set_configs

apply_shot_detection

Field google.cloud.datalabeling.v1beta1.VideoClassificationConfig.apply_shot_detection

class google.cloud.datalabeling_v1beta1.types.VideoEventAnnotation#

Video event annotation.

annotation_spec#

Label of the event in this annotation.

time_segment#

The time segment of the video to which the annotation applies.

annotation_spec

Field google.cloud.datalabeling.v1beta1.VideoEventAnnotation.annotation_spec

time_segment

Field google.cloud.datalabeling.v1beta1.VideoEventAnnotation.time_segment

class google.cloud.datalabeling_v1beta1.types.VideoObjectTrackingAnnotation#

Video object tracking annotation.

annotation_spec#

Label of the object tracked in this annotation.

time_segment#

The time segment of the video to which object tracking applies.

object_tracking_frames#

The list of frames where this object track appears.

annotation_spec

Field google.cloud.datalabeling.v1beta1.VideoObjectTrackingAnnotation.annotation_spec

object_tracking_frames

Field google.cloud.datalabeling.v1beta1.VideoObjectTrackingAnnotation.object_tracking_frames

time_segment

Field google.cloud.datalabeling.v1beta1.VideoObjectTrackingAnnotation.time_segment

class google.cloud.datalabeling_v1beta1.types.VideoPayload#

Container of information of a video.

mime_type#

Video format.

video_uri#

Video uri from the user bucket.

video_thumbnails#

The list of video thumbnails.

frame_rate#

FPS of the video.

signed_uri#

Signed uri of the video file in the service bucket.

frame_rate

Field google.cloud.datalabeling.v1beta1.VideoPayload.frame_rate

mime_type

Field google.cloud.datalabeling.v1beta1.VideoPayload.mime_type

signed_uri

Field google.cloud.datalabeling.v1beta1.VideoPayload.signed_uri

video_thumbnails

Field google.cloud.datalabeling.v1beta1.VideoPayload.video_thumbnails

video_uri

Field google.cloud.datalabeling.v1beta1.VideoPayload.video_uri

class google.cloud.datalabeling_v1beta1.types.VideoThumbnail#

Container of information of a video thumbnail.

thumbnail#

A byte string of the video frame.

time_offset#

Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.

thumbnail

Field google.cloud.datalabeling.v1beta1.VideoThumbnail.thumbnail

time_offset

Field google.cloud.datalabeling.v1beta1.VideoThumbnail.time_offset