docs: add Amazon Bedrock Runtime guide with Converse API examples#4727
Open
niceysam wants to merge 1 commit intoboto:developfrom
Open
docs: add Amazon Bedrock Runtime guide with Converse API examples#4727niceysam wants to merge 1 commit intoboto:developfrom
niceysam wants to merge 1 commit intoboto:developfrom
Conversation
niceysam
force-pushed
the
feature/add-bedrock-guide
branch
from
207bbd8 to
fb471d9
Compare
Add a new guide covering common Amazon Bedrock Runtime use cases using the Converse API, which is the recommended interface for conversational workloads. Examples included: - Basic message with the Converse API - System prompt usage - Multi-turn conversation - Streaming responses with converse_stream - Cross-region inference with model ID prefix - Error handling for ThrottlingException and ModelNotReadyException The Converse API is preferred over the lower-level InvokeModel for most use cases because it provides a unified message format across all supported foundation models.
niceysam
force-pushed
the
feature/add-bedrock-guide
branch
from
fb471d9 to
ef05ecf
Compare
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
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.
What's changed
Added a new guide for Amazon Bedrock Runtime at
docs/source/guide/bedrock.rstcovering practical use cases with the Converse API.The Converse API has been the recommended interface since its GA in 2024 — it provides a unified message format across all foundation models and is simpler than the lower-level
invoke_model. However, boto3 currently has no guide for Bedrock at all, leaving developers to piece things together from the API reference.Examples included
converse_streamus.)ThrottlingException,ModelNotReadyException)Why Converse API over InvokeModel
The guide intentionally focuses on the Converse API rather than
invoke_modelbecause Converse works uniformly across all supported models without needing to know each model's specific request/response format.invoke_modelis still mentioned briefly for awareness but not demonstrated, since most users are better served by Converse.Fixes: no existing issue — this adds missing documentation for a GA service.