Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

DataLabeling

import { DataLabeling } from "https://googleapis.deno.dev/v1/datalabeling:v1beta1.ts";

Public API for Google Cloud AI Data Labeling Service.

class DataLabeling {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsAnnotationSpecSetsCreate(parent: string, req: GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest): Promise<GoogleCloudDatalabelingV1beta1AnnotationSpecSet>;
async projectsAnnotationSpecSetsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsAnnotationSpecSetsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1AnnotationSpecSet>;
async projectsAnnotationSpecSetsList(parent: string, opts?: ProjectsAnnotationSpecSetsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse>;
async projectsDatasetsAnnotatedDatasetsDataItemsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1DataItem>;
async projectsDatasetsAnnotatedDatasetsDataItemsList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsDataItemsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListDataItemsResponse>;
async projectsDatasetsAnnotatedDatasetsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsDatasetsAnnotatedDatasetsExamplesGet(name: string, opts?: ProjectsDatasetsAnnotatedDatasetsExamplesGetOptions): Promise<GoogleCloudDatalabelingV1beta1Example>;
async projectsDatasetsAnnotatedDatasetsExamplesList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsExamplesListOptions): Promise<GoogleCloudDatalabelingV1beta1ListExamplesResponse>;
async projectsDatasetsAnnotatedDatasetsFeedbackThreadsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesCreate(parent: string, req: GoogleCloudDatalabelingV1beta1FeedbackMessage): Promise<GoogleLongrunningOperation>;
async projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesGet(name: string): Promise<GoogleCloudDatalabelingV1beta1FeedbackMessage>;
async projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesListOptions): Promise<GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse>;
async projectsDatasetsAnnotatedDatasetsFeedbackThreadsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1FeedbackThread>;
async projectsDatasetsAnnotatedDatasetsFeedbackThreadsList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsFeedbackThreadsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse>;
async projectsDatasetsAnnotatedDatasetsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1AnnotatedDataset>;
async projectsDatasetsAnnotatedDatasetsList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse>;
async projectsDatasetsCreate(parent: string, req: GoogleCloudDatalabelingV1beta1CreateDatasetRequest): Promise<GoogleCloudDatalabelingV1beta1Dataset>;
async projectsDatasetsDataItemsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1DataItem>;
async projectsDatasetsDataItemsList(parent: string, opts?: ProjectsDatasetsDataItemsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListDataItemsResponse>;
async projectsDatasetsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsDatasetsEvaluationsExampleComparisonsSearch(parent: string, req: GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest): Promise<GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse>;
async projectsDatasetsEvaluationsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1Evaluation>;
async projectsDatasetsExportData(name: string, req: GoogleCloudDatalabelingV1beta1ExportDataRequest): Promise<GoogleLongrunningOperation>;
async projectsDatasetsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1Dataset>;
async projectsDatasetsImageLabel(parent: string, req: GoogleCloudDatalabelingV1beta1LabelImageRequest): Promise<GoogleLongrunningOperation>;
async projectsDatasetsImportData(name: string, req: GoogleCloudDatalabelingV1beta1ImportDataRequest): Promise<GoogleLongrunningOperation>;
async projectsDatasetsList(parent: string, opts?: ProjectsDatasetsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListDatasetsResponse>;
async projectsDatasetsTextLabel(parent: string, req: GoogleCloudDatalabelingV1beta1LabelTextRequest): Promise<GoogleLongrunningOperation>;
async projectsDatasetsVideoLabel(parent: string, req: GoogleCloudDatalabelingV1beta1LabelVideoRequest): Promise<GoogleLongrunningOperation>;
async projectsEvaluationJobsCreate(parent: string, req: GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest): Promise<GoogleCloudDatalabelingV1beta1EvaluationJob>;
async projectsEvaluationJobsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsEvaluationJobsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1EvaluationJob>;
async projectsEvaluationJobsList(parent: string, opts?: ProjectsEvaluationJobsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse>;
async projectsEvaluationJobsPause(name: string, req: GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest): Promise<GoogleProtobufEmpty>;
async projectsEvaluationJobsResume(name: string, req: GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest): Promise<GoogleProtobufEmpty>;
async projectsEvaluationsSearch(parent: string, opts?: ProjectsEvaluationsSearchOptions): Promise<GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse>;
async projectsInstructionsCreate(parent: string, req: GoogleCloudDatalabelingV1beta1CreateInstructionRequest): Promise<GoogleLongrunningOperation>;
async projectsInstructionsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsInstructionsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1Instruction>;
async projectsInstructionsList(parent: string, opts?: ProjectsInstructionsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListInstructionsResponse>;
async projectsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsOperationsList(name: string, opts?: ProjectsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
}

§Constructors

§
new DataLabeling(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§

Creates an annotation spec set by providing a set of labels.

@param parent

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

§
projectsAnnotationSpecSetsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes an annotation spec set by resource name.

@param name

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

§
projectsAnnotationSpecSetsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1AnnotationSpecSet>
[src]

Gets an annotation spec set by resource name.

@param name

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

§

Lists annotation spec sets for a project. Pagination is supported.

@param parent

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}

§
projectsDatasetsAnnotatedDatasetsDataItemsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1DataItem>
[src]

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

@param name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

§
projectsDatasetsAnnotatedDatasetsDataItemsList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsDataItemsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListDataItemsResponse>
[src]

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

@param parent

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

§
projectsDatasetsAnnotatedDatasetsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes an annotated dataset by resource name.

@param name

Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

§
projectsDatasetsAnnotatedDatasetsExamplesGet(name: string, opts?: ProjectsDatasetsAnnotatedDatasetsExamplesGetOptions): Promise<GoogleCloudDatalabelingV1beta1Example>
[src]

Gets an example by resource name, including both data and annotation.

@param name

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

§
projectsDatasetsAnnotatedDatasetsExamplesList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsExamplesListOptions): Promise<GoogleCloudDatalabelingV1beta1ListExamplesResponse>
[src]

Lists examples in an annotated dataset. Pagination is supported.

@param parent

Required. Example resource parent.

§
projectsDatasetsAnnotatedDatasetsFeedbackThreadsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Delete a FeedbackThread.

@param name

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}'.

§
projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesCreate(parent: string, req: GoogleCloudDatalabelingV1beta1FeedbackMessage): Promise<GoogleLongrunningOperation>
[src]

Create a FeedbackMessage object.

@param parent

Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.

§
projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Delete a FeedbackMessage.

@param name

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}'.

§
projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesGet(name: string): Promise<GoogleCloudDatalabelingV1beta1FeedbackMessage>
[src]

Get a FeedbackMessage object.

@param name

Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.

§
projectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsFeedbackThreadsFeedbackMessagesListOptions): Promise<GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse>
[src]

