Class DataLabelingServiceGrpc.DataLabelingServiceBlockingStub (0.161.0)

public static final class DataLabelingServiceGrpc.DataLabelingServiceBlockingStub extends AbstractBlockingStub<DataLabelingServiceGrpc.DataLabelingServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service DataLabelingService.

Service for the AI Platform Data Labeling API.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DataLabelingServiceGrpc.DataLabelingServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected DataLabelingServiceGrpc.DataLabelingServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DataLabelingServiceGrpc.DataLabelingServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

public AnnotationSpecSet createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

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

Parameter
NameDescription
requestCreateAnnotationSpecSetRequest
Returns
TypeDescription
AnnotationSpecSet

createDataset(CreateDatasetRequest request)

public Dataset createDataset(CreateDatasetRequest request)

Creates dataset. If success return a Dataset resource.

Parameter
NameDescription
requestCreateDatasetRequest
Returns
TypeDescription
Dataset

createEvaluationJob(CreateEvaluationJobRequest request)

public EvaluationJob createEvaluationJob(CreateEvaluationJobRequest request)

Creates an evaluation job.

Parameter
NameDescription
requestCreateEvaluationJobRequest
Returns
TypeDescription
EvaluationJob

createInstruction(CreateInstructionRequest request)

public Operation createInstruction(CreateInstructionRequest request)

Creates an instruction for how data should be labeled.

Parameter
NameDescription
requestCreateInstructionRequest
Returns
TypeDescription
Operation

deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

public Empty deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

Deletes an annotated dataset by resource name.

Parameter
NameDescription
requestDeleteAnnotatedDatasetRequest
Returns
TypeDescription
Empty

deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

public Empty deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

Deletes an annotation spec set by resource name.

Parameter
NameDescription
requestDeleteAnnotationSpecSetRequest
Returns
TypeDescription
Empty

deleteDataset(DeleteDatasetRequest request)

public Empty deleteDataset(DeleteDatasetRequest request)

Deletes a dataset by resource name.

Parameter
NameDescription
requestDeleteDatasetRequest
Returns
TypeDescription
Empty

deleteEvaluationJob(DeleteEvaluationJobRequest request)

public Empty deleteEvaluationJob(DeleteEvaluationJobRequest request)

Stops and deletes an evaluation job.

Parameter
NameDescription
requestDeleteEvaluationJobRequest
Returns
TypeDescription
Empty

deleteInstruction(DeleteInstructionRequest request)

public Empty deleteInstruction(DeleteInstructionRequest request)

Deletes an instruction object by resource name.

Parameter
NameDescription
requestDeleteInstructionRequest
Returns
TypeDescription
Empty

exportData(ExportDataRequest request)

public Operation exportData(ExportDataRequest request)

Exports data and annotations from dataset.

Parameter
NameDescription
requestExportDataRequest
Returns
TypeDescription
Operation

getAnnotatedDataset(GetAnnotatedDatasetRequest request)

public AnnotatedDataset getAnnotatedDataset(GetAnnotatedDatasetRequest request)

Gets an annotated dataset by resource name.

Parameter
NameDescription
requestGetAnnotatedDatasetRequest
Returns
TypeDescription
AnnotatedDataset

getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

public AnnotationSpecSet getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

Gets an annotation spec set by resource name.

Parameter
NameDescription
requestGetAnnotationSpecSetRequest
Returns
TypeDescription
AnnotationSpecSet

getDataItem(GetDataItemRequest request)

public DataItem getDataItem(GetDataItemRequest request)

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

Parameter
NameDescription
requestGetDataItemRequest
Returns
TypeDescription
DataItem

getDataset(GetDatasetRequest request)

public Dataset getDataset(GetDatasetRequest request)

Gets dataset by resource name.

Parameter
NameDescription
requestGetDatasetRequest
Returns
TypeDescription
Dataset

getEvaluation(GetEvaluationRequest request)

public Evaluation getEvaluation(GetEvaluationRequest request)

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

Parameter
NameDescription
requestGetEvaluationRequest
Returns
TypeDescription
Evaluation

getEvaluationJob(GetEvaluationJobRequest request)

public EvaluationJob getEvaluationJob(GetEvaluationJobRequest request)

Gets an evaluation job by resource name.

Parameter
NameDescription
requestGetEvaluationJobRequest
Returns
TypeDescription
EvaluationJob

getExample(GetExampleRequest request)

