docs: Add dynamic vector_store_ids support for File Search toolbox#786
docs: Add dynamic vector_store_ids support for File Search toolbox#786Nivedha-Chellam wants to merge 1 commit into
Conversation
Document pinned vs dynamic vector_store_ids patterns for File Search. When omitted from toolbox config, callers can pass vector_store_ids at tools/call time for multi-tenant scenarios. Added examples for REST, Python, .NET, JavaScript, and azd. Noted Foundry portal UI limitation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
@microsoft-github-policy-service agree company="Microsoft"
@microsoft-github-policy-service agree company="Microsoft" |
|
@Nivedha-Chellam : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. @jonburchel |
|
Learn Build status updates of commit 608dc87: ✅ Validation status: passed
For more details, please refer to the build report. |
There was a problem hiding this comment.
Pull request overview
Adds documentation describing two configuration patterns for the File Search tool in a toolbox—either pinning vector_store_ids at toolbox creation time or omitting them and supplying the IDs dynamically at tools/call time—across the REST, SDK, and azd CLI pivots.
Changes:
- Expanded the File Search section to explain pinned vs. dynamic
vector_store_idsusage and added a NOTE about current UI limitations. - Added new “Dynamic” examples for REST, Python, .NET, JavaScript, and azd pivots.
- Updated the
tools/callarguments table to include a dynamicvector_store_idsexample for File Search.
| You can configure `vector_store_ids` in two ways: | ||
|
|
||
| - **Pinned at toolbox creation** — provide `vector_store_ids` in the tool configuration. The vector store is fixed for all calls and can't be overridden at runtime. | ||
| - **Dynamic at runtime** — omit `vector_store_ids` from the tool configuration. Callers provide it in the `tools/call` arguments, enabling scenarios like multi-tenant document stores where each call targets a different vector store. | ||
|
|
| | --------- | --------- | | ||
| | AI Search | `{"query": "search text"}` | | ||
| | File Search | `{"queries": ["search text"]}` | | ||
| | File Search | `{"queries": ["search text"]}` — or `{"queries": ["search text"], "vector_store_ids": ["<ID>"]}` when vector store is passed dynamically | |
| :::zone pivot="vscode" | ||
|
|
||
| The Foundry portal currently requires `vector_store_ids` when adding a File Search tool. To create a File Search tool without `vector_store_ids` (enabling dynamic passing at runtime), use the REST API, SDK, or azd CLI. | ||
|
|
| When `vector_store_ids` is omitted, callers pass it in the `tools/call` arguments: | ||
|
|
||
| ```json | ||
| {"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"file_search","arguments":{"queries":["search text"],"vector_store_ids":["<VECTOR_STORE_ID>"]}}} |
|
Can you review the proposed changes? Important: These changes need to be moved into the private repo for staging and automated checks. If you approve the changes, can you open a PR in the private repo to move the commits? Let us know if you'd like the PR review team's assistance. #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
|
@Nivedha-Chellam : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. @jonburchel |
Summary
Adds documentation for dynamic �ector_store_ids parameter passing with the File Search tool in toolboxes.
Changes
Context
With dynamic parameter support (Stage 1), customers can now choose to either:
This enables scenarios where the vector store is determined at runtime (e.g., per-user or per-session stores).