docs(vector_stores): separate managed Vertex AI Search from pass-through#222
Open
oss-agent-shin wants to merge 7 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Drop the managed `vector_store_registry` section — that flow now
lives at docs/providers/vertex_ai_search_vector_stores.md.
- Drop all `vertex_app_id` references; the code does not read this
field (grep across litellm: 0 hits), so it was silently ignored.
- Add a top-of-page pointer to the managed page for users who want
the unified `/v1/vector_stores/{id}/search` API.
Distinguish `POST /v1/vector_stores` (creates a store on the upstream provider — OpenAI / Azure / RAGFlow) from `POST /vector_store/new` (registers an already-existing upstream store as a LiteLLM-managed mapping — used for Vertex AI Search and any config-mappable provider). Link to the new managed Vertex AI Search page.
Collaborator
|
@oss-agent-shin is there a PR on the litellm repo for this? |
Collaborator
|
some info is misleading, will merge into my branch and fix |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linear: LIT-3229
Why
A customer asked us to "add Vertex AI Search support on the API." That
capability already exists today —
POST /vector_store/newwrites a rowto
LiteLLM_ManagedVectorStoresTableforcustom_llm_provider: vertex_ai/search_api, which is what the Admin UI uses and what theunified
/v1/vector_stores/{id}/searchendpoint resolves against(
litellm/proxy/vector_store_endpoints/management_endpoints.py:515,litellm/llms/vertex_ai/vector_stores/search_api/transformation.py).The customer couldn't find it because our docs steered them wrong on
three counts:
docs/pass_through/vertex_ai_search_datastores.mdwas filed underpass-through but actually mostly documented a managed vector
store (the
vector_store_registryYAML stanza), which conflatedthe two surfaces in one page.
docs/vector_stores/create.mdonly listed OpenAI / Azure / RAGFlowfor
POST /v1/vector_storesand never mentioned that Vertex AISearch registration uses a different endpoint
(
POST /vector_store/new).vertex_app_id, which the code does not read —grep -rn vertex_app_id litellm/ tests/returns 0 hits. A customer whopasted that snippet into their config got it silently ignored.
What's in this PR
New file
docs/providers/vertex_ai_search_vector_stores.md—single managed-mode walkthrough that covers prerequisites,
registration via
config.yamlvector_store_registry, viaPOST /vector_store/new, and via the Admin UI; then query viaPOST /v1/vector_stores/{id}/searchandlitellm.vector_stores.search().Includes a "when to use this vs the pass-through" table that
redirects the other half of users.
Trimmed
docs/pass_through/vertex_ai_search_datastores.mdsoit covers only the pass-through endpoint
(
/vertex_ai/discovery/...). Removed the managedvector_store_registryYAML stanza (now lives on the providerspage) and all
vertex_app_idreferences (no-op today). Addeda tip at the top of the page pointing users who want the unified
API at the new providers page.
Updated
docs/vector_stores/create.mdwith a calloutdistinguishing:
POST /v1/vector_stores— creates an upstream store on theprovider (OpenAI / Azure / RAGFlow).
POST /vector_store/new— registers an existing upstream storeas a LiteLLM-managed mapping (Vertex AI Search, Azure AI Search,
Milvus, Gemini File Search, Bedrock KB).
Also added a new tab in the curl examples that shows the
POST /vector_store/newpayload using the Vertex AI Search shape.Wired the new page into
sidebars.jsunder the existingVertex AI provider category.
Acceptance checklist (from the ticket)
both API-based and UI-based registration without reading code.
create.mdanswers "which endpoint do I use for X provider"without ambiguity.
vertex_app_idin any YAML/JSON example anywhere in thedocs.
Manual testing evidence
1.
vertex_app_idreally is a no-op (so it's safe to remove)The field was never read anywhere in source or tests, so pasting it
into a config silently does nothing — confirming the ticket
diagnosis.
2. The new docs' code path actually works (mocked end-to-end)
The existing test
tests/vector_store_tests/test_vertex_ai_search_api_vector_store.pyexercises exactly the SDK call this PR documents:
I also ran the exact Python SDK example from the new
vertex_ai_search_vector_stores.mdagainst a mocked Discovery Engineresponse to confirm the URL we route to and the response shape both
match what the docs claim:
Captured:
That matches the "Response Format" section of the new docs page
exactly (object name, top-level keys, per-result keys, and the
document_id/link/titleattributes).3.
POST /vector_store/newendpoint really lives where the docs sayConfirms the curl snippets in
vertex_ai_search_vector_stores.mdandthe new tab in
create.mdhit the actual route.Files changed (4)
docs/providers/vertex_ai_search_vector_stores.mddocs/pass_through/vertex_ai_search_datastores.mddocs/vector_stores/create.mdsidebars.jsAgent session: https://litellm-agent-platform.onrender.com/sessions/5a30f91b-4eaa-4c05-9bea-2d8d7968f19d