Merge pull request #1660 from qodo-ai/of/refine-rag-file

docs: Rename Company Codebase to RAG Context Enrichment
This commit is contained in:
ofir-frd
2025-03-30 10:23:04 +03:00
committed by GitHub
4 changed files with 17 additions and 17 deletions

View File

@ -9,7 +9,7 @@ Qodo Merge utilizes a variety of core abilities to provide a comprehensive and e
- [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) - [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/)
- [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) - [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
- [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) - [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/)
- [Company Codebase](https://qodo-merge-docs.qodo.ai/core-abilities/company_codebase/) - [RAG Context Enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/)
- [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) - [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/)
- [Code fine-tuning benchmark](https://qodo-merge-docs.qodo.ai/finetuning_benchmark/) - [Code fine-tuning benchmark](https://qodo-merge-docs.qodo.ai/finetuning_benchmark/)

View File

@ -1,17 +1,16 @@
# Company Codebase 💎 # RAG Context Enrichment 💎
`Supported Git Platforms: GitHub`
`Supported Git Platforms: GitHub`
## Overview ## Overview
### What is Company Codebase? ### What is RAG Context Enrichment?
An organized, semantic database that aggregates all your companys source code into one searchable repository, enabling efficient code discovery and analysis. A feature that enhances AI analysis by retrieving and referencing relevant code patterns from your project, enabling context-aware insights during code reviews.
### How does Company Codebase work? ### How does RAG Context Enrichment work?
By indexing your company's code and using Retrieval-Augmented Generation (RAG), it retrieves contextual code segments on demand, improving pull request (PR) insights and accelerating review accuracy.
Using Retrieval-Augmented Generation (RAG), it searches your configured repositories for contextually relevant code segments, enriching pull request (PR) insights and accelerating review accuracy.
## Getting started ## Getting started
@ -31,27 +30,27 @@ enable_rag=true
<table> <table>
<tr> <tr>
<td><b>enable_rag</b></td> <td><b>enable_rag</b></td>
<td>If set to true, codebase enrichment using RAG will be enabled. Default is false.</td> <td>If set to true, repository enrichment using RAG will be enabled. Default is false.</td>
</tr> </tr>
<tr> <tr>
<td><b>rag_repo_list</b></td> <td><b>rag_repo_list</b></td>
<td>A list of repositories that will be used by the semantic search for RAG. Use `['all']` to consider the entire codebase or a select list or repositories, for example: ['my-org/my-repo', ...]. Default: the repository from which the PR was opened.</td> <td>A list of repositories that will be used by the semantic search for RAG. Use `['all']` to consider the entire codebase or a select list of repositories, for example: ['my-org/my-repo', ...]. Default: the repository from which the PR was opened.</td>
</tr> </tr>
</table> </table>
References from the codebase will be shown in a collapsible bookmark, allowing you to easily access relevant code snippets: References from the repository will be shown in a collapsible bookmark, allowing you to easily access relevant code snippets:
![References](https://codium.ai/images/pr_agent/company_codebase_references.png){width=640} ![References](https://codium.ai/images/pr_agent/rag_context_enrichment_references.png){width=640}
## Limitations ## Limitations
### Querying the codebase presents significant challenges: ### Querying the codebase presents significant challenges
- **Search Method**: RAG uses natural language queries to find semantically relevant code sections - **Search Method**: RAG uses natural language queries to find semantically relevant code sections
- **Result Quality**: No guarantee that RAG results will be useful for all queries - **Result Quality**: No guarantee that RAG results will be useful for all queries
- **Scope Recommendation**: To reduce noise, avoid using the whole codebase; focus on PR repository instead - **Scope Recommendation**: To reduce noise, focus on the PR repository rather than searching across multiple repositories
### This feature has several requirements and restrictions: ### This feature has several requirements and restrictions
- **Codebase**: Must be properly indexed for search functionality - **Codebase**: Must be properly indexed for search functionality
- **Security**: Requires secure and private indexed codebase implementation - **Security**: Requires secure and private indexed codebase implementation
- **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup - **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup

View File

@ -9,6 +9,7 @@ Qodo Merge is a hosted version of PR-Agent, designed for companies and teams tha
- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools. - See the [Tools Guide](./tools/index.md) for a detailed description of the different tools.
- See the [Video Tutorials](https://www.youtube.com/playlist?list=PLRTpyDOSgbwFMA_VBeKMnPLaaZKwjGBFT) for practical demonstrations on how to use the tools.
## Docs Smart Search ## Docs Smart Search

View File

@ -49,7 +49,7 @@ nav:
- Impact evaluation: 'core-abilities/impact_evaluation.md' - Impact evaluation: 'core-abilities/impact_evaluation.md'
- Interactivity: 'core-abilities/interactivity.md' - Interactivity: 'core-abilities/interactivity.md'
- Compression strategy: 'core-abilities/compression_strategy.md' - Compression strategy: 'core-abilities/compression_strategy.md'
- Company Codebase: 'core-abilities/company_codebase.md' - RAG Context Enrichment: 'core-abilities/rag_context_enrichment.md'
- Static code analysis: 'core-abilities/static_code_analysis.md' - Static code analysis: 'core-abilities/static_code_analysis.md'
- Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md' - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md'
- Chrome Extension: - Chrome Extension: