Data Labeling v1beta1 API - Class DataLabelingService.DataLabelingServiceBase (2.0.0-beta04)

Version 2.0.0-beta04

• 2.0.0-beta05 (latest)
• 2.0.0-beta04
• 1.0.0-beta03

[BindServiceMethod(typeof(DataLabelingService), "BindService")]
public abstract class DataLabelingService.DataLabelingServiceBase

Reference documentation and code samples for the Data Labeling v1beta1 API class DataLabelingService.DataLabelingServiceBase.

Base class for server-side implementations of DataLabelingService

Inheritance

object > DataLabelingService.DataLabelingServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Methods

CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest, ServerCallContext)

public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateAnnotationSpecSetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnnotationSpecSet	The response to send back to the client (wrapped by a task).

CreateDataset(CreateDatasetRequest, ServerCallContext)

public virtual Task<Dataset> CreateDataset(CreateDatasetRequest request, ServerCallContext context)

Creates dataset. If success return a Dataset resource.

Parameters
Name	Description
request	CreateDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataset	The response to send back to the client (wrapped by a task).

CreateEvaluationJob(CreateEvaluationJobRequest, ServerCallContext)

public virtual Task<EvaluationJob> CreateEvaluationJob(CreateEvaluationJobRequest request, ServerCallContext context)

Creates an evaluation job.

Parameters
Name	Description
request	CreateEvaluationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationJob	The response to send back to the client (wrapped by a task).

CreateInstruction(CreateInstructionRequest, ServerCallContext)

public virtual Task<Operation> CreateInstruction(CreateInstructionRequest request, ServerCallContext context)

Creates an instruction for how data should be labeled.

Parameters
Name	Description
request	CreateInstructionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest, ServerCallContext)

public virtual Task<Empty> DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, ServerCallContext context)

Deletes an annotated dataset by resource name.

Parameters
Name	Description
request	DeleteAnnotatedDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest, ServerCallContext)

public virtual Task<Empty> DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, ServerCallContext context)

Deletes an annotation spec set by resource name.

Parameters
Name	Description
request	DeleteAnnotationSpecSetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteDataset(DeleteDatasetRequest, ServerCallContext)

public virtual Task<Empty> DeleteDataset(DeleteDatasetRequest request, ServerCallContext context)

Deletes a dataset by resource name.

Parameters
Name	Description
request	DeleteDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteEvaluationJob(DeleteEvaluationJobRequest, ServerCallContext)

public virtual Task<Empty> DeleteEvaluationJob(DeleteEvaluationJobRequest request, ServerCallContext context)

Stops and deletes an evaluation job.

Parameters
Name	Description
request	DeleteEvaluationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteInstruction(DeleteInstructionRequest, ServerCallContext)

public virtual Task<Empty> DeleteInstruction(DeleteInstructionRequest request, ServerCallContext context)

Deletes an instruction object by resource name.

Parameters
Name	Description
request	DeleteInstructionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

ExportData(ExportDataRequest, ServerCallContext)

public virtual Task<Operation> ExportData(ExportDataRequest request, ServerCallContext context)

Exports data and annotations from dataset.

Parameters
Name	Description
request	ExportDataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetAnnotatedDataset(GetAnnotatedDatasetRequest, ServerCallContext)

public virtual Task<AnnotatedDataset> GetAnnotatedDataset(GetAnnotatedDatasetRequest request, ServerCallContext context)

Gets an annotated dataset by resource name.

Parameters
Name	Description
request	GetAnnotatedDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnnotatedDataset	The response to send back to the client (wrapped by a task).

GetAnnotationSpecSet(GetAnnotationSpecSetRequest, ServerCallContext)

public virtual Task<AnnotationSpecSet> GetAnnotationSpecSet(GetAnnotationSpecSetRequest request, ServerCallContext context)

Gets an annotation spec set by resource name.

Parameters
Name	Description
request	GetAnnotationSpecSetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnnotationSpecSet	The response to send back to the client (wrapped by a task).

GetDataItem(GetDataItemRequest, ServerCallContext)

public virtual Task<DataItem> GetDataItem(GetDataItemRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataItem	The response to send back to the client (wrapped by a task).

GetDataset(GetDatasetRequest, ServerCallContext)

public virtual Task<Dataset> GetDataset(GetDatasetRequest request, ServerCallContext context)

Gets dataset by resource name.

Parameters
Name	Description
request	GetDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataset	The response to send back to the client (wrapped by a task).

GetEvaluation(GetEvaluationRequest, ServerCallContext)

public virtual Task<Evaluation> GetEvaluation(GetEvaluationRequest request, ServerCallContext context)

Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).

Parameters
Name	Description
request	GetEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluation	The response to send back to the client (wrapped by a task).

GetEvaluationJob(GetEvaluationJobRequest, ServerCallContext)

