Skip to content

[DOC] Update VectorDBTool: document runtime override for index and embedding_field#12203

Merged
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom
ohltyler:doc/vectordbtool-optional-params
Apr 10, 2026
Merged

[DOC] Update VectorDBTool: document runtime override for index and embedding_field#12203
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom
ohltyler:doc/vectordbtool-optional-params

Conversation

@ohltyler
Copy link
Copy Markdown
Member

@ohltyler ohltyler commented Apr 6, 2026

Description

Updates the VectorDBTool register parameters table to document that index and embedding_field can 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

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>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 6, 2026

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).

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler ohltyler changed the title [DOC] Update VectorDBTool: index and embedding_field are now optional [DOC] Update VectorDBTool: document runtime override for index and embedding_field Apr 6, 2026
@kolchfa-aws kolchfa-aws added Tech review PR: Tech review in progress release-notes PR: Include this PR in the automated release notes v3.7.0 labels Apr 7, 2026
Copy link
Copy Markdown
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @ohltyler!

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Apr 9, 2026
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws kolchfa-aws merged commit 76b8a05 into opensearch-project:main Apr 10, 2026
5 checks passed
@ohltyler ohltyler deleted the doc/vectordbtool-optional-params branch April 10, 2026 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.7.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Update VectorDBTool: document runtime override for index and embedding_field

3 participants