Interface DataLabelingServiceGrpc.AsyncService (0.166.0)

Version 0.166.0

• 0.173.0 (latest)
• 0.172.0
• 0.171.0
• 0.169.0
• 0.168.0
• 0.167.0
• 0.166.0
• 0.165.0
• 0.164.0
• 0.163.0
• 0.162.0
• 0.161.0
• 0.160.0
• 0.159.0
• 0.157.0
• 0.156.0
• 0.155.0
• 0.154.0
• 0.153.0
• 0.152.0
• 0.151.0
• 0.150.0
• 0.149.0
• 0.148.0
• 0.147.0
• 0.144.0
• 0.143.0
• 0.142.0
• 0.141.0
• 0.140.0
• 0.139.0
• 0.138.0
• 0.137.0
• 0.136.0
• 0.135.0
• 0.134.0
• 0.133.0
• 0.132.0
• 0.131.0
• 0.129.0
• 0.128.0
• 0.127.0
• 0.126.0
• 0.125.0
• 0.124.0
• 0.123.7
• 0.122.11

public static interface DataLabelingServiceGrpc.AsyncService

Service for the AI Platform Data Labeling API.

Methods

createAnnotationSpecSet(CreateAnnotationSpecSetRequest request, StreamObserver<AnnotationSpecSet> responseObserver)

public default void createAnnotationSpecSet(CreateAnnotationSpecSetRequest request, StreamObserver<AnnotationSpecSet> responseObserver)

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

Parameters
Name	Description
request	CreateAnnotationSpecSetRequest
responseObserver	io.grpc.stub.StreamObserver<AnnotationSpecSet>

createDataset(CreateDatasetRequest request, StreamObserver<Dataset> responseObserver)

public default void createDataset(CreateDatasetRequest request, StreamObserver<Dataset> responseObserver)

Creates dataset. If success return a Dataset resource.

Parameters
Name	Description
request	CreateDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Dataset>

createEvaluationJob(CreateEvaluationJobRequest request, StreamObserver<EvaluationJob> responseObserver)

public default void createEvaluationJob(CreateEvaluationJobRequest request, StreamObserver<EvaluationJob> responseObserver)

Creates an evaluation job.

Parameters
Name	Description
request	CreateEvaluationJobRequest
responseObserver	io.grpc.stub.StreamObserver<EvaluationJob>

createInstruction(CreateInstructionRequest request, StreamObserver<Operation> responseObserver)

public default void createInstruction(CreateInstructionRequest request, StreamObserver<Operation> responseObserver)

Creates an instruction for how data should be labeled.

Parameters
Name	Description
request	CreateInstructionRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, StreamObserver<Empty> responseObserver)

Deletes an annotated dataset by resource name.

Parameters
Name	Description
request	DeleteAnnotatedDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, StreamObserver<Empty> responseObserver)

Deletes an annotation spec set by resource name.

Parameters
Name	Description
request	DeleteAnnotationSpecSetRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

