feat(citations): Add support for web and search result citations #1344
+317
−34
Conversation
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
added 2 commits
December 16, 2025 09:27
The Bedrock API requires CitationLocation to be a tagged union with
exactly one wrapper key (documentChar, documentPage, or documentChunk).
Changes:
- Refactor citation type definitions to use Inner types + wrapper types
for proper tagged union modeling
- Add _format_citation_location helper method to preserve union structure
- Add tests for all document-based citation location types
BREAKING CHANGE: CitationLocation types now use wrapper structure
(e.g., {'documentChar': {'documentIndex': 0, ...}}) instead of flat
structure. This matches the actual Bedrock API specification.
Fixes strands-agents#1323
Add support for web-based and search result citations in the Bedrock Converse API, enabling the SDK to handle all citation location types. Changes: - Add WebLocation and WebLocationInner types for web citations - Add SearchResultLocation and SearchResultLocationInner types - Update _format_citation_location to handle web and searchResultLocation - Add tests for web and search result citation types This completes support for all CitationLocation types as per the Bedrock Converse API specification.
danilop
requested a deployment
to
manual-approval
GitHub Actions
Waiting
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
This PR adds support for web-based and search result citations in the Bedrock Converse API, completing support for all citation location types.
New Features:
WebLocationtype for web-based citations (url, domain)SearchResultLocationtype for search result citations (searchResultIndex, start, end)_format_citation_locationto handle all 5 location typesDependencies
This PR depends on #1343 (fix: Preserve tagged union structure for CitationLocation) which must be merged first.
Related Issues
Fixes #1345
Type of Change
New feature
Testing
hatch run prepare(1618 tests pass)Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.