|
| 1 | +# Company Codebase 💎 |
| 2 | +`Supported Git Platforms: GitHub` |
| 3 | + |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +### What is Company Codebase? |
| 8 | + |
| 9 | +An organized, semantic database that aggregates all your company’s source code into one searchable repository, enabling efficient code discovery and analysis. |
| 10 | + |
| 11 | +### How does Company Codebase work? |
| 12 | + |
| 13 | +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. |
| 14 | + |
| 15 | + |
| 16 | +## Getting started |
| 17 | + |
| 18 | +!!! info "Prerequisites" |
| 19 | + - Database setup and codebase indexing must be completed before proceeding. [Contact support](https://www.qodo.ai/contact/) for assistance. |
| 20 | + |
| 21 | +### Configuration options |
| 22 | + |
| 23 | +In order to enable the RAG feature, add the following lines to your configuration file: |
| 24 | +``` toml |
| 25 | +[rag_arguments] |
| 26 | +enable_rag=true |
| 27 | +``` |
| 28 | + |
| 29 | +!!! example "RAG Arguments Options" |
| 30 | + |
| 31 | + <table> |
| 32 | + <tr> |
| 33 | + <td><b>enable_rag</b></td> |
| 34 | + <td>If set to true, codebase enrichment using RAG will be enabled. Default is false.</td> |
| 35 | + </tr> |
| 36 | + <tr> |
| 37 | + <td><b>rag_repo_list</b></td> |
| 38 | + <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> |
| 39 | + </tr> |
| 40 | + </table> |
| 41 | + |
| 42 | + |
| 43 | +## Limitations |
| 44 | + |
| 45 | +### Querying the codebase presents significant challenges: |
| 46 | +- **Search Method**: RAG uses natural language queries to find semantically relevant code sections |
| 47 | +- **Result Quality**: No guarantee that RAG results will be useful for all queries |
| 48 | +- **Scope Recommendation**: To reduce noise, avoid using the whole codebase; focus on PR repository instead |
| 49 | + |
| 50 | +### This feature has several requirements and restrictions: |
| 51 | +- **Codebase**: Must be properly indexed for search functionality |
| 52 | +- **Security**: Requires secure and private indexed codebase implementation |
| 53 | +- **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup |
0 commit comments