deleteDataset(DeleteDatasetRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDataset(DeleteDatasetRequest request, StreamObserver<Empty> responseObserver)

Deletes a dataset by resource name.

Parameters
Name	Description
request	DeleteDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

deleteEvaluationJob(DeleteEvaluationJobRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEvaluationJob(DeleteEvaluationJobRequest request, StreamObserver<Empty> responseObserver)

Stops and deletes an evaluation job.

Parameters
Name	Description
request	DeleteEvaluationJobRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

deleteInstruction(DeleteInstructionRequest request, StreamObserver<Empty> responseObserver)

public default void deleteInstruction(DeleteInstructionRequest request, StreamObserver<Empty> responseObserver)

Deletes an instruction object by resource name.

Parameters
Name	Description
request	DeleteInstructionRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

exportData(ExportDataRequest request, StreamObserver<Operation> responseObserver)

public default void exportData(ExportDataRequest request, StreamObserver<Operation> responseObserver)

Exports data and annotations from dataset.

Parameters
Name	Description
request	ExportDataRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

getAnnotatedDataset(GetAnnotatedDatasetRequest request, StreamObserver<AnnotatedDataset> responseObserver)

public default void getAnnotatedDataset(GetAnnotatedDatasetRequest request, StreamObserver<AnnotatedDataset> responseObserver)

Gets an annotated dataset by resource name.

Parameters
Name	Description
request	GetAnnotatedDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<AnnotatedDataset>

getAnnotationSpecSet(GetAnnotationSpecSetRequest request, StreamObserver<AnnotationSpecSet> responseObserver)

public default void getAnnotationSpecSet(GetAnnotationSpecSetRequest request, StreamObserver<AnnotationSpecSet> responseObserver)

Gets an annotation spec set by resource name.

Parameters
Name	Description
request	GetAnnotationSpecSetRequest
responseObserver	io.grpc.stub.StreamObserver<AnnotationSpecSet>

getDataItem(GetDataItemRequest request, StreamObserver<DataItem> responseObserver)

public default void getDataItem(GetDataItemRequest request, StreamObserver<DataItem> responseObserver)

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

Parameters
Name	Description
request	GetDataItemRequest
responseObserver	io.grpc.stub.StreamObserver<DataItem>

getDataset(GetDatasetRequest request, StreamObserver<Dataset> responseObserver)

public default void getDataset(GetDatasetRequest request, StreamObserver<Dataset> responseObserver)

Gets dataset by resource name.

Parameters
Name	Description
request	GetDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Dataset>

getEvaluation(GetEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

public default void getEvaluation(GetEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

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

Parameters
Name	Description
request	GetEvaluationRequest
responseObserver	io.grpc.stub.StreamObserver<Evaluation>

getEvaluationJob(GetEvaluationJobRequest request, StreamObserver<EvaluationJob> responseObserver)

public default void getEvaluationJob(GetEvaluationJobRequest request, StreamObserver<EvaluationJob> responseObserver)

Gets an evaluation job by resource name.

Parameters
Name	Description
request	GetEvaluationJobRequest
responseObserver	io.grpc.stub.StreamObserver<EvaluationJob>

getExample(GetExampleRequest request, StreamObserver<Example> responseObserver)

public default void getExample(GetExampleRequest request, StreamObserver<Example> responseObserver)

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

Parameters
Name	Description
request	GetExampleRequest
responseObserver	io.grpc.stub.StreamObserver<Example>

getInstruction(GetInstructionRequest request, StreamObserver<Instruction> responseObserver)

public default void getInstruction(GetInstructionRequest request, StreamObserver<Instruction> responseObserver)

Gets an instruction by resource name.

Parameters
Name	Description
request	GetInstructionRequest
responseObserver	io.grpc.stub.StreamObserver<Instruction>

importData(ImportDataRequest request, StreamObserver<Operation> responseObserver)

public default void importData(ImportDataRequest request, StreamObserver<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.

Parameters
Name	Description
request	ImportDataRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

labelImage(LabelImageRequest request, StreamObserver<Operation> responseObserver)

public default void labelImage(LabelImageRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	LabelImageRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

labelText(LabelTextRequest request, StreamObserver<Operation> responseObserver)

public default void labelText(LabelTextRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	LabelTextRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

labelVideo(LabelVideoRequest request, StreamObserver<Operation> responseObserver)

public default void labelVideo(LabelVideoRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	LabelVideoRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

listAnnotatedDatasets(ListAnnotatedDatasetsRequest request, StreamObserver<ListAnnotatedDatasetsResponse> responseObserver)

public default void listAnnotatedDatasets(ListAnnotatedDatasetsRequest request, StreamObserver<ListAnnotatedDatasetsResponse> responseObserver)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name	Description
request	ListAnnotatedDatasetsRequest
responseObserver	io.grpc.stub.StreamObserver<ListAnnotatedDatasetsResponse>

listAnnotationSpecSets(ListAnnotationSpecSetsRequest request, StreamObserver<ListAnnotationSpecSetsResponse> responseObserver)

public default void listAnnotationSpecSets(ListAnnotationSpecSetsRequest request, StreamObserver<ListAnnotationSpecSetsResponse> responseObserver)

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

Parameters
Name	Description
request	ListAnnotationSpecSetsRequest
responseObserver	io.grpc.stub.StreamObserver<ListAnnotationSpecSetsResponse>

listDataItems(ListDataItemsRequest request, StreamObserver<ListDataItemsResponse> responseObserver)

public default void listDataItems(ListDataItemsRequest request, StreamObserver<ListDataItemsResponse> responseObserver)

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

Parameters
Name	Description
request	ListDataItemsRequest
responseObserver	io.grpc.stub.StreamObserver<ListDataItemsResponse>

listDatasets(ListDatasetsRequest request, StreamObserver<ListDatasetsResponse> responseObserver)

public default void listDatasets(ListDatasetsRequest request, StreamObserver<ListDatasetsResponse> responseObserver)

Lists datasets under a project. Pagination is supported.

Parameters
Name	Description
request	ListDatasetsRequest
responseObserver	io.grpc.stub.StreamObserver<ListDatasetsResponse>

listEvaluationJobs(ListEvaluationJobsRequest request, StreamObserver<ListEvaluationJobsResponse> responseObserver)

public default void listEvaluationJobs(ListEvaluationJobsRequest request, StreamObserver<ListEvaluationJobsResponse> responseObserver)

Lists all evaluation jobs within a project with possible filters. Pagination is supported.

Parameters
Name	Description
request	ListEvaluationJobsRequest
responseObserver	io.grpc.stub.StreamObserver<ListEvaluationJobsResponse>

listExamples(ListExamplesRequest request, StreamObserver<ListExamplesResponse> responseObserver)

public default void listExamples(ListExamplesRequest request, StreamObserver<ListExamplesResponse> responseObserver)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name	Description
request	ListExamplesRequest
responseObserver	io.grpc.stub.StreamObserver<ListExamplesResponse>

listInstructions(ListInstructionsRequest request, StreamObserver<ListInstructionsResponse> responseObserver)

public default void listInstructions(ListInstructionsRequest request, StreamObserver<ListInstructionsResponse> responseObserver)

Lists instructions for a project. Pagination is supported.

Parameters
Name	Description
request	ListInstructionsRequest
responseObserver	io.grpc.stub.StreamObserver<ListInstructionsResponse>

pauseEvaluationJob(PauseEvaluationJobRequest request, StreamObserver<Empty> responseObserver)

public default void pauseEvaluationJob(PauseEvaluationJobRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name	Description
request	PauseEvaluationJobRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

resumeEvaluationJob(ResumeEvaluationJobRequest request, StreamObserver<Empty> responseObserver)

public default void resumeEvaluationJob(ResumeEvaluationJobRequest request, StreamObserver<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.

Parameters
Name	Description
request	ResumeEvaluationJobRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

searchEvaluations(SearchEvaluationsRequest request, StreamObserver<SearchEvaluationsResponse> responseObserver)

public default void searchEvaluations(SearchEvaluationsRequest request, StreamObserver<SearchEvaluationsResponse> responseObserver)

Searches evaluations within a project.

Parameters
Name	Description
request	SearchEvaluationsRequest
responseObserver	io.grpc.stub.StreamObserver<SearchEvaluationsResponse>

searchExampleComparisons(SearchExampleComparisonsRequest request, StreamObserver<SearchExampleComparisonsResponse> responseObserver)

public default void searchExampleComparisons(SearchExampleComparisonsRequest request, 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.

Parameters
Name	Description
request	SearchExampleComparisonsRequest
responseObserver	io.grpc.stub.StreamObserver<SearchExampleComparisonsResponse>

updateEvaluationJob(UpdateEvaluationJobRequest request, StreamObserver<EvaluationJob> responseObserver)

public default void updateEvaluationJob(UpdateEvaluationJobRequest request, StreamObserver<EvaluationJob> responseObserver)

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.

Parameters
Name	Description
request	UpdateEvaluationJobRequest
responseObserver	io.grpc.stub.StreamObserver<EvaluationJob>