Google Cloud Datalabeling V1beta1 Client - Class DataLabelingServiceClient (0.2.0)

Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class DataLabelingServiceClient.

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

This class is currently experimental and may be subject to changes.

Methods

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

annotatedDatasetName

Formats a string containing the fully-qualified path to represent a annotated_dataset resource.

Parameters
Name	Description
`project`	`string`
`dataset`	`string`
`annotatedDataset`	`string`

Returns
Type	Description
`string`	The formatted annotated_dataset resource.

annotationSpecSetName

Formats a string containing the fully-qualified path to represent a annotation_spec_set resource.

Parameters
Name	Description
`project`	`string`
`annotationSpecSet`	`string`

Returns
Type	Description
`string`	The formatted annotation_spec_set resource.

dataItemName

Formats a string containing the fully-qualified path to represent a data_item resource.

Parameters
Name	Description
`project`	`string`
`dataset`	`string`
`dataItem`	`string`

Returns
Type	Description
`string`	The formatted data_item resource.

datasetName

Formats a string containing the fully-qualified path to represent a dataset resource.

Parameters
Name	Description
`project`	`string`
`dataset`	`string`

Returns
Type	Description
`string`	The formatted dataset resource.

evaluationName

Formats a string containing the fully-qualified path to represent a evaluation resource.

Parameters
Name	Description
`project`	`string`
`dataset`	`string`
`evaluation`	`string`

Returns
Type	Description
`string`	The formatted evaluation resource.

evaluationJobName

Formats a string containing the fully-qualified path to represent a evaluation_job resource.

Parameters
Name	Description
`project`	`string`
`evaluationJob`	`string`

Returns
Type	Description
`string`	The formatted evaluation_job resource.

exampleName

Formats a string containing the fully-qualified path to represent a example resource.

Parameters
Name	Description
`project`	`string`
`dataset`	`string`
`annotatedDataset`	`string`
`example`	`string`

Returns
Type	Description
`string`	The formatted example resource.

instructionName

Formats a string containing the fully-qualified path to represent a instruction resource.

Parameters
Name	Description
`project`	`string`
`instruction`	`string`

Returns
Type	Description
`string`	The formatted instruction resource.

projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

annotatedDataset: projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}
annotationSpecSet: projects/{project}/annotationSpecSets/{annotation_spec_set}
dataItem: projects/{project}/datasets/{dataset}/dataItems/{data_item}
dataset: projects/{project}/datasets/{dataset}
evaluation: projects/{project}/datasets/{dataset}/evaluations/{evaluation}
evaluationJob: projects/{project}/evaluationJobs/{evaluation_job}
example: projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}/examples/{example}
instruction: projects/{project}/instructions/{instruction}
project: projects/{project}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

__call

Handles execution of the async variants for each documented method.

Parameters
Name	Description
`method`	`mixed`
`args`	`mixed`

createAnnotationSpecSet

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::createAnnotationSpecSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\CreateAnnotationSpecSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\AnnotationSpecSet`

createDataset

Creates dataset. If success return a Dataset resource.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::createDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\CreateDatasetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\Dataset`

createEvaluationJob

Creates an evaluation job.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::createEvaluationJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\CreateEvaluationJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\EvaluationJob`

createInstruction

Creates an instruction for how data should be labeled.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::createInstructionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\CreateInstructionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteAnnotatedDataset

Deletes an annotated dataset by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::deleteAnnotatedDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\DeleteAnnotatedDatasetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteAnnotationSpecSet

Deletes an annotation spec set by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::deleteAnnotationSpecSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\DeleteAnnotationSpecSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteDataset

Deletes a dataset by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::deleteDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\DeleteDatasetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteEvaluationJob

Stops and deletes an evaluation job.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::deleteEvaluationJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\DeleteEvaluationJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteInstruction

Deletes an instruction object by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::deleteInstructionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\DeleteInstructionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

exportData

Exports data and annotations from dataset.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::exportDataAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ExportDataRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getAnnotatedDataset

Gets an annotated dataset by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getAnnotatedDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetAnnotatedDatasetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\AnnotatedDataset`

getAnnotationSpecSet

Gets an annotation spec set by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getAnnotationSpecSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetAnnotationSpecSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\AnnotationSpecSet`

getDataItem

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getDataItemAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetDataItemRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\DataItem`

getDataset

Gets dataset by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetDatasetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\Dataset`

getEvaluation

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getEvaluationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetEvaluationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\Evaluation`

getEvaluationJob

Gets an evaluation job by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getEvaluationJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetEvaluationJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\EvaluationJob`

getExample

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getExampleAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetExampleRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\Example`

getInstruction

Gets an instruction by resource name.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::getInstructionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\GetInstructionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\Instruction`

importData

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.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::importDataAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ImportDataRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

labelImage

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::labelImageAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\LabelImageRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

labelText

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::labelTextAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\LabelTextRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

labelVideo

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::labelVideoAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\LabelVideoRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

listAnnotatedDatasets

Lists annotated datasets for a dataset. Pagination is supported.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::listAnnotatedDatasetsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ListAnnotatedDatasetsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listAnnotationSpecSets

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::listAnnotationSpecSetsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ListAnnotationSpecSetsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listDataItems

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::listDataItemsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ListDataItemsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listDatasets

Lists datasets under a project. Pagination is supported.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::listDatasetsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ListDatasetsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listEvaluationJobs

Lists all evaluation jobs within a project with possible filters.

Pagination is supported.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::listEvaluationJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ListEvaluationJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listExamples

Lists examples in an annotated dataset. Pagination is supported.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::listExamplesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ListExamplesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listInstructions

Lists instructions for a project. Pagination is supported.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::listInstructionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ListInstructionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

pauseEvaluationJob

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

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::pauseEvaluationJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\PauseEvaluationJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

resumeEvaluationJob

Resumes a paused evaluation job. A deleted evaluation job can't be resumed.

Resuming a running or scheduled evaluation job is a no-op.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::resumeEvaluationJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\ResumeEvaluationJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

searchEvaluations

Searches evaluations within a project.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::searchEvaluationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\SearchEvaluationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

searchExampleComparisons

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.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::searchExampleComparisonsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\SearchExampleComparisonsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateEvaluationJob

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

The async variant is Google\Cloud\DataLabeling\V1beta1\Client\BaseClient\self::updateEvaluationJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataLabeling\V1beta1\UpdateEvaluationJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DataLabeling\V1beta1\EvaluationJob`