# Google Cloud Ai Platform V1 Client - Class PredictionServiceClient (1.60.0)

1.60.0 (latest) 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.1 0.10.0 Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PredictionServiceClient.

Service Description: A service for online predictions and explanations.

This class provides the ability to make remote calls to the backing service through method
calls that map to API methods.

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.

## Namespace

Google \\ Cloud \\ AIPlatform \\ V1 \\ Client

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `options` | `array|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` 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` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important** : If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\AIPlatform\V1\PredictionServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new PredictionServiceClient(['credentials' => $creds]);` <https://cloud.google.com/docs/authentication/external/externally-sourced-credentials> |
| `↳ 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_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|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` 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](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_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. |
| `↳ logger` | `false|Psr\Log\LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
| `↳ universeDomain` | `string` The service domain for the client. Defaults to 'googleapis.com'. |

### directPredict

Perform an unary online prediction request to a gRPC model server for
Vertex first-party products and frameworks.

The async variant is [PredictionServiceClient::directPredictAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__directPredictAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectPredictRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectPredictResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\DirectPredictRequest;
    use Google\Cloud\AIPlatform\V1\DirectPredictResponse;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function direct_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new DirectPredictRequest())
            ->setEndpoint($formattedEndpoint);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        direct_predict_sample($formattedEndpoint);
    }

### directRawPredict

Perform an unary online prediction request to a gRPC model server for
custom containers.

The async variant is [PredictionServiceClient::directRawPredictAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__directRawPredictAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectRawPredictRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectRawPredictResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\DirectRawPredictRequest;
    use Google\Cloud\AIPlatform\V1\DirectRawPredictResponse;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function direct_raw_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new DirectRawPredictRequest())
            ->setEndpoint($formattedEndpoint);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        direct_raw_predict_sample($formattedEndpoint);
    }

### embedContent

Embed content with multimodal inputs.

The async variant is [PredictionServiceClient::embedContentAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__embedContentAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EmbedContentRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EmbedContentResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\EmbedContentRequest;
    use Google\Cloud\AIPlatform\V1\EmbedContentResponse;

    /**
     * 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 embed_content_sample(): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = new EmbedContentRequest();

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

### explain

Perform an online explanation.

If
[deployed_model_id](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.ExplainRequest#_Google_Cloud_AIPlatform_V1_ExplainRequest__getDeployedModelId__)
is specified, the corresponding DeployModel must have
[explanation_spec](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DeployedModel#_Google_Cloud_AIPlatform_V1_DeployedModel__getExplanationSpec__)
populated. If
[deployed_model_id](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.ExplainRequest#_Google_Cloud_AIPlatform_V1_ExplainRequest__getDeployedModelId__)
is not specified, all DeployedModels must have
[explanation_spec](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DeployedModel#_Google_Cloud_AIPlatform_V1_DeployedModel__getExplanationSpec__)
populated.

The async variant is [PredictionServiceClient::explainAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__explainAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.ExplainRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.ExplainResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\ExplainRequest;
    use Google\Cloud\AIPlatform\V1\ExplainResponse;
    use Google\Protobuf\Value;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the explanation.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function explain_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $instances = [new Value()];
        $request = (new ExplainRequest())
            ->setEndpoint($formattedEndpoint)
            ->setInstances($instances);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        explain_sample($formattedEndpoint);
    }

### generateContent

Generate content with multimodal inputs.

The async variant is [PredictionServiceClient::generateContentAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__generateContentAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Google\Cloud\AIPlatform\V1\GenerateContentRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.GenerateContentResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\Content;
    use Google\Cloud\AIPlatform\V1\GenerateContentRequest;
    use Google\Cloud\AIPlatform\V1\GenerateContentResponse;
    use Google\Cloud\AIPlatform\V1\Part;

    /**
     * @param string $model The fully qualified name of the publisher model or tuned model
     *                      endpoint to use.
     *
     *                      Publisher model format:
     *                      `projects/{project}/locations/{location}/publishers/&#42;/models/*`
     *
     *                      Tuned model endpoint format:
     *                      `projects/{project}/locations/{location}/endpoints/{endpoint}`
     */
    function generate_content_sample(string $model): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $contentsParts = [new Part()];
        $content = (new Content())
            ->setParts($contentsParts);
        $contents = [$content,];
        $request = (new GenerateContentRequest())
            ->setModel($model)
            ->setContents($contents);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $model = '[MODEL]';

        generate_content_sample($model);
    }

