mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 05:08:12 +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>
148 lines
4.4 KiB
Plaintext
148 lines
4.4 KiB
Plaintext
---
|
|
title: TrueFoundry Integration
|
|
icon: chart-line
|
|
mode: "wide"
|
|
---
|
|
|
|
TrueFoundry provides an enterprise-ready [AI Gateway](https://www.truefoundry.com/ai-gateway) which can integrate with agentic frameworks like CrewAI and provides governance and observability for your AI Applications. TrueFoundry AI Gateway serves as a unified interface for LLM access, providing:
|
|
|
|
- **Unified API Access**: Connect to 250+ LLMs (OpenAI, Claude, Gemini, Groq, Mistral) through one API
|
|
- **Low Latency**: Sub-3ms internal latency with intelligent routing and load balancing
|
|
- **Enterprise Security**: SOC 2, HIPAA, GDPR compliance with RBAC and audit logging
|
|
- **Quota and cost management**: Token-based quotas, rate limiting, and comprehensive usage tracking
|
|
- **Observability**: Full request/response logging, metrics, and traces with customizable retention
|
|
|
|
## How TrueFoundry Integrates with CrewAI
|
|
|
|
|
|
### Installation & Setup
|
|
|
|
<Steps>
|
|
<Step title="Install CrewAI">
|
|
```bash
|
|
pip install crewai
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Get TrueFoundry Access Token">
|
|
1. Sign up for a [TrueFoundry account](https://www.truefoundry.com/register)
|
|
2. Follow the steps here in [Quick start](https://docs.truefoundry.com/gateway/quick-start)
|
|
</Step>
|
|
|
|
<Step title="Configure CrewAI with TrueFoundry">
|
|

|
|
|
|
```python
|
|
from crewai import LLM
|
|
|
|
# Create an LLM instance with TrueFoundry AI Gateway
|
|
truefoundry_llm = LLM(
|
|
model="openai-main/gpt-4o", # Similarly, you can call any model from any provider
|
|
base_url="your_truefoundry_gateway_base_url",
|
|
api_key="your_truefoundry_api_key"
|
|
)
|
|
|
|
# Use in your CrewAI agents
|
|
from crewai import Agent
|
|
|
|
@agent
|
|
def researcher(self) -> Agent:
|
|
return Agent(
|
|
config=self.agents_config['researcher'],
|
|
llm=truefoundry_llm,
|
|
verbose=True
|
|
)
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
### Complete CrewAI Example
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, LLM
|
|
|
|
# Configure LLM with TrueFoundry
|
|
llm = LLM(
|
|
model="openai-main/gpt-4o",
|
|
base_url="your_truefoundry_gateway_base_url",
|
|
api_key="your_truefoundry_api_key"
|
|
)
|
|
|
|
# Create agents
|
|
researcher = Agent(
|
|
role='Research Analyst',
|
|
goal='Conduct detailed market research',
|
|
backstory='Expert market analyst with attention to detail',
|
|
llm=llm,
|
|
verbose=True
|
|
)
|
|
|
|
writer = Agent(
|
|
role='Content Writer',
|
|
goal='Create comprehensive reports',
|
|
backstory='Experienced technical writer',
|
|
llm=llm,
|
|
verbose=True
|
|
)
|
|
|
|
# Create tasks
|
|
research_task = Task(
|
|
description='Research AI market trends for 2024',
|
|
agent=researcher,
|
|
expected_output='Comprehensive research summary'
|
|
)
|
|
|
|
writing_task = Task(
|
|
description='Create a market research report',
|
|
agent=writer,
|
|
expected_output='Well-structured report with insights',
|
|
context=[research_task]
|
|
)
|
|
|
|
# Create and execute crew
|
|
crew = Crew(
|
|
agents=[researcher, writer],
|
|
tasks=[research_task, writing_task],
|
|
verbose=True
|
|
)
|
|
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
### Observability and Governance
|
|
|
|
Monitor your CrewAI agents through TrueFoundry's metrics tab:
|
|

|
|
|
|
With Truefoundry's AI gateway, you can monitor and analyze:
|
|
|
|
- **Performance Metrics**: Track key latency metrics like Request Latency, Time to First Token (TTFS), and Inter-Token Latency (ITL) with P99, P90, and P50 percentiles
|
|
- **Cost and Token Usage**: Gain visibility into your application's costs with detailed breakdowns of input/output tokens and the associated expenses for each model
|
|
- **Usage Patterns**: Understand how your application is being used with detailed analytics on user activity, model distribution, and team-based usage
|
|
- **Rate limit and Load balancing**: You can set up rate limiting, load balancing and fallback for your models
|
|
|
|
## Tracing
|
|
|
|
For a more detailed understanding on tracing, please see [getting-started-tracing](https://docs.truefoundry.com/docs/tracing/tracing-getting-started).For tracing, you can add the Traceloop SDK:
|
|
For tracing, you can add the Traceloop SDK:
|
|
|
|
```bash
|
|
pip install traceloop-sdk
|
|
```
|
|
|
|
```python
|
|
from traceloop.sdk import Traceloop
|
|
|
|
# Initialize enhanced tracing
|
|
Traceloop.init(
|
|
api_endpoint="https://your-truefoundry-endpoint/api/tracing",
|
|
headers={
|
|
"Authorization": f"Bearer {your_truefoundry_pat_token}",
|
|
"TFY-Tracing-Project": "your_project_name",
|
|
},
|
|
)
|
|
```
|
|
|
|
This provides additional trace correlation across your entire CrewAI workflow.
|
|

|