Package com.google.cloud.datalabeling.v1beta1 (0.143.0)

A client to Data Labeling API

The interfaces provided are listed below, along with usage samples.

DataLabelingServiceClient

Service Description: Service for the AI Platform Data Labeling API.

Sample for DataLabelingServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = dataLabelingServiceClient.createDataset(parent, dataset);
 }

Classes

AnnotatedDataset

AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotatedDataset

AnnotatedDataset.Builder

AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotatedDataset

AnnotatedDatasetMetadata

Metadata on AnnotatedDataset.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata

AnnotatedDatasetMetadata.Builder

Metadata on AnnotatedDataset.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata

AnnotatedDatasetName.Builder

Builder for projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.

Protobuf type google.cloud.datalabeling.v1beta1.Annotation

Annotation.Builder

Protobuf type google.cloud.datalabeling.v1beta1.Annotation

AnnotationMetadata

Additional information associated with the annotation.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationMetadata

AnnotationMetadata.Builder

Additional information associated with the annotation.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationMetadata

AnnotationOuterClass

AnnotationSpec

Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as dog or cat must reference an AnnotationSpec for dog and an AnnotationSpec for cat.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationSpec

AnnotationSpec.Builder

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationSpec

AnnotationSpecSet

An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationSpecSet

AnnotationSpecSet.Builder

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationSpecSet

AnnotationSpecSetName

AnnotationSpecSetName.Builder

Builder for projects/{project}/annotationSpecSets/{annotation_spec_set}.

AnnotationSpecSetOuterClass

AnnotationValue

Annotation value for an example.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationValue

AnnotationValue.Builder

Annotation value for an example.

Protobuf type google.cloud.datalabeling.v1beta1.AnnotationValue

Attempt

Records a failed evaluation job run.

Protobuf type google.cloud.datalabeling.v1beta1.Attempt

Attempt.Builder

Records a failed evaluation job run.

Protobuf type google.cloud.datalabeling.v1beta1.Attempt

BigQuerySource

The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version.

Protobuf type google.cloud.datalabeling.v1beta1.BigQuerySource

BigQuerySource.Builder

The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version.

Protobuf type google.cloud.datalabeling.v1beta1.BigQuerySource

BoundingBoxEvaluationOptions

Options regarding evaluation between bounding boxes.

Protobuf type google.cloud.datalabeling.v1beta1.BoundingBoxEvaluationOptions

BoundingBoxEvaluationOptions.Builder

Options regarding evaluation between bounding boxes.

Protobuf type google.cloud.datalabeling.v1beta1.BoundingBoxEvaluationOptions

BoundingPoly

A bounding polygon in the image.

Protobuf type google.cloud.datalabeling.v1beta1.BoundingPoly

BoundingPoly.Builder

A bounding polygon in the image.

Protobuf type google.cloud.datalabeling.v1beta1.BoundingPoly

BoundingPolyConfig

Config for image bounding poly (and bounding box) human labeling task.

Protobuf type google.cloud.datalabeling.v1beta1.BoundingPolyConfig

BoundingPolyConfig.Builder

Config for image bounding poly (and bounding box) human labeling task.

Protobuf type google.cloud.datalabeling.v1beta1.BoundingPolyConfig

ClassificationMetadata

Metadata for classification annotations.

Protobuf type google.cloud.datalabeling.v1beta1.ClassificationMetadata

ClassificationMetadata.Builder

Metadata for classification annotations.

Protobuf type google.cloud.datalabeling.v1beta1.ClassificationMetadata

ClassificationMetrics

Metrics calculated for a classification model.

Protobuf type google.cloud.datalabeling.v1beta1.ClassificationMetrics

ClassificationMetrics.Builder

Metrics calculated for a classification model.

Protobuf type google.cloud.datalabeling.v1beta1.ClassificationMetrics

ConfusionMatrix

Confusion matrix of the model running the classification. Only applicable when the metrics entry aggregates multiple labels. Not applicable when the entry is for a single label.

Protobuf type google.cloud.datalabeling.v1beta1.ConfusionMatrix

ConfusionMatrix.Builder

Confusion matrix of the model running the classification. Only applicable when the metrics entry aggregates multiple labels. Not applicable when the entry is for a single label.

Protobuf type google.cloud.datalabeling.v1beta1.ConfusionMatrix

ConfusionMatrix.ConfusionMatrixEntry

Protobuf type google.cloud.datalabeling.v1beta1.ConfusionMatrix.ConfusionMatrixEntry

ConfusionMatrix.ConfusionMatrixEntry.Builder

Protobuf type google.cloud.datalabeling.v1beta1.ConfusionMatrix.ConfusionMatrixEntry

ConfusionMatrix.Row

A row in the confusion matrix. Each entry in this row has the same ground truth label.

Protobuf type google.cloud.datalabeling.v1beta1.ConfusionMatrix.Row

