[Platform][VertexAI] Add support for API key authentication

docs/bundles/ai-bundle.rst

@@ -62,6 +62,7 @@ Advanced Example with Multiple Agents
             vertexai:
                 location: '%env(GOOGLE_CLOUD_LOCATION)%'
                 project_id: '%env(GOOGLE_CLOUD_PROJECT)%'
+                api_key: '%env(GOOGLE_CLOUD_VERTEX_API_KEY)%' # Only needed if authenticating with API keys
             ollama:
                 host_url: '%env(OLLAMA_HOST_URL)%'
         agent:

docs/components/platform/vertexai.rst

@@ -21,12 +21,12 @@ Setup
 Authentication
 ~~~~~~~~~~~~~~
 
-Vertex AI requires Google Cloud authentication. Follow the `Google cloud authentication guide`_ to set up your credentials.
+Vertex AI supports the following authentication methods:
 
-You can authenticate using:
+1. Application Default Credentials (ADC)
+----------------------------------------
 
-1. **Application Default Credentials (ADC)** - Recommended for production
-2. **Service Account Key** - For development or specific service accounts
+Follow the `Google cloud authentication guide`_ to set up your credentials.
 
 For ADC, install the Google Cloud SDK and authenticate:
 
@@ -36,18 +36,13 @@ For ADC, install the Google Cloud SDK and authenticate:
 
 For detailed authentication setup, see `Setting up authentication for Vertex AI`_.
 
-Environment Variables
-~~~~~~~~~~~~~~~~~~~~~
-
 Configure your Google Cloud project and location:
 
 .. code-block:: bash
 
     GOOGLE_CLOUD_PROJECT=your-project-id
     GOOGLE_CLOUD_LOCATION=us-central1
 
-Usage
------
 
 Basic usage example::
 
