Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
chr-hertel merged 1 commit into from
Jan 6, 2026
Merged

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

chr-hertel merged 1 commit into from
Jan 6, 2026

Conversation

@nicodemuz
Copy link

@nicodemuz nicodemuz commented Dec 15, 2025

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.

@carsonbot carsonbot added Feature New feature Platform Issues & PRs about the AI Platform component Status: Needs Review labels Dec 15, 2025
OskarStark
OskarStark reviewed Dec 15, 2025
View reviewed changes
@OskarStark
Copy link
Contributor

OskarStark commented Dec 15, 2025

Please add tests

@nicodemuz
Copy link
Author

nicodemuz commented Dec 15, 2025

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
OskarStark reviewed Dec 15, 2025
View reviewed changes
Copy link
Contributor

@OskarStark OskarStark left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Author

nicodemuz commented Dec 15, 2025

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
Copy link
Contributor

OskarStark commented Dec 16, 2025

@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
OskarStark reviewed Dec 18, 2025
View reviewed changes
docs/components/platform/vertexai.rst Outdated
Comment on lines 26 to 28
========================================
1. Application Default Credentials (ADC)
========================================
Copy link
Contributor

@OskarStark OskarStark Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
========================================
1. Application Default Credentials (ADC)
========================================
Application Default Credentials (ADC)
-------------------------------------

Same for the other headlines

Copy link
Author

@nicodemuz nicodemuz Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

image

Copy link
Contributor

@OskarStark OskarStark Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I think we need to go with ........ dots as underline for the next level, can you please try? thanks

Copy link
Author

@nicodemuz nicodemuz Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated! 👍

@nicodemuz
Copy link
Author

nicodemuz commented Dec 18, 2025

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?

OskarStark
OskarStark reviewed Dec 18, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 18, 2025
View reviewed changes
@OskarStark
Copy link
Contributor

OskarStark commented Dec 18, 2025

Tests still needed

OskarStark
OskarStark reviewed Dec 18, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 18, 2025
View reviewed changes
examples/vertexai/chat-with-api-key.php Outdated

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());
Copy link
Contributor

@OskarStark OskarStark Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but this still uses the adc_aware_http_client

Copy link
Author

@nicodemuz nicodemuz Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Fixed! 👍

@OskarStark
Copy link
Contributor

OskarStark commented Dec 19, 2025

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

OskarStark
OskarStark reviewed Dec 19, 2025
View reviewed changes
Copy link
Contributor

@OskarStark OskarStark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.

chr-hertel
chr-hertel requested changes Dec 19, 2025
View reviewed changes
Copy link
Member

@chr-hertel chr-hertel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we def need this - thanks @nicodemuz!

only minor comments but broken pipeline

@nicodemuz
Copy link
Author

nicodemuz commented Dec 19, 2025

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 nicodemuz mentioned this pull request Dec 19, 2025
Closed
@nicodemuz
Copy link
Author

nicodemuz commented Dec 19, 2025

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
OskarStark reviewed Dec 21, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 21, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 21, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 21, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 21, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 21, 2025
View reviewed changes
OskarStark
OskarStark reviewed Dec 21, 2025
View reviewed changes
@OskarStark
Copy link
Contributor

OskarStark commented Dec 21, 2025

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

Did you rebased properly?

@nicodemuz nicodemuz force-pushed the VertexAiApiKeySupport branch from 9495255 to 30497c4 Compare December 21, 2025 12:49
@nicodemuz
Copy link
Author

nicodemuz commented Dec 21, 2025

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

Did you rebased properly?

@OskarStark I have rebased just now with the main branch of symfony/ai. The tests are still failing:

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 1174 (in /home/runner/work/ai/ai/src/ai-bundle/vendor/symfony/ai-vertex-ai-platform/PlatformFactory.php:36)

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

@OskarStark
Copy link
Contributor

OskarStark commented Dec 21, 2025

Looks like the Order of the arguments is wrong.

IIRC @Guikingone had the same issue in the past, right?

@Guikingone
Copy link
Contributor

Guikingone commented Dec 21, 2025

Yes, was related to the arguments sent into the factory (don't forget about the null for the contract/event dispatcher).

@nicodemuz
Copy link
Author

nicodemuz commented Dec 21, 2025

Yes, was related to the arguments sent into the factory (don't forget about the null for the contract/event dispatcher).

@Guikingone But I have already 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

Can you advice where exactly should I add any other additional updates?

I'm still 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

@OskarStark
Copy link
Contributor

OskarStark commented Dec 30, 2025

Can you please rebase?

@OskarStark
Copy link
Contributor

OskarStark commented Dec 30, 2025

Please require package version ^0.2 in ai-bundle composer.json

@nicodemuz nicodemuz force-pushed the VertexAiApiKeySupport branch from 39ac2ab to 8efa78a Compare January 3, 2026 10:09
@nicodemuz
Copy link
Author

nicodemuz commented Jan 3, 2026

Can you please rebase?

I have rebased.

@nicodemuz
Copy link
Author

nicodemuz commented Jan 3, 2026

Please require package version ^0.2 in ai-bundle composer.json

This seems to already be 0.2: https://github.com/nicodemuz/ai/blob/8efa78a4acb0fb1c5d5e613bcf9462da5ca598e1/src/ai-bundle/composer.json#L92

@chr-hertel chr-hertel added BC Break Breaking the Backwards Compatibility Promise and removed BC Break Breaking the Backwards Compatibility Promise labels Jan 6, 2026
@chr-hertel chr-hertel force-pushed the VertexAiApiKeySupport branch from 8ecc5f7 to 4c7e3fb Compare January 6, 2026 14:00
@chr-hertel
Copy link
Member

chr-hertel commented Jan 6, 2026

Thank you @nicodemuz.

@chr-hertel chr-hertel merged commit 2d37aea into symfony:main Jan 6, 2026
11 checks passed
@OskarStark
Copy link
Contributor

OskarStark commented Jan 6, 2026

AI bundle now need to require vertex 0.2 in require dev, no?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@OskarStark OskarStark OskarStark left review comments

@chr-hertel chr-hertel chr-hertel approved these changes

Assignees

No one assigned

Labels

Feature New feature Platform Issues & PRs about the AI Platform component Status: Reviewed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@nicodemuz @OskarStark @Guikingone @chr-hertel @carsonbot