Interface DataLabelingServiceGrpc.AsyncService
-
- All Known Implementing Classes:
DataLabelingServiceGrpc.DataLabelingServiceImplBase
- Enclosing class:
- DataLabelingServiceGrpc
public static interface DataLabelingServiceGrpc.AsyncServiceService for the AI Platform Data Labeling API.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default voidcreateAnnotationSpecSet(CreateAnnotationSpecSetRequest request, io.grpc.stub.StreamObserver<AnnotationSpecSet> responseObserver)Creates an annotation spec set by providing a set of labels.default voidcreateDataset(CreateDatasetRequest request, io.grpc.stub.StreamObserver<Dataset> responseObserver)Creates dataset.default voidcreateEvaluationJob(CreateEvaluationJobRequest request, io.grpc.stub.StreamObserver<EvaluationJob> responseObserver)Creates an evaluation job.default voidcreateInstruction(CreateInstructionRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)Creates an instruction for how data should be labeled.default voiddeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)Deletes an annotated dataset by resource name.default voiddeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)Deletes an annotation spec set by resource name.default voiddeleteDataset(DeleteDatasetRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)Deletes a dataset by resource name.default voiddeleteEvaluationJob(DeleteEvaluationJobRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)Stops and deletes an evaluation job.default voiddeleteInstruction(DeleteInstructionRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)Deletes an instruction object by resource name.default voidexportData(ExportDataRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)Exports data and annotations from dataset.default voidgetAnnotatedDataset(GetAnnotatedDatasetRequest request, io.grpc.stub.StreamObserver<AnnotatedDataset> responseObserver)Gets an annotated dataset by resource name.default voidgetAnnotationSpecSet(GetAnnotationSpecSetRequest request, io.grpc.stub.StreamObserver<AnnotationSpecSet> responseObserver)Gets an annotation spec set by resource name.default voidgetDataItem(GetDataItemRequest request, io.grpc.stub.StreamObserver<DataItem> responseObserver)Gets a data item in a dataset by resource name.default voidgetDataset(GetDatasetRequest request, io.grpc.stub.StreamObserver<Dataset> responseObserver)Gets dataset by resource name.default voidgetEvaluation(GetEvaluationRequest request, io.grpc.stub.StreamObserver<Evaluation> responseObserver)Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).default voidgetEvaluationJob(GetEvaluationJobRequest request, io.grpc.stub.StreamObserver<EvaluationJob> responseObserver)Gets an evaluation job by resource name.default voidgetExample(GetExampleRequest request, io.grpc.stub.StreamObserver<Example> responseObserver)Gets an example by resource name, including both data and annotation.default voidgetInstruction(GetInstructionRequest request, io.grpc.stub.StreamObserver<Instruction> responseObserver)Gets an instruction by resource name.default voidimportData(ImportDataRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)Imports data into dataset based on source locations defined in request.default voidlabelImage(LabelImageRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)Starts a labeling task for image.default voidlabelText(LabelTextRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)Starts a labeling task for text.default voidlabelVideo(LabelVideoRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)Starts a labeling task for video.default voidlistAnnotatedDatasets(ListAnnotatedDatasetsRequest request, io.grpc.stub.StreamObserver<ListAnnotatedDatasetsResponse> responseObserver)Lists annotated datasets for a dataset.default voidlistAnnotationSpecSets(ListAnnotationSpecSetsRequest request, io.grpc.stub.StreamObserver<ListAnnotationSpecSetsResponse> responseObserver)Lists annotation spec sets for a project.default voidlistDataItems(ListDataItemsRequest request, io.grpc.stub.StreamObserver<ListDataItemsResponse> responseObserver)Lists data items in a dataset.default voidlistDatasets(ListDatasetsRequest request, io.grpc.stub.StreamObserver<ListDatasetsResponse> responseObserver)Lists datasets under a project.default voidlistEvaluationJobs(ListEvaluationJobsRequest request, io.grpc.stub.StreamObserver<ListEvaluationJobsResponse> responseObserver)Lists all evaluation jobs within a project with possible filters.default voidlistExamples(ListExamplesRequest request, io.grpc.stub.StreamObserver<ListExamplesResponse> responseObserver)Lists examples in an annotated dataset.default voidlistInstructions(ListInstructionsRequest request, io.grpc.stub.StreamObserver<ListInstructionsResponse> responseObserver)Lists instructions for a project.default voidpauseEvaluationJob(PauseEvaluationJobRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)Pauses an evaluation job.default voidresumeEvaluationJob(ResumeEvaluationJobRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)Resumes a paused evaluation job.default voidsearchEvaluations(SearchEvaluationsRequest request, io.grpc.stub.StreamObserver<SearchEvaluationsResponse> responseObserver)Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.default voidsearchExampleComparisons(SearchExampleComparisonsRequest request, io.grpc.stub.StreamObserver<SearchExampleComparisonsResponse> responseObserver)Searches example comparisons from an evaluation.default voidupdateEvaluationJob(UpdateEvaluationJobRequest request, io.grpc.stub.StreamObserver<EvaluationJob> responseObserver)Updates an evaluation job.
-
-
-
Method Detail
-
createDataset
default void createDataset(CreateDatasetRequest request, io.grpc.stub.StreamObserver<Dataset> responseObserver)
Creates dataset. If success return a Dataset resource.
-
getDataset
default void getDataset(GetDatasetRequest request, io.grpc.stub.StreamObserver<Dataset> responseObserver)
Gets dataset by resource name.
-
listDatasets
default void listDatasets(ListDatasetsRequest request, io.grpc.stub.StreamObserver<ListDatasetsResponse> responseObserver)
Lists datasets under a project. Pagination is supported.
-
deleteDataset
default void deleteDataset(DeleteDatasetRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a dataset by resource name.
-
importData
default void importData(ImportDataRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
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.
-
exportData
default void exportData(ExportDataRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Exports data and annotations from dataset.
-
getDataItem
default void getDataItem(GetDataItemRequest request, io.grpc.stub.StreamObserver<DataItem> responseObserver)
Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
-
listDataItems
default void listDataItems(ListDataItemsRequest request, io.grpc.stub.StreamObserver<ListDataItemsResponse> responseObserver)
Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.
-
getAnnotatedDataset
default void getAnnotatedDataset(GetAnnotatedDatasetRequest request, io.grpc.stub.StreamObserver<AnnotatedDataset> responseObserver)
Gets an annotated dataset by resource name.
-
listAnnotatedDatasets
default void listAnnotatedDatasets(ListAnnotatedDatasetsRequest request, io.grpc.stub.StreamObserver<ListAnnotatedDatasetsResponse> responseObserver)
Lists annotated datasets for a dataset. Pagination is supported.
-
deleteAnnotatedDataset
default void deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes an annotated dataset by resource name.
-
labelImage
default void labelImage(LabelImageRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Starts a labeling task for image. The type of image labeling task is configured by feature in the request.
-
labelVideo
default void labelVideo(LabelVideoRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Starts a labeling task for video. The type of video labeling task is configured by feature in the request.
-
labelText
default void labelText(LabelTextRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Starts a labeling task for text. The type of text labeling task is configured by feature in the request.
-
getExample
default void getExample(GetExampleRequest request, io.grpc.stub.StreamObserver<Example> responseObserver)
Gets an example by resource name, including both data and annotation.
-
listExamples
default void listExamples(ListExamplesRequest request, io.grpc.stub.StreamObserver<ListExamplesResponse> responseObserver)
Lists examples in an annotated dataset. Pagination is supported.
-
createAnnotationSpecSet
default void createAnnotationSpecSet(CreateAnnotationSpecSetRequest request, io.grpc.stub.StreamObserver<AnnotationSpecSet> responseObserver)
Creates an annotation spec set by providing a set of labels.
-
getAnnotationSpecSet
default void getAnnotationSpecSet(GetAnnotationSpecSetRequest request, io.grpc.stub.StreamObserver<AnnotationSpecSet> responseObserver)
Gets an annotation spec set by resource name.
-
listAnnotationSpecSets
default void listAnnotationSpecSets(ListAnnotationSpecSetsRequest request, io.grpc.stub.StreamObserver<ListAnnotationSpecSetsResponse> responseObserver)
Lists annotation spec sets for a project. Pagination is supported.
-
deleteAnnotationSpecSet
default void deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes an annotation spec set by resource name.
-
createInstruction
default void createInstruction(CreateInstructionRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Creates an instruction for how data should be labeled.
-
getInstruction
default void getInstruction(GetInstructionRequest request, io.grpc.stub.StreamObserver<Instruction> responseObserver)
Gets an instruction by resource name.
-
listInstructions
default void listInstructions(ListInstructionsRequest request, io.grpc.stub.StreamObserver<ListInstructionsResponse> responseObserver)
Lists instructions for a project. Pagination is supported.
-
deleteInstruction
default void deleteInstruction(DeleteInstructionRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes an instruction object by resource name.
-
getEvaluation
default void getEvaluation(GetEvaluationRequest request, io.grpc.stub.StreamObserver<Evaluation> responseObserver)
Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).
-
searchEvaluations
default void searchEvaluations(SearchEvaluationsRequest request, io.grpc.stub.StreamObserver<SearchEvaluationsResponse> responseObserver)
Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.
-
searchExampleComparisons
default void searchExampleComparisons(SearchExampleComparisonsRequest request, io.grpc.stub.StreamObserver<SearchExampleComparisonsResponse> responseObserver)
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.
-
createEvaluationJob
default void createEvaluationJob(CreateEvaluationJobRequest request, io.grpc.stub.StreamObserver<EvaluationJob> responseObserver)
Creates an evaluation job.
-
updateEvaluationJob
default void updateEvaluationJob(UpdateEvaluationJobRequest request, io.grpc.stub.StreamObserver<EvaluationJob> responseObserver)
Updates an evaluation job. You can only update certain fields of the job's [EvaluationJobConfig][google.cloud.datalabeling.v1beta1.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.
-
getEvaluationJob
default void getEvaluationJob(GetEvaluationJobRequest request, io.grpc.stub.StreamObserver<EvaluationJob> responseObserver)
Gets an evaluation job by resource name.
-
pauseEvaluationJob
default void pauseEvaluationJob(PauseEvaluationJobRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.
-
resumeEvaluationJob
default void resumeEvaluationJob(ResumeEvaluationJobRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.
-
deleteEvaluationJob
default void deleteEvaluationJob(DeleteEvaluationJobRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Stops and deletes an evaluation job.
-
listEvaluationJobs
default void listEvaluationJobs(ListEvaluationJobsRequest request, io.grpc.stub.StreamObserver<ListEvaluationJobsResponse> responseObserver)
Lists all evaluation jobs within a project with possible filters. Pagination is supported.
-
-