Skip to content

docs: comprehensive AWS Bedrock documentation update#283

Merged
nkanu17 merged 4 commits into
mainfrom
docs/update-bedrock-documentation
Apr 16, 2026
Merged

docs: comprehensive AWS Bedrock documentation update#283
nkanu17 merged 4 commits into
mainfrom
docs/update-bedrock-documentation

Conversation

@nkanu17
Copy link
Copy Markdown
Contributor

@nkanu17 nkanu17 commented Apr 16, 2026

Summary

Updates docs/aws-bedrock.md and docs/llm-providers.md to comprehensively cover the AWS Bedrock implementation.

Changes

docs/aws-bedrock.md

  • Added Quick Start section with step-by-step instructions to run a full Bedrock-backed instance
  • Added section explaining the bedrock/ prefix requirement (required for embedding models, not needed for generation models)
  • Added section explaining why both REGION_NAME and AWS_REGION_NAME must be set
  • Fixed Docker Compose instructions to use --profile aws instead of the incorrect DOCKER_TARGET variable
  • Fixed YAML config example to include the bedrock/ prefix on embedding models
  • Added latest Anthropic Claude generation models (Opus 4.6, Sonnet 4.6, Opus 4.1, Sonnet 4, 3.5 Haiku, 3 Haiku)
  • Added additional embedding models (Titan multimodal, Cohere Embed v4)
  • Added a hybrid config example (OpenAI embeddings + Bedrock generation)
  • Expanded installation section with uv sync --extra aws and explicit warning about missing deps
  • Fixed troubleshooting to reference correct env var names

docs/llm-providers.md

  • Fixed Quick Start to include both region variables, REDISVL_VECTOR_DIMENSIONS, and prefix explanation
  • Added callout about the [aws] extra installation requirement
  • Fixed default GENERATION_MODEL from gpt-4o-mini to gpt-5 (matching config.py)
  • Updated FAST_MODEL default and added SLOW_MODEL row to the reference table
  • Replaced outdated Bedrock generation model IDs with current ones from MODEL_CONFIGS
  • Added latest Anthropic Claude models with pre-configured status indicators
  • Added additional embedding models (Titan multimodal, Cohere Embed v4)
  • Fixed Docker instructions to use --profile aws
  • Added Bedrock troubleshooting entries
  • Added cross-reference to aws-bedrock.md in See Also section

Note

Low Risk
Documentation-only changes plus a small LangChain integration example update; no runtime behavior changes to the server or client libraries.

Overview
Significantly expands AWS Bedrock documentation with a full quick start, clearer guidance on required dependencies (agent-memory-server[aws] / uv sync --extra aws), correct Docker Compose usage (--profile aws), and explicit configuration for AWS_REGION_NAME vs REGION_NAME and REDISVL_VECTOR_DIMENSIONS.

Clarifies LiteLLM Bedrock model naming rules (embedding models require bedrock/, generation models don’t), refreshes the listed supported Bedrock models (including newer Claude and additional embedding options), adds hybrid configuration examples, and updates troubleshooting/migration notes. Also updates the agent_memory_client LangChain integration docstring example to use create_agent and the newer messages-based invocation style.

Reviewed by Cursor Bugbot for commit 51b0264. Bugbot is set up for automated code reviews on this repo. Configure here.

- Add Quick Start section to aws-bedrock.md for running a full Bedrock instance
- Document bedrock/ prefix requirement for embedding models vs no prefix for generation
- Add installation instructions for the [aws] extra (boto3, botocore)
- Fix Docker Compose instructions to use --profile aws instead of DOCKER_TARGET
- Fix region env var references (REGION_NAME + AWS_REGION_NAME)
- Add latest Anthropic Claude models (Opus 4.6, Sonnet 4.6, Opus 4.1, Sonnet 4, etc.)
- Add additional embedding models (Titan multimodal, Cohere Embed v4)
- Fix default GENERATION_MODEL in llm-providers.md to match config.py
- Add hybrid config examples (Bedrock embeddings + OpenAI generation and vice versa)
- Add troubleshooting entries for missing AWS dependencies
- Cross-reference between aws-bedrock.md and llm-providers.md
Copilot AI review requested due to automatic review settings April 16, 2026 14:05
@nkanu17 nkanu17 requested a review from vishal-bala April 16, 2026 14:06
@jit-ci
Copy link
Copy Markdown

jit-ci Bot commented Apr 16, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Review completed. The documentation updates are comprehensive and well-structured, providing clear guidance for AWS Bedrock users. The Quick Start section, model tables, and troubleshooting additions are valuable improvements.


🤖 Automated review complete. Please react with 👍 or 👎 on the individual review comments to provide feedback on their usefulness.

Comment thread docs/llm-providers.md
Comment thread docs/llm-providers.md
The module docstring was using the removed create_tool_calling_agent and
AgentExecutor API from LangChain < v0.2. Updated to use create_agent
from langchain.agents, which is the current API.
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8b820f2c28

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/aws-bedrock.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the project’s documentation to more comprehensively describe AWS Bedrock support (installation, configuration, model IDs, and Docker workflows) and to align the provider guide with the current Bedrock setup.

Changes:

  • Expanded AWS Bedrock documentation with a Quick Start, region variable explanations, prefix requirements, and updated model lists.
  • Refreshed llm-providers.md Bedrock guidance (install extras, updated defaults table, expanded troubleshooting, updated Docker Compose usage).
  • Added cross-references between Bedrock docs and the provider overview.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File Description
docs/llm-providers.md Updates provider quick start and Bedrock section (extras install, model IDs, prefix guidance, Docker profile usage, defaults table).
docs/aws-bedrock.md Replaces prior “consolidated” stub with a full Bedrock guide (Quick Start, region/prefix explanation, models, Docker, troubleshooting).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/aws-bedrock.md
Comment thread docs/llm-providers.md Outdated
Comment thread docs/llm-providers.md Outdated
Comment thread docs/llm-providers.md Outdated
Comment thread docs/aws-bedrock.md Outdated
Comment thread docs/aws-bedrock.md Outdated
Copy link
Copy Markdown
Contributor

@vishal-bala vishal-bala left a comment

Choose a reason for hiding this comment

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

Just a few comments, but aside from them this LGTM 👍

Comment thread docs/aws-bedrock.md Outdated
Comment thread docs/aws-bedrock.md Outdated
Comment thread docs/aws-bedrock.md Outdated
Comment thread docs/llm-providers.md Outdated
nkanu17 added 2 commits April 16, 2026 10:28
- Fix REGION_NAME vs AWS_REGION_NAME: clarify AWS_REGION_NAME is required
  (LiteLLM), REGION_NAME is optional (server-side boto3 model-existence checks)
- Fix IAM role section: note that server boto3 utilities currently require
  explicit credentials, but LiteLLM handles IAM roles natively
- Fix REDISVL_VECTOR_DIMENSIONS description: it is a fallback/override, not
  auto-detected
- Add asterisk notes on embedding models not in MODEL_CONFIGS (titan-embed-image,
  cohere.embed-v4) requiring explicit REDISVL_VECTOR_DIMENSIONS
- Clarify bedrock/ prefix is optional (not prohibited) for generation models
- Remove boto3/botocore version ranges from docs
- Rename LLM Proxy to LLM Proxy (LiteLLM) in architecture diagram
- Update wording from 'no prefix needed' to 'prefix optional'
@nkanu17 nkanu17 merged commit cc3a832 into main Apr 16, 2026
48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants