API documentation for datalabeling_v1beta1.types module.
Classes
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.
Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.
Output only. Source of the annotation.
Output only. Number of examples in the annotated dataset.
Output only. Per label statistics.
Output only. Additional information about AnnotatedDataset.
AnnotatedDatasetMetadata
Metadata on AnnotatedDataset.
Configuration for image classification task.
Configuration for image polyline task.
Configuration for video classification task.
Configuration for video object tracking task.
Configuration for text classification task.
HumanAnnotationConfig used when requesting the human labeling task for this AnnotatedDataset.
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.
Output only. The source of the annotation.
Output only. Annotation metadata, including information like votes for labels.
AnnotationMetadata
Additional information associated with the annotation.
AnnotationSpec
Container of information related to one annotation spec.
Optional. User-provided description of the annotation specification. The description can be up to 10000 characters long.
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.
Required. The display name for AnnotationSpecSet defined by user. Maximum of 64 characters.
Required. The actual spec set defined by the users.
AnnotationValue
Annotation value for an example.
Annotation value for image bounding box, oriented bounding box and polygon cases.
Annotation value for image segmentation.
Annotation value for text entity extraction case.
Annotation value for video object detection and tracking case.
Any
API documentation for datalabeling_v1beta1.types.Any class.
Attempt
Records a failed attempt.
BigQuerySource
The BigQuery location for the input content.
BoundingBoxEvaluationOptions
Options regarding evaluation between bounding boxes.
BoundingPoly
A bounding polygon in the image.
BoundingPolyConfig
Config for image bounding poly (and bounding box) human labeling task.
Optional. Instruction message showed on contributors UI.
CancelOperationRequest
API documentation for datalabeling_v1beta1.types.CancelOperationRequest class.
ClassificationMetadata
Metadata for classification annotations.
ClassificationMetrics
ConfusionMatrix
Confusion matrix of the model running the classification. Not applicable when label filtering is specified in evaluation option.
CreateAnnotationSpecSetRequest
Request message for CreateAnnotationSpecSet.
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.
CreateDatasetRequest
Request message for CreateDataset.
Required. The dataset to be created.
CreateEvaluationJobRequest
Request message for CreateEvaluationJob.
Required. The evaluation job to create.
CreateInstructionMetadata
Metadata of a CreateInstruction operation.
Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.
CreateInstructionRequest
Request message for CreateInstruction.
Required. Instruction of how to perform the labeling task.
CsvInstruction
Instruction from a CSV file.
DataItem
DataItem is a piece of data, without annotation. For example, an image.
The image payload, a container of the image bytes/uri.
The video payload, a container of the video uri.
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.
Required. The display name of the dataset. Maximum of 64 characters.
Output only. Time the dataset is created.
Output only. The names of any related resources that are blocking changes to the dataset.
DeleteAnnotatedDatasetRequest
Request message for DeleteAnnotatedDataset.
DeleteAnnotationSpecSetRequest
Request message for DeleteAnnotationSpecSet.
DeleteDatasetRequest
Request message for DeleteDataset.
DeleteEvaluationJobRequest
Request message DeleteEvaluationJob.
DeleteInstructionRequest
Request message for DeleteInstruction.
DeleteOperationRequest
API documentation for datalabeling_v1beta1.types.DeleteOperationRequest class.
Duration
API documentation for datalabeling_v1beta1.types.Duration class.
Empty
API documentation for datalabeling_v1beta1.types.Empty class.
Evaluation
Describes an evaluation between 2 annotated datasets. Created by an evaluation plan.
Options used in evaluation plan for creating the evaluation.
Output only. Timestamp when this model evaluation was created.
Type of the annotation to compute metrics for in the groundtruth and annotation labeled dataset. Required for creation.
EvaluationConfig
EvaluationJob
Defines an evaluation job that is triggered periodically to generate evaluations.
Description of the job. The description can be up to 25000 characters long.
The versioned model that is being evaluated here. Only one job is allowed for each model name. Format: 'projects//models//versions/*'
Name of the AnnotationSpecSet.
Output only. Any attempts with errors happening in evaluation job runs each time will be recorded here incrementally.
EvaluationJobAlertConfig
If a single evaluation run's aggregate mean average precision is lower than this threshold, the alert will be triggered.
EvaluationJobConfig
Input config for data, gcs_source in the config will be the root path for data. Data should be organzied chronically under that path.
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
Percentage of examples to collect in each period. 0.1 means 10% of total examples will be collected, and 0.0 means no collection.
EvaluationMetrics
EventConfig
Config for video event human labeling task.
Example
An Example is a piece of data and its annotation. For example, an image with label "house".
The image payload, a container of the image bytes/uri.
The video payload, a container of the video uri.
Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.
ExportDataOperationMetadata
Metadata of an ExportData operation.
Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.
ExportDataOperationResponse
Response used for ExportDataset longrunning operation.
Output only. Total number of examples requested to export
Output only. Statistic infos of labels in the exported dataset.
ExportDataRequest
Request message for ExportData API.
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}
Required. Specify the output destination.
FieldMask
API documentation for datalabeling_v1beta1.types.FieldMask class.
GcsDestination
Export destination of the data.Only gcs path is allowed in output_uri.
Required. The format of the gcs destination. Only "text/csv" and "application/json" are supported.
GcsFolderDestination
Export folder destination of the data.
GcsSource
Source of the Cloud Storage file to be imported.
Required. The format of the source file. Only "text/csv" is supported.
GetAnnotatedDatasetRequest
Request message for GetAnnotatedDataset.
GetAnnotationSpecSetRequest
Request message for GetAnnotationSpecSet.
GetDataItemRequest
Request message for GetDataItem.
GetDatasetRequest
Request message for GetDataSet.
GetEvaluationJobRequest
Request message for GetEvaluationJob.
GetEvaluationRequest
Request message for GetEvaluation.
GetExampleRequest
Request message for GetExample
Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
GetInstructionRequest
Request message for GetInstruction.
GetOperationRequest
API documentation for datalabeling_v1beta1.types.GetOperationRequest class.
HumanAnnotationConfig
Configuration for how human labeling task should be done.
Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .
Optional. A human-readable label used to logically group
labeling tasks. This string must match the regular expression
[a-zA-Z\d_-]{0,128}.
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.
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/
ImageBoundingPolyAnnotation
Image bounding poly annotation. It represents a polygon including bounding box in the image.
Label of object in this bounding polygon.
ImageClassificationAnnotation
Image classification annotation definition.
ImageClassificationConfig
Config for image classification human labeling task.
Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image.
ImagePayload
Container of information about an image.
A byte string of a thumbnail image.
Signed uri of the image file in the service bucket.
ImagePolylineAnnotation
A polyline for the image annotation.
ImageSegmentationAnnotation
Image segmentation annotation.
Image format.
ImportDataOperationMetadata
Metadata of an ImportData operation.
Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.
ImportDataOperationResponse
Response used for ImportData longrunning operation.
Output only. Total number of examples requested to import
ImportDataRequest
Request message for ImportData API.
Required. Specify the input source of the data.
InputConfig
The configuration of input data, including data type, location, etc.
Required for text import, as language code must be specified.
Source located in Cloud Storage.
Optional. If input contains annotation, user needs to specify the type and metadata of the annotation when creating it as an annotated dataset.
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.
Required. The display name of the instruction. Maximum of 64 characters.
Output only. Creation time of instruction.
Required. The data type of this instruction.
One of CSV or PDF instruction is required. Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.
LabelImageBoundingBoxOperationMetadata
Details of a LabelImageBoundingBox operation metadata.
LabelImageBoundingPolyOperationMetadata
Details of LabelImageBoundingPoly operation metadata.
LabelImageClassificationOperationMetadata
Metadata of a LabelImageClassification operation.
LabelImageOrientedBoundingBoxOperationMetadata
Details of a LabelImageOrientedBoundingBox operation metadata.
LabelImagePolylineOperationMetadata
Details of LabelImagePolyline operation metadata.
LabelImageRequest
Request message for starting an image labeling task.
Configuration for image classification task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.
Configuration for polyline task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.
Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Required. The type of image labeling task.
LabelImageSegmentationOperationMetadata
Details of a LabelImageSegmentation operation metadata.
LabelOperationMetadata
Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 18
Details of label image classification operation.
Details of label image bounding poly operation.
Details of label image polyline operation.
Details of label video classification operation.
Details of label video object tracking operation.
Details of label text classification operation.
Output only. Progress of label operation. Range: [0, 100].
Output only. Timestamp when labeling request was created.
LabelStats
Statistics about annotation specs.
LabelTextClassificationOperationMetadata
Details of a LabelTextClassification operation metadata.
LabelTextEntityExtractionOperationMetadata
Details of a LabelTextEntityExtraction operation metadata.
LabelTextRequest
Request message for LabelText.
Configuration for text classification task. One of text_classification_config and text_entity_extraction_config is required.
Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Required. The type of text labeling task.
LabelVideoClassificationOperationMetadata
Details of a LabelVideoClassification operation metadata.
LabelVideoEventOperationMetadata
Details of a LabelVideoEvent operation metadata.
LabelVideoObjectDetectionOperationMetadata
Details of a LabelVideoObjectDetection operation metadata.
LabelVideoObjectTrackingOperationMetadata
Details of a LabelVideoObjectTracking operation metadata.
LabelVideoRequest
Request message for LabelVideo.
Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.
Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.
Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Required. The type of video labeling task.
ListAnnotatedDatasetsRequest
Request message for ListAnnotatedDatasets.
Optional. Filter is not supported at this moment.
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.
ListAnnotatedDatasetsResponse
Results of listing annotated datasets for a dataset.
A token to retrieve next page of results.
ListAnnotationSpecSetsRequest
Request message for ListAnnotationSpecSets.
Optional. Filter is not supported at this moment.
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.
ListAnnotationSpecSetsResponse
Results of listing annotation spec set under a project.
A token to retrieve next page of results.
ListDataItemsRequest
Request message for ListDataItems.
Optional. Filter is not supported at this moment.
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.
ListDataItemsResponse
Results of listing data items in a dataset.
A token to retrieve next page of results.
ListDatasetsRequest
Request message for ListDataset.
Optional. Filter on dataset is not supported at this moment.
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.
ListDatasetsResponse
Results of listing datasets within a project.
A token to retrieve next page of results.
ListEvaluationJobsRequest
Request message for ListEvaluationJobs.
Optional. Only support filter by model id and job state. Format: "evaluation_job.model_id = {model_id} AND evaluation_job.state = {EvaluationJob::State}"
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.
ListEvaluationJobsResponse
Results for listing evaluation jobs.
A token to retrieve next page of results.
ListExamplesRequest
Request message for ListExamples.
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}"
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.
ListExamplesResponse
Results of listing Examples in and annotated dataset.
A token to retrieve next page of results.
ListInstructionsRequest
Request message for ListInstructions.
Optional. Filter is not supported at this moment.
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.
ListInstructionsResponse
Results of listing instructions under a project.
A token to retrieve next page of results.
ListOperationsRequest
API documentation for datalabeling_v1beta1.types.ListOperationsRequest class.
ListOperationsResponse
API documentation for datalabeling_v1beta1.types.ListOperationsResponse class.
NormalizedBoundingPoly
Normalized bounding polygon.
NormalizedPolyline
Normalized polyline.
NormalizedVertex
X coordinate.
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.
Required. Number of frames per second to be extracted from the video.
ObjectDetectionMetrics
ObjectTrackingConfig
Config for video object tracking human labeling task.
ObjectTrackingFrame
Video frame level annotation for object detection and tracking.
The time offset of this frame relative to the beginning of the video.
Operation
API documentation for datalabeling_v1beta1.types.Operation class.
OperationInfo
API documentation for datalabeling_v1beta1.types.OperationInfo class.
OperatorMetadata
General information useful for labels coming from contributors.
The total number of contributors that answer this question.
Comments from contributors.
OutputConfig
The configuration of output data.
Output to a file in Cloud Storage. Should be used for labeling output other thanimage segmentation.
PauseEvaluationJobRequest
Request message for PauseEvaluationJob.
PdfInstruction
Instruction from a PDF file.
Polyline
A line with multiple line segments.
PolylineConfig
Config for image polyline human labeling task.
Optional. Instruction message showed on contributors UI.
PrCurve
Area under precision recall curve.
mean average prcision of this curve.
ResumeEvaluationJobRequest
Request message ResumeEvaluationJob.
SearchEvaluationsRequest
Request message for SearchEvaluation.
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}"
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.
SearchEvaluationsResponse
Results of searching evaluations.
A token to retrieve next page of results.
SearchExampleComparisonsRequest
Request message of SearchExampleComparisons.
Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
SearchExampleComparisonsResponse
Results of searching example comparisons.
SegmentationConfig
Config for image segmentation
Instruction message showed on labelers UI.
SentimentConfig
Config for setting up sentiments.
SequentialSegment
Start and end position in a sequence (e.g. text segment).
End position (exclusive).
Status
API documentation for datalabeling_v1beta1.types.Status class.
TextClassificationAnnotation
Text classification annotation.
TextClassificationConfig
Config for text classification human labeling task.
Required. Annotation spec set resource name.
TextEntityExtractionAnnotation
Text entity extraction annotation.
Position of the entity.
TextEntityExtractionConfig
Config for text entity extraction human labeling task.
TextMetadata
Metadata for the text.
TextPayload
Container of information about a piece of text.
TimeSegment
A time period inside of an example that has a time dimension (e.g. video).
End of the time segment (exclusive), represented as the duration since the example start.
Timestamp
API documentation for datalabeling_v1beta1.types.Timestamp class.
UpdateEvaluationJobRequest
Request message for UpdateEvaluationJob.
Optional. Mask for which field in evaluation_job should be updated.
Vertex
X coordinate.
VideoClassificationAnnotation
Video classification annotation.
Label of the segment specified by time_segment.
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.
Optional. Option to apply shot detection on the video.
VideoEventAnnotation
Video event annotation.
The time segment of the video to which the annotation applies.
VideoObjectTrackingAnnotation
Video object tracking annotation.
The time segment of the video to which object tracking applies.
VideoPayload
Container of information of a video.
Video uri from the user bucket.
FPS of the video.
VideoThumbnail
Container of information of a video thumbnail.
Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.
WaitOperationRequest
API documentation for datalabeling_v1beta1.types.WaitOperationRequest class.