public Example getExample(GetExampleRequest request)

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

Parameter
NameDescription
requestGetExampleRequest
Returns
TypeDescription
Example

getInstruction(GetInstructionRequest request)

public Instruction getInstruction(GetInstructionRequest request)

Gets an instruction by resource name.

Parameter
NameDescription
requestGetInstructionRequest
Returns
TypeDescription
Instruction

importData(ImportDataRequest request)

public Operation importData(ImportDataRequest request)

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.

Parameter
NameDescription
requestImportDataRequest
Returns
TypeDescription
Operation

labelImage(LabelImageRequest request)

public Operation labelImage(LabelImageRequest request)

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

Parameter
NameDescription
requestLabelImageRequest
Returns
TypeDescription
Operation

labelText(LabelTextRequest request)

public Operation labelText(LabelTextRequest request)

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

Parameter
NameDescription
requestLabelTextRequest
Returns
TypeDescription
Operation

labelVideo(LabelVideoRequest request)

public Operation labelVideo(LabelVideoRequest request)

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

Parameter
NameDescription
requestLabelVideoRequest
Returns
TypeDescription
Operation

listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

public ListAnnotatedDatasetsResponse listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

Lists annotated datasets for a dataset. Pagination is supported.

Parameter
NameDescription
requestListAnnotatedDatasetsRequest
Returns
TypeDescription
ListAnnotatedDatasetsResponse

listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

public ListAnnotationSpecSetsResponse listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

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

Parameter
NameDescription
requestListAnnotationSpecSetsRequest
Returns
TypeDescription
ListAnnotationSpecSetsResponse

listDataItems(ListDataItemsRequest request)

public ListDataItemsResponse listDataItems(ListDataItemsRequest request)

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

Parameter
NameDescription
requestListDataItemsRequest
Returns
TypeDescription
ListDataItemsResponse

listDatasets(ListDatasetsRequest request)

public ListDatasetsResponse listDatasets(ListDatasetsRequest request)

Lists datasets under a project. Pagination is supported.

Parameter
NameDescription
requestListDatasetsRequest
Returns
TypeDescription
ListDatasetsResponse

listEvaluationJobs(ListEvaluationJobsRequest request)

public ListEvaluationJobsResponse listEvaluationJobs(ListEvaluationJobsRequest request)

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

Parameter
NameDescription
requestListEvaluationJobsRequest
Returns
TypeDescription
ListEvaluationJobsResponse

listExamples(ListExamplesRequest request)

public ListExamplesResponse listExamples(ListExamplesRequest request)

Lists examples in an annotated dataset. Pagination is supported.

Parameter
NameDescription
requestListExamplesRequest
Returns
TypeDescription
ListExamplesResponse

listInstructions(ListInstructionsRequest request)

public ListInstructionsResponse listInstructions(ListInstructionsRequest request)

Lists instructions for a project. Pagination is supported.

Parameter
NameDescription
requestListInstructionsRequest
Returns
TypeDescription
ListInstructionsResponse

pauseEvaluationJob(PauseEvaluationJobRequest request)

public Empty pauseEvaluationJob(PauseEvaluationJobRequest request)

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

Parameter
NameDescription
requestPauseEvaluationJobRequest
Returns
TypeDescription
Empty

resumeEvaluationJob(ResumeEvaluationJobRequest request)

public Empty resumeEvaluationJob(ResumeEvaluationJobRequest request)

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

Parameter
NameDescription
requestResumeEvaluationJobRequest
Returns
TypeDescription
Empty

searchEvaluations(SearchEvaluationsRequest request)

public SearchEvaluationsResponse searchEvaluations(SearchEvaluationsRequest request)

Searches evaluations within a project.

Parameter
NameDescription
requestSearchEvaluationsRequest
Returns
TypeDescription
SearchEvaluationsResponse

searchExampleComparisons(SearchExampleComparisonsRequest request)

public SearchExampleComparisonsResponse searchExampleComparisons(SearchExampleComparisonsRequest request)

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.

Parameter
NameDescription
requestSearchExampleComparisonsRequest
Returns
TypeDescription
SearchExampleComparisonsResponse

updateEvaluationJob(UpdateEvaluationJobRequest request)

public EvaluationJob updateEvaluationJob(UpdateEvaluationJobRequest request)

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.

Parameter
NameDescription
requestUpdateEvaluationJobRequest
Returns
TypeDescription
EvaluationJob