Commit f146914
Update vertex ai provider docs with api key info (#2519)
# Pull Request Template
Thanks for taking the time to fill out this pull request!
## Issue Reference
Please link to any related issues
- [ ] This PR fixes/closes #[issue number]
## Changes
This PR adds documentation for using Vertex AI API Keys (Express Mode)
to the Vertex AI provider docs. This aims to simplify the initial setup
for users by recommending a faster alternative to service account
authentication.
The changes include:
- A new section detailing how to configure a Vertex AI client with an
API key using `query_params`.
- An `Info` note recommending Express Mode for quick starts and linking
to Google's official guide.
- Clarification on explicitly setting `project_id` and omitting
`credentials` when using an API key.
- An updated `ParamField` for `query_params` to include the API key
example.
## Testing
Please describe how you tested these changes
- [ ] Unit tests added/updated
- [X] Manual testing performed (verified documentation renders
correctly)
- [ ] Tested in [environment]
## Screenshots
If applicable, add screenshots to help explain your changes
[Add screenshots here...]
## PR Checklist
Please ensure you've completed these items
- [X] I have read and followed the contributing guidelines
- [X] My code follows the style guidelines of this project
- [X] I have performed a self-review of my own code
- [X] I have commented my code, particularly in hard-to-understand areas
- [X] I have made corresponding changes to the documentation
- [X] My changes generate no new warnings
## Additional Notes
This change directly addresses the user request to document the Vertex
API Key (Express Mode) for faster onboarding, including a recommendation
and a link to the official Google documentation.
---
<a
href="https://cursor.com/background-agent?bcId=bc-0bc51542-2ea0-491b-9712-6fa91f28ed99"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-cursor-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-cursor-light.svg"><img alt="Open in
Cursor"
src="https://cursor.com/open-in-cursor.svg"></picture></a> <a
href="https://cursor.com/agents?id=bc-0bc51542-2ea0-491b-9712-6fa91f28ed99"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-web-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-web-light.svg"><img alt="Open in Web"
src="https://cursor.com/open-in-web.svg"></picture></a>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>1 parent d3d6be6 commit f146914
1 file changed
Lines changed: 50 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
48 | 77 | | |
49 | 78 | | |
50 | 79 | | |
| |||
334 | 363 | | |
335 | 364 | | |
336 | 365 | | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
337 | 387 | | |
338 | 388 | | |
339 | 389 | | |
| |||
0 commit comments