ConfusionMatrix.Row.Builder

A row in the confusion matrix. Each entry in this row has the same ground truth label.

Protobuf type google.cloud.datalabeling.v1beta1.ConfusionMatrix.Row

CreateAnnotationSpecSetRequest

Request message for CreateAnnotationSpecSet.

Protobuf type google.cloud.datalabeling.v1beta1.CreateAnnotationSpecSetRequest

CreateAnnotationSpecSetRequest.Builder

Request message for CreateAnnotationSpecSet.

Protobuf type google.cloud.datalabeling.v1beta1.CreateAnnotationSpecSetRequest

CreateDatasetRequest

Request message for CreateDataset.

Protobuf type google.cloud.datalabeling.v1beta1.CreateDatasetRequest

CreateDatasetRequest.Builder

Request message for CreateDataset.

Protobuf type google.cloud.datalabeling.v1beta1.CreateDatasetRequest

CreateEvaluationJobRequest

Request message for CreateEvaluationJob.

Protobuf type google.cloud.datalabeling.v1beta1.CreateEvaluationJobRequest

CreateEvaluationJobRequest.Builder

Request message for CreateEvaluationJob.

Protobuf type google.cloud.datalabeling.v1beta1.CreateEvaluationJobRequest

CreateInstructionMetadata

Metadata of a CreateInstruction operation.

Protobuf type google.cloud.datalabeling.v1beta1.CreateInstructionMetadata

CreateInstructionMetadata.Builder

Metadata of a CreateInstruction operation.

Protobuf type google.cloud.datalabeling.v1beta1.CreateInstructionMetadata

CreateInstructionRequest

Request message for CreateInstruction.

Protobuf type google.cloud.datalabeling.v1beta1.CreateInstructionRequest

CreateInstructionRequest.Builder

Request message for CreateInstruction.

Protobuf type google.cloud.datalabeling.v1beta1.CreateInstructionRequest

CsvInstruction

Deprecated: this instruction format is not supported any more. Instruction from a CSV file.

Protobuf type google.cloud.datalabeling.v1beta1.CsvInstruction

CsvInstruction.Builder

Deprecated: this instruction format is not supported any more. Instruction from a CSV file.

Protobuf type google.cloud.datalabeling.v1beta1.CsvInstruction

DataItem

DataItem is a piece of data, without annotation. For example, an image.

Protobuf type google.cloud.datalabeling.v1beta1.DataItem

DataItem.Builder

DataItem is a piece of data, without annotation. For example, an image.

Protobuf type google.cloud.datalabeling.v1beta1.DataItem

DataItemName

DataItemName.Builder

Builder for projects/{project}/datasets/{dataset}/dataItems/{data_item}.

DataLabelingServiceClient

Service Description: Service for the AI Platform Data Labeling API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = dataLabelingServiceClient.createDataset(parent, dataset);
 }

Note: close() needs to be called on the DataLabelingServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DataLabelingServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataLabelingServiceSettings dataLabelingServiceSettings =
     DataLabelingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataLabelingServiceClient dataLabelingServiceClient =
     DataLabelingServiceClient.create(dataLabelingServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataLabelingServiceSettings dataLabelingServiceSettings =
     DataLabelingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataLabelingServiceClient dataLabelingServiceClient =
     DataLabelingServiceClient.create(dataLabelingServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DataLabelingServiceClient.ListAnnotatedDatasetsFixedSizeCollection

DataLabelingServiceClient.ListAnnotatedDatasetsPage

DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse

DataLabelingServiceClient.ListAnnotationSpecSetsFixedSizeCollection

DataLabelingServiceClient.ListAnnotationSpecSetsPage

DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse

DataLabelingServiceClient.ListDataItemsFixedSizeCollection

DataLabelingServiceClient.ListDataItemsPage

DataLabelingServiceClient.ListDataItemsPagedResponse

DataLabelingServiceClient.ListDatasetsFixedSizeCollection

DataLabelingServiceClient.ListDatasetsPage

DataLabelingServiceClient.ListDatasetsPagedResponse

DataLabelingServiceClient.ListEvaluationJobsFixedSizeCollection

DataLabelingServiceClient.ListEvaluationJobsPage

DataLabelingServiceClient.ListEvaluationJobsPagedResponse

DataLabelingServiceClient.ListExamplesFixedSizeCollection

DataLabelingServiceClient.ListExamplesPage

DataLabelingServiceClient.ListExamplesPagedResponse

DataLabelingServiceClient.ListInstructionsFixedSizeCollection

DataLabelingServiceClient.ListInstructionsPage

DataLabelingServiceClient.ListInstructionsPagedResponse

DataLabelingServiceClient.SearchEvaluationsFixedSizeCollection

DataLabelingServiceClient.SearchEvaluationsPage

DataLabelingServiceClient.SearchEvaluationsPagedResponse