mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-06 15:39:24 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
167 lines
5.0 KiB
Plaintext
167 lines
5.0 KiB
Plaintext
---
|
|
title: 'Bedrock Knowledge Base Retriever'
|
|
description: 'Retrieve information from Amazon Bedrock Knowledge Bases using natural language queries'
|
|
icon: aws
|
|
mode: "wide"
|
|
---
|
|
|
|
# `BedrockKBRetrieverTool`
|
|
|
|
The `BedrockKBRetrieverTool` enables CrewAI agents to retrieve information from Amazon Bedrock Knowledge Bases using natural language queries.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
uv pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- AWS credentials configured (either through environment variables or AWS CLI)
|
|
- `boto3` and `python-dotenv` packages
|
|
- Access to Amazon Bedrock Knowledge Base
|
|
|
|
## Usage
|
|
|
|
Here's how to use the tool with a CrewAI agent:
|
|
|
|
```python {2, 4-17}
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools.aws.bedrock.knowledge_base.retriever_tool import BedrockKBRetrieverTool
|
|
|
|
# Initialize the tool
|
|
kb_tool = BedrockKBRetrieverTool(
|
|
knowledge_base_id="your-kb-id",
|
|
number_of_results=5
|
|
)
|
|
|
|
# Create a CrewAI agent that uses the tool
|
|
researcher = Agent(
|
|
role='Knowledge Base Researcher',
|
|
goal='Find information about company policies',
|
|
backstory='I am a researcher specialized in retrieving and analyzing company documentation.',
|
|
tools=[kb_tool],
|
|
verbose=True
|
|
)
|
|
|
|
# Create a task for the agent
|
|
research_task = Task(
|
|
description="Find our company's remote work policy and summarize the key points.",
|
|
agent=researcher
|
|
)
|
|
|
|
# Create a crew with the agent
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[research_task],
|
|
verbose=2
|
|
)
|
|
|
|
# Run the crew
|
|
result = crew.kickoff()
|
|
print(result)
|
|
```
|
|
|
|
## Tool Arguments
|
|
|
|
| Argument | Type | Required | Default | Description |
|
|
|:---------|:-----|:---------|:---------|:-------------|
|
|
| **knowledge_base_id** | `str` | Yes | None | The unique identifier of the knowledge base (0-10 alphanumeric characters) |
|
|
| **number_of_results** | `int` | No | 5 | Maximum number of results to return |
|
|
| **retrieval_configuration** | `dict` | No | None | Custom configurations for the knowledge base query |
|
|
| **guardrail_configuration** | `dict` | No | None | Content filtering settings |
|
|
| **next_token** | `str` | No | None | Token for pagination |
|
|
|
|
## Environment Variables
|
|
|
|
```bash
|
|
BEDROCK_KB_ID=your-knowledge-base-id # Alternative to passing knowledge_base_id
|
|
AWS_REGION=your-aws-region # Defaults to us-east-1
|
|
AWS_ACCESS_KEY_ID=your-access-key # Required for AWS authentication
|
|
AWS_SECRET_ACCESS_KEY=your-secret-key # Required for AWS authentication
|
|
```
|
|
|
|
## Response Format
|
|
|
|
The tool returns results in JSON format:
|
|
|
|
```json
|
|
{
|
|
"results": [
|
|
{
|
|
"content": "Retrieved text content",
|
|
"content_type": "text",
|
|
"source_type": "S3",
|
|
"source_uri": "s3://bucket/document.pdf",
|
|
"score": 0.95,
|
|
"metadata": {
|
|
"additional": "metadata"
|
|
}
|
|
}
|
|
],
|
|
"nextToken": "pagination-token",
|
|
"guardrailAction": "NONE"
|
|
}
|
|
```
|
|
|
|
## Advanced Usage
|
|
|
|
### Custom Retrieval Configuration
|
|
|
|
```python
|
|
kb_tool = BedrockKBRetrieverTool(
|
|
knowledge_base_id="your-kb-id",
|
|
retrieval_configuration={
|
|
"vectorSearchConfiguration": {
|
|
"numberOfResults": 10,
|
|
"overrideSearchType": "HYBRID"
|
|
}
|
|
}
|
|
)
|
|
|
|
policy_expert = Agent(
|
|
role='Policy Expert',
|
|
goal='Analyze company policies in detail',
|
|
backstory='I am an expert in corporate policy analysis with deep knowledge of regulatory requirements.',
|
|
tools=[kb_tool]
|
|
)
|
|
```
|
|
|
|
## Supported Data Sources
|
|
|
|
- Amazon S3
|
|
- Confluence
|
|
- Salesforce
|
|
- SharePoint
|
|
- Web pages
|
|
- Custom document locations
|
|
- Amazon Kendra
|
|
- SQL databases
|
|
|
|
## Use Cases
|
|
|
|
### Enterprise Knowledge Integration
|
|
- Enable CrewAI agents to access your organization's proprietary knowledge without exposing sensitive data
|
|
- Allow agents to make decisions based on your company's specific policies, procedures, and documentation
|
|
- Create agents that can answer questions based on your internal documentation while maintaining data security
|
|
|
|
### Specialized Domain Knowledge
|
|
- Connect CrewAI agents to domain-specific knowledge bases (legal, medical, technical) without retraining models
|
|
- Leverage existing knowledge repositories that are already maintained in your AWS environment
|
|
- Combine CrewAI's reasoning with domain-specific information from your knowledge bases
|
|
|
|
### Data-Driven Decision Making
|
|
- Ground CrewAI agent responses in your actual company data rather than general knowledge
|
|
- Ensure agents provide recommendations based on your specific business context and documentation
|
|
- Reduce hallucinations by retrieving factual information from your knowledge bases
|
|
|
|
### Scalable Information Access
|
|
- Access terabytes of organizational knowledge without embedding it all into your models
|
|
- Dynamically query only the relevant information needed for specific tasks
|
|
- Leverage AWS's scalable infrastructure to handle large knowledge bases efficiently
|
|
|
|
### Compliance and Governance
|
|
- Ensure CrewAI agents provide responses that align with your company's approved documentation
|
|
- Create auditable trails of information sources used by your agents
|
|
- Maintain control over what information sources your agents can access
|