{ "name": "datalabeling", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Data Labeling", "fullyEncodeReservedExpansion": true, "rootUrl": "https://datalabeling.googleapis.com/", "baseUrl": "https://datalabeling.googleapis.com/", "schemas": { "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { "properties": { "createTime": { "format": "google-datetime", "description": "Timestamp when create instruction request was created.", "type": "string" }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "instruction": { "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", "type": "string" } }, "id": "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata", "type": "object", "description": "Metadata of a CreateInstruction operation." }, "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination": { "id": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", "description": "Export folder destination of the data.", "type": "object", "properties": { "outputFolderUri": { "description": "Required. Cloud Storage directory to export data to.", "type": "string" } } }, "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata": { "description": "Details of LabelImageBoundingPoly operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", "description": "Details of a LabelImageBoundingBox operation metadata.", "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelStats": { "properties": { "exampleCount": { "type": "object", "description": "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.", "additionalProperties": { "type": "string", "format": "int64" } } }, "description": "Statistics about annotation specs.", "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelStats" }, "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig": { "properties": { "annotationSpecSet": { "description": "Required. Annotation spec set resource name.", "type": "string" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", "description": "Config for text entity extraction human labeling task." }, "GoogleCloudDatalabelingV1alpha1GcsFolderDestination": { "id": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", "description": "Export folder destination of the data.", "type": "object", "properties": { "outputFolderUri": { "type": "string", "description": "Required. Cloud Storage directory to export data to." } } }, "GoogleCloudDatalabelingV1p2alpha1OutputConfig": { "description": "The configuration of output data.", "id": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", "type": "object", "properties": { "gcsDestination": { "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsDestination" }, "gcsFolderDestination": { "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs.", "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination" } } }, "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata": { "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata", "properties": { "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "textClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", "description": "Details of label text classification operation." }, "textEntityExtractionDetails": { "description": "Details of label text entity extraction operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata" }, "dataset": { "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", "type": "string" }, "imageOrientedBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of label image oriented bounding box operation." }, "progressPercent": { "format": "int32", "description": "Output only. Progress of label operation. Range: [0, 100].", "type": "integer" }, "imageBoundingBoxDetails": { "description": "Details of label image bounding box operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata" }, "videoClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", "description": "Details of label video classification operation." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when labeling request was created." }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "videoObjectTrackingDetails": { "description": "Details of label video object tracking operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata" }, "videoEventDetails": { "description": "Details of label video event operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata" }, "imageBoundingPolyDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", "description": "Details of label image bounding poly operation." }, "imageClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", "description": "Details of label image classification operation." }, "imagePolylineDetails": { "description": "Details of label image polyline operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata" }, "imageSegmentationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", "description": "Details of label image segmentation operation." }, "videoObjectDetectionDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata", "description": "Details of label video object detection operation." } } }, "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata": { "description": "Metadata of an ImportData operation.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata", "properties": { "partialFailures": { "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "dataset": { "type": "string", "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"" }, "createTime": { "description": "Output only. Timestamp when import dataset request was created.", "format": "google-datetime", "type": "string" } } }, "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata", "type": "object", "description": "Metadata of an ExportData operation.", "properties": { "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "partialFailures": { "type": "array", "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when export dataset request was created." }, "dataset": { "type": "string", "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"" } } }, "GoogleCloudDatalabelingV1beta1LabelStats": { "properties": { "exampleCount": { "additionalProperties": { "type": "string", "format": "int64" }, "type": "object", "description": "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." } }, "description": "Statistics about annotation specs.", "id": "GoogleCloudDatalabelingV1beta1LabelStats", "type": "object" }, "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest": { "id": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest", "type": "object", "description": "Request message for PauseEvaluationJob.", "properties": {} }, "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation": { "description": "Text entity extraction annotation.", "properties": { "sequentialSegment": { "description": "Position of the entity.", "$ref": "GoogleCloudDatalabelingV1beta1SequentialSegment" }, "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of the text entities." } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation" }, "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata": { "properties": { "thumbnail": { "type": "string", "format": "byte", "description": "An image thumbnail of this thread." }, "createTime": { "format": "google-datetime", "type": "string", "description": "When the thread is created" }, "status": { "enum": [ "FEEDBACK_THREAD_STATUS_UNSPECIFIED", "NEW", "REPLIED" ], "type": "string", "enumDescriptions": [ "", "Feedback thread is created with no reply;", "Feedback thread is replied at least once;" ] }, "lastUpdateTime": { "type": "string", "format": "google-datetime", "description": "When the thread is last updated." } }, "id": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", "type": "object" }, "GoogleCloudDatalabelingV1beta1ConfusionMatrix": { "type": "object", "properties": { "row": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1Row" }, "type": "array" } }, "description": "Confusion matrix of the model running the classification. Only applicable when the metrics entry aggregates multiple labels. Not applicable when the entry is for a single label.", "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrix" }, "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "type": "object", "description": "Details of a LabelTextEntityExtraction operation metadata.", "id": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata" }, "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination": { "description": "Export folder destination of the data.", "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination", "properties": { "outputFolderUri": { "description": "Required. Cloud Storage directory to export data to.", "type": "string" } } }, "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig": { "type": "object", "description": "Configuration for how human labeling task should be done.", "id": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "properties": { "contributorEmails": { "type": "array", "items": { "type": "string" }, "description": "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/" }, "replicaCount": { "description": "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.", "type": "integer", "format": "int32" }, "userEmailAddress": { "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", "type": "string" }, "instruction": { "type": "string", "description": "Required. Instruction resource name." }, "questionDuration": { "format": "google-duration", "type": "string", "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds." }, "annotatedDatasetDisplayName": { "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", "type": "string" }, "annotatedDatasetDescription": { "type": "string", "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long." }, "labelGroup": { "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", "type": "string" }, "languageCode": { "type": "string", "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification." } } }, "GoogleCloudDatalabelingV1beta1SegmentationConfig": { "properties": { "instructionMessage": { "type": "string", "description": "Instruction message showed on labelers UI." }, "annotationSpecSet": { "description": "Required. Annotation spec set resource name. format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", "type": "string" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1SegmentationConfig", "description": "Config for image segmentation" }, "GoogleCloudDatalabelingV1beta1PolylineConfig": { "type": "object", "properties": { "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." }, "instructionMessage": { "type": "string", "description": "Optional. Instruction message showed on contributors UI." } }, "description": "Config for image polyline human labeling task.", "id": "GoogleCloudDatalabelingV1beta1PolylineConfig" }, "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation": { "type": "object", "properties": { "polyline": { "$ref": "GoogleCloudDatalabelingV1beta1Polyline" }, "normalizedPolyline": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedPolyline" }, "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of this polyline." } }, "id": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", "description": "A polyline for the image annotation." }, "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse", "description": "Response used for ImportData longrunning operation.", "properties": { "importCount": { "format": "int32", "type": "integer", "description": "Output only. Number of examples imported successfully." }, "dataset": { "type": "string", "description": "Ouptut only. The name of imported dataset." }, "totalCount": { "type": "integer", "description": "Output only. Total number of examples requested to import", "format": "int32" } } }, "GoogleCloudDatalabelingV1beta1NormalizedVertex": { "properties": { "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "x": { "format": "float", "description": "X coordinate.", "type": "number" } }, "id": "GoogleCloudDatalabelingV1beta1NormalizedVertex", "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "type": "object" }, "GoogleCloudDatalabelingV1beta1Dataset": { "id": "GoogleCloudDatalabelingV1beta1Dataset", "description": "Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.", "properties": { "dataItemCount": { "description": "Output only. The number of data items in the dataset.", "format": "int64", "type": "string" }, "lastMigrateTime": { "description": "Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.", "format": "google-datetime", "type": "string" }, "description": { "type": "string", "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long." }, "blockingResources": { "type": "array", "description": "Output only. The names of any related resources that are blocking changes to the dataset.", "items": { "type": "string" } }, "inputConfigs": { "type": "array", "description": "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.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1InputConfig" } }, "name": { "description": "Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}", "type": "string" }, "displayName": { "type": "string", "description": "Required. The display name of the dataset. Maximum of 64 characters." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Time the dataset is created." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1VideoEventAnnotation": { "type": "object", "description": "Video event annotation.", "properties": { "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of the event in this annotation." }, "timeSegment": { "description": "The time segment of the video to which the annotation applies.", "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment" } }, "id": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation" }, "GoogleCloudDatalabelingV1beta1LabelTextRequest": { "description": "Request message for LabelText.", "id": "GoogleCloudDatalabelingV1beta1LabelTextRequest", "properties": { "textEntityExtractionConfig": { "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", "description": "Configuration for entity extraction task. One of text_classification_config and text_entity_extraction_config is required." }, "textClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", "description": "Configuration for text classification task. One of text_classification_config and text_entity_extraction_config is required." }, "feature": { "enum": [ "FEATURE_UNSPECIFIED", "TEXT_CLASSIFICATION", "TEXT_ENTITY_EXTRACTION" ], "type": "string", "description": "Required. The type of text labeling task.", "enumDescriptions": [ "", "Label text content to one of more labels.", "Label entities and their span in text." ] }, "basicConfig": { "description": "Required. Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1InputConfig": { "properties": { "bigquerySource": { "$ref": "GoogleCloudDatalabelingV1beta1BigQuerySource", "description": "Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob." }, "classificationMetadata": { "description": "Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.", "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetadata" }, "textMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1TextMetadata", "description": "Required for text import, as language code must be specified." }, "gcsSource": { "$ref": "GoogleCloudDatalabelingV1beta1GcsSource", "description": "Source located in Cloud Storage." }, "dataType": { "enum": [ "DATA_TYPE_UNSPECIFIED", "IMAGE", "VIDEO", "TEXT", "GENERAL_DATA" ], "enumDescriptions": [ "Data type is unspecified.", "Allowed for continuous evaluation.", "Video data type.", "Allowed for continuous evaluation.", "Allowed for continuous evaluation." ], "description": "Required. Data type must be specifed when user tries to import data.", "type": "string" }, "annotationType": { "type": "string", "enum": [ "ANNOTATION_TYPE_UNSPECIFIED", "IMAGE_CLASSIFICATION_ANNOTATION", "IMAGE_BOUNDING_BOX_ANNOTATION", "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", "IMAGE_BOUNDING_POLY_ANNOTATION", "IMAGE_POLYLINE_ANNOTATION", "IMAGE_SEGMENTATION_ANNOTATION", "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", "VIDEO_OBJECT_TRACKING_ANNOTATION", "VIDEO_OBJECT_DETECTION_ANNOTATION", "VIDEO_EVENT_ANNOTATION", "TEXT_CLASSIFICATION_ANNOTATION", "TEXT_ENTITY_EXTRACTION_ANNOTATION", "GENERAL_CLASSIFICATION_ANNOTATION" ], "description": "Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.", "enumDescriptions": [ "", "Classification annotations in an image. Allowed for continuous evaluation.", "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", "Oriented bounding box. The box does not have to be parallel to horizontal line.", "Bounding poly annotations in an image.", "Polyline annotations in an image.", "Segmentation annotations in an image.", "Classification annotations in video shots.", "Video object tracking annotation.", "Video object detection annotation.", "Video event annotation.", "Classification for text. Allowed for continuous evaluation.", "Entity extraction for text.", "General classification. Allowed for continuous evaluation." ] } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1InputConfig", "description": "The configuration of input data, including data type, location, etc." }, "GoogleCloudDatalabelingV1beta1CreateInstructionRequest": { "description": "Request message for CreateInstruction.", "type": "object", "properties": { "instruction": { "description": "Required. Instruction of how to perform the labeling task.", "$ref": "GoogleCloudDatalabelingV1beta1Instruction" } }, "id": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest" }, "GoogleCloudDatalabelingV1beta1DataItem": { "description": "DataItem is a piece of data, without annotation. For example, an image.", "id": "GoogleCloudDatalabelingV1beta1DataItem", "properties": { "imagePayload": { "description": "The image payload, a container of the image bytes/uri.", "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload" }, "name": { "type": "string", "description": "Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}" }, "videoPayload": { "description": "The video payload, a container of the video uri.", "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload" }, "textPayload": { "description": "The text payload, a container of text content.", "$ref": "GoogleCloudDatalabelingV1beta1TextPayload" } }, "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata": { "description": "Details of a LabelVideoEvent operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata" }, "GoogleCloudDatalabelingV1beta1BigQuerySource": { "type": "object", "properties": { "inputUri": { "description": "Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: \"bq://{your_project_id}/ {your_dataset_name}/{your_table_name}\" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).", "type": "string" } }, "description": "The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version.", "id": "GoogleCloudDatalabelingV1beta1BigQuerySource" }, "GoogleCloudDatalabelingV1alpha1OutputConfig": { "properties": { "gcsDestination": { "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation.", "$ref": "GoogleCloudDatalabelingV1alpha1GcsDestination" }, "gcsFolderDestination": { "$ref": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." } }, "id": "GoogleCloudDatalabelingV1alpha1OutputConfig", "description": "The configuration of output data.", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1LabelStats": { "properties": { "exampleCount": { "type": "object", "description": "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.", "additionalProperties": { "format": "int64", "type": "string" } } }, "description": "Statistics about annotation specs.", "id": "GoogleCloudDatalabelingV1p2alpha1LabelStats", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "Timestamp when create instruction request was created.", "type": "string" }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "instruction": { "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", "type": "string" } }, "description": "Metadata of a CreateInstruction operation.", "type": "object" }, "GoogleCloudDatalabelingV1beta1FeedbackThread": { "type": "object", "description": "A feedback thread of a certain labeling task on a certain annotated dataset.", "properties": { "name": { "type": "string", "description": "Name of the feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'" }, "feedbackThreadMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", "description": "Metadata regarding the feedback thread." } }, "id": "GoogleCloudDatalabelingV1beta1FeedbackThread" }, "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelTextEntityExtraction operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata" }, "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse", "type": "object", "description": "Response used for ExportDataset longrunning operation.", "properties": { "exportCount": { "type": "integer", "format": "int32", "description": "Output only. Number of examples exported successfully." }, "outputConfig": { "description": "Output only. output_config in the ExportData request.", "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig" }, "dataset": { "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", "type": "string" }, "totalCount": { "description": "Output only. Total number of examples requested to export", "type": "integer", "format": "int32" }, "labelStats": { "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", "description": "Output only. Statistic infos of labels in the exported dataset." }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." } } }, "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse": { "description": "Response used for ExportDataset longrunning operation.", "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse", "properties": { "outputConfig": { "description": "Output only. output_config in the ExportData request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1OutputConfig" }, "exportCount": { "description": "Output only. Number of examples exported successfully.", "type": "integer", "format": "int32" }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "labelStats": { "description": "Output only. Statistic infos of labels in the exported dataset.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelStats" }, "dataset": { "type": "string", "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"" }, "totalCount": { "description": "Output only. Total number of examples requested to export", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions": { "id": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", "properties": { "iouThreshold": { "format": "float", "description": "Minimum [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) required for 2 bounding boxes to be considered a match. This must be a number between 0 and 1.", "type": "number" } }, "description": "Options regarding evaluation between bounding boxes.", "type": "object" }, "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly": { "description": "Normalized bounding polygon.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly", "properties": { "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" }, "type": "array" } } }, "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse": { "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse", "description": "Results of searching example comparisons.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." }, "exampleComparisons": { "description": "A list of example comparisons matching the search criteria.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1ExampleComparison" } } } }, "GoogleCloudDatalabelingV1beta1NormalizedPolyline": { "description": "Normalized polyline.", "properties": { "normalizedVertices": { "type": "array", "description": "The normalized polyline vertices.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" } } }, "id": "GoogleCloudDatalabelingV1beta1NormalizedPolyline", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig": { "description": "Configuration for how human labeling task should be done.", "id": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "properties": { "replicaCount": { "type": "integer", "format": "int32", "description": "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." }, "userEmailAddress": { "type": "string", "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent." }, "instruction": { "type": "string", "description": "Required. Instruction resource name." }, "questionDuration": { "type": "string", "format": "google-duration", "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds." }, "annotatedDatasetDescription": { "type": "string", "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long." }, "annotatedDatasetDisplayName": { "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", "type": "string" }, "contributorEmails": { "items": { "type": "string" }, "description": "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/", "type": "array" }, "languageCode": { "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", "type": "string" }, "labelGroup": { "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", "type": "string" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1TextClassificationConfig": { "type": "object", "description": "Config for text classification human labeling task.", "id": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", "properties": { "allowMultiLabel": { "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one text segment.", "type": "boolean" }, "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." }, "sentimentConfig": { "$ref": "GoogleCloudDatalabelingV1beta1SentimentConfig", "deprecated": true, "description": "Optional. Configs for sentiment selection. We deprecate sentiment analysis in data labeling side as it is incompatible with uCAIP." } } }, "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest": { "type": "object", "properties": { "job": { "description": "Required. The evaluation job to create.", "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" } }, "description": "Request message for CreateEvaluationJob.", "id": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest" }, "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation": { "description": "Text classification annotation.", "properties": { "annotationSpec": { "description": "Label of the text.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" } }, "id": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", "type": "object" }, "GoogleCloudDatalabelingV1beta1EvaluationJobConfig": { "description": "Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob.", "type": "object", "properties": { "imageClassificationConfig": { "description": "Specify this field if your model version performs image classification or general classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config.", "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig" }, "humanAnnotationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to `true` for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field. Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the `instruction` field within this configuration." }, "boundingPolyConfig": { "description": "Specify this field if your model version performs image object detection (bounding box detection). `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet.", "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig" }, "exampleCount": { "format": "int32", "type": "integer", "description": "Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides `example_sample_percentage`: even if the service has not sampled enough predictions to fulfill `example_sample_perecentage` during an interval, it stops sampling predictions when it meets this limit." }, "inputConfig": { "$ref": "GoogleCloudDatalabelingV1beta1InputConfig", "description": "Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields: * `dataType` must be one of `IMAGE`, `TEXT`, or `GENERAL_DATA`. * `annotationType` must be one of `IMAGE_CLASSIFICATION_ANNOTATION`, `TEXT_CLASSIFICATION_ANNOTATION`, `GENERAL_CLASSIFICATION_ANNOTATION`, or `IMAGE_BOUNDING_BOX_ANNOTATION` (image object detection). * If your machine learning model performs classification, you must specify `classificationMetadata.isMultiLabel`. * You must specify `bigquerySource` (not `gcsSource`)." }, "evaluationJobAlertConfig": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", "description": "Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run." }, "textClassificationConfig": { "description": "Specify this field if your model version performs text classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config.", "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig" }, "bigqueryImportKeys": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON. You can provide the following entries in this field: * `data_json_key`: the data key for prediction input. You must provide either this key or `reference_json_key`. * `reference_json_key`: the data reference key for prediction input. You must provide either this key or `data_json_key`. * `label_json_key`: the label key for prediction output. Required. * `label_score_json_key`: the score key for prediction output. Required. * `bounding_box_json_key`: the bounding box key for prediction output. Required if your model version perform image object detection. Learn [how to configure prediction keys](/ml-engine/docs/continuous-evaluation/create-job#prediction-keys)." }, "exampleSamplePercentage": { "description": "Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.", "format": "double", "type": "number" }, "evaluationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig", "description": "Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the `boundingBoxEvaluationOptions` field within this configuration. Otherwise, provide an empty object for this configuration." } }, "id": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig" }, "GoogleCloudDatalabelingV1beta1Row": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1Row", "properties": { "entries": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry" }, "description": "A list of the confusion matrix entries. One entry for each possible predicted label." }, "annotationSpec": { "description": "The annotation spec of the ground truth label for this row.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" } }, "description": "A row in the confusion matrix. Each entry in this row has the same ground truth label." }, "GoogleLongrunningOperation": { "properties": { "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" }, "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." } }, "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse": { "id": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse", "description": "Results for listing FeedbackMessages.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." }, "feedbackMessages": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" }, "type": "array", "description": "The list of feedback messages to return." } } }, "GoogleCloudDatalabelingV1beta1PrCurve": { "properties": { "meanAveragePrecision": { "format": "float", "description": "Mean average prcision of this curve.", "type": "number" }, "annotationSpec": { "description": "The annotation spec of the label for which the precision-recall curve calculated. If this field is empty, that means the precision-recall curve is an aggregate curve for all labels.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" }, "confidenceMetricsEntries": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry" }, "description": "Entries that make up the precision-recall graph. Each entry is a \"point\" on the graph drawn for a different `confidence_threshold`." }, "areaUnderCurve": { "description": "Area under the precision-recall curve. Not to be confused with area under a receiver operating characteristic (ROC) curve.", "format": "float", "type": "number" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1PrCurve" }, "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata": { "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "description": "Details of a LabelVideoObjectTracking operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse": { "type": "object", "description": "Results for listing evaluation jobs.", "id": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse", "properties": { "evaluationJobs": { "description": "The list of evaluation jobs to return.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" } }, "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" } } }, "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse": { "type": "object", "properties": { "dataset": { "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", "type": "string" }, "exportCount": { "type": "integer", "format": "int32", "description": "Output only. Number of examples exported successfully." }, "totalCount": { "type": "integer", "format": "int32", "description": "Output only. Total number of examples requested to export" }, "outputConfig": { "description": "Output only. output_config in the ExportData request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1OutputConfig" }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "labelStats": { "description": "Output only. Statistic infos of labels in the exported dataset.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelStats" } }, "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse", "description": "Response used for ExportDataset longrunning operation." }, "GoogleCloudDatalabelingV1beta1OperatorMetadata": { "description": "General information useful for labels coming from contributors.", "id": "GoogleCloudDatalabelingV1beta1OperatorMetadata", "type": "object", "properties": { "labelVotes": { "format": "int32", "description": "The total number of contributors that choose this label.", "type": "integer" }, "score": { "type": "number", "description": "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).", "format": "float" }, "comments": { "type": "array", "description": "Comments from contributors.", "items": { "type": "string" } }, "totalVotes": { "format": "int32", "description": "The total number of contributors that answer this question.", "type": "integer" } } }, "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config." } }, "description": "Details of a LabelImageSegmentation operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata" }, "GoogleCloudDatalabelingV1beta1ImportDataRequest": { "properties": { "userEmailAddress": { "description": "Email of the user who started the import task and should be notified by email. If empty no notification will be sent.", "type": "string" }, "inputConfig": { "description": "Required. Specify the input source of the data.", "$ref": "GoogleCloudDatalabelingV1beta1InputConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1ImportDataRequest", "description": "Request message for ImportData API." }, "GoogleLongrunningListOperationsResponse": { "type": "object", "id": "GoogleLongrunningListOperationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "GoogleLongrunningOperation" }, "type": "array" } }, "description": "The response message for Operations.ListOperations." }, "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "description": "Details of a LabelVideoEvent operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ImagePayload": { "type": "object", "description": "Container of information about an image.", "id": "GoogleCloudDatalabelingV1beta1ImagePayload", "properties": { "signedUri": { "description": "Signed uri of the image file in the service bucket.", "type": "string" }, "imageThumbnail": { "description": "A byte string of a thumbnail image.", "format": "byte", "type": "string" }, "mimeType": { "description": "Image format.", "type": "string" }, "imageUri": { "description": "Image uri from the user bucket.", "type": "string" } } }, "GoogleCloudDatalabelingV1beta1Evaluation": { "description": "Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.", "id": "GoogleCloudDatalabelingV1beta1Evaluation", "type": "object", "properties": { "evaluatedItemCount": { "format": "int64", "description": "Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp for when this evaluation was created." }, "config": { "description": "Output only. Options used in the evaluation job that created this evaluation.", "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig" }, "name": { "description": "Output only. Resource name of an evaluation. The name has the following format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}'", "type": "string" }, "evaluationJobRunTime": { "type": "string", "description": "Output only. Timestamp for when the evaluation job that created this evaluation ran.", "format": "google-datetime" }, "evaluationMetrics": { "description": "Output only. Metrics comparing predictions to ground truth labels.", "$ref": "GoogleCloudDatalabelingV1beta1EvaluationMetrics" }, "annotationType": { "description": "Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.", "enum": [ "ANNOTATION_TYPE_UNSPECIFIED", "IMAGE_CLASSIFICATION_ANNOTATION", "IMAGE_BOUNDING_BOX_ANNOTATION", "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", "IMAGE_BOUNDING_POLY_ANNOTATION", "IMAGE_POLYLINE_ANNOTATION", "IMAGE_SEGMENTATION_ANNOTATION", "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", "VIDEO_OBJECT_TRACKING_ANNOTATION", "VIDEO_OBJECT_DETECTION_ANNOTATION", "VIDEO_EVENT_ANNOTATION", "TEXT_CLASSIFICATION_ANNOTATION", "TEXT_ENTITY_EXTRACTION_ANNOTATION", "GENERAL_CLASSIFICATION_ANNOTATION" ], "enumDescriptions": [ "", "Classification annotations in an image. Allowed for continuous evaluation.", "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", "Oriented bounding box. The box does not have to be parallel to horizontal line.", "Bounding poly annotations in an image.", "Polyline annotations in an image.", "Segmentation annotations in an image.", "Classification annotations in video shots.", "Video object tracking annotation.", "Video object detection annotation.", "Video event annotation.", "Classification for text. Allowed for continuous evaluation.", "Entity extraction for text.", "General classification. Allowed for continuous evaluation." ], "type": "string" } } }, "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation": { "description": "Image classification annotation definition.", "id": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", "properties": { "annotationSpec": { "description": "Label of image.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1PdfInstruction": { "description": "Instruction from a PDF file.", "id": "GoogleCloudDatalabelingV1beta1PdfInstruction", "properties": { "gcsFileUri": { "description": "PDF file for the instruction. Only gcs path is allowed.", "type": "string" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1ListExamplesResponse": { "description": "Results of listing Examples in and annotated dataset.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1ListExamplesResponse", "properties": { "examples": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1Example" }, "type": "array", "description": "The list of examples to return." }, "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", "description": "Details of a LabelVideoClassification operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." }, "evaluations": { "description": "The list of evaluations matching the search.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" } } }, "id": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse", "type": "object", "description": "Results of searching evaluations." }, "GoogleCloudDatalabelingV1beta1LabelImageRequest": { "type": "object", "description": "Request message for starting an image labeling task.", "properties": { "basicConfig": { "description": "Required. Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" }, "feature": { "enumDescriptions": [ "", "Label whole image with one or more of labels.", "Label image with bounding boxes for labels.", "Label oriented bounding box. The box does not have to be parallel to horizontal line.", "Label images with bounding poly. A bounding poly is a plane figure that is bounded by a finite chain of straight line segments closing in a loop.", "Label images with polyline. Polyline is formed by connected line segments which are not in closed form.", "Label images with segmentation. Segmentation is different from bounding poly since it is more fine-grained, pixel level annotation." ], "type": "string", "description": "Required. The type of image labeling task.", "enum": [ "FEATURE_UNSPECIFIED", "CLASSIFICATION", "BOUNDING_BOX", "ORIENTED_BOUNDING_BOX", "BOUNDING_POLY", "POLYLINE", "SEGMENTATION" ] }, "segmentationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", "description": "Configuration for segmentation task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." }, "imageClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", "description": "Configuration for image classification task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." }, "polylineConfig": { "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", "description": "Configuration for polyline task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." }, "boundingPolyConfig": { "description": "Configuration for bounding box and bounding poly task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.", "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig" } }, "id": "GoogleCloudDatalabelingV1beta1LabelImageRequest" }, "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest": { "description": "Request message of SearchExampleComparisons.", "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest", "type": "object", "properties": { "pageToken": { "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest. If you don't specify this field, the API call requests the first page of the search.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "type": "integer", "format": "int32" } } }, "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata": { "description": "Metadata of a CreateInstruction operation.", "properties": { "partialFailures": { "type": "array", "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "type": "string", "format": "google-datetime", "description": "Timestamp when create instruction request was created." }, "instruction": { "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", "type": "string" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata" }, "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata": { "description": "Metadata describing the feedback from the operator.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata", "properties": {} }, "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata", "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", "properties": { "imageOrientedBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of label image oriented bounding box operation." }, "imageBoundingPolyDetails": { "description": "Details of label image bounding poly operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata" }, "videoObjectTrackingDetails": { "description": "Details of label video object tracking operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata" }, "imageClassificationDetails": { "description": "Details of label image classification operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata" }, "videoClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", "description": "Details of label video classification operation." }, "videoObjectDetectionDetails": { "description": "Details of label video object detection operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata" }, "imagePolylineDetails": { "description": "Details of label image polyline operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata" }, "textClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", "description": "Details of label text classification operation." }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "type": "array" }, "createTime": { "description": "Output only. Timestamp when labeling request was created.", "type": "string", "format": "google-datetime" }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "imageSegmentationDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", "description": "Details of label image segmentation operation." }, "progressPercent": { "description": "Output only. Progress of label operation. Range: [0, 100].", "type": "integer", "format": "int32" }, "videoEventDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", "description": "Details of label video event operation." }, "dataset": { "type": "string", "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"" }, "imageBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", "description": "Details of label image bounding box operation." }, "textEntityExtractionDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", "description": "Details of label text entity extraction operation." } } }, "GoogleCloudDatalabelingV1beta1GcsSource": { "properties": { "inputUri": { "type": "string", "description": "Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`)." }, "mimeType": { "description": "Required. The format of the source file. Only \"text/csv\" is supported.", "type": "string" } }, "id": "GoogleCloudDatalabelingV1beta1GcsSource", "description": "Source of the Cloud Storage file to be imported.", "type": "object" }, "GoogleCloudDatalabelingV1beta1SequentialSegment": { "type": "object", "properties": { "start": { "format": "int32", "type": "integer", "description": "Start position (inclusive)." }, "end": { "description": "End position (exclusive).", "type": "integer", "format": "int32" } }, "id": "GoogleCloudDatalabelingV1beta1SequentialSegment", "description": "Start and end position in a sequence (e.g. text segment)." }, "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata": { "description": "Metadata of a LabelImageClassification operation.", "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1AnnotatedDataset": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1AnnotatedDataset", "description": "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.", "properties": { "blockingResources": { "type": "array", "description": "Output only. The names of any related resources that are blocking changes to the annotated dataset.", "items": { "type": "string" } }, "displayName": { "type": "string", "description": "Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters." }, "exampleCount": { "type": "string", "format": "int64", "description": "Output only. Number of examples in the annotated dataset." }, "metadata": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata", "description": "Output only. Additional information about AnnotatedDataset." }, "createTime": { "description": "Output only. Time the AnnotatedDataset was created.", "format": "google-datetime", "type": "string" }, "description": { "description": "Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.", "type": "string" }, "name": { "type": "string", "description": "Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}" }, "annotationSource": { "enum": [ "ANNOTATION_SOURCE_UNSPECIFIED", "OPERATOR" ], "description": "Output only. Source of the annotation.", "type": "string", "enumDescriptions": [ "", "Answer is provided by a human contributor." ] }, "labelStats": { "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", "description": "Output only. Per label statistics." }, "completedExampleCount": { "type": "string", "format": "int64", "description": "Output only. Number of examples that have annotation in the annotated dataset." }, "annotationType": { "enumDescriptions": [ "", "Classification annotations in an image. Allowed for continuous evaluation.", "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", "Oriented bounding box. The box does not have to be parallel to horizontal line.", "Bounding poly annotations in an image.", "Polyline annotations in an image.", "Segmentation annotations in an image.", "Classification annotations in video shots.", "Video object tracking annotation.", "Video object detection annotation.", "Video event annotation.", "Classification for text. Allowed for continuous evaluation.", "Entity extraction for text.", "General classification. Allowed for continuous evaluation." ], "enum": [ "ANNOTATION_TYPE_UNSPECIFIED", "IMAGE_CLASSIFICATION_ANNOTATION", "IMAGE_BOUNDING_BOX_ANNOTATION", "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", "IMAGE_BOUNDING_POLY_ANNOTATION", "IMAGE_POLYLINE_ANNOTATION", "IMAGE_SEGMENTATION_ANNOTATION", "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", "VIDEO_OBJECT_TRACKING_ANNOTATION", "VIDEO_OBJECT_DETECTION_ANNOTATION", "VIDEO_EVENT_ANNOTATION", "TEXT_CLASSIFICATION_ANNOTATION", "TEXT_ENTITY_EXTRACTION_ANNOTATION", "GENERAL_CLASSIFICATION_ANNOTATION" ], "type": "string", "description": "Output only. Type of the annotation. It is specified when starting labeling task." } } }, "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation": { "type": "object", "properties": { "annotationColors": { "additionalProperties": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" }, "type": "object", "description": "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." }, "mimeType": { "type": "string", "description": "Image format." }, "imageBytes": { "description": "A byte string of a full image's color map.", "type": "string", "format": "byte" } }, "id": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation", "description": "Image segmentation annotation." }, "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", "description": "Details of a LabelTextClassification operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ClassificationMetrics": { "description": "Metrics calculated for a classification model.", "type": "object", "properties": { "prCurve": { "description": "Precision-recall curve based on ground truth labels, predicted labels, and scores for the predicted labels.", "$ref": "GoogleCloudDatalabelingV1beta1PrCurve" }, "confusionMatrix": { "description": "Confusion matrix of predicted labels vs. ground truth labels.", "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrix" } }, "id": "GoogleCloudDatalabelingV1beta1ClassificationMetrics" }, "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", "description": "Metadata of a LabelImageClassification operation.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata": { "description": "Details of LabelImageBoundingPoly operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1beta1ImageClassificationConfig": { "id": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", "description": "Config for image classification human labeling task.", "type": "object", "properties": { "answerAggregationType": { "description": "Optional. The type of how to aggregate answers.", "type": "string", "enumDescriptions": [ "", "Majority vote to aggregate answers.", "Unanimous answers will be adopted.", "Preserve all answers by crowd compute." ], "enum": [ "STRING_AGGREGATION_TYPE_UNSPECIFIED", "MAJORITY_VOTE", "UNANIMOUS_VOTE", "NO_AGGREGATION" ] }, "allowMultiLabel": { "type": "boolean", "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image." }, "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." } } }, "GoogleCloudDatalabelingV1beta1EvaluationMetrics": { "id": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", "properties": { "classificationMetrics": { "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetrics" }, "objectDetectionMetrics": { "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1EvaluationConfig": { "type": "object", "properties": { "boundingBoxEvaluationOptions": { "$ref": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", "description": "Only specify this field if the related model performs image object detection (`IMAGE_BOUNDING_BOX_ANNOTATION`). Describes how to evaluate bounding boxes." } }, "description": "Configuration details used for calculating evaluation metrics and creating an Evaluation.", "id": "GoogleCloudDatalabelingV1beta1EvaluationConfig" }, "GoogleCloudDatalabelingV1beta1CsvInstruction": { "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file.", "type": "object", "properties": { "gcsFileUri": { "description": "CSV file for the instruction. Only gcs path is allowed.", "type": "string" } }, "id": "GoogleCloudDatalabelingV1beta1CsvInstruction" }, "GoogleCloudDatalabelingV1beta1LabelOperationMetadata": { "properties": { "dataset": { "type": "string", "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"" }, "imageSegmentationDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", "description": "Details of label image segmentation operation." }, "progressPercent": { "format": "int32", "description": "Output only. Progress of label operation. Range: [0, 100].", "type": "integer" }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "imageBoundingBoxDetails": { "description": "Details of label image bounding box operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when labeling request was created.", "type": "string" }, "textClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", "description": "Details of label text classification operation." }, "imagePolylineDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", "description": "Details of label image polyline operation." }, "imageBoundingPolyDetails": { "description": "Details of label image bounding poly operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata" }, "videoObjectTrackingDetails": { "description": "Details of label video object tracking operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata" }, "videoClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", "description": "Details of label video classification operation." }, "videoEventDetails": { "description": "Details of label video event operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata" }, "textEntityExtractionDetails": { "description": "Details of label text entity extraction operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata" }, "videoObjectDetectionDetails": { "description": "Details of label video object detection operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata" }, "imageOrientedBoundingBoxDetails": { "description": "Details of label image oriented bounding box operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata" }, "partialFailures": { "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "imageClassificationDetails": { "description": "Details of label image classification operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelOperationMetadata", "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23" }, "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata", "properties": { "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when export dataset request was created." }, "partialFailures": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "dataset": { "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", "type": "string" } }, "description": "Metadata of an ExportData operation." }, "GoogleCloudDatalabelingV1beta1AnnotationMetadata": { "description": "Additional information associated with the annotation.", "properties": { "operatorMetadata": { "description": "Metadata related to human labeling.", "$ref": "GoogleCloudDatalabelingV1beta1OperatorMetadata" } }, "id": "GoogleCloudDatalabelingV1beta1AnnotationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelVideoObjectTracking operation metadata." }, "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." }, "annotationSpecSets": { "description": "The list of annotation spec sets.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" }, "type": "array" } }, "type": "object", "description": "Results of listing annotation spec set under a project.", "id": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse" }, "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", "description": "Details of a LabelTextEntityExtraction operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config." } }, "type": "object", "description": "Details of a LabelImageSegmentation operation metadata.", "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata" }, "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig": { "properties": { "allowMultiLabel": { "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set.", "type": "boolean" }, "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." } }, "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig", "description": "Annotation spec set with the setting of allowing multi labels or not.", "type": "object" }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "code": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" } } } }, "GoogleCloudDatalabelingV1beta1Attempt": { "properties": { "attemptTime": { "type": "string", "format": "google-datetime" }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Details of errors that occurred." } }, "id": "GoogleCloudDatalabelingV1beta1Attempt", "type": "object", "description": "Records a failed evaluation job run." }, "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest": { "id": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest", "description": "Request message ResumeEvaluationJob.", "properties": {}, "type": "object" }, "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", "description": "Details of a LabelVideoEvent operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", "properties": { "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of the segment specified by time_segment." }, "timeSegment": { "description": "The time segment of the video to which the annotation applies.", "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment" } }, "description": "Video classification annotation." }, "GoogleCloudDatalabelingV1beta1AnnotationValue": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1AnnotationValue", "properties": { "textEntityExtractionAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", "description": "Annotation value for text entity extraction case." }, "videoObjectTrackingAnnotation": { "description": "Annotation value for video object detection and tracking case.", "$ref": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation" }, "videoClassificationAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", "description": "Annotation value for video classification case." }, "imageClassificationAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", "description": "Annotation value for image classification case." }, "videoEventAnnotation": { "description": "Annotation value for video event case.", "$ref": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation" }, "imagePolylineAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", "description": "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." }, "imageBoundingPolyAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", "description": "Annotation value for image bounding box, oriented bounding box and polygon cases." }, "imageSegmentationAnnotation": { "description": "Annotation value for image segmentation.", "$ref": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation" }, "textClassificationAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", "description": "Annotation value for text classification case." } }, "description": "Annotation value for an example." }, "GoogleCloudDatalabelingV1beta1OutputConfig": { "type": "object", "properties": { "gcsFolderDestination": { "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs.", "$ref": "GoogleCloudDatalabelingV1beta1GcsFolderDestination" }, "gcsDestination": { "$ref": "GoogleCloudDatalabelingV1beta1GcsDestination", "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." } }, "id": "GoogleCloudDatalabelingV1beta1OutputConfig", "description": "The configuration of output data." }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata": { "description": "Details of a LabelVideoObjectDetection operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata" }, "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata": { "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "description": "Details of a LabelTextClassification operation metadata.", "id": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata" }, "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", "type": "object", "description": "Details of a LabelTextClassification operation metadata." }, "GoogleCloudDatalabelingV1beta1LabelVideoRequest": { "description": "Request message for LabelVideo.", "properties": { "eventConfig": { "description": "Configuration for video event task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.", "$ref": "GoogleCloudDatalabelingV1beta1EventConfig" }, "videoClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", "description": "Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." }, "feature": { "enumDescriptions": [ "", "Label whole video or video segment with one or more labels.", "Label objects with bounding box on image frames extracted from the video.", "Label and track objects in video.", "Label the range of video for the specified events." ], "description": "Required. The type of video labeling task.", "type": "string", "enum": [ "FEATURE_UNSPECIFIED", "CLASSIFICATION", "OBJECT_DETECTION", "OBJECT_TRACKING", "EVENT" ] }, "objectDetectionConfig": { "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", "description": "Configuration for video object detection task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." }, "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Required. Basic human annotation config." }, "objectTrackingConfig": { "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", "description": "Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelVideoRequest" }, "GoogleCloudDatalabelingV1beta1ListDatasetsResponse": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse", "properties": { "datasets": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1Dataset" }, "description": "The list of datasets to return.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." } }, "description": "Results of listing datasets within a project." }, "GoogleCloudDatalabelingV1beta1BoundingPolyConfig": { "id": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", "type": "object", "description": "Config for image bounding poly (and bounding box) human labeling task.", "properties": { "annotationSpecSet": { "description": "Required. Annotation spec set resource name.", "type": "string" }, "instructionMessage": { "type": "string", "description": "Optional. Instruction message showed on contributors UI." } } }, "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig": { "id": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "type": "object", "description": "Configuration for how human labeling task should be done.", "properties": { "annotatedDatasetDisplayName": { "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", "type": "string" }, "userEmailAddress": { "type": "string", "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent." }, "instruction": { "description": "Required. Instruction resource name.", "type": "string" }, "annotatedDatasetDescription": { "type": "string", "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long." }, "contributorEmails": { "type": "array", "description": "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/", "items": { "type": "string" } }, "questionDuration": { "type": "string", "format": "google-duration", "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds." }, "languageCode": { "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", "type": "string" }, "replicaCount": { "type": "integer", "description": "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.", "format": "int32" }, "labelGroup": { "type": "string", "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`." } } }, "GoogleCloudDatalabelingV1alpha1LabelStats": { "id": "GoogleCloudDatalabelingV1alpha1LabelStats", "type": "object", "properties": { "exampleCount": { "type": "object", "description": "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.", "additionalProperties": { "type": "string", "format": "int64" } } }, "description": "Statistics about annotation specs." }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata": { "description": "Details of a LabelVideoObjectDetection operation metadata.", "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata" }, "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata": { "type": "object", "description": "Details of a LabelImageBoundingBox operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata" }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", "description": "Details of a LabelVideoClassification operation metadata.", "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest": { "type": "object", "properties": { "annotationSpecSet": { "description": "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.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" } }, "description": "Request message for CreateAnnotationSpecSet.", "id": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest" }, "GoogleCloudDatalabelingV1alpha1GcsDestination": { "properties": { "mimeType": { "type": "string", "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported." }, "outputUri": { "description": "Required. The output uri of destination file.", "type": "string" } }, "description": "Export destination of the data.Only gcs path is allowed in output_uri.", "id": "GoogleCloudDatalabelingV1alpha1GcsDestination", "type": "object" }, "GoogleCloudDatalabelingV1beta1ListInstructionsResponse": { "description": "Results of listing instructions under a project.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse", "properties": { "instructions": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Instruction" }, "description": "The list of Instructions to return." }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." } } }, "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", "description": "Details of LabelImagePolyline operation metadata.", "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "description": "Details of a LabelVideoObjectTracking operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata" }, "GoogleCloudDatalabelingV1p1alpha1OutputConfig": { "properties": { "gcsDestination": { "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsDestination", "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." }, "gcsFolderDestination": { "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." } }, "id": "GoogleCloudDatalabelingV1p1alpha1OutputConfig", "description": "The configuration of output data.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation": { "id": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", "properties": { "normalizedBoundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" }, "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of object in this bounding polygon." }, "boundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" } }, "description": "Image bounding poly annotation. It represents a polygon including bounding box in the image.", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", "description": "Details of a LabelVideoEvent operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when export dataset request was created.", "type": "string" }, "dataset": { "type": "string", "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"" }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" } }, "description": "Metadata of an ExportData operation." }, "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse", "type": "object", "properties": { "dataset": { "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", "type": "string" }, "exportCount": { "type": "integer", "description": "Output only. Number of examples exported successfully.", "format": "int32" }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "outputConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1OutputConfig", "description": "Output only. output_config in the ExportData request." }, "totalCount": { "type": "integer", "format": "int32", "description": "Output only. Total number of examples requested to export" }, "labelStats": { "description": "Output only. Statistic infos of labels in the exported dataset.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelStats" } }, "description": "Response used for ExportDataset longrunning operation." }, "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", "description": "Details of a LabelImageBoundingBox operation metadata." }, "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig": { "id": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", "type": "object", "description": "Provides details for how an evaluation job sends email alerts based on the results of a run.", "properties": { "email": { "description": "Required. An email address to send alerts to.", "type": "string" }, "minAcceptableMeanAveragePrecision": { "type": "number", "format": "double", "description": "Required. A number between 0 and 1 that describes a minimum mean average precision threshold. When the evaluation job runs, if it calculates that your model version's predictions from the recent interval have meanAveragePrecision below this threshold, then it sends an alert to your specified email." } } }, "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata": { "description": "Details of a LabelVideoObjectDetection operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry": { "properties": { "recallAt5": { "type": "number", "format": "float", "description": "Recall value for entries with label that has highest 5 scores." }, "precisionAt1": { "description": "Precision value for entries with label that has highest score.", "format": "float", "type": "number" }, "precision": { "description": "Precision value.", "type": "number", "format": "float" }, "f1Score": { "description": "Harmonic mean of recall and precision.", "format": "float", "type": "number" }, "precisionAt5": { "format": "float", "description": "Precision value for entries with label that has highest 5 scores.", "type": "number" }, "recall": { "description": "Recall value.", "type": "number", "format": "float" }, "confidenceThreshold": { "type": "number", "description": "Threshold used for this entry. For classification tasks, this is a classification threshold: a predicted label is categorized as positive or negative (in the context of this point on the PR curve) based on whether the label's score meets this threshold. For image object detection (bounding box) tasks, this is the [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) threshold for the context of this point on the PR curve.", "format": "float" }, "recallAt1": { "type": "number", "description": "Recall value for entries with label that has highest score.", "format": "float" }, "f1ScoreAt1": { "type": "number", "format": "float", "description": "The harmonic mean of recall_at1 and precision_at1." }, "f1ScoreAt5": { "description": "The harmonic mean of recall_at5 and precision_at5.", "format": "float", "type": "number" } }, "id": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1GcsDestination": { "description": "Export destination of the data.Only gcs path is allowed in output_uri.", "properties": { "outputUri": { "description": "Required. The output uri of destination file.", "type": "string" }, "mimeType": { "type": "string", "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported." } }, "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1GcsDestination" }, "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata", "properties": { "partialFailures": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "dataset": { "type": "string", "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when export dataset request was created.", "type": "string" } }, "description": "Metadata of an ExportData operation.", "type": "object" }, "GoogleCloudDatalabelingV1beta1Instruction": { "description": "Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.", "id": "GoogleCloudDatalabelingV1beta1Instruction", "properties": { "displayName": { "type": "string", "description": "Required. The display name of the instruction. Maximum of 64 characters." }, "updateTime": { "format": "google-datetime", "description": "Output only. Last update time of instruction.", "type": "string" }, "description": { "description": "Optional. User-provided description of the instruction. The description can be up to 10000 characters long.", "type": "string" }, "dataType": { "enumDescriptions": [ "Data type is unspecified.", "Allowed for continuous evaluation.", "Video data type.", "Allowed for continuous evaluation.", "Allowed for continuous evaluation." ], "description": "Required. The data type of this instruction.", "enum": [ "DATA_TYPE_UNSPECIFIED", "IMAGE", "VIDEO", "TEXT", "GENERAL_DATA" ], "type": "string" }, "createTime": { "description": "Output only. Creation time of instruction.", "type": "string", "format": "google-datetime" }, "csvInstruction": { "$ref": "GoogleCloudDatalabelingV1beta1CsvInstruction", "description": "Deprecated: this instruction format is not supported any more. 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.", "deprecated": true }, "pdfInstruction": { "description": "Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.", "$ref": "GoogleCloudDatalabelingV1beta1PdfInstruction" }, "name": { "type": "string", "description": "Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}" }, "blockingResources": { "type": "array", "items": { "type": "string" }, "description": "Output only. The names of any related resources that are blocking changes to the instruction." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1TimeSegment": { "id": "GoogleCloudDatalabelingV1beta1TimeSegment", "properties": { "endTimeOffset": { "format": "google-duration", "type": "string", "description": "End of the time segment (exclusive), represented as the duration since the example start." }, "startTimeOffset": { "format": "google-duration", "description": "Start of the time segment (inclusive), represented as the duration since the example start.", "type": "string" } }, "description": "A time period inside of an example that has a time dimension (e.g. video).", "type": "object" }, "GoogleCloudDatalabelingV1beta1AnnotationSpec": { "id": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.", "properties": { "index": { "type": "integer", "format": "int32", "description": "Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: \"dog\", index: 0 }` and one AnnotationSpec with `{ display_name: \"cat\", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values." }, "description": { "type": "string", "description": "Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long." }, "displayName": { "description": "Required. The display name of the AnnotationSpec. Maximum of 64 characters.", "type": "string" } }, "type": "object" }, "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata": { "description": "Details of LabelImageBoundingPoly operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config." } } }, "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "description": "Details of a LabelImageSegmentation operation metadata." }, "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry": { "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry", "type": "object", "properties": { "itemCount": { "description": "Number of items predicted to have this label. (The ground truth label for these items is the `Row.annotationSpec` of this entry's parent.)", "type": "integer", "format": "int32" }, "annotationSpec": { "description": "The annotation spec of a predicted label.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" } } }, "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig": { "id": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "type": "object", "properties": { "annotatedDatasetDisplayName": { "type": "string", "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters ." }, "annotatedDatasetDescription": { "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", "type": "string" }, "contributorEmails": { "items": { "type": "string" }, "type": "array", "description": "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/" }, "languageCode": { "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", "type": "string" }, "replicaCount": { "format": "int32", "description": "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.", "type": "integer" }, "instruction": { "description": "Required. Instruction resource name.", "type": "string" }, "labelGroup": { "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", "type": "string" }, "userEmailAddress": { "type": "string", "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent." }, "questionDuration": { "format": "google-duration", "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", "type": "string" } }, "description": "Configuration for how human labeling task should be done." }, "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata": { "properties": { "objectDetectionConfig": { "description": "Configuration for video object detection task.", "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig" }, "textClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", "description": "Configuration for text classification task." }, "humanAnnotationConfig": { "description": "HumanAnnotationConfig used when requesting the human labeling task for this AnnotatedDataset.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" }, "textEntityExtractionConfig": { "description": "Configuration for text entity extraction task.", "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig" }, "segmentationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", "description": "Configuration for image segmentation task." }, "polylineConfig": { "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", "description": "Configuration for image polyline task." }, "eventConfig": { "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", "description": "Configuration for video event labeling task." }, "videoClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", "description": "Configuration for video classification task." }, "boundingPolyConfig": { "description": "Configuration for image bounding box and bounding poly task.", "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig" }, "objectTrackingConfig": { "description": "Configuration for video object tracking task.", "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig" }, "imageClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", "description": "Configuration for image classification task." } }, "description": "Metadata on AnnotatedDataset.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata" }, "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata": { "id": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "type": "object", "description": "Details of a LabelVideoClassification operation metadata." }, "GoogleCloudDatalabelingV1beta1FeedbackMessage": { "type": "object", "properties": { "body": { "description": "String content of the feedback. Maximum of 10000 characters.", "type": "string" }, "image": { "format": "byte", "type": "string", "description": "The image storing this feedback if the feedback is an image representing operator's comments." }, "createTime": { "format": "google-datetime", "description": "Create time.", "type": "string" }, "requesterFeedbackMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata" }, "operatorFeedbackMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata" }, "name": { "description": "Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}'", "type": "string" } }, "description": "A feedback message inside a feedback thread.", "id": "GoogleCloudDatalabelingV1beta1FeedbackMessage" }, "GoogleCloudDatalabelingV1beta1AnnotationSpecSet": { "description": "An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", "properties": { "annotationSpecs": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" }, "description": "Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.", "type": "array" }, "blockingResources": { "type": "array", "description": "Output only. The names of any related resources that are blocking changes to the annotation spec set.", "items": { "type": "string" } }, "name": { "type": "string", "description": "Output only. The AnnotationSpecSet resource name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"" }, "description": { "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.", "type": "string" }, "displayName": { "type": "string", "description": "Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters." } } }, "GoogleCloudDatalabelingV1beta1VideoPayload": { "id": "GoogleCloudDatalabelingV1beta1VideoPayload", "description": "Container of information of a video.", "type": "object", "properties": { "signedUri": { "description": "Signed uri of the video file in the service bucket.", "type": "string" }, "videoThumbnails": { "type": "array", "description": "The list of video thumbnails.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1VideoThumbnail" } }, "mimeType": { "type": "string", "description": "Video format." }, "frameRate": { "type": "number", "format": "float", "description": "FPS of the video." }, "videoUri": { "description": "Video uri from the user bucket.", "type": "string" } } }, "GoogleCloudDatalabelingV1beta1Example": { "properties": { "imagePayload": { "description": "The image payload, a container of the image bytes/uri.", "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload" }, "name": { "description": "Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", "type": "string" }, "annotations": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Annotation" }, "description": "Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations." }, "textPayload": { "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", "description": "The text payload, a container of the text content." }, "videoPayload": { "description": "The video payload, a container of the video uri.", "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload" } }, "type": "object", "description": "An Example is a piece of data and its annotation. For example, an image with label \"house\".", "id": "GoogleCloudDatalabelingV1beta1Example" }, "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata": { "description": "Metadata of an ImportData operation.", "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata", "type": "object", "properties": { "dataset": { "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", "type": "string" }, "partialFailures": { "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "createTime": { "description": "Output only. Timestamp when import dataset request was created.", "format": "google-datetime", "type": "string" } } }, "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata": { "type": "object", "properties": { "instruction": { "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", "type": "string" }, "partialFailures": { "type": "array", "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "description": "Timestamp when create instruction request was created.", "type": "string", "format": "google-datetime" } }, "description": "Metadata of a CreateInstruction operation.", "id": "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata" }, "GoogleCloudDatalabelingV1beta1EvaluationJob": { "id": "GoogleCloudDatalabelingV1beta1EvaluationJob", "description": "Defines an evaluation job that runs periodically to generate Evaluations. [Creating an evaluation job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point for using continuous evaluation.", "properties": { "modelVersion": { "description": "Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: \"projects/{project_id}/models/{model_name}/versions/{version_name}\" There can only be one evaluation job per model version.", "type": "string" }, "schedule": { "type": "string", "description": "Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in [crontab format](/scheduler/docs/configuring/cron-job-schedules) or in an [English-like format](/appengine/docs/standard/python/config/cronref#schedule_format). Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day." }, "name": { "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"", "type": "string" }, "annotationSpecSet": { "description": "Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", "type": "string" }, "labelMissingGroundTruth": { "type": "boolean", "description": "Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`." }, "evaluationJobConfig": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", "description": "Required. Configuration details for the evaluation job." }, "state": { "enum": [ "STATE_UNSPECIFIED", "SCHEDULED", "RUNNING", "PAUSED", "STOPPED" ], "description": "Output only. Describes the current state of the job.", "type": "string", "enumDescriptions": [ "", "The job is scheduled to run at the configured interval. You can pause or delete the job. When the job is in this state, it samples prediction input and output from your model version into your BigQuery table as predictions occur.", "The job is currently running. When the job runs, Data Labeling Service does several things: 1. If you have configured your job to use Data Labeling Service for ground truth labeling, the service creates a Dataset and a labeling task for all data sampled since the last time the job ran. Human labelers provide ground truth labels for your data. Human labeling may take hours, or even days, depending on how much data has been sampled. The job remains in the `RUNNING` state during this time, and it can even be running multiple times in parallel if it gets triggered again (for example 24 hours later) before the earlier run has completed. When human labelers have finished labeling the data, the next step occurs. If you have configured your job to provide your own ground truth labels, Data Labeling Service still creates a Dataset for newly sampled data, but it expects that you have already added ground truth labels to the BigQuery table by this time. The next step occurs immediately. 2. Data Labeling Service creates an Evaluation by comparing your model version's predictions with the ground truth labels. If the job remains in this state for a long time, it continues to sample prediction data into your BigQuery table and will run again at the next interval, even if it causes the job to run multiple times in parallel.", "The job is not sampling prediction input and output into your BigQuery table and it will not run according to its schedule. You can resume the job.", "The job has this state right before it is deleted." ] }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp of when this evaluation job was created.", "type": "string" }, "attempts": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1Attempt" }, "type": "array", "description": "Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array." }, "description": { "type": "string", "description": "Required. Description of the job. The description can be up to 25,000 characters long." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1Annotation": { "id": "GoogleCloudDatalabelingV1beta1Annotation", "properties": { "annotationSentiment": { "description": "Output only. Sentiment for this annotation.", "type": "string", "enumDescriptions": [ "", "This annotation describes negatively about the data.", "This label describes positively about the data." ], "enum": [ "ANNOTATION_SENTIMENT_UNSPECIFIED", "NEGATIVE", "POSITIVE" ] }, "annotationValue": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationValue", "description": "Output only. This is the actual annotation value, e.g classification, bounding box values are stored here." }, "name": { "type": "string", "description": "Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}" }, "annotationMetadata": { "description": "Output only. Annotation metadata, including information like votes for labels.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationMetadata" }, "annotationSource": { "description": "Output only. The source of the annotation.", "enum": [ "ANNOTATION_SOURCE_UNSPECIFIED", "OPERATOR" ], "enumDescriptions": [ "", "Answer is provided by a human contributor." ], "type": "string" } }, "description": "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.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ListDataItemsResponse": { "properties": { "dataItems": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1DataItem" }, "description": "The list of data items to return.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" } }, "id": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse", "type": "object", "description": "Results of listing data items in a dataset." }, "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata": { "description": "Details of a LabelTextClassification operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse", "description": "Response used for ImportData longrunning operation.", "properties": { "totalCount": { "type": "integer", "format": "int32", "description": "Output only. Total number of examples requested to import" }, "importCount": { "description": "Output only. Number of examples imported successfully.", "type": "integer", "format": "int32" }, "dataset": { "type": "string", "description": "Ouptut only. The name of imported dataset." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1VideoClassificationConfig": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", "description": "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.", "properties": { "annotationSpecSetConfigs": { "description": "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.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig" }, "type": "array" }, "applyShotDetection": { "type": "boolean", "description": "Optional. Option to apply shot detection on the video." } } }, "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame": { "description": "Video frame level annotation for object detection and tracking.", "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame", "properties": { "boundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" }, "timeOffset": { "description": "The time offset of this frame relative to the beginning of the video.", "type": "string", "format": "google-duration" }, "normalizedBoundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" } }, "type": "object" }, "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata": { "type": "object", "description": "Details of a LabelImageBoundingBox operation metadata.", "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata": { "description": "Details of a LabelVideoClassification operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", "type": "object" }, "GoogleProtobufEmpty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "GoogleProtobufEmpty", "type": "object", "properties": {} }, "GoogleCloudDatalabelingV1beta1ExportDataRequest": { "id": "GoogleCloudDatalabelingV1beta1ExportDataRequest", "properties": { "userEmailAddress": { "description": "Email of the user who started the export task and should be notified by email. If empty no notification will be sent.", "type": "string" }, "annotatedDataset": { "type": "string", "description": "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/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}" }, "filter": { "type": "string", "description": "Optional. Filter is not supported at this moment." }, "outputConfig": { "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", "description": "Required. Specify the output destination." } }, "type": "object", "description": "Request message for ExportData API." }, "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata": { "type": "object", "description": "Details of LabelImagePolyline operation metadata.", "id": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics": { "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics", "type": "object", "properties": { "prCurve": { "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", "description": "Precision-recall curve." } }, "description": "Metrics calculated for an image object detection (bounding box) model." }, "GoogleCloudDatalabelingV1beta1SentimentConfig": { "properties": { "enableLabelSentimentSelection": { "type": "boolean", "description": "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." } }, "description": "Config for setting up sentiments.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1SentimentConfig" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "description": "Details of LabelImageBoundingPoly operation metadata.", "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1beta1CreateDatasetRequest": { "properties": { "dataset": { "description": "Required. The dataset to be created.", "$ref": "GoogleCloudDatalabelingV1beta1Dataset" } }, "description": "Request message for CreateDataset.", "id": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest", "type": "object" }, "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse": { "type": "object", "description": "Results for listing FeedbackThreads.", "properties": { "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" }, "feedbackThreads": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" }, "description": "The list of feedback threads to return.", "type": "array" } }, "id": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse" }, "GoogleCloudDatalabelingV1beta1VideoThumbnail": { "id": "GoogleCloudDatalabelingV1beta1VideoThumbnail", "type": "object", "description": "Container of information of a video thumbnail.", "properties": { "timeOffset": { "description": "Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.", "format": "google-duration", "type": "string" }, "thumbnail": { "format": "byte", "description": "A byte string of the video frame.", "type": "string" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata", "type": "object", "properties": { "imageBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", "description": "Details of label image bounding box operation." }, "videoEventDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", "description": "Details of label video event operation." }, "imageClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", "description": "Details of label image classification operation." }, "imagePolylineDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", "description": "Details of label image polyline operation." }, "textClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", "description": "Details of label text classification operation." }, "imageSegmentationDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", "description": "Details of label image segmentation operation." }, "partialFailures": { "type": "array", "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "items": { "$ref": "GoogleRpcStatus" } }, "textEntityExtractionDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", "description": "Details of label text entity extraction operation." }, "videoClassificationDetails": { "description": "Details of label video classification operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata" }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "progressPercent": { "type": "integer", "format": "int32", "description": "Output only. Progress of label operation. Range: [0, 100]." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when labeling request was created." }, "videoObjectTrackingDetails": { "description": "Details of label video object tracking operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata" }, "imageBoundingPolyDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", "description": "Details of label image bounding poly operation." }, "dataset": { "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", "type": "string" }, "imageOrientedBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of label image oriented bounding box operation." }, "videoObjectDetectionDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", "description": "Details of label video object detection operation." } }, "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23" }, "GoogleCloudDatalabelingV1p1alpha1GcsDestination": { "description": "Export destination of the data.Only gcs path is allowed in output_uri.", "type": "object", "properties": { "mimeType": { "type": "string", "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported." }, "outputUri": { "type": "string", "description": "Required. The output uri of destination file." } }, "id": "GoogleCloudDatalabelingV1p1alpha1GcsDestination" }, "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata": { "id": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "description": "Details of LabelImagePolyline operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1TextPayload": { "properties": { "textContent": { "description": "Text content.", "type": "string" } }, "description": "Container of information about a piece of text.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1TextPayload" }, "GoogleCloudDatalabelingV1beta1Polyline": { "properties": { "vertices": { "description": "The polyline vertices.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Vertex" }, "type": "array" } }, "description": "A line with multiple line segments.", "id": "GoogleCloudDatalabelingV1beta1Polyline", "type": "object" }, "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation": { "id": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation", "description": "Video object tracking annotation.", "properties": { "annotationSpec": { "description": "Label of the object tracked in this annotation.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" }, "objectTrackingFrames": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame" }, "description": "The list of frames where this object track appears." }, "timeSegment": { "description": "The time segment of the video to which object tracking applies.", "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment" } }, "type": "object" }, "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config." } }, "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", "id": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config." } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", "description": "Details of a LabelImageSegmentation operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata": { "description": "Metadata of a LabelImageClassification operation.", "id": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata": { "description": "Metadata of an GenerateAnalysisReport operation.", "id": "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata", "properties": { "dataset": { "type": "string", "description": "The name of the dataset for which the analysis report is generated. Format: \"projects/*/datasets/*\"" }, "createTime": { "type": "string", "description": "Timestamp when generate report request was created.", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1EventConfig": { "description": "Config for video event human labeling task.", "id": "GoogleCloudDatalabelingV1beta1EventConfig", "properties": { "annotationSpecSets": { "type": "array", "description": "Required. The list of annotation spec set resource name. Similar to video classification, we support selecting event from multiple AnnotationSpecSet at the same time.", "items": { "type": "string" } }, "clipLength": { "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 60s.", "format": "int32", "type": "integer" }, "overlapLength": { "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 1s.", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig": { "properties": { "overlapLength": { "type": "integer", "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 0.3s.", "format": "int32" }, "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." }, "clipLength": { "format": "int32", "type": "integer", "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 20s." } }, "type": "object", "description": "Config for video object tracking human labeling task.", "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig" }, "GoogleCloudDatalabelingV1beta1GcsFolderDestination": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", "description": "Export folder destination of the data.", "properties": { "outputFolderUri": { "type": "string", "description": "Required. Cloud Storage directory to export data to." } } }, "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig": { "type": "object", "description": "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.", "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", "properties": { "extractionFrameRate": { "type": "number", "description": "Required. Number of frames per second to be extracted from the video.", "format": "double" }, "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." } } }, "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "type": "object", "description": "Details of a LabelTextEntityExtraction operation metadata.", "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata" }, "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata", "type": "object", "properties": { "createTime": { "description": "Output only. Timestamp when import dataset request was created.", "type": "string", "format": "google-datetime" }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "type": "array" }, "dataset": { "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", "type": "string" } }, "description": "Metadata of an ImportData operation." }, "GoogleCloudDatalabelingV1beta1ExampleComparison": { "id": "GoogleCloudDatalabelingV1beta1ExampleComparison", "type": "object", "description": "Example comparisons comparing ground truth output and predictions for a specific input.", "properties": { "modelCreatedExamples": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1Example" }, "type": "array", "description": "Predictions by the model for the input." }, "groundTruthExample": { "$ref": "GoogleCloudDatalabelingV1beta1Example", "description": "The ground truth output for the input." } } }, "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata": { "description": "Details of a LabelVideoObjectDetection operation metadata.", "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", "id": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse", "type": "object", "description": "Response used for ImportData longrunning operation.", "properties": { "totalCount": { "format": "int32", "description": "Output only. Total number of examples requested to import", "type": "integer" }, "dataset": { "description": "Ouptut only. The name of imported dataset.", "type": "string" }, "importCount": { "type": "integer", "format": "int32", "description": "Output only. Number of examples imported successfully." } } }, "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata": { "id": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata", "description": "Metadata describing the feedback from the labeling task requester.", "properties": {}, "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata": { "properties": { "partialFailures": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "dataset": { "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", "type": "string" }, "createTime": { "description": "Output only. Timestamp when import dataset request was created.", "type": "string", "format": "google-datetime" } }, "type": "object", "description": "Metadata of an ImportData operation.", "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata" }, "GoogleCloudDatalabelingV1beta1ClassificationMetadata": { "description": "Metadata for classification annotations.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", "properties": { "isMultiLabel": { "description": "Whether the classification task is multi-label or not.", "type": "boolean" } } }, "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata": { "description": "Details of LabelImagePolyline operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "description": "Metadata of a LabelImageClassification operation.", "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata" }, "GoogleCloudDatalabelingV1beta1BoundingPoly": { "properties": { "vertices": { "description": "The bounding polygon vertices.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Vertex" }, "type": "array" } }, "id": "GoogleCloudDatalabelingV1beta1BoundingPoly", "description": "A bounding polygon in the image.", "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "type": "object", "description": "Details of a LabelVideoObjectTracking operation metadata." }, "GoogleCloudDatalabelingV1beta1Vertex": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1Vertex", "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "properties": { "y": { "type": "integer", "format": "int32", "description": "Y coordinate." }, "x": { "description": "X coordinate.", "type": "integer", "format": "int32" } } }, "GoogleCloudDatalabelingV1beta1GcsDestination": { "type": "object", "properties": { "outputUri": { "description": "Required. The output uri of destination file.", "type": "string" }, "mimeType": { "type": "string", "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported." } }, "id": "GoogleCloudDatalabelingV1beta1GcsDestination", "description": "Export destination of the data.Only gcs path is allowed in output_uri." }, "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse", "type": "object", "properties": { "importCount": { "type": "integer", "format": "int32", "description": "Output only. Number of examples imported successfully." }, "totalCount": { "format": "int32", "type": "integer", "description": "Output only. Total number of examples requested to import" }, "dataset": { "description": "Ouptut only. The name of imported dataset.", "type": "string" } }, "description": "Response used for ImportData longrunning operation." }, "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse": { "id": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse", "description": "Results of listing annotated datasets for a dataset.", "properties": { "annotatedDatasets": { "description": "The list of annotated datasets to return.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1TextMetadata": { "description": "Metadata for the text.", "id": "GoogleCloudDatalabelingV1beta1TextMetadata", "type": "object", "properties": { "languageCode": { "description": "The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.", "type": "string" } } } }, "discoveryVersion": "v1", "description": "Public API for Google Cloud AI Data Labeling Service.", "mtlsRootUrl": "https://datalabeling.mtls.googleapis.com/", "basePath": "", "protocol": "rest", "ownerDomain": "google.com", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "ownerName": "Google", "title": "Data Labeling API", "version_module": true, "id": "datalabeling:v1beta1", "servicePath": "", "revision": "20231001", "parameters": { "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "$.xgafv": { "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "alt": { "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "type": "string", "enum": [ "json", "media", "proto" ], "location": "query" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean", "default": "true" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" } }, "resources": { "projects": { "resources": { "datasets": { "resources": { "dataItems": { "methods": { "get": { "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+/dataItems/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}" } }, "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", "id": "datalabeling.projects.datasets.dataItems.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1DataItem" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems/{dataItemsId}" }, "list": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" }, "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", "id": "datalabeling.projects.datasets.dataItems.list", "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. Filter is not supported at this moment." }, "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", "pattern": "^projects/[^/]+/datasets/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty." }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "location": "query", "format": "int32", "type": "integer" } }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/dataItems" } } }, "text": { "methods": { "label": { "id": "datalabeling.projects.datasets.text.label", "path": "v1beta1/{+parent}/text:label", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/text:label", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudDatalabelingV1beta1LabelTextRequest" }, "description": "Starts a labeling task for text. The type of text labeling task is configured by feature in the request.", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+$", "type": "string", "description": "Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}" } } } } }, "image": { "methods": { "label": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/datasets/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}" } }, "description": "Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", "id": "datalabeling.projects.datasets.image.label", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/image:label", "request": { "$ref": "GoogleCloudDatalabelingV1beta1LabelImageRequest" }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label", "httpMethod": "POST" } } }, "video": { "methods": { "label": { "parameters": { "parent": { "pattern": "^projects/[^/]+/datasets/[^/]+$", "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "datalabeling.projects.datasets.video.label", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/video:label", "description": "Starts a labeling task for video. The type of video labeling task is configured by feature in the request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/video:label", "request": { "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoRequest" }, "parameterOrder": [ "parent" ] } } }, "evaluations": { "resources": { "exampleComparisons": { "methods": { "search": { "id": "datalabeling.projects.datasets.evaluations.exampleComparisons.search", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/exampleComparisons:search", "description": "Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}/exampleComparisons:search", "request": { "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest" }, "parameters": { "parent": { "required": true, "description": "Required. Name of the Evaluation resource to search for example comparisons from. Format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}\"", "location": "path", "type": "string", "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse" }, "httpMethod": "POST" } } } }, "methods": { "get": { "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}", "description": "Gets an evaluation by resource name (to search, use projects.evaluations.search).", "parameters": { "name": { "description": "Required. Name of the evaluation. Format: \"projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'", "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", "type": "string", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" }, "parameterOrder": [ "name" ], "id": "datalabeling.projects.datasets.evaluations.get", "path": "v1beta1/{+name}" } } }, "annotatedDatasets": { "methods": { "delete": { "id": "datalabeling.projects.datasets.annotatedDatasets.delete", "description": "Deletes an annotated dataset by resource name.", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "description": "Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "required": true, "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameterOrder": [ "parent" ], "description": "Lists annotated datasets for a dataset. Pagination is supported.", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse" }, "httpMethod": "GET", "path": "v1beta1/{+parent}/annotatedDatasets", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotatedDatasetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotatedDatasets] call. Return first page if empty." }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "format": "int32" }, "filter": { "description": "Optional. Filter is not supported at this moment.", "type": "string", "location": "query" }, "parent": { "type": "string", "location": "path", "required": true, "description": "Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}", "pattern": "^projects/[^/]+/datasets/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.list" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", "response": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets an annotated dataset by resource name.", "id": "datalabeling.projects.datasets.annotatedDatasets.get", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$" } }, "path": "v1beta1/{+name}" } }, "resources": { "dataItems": { "methods": { "list": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", "httpMethod": "GET", "path": "v1beta1/{+parent}/dataItems", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.list", "parameters": { "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.", "type": "string" }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "location": "query", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", "location": "path", "type": "string", "required": true }, "filter": { "description": "Optional. Filter is not supported at this moment.", "type": "string", "location": "query" } } }, "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems/{dataItemsId}", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/dataItems/[^/]+$", "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}" } }, "httpMethod": "GET", "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1DataItem" }, "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset." } } }, "examples": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples", "httpMethod": "GET", "description": "Lists examples in an annotated dataset. Pagination is supported.", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListExamplesResponse" }, "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "type": "integer" }, "pageToken": { "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.", "location": "query", "type": "string" }, "filter": { "description": "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}\"", "type": "string", "location": "query" }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "description": "Required. Example resource parent.", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "datalabeling.projects.datasets.annotatedDatasets.examples.list", "path": "v1beta1/{+parent}/examples" }, "get": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1Example" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.examples.get", "parameters": { "name": { "required": true, "location": "path", "description": "Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/examples/[^/]+$", "type": "string" }, "filter": { "description": "Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"", "type": "string", "location": "query" } }, "description": "Gets an example by resource name, including both data and annotation.", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples/{examplesId}", "parameterOrder": [ "name" ], "httpMethod": "GET" } } }, "feedbackThreads": { "resources": { "feedbackMessages": { "methods": { "list": { "parameterOrder": [ "parent" ], "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list", "parameters": { "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackMessages.next_page_token of the previous [DataLabelingService.ListFeedbackMessages] call. Return first page if empty.", "type": "string" }, "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", "description": "Required. FeedbackMessage resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}\"" } }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages", "path": "v1beta1/{+parent}/feedbackMessages", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List FeedbackMessages with pagination.", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse" } }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.delete", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", "parameters": { "name": { "description": "Required. Name of the FeedbackMessage that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.", "type": "string", "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Delete a FeedbackMessage." }, "create": { "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", "description": "Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Create a FeedbackMessage object.", "httpMethod": "POST", "path": "v1beta1/{+parent}/feedbackMessages", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages" }, "get": { "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.get", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'." } }, "description": "Get a FeedbackMessage object.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" } } } } }, "methods": { "get": { "httpMethod": "GET", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", "type": "string", "required": true, "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get", "response": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" }, "description": "Get a FeedbackThread object.", "parameterOrder": [ "name" ] }, "list": { "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads", "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackThreads.next_page_token of the previous [DataLabelingService.ListFeedbackThreads] call. Return first page if empty.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." }, "parent": { "type": "string", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "description": "Required. FeedbackThread resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}\"", "required": true, "location": "path" } }, "description": "List FeedbackThreads with pagination.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse" }, "path": "v1beta1/{+parent}/feedbackThreads" }, "delete": { "path": "v1beta1/{+name}", "description": "Delete a FeedbackThread.", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.delete", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. Name of the FeedbackThread that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'." } }, "response": { "$ref": "GoogleProtobufEmpty" } } } } } } }, "methods": { "list": { "description": "Lists datasets under a project. Pagination is supported.", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse" }, "path": "v1beta1/{+parent}/datasets", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." }, "parent": { "pattern": "^projects/[^/]+$", "location": "path", "description": "Required. Dataset resource parent, format: projects/{project_id}", "required": true, "type": "string" }, "filter": { "description": "Optional. Filter on dataset is not supported at this moment.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDatasetsResponse.next_page_token of the previous [DataLabelingService.ListDatasets] call. Returns the first page if empty.", "location": "query", "type": "string" } }, "id": "datalabeling.projects.datasets.list" }, "get": { "description": "Gets dataset by resource name.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "datalabeling.projects.datasets.get", "response": { "$ref": "GoogleCloudDatalabelingV1beta1Dataset" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}" } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}", "httpMethod": "GET" }, "importData": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:importData", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+$", "type": "string", "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", "required": true, "location": "path" } }, "description": "Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.", "httpMethod": "POST", "id": "datalabeling.projects.datasets.importData", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:importData", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudDatalabelingV1beta1ImportDataRequest" } }, "delete": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "datalabeling.projects.datasets.delete", "description": "Deletes a dataset by resource name.", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+$", "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}" }, "exportData": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDatalabelingV1beta1ExportDataRequest" }, "parameters": { "name": { "required": true, "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+$", "type": "string" } }, "id": "datalabeling.projects.datasets.exportData", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "path": "v1beta1/{+name}:exportData", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports data and annotations from dataset.", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:exportData" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest" }, "response": { "$ref": "GoogleCloudDatalabelingV1beta1Dataset" }, "id": "datalabeling.projects.datasets.create", "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+$", "description": "Required. Dataset resource parent, format: projects/{project_id}", "type": "string" } }, "path": "v1beta1/{+parent}/datasets", "description": "Creates dataset. If success return a Dataset resource.", "flatPath": "v1beta1/projects/{projectsId}/datasets" } } }, "annotationSpecSets": { "methods": { "delete": { "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.annotationSpecSets.delete", "parameters": { "name": { "required": true, "location": "path", "description": "Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.", "type": "string", "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$" } }, "description": "Deletes an annotation spec set by resource name." }, "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse" }, "id": "datalabeling.projects.annotationSpecSets.list", "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotationSpecSetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotationSpecSets] call. Return first page if empty.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "description": "Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}", "location": "path", "pattern": "^projects/[^/]+$" }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "format": "int32", "location": "query" }, "filter": { "location": "query", "description": "Optional. Filter is not supported at this moment.", "type": "string" } }, "description": "Lists annotation spec sets for a project. Pagination is supported.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", "path": "v1beta1/{+parent}/annotationSpecSets" }, "create": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" }, "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+$", "description": "Required. AnnotationSpecSet resource parent, format: projects/{project_id}", "location": "path", "type": "string" } }, "description": "Creates an annotation spec set by providing a set of labels.", "id": "datalabeling.projects.annotationSpecSets.create", "path": "v1beta1/{+parent}/annotationSpecSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest" }, "parameterOrder": [ "parent" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "datalabeling.projects.annotationSpecSets.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", "response": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" }, "description": "Gets an annotation spec set by resource name.", "parameters": { "name": { "required": true, "location": "path", "description": "Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ] } } }, "evaluationJobs": { "methods": { "delete": { "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "datalabeling.projects.evaluationJobs.delete", "description": "Stops and deletes an evaluation job.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. Name of the evaluation job that is going to be deleted. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "path": "v1beta1/{+parent}/evaluationJobs", "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.", "location": "query", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the `AND` operator or the `OR` operator. For example, you can use the following string for your filter: \"evaluation_job.model_id = {model_name} AND evaluation_job.state = {evaluation_job_state}\"" }, "parent": { "location": "path", "pattern": "^projects/[^/]+$", "type": "string", "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", "required": true }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." } }, "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse" }, "description": "Lists all evaluation jobs within a project with possible filters. Pagination is supported.", "id": "datalabeling.projects.evaluationJobs.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" }, "resume": { "path": "v1beta1/{+name}:resume", "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:resume", "id": "datalabeling.projects.evaluationJobs.resume", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.", "response": { "$ref": "GoogleProtobufEmpty" }, "request": { "$ref": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest" }, "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", "required": true, "description": "Required. Name of the evaluation job that is going to be resumed. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"" } } }, "get": { "description": "Gets an evaluation job by resource name.", "response": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", "description": "Required. Name of the evaluation job. Format: \"projects/{project_id} /evaluationJobs/{evaluation_job_id}\"", "type": "string" } }, "id": "datalabeling.projects.evaluationJobs.get", "httpMethod": "GET", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "pause": { "description": "Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "datalabeling.projects.evaluationJobs.pause", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:pause", "path": "v1beta1/{+name}:pause", "request": { "$ref": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", "description": "Required. Name of the evaluation job that is going to be paused. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", "type": "string" } }, "httpMethod": "POST" }, "create": { "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest" }, "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", "parameterOrder": [ "parent" ], "id": "datalabeling.projects.evaluationJobs.create", "description": "Creates an evaluation job.", "path": "v1beta1/{+parent}/evaluationJobs", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+$", "required": true, "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", "type": "string", "location": "path" } }, "response": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: `humanAnnotationConfig.instruction`, `exampleCount`, and `exampleSamplePercentage`. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.evaluationJobs.patch", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", "required": true, "type": "string", "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"" }, "updateMask": { "description": "Optional. Mask for which fields to update. You can only provide the following fields: * `evaluationJobConfig.humanAnnotationConfig.instruction` * `evaluationJobConfig.exampleCount` * `evaluationJobConfig.exampleSamplePercentage` You can provide more than one of these fields by separating them with commas.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" } } } }, "instructions": { "methods": { "get": { "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/instructions/[^/]+$", "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}" } }, "id": "datalabeling.projects.instructions.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1Instruction" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", "description": "Gets an instruction by resource name.", "path": "v1beta1/{+name}" }, "create": { "description": "Creates an instruction for how data should be labeled.", "flatPath": "v1beta1/projects/{projectsId}/instructions", "parameters": { "parent": { "pattern": "^projects/[^/]+$", "required": true, "type": "string", "description": "Required. Instruction resource parent, format: projects/{project_id}", "location": "path" } }, "id": "datalabeling.projects.instructions.create", "path": "v1beta1/{+parent}/instructions", "httpMethod": "POST", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest" }, "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "location": "query", "description": "Optional. Filter is not supported at this moment.", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous [DataLabelingService.ListInstructions] call. Return first page if empty.", "type": "string", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+$", "description": "Required. Instruction resource parent, format: projects/{project_id}", "type": "string", "required": true }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/instructions", "description": "Lists instructions for a project. Pagination is supported.", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/instructions", "httpMethod": "GET", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse" }, "id": "datalabeling.projects.instructions.list" }, "delete": { "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/instructions/[^/]+$", "type": "string", "location": "path", "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}" } }, "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes an instruction object by resource name.", "id": "datalabeling.projects.instructions.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE" } } }, "evaluations": { "methods": { "search": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Searches evaluations within a project.", "id": "datalabeling.projects.evaluations.search", "response": { "$ref": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/evaluations:search", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/evaluations:search", "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." }, "filter": { "type": "string", "location": "query", "description": "Optional. To search evaluations, you can filter by the following: * evaluation_job.evaluation_job_id (the last part of EvaluationJob.name) * evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion) * evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.job_state (EvaluationJob.state) * annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName) To filter by multiple critiera, use the `AND` operator or the `OR` operator. The following examples shows a string that filters by several critiera: \"evaluation_job.evaluation_job_id = {evaluation_job_id} AND evaluation_job.model_id = {model_name} AND evaluation_job.evaluation_job_run_time_start = {timestamp_1} AND evaluation_job.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}\"" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request. If you don't specify this field, the API call requests the first page of the search." }, "parent": { "pattern": "^projects/[^/]+$", "required": true, "location": "path", "description": "Required. Evaluation search parent (project ID). Format: \"projects/ {project_id}\"", "type": "string" } } } } }, "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", "httpMethod": "DELETE", "id": "datalabeling.projects.operations.delete", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "GET", "id": "datalabeling.projects.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel" }, "get": { "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "datalabeling.projects.operations.get", "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "required": true, "pattern": "^projects/[^/]+/operations/[^/]+$", "type": "string" } }, "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "datalabeling.projects.operations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "name": { "pattern": "^projects/[^/]+$", "type": "string", "required": true, "description": "The name of the operation's parent resource.", "location": "path" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/operations", "parameterOrder": [ "name" ] } } } } } }, "version": "v1beta1", "kind": "discovery#restDescription", "batchPath": "batch", "documentationLink": "https://cloud.google.com/data-labeling/docs/" }