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

nicodemuz · 2025-12-15T17:24:05Z

Q	A
Bug fix?	no
New feature?	yes
Docs?	need to be updated
License	MIT

Vertex AI supports multiple methods of authentication. This PR adds support for API keys.

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

OskarStark · 2025-12-15T17:37:41Z

Please add tests

nicodemuz · 2025-12-15T19:58:49Z

Please add tests

Sure. Before I spend more time on tests, can you review that the approach/solution is correct? I'm relatively new to the symfony/ai project and not sure how other Bridges handle this.

OskarStark

Looks good to me. WDYT @chr-hertel ?

@nicodemuz can you please check if it is also supported for Gemini. This should also be configurable via the AiBundle config

nicodemuz · 2025-12-15T21:13:09Z

Looks good to me. WDYT @chr-hertel ?

@nicodemuz can you please check if it is also supported for Gemini. This should also be configurable via the AiBundle config

@OskarStark You mean to configure whether the key should be sent via a query parameter or the headers? For Gemini, I think the API key is sent via HTTP headers:

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

Lines 81 to 86 in 5b89765

    
           return new RawHttpResult($this->httpClient->request('POST', $url, [ 
        
               'headers' => [ 
        
                   'x-goog-api-key' => $this->apiKey, 
        
               ], 
        
               'json' => array_merge($generationConfig, $payload), 
        
           ]));

OskarStark · 2025-12-16T06:40:18Z

@OskarStark You mean to configure whether the key should be sent via a query parameter or the headers? For Gemini, I think the API key is sent via HTTP headers:

Thanks for double checking

OskarStark · 2025-12-18T21:16:59Z

docs/components/platform/vertexai.rst

+========================================
+1. Application Default Credentials (ADC)
+========================================


Suggested change

========================================

1. Application Default Credentials (ADC)

========================================

Application Default Credentials (ADC)

-------------------------------------

Same for the other headlines

I have updated the headings as per your suggestion. I was trying to make these headings as subheadings of "Authentication", but now they became top level headings:

nicodemuz · 2025-12-18T21:17:09Z

Please add tests

@OskarStark I'm trying to fix the tests, and there's one test failing with:

1) Symfony\AI\AiBundle\Tests\DependencyInjection\AiBundleTest::testExtensionLoadDoesNotThrow
Failed to load platform service "ai.platform.vertexai" or call getModelCatalog(). Original error: Symfony\AI\Platform\Bridge\VertexAi\PlatformFactory::create(): Argument #3 ($httpClient) must be of type ?Symfony\Contracts\HttpClient\HttpClientInterface, string given, called in /home/runner/work/ai/ai/src/ai-bundle/vendor/symfony/dependency-injection/ContainerBuilder.php on line 1178 (in /home/runner/work/ai/ai/src/ai-bundle/vendor/symfony/ai-vertex-ai-platform/PlatformFactory.php:33)

/home/runner/work/ai/ai/src/ai-bundle/tests/DependencyInjection/AiBundleTest.php:123

Is it trying to run code from some other repo/branch? Since it's referring to ai-vertex-ai-platform/PlatformFactory.php:33? How do I fix this?

examples/.env

examples/vertexai/chat.php

OskarStark · 2025-12-18T21:20:31Z

Tests still needed

Co-authored-by: Oskar Stark <[email protected]>

OskarStark · 2025-12-18T21:41:29Z

examples/.env

 # Vertex AI
 GOOGLE_CLOUD_LOCATION=global
 GOOGLE_CLOUD_PROJECT=GOOGLE_CLOUD_PROJECT
+GOOGLE_CLOUD_VERTEX_API_KEY=


Suggested change

GOOGLE_CLOUD_VERTEX_API_KEY=

GOOGLE_CLOUD_API_KEY=

in the whole PR

Doesn't google cloud have hundreds of APIs that can be accessed with a product specific API key? This API key is for the key that can be created at https://console.cloud.google.com/vertex-ai/studio/settings/api-keys

Hmm you might be right 🤔

OskarStark · 2025-12-18T21:42:03Z

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

+
+require_once __DIR__.'/bootstrap.php';
+
+$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), env('GOOGLE_CLOUD_VERTEX_API_KEY'), httpClient: adc_aware_http_client());


but this still uses the adc_aware_http_client

Good catch. Fixed! 👍

OskarStark · 2025-12-19T05:30:10Z

It looks like your committer email is not associated with your GitHub account

OskarStark

.

OskarStark · 2025-12-19T05:28:32Z

examples/.env

 # Vertex AI
 GOOGLE_CLOUD_LOCATION=global
 GOOGLE_CLOUD_PROJECT=GOOGLE_CLOUD_PROJECT
+GOOGLE_CLOUD_VERTEX_API_KEY=


Hmm you might be right 🤔

chr-hertel · 2025-12-19T11:28:32Z

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

+        if (null !== $this->apiKey) {
+            $url .= '?key='.$this->apiKey;
+        }


not a big fan of string-based concatenation when it comes to ? and & - might be brittle when extending later
can we use the query part of the HttpClient's request method here?

chr-hertel · 2025-12-19T11:28:47Z

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

+        if (null !== $this->apiKey) {
+            $url .= '?key='.$this->apiKey;
+        }


same as above

chr-hertel

Yes, we def need this - thanks @nicodemuz!

only minor comments but broken pipeline

nicodemuz · 2025-12-19T11:31:57Z

Yes, we def need this - thanks @nicodemuz!

only minor comments but broken pipeline

Any ideas about the broken pipeline? See my comment here:

#1139 (comment)

nicodemuz · 2025-12-19T18:31:35Z