### predict

Perform an online prediction.

The async variant is [PredictionServiceClient::predictAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__predictAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.PredictRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.PredictResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\PredictRequest;
    use Google\Cloud\AIPlatform\V1\PredictResponse;
    use Google\Protobuf\Value;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $instances = [new Value()];
        $request = (new PredictRequest())
            ->setEndpoint($formattedEndpoint)
            ->setInstances($instances);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        predict_sample($formattedEndpoint);
    }

### rawPredict

Perform an online prediction with an arbitrary HTTP payload.

The response includes the following HTTP headers:

- `X-Vertex-AI-Endpoint-Id`: ID of the
  [Endpoint](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Endpoint) that served this
  prediction.

- `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
  [DeployedModel](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DeployedModel) that served this
  prediction.

The async variant is [PredictionServiceClient::rawPredictAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__rawPredictAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.RawPredictRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Api.HttpBody.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Api\HttpBody;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\RawPredictRequest;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function raw_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new RawPredictRequest())
            ->setEndpoint($formattedEndpoint);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        raw_predict_sample($formattedEndpoint);
    }

### serverStreamingPredict

Perform a server-side streaming online prediction request for Vertex
LLM streaming.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.StreamingPredictRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/ServerStream.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.StreamingPredictResponse>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\ServerStream;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\StreamingPredictRequest;
    use Google\Cloud\AIPlatform\V1\StreamingPredictResponse;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function server_streaming_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new StreamingPredictRequest())
            ->setEndpoint($formattedEndpoint);

        // Call the API and handle any network failures.
        try {
            /** @var ServerStream $stream */
            $stream = $predictionServiceClient->serverStreamingPredict($request);

            /** @var StreamingPredictResponse $element */
            foreach ($stream->readAll() as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        server_streaming_predict_sample($formattedEndpoint);
    }

### streamDirectPredict

Perform a streaming online prediction request to a gRPC model server for
Vertex first-party products and frameworks.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/BidiStream.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\BidiStream;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\StreamDirectPredictRequest;
    use Google\Cloud\AIPlatform\V1\StreamDirectPredictResponse;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function stream_direct_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new StreamDirectPredictRequest())
            ->setEndpoint($formattedEndpoint);

        // Call the API and handle any network failures.
        try {
            /** @var BidiStream $stream */
            $stream = $predictionServiceClient->streamDirectPredict();
            $stream->writeAll([$request,]);

            /** @var StreamDirectPredictResponse $element */
            foreach ($stream->closeWriteAndReadAll() as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        stream_direct_predict_sample($formattedEndpoint);
    }

### streamDirectRawPredict

Perform a streaming online prediction request to a gRPC model server for
custom containers.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/BidiStream.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\BidiStream;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\StreamDirectRawPredictRequest;
    use Google\Cloud\AIPlatform\V1\StreamDirectRawPredictResponse;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function stream_direct_raw_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new StreamDirectRawPredictRequest())
            ->setEndpoint($formattedEndpoint);

        // Call the API and handle any network failures.
        try {
            /** @var BidiStream $stream */
            $stream = $predictionServiceClient->streamDirectRawPredict();
            $stream->writeAll([$request,]);

            /** @var StreamDirectRawPredictResponse $element */
            foreach ($stream->closeWriteAndReadAll() as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        stream_direct_raw_predict_sample($formattedEndpoint);
    }

### streamGenerateContent

Generate content with multimodal inputs with streaming support.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Google\Cloud\AIPlatform\V1\GenerateContentRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/ServerStream.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.GenerateContentResponse>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\ServerStream;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\Content;
    use Google\Cloud\AIPlatform\V1\GenerateContentRequest;
    use Google\Cloud\AIPlatform\V1\GenerateContentResponse;
    use Google\Cloud\AIPlatform\V1\Part;

    /**
     * @param string $model The fully qualified name of the publisher model or tuned model
     *                      endpoint to use.
     *
     *                      Publisher model format:
     *                      `projects/{project}/locations/{location}/publishers/&#42;/models/*`
     *
     *                      Tuned model endpoint format:
     *                      `projects/{project}/locations/{location}/endpoints/{endpoint}`
     */
    function stream_generate_content_sample(string $model): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $contentsParts = [new Part()];
        $content = (new Content())
            ->setParts($contentsParts);
        $contents = [$content,];
        $request = (new GenerateContentRequest())
            ->setModel($model)
            ->setContents($contents);

        // Call the API and handle any network failures.
        try {
            /** @var ServerStream $stream */
            $stream = $predictionServiceClient->streamGenerateContent($request);

            /** @var GenerateContentResponse $element */
            foreach ($stream->readAll() as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $model = '[MODEL]';

        stream_generate_content_sample($model);
    }

### streamRawPredict

Perform a streaming online prediction with an arbitrary HTTP payload.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.StreamRawPredictRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/ServerStream.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Api.HttpBody.html>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\ServerStream;
    use Google\Api\HttpBody;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\StreamRawPredictRequest;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function stream_raw_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new StreamRawPredictRequest())
            ->setEndpoint($formattedEndpoint);

        // Call the API and handle any network failures.
        try {
            /** @var ServerStream $stream */
            $stream = $predictionServiceClient->streamRawPredict($request);

            /** @var HttpBody $element */
            foreach ($stream->readAll() as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        stream_raw_predict_sample($formattedEndpoint);
    }

### streamingPredict

Perform a streaming online prediction request for Vertex first-party
products and frameworks.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/BidiStream.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\BidiStream;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\StreamingPredictRequest;
    use Google\Cloud\AIPlatform\V1\StreamingPredictResponse;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function streaming_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new StreamingPredictRequest())
            ->setEndpoint($formattedEndpoint);

        // Call the API and handle any network failures.
        try {
            /** @var BidiStream $stream */
            $stream = $predictionServiceClient->streamingPredict();
            $stream->writeAll([$request,]);

            /** @var StreamingPredictResponse $element */
            foreach ($stream->closeWriteAndReadAll() as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        streaming_predict_sample($formattedEndpoint);
    }

### streamingRawPredict

Perform a streaming online prediction request through gRPC.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/BidiStream.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\BidiStream;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\AIPlatform\V1\StreamingRawPredictRequest;
    use Google\Cloud\AIPlatform\V1\StreamingRawPredictResponse;

    /**
     * @param string $formattedEndpoint The name of the Endpoint requested to serve the prediction.
     *                                  Format:
     *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
     *                                  Please see {@see PredictionServiceClient::endpointName()} for help formatting this field.
     */
    function streaming_raw_predict_sample(string $formattedEndpoint): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new StreamingRawPredictRequest())
            ->setEndpoint($formattedEndpoint);

        // Call the API and handle any network failures.
        try {
            /** @var BidiStream $stream */
            $stream = $predictionServiceClient->streamingRawPredict();
            $stream->writeAll([$request,]);

            /** @var StreamingRawPredictResponse $element */
            foreach ($stream->closeWriteAndReadAll() as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $formattedEndpoint = PredictionServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

        streaming_raw_predict_sample($formattedEndpoint);
    }

### getLocation

Gets information about a location.

The async variant is [PredictionServiceClient::getLocationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__getLocationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.GetLocationRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\Location\GetLocationRequest;
    use Google\Cloud\Location\Location;

    /**
     * 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 get_location_sample(): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = new GetLocationRequest();

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

### listLocations

Lists information about the supported locations for this service.

The async variant is [PredictionServiceClient::listLocationsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__listLocationsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.ListLocationsRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\Location\ListLocationsRequest;
    use Google\Cloud\Location\Location;

    /**
     * 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 list_locations_sample(): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = new ListLocationsRequest();

        // Call the API and handle any network failures.
        try {
            /** @var PagedListResponse $response */
            $response = $predictionServiceClient->listLocations($request);

            /** @var Location $element */
            foreach ($response as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

### getIamPolicy

Gets the access control policy for a resource. Returns an empty policy
if the resource exists and does not have a policy set.

The async variant is [PredictionServiceClient::getIamPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__getIamPolicyAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.GetIamPolicyRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\Iam\V1\GetIamPolicyRequest;
    use Google\Cloud\Iam\V1\Policy;

    /**
     * @param string $resource REQUIRED: The resource for which the policy is being requested.
     *                         See the operation documentation for the appropriate value for this field.
     */
    function get_iam_policy_sample(string $resource): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $request = (new GetIamPolicyRequest())
            ->setResource($resource);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $resource = '[RESOURCE]';

        get_iam_policy_sample($resource);
    }

### setIamPolicy

Sets the access control policy on the specified resource. Replaces
any existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
errors.

The async variant is [PredictionServiceClient::setIamPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__setIamPolicyAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.SetIamPolicyRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\Iam\V1\Policy;
    use Google\Cloud\Iam\V1\SetIamPolicyRequest;

    /**
     * @param string $resource REQUIRED: The resource for which the policy is being specified.
     *                         See the operation documentation for the appropriate value for this field.
     */
    function set_iam_policy_sample(string $resource): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $policy = new Policy();
        $request = (new SetIamPolicyRequest())
            ->setResource($resource)
            ->setPolicy($policy);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $resource = '[RESOURCE]';

        set_iam_policy_sample($resource);
    }

### testIamPermissions

Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.

The async variant is [PredictionServiceClient::testIamPermissionsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.PredictionServiceClient#_Google_Cloud_AIPlatform_V1_Client_PredictionServiceClient__testIamPermissionsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\AIPlatform\V1\Client\PredictionServiceClient;
    use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
    use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

    /**
     * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
     *                                   See the operation documentation for the appropriate value for this field.
     * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
     *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
     *                                   information see
     *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
     */
    function test_iam_permissions_sample(string $resource, string $permissionsElement): void
    {
        // Create a client.
        $predictionServiceClient = new PredictionServiceClient();

        // Prepare the request message.
        $permissions = [$permissionsElement,];
        $request = (new TestIamPermissionsRequest())
            ->setResource($resource)
            ->setPermissions($permissions);

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

    /**
     * Helper to execute the sample.
     *
     * 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 callSample(): void
    {
        $resource = '[RESOURCE]';
        $permissionsElement = '[PERMISSIONS]';

        test_iam_permissions_sample($resource, $permissionsElement);
    }

### directPredictAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectPredictRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectPredictResponse>` |   |

### directRawPredictAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectRawPredictRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.DirectRawPredictResponse>` |   |

### embedContentAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EmbedContentRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EmbedContentResponse>` |   |

### explainAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.ExplainRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.ExplainResponse>` |   |

### generateContentAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Google\Cloud\AIPlatform\V1\GenerateContentRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.GenerateContentResponse>` |   |

### predictAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.PredictRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.PredictResponse>` |   |

### rawPredictAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.RawPredictRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Api.HttpBody.html>` |   |

### getLocationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.GetLocationRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html>` |   |

### listLocationsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.ListLocationsRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### getIamPolicyAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.GetIamPolicyRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html>` |   |

### setIamPolicyAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.SetIamPolicyRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html>` |   |

### testIamPermissionsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsResponse.html>` |   |

### static::cachedContentName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `cachedContent` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted cached_content resource. |

### static::endpointName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `endpoint` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted endpoint resource. |

### static::projectLocationEndpointName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `endpoint` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted project_location_endpoint resource. |

### static::projectLocationPublisherModelName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `publisher` | `string` |
| `model` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted project_location_publisher_model resource. |

### static::ragCorpusName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `ragCorpus` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted rag_corpus resource. |

### static::templateName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `template` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted template 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

- cachedContent: projects/{project}/locations/{location}/cachedContents/{cached_content}
- endpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
- projectLocationEndpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
- projectLocationPublisherModel: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}
- ragCorpus: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
- template: projects/{project}/locations/{location}/templates/{template}

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