docs: clarify BedrockResponse.is_json() always returns True #7748
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
Addresses aws-powertools#7692 - Added comprehensive docstring to BedrockResponse.is_json() explaining why it always returns True regardless of content_type parameter - Updated BedrockResponse class docstring with note about Bedrock Agents only supporting TEXT content type - Added tip in bedrock_agents.md documentation to clarify content_type behavior for users - Included AWS documentation reference for context The content_type parameter is maintained for API consistency but does not affect the actual response format sent to Bedrock Agents, as they only support TEXT content type per AWS Lambda integration docs.
boring-cyborg
bot
added
documentation
pull-request-size
bot
added
the
size/S
|
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.
Fixes #7692
Summary
Clarifies that
BedrockResponse.is_json()always returnsTrueregardless of thecontent_typeparameter due to AWS Bedrock Agents only supporting TEXT content type in the responseBody.Changes
BedrockResponseclass docstring explaining AWS Bedrock limitationis_json()method docstring with AWS documentation referenceContext
Amazon Bedrock Agents only support TEXT content type per the AWS Lambda integration documentation. All response bodies are automatically serialized as JSON strings regardless of the
content_typeparameter.The
content_typeparameter is maintained for API consistency but does not affect the actual response format sent to Bedrock Agents.User experience
Before:
Users were confused why
BedrockResponse.is_json()always returnsTrueeven when settingcontent_type="text/plain". The behavior was not documented, leading to assumptions that thecontent_typeparameter would control the response format.After:
Clear documentation in both the API reference (via docstrings) and user guide explains:
is_json()always returnsTruecontent_typeparameter is kept for API consistencyUsers will now understand this is expected behavior due to AWS platform constraints, not a bug.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.