It looks like your committer email is not associated with your GitHub account

Will this prevent from the PR getting merged? I remember getting a lot of spam after entering my email address in public repos.

OskarStark · 2025-12-20T09:15:22Z

Will this prevent from the PR getting merged? I remember getting a lot of spam after entering my email address in public repos.

No it will not

OskarStark · 2025-12-20T09:15:54Z

Can you please check the tests? They look related

nicodemuz · 2025-12-20T09:25:07Z

Can you please check the tests? They look related

Regarding the error mentioned in here https://github.com/symfony/ai/actions/runs/20368930248/job/58530711175?pr=1139:

Failed to load platform service "ai.platform.vertexai" or call getModelCatalog(). Original error: Symfony\AI\Platform\Bridge\VertexAi\PlatformFactory::create(): Argument 3 ($httpClient) must be of type ?Symfony\Contracts\HttpClient\HttpClientInterface, string given, called in /home/runner/work/ai/ai/src/ai-bundle/vendor/symfony/dependency-injection/ContainerBuilder.php on line 1178 (in /home/runner/work/ai/ai/src/ai-bundle/vendor/symfony/ai-vertex-ai-platform/PlatformFactory.php:33)

I have updated the 3rd parameter of PlatformFactory::create() to accept the $apiKey:
https://github.com/nicodemuz/ai/blob/c5bd3ec2282d73688189c8836437cdf20a9e4e16/src/platform/src/Bridge/VertexAi/PlatformFactory.php#L36

And I have updated code to also pass the 3rd parameter as the apiKey:
https://github.com/nicodemuz/ai/blob/c5bd3ec2282d73688189c8836437cdf20a9e4e16/src/ai-bundle/src/AiBundle.php#L589

I'm a bit confused why it's calling an outdated PlatformFacory via the vendor folder:

in /home/runner/work/ai/ai/src/ai-bundle/vendor/symfony/ai-vertex-ai-platform/PlatformFactory.php:33

How should I address this? Should I add the new parameter as the last parameter in PlatformFactory::create()?

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

c80dc08

nicodemuz requested review from OskarStark and chr-hertel as code owners December 15, 2025 17:24

carsonbot added Feature New feature Platform Issues & PRs about the AI Platform component Status: Needs Review labels Dec 15, 2025

OskarStark reviewed Dec 15, 2025

View reviewed changes

src/platform/src/Bridge/VertexAi/Embeddings/ModelClient.php Outdated Show resolved Hide resolved

OskarStark reviewed Dec 15, 2025

View reviewed changes

Nico Hiort af Ornäs added 9 commits December 18, 2025 22:10

Fix examples

6073689

Add GOOGLE_CLOUD_VERTEX_API_KEY to .env

fd87fab

Update docs for Vertex AI

954074a

Fix newly introduced apiKey parameter

da3efa4

Update code style

cbd5290

Make api_key optional

35a4a75

Fix typo in comments

7161cc1

Add api_key to AiBundleTest

9ebf514

Add configuration option

f7d3c2d

OskarStark reviewed Dec 18, 2025

View reviewed changes

examples/.env Outdated Show resolved Hide resolved

OskarStark reviewed Dec 18, 2025

View reviewed changes

examples/vertexai/chat.php Show resolved Hide resolved

nicodemuz and others added 4 commits December 18, 2025 23:29

Update examples/.env

73695b4

Co-authored-by: Oskar Stark <[email protected]>

Update headings

8f1853c

Add example to chat with API key

cc910ea

Make API key with SensitiveParameter attribute

8dcdb2f

OskarStark reviewed Dec 18, 2025

View reviewed changes

Remove adc_aware_http_client from chat-with-api-key.php example

01fafa7

OskarStark reviewed Dec 19, 2025

View reviewed changes

chr-hertel reviewed Dec 19, 2025

View reviewed changes

chr-hertel added Status: Needs Work and removed Status: Needs Review labels Dec 19, 2025

chr-hertel requested changes Dec 19, 2025

View reviewed changes

Pass query parameters as array

c5bd3ec

carsonbot added Status: Needs Review and removed Status: Needs Work labels Dec 19, 2025

nicodemuz mentioned this pull request Dec 19, 2025

[AI Bundle][Platform] Allow configure Bedrock platform via bundle config #1206

Open


		require_once __DIR__.'/bootstrap.php';

		$platform = PlatformFactory::create(env('GOOGLE_CLOUD_LOCATION'), env('GOOGLE_CLOUD_PROJECT'), env('GOOGLE_CLOUD_VERTEX_API_KEY'), httpClient: adc_aware_http_client());

Uh oh!

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

Are you sure you want to change the base?

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

Uh oh!

Conversation

nicodemuz commented Dec 15, 2025

Uh oh!

Uh oh!

OskarStark commented Dec 15, 2025

Uh oh!

nicodemuz commented Dec 15, 2025

Uh oh!

OskarStark left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicodemuz commented Dec 15, 2025

Uh oh!

OskarStark commented Dec 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicodemuz commented Dec 18, 2025

Uh oh!

Uh oh!

Uh oh!

OskarStark commented Dec 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OskarStark commented Dec 19, 2025

Uh oh!

OskarStark left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chr-hertel left a comment

Choose a reason for hiding this comment

Uh oh!

nicodemuz commented Dec 19, 2025

Uh oh!

nicodemuz commented Dec 19, 2025

Uh oh!

OskarStark commented Dec 20, 2025

Uh oh!

OskarStark commented Dec 20, 2025

Uh oh!

nicodemuz commented Dec 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

OskarStark left a comment •

edited

Loading