{ "baseUrl": "https://datalabeling.googleapis.com/", "title": "Data Labeling API", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "documentationLink": "https://cloud.google.com/data-labeling/docs/", "name": "datalabeling", "basePath": "", "parameters": { "prettyPrint": { "default": "true", "type": "boolean", "description": "Returns response with indentations and line breaks.", "location": "query" }, "alt": { "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "default": "json", "description": "Data format for response.", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "quotaUser": { "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.", "type": "string", "location": "query" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "key": { "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.", "type": "string", "location": "query" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "description": "V1 error format.", "type": "string" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." } }, "protocol": "rest", "id": "datalabeling:v1beta1", "resources": { "projects": { "resources": { "annotationSpecSets": { "methods": { "get": { "id": "datalabeling.projects.annotationSpecSets.get", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", "type": "string", "description": "Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", "location": "path", "required": true } }, "response": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", "description": "Gets an annotation spec set by resource name." }, "delete": { "description": "Deletes an annotation spec set by resource name.", "id": "datalabeling.projects.annotationSpecSets.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.", "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", "required": true, "type": "string", "location": "path" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", "httpMethod": "DELETE" }, "list": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", "description": "Lists annotation spec sets for a project. Pagination is supported.", "parameters": { "pageToken": { "type": "string", "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.", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter is not supported at this moment." }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." }, "parent": { "pattern": "^projects/[^/]+$", "description": "Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.annotationSpecSets.list", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/annotationSpecSets" }, "create": { "httpMethod": "POST", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+$", "description": "Required. AnnotationSpecSet resource parent, format: projects/{project_id}" } }, "description": "Creates an annotation spec set by providing a set of labels.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/annotationSpecSets", "id": "datalabeling.projects.annotationSpecSets.create", "response": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest" } } } }, "datasets": { "methods": { "get": { "parameterOrder": [ "name" ], "description": "Gets dataset by resource name.", "path": "v1beta1/{+name}", "id": "datalabeling.projects.datasets.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudDatalabelingV1beta1Dataset" }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+$", "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists datasets under a project. Pagination is supported.", "flatPath": "v1beta1/projects/{projectsId}/datasets", "path": "v1beta1/{+parent}/datasets", "parameterOrder": [ "parent" ], "id": "datalabeling.projects.datasets.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse" }, "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter on dataset is not supported at this moment." }, "parent": { "type": "string", "pattern": "^projects/[^/]+$", "description": "Required. Dataset resource parent, format: projects/{project_id}", "location": "path", "required": true }, "pageToken": { "type": "string", "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" } }, "httpMethod": "GET" }, "importData": { "request": { "$ref": "GoogleCloudDatalabelingV1beta1ImportDataRequest" }, "id": "datalabeling.projects.datasets.importData", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:importData", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", "type": "string", "pattern": "^projects/[^/]+/datasets/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "path": "v1beta1/{+name}:importData", "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.", "response": { "$ref": "GoogleLongrunningOperation" } }, "exportData": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudDatalabelingV1beta1ExportDataRequest" }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:exportData", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/datasets/[^/]+$", "required": true, "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:exportData", "description": "Exports data and annotations from dataset.", "id": "datalabeling.projects.datasets.exportData" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+$", "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Deletes a dataset by resource name.", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}", "id": "datalabeling.projects.datasets.delete", "response": { "$ref": "GoogleProtobufEmpty" } }, "create": { "flatPath": "v1beta1/projects/{projectsId}/datasets", "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest" }, "response": { "$ref": "GoogleCloudDatalabelingV1beta1Dataset" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "description": " Creates dataset. If success return a Dataset resource.", "path": "v1beta1/{+parent}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+$", "type": "string", "description": "Required. Dataset resource parent, format: projects/{project_id}", "location": "path", "required": true } }, "id": "datalabeling.projects.datasets.create" } }, "resources": { "evaluations": { "methods": { "get": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" }, "description": " Gets an evaluation by resource name (to search, use projects.evaluations.search).", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. Name of the evaluation. Format: \"projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'", "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", "location": "path" } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}", "id": "datalabeling.projects.datasets.evaluations.get", "httpMethod": "GET" } }, "resources": { "exampleComparisons": { "methods": { "search": { "httpMethod": "POST", "path": "v1beta1/{+parent}/exampleComparisons:search", "response": { "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}/exampleComparisons:search", "id": "datalabeling.projects.datasets.evaluations.exampleComparisons.search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", "type": "string", "description": "Required. Name of the Evaluation resource to search for example comparisons from. Format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}\"", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest" }, "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." } } } } }, "image": { "methods": { "label": { "parameters": { "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/datasets/[^/]+$", "location": "path", "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}" } }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/image:label", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "datalabeling.projects.datasets.image.label", "httpMethod": "POST", "request": { "$ref": "GoogleCloudDatalabelingV1beta1LabelImageRequest" }, "description": " Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", "parameterOrder": [ "parent" ] } } }, "annotatedDatasets": { "methods": { "list": { "parameters": { "filter": { "type": "string", "location": "query", "description": "Optional. Filter is not supported at this moment." }, "parent": { "pattern": "^projects/[^/]+/datasets/[^/]+$", "description": "Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}", "type": "string", "required": true, "location": "path" }, "pageToken": { "location": "query", "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.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "location": "query", "type": "integer", "format": "int32" } }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets", "id": "datalabeling.projects.datasets.annotatedDatasets.list", "path": "v1beta1/{+parent}/annotatedDatasets", "httpMethod": "GET", "description": "Lists annotated datasets for a dataset. Pagination is supported.", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "delete": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "id": "datalabeling.projects.datasets.annotatedDatasets.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "description": "Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", "required": true, "type": "string", "location": "path" } }, "description": "Deletes an annotated dataset by resource name." }, "get": { "parameterOrder": [ "name" ], "id": "datalabeling.projects.datasets.annotatedDatasets.get", "description": "Gets an annotated dataset by resource name.", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", "response": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" }, "path": "v1beta1/{+name}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "required": true, "type": "string", "description": "Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "feedbackThreads": { "methods": { "list": { "path": "v1beta1/{+parent}/feedbackThreads", "parameters": { "pageToken": { "type": "string", "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.", "location": "query" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "type": "integer", "location": "query" }, "parent": { "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "location": "path", "description": "Required. FeedbackThread resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}\"", "type": "string" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse" }, "description": "List FeedbackThreads with pagination.", "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads" }, "get": { "description": " Get a FeedbackThread object.", "response": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" }, "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", "parameters": { "name": { "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "description": "Delete a FeedbackThread.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.delete", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", "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}'.", "location": "path", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", "response": { "$ref": "GoogleProtobufEmpty" } } }, "resources": { "feedbackMessages": { "methods": { "get": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" }, "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", "location": "path", "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}/feedbackMessages/{feedback_message_id}'." } }, "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Get a FeedbackMessage object.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", "httpMethod": "GET" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", "type": "string", "required": true, "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}'.", "location": "path" } }, "description": "Delete a FeedbackMessage.", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages", "path": "v1beta1/{+parent}/feedbackMessages", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse" }, "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": { "type": "string", "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.", "location": "query" }, "parent": { "location": "path", "required": true, "type": "string", "description": "Required. FeedbackMessage resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}\"", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list", "description": "List FeedbackMessages with pagination." }, "create": { "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Create a FeedbackMessage object.", "request": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/feedbackMessages", "parameters": { "parent": { "description": "Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.", "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages" } } } } }, "dataItems": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.list", "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "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." }, "parent": { "type": "string", "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "location": "path" }, "filter": { "description": "Optional. Filter is not supported at this moment.", "type": "string", "location": "query" } }, "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", "path": "v1beta1/{+parent}/dataItems", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems" }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems/{dataItemsId}", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudDatalabelingV1beta1DataItem" }, "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.get", "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/dataItems/[^/]+$", "required": true, "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}" } } } } }, "examples": { "methods": { "get": { "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples/{examplesId}", "response": { "$ref": "GoogleCloudDatalabelingV1beta1Example" }, "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"" }, "name": { "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/examples/[^/]+$", "type": "string", "location": "path", "description": "Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}" } }, "id": "datalabeling.projects.datasets.annotatedDatasets.examples.get", "description": "Gets an example by resource name, including both data and annotation.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListExamplesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists examples in an annotated dataset. Pagination is supported.", "id": "datalabeling.projects.datasets.annotatedDatasets.examples.list", "parameters": { "pageToken": { "type": "string", "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" }, "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": { "type": "string", "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", "description": "Required. Example resource parent.", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100." } }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/examples", "httpMethod": "GET" } } } } }, "dataItems": { "methods": { "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.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems", "parameters": { "filter": { "type": "string", "description": "Optional. Filter is not supported at this moment.", "location": "query" }, "pageToken": { "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", "location": "query" }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "location": "query", "format": "int32" }, "parent": { "type": "string", "required": true, "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+$" } }, "id": "datalabeling.projects.datasets.dataItems.list", "path": "v1beta1/{+parent}/dataItems" }, "get": { "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", "response": { "$ref": "GoogleCloudDatalabelingV1beta1DataItem" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", "pattern": "^projects/[^/]+/datasets/[^/]+/dataItems/[^/]+$", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems/{dataItemsId}", "id": "datalabeling.projects.datasets.dataItems.get", "path": "v1beta1/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "text": { "methods": { "label": { "parameters": { "parent": { "type": "string", "description": "Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", "required": true, "pattern": "^projects/[^/]+/datasets/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/text:label", "id": "datalabeling.projects.datasets.text.label", "httpMethod": "POST", "description": "Starts a labeling task for text. The type of text labeling task is configured by feature in the request.", "request": { "$ref": "GoogleCloudDatalabelingV1beta1LabelTextRequest" }, "path": "v1beta1/{+parent}/text:label", "parameterOrder": [ "parent" ] } } }, "video": { "methods": { "label": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/video:label", "description": "Starts a labeling task for video. The type of video labeling task is configured by feature in the request.", "id": "datalabeling.projects.datasets.video.label", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/video:label", "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoRequest" }, "parameters": { "parent": { "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", "required": true, "location": "path", "pattern": "^projects/[^/]+/datasets/[^/]+$", "type": "string" } } } } } } }, "evaluations": { "methods": { "search": { "path": "v1beta1/{+parent}/evaluations:search", "parameters": { "filter": { "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}\"", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "description": "Required. Evaluation search parent (project ID). Format: \"projects/ {project_id}\"", "location": "path", "pattern": "^projects/[^/]+$" }, "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 request. If you don't specify this field, the API call requests the first page of the search.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "location": "query", "type": "integer" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse" }, "description": "Searches evaluations within a project.", "flatPath": "v1beta1/projects/{projectsId}/evaluations:search", "httpMethod": "GET", "id": "datalabeling.projects.evaluations.search" } } }, "operations": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "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" ], "id": "datalabeling.projects.operations.get", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { "required": true, "pattern": "^projects/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "id": "datalabeling.projects.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/operations", "httpMethod": "GET" }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^projects/[^/]+/operations/[^/]+$" } }, "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`." }, "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`.", "id": "datalabeling.projects.operations.delete", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE" } } }, "instructions": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", "id": "datalabeling.projects.instructions.get", "response": { "$ref": "GoogleCloudDatalabelingV1beta1Instruction" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/instructions/[^/]+$", "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets an instruction by resource name." }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/instructions", "id": "datalabeling.projects.instructions.create", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/instructions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest" }, "description": "Creates an instruction for how data should be labeled.", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+$", "description": "Required. Instruction resource parent, format: projects/{project_id}", "required": true, "type": "string" } } }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an instruction object by resource name.", "id": "datalabeling.projects.instructions.delete", "parameters": { "name": { "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/instructions/[^/]+$" } } }, "list": { "path": "v1beta1/{+parent}/instructions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse" }, "description": "Lists instructions for a project. Pagination is supported.", "flatPath": "v1beta1/projects/{projectsId}/instructions", "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "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." }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter is not supported at this moment." }, "parent": { "type": "string", "location": "path", "description": "Required. Instruction resource parent, format: projects/{project_id}", "required": true, "pattern": "^projects/[^/]+$" } }, "id": "datalabeling.projects.instructions.list" } } }, "evaluationJobs": { "methods": { "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+$", "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"" }, "pageToken": { "location": "query", "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.", "type": "string" }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "format": "int32", "location": "query" }, "filter": { "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}\"", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all evaluation jobs within a project with possible filters. Pagination is supported.", "id": "datalabeling.projects.evaluationJobs.list", "path": "v1beta1/{+parent}/evaluationJobs", "response": { "$ref": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse" } }, "create": { "response": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "description": " Creates an evaluation job.", "id": "datalabeling.projects.evaluationJobs.create", "request": { "$ref": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", "type": "string", "location": "path", "pattern": "^projects/[^/]+$" } }, "httpMethod": "POST", "path": "v1beta1/{+parent}/evaluationJobs" }, "delete": { "id": "datalabeling.projects.evaluationJobs.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "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/[^/]+$", "type": "string", "location": "path", "required": true } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "description": "Stops and deletes an evaluation job.", "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", "location": "path", "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": { "format": "google-fieldmask", "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" } }, "request": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "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.", "id": "datalabeling.projects.evaluationJobs.patch", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", "response": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "parameterOrder": [ "name" ], "httpMethod": "PATCH" }, "resume": { "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.", "id": "datalabeling.projects.evaluationJobs.resume", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "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}\"", "location": "path", "type": "string" } }, "request": { "$ref": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest" }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:resume", "httpMethod": "POST", "path": "v1beta1/{+name}:resume" }, "get": { "path": "v1beta1/{+name}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. Name of the evaluation job. Format: \"projects/{project_id} /evaluationJobs/{evaluation_job_id}\"" } }, "description": "Gets an evaluation job by resource name.", "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", "id": "datalabeling.projects.evaluationJobs.get", "response": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "pause": { "httpMethod": "POST", "path": "v1beta1/{+name}:pause", "description": "Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.", "parameters": { "name": { "type": "string", "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}\"" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "datalabeling.projects.evaluationJobs.pause", "request": { "$ref": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:pause" } } } } } }, "batchPath": "batch", "ownerName": "Google", "kind": "discovery#restDescription", "discoveryVersion": "v1", "mtlsRootUrl": "https://datalabeling.mtls.googleapis.com/", "schemas": { "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata": { "description": "Metadata of a CreateInstruction operation.", "id": "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata", "properties": { "instruction": { "type": "string", "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}" }, "createTime": { "description": "Timestamp when create instruction request was created.", "type": "string", "format": "google-datetime" }, "partialFailures": { "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata": { "description": "Details of a LabelVideoObjectDetection operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1beta1ListExamplesResponse": { "properties": { "examples": { "description": "The list of examples to return.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Example" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." } }, "id": "GoogleCloudDatalabelingV1beta1ListExamplesResponse", "type": "object", "description": "Results of listing Examples in and annotated dataset." }, "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata": { "description": "Metadata of an ImportData operation.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata", "properties": { "dataset": { "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", "type": "string" }, "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 import dataset request was created.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDatalabelingV1beta1AnnotationSpec": { "id": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "properties": { "displayName": { "description": "Required. The display name of the AnnotationSpec. Maximum of 64 characters.", "type": "string" }, "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": { "description": "Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.", "type": "string" } }, "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`.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics", "description": "Metrics calculated for an image object detection (bounding box) model.", "properties": { "prCurve": { "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", "description": "Precision-recall curve." } } }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata": { "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", "description": "Details of a LabelVideoObjectTracking operation metadata." }, "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata": { "properties": {}, "id": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata", "description": "Metadata describing the feedback from the operator.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata", "type": "object", "properties": { "dataset": { "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", "type": "string" }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "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.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when export dataset request was created." } }, "description": "Metadata of an ExportData operation." }, "GoogleCloudDatalabelingV1beta1InputConfig": { "description": "The configuration of input data, including data type, location, etc.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1InputConfig", "properties": { "gcsSource": { "description": "Source located in Cloud Storage.", "$ref": "GoogleCloudDatalabelingV1beta1GcsSource" }, "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" ], "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." ], "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." }, "textMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1TextMetadata", "description": "Required for text import, as language code must be specified." }, "dataType": { "enumDescriptions": [ "Data type is unspecified.", "Allowed for continuous evaluation.", "Video data type.", "Allowed for continuous evaluation.", "Allowed for continuous evaluation." ], "enum": [ "DATA_TYPE_UNSPECIFIED", "IMAGE", "VIDEO", "TEXT", "GENERAL_DATA" ], "description": "Required. Data type must be specifed when user tries to import data.", "type": "string" }, "classificationMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", "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." }, "bigquerySource": { "$ref": "GoogleCloudDatalabelingV1beta1BigQuerySource", "description": "Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob." } } }, "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation": { "properties": { "annotationSpec": { "description": "Label of the object tracked in this annotation.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" }, "timeSegment": { "description": "The time segment of the video to which object tracking applies.", "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment" }, "objectTrackingFrames": { "type": "array", "description": "The list of frames where this object track appears.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame" } } }, "description": "Video object tracking annotation.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation" }, "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" }, "filter": { "description": "Optional. Filter is not supported at this moment.", "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}" }, "outputConfig": { "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", "description": "Required. Specify the output destination." } }, "id": "GoogleCloudDatalabelingV1beta1ExportDataRequest", "description": "Request message for ExportData API.", "type": "object" }, "GoogleCloudDatalabelingV1beta1EvaluationJobConfig": { "type": "object", "description": "Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob.", "id": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", "properties": { "boundingPolyConfig": { "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", "description": "Specify this field if your model version performs image object detection (bounding box detection). `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet." }, "textClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", "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." }, "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." }, "exampleCount": { "format": "int32", "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.", "type": "integer" }, "inputConfig": { "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`).", "$ref": "GoogleCloudDatalabelingV1beta1InputConfig" }, "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)." }, "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." }, "exampleSamplePercentage": { "format": "double", "type": "number", "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." }, "imageClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", "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." }, "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." } } }, "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata", "description": "Metadata of an ExportData operation.", "type": "object", "properties": { "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" } }, "dataset": { "type": "string", "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"" }, "createTime": { "type": "string", "description": "Output only. Timestamp when export dataset request was created.", "format": "google-datetime" }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." } } }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata": { "description": "Details of a LabelVideoClassification operation metadata.", "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1Annotation": { "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", "properties": { "annotationSource": { "description": "Output only. The source of the annotation.", "enum": [ "ANNOTATION_SOURCE_UNSPECIFIED", "OPERATOR" ], "type": "string", "enumDescriptions": [ "", "Answer is provided by a human contributor." ] }, "annotationMetadata": { "description": "Output only. Annotation metadata, including information like votes for labels.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationMetadata" }, "name": { "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}", "type": "string" }, "annotationSentiment": { "description": "Output only. Sentiment for this annotation.", "type": "string", "enum": [ "ANNOTATION_SENTIMENT_UNSPECIFIED", "NEGATIVE", "POSITIVE" ], "enumDescriptions": [ "", "This annotation describes negatively about the data.", "This label describes positively about the data." ] }, "annotationValue": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationValue", "description": "Output only. This is the actual annotation value, e.g classification, bounding box values are stored here." } }, "id": "GoogleCloudDatalabelingV1beta1Annotation" }, "GoogleCloudDatalabelingV1beta1ListInstructionsResponse": { "id": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse", "type": "object", "description": "Results of listing instructions under a project.", "properties": { "instructions": { "description": "The list of Instructions to return.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Instruction" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." } } }, "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config." } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of a LabelImageOrientedBoundingBox operation metadata." }, "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata": { "description": "Details of a LabelTextEntityExtraction operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata" }, "GoogleCloudDatalabelingV1beta1LabelTextRequest": { "description": "Request message for LabelText.", "properties": { "textEntityExtractionConfig": { "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", "description": "Configuration for entity extraction task. One of text_classification_config and text_entity_extraction_config is required." }, "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Required. Basic human annotation config." }, "textClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", "description": "Configuration for text classification task. One of text_classification_config and text_entity_extraction_config is required." }, "feature": { "type": "string", "enumDescriptions": [ "", "Label text content to one of more labels.", "Label entities and their span in text." ], "description": "Required. The type of text labeling task.", "enum": [ "FEATURE_UNSPECIFIED", "TEXT_CLASSIFICATION", "TEXT_ENTITY_EXTRACTION" ] } }, "id": "GoogleCloudDatalabelingV1beta1LabelTextRequest", "type": "object" }, "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", "type": "object", "description": "Details of a LabelTextClassification operation metadata." }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", "description": "Details of a LabelVideoClassification operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelImageBoundingBox operation metadata." }, "GoogleCloudDatalabelingV1alpha1LabelStats": { "type": "object", "description": "Statistics about annotation specs.", "id": "GoogleCloudDatalabelingV1alpha1LabelStats", "properties": { "exampleCount": { "type": "object", "additionalProperties": { "type": "string", "format": "int64" }, "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." } } }, "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig": { "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig", "description": "Annotation spec set with the setting of allowing multi labels or not.", "type": "object", "properties": { "allowMultiLabel": { "type": "boolean", "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set." }, "annotationSpecSet": { "description": "Required. Annotation spec set resource name.", "type": "string" } } }, "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", "description": "Details of a LabelTextClassification operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata": { "properties": { "imageBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", "description": "Details of label image bounding box operation." }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "dataset": { "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", "type": "string" }, "videoClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", "description": "Details of label video classification operation." }, "imageSegmentationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", "description": "Details of label image segmentation operation." }, "videoObjectTrackingDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", "description": "Details of label video object tracking operation." }, "imageClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", "description": "Details of label image classification operation." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when labeling request was created." }, "imagePolylineDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", "description": "Details of label image polyline operation." }, "videoObjectDetectionDetails": { "description": "Details of label video object detection operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata" }, "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" }, "progressPercent": { "type": "integer", "format": "int32", "description": "Output only. Progress of label operation. Range: [0, 100]." }, "textEntityExtractionDetails": { "description": "Details of label text entity extraction operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata" }, "textClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", "description": "Details of label text classification operation." }, "imageOrientedBoundingBoxDetails": { "description": "Details of label image oriented bounding box operation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata" }, "videoEventDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", "description": "Details of label video event operation." }, "imageBoundingPolyDetails": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", "description": "Details of label image bounding poly operation." } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata", "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata": { "description": "Details of a LabelImageBoundingBox operation metadata.", "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1ListDataItemsResponse": { "type": "object", "description": "Results of listing data items in a dataset.", "properties": { "dataItems": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1DataItem" }, "description": "The list of data items to return." }, "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" } }, "id": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" }, "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse": { "description": "Response used for ImportData longrunning operation.", "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse", "properties": { "dataset": { "type": "string", "description": "Ouptut only. The name of imported dataset." }, "totalCount": { "description": "Output only. Total number of examples requested to import", "type": "integer", "format": "int32" }, "importCount": { "type": "integer", "description": "Output only. Number of examples imported successfully.", "format": "int32" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1Dataset": { "type": "object", "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": { "lastMigrateTime": { "format": "google-datetime", "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.", "type": "string" }, "dataItemCount": { "description": "Output only. The number of data items in the dataset.", "format": "int64", "type": "string" }, "description": { "type": "string", "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long." }, "name": { "description": "Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}", "type": "string" }, "blockingResources": { "description": "Output only. The names of any related resources that are blocking changes to the dataset.", "type": "array", "items": { "type": "string" } }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time the dataset is created." }, "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" } }, "displayName": { "type": "string", "description": "Required. The display name of the dataset. Maximum of 64 characters." } } }, "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig": { "description": "Config for video object tracking human labeling task.", "properties": { "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." }, "overlapLength": { "format": "int32", "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." }, "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 20s.", "format": "int32", "type": "integer" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig" }, "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata": { "description": "Details of LabelImagePolyline operation metadata.", "id": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", "description": "Details of a LabelVideoClassification operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1beta1Instruction": { "id": "GoogleCloudDatalabelingV1beta1Instruction", "properties": { "name": { "type": "string", "description": "Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}" }, "blockingResources": { "type": "array", "description": "Output only. The names of any related resources that are blocking changes to the instruction.", "items": { "type": "string" } }, "updateTime": { "format": "google-datetime", "description": "Output only. Last update time of instruction.", "type": "string" }, "displayName": { "description": "Required. The display name of the instruction. Maximum of 64 characters.", "type": "string" }, "csvInstruction": { "$ref": "GoogleCloudDatalabelingV1beta1CsvInstruction", "deprecated": true, "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." }, "dataType": { "type": "string", "description": "Required. The data type of this instruction.", "enumDescriptions": [ "Data type is unspecified.", "Allowed for continuous evaluation.", "Video data type.", "Allowed for continuous evaluation.", "Allowed for continuous evaluation." ], "enum": [ "DATA_TYPE_UNSPECIFIED", "IMAGE", "VIDEO", "TEXT", "GENERAL_DATA" ] }, "pdfInstruction": { "$ref": "GoogleCloudDatalabelingV1beta1PdfInstruction", "description": "Instruction from a PDF document. The PDF should be in a Cloud Storage bucket." }, "description": { "type": "string", "description": "Optional. User-provided description of the instruction. The description can be up to 10000 characters long." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Creation time of instruction." } }, "description": "Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse": { "properties": { "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "dataset": { "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", "type": "string" }, "exportCount": { "format": "int32", "type": "integer", "description": "Output only. Number of examples exported successfully." }, "labelStats": { "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", "description": "Output only. Statistic infos of labels in the exported dataset." }, "outputConfig": { "description": "Output only. output_config in the ExportData request.", "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig" }, "totalCount": { "type": "integer", "format": "int32", "description": "Output only. Total number of examples requested to export" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse", "description": "Response used for ExportDataset longrunning operation." }, "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig": { "id": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", "properties": { "minAcceptableMeanAveragePrecision": { "format": "double", "type": "number", "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." }, "email": { "description": "Required. An email address to send alerts to.", "type": "string" } }, "description": "Provides details for how an evaluation job sends email alerts based on the results of a run.", "type": "object" }, "GoogleCloudDatalabelingV1alpha1GcsDestination": { "properties": { "outputUri": { "type": "string", "description": "Required. The output uri of destination file." }, "mimeType": { "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", "type": "string" } }, "description": "Export destination of the data.Only gcs path is allowed in output_uri.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1GcsDestination" }, "GoogleCloudDatalabelingV1beta1AnnotationValue": { "properties": { "imageSegmentationAnnotation": { "description": "Annotation value for image segmentation.", "$ref": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation" }, "imagePolylineAnnotation": { "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.", "$ref": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation" }, "imageBoundingPolyAnnotation": { "description": "Annotation value for image bounding box, oriented bounding box and polygon cases.", "$ref": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation" }, "videoClassificationAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", "description": "Annotation value for video classification case." }, "videoEventAnnotation": { "description": "Annotation value for video event case.", "$ref": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation" }, "videoObjectTrackingAnnotation": { "description": "Annotation value for video object detection and tracking case.", "$ref": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation" }, "textClassificationAnnotation": { "description": "Annotation value for text classification case.", "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation" }, "imageClassificationAnnotation": { "description": "Annotation value for image classification case.", "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation" }, "textEntityExtractionAnnotation": { "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", "description": "Annotation value for text entity extraction case." } }, "description": "Annotation value for an example.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1AnnotationValue" }, "GoogleCloudDatalabelingV1beta1NormalizedVertex": { "id": "GoogleCloudDatalabelingV1beta1NormalizedVertex", "properties": { "y": { "type": "number", "format": "float", "description": "Y coordinate." }, "x": { "description": "X coordinate.", "format": "float", "type": "number" } }, "type": "object", "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." }, "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation": { "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." }, "imageBytes": { "description": "A byte string of a full image's color map.", "type": "string", "format": "byte" }, "mimeType": { "description": "Image format.", "type": "string" } }, "description": "Image segmentation annotation.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation" }, "GoogleCloudDatalabelingV1beta1EvaluationConfig": { "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." } }, "type": "object", "description": "Configuration details used for calculating evaluation metrics and creating an Evaluation.", "id": "GoogleCloudDatalabelingV1beta1EvaluationConfig" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", "description": "Details of a LabelImageBoundingBox operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", "description": "Details of a LabelTextEntityExtraction operation metadata." }, "GoogleCloudDatalabelingV1beta1VideoPayload": { "properties": { "signedUri": { "description": "Signed uri of the video file in the service bucket.", "type": "string" }, "frameRate": { "description": "FPS of the video.", "format": "float", "type": "number" }, "videoThumbnails": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1VideoThumbnail" }, "description": "The list of video thumbnails." }, "videoUri": { "type": "string", "description": "Video uri from the user bucket." }, "mimeType": { "type": "string", "description": "Video format." } }, "id": "GoogleCloudDatalabelingV1beta1VideoPayload", "description": "Container of information of a video.", "type": "object" }, "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation": { "id": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", "type": "object", "description": "Video classification annotation.", "properties": { "timeSegment": { "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", "description": "The time segment of the video to which the annotation applies." }, "annotationSpec": { "description": "Label of the segment specified by time_segment.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" } } }, "GoogleCloudDatalabelingV1p2alpha1LabelStats": { "description": "Statistics about annotation specs.", "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." } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelStats", "type": "object" }, "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig": { "id": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "type": "object", "properties": { "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." }, "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" }, "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": { "type": "string", "description": "Required. Instruction resource name." }, "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" }, "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": { "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." } }, "description": "Configuration for how human labeling task should be done." }, "GoogleCloudDatalabelingV1beta1ExampleComparison": { "description": "Example comparisons comparing ground truth output and predictions for a specific input.", "id": "GoogleCloudDatalabelingV1beta1ExampleComparison", "type": "object", "properties": { "groundTruthExample": { "$ref": "GoogleCloudDatalabelingV1beta1Example", "description": "The ground truth output for the input." }, "modelCreatedExamples": { "description": "Predictions by the model for the input.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Example" }, "type": "array" } } }, "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions": { "id": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", "properties": { "iouThreshold": { "type": "number", "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." } }, "description": "Options regarding evaluation between bounding boxes.", "type": "object" }, "GoogleCloudDatalabelingV1beta1FeedbackMessage": { "id": "GoogleCloudDatalabelingV1beta1FeedbackMessage", "type": "object", "description": "A feedback message inside a feedback thread.", "properties": { "operatorFeedbackMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata" }, "image": { "type": "string", "format": "byte", "description": "The image storing this feedback if the feedback is an image representing operator's comments." }, "name": { "type": "string", "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}'" }, "body": { "type": "string", "description": "String content of the feedback. Maximum of 10000 characters." }, "requesterFeedbackMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata" }, "createTime": { "type": "string", "description": "Create time.", "format": "google-datetime" } } }, "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata": { "type": "object", "properties": { "progressPercent": { "description": "Output only. Progress of label operation. Range: [0, 100].", "format": "int32", "type": "integer" }, "imageSegmentationDetails": { "description": "Details of label image segmentation operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata" }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "textClassificationDetails": { "description": "Details of label text classification operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata" }, "imageClassificationDetails": { "description": "Details of label image classification operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata" }, "videoClassificationDetails": { "description": "Details of label video classification operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata" }, "videoObjectDetectionDetails": { "description": "Details of label video object detection operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata" }, "imageBoundingPolyDetails": { "description": "Details of label image bounding poly operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata" }, "imageBoundingBoxDetails": { "description": "Details of label image bounding box operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata" }, "dataset": { "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", "type": "string" }, "videoObjectTrackingDetails": { "description": "Details of label video object tracking operation.", "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata" }, "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" }, "imagePolylineDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", "description": "Details of label image polyline operation." }, "imageOrientedBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of label image oriented bounding box operation." }, "textEntityExtractionDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", "description": "Details of label text entity extraction operation." }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when labeling request was created.", "type": "string" }, "videoEventDetails": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", "description": "Details of label video event operation." } }, "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", "id": "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata" }, "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": { "description": "Required. Annotation spec set resource name.", "type": "string" }, "sentimentConfig": { "deprecated": true, "description": "Optional. Configs for sentiment selection. We deprecate sentiment analysis in data labeling side as it is incompatible with uCAIP.", "$ref": "GoogleCloudDatalabelingV1beta1SentimentConfig" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "description": "Details of LabelImageBoundingPoly operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata": { "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata" }, "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination": { "properties": { "outputFolderUri": { "type": "string", "description": "Required. Cloud Storage directory to export data to." } }, "type": "object", "description": "Export folder destination of the data.", "id": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination" }, "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelVideoClassification operation metadata." }, "GoogleCloudDatalabelingV1beta1SequentialSegment": { "properties": { "start": { "format": "int32", "type": "integer", "description": "Start position (inclusive)." }, "end": { "description": "End position (exclusive).", "type": "integer", "format": "int32" } }, "description": "Start and end position in a sequence (e.g. text segment).", "type": "object", "id": "GoogleCloudDatalabelingV1beta1SequentialSegment" }, "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame", "description": "Video frame level annotation for object detection and tracking.", "properties": { "boundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" }, "normalizedBoundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" }, "timeOffset": { "description": "The time offset of this frame relative to the beginning of the video.", "type": "string", "format": "google-duration" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1beta1Example": { "id": "GoogleCloudDatalabelingV1beta1Example", "description": "An Example is a piece of data and its annotation. For example, an image with label \"house\".", "type": "object", "properties": { "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." }, "videoPayload": { "description": "The video payload, a container of the video uri.", "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload" }, "imagePayload": { "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload", "description": "The image payload, a container of the image bytes/uri." }, "textPayload": { "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", "description": "The text payload, a container of the text content." }, "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" } } }, "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse": { "description": "Results for listing FeedbackMessages.", "id": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse", "type": "object", "properties": { "feedbackMessages": { "type": "array", "description": "The list of feedback messages to return.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." } } }, "GoogleCloudDatalabelingV1beta1CsvInstruction": { "id": "GoogleCloudDatalabelingV1beta1CsvInstruction", "properties": { "gcsFileUri": { "description": "CSV file for the instruction. Only gcs path is allowed.", "type": "string" } }, "type": "object", "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file." }, "GoogleCloudDatalabelingV1beta1FeedbackThread": { "description": "A feedback thread of a certain labeling task on a certain annotated dataset.", "id": "GoogleCloudDatalabelingV1beta1FeedbackThread", "properties": { "name": { "description": "Name of the feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'", "type": "string" }, "feedbackThreadMetadata": { "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", "description": "Metadata regarding the feedback thread." } }, "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", "type": "object", "description": "Details of a LabelImageSegmentation operation metadata." }, "GoogleCloudDatalabelingV1p2alpha1OutputConfig": { "id": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", "properties": { "gcsFolderDestination": { "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs.", "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination" }, "gcsDestination": { "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation.", "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsDestination" } }, "type": "object", "description": "The configuration of output data." }, "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata": { "description": "Details of LabelImagePolyline operation metadata.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", "description": "Details of a LabelVideoEvent operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1LabelOperationMetadata", "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", "properties": { "videoClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", "description": "Details of label video classification operation." }, "dataset": { "type": "string", "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"" }, "videoObjectTrackingDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata", "description": "Details of label video object tracking operation." }, "textEntityExtractionDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", "description": "Details of label text entity extraction operation." }, "imageBoundingPolyDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", "description": "Details of label image bounding poly operation." }, "imageSegmentationDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", "description": "Details of label image segmentation operation." }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "videoEventDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", "description": "Details of label video event operation." }, "textClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", "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" }, "imageClassificationDetails": { "description": "Details of label image classification operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when labeling request was created." }, "imagePolylineDetails": { "description": "Details of label image polyline operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata" }, "imageBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", "description": "Details of label image bounding box operation." }, "imageOrientedBoundingBoxDetails": { "description": "Details of label image oriented bounding box operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata" }, "videoObjectDetectionDetails": { "description": "Details of label video object detection operation.", "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata" }, "progressPercent": { "description": "Output only. Progress of label operation. Range: [0, 100].", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", "properties": { "annotationSpec": { "description": "Label of image.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" } }, "description": "Image classification annotation definition." }, "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "description": "Metadata of a LabelImageClassification operation.", "id": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata": { "description": "Details of LabelImageBoundingPoly operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", "description": "Metadata of a LabelImageClassification operation.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest": { "properties": {}, "id": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest", "type": "object", "description": "Request message ResumeEvaluationJob." }, "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest": { "id": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest", "properties": {}, "description": "Request message for PauseEvaluationJob.", "type": "object" }, "GoogleCloudDatalabelingV1beta1Polyline": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1Polyline", "description": "A line with multiple line segments.", "properties": { "vertices": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Vertex" }, "description": "The polyline vertices." } } }, "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest": { "description": "Request message for CreateAnnotationSpecSet.", "properties": { "annotationSpecSet": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", "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." } }, "id": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest", "type": "object" }, "GoogleCloudDatalabelingV1beta1CreateDatasetRequest": { "description": "Request message for CreateDataset.", "type": "object", "properties": { "dataset": { "description": "Required. The dataset to be created.", "$ref": "GoogleCloudDatalabelingV1beta1Dataset" } }, "id": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest" }, "GoogleCloudDatalabelingV1beta1OutputConfig": { "id": "GoogleCloudDatalabelingV1beta1OutputConfig", "type": "object", "description": "The configuration of output data.", "properties": { "gcsDestination": { "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation.", "$ref": "GoogleCloudDatalabelingV1beta1GcsDestination" }, "gcsFolderDestination": { "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs.", "$ref": "GoogleCloudDatalabelingV1beta1GcsFolderDestination" } } }, "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest", "properties": { "job": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob", "description": "Required. The evaluation job to create." } }, "description": " Request message for CreateEvaluationJob." }, "GoogleCloudDatalabelingV1beta1Evaluation": { "properties": { "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" ], "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." ], "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." }, "createTime": { "description": "Output only. Timestamp for when this evaluation was created.", "type": "string", "format": "google-datetime" }, "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" }, "evaluationMetrics": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", "description": "Output only. Metrics comparing predictions to ground truth labels." }, "evaluationJobRunTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp for when the evaluation job that created this evaluation ran." }, "config": { "description": "Output only. Options used in the evaluation job that created this evaluation.", "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig" }, "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" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1Evaluation", "description": "Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully." }, "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelVideoObjectTracking operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata" }, "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig": { "description": "Configuration for how human labeling task should be done.", "type": "object", "properties": { "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." }, "annotatedDatasetDescription": { "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", "type": "string" }, "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" }, "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.", "format": "int32", "type": "integer" }, "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" }, "annotatedDatasetDisplayName": { "type": "string", "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters ." }, "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/" }, "questionDuration": { "type": "string", "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", "format": "google-duration" } }, "id": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" }, "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata": { "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "type": "object", "description": "Details of a LabelVideoObjectDetection operation metadata." }, "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig": { "properties": { "questionDuration": { "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", "format": "google-duration", "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": { "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": { "description": "Required. Instruction resource name.", "type": "string" }, "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." }, "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" }, "contributorEmails": { "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", "items": { "type": "string" } }, "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." } }, "id": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Configuration for how human labeling task should be done.", "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", "description": "Details of a LabelVideoEvent operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ClassificationMetrics": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1ClassificationMetrics", "description": "Metrics calculated for a classification model.", "properties": { "confusionMatrix": { "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrix", "description": "Confusion matrix of predicted labels vs. ground truth labels." }, "prCurve": { "description": "Precision-recall curve based on ground truth labels, predicted labels, and scores for the predicted labels.", "$ref": "GoogleCloudDatalabelingV1beta1PrCurve" } } }, "GoogleCloudDatalabelingV1beta1VideoEventAnnotation": { "description": "Video event annotation.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation", "properties": { "timeSegment": { "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", "description": "The time segment of the video to which the annotation applies." }, "annotationSpec": { "description": "Label of the event in this annotation.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" } } }, "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse": { "description": "Results of listing annotation spec set under a project.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." }, "annotationSpecSets": { "description": "The list of annotation spec sets.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" } } }, "id": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse" }, "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly": { "properties": { "normalizedVertices": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" }, "description": "The bounding polygon normalized vertices.", "type": "array" } }, "id": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly", "type": "object", "description": "Normalized bounding polygon." }, "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } }, "description": "Details of LabelImagePolyline operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata" }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", "type": "object", "description": "Details of a LabelVideoObjectTracking operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata": { "id": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", "description": "Details of a LabelTextEntityExtraction operation metadata.", "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } } }, "GoogleCloudDatalabelingV1beta1NormalizedPolyline": { "properties": { "normalizedVertices": { "description": "The normalized polyline vertices.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" } } }, "description": "Normalized polyline.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1NormalizedPolyline" }, "GoogleCloudDatalabelingV1beta1OperatorMetadata": { "id": "GoogleCloudDatalabelingV1beta1OperatorMetadata", "type": "object", "properties": { "totalVotes": { "description": "The total number of contributors that answer this question.", "type": "integer", "format": "int32" }, "labelVotes": { "description": "The total number of contributors that choose this label.", "type": "integer", "format": "int32" }, "comments": { "description": "Comments from contributors.", "type": "array", "items": { "type": "string" } }, "score": { "format": "float", "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)." } }, "description": "General information useful for labels coming from contributors." }, "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", "description": "Metadata of a LabelImageClassification operation." }, "GoogleCloudDatalabelingV1beta1GcsDestination": { "description": "Export destination of the data.Only gcs path is allowed in output_uri.", "id": "GoogleCloudDatalabelingV1beta1GcsDestination", "type": "object", "properties": { "mimeType": { "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", "type": "string" }, "outputUri": { "description": "Required. The output uri of destination file.", "type": "string" } } }, "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata": { "type": "object", "description": "Metadata of an ImportData operation.", "properties": { "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" }, "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." } }, "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata" }, "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata", "description": "Metadata of an ImportData operation.", "properties": { "dataset": { "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", "type": "string" }, "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 import dataset request was created.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata": { "type": "object", "description": "Details of a LabelTextClassification operation metadata.", "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation": { "id": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", "description": "Image bounding poly annotation. It represents a polygon including bounding box in the image.", "properties": { "boundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" }, "normalizedBoundingPoly": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" }, "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of object in this bounding polygon." } }, "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata", "description": "Metadata of an ImportData operation.", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when import dataset request was created.", "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.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "dataset": { "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", "type": "string" } }, "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata": { "type": "object", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelTextClassification operation metadata.", "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata" }, "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata" }, "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" }, "dataset": { "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", "type": "string" }, "labelStats": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelStats", "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/*\"." }, "totalCount": { "type": "integer", "description": "Output only. Total number of examples requested to export", "format": "int32" } }, "description": "Response used for ExportDataset longrunning operation.", "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse" }, "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig": { "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", "properties": { "annotationSpecSet": { "description": "Required. Annotation spec set resource name.", "type": "string" } }, "description": "Config for text entity extraction human labeling task.", "type": "object" }, "GoogleCloudDatalabelingV1beta1ListDatasetsResponse": { "type": "object", "properties": { "datasets": { "description": "The list of datasets to return.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Dataset" } }, "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" } }, "description": "Results of listing datasets within a project.", "id": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse" }, "GoogleCloudDatalabelingV1beta1PrCurve": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1PrCurve", "properties": { "meanAveragePrecision": { "format": "float", "description": "Mean average prcision of this curve.", "type": "number" }, "confidenceMetricsEntries": { "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`.", "type": "array" }, "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" }, "areaUnderCurve": { "format": "float", "description": "Area under the precision-recall curve. Not to be confused with area under a receiver operating characteristic (ROC) curve.", "type": "number" } } }, "GoogleCloudDatalabelingV1beta1BigQuerySource": { "properties": { "inputUri": { "type": "string", "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)." } }, "id": "GoogleCloudDatalabelingV1beta1BigQuerySource", "type": "object", "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." }, "GoogleCloudDatalabelingV1beta1ImageClassificationConfig": { "properties": { "annotationSpecSet": { "type": "string", "description": "Required. Annotation spec set resource name." }, "allowMultiLabel": { "type": "boolean", "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image." }, "answerAggregationType": { "enumDescriptions": [ "", "Majority vote to aggregate answers.", "Unanimous answers will be adopted.", "Preserve all answers by crowd compute." ], "type": "string", "enum": [ "STRING_AGGREGATION_TYPE_UNSPECIFIED", "MAJORITY_VOTE", "UNANIMOUS_VOTE", "NO_AGGREGATION" ], "description": "Optional. The type of how to aggregate answers." } }, "type": "object", "description": "Config for image classification human labeling task.", "id": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig" }, "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse": { "description": "Results for listing FeedbackThreads.", "id": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse", "type": "object", "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" } } }, "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest": { "description": "Request message of SearchExampleComparisons.", "type": "object", "properties": { "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", "format": "int32" }, "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" } }, "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest" }, "GoogleCloudDatalabelingV1beta1LabelStats": { "id": "GoogleCloudDatalabelingV1beta1LabelStats", "properties": { "exampleCount": { "additionalProperties": { "format": "int64", "type": "string" }, "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.", "type": "object" } }, "description": "Statistics about annotation specs.", "type": "object" }, "GoogleCloudDatalabelingV1alpha1GcsFolderDestination": { "id": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", "properties": { "outputFolderUri": { "description": "Required. Cloud Storage directory to export data to.", "type": "string" } }, "description": "Export folder destination of the data.", "type": "object" }, "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse": { "description": "Results of searching example comparisons.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse", "properties": { "exampleComparisons": { "type": "array", "description": "A list of example comparisons matching the search criteria.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1ExampleComparison" } }, "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" } } }, "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig": { "properties": { "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/" }, "annotatedDatasetDescription": { "type": "string", "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long." }, "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." }, "annotatedDatasetDisplayName": { "type": "string", "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters ." }, "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." }, "questionDuration": { "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", "type": "string", "format": "google-duration" }, "instruction": { "description": "Required. Instruction resource name.", "type": "string" }, "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}`." }, "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." } }, "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Configuration for how human labeling task should be done." }, "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata": { "type": "object", "description": "Details of a LabelImageSegmentation operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata" }, "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata": { "description": "Metadata of an ExportData operation.", "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata", "type": "object", "properties": { "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "createTime": { "type": "string", "description": "Output only. Timestamp when export dataset request was created.", "format": "google-datetime" }, "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": { "type": "string", "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"" } } }, "GoogleCloudDatalabelingV1p1alpha1GcsDestination": { "description": "Export destination of the data.Only gcs path is allowed in output_uri.", "properties": { "mimeType": { "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", "type": "string" }, "outputUri": { "description": "Required. The output uri of destination file.", "type": "string" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1GcsDestination" }, "GoogleCloudDatalabelingV1beta1ClassificationMetadata": { "id": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", "description": "Metadata for classification annotations.", "properties": { "isMultiLabel": { "description": "Whether the classification task is multi-label or not.", "type": "boolean" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata": { "type": "object", "description": "Metadata of a LabelImageClassification operation.", "id": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1TimeSegment": { "properties": { "endTimeOffset": { "format": "google-duration", "type": "string", "description": "End of the time segment (exclusive), represented as the duration since the example start." }, "startTimeOffset": { "type": "string", "description": "Start of the time segment (inclusive), represented as the duration since the example start.", "format": "google-duration" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1TimeSegment", "description": "A time period inside of an example that has a time dimension (e.g. video)." }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata": { "type": "object", "description": "Details of a LabelVideoObjectDetection operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata" }, "GoogleLongrunningListOperationsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } } }, "type": "object", "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse" }, "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination": { "description": "Export folder destination of the data.", "properties": { "outputFolderUri": { "type": "string", "description": "Required. Cloud Storage directory to export data to." } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination" }, "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation": { "properties": { "polyline": { "$ref": "GoogleCloudDatalabelingV1beta1Polyline" }, "normalizedPolyline": { "$ref": "GoogleCloudDatalabelingV1beta1NormalizedPolyline" }, "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of this polyline." } }, "description": "A polyline for the image annotation.", "id": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", "type": "object" }, "GoogleLongrunningOperation": { "properties": { "response": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "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": { "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}`.", "type": "string" }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "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." } }, "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation" }, "GoogleCloudDatalabelingV1beta1AnnotatedDataset": { "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": { "description": "Output only. The names of any related resources that are blocking changes to the annotated dataset.", "type": "array", "items": { "type": "string" } }, "completedExampleCount": { "type": "string", "description": "Output only. Number of examples that have annotation in the annotated dataset.", "format": "int64" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time the AnnotatedDataset was created." }, "displayName": { "description": "Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.", "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" }, "metadata": { "description": "Output only. Additional information about AnnotatedDataset.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata" }, "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." ], "description": "Output only. Type of the annotation. It is specified when starting labeling task.", "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" ] }, "labelStats": { "description": "Output only. Per label statistics.", "$ref": "GoogleCloudDatalabelingV1beta1LabelStats" }, "name": { "type": "string", "description": "Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}" }, "annotationSource": { "type": "string", "description": "Output only. Source of the annotation.", "enum": [ "ANNOTATION_SOURCE_UNSPECIFIED", "OPERATOR" ], "enumDescriptions": [ "", "Answer is provided by a human contributor." ] }, "exampleCount": { "type": "string", "format": "int64", "description": "Output only. Number of examples in the annotated dataset." } }, "type": "object" }, "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata": { "description": "Details of a LabelVideoObjectDetection operation metadata.", "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1VideoThumbnail": { "type": "object", "description": "Container of information of a video thumbnail.", "id": "GoogleCloudDatalabelingV1beta1VideoThumbnail", "properties": { "timeOffset": { "type": "string", "format": "google-duration", "description": "Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from." }, "thumbnail": { "type": "string", "description": "A byte string of the video frame.", "format": "byte" } } }, "GoogleCloudDatalabelingV1beta1LabelImageRequest": { "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Required. Basic human annotation config." }, "polylineConfig": { "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", "description": "Configuration for polyline task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." }, "segmentationConfig": { "description": "Configuration for segmentation task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required.", "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig" }, "feature": { "type": "string", "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." ], "enum": [ "FEATURE_UNSPECIFIED", "CLASSIFICATION", "BOUNDING_BOX", "ORIENTED_BOUNDING_BOX", "BOUNDING_POLY", "POLYLINE", "SEGMENTATION" ], "description": "Required. The type of image labeling task." }, "imageClassificationConfig": { "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", "description": "Configuration for image classification 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" } }, "description": " Request message for starting an image labeling task.", "id": "GoogleCloudDatalabelingV1beta1LabelImageRequest" }, "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation": { "id": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", "type": "object", "properties": { "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "Label of the text." } }, "description": "Text classification annotation." }, "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata": { "properties": {}, "type": "object", "description": "Metadata describing the feedback from the labeling task requester.", "id": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata" }, "GoogleCloudDatalabelingV1beta1Vertex": { "type": "object", "properties": { "y": { "description": "Y coordinate.", "format": "int32", "type": "integer" }, "x": { "format": "int32", "type": "integer", "description": "X coordinate." } }, "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudDatalabelingV1beta1Vertex" }, "GoogleCloudDatalabelingV1beta1ImagePayload": { "id": "GoogleCloudDatalabelingV1beta1ImagePayload", "description": "Container of information about an image.", "properties": { "signedUri": { "description": "Signed uri of the image file in the service bucket.", "type": "string" }, "mimeType": { "type": "string", "description": "Image format." }, "imageThumbnail": { "type": "string", "description": "A byte string of a thumbnail image.", "format": "byte" }, "imageUri": { "type": "string", "description": "Image uri from the user bucket." } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry": { "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry", "properties": { "annotationSpec": { "description": "The annotation spec of a predicted label.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" }, "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.)", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1SentimentConfig": { "type": "object", "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." } }, "id": "GoogleCloudDatalabelingV1beta1SentimentConfig", "description": "Config for setting up sentiments." }, "GoogleCloudDatalabelingV1alpha1OutputConfig": { "description": "The configuration of output data.", "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": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination" }, "gcsDestination": { "$ref": "GoogleCloudDatalabelingV1alpha1GcsDestination", "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." } }, "id": "GoogleCloudDatalabelingV1alpha1OutputConfig" }, "GoogleCloudDatalabelingV1beta1LabelVideoRequest": { "id": "GoogleCloudDatalabelingV1beta1LabelVideoRequest", "type": "object", "description": " Request message for LabelVideo.", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", "description": "Required. Basic human annotation config." }, "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": { "description": "Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.", "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig" }, "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." ], "type": "string", "description": "Required. The type of video labeling task.", "enum": [ "FEATURE_UNSPECIFIED", "CLASSIFICATION", "OBJECT_DETECTION", "OBJECT_TRACKING", "EVENT" ] }, "objectTrackingConfig": { "description": "Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.", "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig" }, "objectDetectionConfig": { "description": "Configuration for video object detection task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.", "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig" } } }, "GoogleCloudDatalabelingV1beta1AnnotationSpecSet": { "id": "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", "properties": { "displayName": { "type": "string", "description": "Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters." }, "description": { "type": "string", "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long." }, "name": { "description": "Output only. The AnnotationSpecSet resource name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", "type": "string" }, "annotationSpecs": { "type": "array", "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." }, "blockingResources": { "items": { "type": "string" }, "type": "array", "description": "Output only. The names of any related resources that are blocking changes to the annotation spec set." } } }, "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata": { "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "description": "Details of LabelImageBoundingPoly operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1beta1SegmentationConfig": { "type": "object", "properties": { "annotationSpecSet": { "description": "Required. Annotation spec set resource name. format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", "type": "string" }, "instructionMessage": { "type": "string", "description": "Instruction message showed on labelers UI." } }, "description": "Config for image segmentation", "id": "GoogleCloudDatalabelingV1beta1SegmentationConfig" }, "GoogleCloudDatalabelingV1beta1Row": { "properties": { "entries": { "type": "array", "description": "A list of the confusion matrix entries. One entry for each possible predicted label.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry" } }, "annotationSpec": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", "description": "The annotation spec of the ground truth label for this row." } }, "id": "GoogleCloudDatalabelingV1beta1Row", "description": "A row in the confusion matrix. Each entry in this row has the same ground truth label.", "type": "object" }, "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "description": "Details of LabelImageBoundingPoly operation metadata.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata" }, "GoogleCloudDatalabelingV1beta1ConfusionMatrix": { "properties": { "row": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Row" } } }, "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", "type": "object" }, "GoogleCloudDatalabelingV1beta1AnnotationMetadata": { "type": "object", "properties": { "operatorMetadata": { "description": "Metadata related to human labeling.", "$ref": "GoogleCloudDatalabelingV1beta1OperatorMetadata" } }, "description": "Additional information associated with the annotation.", "id": "GoogleCloudDatalabelingV1beta1AnnotationMetadata" }, "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse": { "type": "object", "properties": { "evaluationJobs": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" }, "description": "The list of evaluation jobs to return.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve next page of results.", "type": "string" } }, "id": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse", "description": "Results for listing evaluation jobs." }, "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata": { "description": "Metadata on AnnotatedDataset.", "properties": { "textEntityExtractionConfig": { "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", "description": "Configuration for text entity extraction task." }, "objectDetectionConfig": { "description": "Configuration for video object detection task.", "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig" }, "boundingPolyConfig": { "description": "Configuration for image bounding box and bounding poly task.", "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig" }, "imageClassificationConfig": { "description": "Configuration for image classification task.", "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig" }, "videoClassificationConfig": { "description": "Configuration for video classification task.", "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig" }, "objectTrackingConfig": { "description": "Configuration for video object tracking task.", "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig" }, "humanAnnotationConfig": { "description": "HumanAnnotationConfig used when requesting the human labeling task for this AnnotatedDataset.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" }, "eventConfig": { "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", "description": "Configuration for video event labeling task." }, "segmentationConfig": { "description": "Configuration for image segmentation task.", "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig" }, "textClassificationConfig": { "description": "Configuration for text classification task.", "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig" }, "polylineConfig": { "description": "Configuration for image polyline task.", "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata" }, "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata": { "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config." } }, "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", "type": "object", "description": "Details of a LabelImageSegmentation operation metadata." }, "GoogleCloudDatalabelingV1beta1EventConfig": { "description": "Config for video event human labeling task.", "type": "object", "properties": { "annotationSpecSets": { "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.", "type": "array", "items": { "type": "string" } }, "clipLength": { "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 60s.", "format": "int32" }, "overlapLength": { "format": "int32", "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 1s.", "type": "integer" } }, "id": "GoogleCloudDatalabelingV1beta1EventConfig" }, "GoogleCloudDatalabelingV1beta1ImportDataRequest": { "id": "GoogleCloudDatalabelingV1beta1ImportDataRequest", "type": "object", "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" } }, "description": "Request message for ImportData API." }, "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata", "properties": { "dataset": { "description": "The name of the dataset for which the analysis report is generated. Format: \"projects/*/datasets/*\"", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Timestamp when generate report request was created.", "type": "string" } }, "type": "object", "description": "Metadata of an GenerateAnalysisReport operation." }, "GoogleCloudDatalabelingV1beta1PdfInstruction": { "type": "object", "properties": { "gcsFileUri": { "type": "string", "description": "PDF file for the instruction. Only gcs path is allowed." } }, "id": "GoogleCloudDatalabelingV1beta1PdfInstruction", "description": "Instruction from a PDF file." }, "GoogleCloudDatalabelingV1beta1BoundingPoly": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1BoundingPoly", "description": "A bounding polygon in the image.", "properties": { "vertices": { "description": "The bounding polygon vertices.", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Vertex" }, "type": "array" } } }, "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.", "id": "GoogleCloudDatalabelingV1beta1EvaluationJob", "type": "object", "properties": { "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" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp of when this evaluation job was created." }, "schedule": { "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.", "type": "string" }, "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" }, "description": { "type": "string", "description": "Required. Description of the job. The description can be up to 25,000 characters long." }, "evaluationJobConfig": { "description": "Required. Configuration details for the evaluation job.", "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig" }, "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`." }, "state": { "description": "Output only. Describes the current state of the job.", "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "SCHEDULED", "RUNNING", "PAUSED", "STOPPED" ] }, "attempts": { "items": { "$ref": "GoogleCloudDatalabelingV1beta1Attempt" }, "description": "Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.", "type": "array" } } }, "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig": { "type": "object", "properties": { "annotationSpecSet": { "description": "Required. Annotation spec set resource name.", "type": "string" }, "extractionFrameRate": { "description": "Required. Number of frames per second to be extracted from the video.", "type": "number", "format": "double" } }, "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" }, "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata", "description": "Metadata of a CreateInstruction operation.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Timestamp when create instruction request was created." }, "instruction": { "type": "string", "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}" }, "partialFailures": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", "type": "array" } } }, "GoogleCloudDatalabelingV1beta1DataItem": { "id": "GoogleCloudDatalabelingV1beta1DataItem", "type": "object", "properties": { "name": { "description": "Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", "type": "string" }, "textPayload": { "description": "The text payload, a container of text content.", "$ref": "GoogleCloudDatalabelingV1beta1TextPayload" }, "videoPayload": { "description": "The video payload, a container of the video uri.", "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload" }, "imagePayload": { "description": "The image payload, a container of the image bytes/uri.", "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload" } }, "description": "DataItem is a piece of data, without annotation. For example, an image." }, "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse", "type": "object", "properties": { "importCount": { "format": "int32", "type": "integer", "description": "Output only. Number of examples imported successfully." }, "dataset": { "description": "Ouptut only. The name of imported dataset.", "type": "string" }, "totalCount": { "type": "integer", "format": "int32", "description": "Output only. Total number of examples requested to import" } }, "description": "Response used for ImportData longrunning operation." }, "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." }, "annotatedDatasets": { "description": "The list of annotated datasets to return.", "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" } } }, "id": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse", "type": "object", "description": "Results of listing annotated datasets for a dataset." }, "GoogleCloudDatalabelingV1beta1BoundingPolyConfig": { "properties": { "annotationSpecSet": { "description": "Required. Annotation spec set resource name.", "type": "string" }, "instructionMessage": { "type": "string", "description": "Optional. Instruction message showed on contributors UI." } }, "id": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", "description": "Config for image bounding poly (and bounding box) human labeling task.", "type": "object" }, "GoogleCloudDatalabelingV1beta1GcsFolderDestination": { "type": "object", "properties": { "outputFolderUri": { "type": "string", "description": "Required. Cloud Storage directory to export data to." } }, "id": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", "description": "Export folder destination of the data." }, "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata": { "id": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "description": "Details of a LabelVideoEvent operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse", "properties": { "totalCount": { "format": "int32", "type": "integer", "description": "Output only. Total number of examples requested to import" }, "importCount": { "type": "integer", "description": "Output only. Number of examples imported successfully.", "format": "int32" }, "dataset": { "description": "Ouptut only. The name of imported dataset.", "type": "string" } }, "type": "object", "description": "Response used for ImportData longrunning operation." }, "GoogleCloudDatalabelingV1beta1TextPayload": { "properties": { "textContent": { "type": "string", "description": "Text content." } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1TextPayload", "description": "Container of information about a piece of text." }, "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config.", "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig" } }, "id": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", "description": "Details of a LabelImageSegmentation operation metadata.", "type": "object" }, "GoogleCloudDatalabelingV1p2alpha1GcsDestination": { "description": "Export destination of the data.Only gcs path is allowed in output_uri.", "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": "GoogleCloudDatalabelingV1p2alpha1GcsDestination", "type": "object" }, "GoogleCloudDatalabelingV1beta1GcsSource": { "id": "GoogleCloudDatalabelingV1beta1GcsSource", "type": "object", "description": "Source of the Cloud Storage file to be imported.", "properties": { "inputUri": { "description": "Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).", "type": "string" }, "mimeType": { "description": "Required. The format of the source file. Only \"text/csv\" is supported.", "type": "string" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelStats": { "id": "GoogleCloudDatalabelingV1p1alpha1LabelStats", "type": "object", "properties": { "exampleCount": { "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" }, "type": "object" } }, "description": "Statistics about annotation specs." }, "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse": { "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse", "description": "Response used for ExportDataset longrunning operation.", "type": "object", "properties": { "labelStats": { "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelStats", "description": "Output only. Statistic infos of labels in the exported dataset." }, "exportCount": { "type": "integer", "format": "int32", "description": "Output only. Number of examples exported successfully." }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "dataset": { "type": "string", "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"" }, "outputConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", "description": "Output only. output_config in the ExportData request." }, "totalCount": { "type": "integer", "format": "int32", "description": "Output only. Total number of examples requested to export" } } }, "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata": { "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata", "description": "Metadata of an ExportData operation.", "properties": { "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "createTime": { "type": "string", "description": "Output only. Timestamp when export dataset request was created.", "format": "google-datetime" }, "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": { "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", "type": "string" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation": { "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", "properties": { "annotationSpec": { "description": "Label of the text entities.", "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" }, "sequentialSegment": { "description": "Position of the entity.", "$ref": "GoogleCloudDatalabelingV1beta1SequentialSegment" } }, "type": "object", "description": "Text entity extraction annotation." }, "GoogleCloudDatalabelingV1beta1CreateInstructionRequest": { "id": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest", "description": "Request message for CreateInstruction.", "properties": { "instruction": { "description": "Required. Instruction of how to perform the labeling task.", "$ref": "GoogleCloudDatalabelingV1beta1Instruction" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry": { "properties": { "precisionAt1": { "type": "number", "description": "Precision value for entries with label that has highest score.", "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" }, "recallAt5": { "description": "Recall value for entries with label that has highest 5 scores.", "type": "number", "format": "float" }, "f1ScoreAt5": { "format": "float", "type": "number", "description": "The harmonic mean of recall_at5 and precision_at5." }, "f1Score": { "format": "float", "type": "number", "description": "Harmonic mean of recall and precision." }, "f1ScoreAt1": { "description": "The harmonic mean of recall_at1 and precision_at1.", "format": "float", "type": "number" }, "precisionAt5": { "format": "float", "description": "Precision value for entries with label that has highest 5 scores.", "type": "number" }, "recallAt1": { "format": "float", "type": "number", "description": "Recall value for entries with label that has highest score." }, "precision": { "format": "float", "type": "number", "description": "Precision value." }, "recall": { "description": "Recall value.", "type": "number", "format": "float" } }, "id": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry", "type": "object" }, "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse": { "properties": { "evaluations": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" }, "description": "The list of evaluations matching the search." }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results." } }, "type": "object", "id": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse", "description": "Results of searching evaluations." }, "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata": { "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "type": "object", "description": "Details of a LabelVideoObjectTracking operation metadata.", "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata" }, "GoogleCloudDatalabelingV1beta1EvaluationMetrics": { "properties": { "objectDetectionMetrics": { "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics" }, "classificationMetrics": { "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetrics" } }, "id": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", "type": "object" }, "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { "id": "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata", "type": "object", "description": "Metadata of a CreateInstruction operation.", "properties": { "createTime": { "description": "Timestamp when create instruction request was created.", "format": "google-datetime", "type": "string" }, "instruction": { "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", "type": "string" }, "partialFailures": { "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" }, "type": "array" } } }, "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata": { "description": "Details of LabelImagePolyline operation metadata.", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata" }, "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata": { "id": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", "type": "object", "properties": { "thumbnail": { "type": "string", "description": "An image thumbnail of this thread.", "format": "byte" }, "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;" ] }, "createTime": { "format": "google-datetime", "type": "string", "description": "When the thread is created" }, "lastUpdateTime": { "format": "google-datetime", "description": "When the thread is last updated.", "type": "string" } } }, "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": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "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" }, "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": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } } } }, "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse": { "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse", "properties": { "importCount": { "description": "Output only. Number of examples imported successfully.", "format": "int32", "type": "integer" }, "totalCount": { "type": "integer", "description": "Output only. Total number of examples requested to import", "format": "int32" }, "dataset": { "type": "string", "description": "Ouptut only. The name of imported dataset." } }, "description": "Response used for ImportData longrunning operation." }, "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata": { "description": "Details of a LabelVideoEvent operation metadata.", "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", "type": "object", "properties": { "basicConfig": { "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", "description": "Basic human annotation config used in labeling request." } } }, "GoogleCloudDatalabelingV1beta1Attempt": { "id": "GoogleCloudDatalabelingV1beta1Attempt", "description": "Records a failed evaluation job run.", "properties": { "attemptTime": { "type": "string", "format": "google-datetime" }, "partialFailures": { "description": "Details of errors that occurred.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "description": "Details of a LabelImageBoundingBox operation metadata." }, "GoogleCloudDatalabelingV1beta1PolylineConfig": { "description": "Config for image polyline human labeling task.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1PolylineConfig", "properties": { "annotationSpecSet": { "description": "Required. Annotation spec set resource name.", "type": "string" }, "instructionMessage": { "type": "string", "description": "Optional. Instruction message showed on contributors UI." } } }, "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata": { "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when labeling request was created." }, "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.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "imageBoundingBoxDetails": { "description": "Details of label image bounding box operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata" }, "textEntityExtractionDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", "description": "Details of label text entity extraction operation." }, "dataset": { "type": "string", "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"" }, "videoObjectTrackingDetails": { "description": "Details of label video object tracking operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata" }, "progressPercent": { "format": "int32", "type": "integer", "description": "Output only. Progress of label operation. Range: [0, 100]." }, "videoClassificationDetails": { "description": "Details of label video classification operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata" }, "imageBoundingPolyDetails": { "description": "Details of label image bounding poly operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata" }, "textClassificationDetails": { "description": "Details of label text classification operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata" }, "annotatedDataset": { "type": "string", "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\"." }, "videoObjectDetectionDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", "description": "Details of label video object detection operation." }, "imageClassificationDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", "description": "Details of label image classification operation." }, "imagePolylineDetails": { "description": "Details of label image polyline operation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata" }, "imageSegmentationDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", "description": "Details of label image segmentation operation." }, "imageOrientedBoundingBoxDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", "description": "Details of label image oriented bounding box operation." }, "videoEventDetails": { "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", "description": "Details of label video event operation." } }, "id": "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata" }, "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse": { "properties": { "outputConfig": { "$ref": "GoogleCloudDatalabelingV1alpha1OutputConfig", "description": "Output only. output_config in the ExportData request." }, "dataset": { "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", "type": "string" }, "totalCount": { "type": "integer", "format": "int32", "description": "Output only. Total number of examples requested to export" }, "labelStats": { "$ref": "GoogleCloudDatalabelingV1alpha1LabelStats", "description": "Output only. Statistic infos of labels in the exported dataset." }, "annotatedDataset": { "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", "type": "string" }, "exportCount": { "format": "int32", "type": "integer", "description": "Output only. Number of examples exported successfully." } }, "description": "Response used for ExportDataset longrunning operation.", "type": "object", "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse" }, "GoogleCloudDatalabelingV1p1alpha1OutputConfig": { "properties": { "gcsDestination": { "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation.", "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsDestination" }, "gcsFolderDestination": { "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs.", "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination" } }, "description": "The configuration of output data.", "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1OutputConfig" }, "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata": { "description": "Details of a LabelTextEntityExtraction operation metadata.", "id": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", "properties": { "basicConfig": { "description": "Basic human annotation config used in labeling request.", "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig" } }, "type": "object" }, "GoogleCloudDatalabelingV1beta1TextMetadata": { "type": "object", "id": "GoogleCloudDatalabelingV1beta1TextMetadata", "properties": { "languageCode": { "type": "string", "description": "The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US." } }, "description": "Metadata for the text." }, "GoogleCloudDatalabelingV1beta1VideoClassificationConfig": { "properties": { "applyShotDetection": { "description": "Optional. Option to apply shot detection on the video.", "type": "boolean" }, "annotationSpecSetConfigs": { "type": "array", "items": { "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig" }, "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." } }, "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.", "type": "object", "id": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig" }, "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata": { "description": "Metadata of a CreateInstruction operation.", "properties": { "partialFailures": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details." }, "instruction": { "type": "string", "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}" }, "createTime": { "description": "Timestamp when create instruction request was created.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata" }, "GoogleProtobufEmpty": { "properties": {}, "id": "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); }", "type": "object" } }, "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." } } } }, "version": "v1beta1", "version_module": true, "fullyEncodeReservedExpansion": true, "rootUrl": "https://datalabeling.googleapis.com/", "ownerDomain": "google.com", "canonicalName": "Data Labeling", "description": "Public API for Google Cloud AI Data Labeling Service.", "servicePath": "", "revision": "20260210" }