Cloud Vision V1 Client - Class ImageAnnotatorClient (1.6.8)

Reference documentation and code samples for the Cloud Vision V1 Client class ImageAnnotatorClient.

Service Description: Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$imageAnnotatorClient = new ImageAnnotatorClient();
try {
    $requests = [];
    $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $imageAnnotatorClient->resumeOperation($operationName, 'asyncBatchAnnotateFiles');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $imageAnnotatorClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Methods

createImageObject

Creates an Image object that can be used as part of an image annotation request.

Example:

$imageResource = fopen('path/to/image.jpg', 'r');
$image = $imageAnnotatorClient->createImageObject($imageResource);
$response = $imageAnnotatorClient->faceDetection($image);
$imageData = file_get_contents('path/to/image.jpg');
$image = $imageAnnotatorClient->createImageObject($imageData);
$response = $imageAnnotatorClient->faceDetection($image);
$imageUri = "gs://my-bucket/image.jpg";
$image = $imageAnnotatorClient->createImageObject($imageUri);
$response = $imageAnnotatorClient->faceDetection($image);
Parameter
NameDescription
imageInput resource|string

An image to configure with the given settings. This parameter will accept a resource, a string of bytes, or the URI of an image in a publicly-accessible web location.

Returns
TypeDescription
Google\Cloud\Vision\V1\Image

annotateImage

Run image detection and annotation for an image.

Example:

use Google\Cloud\Vision\V1\Feature;
use Google\Cloud\Vision\V1\Feature\Type;

$imageResource = fopen('path/to/image.jpg', 'r');
$features = [Type::FACE_DETECTION];
$response = $imageAnnotatorClient->annotateImage($imageResource, $features);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

features array<Google\Cloud\Vision\V1\Feature>|int[]

Requested features.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

faceDetection

Run face detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->faceDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

landmarkDetection

Run landmark detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->landmarkDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

logoDetection

Run logo detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->logoDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

labelDetection

Run label detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->labelDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

textDetection

Run text detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->textDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

documentTextDetection

Run document text detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->documentTextDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

safeSearchDetection

Run safe search detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->safeSearchDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

imagePropertiesDetection

Run image properties detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->imagePropertiesDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

cropHintsDetection

Run crop hints detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->cropHintsDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

webDetection

Run web detection for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->webDetection($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

objectLocalization

Run object localization for an image.

Example:

$imageContent = file_get_contents('path/to/image.jpg');
$response = $imageAnnotatorClient->objectLocalization($imageContent);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

productSearch

Run product search for an image.

Example:

use Google\Cloud\Vision\V1\ProductSearchClient;
use Google\Cloud\Vision\V1\ProductSearchParams;

$imageContent = file_get_contents('path/to/image.jpg');
$productSetName = ProductSearchClient::productSetName('PROJECT_ID', 'LOC_ID', 'PRODUCT_SET_ID');
$productSearchParams = (new ProductSearchParams)
    ->setProductSet($productSetName);
$response = $imageAnnotatorClient->productSearch(
    $imageContent,
    $productSearchParams
);
Parameters
NameDescription
image resource|string|Google\Cloud\Vision\V1\Image

The image to be processed.

productSearchParams Google\Cloud\Vision\V1\ProductSearchParams

Parameters for a product search request. Please note, this value will override the {@see \Google\Cloud\Vision\V1\ProductSearchParams} in the {@see \Google\Cloud\Vision\V1\ImageContext} instance if provided.

optionalArgs array

Configuration Options.

↳ imageContext ImageContext

Additional context that may accompany the image.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\AnnotateImageResponse

productSetName

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

Parameters
NameDescription
project string
location string
productSet string
Returns
TypeDescription
stringThe formatted product_set 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

  • productSet: projects/{project}/locations/{location}/productSets/{product_set}

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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

getOperationsClient

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

Returns
TypeDescription
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
NameDescription
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse

__construct

Constructor.

Parameters
NameDescription
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.

asyncBatchAnnotateFiles

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface.

Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

Parameters
NameDescription
requests array<Google\Cloud\Vision\V1\AsyncAnnotateFileRequest>

Required. Individual async file annotation requests for this batch.

optionalArgs array

Optional.

↳ parent string

Optional. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no parent is specified, a region will be chosen automatically. Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union. Example: projects/project-A/locations/eu.

↳ 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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Vision\V1\AsyncAnnotateFileRequest;
use Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse;
use Google\Cloud\Vision\V1\ImageAnnotatorClient;
use Google\Rpc\Status;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function async_batch_annotate_files_sample(): void
{
    // Create a client.
    $imageAnnotatorClient = new ImageAnnotatorClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $requests = [new AsyncAnnotateFileRequest()];

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AsyncBatchAnnotateFilesResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

asyncBatchAnnotateImages

Run asynchronous image detection and annotation for a list of images.

Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateImagesResponse (results).

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Parameters
NameDescription
requests array<Google\Cloud\Vision\V1\AnnotateImageRequest>

Required. Individual image annotation requests for this batch.

outputConfig Google\Cloud\Vision\V1\OutputConfig

Required. The desired output location and metadata (e.g. format).

optionalArgs array

Optional.

↳ parent string

Optional. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no parent is specified, a region will be chosen automatically. Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union. Example: projects/project-A/locations/eu.

↳ 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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Vision\V1\AnnotateImageRequest;
use Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse;
use Google\Cloud\Vision\V1\ImageAnnotatorClient;
use Google\Cloud\Vision\V1\OutputConfig;
use Google\Rpc\Status;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function async_batch_annotate_images_sample(): void
{
    // Create a client.
    $imageAnnotatorClient = new ImageAnnotatorClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $requests = [new AnnotateImageRequest()];
    $outputConfig = new OutputConfig();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $imageAnnotatorClient->asyncBatchAnnotateImages($requests, $outputConfig);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AsyncBatchAnnotateImagesResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

batchAnnotateFiles

Service that performs image detection and annotation for a batch of files.

Now only "application/pdf", "image/tiff" and "image/gif" are supported.

This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

Parameters
NameDescription
requests array<Google\Cloud\Vision\V1\AnnotateFileRequest>

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

optionalArgs array

Optional.

↳ parent string

Optional. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no parent is specified, a region will be chosen automatically. Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union. Example: projects/project-A/locations/eu.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\BatchAnnotateFilesResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Vision\V1\AnnotateFileRequest;
use Google\Cloud\Vision\V1\BatchAnnotateFilesResponse;
use Google\Cloud\Vision\V1\ImageAnnotatorClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function batch_annotate_files_sample(): void
{
    // Create a client.
    $imageAnnotatorClient = new ImageAnnotatorClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $requests = [new AnnotateFileRequest()];

    // Call the API and handle any network failures.
    try {
        /** @var BatchAnnotateFilesResponse $response */
        $response = $imageAnnotatorClient->batchAnnotateFiles($requests);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

batchAnnotateImages

Run image detection and annotation for a batch of images.

Parameters
NameDescription
requests array<Google\Cloud\Vision\V1\AnnotateImageRequest>

Required. Individual image annotation requests for this batch.

optionalArgs array

Optional.

↳ parent string

Optional. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no parent is specified, a region will be chosen automatically. Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union. Example: projects/project-A/locations/eu.

↳ 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
TypeDescription
Google\Cloud\Vision\V1\BatchAnnotateImagesResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Vision\V1\AnnotateImageRequest;
use Google\Cloud\Vision\V1\BatchAnnotateImagesResponse;
use Google\Cloud\Vision\V1\ImageAnnotatorClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function batch_annotate_images_sample(): void
{
    // Create a client.
    $imageAnnotatorClient = new ImageAnnotatorClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $requests = [new AnnotateImageRequest()];

    // Call the API and handle any network failures.
    try {
        /** @var BatchAnnotateImagesResponse $response */
        $response = $imageAnnotatorClient->batchAnnotateImages($requests);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

Constants

SERVICE_NAME

Value: 'google.cloud.vision.v1.ImageAnnotator'

The name of the service.

SERVICE_ADDRESS

Value: 'vision.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.