@@ -59,7 +54,7 @@ Basic usage example::
     $platform = PlatformFactory::create(
         $_ENV['GOOGLE_CLOUD_LOCATION'],
         $_ENV['GOOGLE_CLOUD_PROJECT'],
-        $httpClient
+        httpClient: $httpClient
     );
 
     $messages = new MessageBag(
@@ -69,6 +64,28 @@ Basic usage example::
     $result = $platform->invoke('gemini-2.5-flash', $messages);
     echo $result->getContent();
 
+2. Service Account Key
+----------------------
+
+Similar to the first approach, but instead of authenticating with the `gcloud` command, you provide the service account key directly using an environment variable:
+
+.. code-block:: bash
+
+    GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account-key.json"
+
+3. API Key
+----------
+
+Similar to the first approach, but instead of authenticating with the `gcloud` command, you provide the API keys when creating the platform::
+
+    $platform = PlatformFactory::create(
+        $_ENV['GOOGLE_CLOUD_LOCATION'],
+        $_ENV['GOOGLE_CLOUD_PROJECT'],
+        apiKey: $_ENV['GOOGLE_CLOUD_VERTEX_API_KEY'],
+    );
+
+To get an API key, visit: `Vertex AI Studio (API keys)`_.
+
 Model Availability by Location
 ------------------------------
 
@@ -164,3 +181,4 @@ See the ``examples/vertexai/`` directory for complete working examples:
 .. _Google cloud authentication guide: https://cloud.google.com/docs/authentication
 .. _Setting up authentication for Vertex AI: https://cloud.google.com/vertex-ai/docs/authentication
 .. _Google Cloud Console for Vertex AI: https://console.cloud.google.com/vertex-ai
+.. _Vertex AI Studio (API keys): https://console.cloud.google.com/vertex-ai/studio/settings/api-keys

examples/.env

@@ -98,6 +98,7 @@ AIMLAPI_API_KEY=
 # Vertex AI
 GOOGLE_CLOUD_LOCATION=global
 GOOGLE_CLOUD_PROJECT=GOOGLE_CLOUD_PROJECT
+GOOGLE_CLOUD_VERTEX_API_KEY=
 
 # For using Albert API (French Sovereign AI)
 ALBERT_API_KEY=

examples/vertexai/audio-input.php

@@ -16,7 +16,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $messages = new MessageBag(
     Message::ofUser(

examples/vertexai/chat-with-api-key.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\AI\Platform\Bridge\VertexAi\PlatformFactory;
+use Symfony\AI\Platform\Message\Message;
+use Symfony\AI\Platform\Message\MessageBag;
+
+require_once __DIR__.'/bootstrap.php';
+
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), env('GOOGLE_CLOUD_VERTEX_API_KEY'));
+
+$messages = new MessageBag(
+    Message::forSystem('You are an expert assistant in geography.'),
+    Message::ofUser('Where is Mount Fuji?'),
+);
+$result = $platform->invoke('gemini-2.5-flash', $messages);
+
+echo $result->asText().\PHP_EOL;

examples/vertexai/chat.php

@@ -15,7 +15,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $messages = new MessageBag(
     Message::forSystem('You are an expert assistant in geography.'),

examples/vertexai/embeddings.php

@@ -13,7 +13,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $result = $platform->invoke('gemini-embedding-001', <<<TEXT
     Once upon a time, there was a country called Japan. It was a beautiful country with a lot of mountains and rivers.

examples/vertexai/image-input.php

@@ -16,7 +16,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $messages = new MessageBag(
     Message::forSystem('You are an image analyzer bot that helps identify the content of images.'),

examples/vertexai/pdf-input-binary.php

@@ -16,7 +16,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $messages = new MessageBag(
     Message::ofUser(

examples/vertexai/server-tools.php

@@ -15,7 +15,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $messages = new MessageBag(
     Message::ofUser(

examples/vertexai/stream.php

@@ -15,7 +15,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $messages = new MessageBag(
     Message::forSystem('You are an expert assistant in geography.'),

examples/vertexai/structured-output-clock.php

@@ -25,7 +25,7 @@
 $dispatcher = new EventDispatcher();
 $dispatcher->addSubscriber(new PlatformSubscriber());
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client(), eventDispatcher: $dispatcher);
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client(), eventDispatcher: $dispatcher);
 
 $clock = new Clock(new SymfonyClock());
 $toolbox = new Toolbox([$clock], logger: logger());

examples/vertexai/structured-output-math.php

@@ -21,7 +21,7 @@
 $dispatcher = new EventDispatcher();
 $dispatcher->addSubscriber(new PlatformSubscriber());
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client(), eventDispatcher: $dispatcher);
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client(), eventDispatcher: $dispatcher);
 $messages = new MessageBag(
     Message::forSystem('You are a helpful math tutor. Guide the user through the solution step by step.'),
     Message::ofUser('how can I solve 8x + 7 = -23'),

examples/vertexai/token-metadata.php

@@ -16,7 +16,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $agent = new Agent($platform, 'gemini-2.0-flash-lite');
 $messages = new MessageBag(

examples/vertexai/toolcall.php

@@ -19,7 +19,7 @@
 
 require_once __DIR__.'/bootstrap.php';
 
-$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), adc_aware_http_client());
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), httpClient: adc_aware_http_client());
 
 $toolbox = new Toolbox([new Clock()], logger: logger());
 $processor = new AgentProcessor($toolbox);

src/ai-bundle/config/options.php

@@ -157,6 +157,7 @@
                         ->children()
                             ->stringNode('location')->isRequired()->end()
                             ->stringNode('project_id')->isRequired()->end()
+                            ->stringNode('api_key')->defaultNull()->end()
                         ->end()
                     ->end()
                     ->arrayNode('openai')

src/ai-bundle/src/AiBundle.php

@@ -624,6 +624,7 @@ private function processPlatformConfig(string $type, array $platform, ContainerB
                 ->setArguments([
                     $platform['location'],
                     $platform['project_id'],
+                    $platform['api_key'] ?? null,
                     $httpClient,
                     new Reference('ai.platform.model_catalog.vertexai.gemini'),
                     new Reference('ai.platform.contract.vertexai.gemini'),

src/ai-bundle/tests/DependencyInjection/AiBundleTest.php

@@ -92,9 +92,9 @@ public function testExtensionLoadDoesNotThrow()
     {
         $container = $this->buildContainer($this->getFullConfig());
 
-        // Mock services that are used as platform create arguments, but should not be testet here or are not available.
+        // Mock services that are used as platform create arguments, but should not be tested here or are not available.
         $container->set('event_dispatcher', $this->createMock(EventDispatcherInterface::class));
-        $container->getDefinition('ai.platform.vertexai')->replaceArgument(2, $this->createMock(HttpClientInterface::class));
+        $container->getDefinition('ai.platform.vertexai')->replaceArgument(3, $this->createMock(HttpClientInterface::class));
 
         $platforms = $container->findTaggedServiceIds('ai.platform');
 
@@ -7023,6 +7023,7 @@ private function getFullConfig(): array
                     'vertexai' => [
                         'location' => 'global',
                         'project_id' => '123',
+                        'api_key' => 'vertex_key_full',
                     ],
                     'dockermodelrunner' => [
                         'host_url' => 'http://127.0.0.1:12434',

src/platform/src/Bridge/VertexAi/Embeddings/ModelClient.php

@@ -26,6 +26,7 @@ public function __construct(
         private readonly HttpClientInterface $httpClient,
         private readonly string $location,
         private readonly string $projectId,
+        #[\SensitiveParameter] private readonly ?string $apiKey = null,
     ) {
     }
 
@@ -47,6 +48,11 @@ public function request(BaseModel $model, array|string $payload, array $options
             'predict',
         );
 
+        $query = [];
+        if (null !== $this->apiKey) {
+            $query['key'] = $this->apiKey;
+        }
+
         $modelOptions = $model->getOptions();
 
         $payload = [
@@ -71,6 +77,7 @@ public function request(BaseModel $model, array|string $payload, array $options
                         'Content-Type' => 'application/json',
                     ],
                     'json' => array_merge($payload, $modelOptions),
+                    'query' => $query,
                 ]
             )
         );

src/platform/src/Bridge/VertexAi/Gemini/ModelClient.php

@@ -30,6 +30,7 @@ public function __construct(
         HttpClientInterface $httpClient,
         private readonly string $location,
         private readonly string $projectId,
+        #[\SensitiveParameter] private readonly ?string $apiKey = null,
     ) {
         $this->httpClient = $httpClient instanceof EventSourceHttpClient ? $httpClient : new EventSourceHttpClient($httpClient);
     }
@@ -52,6 +53,11 @@ public function request(BaseModel $model, array|string $payload, array $options
             $options['stream'] ?? false ? 'streamGenerateContent' : 'generateContent',
         );
 
+        $query = [];
+        if (null !== $this->apiKey) {
+            $query['key'] = $this->apiKey;
+        }
+
         if (isset($options[PlatformSubscriber::RESPONSE_FORMAT]['json_schema']['schema'])) {
             $options['generationConfig']['responseMimeType'] = 'application/json';
             $options['generationConfig']['responseSchema'] = $options[PlatformSubscriber::RESPONSE_FORMAT]['json_schema']['schema'];
@@ -107,6 +113,7 @@ public function request(BaseModel $model, array|string $payload, array $options
                 $url,
                 [
                     'json' => array_merge($options, $payload),
+                    'query' => $query,
                 ]
             )
         );

src/platform/src/Bridge/VertexAi/PlatformFactory.php

@@ -33,6 +33,7 @@ final class PlatformFactory
     public static function create(
         string $location,
         string $projectId,
+        #[\SensitiveParameter] ?string $apiKey = null,
         ?HttpClientInterface $httpClient = null,
         ModelCatalogInterface $modelCatalog = new ModelCatalog(),
         ?Contract $contract = null,
@@ -45,7 +46,7 @@ public static function create(
         $httpClient = $httpClient instanceof EventSourceHttpClient ? $httpClient : new EventSourceHttpClient($httpClient);
 
         return new Platform(
-            [new GeminiModelClient($httpClient, $location, $projectId), new EmbeddingsModelClient($httpClient, $location, $projectId)],
+            [new GeminiModelClient($httpClient, $location, $projectId, $apiKey), new EmbeddingsModelClient($httpClient, $location, $projectId, $apiKey)],
             [new GeminiResultConverter(), new EmbeddingsResultConverter()],
             $modelCatalog,
             $contract ?? GeminiContract::create(),