[DOC] Update VectorDBTool: document runtime override for index and embedding_field#12203
Merged
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom Apr 10, 2026
Conversation
index and embedding_field can now be provided at runtime by the LLM (e.g., via function calling in conversational agents). Runtime values take priority over registered defaults. Resolves opensearch-project#12202 Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
owaiskazi19
reviewed
Apr 6, 2026
owaiskazi19
reviewed
Apr 6, 2026
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
owaiskazi19
approved these changes
Apr 8, 2026
kolchfa-aws
approved these changes
Apr 9, 2026
Collaborator
kolchfa-aws
left a comment
There was a problem hiding this comment.
Thank you, @ohltyler!
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
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.
Description
Updates the VectorDBTool register parameters table to document that
indexandembedding_fieldcan be provided at runtime by the LLM (e.g., via function calling in conversational agents), with runtime values taking priority over registered defaults. Both parameters remain marked as Required since the tool needs them to function — the change clarifies that they can be supplied at runtime rather than only at registration time.Related
input_schemaand runtime param overrides to VectorDBTool