-
Notifications
You must be signed in to change notification settings - Fork 137
Truefoundry docs addition #280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
rishiraj-tf
wants to merge
7
commits into
RooCodeInc:main
Choose a base branch
from
rishiraj-tf:truefoundry-docs-improvements
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
739200c
Add TrueFoundry AI Gateway integration documentation
rishiraj-tf ec3828d
Merge pull request #1 from rishiraj-tf/truefoundry-integration
rishiraj-tf 66b37a2
Improve TrueFoundry documentation with better formatting and links
rishiraj-tf 21fcd65
feat: add TrueFoundry gateway analytics and metrics visualization
rishiraj-tf f7f80e6
refactor: enhance TrueFoundry documentation content and structure
rishiraj-tf 6442c71
updated commented changes
rishiraj-tf 434e290
Merge branch 'main' into truefoundry-docs-improvements
rishiraj-tf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,175 @@ | ||
# TrueFoundry | ||
|
||
TrueFoundry's AI Gateway is an enterprise-grade platform that enables developers to access multiple AI models through a unified, secure, and cost-optimized interface. By connecting Roo Code to TrueFoundry's AI Gateway, you can leverage its AI capabilities for code generation, debugging, and development tasks while benefiting from enterprise features including security, compliance, cost management, and access control. | ||
|
||
**Get Started:** [Website](https://www.truefoundry.com/ai-gateway) | [Documentation](https://docs.truefoundry.com/gateway/intro-to-llm-gateway) | ||
|
||
## Why TrueFoundry? | ||
|
||
- **Multi-Model Access**: Connect to OpenAI, Anthropic, Google, and other providers through a single endpoint | ||
- **Enterprise Security**: Built-in access control, rate limiting, and security guardrails | ||
- **Cost Optimization**: Advanced cost tracking, budget limiting, and usage analytics | ||
- **High Availability**: Load balancing and fallback mechanisms for reliable service | ||
- **Observability**: Comprehensive logging, monitoring, and analytics | ||
|
||
## Prerequisites | ||
|
||
Before integrating Roo Code with TrueFoundry, ensure you have: | ||
|
||
1. **TrueFoundry Account**: A TrueFoundry account with at least one model provider configured. Follow quick start guide [here](https://docs.truefoundry.com/gateway/quick-start) | ||
2. **Personal Access Token**: Generate a token by following the [TrueFoundry token generation guide](https://docs.truefoundry.com/gateway/authentication) | ||
3. **Roo Code Extension**: Install Roo Code from the VS Code Marketplace | ||
|
||
 | ||
|
||
## Integration Guide | ||
|
||
### Step 1: Get TrueFoundry Gateway Configuration | ||
|
||
1. **Navigate to AI Gateway Playground**: Go to your TrueFoundry AI Gateway playground | ||
2. **Access Unified Code Snippet**: Use the unified code snippet feature | ||
3. **Copy Configuration Details**: Note down: | ||
- Base URL (e.g., `https://your-control-plane.truefoundry.cloud/api/llm`) | ||
- Model name (use exactly as shown in the snippet) | ||
- Your authentication token | ||
|
||
 | ||
|
||
### Step 2: Configure Roo Code | ||
|
||
1. **Open Roo Code Settings**: | ||
- Click the Roo Code icon (🦘) in VS Code's Activity Bar | ||
- Navigate to settings or configuration | ||
|
||
2. **Add Custom Provider**: | ||
- Select "Custom" or "OpenAI Compatible" from the provider dropdown | ||
- Configure the following settings: | ||
|
||
```json | ||
{ | ||
"baseUrl": "https://your-control-plane.truefoundry.cloud/api/llm", | ||
"apiKey": "your-truefoundry-token", | ||
"model": "openai-main/gpt-4o" | ||
} | ||
``` | ||
|
||
 | ||
|
||
3. **Save Configuration**: Apply your settings and test the connection | ||
|
||
### Step 3: Test Your Integration | ||
|
||
1. **Verify Connection**: Open a code file and ask Roo Code a question | ||
2. **Check Response Quality**: Ensure responses are generated successfully | ||
3. **Monitor Usage**: Use TrueFoundry's dashboard to track your API usage | ||
|
||
 | ||
|
||
## Recommended Models | ||
|
||
Choose models based on your specific use cases: | ||
|
||
### **Code Generation & Complex Tasks** | ||
- **`openai-main/gpt-4o`**: Best for complex code generation and reasoning tasks | ||
- **`anthropic/claude-4-sonnet`**: Excellent for code understanding and following instructions | ||
|
||
|
||
:::tip Model Names | ||
Always use the exact model name as shown in your TrueFoundry Gateway unified code snippet to ensure proper routing. | ||
::: | ||
|
||
## Advanced Configuration | ||
|
||
### Multiple Model Profiles | ||
|
||
Configure different profiles for various development scenarios: | ||
|
||
```json | ||
{ | ||
"roocode.apiProfiles": [ | ||
{ | ||
"name": "TrueFoundry GPT-4", | ||
"baseUrl": "https://your-control-plane.truefoundry.cloud/api/llm", | ||
"apiKey": "your-truefoundry-token", | ||
"model": "openai-main/gpt-4o", | ||
"description": "High-quality code generation and complex reasoning" | ||
}, | ||
{ | ||
"name": "TrueFoundry Claude", | ||
"baseUrl": "https://your-control-plane.truefoundry.cloud/api/llm", | ||
"apiKey": "your-truefoundry-token", | ||
"model": "anthropic-main/claude-3-5-sonnet", | ||
"description": "Excellent for code understanding and refactoring" | ||
}, | ||
{ | ||
"name": "TrueFoundry Fast", | ||
"baseUrl": "https://your-control-plane.truefoundry.cloud/api/llm", | ||
"apiKey": "your-truefoundry-token", | ||
"model": "openai-main/gpt-3.5-turbo", | ||
"description": "Quick responses for simple tasks" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
### Custom Instructions for Enterprise Development | ||
|
||
Enhance Roo Code's performance with TrueFoundry by setting custom instructions tailored for enterprise development: | ||
|
||
``` | ||
You are an expert software developer working with enterprise-grade code. | ||
|
||
Prioritize: | ||
- Security best practices and vulnerability prevention | ||
- Performance optimization and scalability | ||
- Clean, maintainable, and well-documented code | ||
- Comprehensive error handling and logging | ||
- Code review standards and team consistency | ||
|
||
When suggesting code changes, always consider: | ||
- Enterprise coding standards and guidelines | ||
- Testing requirements (unit, integration, e2e) | ||
- Deployment and CI/CD implications | ||
- Documentation and knowledge sharing | ||
- Security and compliance requirements | ||
``` | ||
|
||
## Enterprise Features | ||
|
||
### Analytics and Cost Management | ||
|
||
TrueFoundry provides advanced cost tracking and budgeting: | ||
|
||
- **Usage Analytics**: Monitor API calls, tokens, and costs per project | ||
- **Budget Limits**: Set spending limits to control costs | ||
- **Cost Attribution**: Track usage by team, project, or user | ||
|
||
[Learn more about Cost Management →](https://docs.truefoundry.com/gateway/cost-tracking) | ||
|
||
 | ||
|
||
### Security & Compliance | ||
|
||
- **Access Control**: Role-based permissions and user management | ||
- **Data Privacy**: Ensure your code and data remain secure | ||
- **Audit Logs**: Comprehensive logging for compliance requirements | ||
- **Content Filtering**: Built-in guardrails and content moderation | ||
|
||
[Learn more about Security & Compliance →](https://docs.truefoundry.com/gateway/guardrails-and-security) | ||
|
||
### Gateway features | ||
|
||
- **Load Balancing**: Automatic distribution across multiple model endpoints | ||
- **Fallback Support**: Automatic failover to backup models | ||
- **Rate Limiting**: Intelligent request throttling and queue management | ||
|
||
[Learn more about Gateway features →](https://docs.truefoundry.com/gateway/load-balancing) | ||
|
||
### Getting Help | ||
|
||
- **TrueFoundry Documentation**: [https://docs.truefoundry.com/](https://docs.truefoundry.com/) | ||
- **TrueFoundry Support**: [[email protected]](mailto:[email protected]) | ||
- **Roo Code Community**: Join our community for integration help | ||
|
||
|
||
All your Roo Code requests will now be routed through TrueFoundry's AI Gateway, providing you with enterprise-grade AI capabilities while maintaining security, cost control, and high availability. |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Uh oh!
There was an error while loading. Please reload this page.