Class DataLabelingService.DataLabelingServiceBase
Base class for server-side implementations of DataLabelingService
Inheritance
Inherited Members
Namespace: Google.Cloud.DataLabeling.V1Beta1
Assembly: Google.Cloud.DataLabeling.V1Beta1.dll
Syntax
[BindServiceMethod(typeof(DataLabelingService), "BindService")]
public abstract class DataLabelingServiceBaseMethods
CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest, ServerCallContext)
Creates an annotation spec set by providing a set of labels.
Declaration
public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateAnnotationSpecSetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AnnotationSpecSet> | The response to send back to the client (wrapped by a task). |
CreateDataset(CreateDatasetRequest, ServerCallContext)
Creates dataset. If success return a Dataset resource.
Declaration
public virtual Task<Dataset> CreateDataset(CreateDatasetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateDatasetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Dataset> | The response to send back to the client (wrapped by a task). |
CreateEvaluationJob(CreateEvaluationJobRequest, ServerCallContext)
Creates an evaluation job.
Declaration
public virtual Task<EvaluationJob> CreateEvaluationJob(CreateEvaluationJobRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateEvaluationJobRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<EvaluationJob> | The response to send back to the client (wrapped by a task). |
CreateInstruction(CreateInstructionRequest, ServerCallContext)
Creates an instruction for how data should be labeled.
Declaration
public virtual Task<Operation> CreateInstruction(CreateInstructionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CreateInstructionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |
DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest, ServerCallContext)
Deletes an annotated dataset by resource name.
Declaration
public virtual Task<Empty> DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteAnnotatedDatasetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest, ServerCallContext)
Deletes an annotation spec set by resource name.
Declaration
public virtual Task<Empty> DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteAnnotationSpecSetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteDataset(DeleteDatasetRequest, ServerCallContext)
Deletes a dataset by resource name.
Declaration
public virtual Task<Empty> DeleteDataset(DeleteDatasetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteDatasetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteEvaluationJob(DeleteEvaluationJobRequest, ServerCallContext)
Stops and deletes an evaluation job.
Declaration
public virtual Task<Empty> DeleteEvaluationJob(DeleteEvaluationJobRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteEvaluationJobRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteInstruction(DeleteInstructionRequest, ServerCallContext)
Deletes an instruction object by resource name.
Declaration
public virtual Task<Empty> DeleteInstruction(DeleteInstructionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteInstructionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
ExportData(ExportDataRequest, ServerCallContext)
Exports data and annotations from dataset.
Declaration
public virtual Task<Operation> ExportData(ExportDataRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ExportDataRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |
GetAnnotatedDataset(GetAnnotatedDatasetRequest, ServerCallContext)
Gets an annotated dataset by resource name.
Declaration
public virtual Task<AnnotatedDataset> GetAnnotatedDataset(GetAnnotatedDatasetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetAnnotatedDatasetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AnnotatedDataset> | The response to send back to the client (wrapped by a task). |
GetAnnotationSpecSet(GetAnnotationSpecSetRequest, ServerCallContext)
Gets an annotation spec set by resource name.
Declaration
public virtual Task<AnnotationSpecSet> GetAnnotationSpecSet(GetAnnotationSpecSetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetAnnotationSpecSetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AnnotationSpecSet> | The response to send back to the client (wrapped by a task). |
GetDataItem(GetDataItemRequest, ServerCallContext)
Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
Declaration
public virtual Task<DataItem> GetDataItem(GetDataItemRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetDataItemRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<DataItem> | The response to send back to the client (wrapped by a task). |
GetDataset(GetDatasetRequest, ServerCallContext)
Gets dataset by resource name.
Declaration
public virtual Task<Dataset> GetDataset(GetDatasetRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetDatasetRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Dataset> | The response to send back to the client (wrapped by a task). |
GetEvaluation(GetEvaluationRequest, ServerCallContext)
Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).
Declaration
public virtual Task<Evaluation> GetEvaluation(GetEvaluationRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetEvaluationRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Evaluation> | The response to send back to the client (wrapped by a task). |
GetEvaluationJob(GetEvaluationJobRequest, ServerCallContext)
Gets an evaluation job by resource name.
Declaration
public virtual Task<EvaluationJob> GetEvaluationJob(GetEvaluationJobRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetEvaluationJobRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<EvaluationJob> | The response to send back to the client (wrapped by a task). |
GetExample(GetExampleRequest, ServerCallContext)
Gets an example by resource name, including both data and annotation.
Declaration
public virtual Task<Example> GetExample(GetExampleRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetExampleRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Example> | The response to send back to the client (wrapped by a task). |
GetInstruction(GetInstructionRequest, ServerCallContext)
Gets an instruction by resource name.
Declaration
public virtual Task<Instruction> GetInstruction(GetInstructionRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetInstructionRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Instruction> | The response to send back to the client (wrapped by a task). |
ImportData(ImportDataRequest, ServerCallContext)
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.
Declaration
public virtual Task<Operation> ImportData(ImportDataRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ImportDataRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |
LabelImage(LabelImageRequest, ServerCallContext)
Starts a labeling task for image. The type of image labeling task is configured by feature in the request.
Declaration
public virtual Task<Operation> LabelImage(LabelImageRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| LabelImageRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |
LabelText(LabelTextRequest, ServerCallContext)
Starts a labeling task for text. The type of text labeling task is configured by feature in the request.
Declaration
public virtual Task<Operation> LabelText(LabelTextRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| LabelTextRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |
LabelVideo(LabelVideoRequest, ServerCallContext)
Starts a labeling task for video. The type of video labeling task is configured by feature in the request.
Declaration
public virtual Task<Operation> LabelVideo(LabelVideoRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| LabelVideoRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |
ListAnnotatedDatasets(ListAnnotatedDatasetsRequest, ServerCallContext)
Lists annotated datasets for a dataset. Pagination is supported.
Declaration
public virtual Task<ListAnnotatedDatasetsResponse> ListAnnotatedDatasets(ListAnnotatedDatasetsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListAnnotatedDatasetsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListAnnotatedDatasetsResponse> | The response to send back to the client (wrapped by a task). |
ListAnnotationSpecSets(ListAnnotationSpecSetsRequest, ServerCallContext)
Lists annotation spec sets for a project. Pagination is supported.
Declaration
public virtual Task<ListAnnotationSpecSetsResponse> ListAnnotationSpecSets(ListAnnotationSpecSetsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListAnnotationSpecSetsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListAnnotationSpecSetsResponse> | The response to send back to the client (wrapped by a task). |
ListDataItems(ListDataItemsRequest, ServerCallContext)
Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.
Declaration
public virtual Task<ListDataItemsResponse> ListDataItems(ListDataItemsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListDataItemsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListDataItemsResponse> | The response to send back to the client (wrapped by a task). |
ListDatasets(ListDatasetsRequest, ServerCallContext)
Lists datasets under a project. Pagination is supported.
Declaration
public virtual Task<ListDatasetsResponse> ListDatasets(ListDatasetsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListDatasetsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListDatasetsResponse> | The response to send back to the client (wrapped by a task). |
ListEvaluationJobs(ListEvaluationJobsRequest, ServerCallContext)
Lists all evaluation jobs within a project with possible filters. Pagination is supported.
Declaration
public virtual Task<ListEvaluationJobsResponse> ListEvaluationJobs(ListEvaluationJobsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListEvaluationJobsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListEvaluationJobsResponse> | The response to send back to the client (wrapped by a task). |
ListExamples(ListExamplesRequest, ServerCallContext)
Lists examples in an annotated dataset. Pagination is supported.
Declaration
public virtual Task<ListExamplesResponse> ListExamples(ListExamplesRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListExamplesRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListExamplesResponse> | The response to send back to the client (wrapped by a task). |
ListInstructions(ListInstructionsRequest, ServerCallContext)
Lists instructions for a project. Pagination is supported.
Declaration
public virtual Task<ListInstructionsResponse> ListInstructions(ListInstructionsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListInstructionsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListInstructionsResponse> | The response to send back to the client (wrapped by a task). |
PauseEvaluationJob(PauseEvaluationJobRequest, ServerCallContext)
Pauses an evaluation job. Pausing an evaluation job that is already in a
PAUSED state is a no-op.
Declaration
public virtual Task<Empty> PauseEvaluationJob(PauseEvaluationJobRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| PauseEvaluationJobRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
ResumeEvaluationJob(ResumeEvaluationJobRequest, ServerCallContext)
Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.
Declaration
public virtual Task<Empty> ResumeEvaluationJob(ResumeEvaluationJobRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ResumeEvaluationJobRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
SearchEvaluations(SearchEvaluationsRequest, ServerCallContext)
Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.
Declaration
public virtual Task<SearchEvaluationsResponse> SearchEvaluations(SearchEvaluationsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| SearchEvaluationsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchEvaluationsResponse> | The response to send back to the client (wrapped by a task). |
SearchExampleComparisons(SearchExampleComparisonsRequest, ServerCallContext)
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.
Declaration
public virtual Task<SearchExampleComparisonsResponse> SearchExampleComparisons(SearchExampleComparisonsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| SearchExampleComparisonsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchExampleComparisonsResponse> | The response to send back to the client (wrapped by a task). |
UpdateEvaluationJob(UpdateEvaluationJobRequest, ServerCallContext)
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.
Declaration
public virtual Task<EvaluationJob> UpdateEvaluationJob(UpdateEvaluationJobRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateEvaluationJobRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<EvaluationJob> | The response to send back to the client (wrapped by a task). |