List FeedbackMessages with pagination.

@param parent

Required. FeedbackMessage resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}"

§
projectsDatasetsAnnotatedDatasetsFeedbackThreadsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1FeedbackThread>
[src]

Get a FeedbackThread object.

@param name

Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.

§
projectsDatasetsAnnotatedDatasetsFeedbackThreadsList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsFeedbackThreadsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse>
[src]

List FeedbackThreads with pagination.

@param parent

Required. FeedbackThread resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}"

§
projectsDatasetsAnnotatedDatasetsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1AnnotatedDataset>
[src]

Gets an annotated dataset by resource name.

@param name

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

§
projectsDatasetsAnnotatedDatasetsList(parent: string, opts?: ProjectsDatasetsAnnotatedDatasetsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse>
[src]

Lists annotated datasets for a dataset. Pagination is supported.

@param parent

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}

§

Creates dataset. If success return a Dataset resource.

@param parent

Required. Dataset resource parent, format: projects/{project_id}

§
projectsDatasetsDataItemsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1DataItem>
[src]

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

@param name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

§
projectsDatasetsDataItemsList(parent: string, opts?: ProjectsDatasetsDataItemsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListDataItemsResponse>
[src]

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

@param parent

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

§
projectsDatasetsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a dataset by resource name.

@param 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.

@param parent

Required. Name of the Evaluation resource to search for example comparisons from. Format: "projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}"

§
projectsDatasetsEvaluationsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1Evaluation>
[src]

Gets an evaluation by resource name (to search, use projects.evaluations.search).

@param name

Required. Name of the evaluation. Format: "projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'

§
projectsDatasetsExportData(name: string, req: GoogleCloudDatalabelingV1beta1ExportDataRequest): Promise<GoogleLongrunningOperation>
[src]

Exports data and annotations from dataset.

@param name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

§
projectsDatasetsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1Dataset>
[src]

Gets dataset by resource name.

@param name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

§
projectsDatasetsImageLabel(parent: string, req: GoogleCloudDatalabelingV1beta1LabelImageRequest): Promise<GoogleLongrunningOperation>
[src]

Starts a labeling task for image. The type of image labeling task is configured by feature in the request.

@param parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

§
projectsDatasetsImportData(name: string, req: GoogleCloudDatalabelingV1beta1ImportDataRequest): Promise<GoogleLongrunningOperation>
[src]

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.

@param name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

§
projectsDatasetsList(parent: string, opts?: ProjectsDatasetsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListDatasetsResponse>
[src]

Lists datasets under a project. Pagination is supported.

@param parent

Required. Dataset resource parent, format: projects/{project_id}

§
projectsDatasetsTextLabel(parent: string, req: GoogleCloudDatalabelingV1beta1LabelTextRequest): Promise<GoogleLongrunningOperation>
[src]

Starts a labeling task for text. The type of text labeling task is configured by feature in the request.

@param parent

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

§
projectsDatasetsVideoLabel(parent: string, req: GoogleCloudDatalabelingV1beta1LabelVideoRequest): Promise<GoogleLongrunningOperation>
[src]

Starts a labeling task for video. The type of video labeling task is configured by feature in the request.

@param parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

§

Creates an evaluation job.

@param parent

Required. Evaluation job resource parent. Format: "projects/{project_id}"

§
projectsEvaluationJobsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Stops and deletes an evaluation job.

@param name

Required. Name of the evaluation job that is going to be deleted. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

§
projectsEvaluationJobsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1EvaluationJob>
[src]

Gets an evaluation job by resource name.

@param 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.

@param parent

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.

@param name

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}"

§
projectsEvaluationJobsPause(name: string, req: GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest): Promise<GoogleProtobufEmpty>
[src]

Pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op.

@param name

Required. Name of the evaluation job that is going to be paused. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

§
projectsEvaluationJobsResume(name: string, req: GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest): Promise<GoogleProtobufEmpty>
[src]

Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.

@param name

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.

@param parent

Required. Evaluation search parent (project ID). Format: "projects/ {project_id}"

§
projectsInstructionsCreate(parent: string, req: GoogleCloudDatalabelingV1beta1CreateInstructionRequest): Promise<GoogleLongrunningOperation>
[src]

Creates an instruction for how data should be labeled.

@param parent

Required. Instruction resource parent, format: projects/{project_id}

§
projectsInstructionsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes an instruction object by resource name.

@param name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

§
projectsInstructionsGet(name: string): Promise<GoogleCloudDatalabelingV1beta1Instruction>
[src]

Gets an instruction by resource name.

@param name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

§
projectsInstructionsList(parent: string, opts?: ProjectsInstructionsListOptions): Promise<GoogleCloudDatalabelingV1beta1ListInstructionsResponse>
[src]

Lists instructions for a project. Pagination is supported.

@param parent

Required. Instruction resource parent, format: projects/{project_id}

§
projectsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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.

@param name

The name of the operation resource to be cancelled.

§
projectsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

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.

@param name

The name of the operation resource to be deleted.

§
projectsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

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.

@param name

The name of the operation resource.

§
projectsOperationsList(name: string, opts?: ProjectsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.