public virtual Task<EvaluationJob> GetEvaluationJob(GetEvaluationJobRequest request, ServerCallContext context)

Gets an evaluation job by resource name.

Parameters
Name	Description
request	GetEvaluationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationJob	The response to send back to the client (wrapped by a task).

GetExample(GetExampleRequest, ServerCallContext)

public virtual Task<Example> GetExample(GetExampleRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetExampleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskExample	The response to send back to the client (wrapped by a task).

GetInstruction(GetInstructionRequest, ServerCallContext)

public virtual Task<Instruction> GetInstruction(GetInstructionRequest request, ServerCallContext context)

Gets an instruction by resource name.

Parameters
Name	Description
request	GetInstructionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstruction	The response to send back to the client (wrapped by a task).

ImportData(ImportDataRequest, ServerCallContext)

public virtual Task<Operation> ImportData(ImportDataRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

LabelImage(LabelImageRequest, ServerCallContext)

public virtual Task<Operation> LabelImage(LabelImageRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	LabelImageRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

LabelText(LabelTextRequest, ServerCallContext)

public virtual Task<Operation> LabelText(LabelTextRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	LabelTextRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

LabelVideo(LabelVideoRequest, ServerCallContext)

public virtual Task<Operation> LabelVideo(LabelVideoRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	LabelVideoRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListAnnotatedDatasets(ListAnnotatedDatasetsRequest, ServerCallContext)

public virtual Task<ListAnnotatedDatasetsResponse> ListAnnotatedDatasets(ListAnnotatedDatasetsRequest request, ServerCallContext context)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name	Description
request	ListAnnotatedDatasetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAnnotatedDatasetsResponse	The response to send back to the client (wrapped by a task).

ListAnnotationSpecSets(ListAnnotationSpecSetsRequest, ServerCallContext)

public virtual Task<ListAnnotationSpecSetsResponse> ListAnnotationSpecSets(ListAnnotationSpecSetsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListAnnotationSpecSetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAnnotationSpecSetsResponse	The response to send back to the client (wrapped by a task).

ListDataItems(ListDataItemsRequest, ServerCallContext)

public virtual Task<ListDataItemsResponse> ListDataItems(ListDataItemsRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDataItemsResponse	The response to send back to the client (wrapped by a task).

ListDatasets(ListDatasetsRequest, ServerCallContext)

public virtual Task<ListDatasetsResponse> ListDatasets(ListDatasetsRequest request, ServerCallContext context)

Lists datasets under a project. Pagination is supported.

Parameters
Name	Description
request	ListDatasetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDatasetsResponse	The response to send back to the client (wrapped by a task).

ListEvaluationJobs(ListEvaluationJobsRequest, ServerCallContext)

public virtual Task<ListEvaluationJobsResponse> ListEvaluationJobs(ListEvaluationJobsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListEvaluationJobsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEvaluationJobsResponse	The response to send back to the client (wrapped by a task).

ListExamples(ListExamplesRequest, ServerCallContext)

public virtual Task<ListExamplesResponse> ListExamples(ListExamplesRequest request, ServerCallContext context)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name	Description
request	ListExamplesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListExamplesResponse	The response to send back to the client (wrapped by a task).

ListInstructions(ListInstructionsRequest, ServerCallContext)

public virtual Task<ListInstructionsResponse> ListInstructions(ListInstructionsRequest request, ServerCallContext context)

Lists instructions for a project. Pagination is supported.

Parameters
Name	Description
request	ListInstructionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListInstructionsResponse	The response to send back to the client (wrapped by a task).

PauseEvaluationJob(PauseEvaluationJobRequest, ServerCallContext)

public virtual Task<Empty> PauseEvaluationJob(PauseEvaluationJobRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	PauseEvaluationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

ResumeEvaluationJob(ResumeEvaluationJobRequest, ServerCallContext)

public virtual Task<Empty> ResumeEvaluationJob(ResumeEvaluationJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

SearchEvaluations(SearchEvaluationsRequest, ServerCallContext)

public virtual Task<SearchEvaluationsResponse> SearchEvaluations(SearchEvaluationsRequest request, ServerCallContext context)

Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.

Parameters
Name	Description
request	SearchEvaluationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchEvaluationsResponse	The response to send back to the client (wrapped by a task).

SearchExampleComparisons(SearchExampleComparisonsRequest, ServerCallContext)

public virtual Task<SearchExampleComparisonsResponse> SearchExampleComparisons(SearchExampleComparisonsRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchExampleComparisonsResponse	The response to send back to the client (wrapped by a task).

UpdateEvaluationJob(UpdateEvaluationJobRequest, ServerCallContext)

public virtual Task<EvaluationJob> UpdateEvaluationJob(UpdateEvaluationJobRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	UpdateEvaluationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationJob	The response to send back to the client (wrapped by a task).