Class DataLabelingServiceClient (1.1.0)

DataLabelingServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.datalabeling_v1beta1.services.data_labeling_service.transports.base.DataLabelingServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for the AI Platform Data Labeling API.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
DataLabelingServiceTransportThe transport used by the client instance.

Methods

DataLabelingServiceClient

DataLabelingServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.datalabeling_v1beta1.services.data_labeling_service.transports.base.DataLabelingServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the data labeling service client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, DataLabelingServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

annotated_dataset_path

annotated_dataset_path(project: str, dataset: str, annotated_dataset: str)

Returns a fully-qualified annotated_dataset string.

annotation_spec_set_path

annotation_spec_set_path(project: str, annotation_spec_set: str)

Returns a fully-qualified annotation_spec_set string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_annotation_spec_set

create_annotation_spec_set(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.CreateAnnotationSpecSetRequest] = None, *, parent: Optional[str] = None, annotation_spec_set: Optional[google.cloud.datalabeling_v1beta1.types.annotation_spec_set.AnnotationSpecSet] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.CreateAnnotationSpecSetRequest

The request object. Request message for CreateAnnotationSpecSet.

parent str

Required. AnnotationSpecSet resource parent, format: projects/{project_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

annotation_spec_set google.cloud.datalabeling_v1beta1.types.AnnotationSpecSet

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name. This corresponds to the annotation_spec_set field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.AnnotationSpecSetAn 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.

create_dataset

create_dataset(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.CreateDatasetRequest] = None, *, parent: Optional[str] = None, dataset: Optional[google.cloud.datalabeling_v1beta1.types.dataset.Dataset] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates dataset. If success return a Dataset resource.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.CreateDatasetRequest

The request object. Request message for CreateDataset.

parent str

Required. Dataset resource parent, format: projects/{project_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

dataset google.cloud.datalabeling_v1beta1.types.Dataset

Required. The dataset to be created. This corresponds to the dataset field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.DatasetDataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.

create_evaluation_job

create_evaluation_job(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.CreateEvaluationJobRequest] = None, *, parent: Optional[str] = None, job: Optional[google.cloud.datalabeling_v1beta1.types.evaluation_job.EvaluationJob] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an evaluation job.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.CreateEvaluationJobRequest

The request object. Request message for CreateEvaluationJob.

parent str

Required. Evaluation job resource parent. Format: "projects/{project_id}" This corresponds to the parent field on the request instance; if request is provided, this should not be set.

job google.cloud.datalabeling_v1beta1.types.EvaluationJob

Required. The evaluation job to create. This corresponds to the job field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.EvaluationJobDefines an evaluation job that runs periodically to generate Evaluations. [Creating an evaluation job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point for using continuous evaluation.

create_instruction

create_instruction(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.CreateInstructionRequest] = None, *, parent: Optional[str] = None, instruction: Optional[google.cloud.datalabeling_v1beta1.types.instruction.Instruction] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an instruction for how data should be labeled.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.CreateInstructionRequest

The request object. Request message for CreateInstruction.

parent str

Required. Instruction resource parent, format: projects/{project_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

instruction google.cloud.datalabeling_v1beta1.types.Instruction

Required. Instruction of how to perform the labeling task. This corresponds to the instruction field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Instruction Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.

data_item_path

data_item_path(project: str, dataset: str, data_item: str)

Returns a fully-qualified data_item string.

dataset_path

dataset_path(project: str, dataset: str)

Returns a fully-qualified dataset string.

delete_annotated_dataset

delete_annotated_dataset(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.DeleteAnnotatedDatasetRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an annotated dataset by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.DeleteAnnotatedDatasetRequest

The request object. Request message for DeleteAnnotatedDataset.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_annotation_spec_set

delete_annotation_spec_set(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.DeleteAnnotationSpecSetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an annotation spec set by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.DeleteAnnotationSpecSetRequest

The request object. Request message for DeleteAnnotationSpecSet.

name str

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_dataset

delete_dataset(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.DeleteDatasetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a dataset by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.DeleteDatasetRequest

The request object. Request message for DeleteDataset.

name str

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_evaluation_job

delete_evaluation_job(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.DeleteEvaluationJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Stops and deletes an evaluation job.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.DeleteEvaluationJobRequest

The request object. Request message DeleteEvaluationJob.

name str

Required. Name of the evaluation job that is going to be deleted. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}" This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_instruction

delete_instruction(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.DeleteInstructionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an instruction object by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.DeleteInstructionRequest

The request object. Request message for DeleteInstruction.

name str

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

evaluation_job_path

evaluation_job_path(project: str, evaluation_job: str)

Returns a fully-qualified evaluation_job string.

evaluation_path

evaluation_path(project: str, dataset: str, evaluation: str)

Returns a fully-qualified evaluation string.

example_path

example_path(project: str, dataset: str, annotated_dataset: str, example: str)

Returns a fully-qualified example string.

export_data

export_data(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ExportDataRequest] = None, *, name: Optional[str] = None, annotated_dataset: Optional[str] = None, filter: Optional[str] = None, output_config: Optional[google.cloud.datalabeling_v1beta1.types.dataset.OutputConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports data and annotations from dataset.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ExportDataRequest

The request object. Request message for ExportData API.

name str

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

annotated_dataset str

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id} This corresponds to the annotated_dataset field on the request instance; if request is provided, this should not be set.

filter str

Optional. Filter is not supported at this moment. This corresponds to the filter field on the request instance; if request is provided, this should not be set.

output_config google.cloud.datalabeling_v1beta1.types.OutputConfig

Required. Specify the output destination. This corresponds to the output_config field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be ExportDataOperationResponse Response used for ExportDataset longrunning operation.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DataLabelingServiceClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
DataLabelingServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DataLabelingServiceClientThe constructed client.

get_annotated_dataset

get_annotated_dataset(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetAnnotatedDatasetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an annotated dataset by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetAnnotatedDatasetRequest

The request object. Request message for GetAnnotatedDataset.

name str

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.AnnotatedDatasetAnnotatedDataset 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.

get_annotation_spec_set

get_annotation_spec_set(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetAnnotationSpecSetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an annotation spec set by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetAnnotationSpecSetRequest

The request object. Request message for GetAnnotationSpecSet.

name str

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.AnnotationSpecSetAn 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.

get_data_item

get_data_item(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetDataItemRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetDataItemRequest

The request object. Request message for GetDataItem.

name str

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.DataItemDataItem is a piece of data, without annotation. For example, an image.

get_dataset

get_dataset(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetDatasetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets dataset by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetDatasetRequest

The request object. Request message for GetDataSet.

name str

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.DatasetDataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.

get_evaluation

get_evaluation(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetEvaluationRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetEvaluationRequest

The request object. Request message for GetEvaluation.

name str

Required. Name of the evaluation. Format: "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}' This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.EvaluationDescribes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.

get_evaluation_job

get_evaluation_job(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetEvaluationJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an evaluation job by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetEvaluationJobRequest

The request object. Request message for GetEvaluationJob.

name str

Required. Name of the evaluation job. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}" This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.EvaluationJobDefines an evaluation job that runs periodically to generate Evaluations. [Creating an evaluation job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point for using continuous evaluation.

get_example

get_example(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetExampleRequest] = None, *, name: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetExampleRequest

The request object. Request message for GetExample

name str

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

filter str

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}" This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.ExampleAn Example is a piece of data and its annotation. For example, an image with label "house".

get_instruction

get_instruction(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.GetInstructionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an instruction by resource name.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.GetInstructionRequest

The request object. Request message for GetInstruction.

name str

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.InstructionInstruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.

import_data

import_data(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ImportDataRequest] = None, *, name: Optional[str] = None, input_config: Optional[google.cloud.datalabeling_v1beta1.types.dataset.InputConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
NameDescription
request google.cloud.datalabeling_v1beta1.types.ImportDataRequest

The request object. Request message for ImportData API.

name str

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

input_config google.cloud.datalabeling_v1beta1.types.InputConfig

Required. Specify the input source of the data. This corresponds to the input_config field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be ImportDataOperationResponse Response used for ImportData longrunning operation.

instruction_path

instruction_path(project: str, instruction: str)

Returns a fully-qualified instruction string.

label_image

label_image(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.LabelImageRequest] = None, *, parent: Optional[str] = None, basic_config: Optional[google.cloud.datalabeling_v1beta1.types.human_annotation_config.HumanAnnotationConfig] = None, feature: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.LabelImageRequest.Feature] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.LabelImageRequest

The request object. Request message for starting an image labeling task.

parent str

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

basic_config google.cloud.datalabeling_v1beta1.types.HumanAnnotationConfig

Required. Basic human annotation config. This corresponds to the basic_config field on the request instance; if request is provided, this should not be set.

feature google.cloud.datalabeling_v1beta1.types.LabelImageRequest.Feature

Required. The type of image labeling task. This corresponds to the feature field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

label_text

label_text(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.LabelTextRequest] = None, *, parent: Optional[str] = None, basic_config: Optional[google.cloud.datalabeling_v1beta1.types.human_annotation_config.HumanAnnotationConfig] = None, feature: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.LabelTextRequest.Feature] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.LabelTextRequest

The request object. Request message for LabelText.

parent str

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

basic_config google.cloud.datalabeling_v1beta1.types.HumanAnnotationConfig

Required. Basic human annotation config. This corresponds to the basic_config field on the request instance; if request is provided, this should not be set.

feature google.cloud.datalabeling_v1beta1.types.LabelTextRequest.Feature

Required. The type of text labeling task. This corresponds to the feature field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

label_video

label_video(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.LabelVideoRequest] = None, *, parent: Optional[str] = None, basic_config: Optional[google.cloud.datalabeling_v1beta1.types.human_annotation_config.HumanAnnotationConfig] = None, feature: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.LabelVideoRequest.Feature] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.LabelVideoRequest

The request object. Request message for LabelVideo.

parent str

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

basic_config google.cloud.datalabeling_v1beta1.types.HumanAnnotationConfig

Required. Basic human annotation config. This corresponds to the basic_config field on the request instance; if request is provided, this should not be set.

feature google.cloud.datalabeling_v1beta1.types.LabelVideoRequest.Feature

Required. The type of video labeling task. This corresponds to the feature field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be 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.

list_annotated_datasets

list_annotated_datasets(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ListAnnotatedDatasetsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ListAnnotatedDatasetsRequest

The request object. Request message for ListAnnotatedDatasets.

parent str

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. Filter is not supported at this moment. This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.ListAnnotatedDatasetsPagerResults of listing annotated datasets for a dataset. Iterating over this object will yield results and resolve additional pages automatically.

list_annotation_spec_sets

list_annotation_spec_sets(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ListAnnotationSpecSetsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ListAnnotationSpecSetsRequest

The request object. Request message for ListAnnotationSpecSets.

parent str

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. Filter is not supported at this moment. This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.ListAnnotationSpecSetsPagerResults of listing annotation spec set under a project. Iterating over this object will yield results and resolve additional pages automatically.

list_data_items

list_data_items(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ListDataItemsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ListDataItemsRequest

The request object. Request message for ListDataItems.

parent str

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. Filter is not supported at this moment. This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.ListDataItemsPagerResults of listing data items in a dataset. Iterating over this object will yield results and resolve additional pages automatically.

list_datasets

list_datasets(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ListDatasetsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists datasets under a project. Pagination is supported.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ListDatasetsRequest

The request object. Request message for ListDataset.

parent str

Required. Dataset resource parent, format: projects/{project_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. Filter on dataset is not supported at this moment. This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.ListDatasetsPagerResults of listing datasets within a project. Iterating over this object will yield results and resolve additional pages automatically.

list_evaluation_jobs

list_evaluation_jobs(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ListEvaluationJobsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ListEvaluationJobsRequest

The request object. Request message for ListEvaluationJobs.

parent str

Required. Evaluation job resource parent. Format: "projects/{project_id}" This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluation\ job.model_id = {model_name} AND evaluation\ job.state = {evaluation_job_state}" This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.ListEvaluationJobsPagerResults for listing evaluation jobs. Iterating over this object will yield results and resolve additional pages automatically.

list_examples

list_examples(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ListExamplesRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists examples in an annotated dataset. Pagination is supported.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ListExamplesRequest

The request object. Request message for ListExamples.

parent str

Required. Example resource parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}" This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.ListExamplesPagerResults of listing Examples in and annotated dataset. Iterating over this object will yield results and resolve additional pages automatically.

list_instructions

list_instructions(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ListInstructionsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists instructions for a project. Pagination is supported.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.ListInstructionsRequest

The request object. Request message for ListInstructions.

parent str

Required. Instruction resource parent, format: projects/{project_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. Filter is not supported at this moment. This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.ListInstructionsPagerResults of listing instructions under a project. Iterating over this object will yield results and resolve additional pages automatically.

parse_annotated_dataset_path

parse_annotated_dataset_path(path: str)

Parses a annotated_dataset path into its component segments.

parse_annotation_spec_set_path

parse_annotation_spec_set_path(path: str)

Parses a annotation_spec_set path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_data_item_path

parse_data_item_path(path: str)

Parses a data_item path into its component segments.

parse_dataset_path

parse_dataset_path(path: str)

Parses a dataset path into its component segments.

parse_evaluation_job_path

parse_evaluation_job_path(path: str)

Parses a evaluation_job path into its component segments.

parse_evaluation_path

parse_evaluation_path(path: str)

Parses a evaluation path into its component segments.

parse_example_path

parse_example_path(path: str)

Parses a example path into its component segments.

parse_instruction_path

parse_instruction_path(path: str)

Parses a instruction path into its component segments.

pause_evaluation_job

pause_evaluation_job(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.PauseEvaluationJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.PauseEvaluationJobRequest

The request object. Request message for PauseEvaluationJob.

name str

Required. Name of the evaluation job that is going to be paused. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}" This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

resume_evaluation_job

resume_evaluation_job(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.ResumeEvaluationJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
NameDescription
request google.cloud.datalabeling_v1beta1.types.ResumeEvaluationJobRequest

The request object. Request message ResumeEvaluationJob.

name str

Required. Name of the evaluation job that is going to be resumed. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}" This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

search_evaluations

search_evaluations(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchEvaluationsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Searches xref_evaluations within a project.

Parameters
NameDescription
request google.cloud.datalabeling_v1beta1.types.SearchEvaluationsRequest

The request object. Request message for SearchEvaluation.

parent str

Required. Evaluation search parent (project ID). Format: "projects/{project_id}" This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. To search evaluations, you can filter by the following: - evaluation_job.evaluation_job_id (the last part of EvaluationJob.name) - evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion) - evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation) - evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation) - evaluation_job.job_state (EvaluationJob.state) - annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName) To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera: "evaluation\ job.evaluation_job_id = {evaluation_job_id} AND evaluation\ job.model_id = {model_name} AND evaluation\ job.evaluation_job_run_time_start = {timestamp_1} AND evaluation\ job.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}" This corresponds to the filter field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.SearchEvaluationsPagerResults of searching evaluations. Iterating over this object will yield results and resolve additional pages automatically.

search_example_comparisons

search_example_comparisons(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchExampleComparisonsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
NameDescription
request google.cloud.datalabeling_v1beta1.types.SearchExampleComparisonsRequest

The request object. Request message of SearchExampleComparisons.

parent str

Required. Name of the Evaluation resource to search for example comparisons from. Format: "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}" This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.services.data_labeling_service.pagers.SearchExampleComparisonsPagerResults of searching example comparisons. Iterating over this object will yield results and resolve additional pages automatically.

update_evaluation_job

update_evaluation_job(request: Optional[google.cloud.datalabeling_v1beta1.types.data_labeling_service.UpdateEvaluationJobRequest] = None, *, evaluation_job: Optional[google.cloud.datalabeling_v1beta1.types.evaluation_job.EvaluationJob] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an evaluation job. You can only update certain fields of the job's xref_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
NameDescription
request google.cloud.datalabeling_v1beta1.types.UpdateEvaluationJobRequest

The request object. Request message for UpdateEvaluationJob.

evaluation_job google.cloud.datalabeling_v1beta1.types.EvaluationJob

Required. Evaluation job that is going to be updated. This corresponds to the evaluation_job field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Mask for which fields to update. You can only provide the following fields: - evaluationJobConfig.humanAnnotationConfig.instruction - evaluationJobConfig.exampleCount - evaluationJobConfig.exampleSamplePercentage You can provide more than one of these fields by separating them with commas. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.datalabeling_v1beta1.types.EvaluationJobDefines an evaluation job that runs periodically to generate Evaluations. [Creating an evaluation job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point for using continuous evaluation.