DataLabeling
import { DataLabeling } from "https://googleapis.deno.dev/v1/datalabeling:v1beta1.ts";
Public API for Google Cloud AI Data Labeling Service.
§Methods
Creates an annotation spec set by providing a set of labels.
Required. AnnotationSpecSet resource parent, format: projects/{project_id}
Deletes an annotation spec set by resource name.
Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
.
Gets an annotation spec set by resource name.
Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
Lists annotation spec sets for a project. Pagination is supported.
Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.
Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
Deletes an annotated dataset by resource name.
Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Gets an example by resource name, including both data and annotation.
Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
Lists examples in an annotated dataset. Pagination is supported.
Required. Example resource parent.
Delete a FeedbackThread.
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}'.
Create a FeedbackMessage object.
Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.
Delete a FeedbackMessage.
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}'.
Get a FeedbackMessage object.
Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.
List FeedbackMessages with pagination.
Required. FeedbackMessage resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}"
Get a FeedbackThread object.
Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.
List FeedbackThreads with pagination.
Required. FeedbackThread resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}"
Gets an annotated dataset by resource name.
Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Lists annotated datasets for a dataset. Pagination is supported.
Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}
Creates dataset. If success return a Dataset resource.
Required. Dataset resource parent, format: projects/{project_id}
Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.
Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
Deletes a dataset by resource name.
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
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.
Required. Name of the Evaluation resource to search for example comparisons from. Format: "projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}"
Gets an evaluation by resource name (to search, use projects.evaluations.search).
Required. Name of the evaluation. Format: "projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'
Exports data and annotations from dataset.
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Gets dataset by resource name.
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Starts a labeling task for image. The type of image labeling task is configured by feature in the request.
Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
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.
Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Lists datasets under a project. Pagination is supported.
Required. Dataset resource parent, format: projects/{project_id}
Starts a labeling task for text. The type of text labeling task is configured by feature in the request.
Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Starts a labeling task for video. The type of video labeling task is configured by feature in the request.
Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
Creates an evaluation job.
Required. Evaluation job resource parent. Format: "projects/{project_id}"
Stops and deletes an evaluation job.
Required. Name of the evaluation job that is going to be deleted. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
Gets an evaluation job by resource name.
Required. Name of the evaluation job. Format: "projects/{project_id} /evaluationJobs/{evaluation_job_id}"
Lists all evaluation jobs within a project with possible filters. Pagination is supported.
Required. Evaluation job resource parent. Format: "projects/{project_id}"
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.
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}"
Pauses an evaluation job. Pausing an evaluation job that is already in a
PAUSED
state is a no-op.
Required. Name of the evaluation job that is going to be paused. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.
Required. Name of the evaluation job that is going to be resumed. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
Searches evaluations within a project.
Required. Evaluation search parent (project ID). Format: "projects/ {project_id}"
Creates an instruction for how data should be labeled.
Required. Instruction resource parent, format: projects/{project_id}
Deletes an instruction object by resource name.
Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Gets an instruction by resource name.
Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Lists instructions for a project. Pagination is supported.
Required. Instruction resource parent, format: projects/{project_id}
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
.
The name of the operation resource to be cancelled.
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
.
The name of the operation resource to be deleted.
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.
The name of the operation resource.
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
The name of the operation's parent resource.