Google Cloud Document Ai V1 Client - Class DocumentProcessorServiceClient (1.5.0)

Version 1.5.0

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.14.0
• 1.13.1
• 1.12.2
• 1.9.0
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.1
• 1.0.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class DocumentProcessorServiceClient.

Service Description: Service to call Document AI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

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

Namespace

Google \ Cloud \ DocumentAI \ V1 \ Client

Methods

__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.

batchProcessDocuments

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::batchProcessDocumentsAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\BatchProcessRequest 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

createProcessor

Creates a processor from the ProcessorType provided. The processor will be at ENABLED state by default after its creation.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::createProcessorAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\CreateProcessorRequest 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\DocumentAI\V1\Processor

deleteProcessor

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::deleteProcessorAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DeleteProcessorRequest 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

deleteProcessorVersion

Deletes the processor version, all artifacts under the processor version will be deleted.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::deleteProcessorVersionAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DeleteProcessorVersionRequest 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

deployProcessorVersion

Deploys the processor version.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::deployProcessorVersionAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DeployProcessorVersionRequest 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

disableProcessor

Disables a processor

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::disableProcessorAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DisableProcessorRequest 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

enableProcessor

Enables a processor

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::enableProcessorAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\EnableProcessorRequest 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

evaluateProcessorVersion

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::evaluateProcessorVersionAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\EvaluateProcessorVersionRequest 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

fetchProcessorTypes

Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::fetchProcessorTypesAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\FetchProcessorTypesRequest 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\DocumentAI\V1\FetchProcessorTypesResponse

getEvaluation

Retrieves a specific evaluation.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::getEvaluationAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\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\DocumentAI\V1\Evaluation

getProcessor

Gets a processor detail.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::getProcessorAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\GetProcessorRequest 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\DocumentAI\V1\Processor

getProcessorType

Gets a processor type detail.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::getProcessorTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\GetProcessorTypeRequest 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\DocumentAI\V1\ProcessorType

getProcessorVersion

Gets a processor version detail.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::getProcessorVersionAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\GetProcessorVersionRequest 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\DocumentAI\V1\ProcessorVersion

listEvaluations

Retrieves a set of evaluations for a given processor version.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::listEvaluationsAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListEvaluationsRequest 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

listProcessorTypes

Lists the processor types that exist.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::listProcessorTypesAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListProcessorTypesRequest 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

listProcessorVersions

Lists all versions of a processor.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::listProcessorVersionsAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListProcessorVersionsRequest 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

listProcessors

Lists all processors which belong to this project.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::listProcessorsAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListProcessorsRequest 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

processDocument

Processes a single document.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::processDocumentAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ProcessRequest 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\DocumentAI\V1\ProcessResponse

reviewDocument

Send a document for Human Review. The input document should be processed by the specified processor.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::reviewDocumentAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ReviewDocumentRequest 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

setDefaultProcessorVersion

Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::setDefaultProcessorVersionAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\SetDefaultProcessorVersionRequest 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

trainProcessorVersion

Trains a new processor version.

Operation metadata is returned as TrainProcessorVersionMetadata.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::trainProcessorVersionAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest 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

undeployProcessorVersion

Undeploys the processor version.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::undeployProcessorVersionAsync() .

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\UndeployProcessorVersionRequest 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

getLocation

Gets information about a location.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::getLocationAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest 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\Location\Location

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\DocumentAI\V1\Client\BaseClient\self::listLocationsAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest 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

batchProcessDocumentsAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\BatchProcessRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createProcessorAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\CreateProcessorRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteProcessorAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DeleteProcessorRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteProcessorVersionAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DeleteProcessorVersionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deployProcessorVersionAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DeployProcessorVersionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

disableProcessorAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\DisableProcessorRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

enableProcessorAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\EnableProcessorRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

evaluateProcessorVersionAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\EvaluateProcessorVersionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

fetchProcessorTypesAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\FetchProcessorTypesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getEvaluationAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\GetEvaluationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getProcessorAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\GetProcessorRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getProcessorTypeAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\GetProcessorTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getProcessorVersionAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\GetProcessorVersionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listEvaluationsAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListEvaluationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listProcessorTypesAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListProcessorTypesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listProcessorVersionsAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListProcessorVersionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listProcessorsAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ListProcessorsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

processDocumentAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ProcessRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

reviewDocumentAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\ReviewDocumentRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setDefaultProcessorVersionAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\SetDefaultProcessorVersionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

trainProcessorVersionAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

undeployProcessorVersionAsync

Parameters
Name	Description
request	Google\Cloud\DocumentAI\V1\UndeployProcessorVersionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

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

static::evaluationName

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

Parameters
Name	Description
project	string
location	string
processor	string
processorVersion	string
evaluation	string

Returns
Type	Description
string	The formatted evaluation resource.

static::humanReviewConfigName

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

Parameters
Name	Description
project	string
location	string
processor	string

Returns
Type	Description
string	The formatted human_review_config resource.

static::locationName

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

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::processorName

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

Parameters
Name	Description
project	string
location	string
processor	string

Returns
Type	Description
string	The formatted processor resource.

static::processorTypeName

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

Parameters
Name	Description
project	string
location	string
processorType	string

Returns
Type	Description
string	The formatted processor_type resource.

static::processorVersionName

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

Parameters
Name	Description
project	string
location	string
processor	string
processorVersion	string

Returns
Type	Description
string	The formatted processor_version resource.

static::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

• evaluation: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}
• humanReviewConfig: projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig
• location: projects/{project}/locations/{location}
• processor: projects/{project}/locations/{location}/processors/{processor}
• processorType: projects/{project}/locations/{location}/processorTypes/{processor_type}
• processorVersion: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}

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.