2026-06-23
▼ ▲ datalabeling.projects.annotationSpecSets.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/annotationSpecSets
Parameters :
parent
Pattern : ^projects/[^/]+$
Description : Required. AnnotationSpecSet resource parent, format: projects/{project_id}
Required : Yes
Location : path
Type : string
HTTP Method : POST
Path : v1beta1/{+parent}/annotationSpecSets
Description : Creates an annotation spec set by providing a set of labels.
Parameter Order : parent
▼ ▲ datalabeling.projects.annotationSpecSets.list
Parameters :
filter
Description : Optional. Filter is not supported at this moment.
Location : query
Type : string
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
parent
Pattern : ^projects/[^/]+$
Description : Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
Location : path
Required : Yes
Type : string
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Description : Lists annotation spec sets for a project. Pagination is supported.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/annotationSpecSets
Flat Path : v1beta1/projects/{projectsId}/annotationSpecSets
Parameter Order : parent
HTTP Method : GET
▼ ▲ datalabeling.projects.annotationSpecSets.delete
Flat Path : v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
HTTP Method : DELETE
Description : Deletes an annotation spec set by resource name.
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/annotationSpecSets/[^/]+$
Location : path
Description : Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.
Required : Yes
Type : string
▼ ▲ datalabeling.projects.annotationSpecSets.get
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Description : Gets an annotation spec set by resource 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 : Yes
Flat Path : v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}
HTTP Method : GET
▼ ▲ datalabeling.projects.operations.delete
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Location : path
Required : Yes
Flat Path : v1beta1/projects/{projectsId}/operations/{operationsId}
Parameter Order : name
HTTP Method : DELETE
Path : v1beta1/{+name}
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`.
▼ ▲ datalabeling.projects.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/operations/{operationsId}:cancel
HTTP Method : GET
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Description : The name of the operation resource to be cancelled.
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`.
▼ ▲ datalabeling.projects.operations.get
Parameter Order : name
HTTP Method : GET
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.
Path : v1beta1/{+name}
Parameters :
name
Description : The name of the operation resource.
Type : string
Location : path
Pattern : ^projects/[^/]+/operations/[^/]+$
Required : Yes
Flat Path : v1beta1/projects/{projectsId}/operations/{operationsId}
▼ ▲ datalabeling.projects.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/operations
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
filter
Type : string
Location : query
Description : The standard list filter.
pageSize
Description : The standard list page size.
Location : query
Format : int32
Type : integer
pageToken
Description : The standard list page token.
Location : query
Type : string
name
Location : path
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+$
Required : Yes
Type : string
returnPartialSuccess
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
Location : query
▼ ▲ datalabeling.projects.datasets.list
Parameter Order : parent
Parameters :
pageToken
Location : query
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.
Type : string
parent
Description : Required. Dataset resource parent, format: projects/{project_id}
Required : Yes
Location : path
Pattern : ^projects/[^/]+$
Type : string
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Type : integer
Location : query
filter
Type : string
Location : query
Description : Optional. Filter on dataset is not supported at this moment.
Path : v1beta1/{+parent}/datasets
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists datasets under a project. Pagination is supported.
Flat Path : v1beta1/projects/{projectsId}/datasets
HTTP Method : GET
▼ ▲ datalabeling.projects.datasets.delete
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a dataset by resource name.
HTTP Method : DELETE
Parameters :
name
Pattern : ^projects/[^/]+/datasets/[^/]+$
Description : Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Type : string
Required : Yes
Location : path
▼ ▲ datalabeling.projects.datasets.create
Flat Path : v1beta1/projects/{projectsId}/datasets
Description : Creates dataset. If success return a Dataset resource.
HTTP Method : POST
Path : v1beta1/{+parent}/datasets
Parameter Order : parent
Parameters :
parent
Description : Required. Dataset resource parent, format: projects/{project_id}
Required : Yes
Type : string
Pattern : ^projects/[^/]+$
Location : path
▼ ▲ datalabeling.projects.datasets.exportData
Description : Exports data and annotations from dataset.
Path : v1beta1/{+name}:exportData
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/datasets/[^/]+$
Location : path
Type : string
Description : Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Required : Yes
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}:exportData
▼ ▲ datalabeling.projects.datasets.importData
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Pattern : ^projects/[^/]+/datasets/[^/]+$
Location : path
Type : string
Required : Yes
HTTP Method : POST
Path : v1beta1/{+name}:importData
Parameter Order : name
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.
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}:importData
▼ ▲ datalabeling.projects.datasets.get
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}
Description : Gets dataset by resource name.
HTTP Method : GET
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/datasets/[^/]+$
Location : path
Type : string
Description : Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Required : Yes
Path : v1beta1/{+name}
▼ ▲ datalabeling.projects.datasets.video.label
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts a labeling task for video. The type of video labeling task is configured by feature in the request.
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/video:label
HTTP Method : POST
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+/datasets/[^/]+$
Description : Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Location : path
Required : Yes
Path : v1beta1/{+parent}/video:label
▼ ▲ datalabeling.projects.datasets.text.label
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/text:label
Parameter Order : parent
Path : v1beta1/{+parent}/text:label
HTTP Method : POST
Parameters :
parent
Description : Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Pattern : ^projects/[^/]+/datasets/[^/]+$
Type : string
Required : Yes
Location : path
Description : Starts a labeling task for text. The type of text labeling task is configured by feature in the request.
▼ ▲ datalabeling.projects.datasets.evaluations.exampleComparisons.search
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/exampleComparisons:search
Parameters :
parent
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$
Description : Required. Name of the Evaluation resource to search for example comparisons from. Format: "projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}"
HTTP Method : POST
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}/exampleComparisons:search
Description : Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.
▼ ▲ datalabeling.projects.datasets.evaluations.get
HTTP Method : GET
Description : Gets an evaluation by resource name (to search, use projects.evaluations.search).
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$
Type : string
Description : Required. Name of the evaluation. Format: "projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}
Path : v1beta1/{+name}
Parameter Order : name
▼ ▲ datalabeling.projects.datasets.image.label
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label
Parameters :
parent
Pattern : ^projects/[^/]+/datasets/[^/]+$
Location : path
Description : Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Required : Yes
Type : string
Parameter Order : parent
Path : v1beta1/{+parent}/image:label
Description : Starts a labeling task for image. The type of image labeling task is configured by feature in the request.
▼ ▲ datalabeling.projects.datasets.dataItems.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/datasets/[^/]+/dataItems/[^/]+$
Type : string
Description : Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
Location : path
Required : Yes
Path : v1beta1/{+name}
Description : Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems/{dataItemsId}
▼ ▲ datalabeling.projects.datasets.dataItems.list
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems
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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
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
Location : query
Description : Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.
Type : string
parent
Required : Yes
Description : Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
Pattern : ^projects/[^/]+/datasets/[^/]+$
Location : path
Type : string
filter
Location : query
Description : Optional. Filter is not supported at this moment.
Type : string
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.dataItems.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems/{dataItemsId}
Description : Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
HTTP Method : GET
Parameters :
name
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/dataItems/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
Parameter Order : name
Path : v1beta1/{+name}
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.dataItems.list
Parameter Order : parent
Description : Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems
Parameters :
pageSize
Type : integer
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Format : int32
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.
Location : query
Type : string
parent
Description : Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$
filter
Description : Optional. Filter is not supported at this moment.
Location : query
Type : string
Path : v1beta1/{+parent}/dataItems
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.examples.list
Parameter Order : parent
Description : Lists examples in an annotated dataset. Pagination is supported.
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples
HTTP Method : GET
Parameters :
pageSize
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Format : int32
Type : integer
Location : query
pageToken
Description : Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.
Type : string
Location : query
filter
Location : query
Type : string
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}"
parent
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$
Description : Required. Example resource parent.
Required : Yes
Type : string
Location : path
Path : v1beta1/{+parent}/examples
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.examples.get
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples/{examplesId}
Description : Gets an example by resource name, including both data and annotation.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
HTTP Method : GET
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
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/examples/[^/]+$
Required : Yes
Type : string
Description : Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
Location : path
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.delete
Description : Delete a FeedbackThread.
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}
HTTP Method : DELETE
Parameters :
name
Required : Yes
Type : string
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
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get
Parameter Order : name
Description : Get a FeedbackThread object.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}
Parameters :
name
Type : string
Description : Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$
Location : path
Required : Yes
Path : v1beta1/{+name}
HTTP Method : GET
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list
Path : v1beta1/{+parent}/feedbackThreads
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$
Required : Yes
Description : Required. FeedbackThread resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}"
pageSize
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Type : integer
pageToken
Type : string
Location : query
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.
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads
Description : List FeedbackThreads with pagination.
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list
HTTP Method : GET
Path : v1beta1/{+parent}/feedbackMessages
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List FeedbackMessages with pagination.
Parameter Order : parent
Parameters :
parent
Type : string
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 : Yes
pageSize
Location : query
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 ListFeedbackMessages.next_page_token of the previous [DataLabelingService.ListFeedbackMessages] call. Return first page if empty.
Type : string
Location : query
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.delete
Path : v1beta1/{+name}
HTTP Method : DELETE
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}
Parameters :
name
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$
Required : Yes
Type : string
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.
Parameter Order : name
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Description : Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.
Type : string
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$
Location : path
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages
HTTP Method : POST
Parameter Order : parent
Description : Create a FeedbackMessage object.
Path : v1beta1/{+parent}/feedbackMessages
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.get
Description : Get a FeedbackMessage object.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$
Type : string
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}'.
Location : path
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}
Path : v1beta1/{+name}
HTTP Method : GET
Parameter Order : name
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.delete
Description : Deletes an annotated dataset by resource name.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}
HTTP Method : DELETE
Parameters :
name
Location : path
Description : Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Type : string
Required : Yes
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$
Path : v1beta1/{+name}
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.list
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets
Parameters :
parent
Pattern : ^projects/[^/]+/datasets/[^/]+$
Location : path
Description : Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}
Type : string
Required : Yes
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
filter
Location : query
Type : string
Description : Optional. Filter is not supported at this moment.
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
Description : Lists annotated datasets for a dataset. Pagination is supported.
Path : v1beta1/{+parent}/annotatedDatasets
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ datalabeling.projects.datasets.annotatedDatasets.get
Path : v1beta1/{+name}
Parameters :
name
Required : Yes
Description : Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Type : string
Pattern : ^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}
Parameter Order : name
Description : Gets an annotated dataset by resource name.
▼ ▲ datalabeling.projects.evaluations.search
Description : Searches evaluations within a project.
Path : v1beta1/{+parent}/evaluations:search
Flat Path : v1beta1/projects/{projectsId}/evaluations:search
HTTP Method : GET
Parameter Order : parent
Parameters :
pageSize
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Format : int32
Location : query
Type : integer
pageToken
Type : string
Location : query
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.
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}"
Location : query
Type : string
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+$
Location : path
Description : Required. Evaluation search parent (project ID). Format: "projects/ {project_id}"
▼ ▲ datalabeling.projects.evaluationJobs.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/evaluationJobs
Path : v1beta1/{+parent}/evaluationJobs
Description : Creates an evaluation job.
Parameter Order : parent
Parameters :
parent
Pattern : ^projects/[^/]+$
Required : Yes
Location : path
Description : Required. Evaluation job resource parent. Format: "projects/{project_id}"
Type : string
HTTP Method : POST
▼ ▲ datalabeling.projects.evaluationJobs.resume
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:resume
Parameter Order : name
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.
Path : v1beta1/{+name}:resume
Parameters :
name
Pattern : ^projects/[^/]+/evaluationJobs/[^/]+$
Required : Yes
Description : Required. Name of the evaluation job that is going to be resumed. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
Type : string
Location : path
▼ ▲ datalabeling.projects.evaluationJobs.pause
Path : v1beta1/{+name}:pause
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.
Flat Path : v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:pause
Parameters :
name
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/evaluationJobs/[^/]+$
Description : Required. Name of the evaluation job that is going to be paused. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
▼ ▲ datalabeling.projects.evaluationJobs.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}
HTTP Method : GET
Description : Gets an evaluation job by resource name.
Parameters :
name
Description : Required. Name of the evaluation job. Format: "projects/{project_id} /evaluationJobs/{evaluation_job_id}"
Pattern : ^projects/[^/]+/evaluationJobs/[^/]+$
Location : path
Type : string
Required : Yes
▼ ▲ datalabeling.projects.evaluationJobs.delete
Flat Path : v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}
Parameters :
name
Pattern : ^projects/[^/]+/evaluationJobs/[^/]+$
Description : Required. Name of the evaluation job that is going to be deleted. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
Type : string
Location : path
Required : Yes
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Stops and deletes an evaluation job.
Path : v1beta1/{+name}
▼ ▲ datalabeling.projects.evaluationJobs.patch
Parameters :
name
Required : Yes
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
Pattern : ^projects/[^/]+/evaluationJobs/[^/]+$
Location : path
updateMask
Location : query
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.
Format : google-fieldmask
Type : string
Flat Path : v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
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.
Path : v1beta1/{+name}
HTTP Method : PATCH
▼ ▲ datalabeling.projects.evaluationJobs.list
Flat Path : v1beta1/projects/{projectsId}/evaluationJobs
HTTP Method : GET
Path : v1beta1/{+parent}/evaluationJobs
Description : Lists all evaluation jobs within a project with possible filters. Pagination is supported.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
filter
Location : query
Type : string
Description : Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the `AND` operator or the `OR` operator. For example, you can use the following string for your filter: "evaluation_job.model_id = {model_name} AND evaluation_job.state = {evaluation_job_state}"
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Type : integer
Location : query
parent
Location : path
Required : Yes
Pattern : ^projects/[^/]+$
Description : Required. Evaluation job resource parent. Format: "projects/{project_id}"
Type : string
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
▼ ▲ datalabeling.projects.instructions.list
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/instructions
Path : v1beta1/{+parent}/instructions
Description : Lists instructions for a project. Pagination is supported.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Location : query
Description : Optional. Filter is not supported at this moment.
Type : string
pageSize
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Format : int32
parent
Required : Yes
Description : Required. Instruction resource parent, format: projects/{project_id}
Type : string
Location : path
Pattern : ^projects/[^/]+$
pageToken
Type : string
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.
Location : query
▼ ▲ datalabeling.projects.instructions.create
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1beta1/{+parent}/instructions
Parameters :
parent
Description : Required. Instruction resource parent, format: projects/{project_id}
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+$
Description : Creates an instruction for how data should be labeled.
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/instructions
▼ ▲ datalabeling.projects.instructions.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/instructions/{instructionsId}
Parameters :
name
Description : Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Pattern : ^projects/[^/]+/instructions/[^/]+$
Required : Yes
Location : path
Type : string
HTTP Method : GET
Description : Gets an instruction by resource name.
▼ ▲ datalabeling.projects.instructions.delete
Path : v1beta1/{+name}
Parameter Order : name
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/instructions/[^/]+$
Required : Yes
Location : path
Description : Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an instruction object by resource name.
HTTP Method : DELETE
Flat Path : v1beta1/projects/{projectsId}/instructions/{instructionsId}