CodeRAG

Motivação do projeto

Este projeto veio de uma idéia simples: e se você pudesse fornecer uma base de código inteira a um LLM em vez de apenas pequenos pedaços? A maioria dos assistentes de codificação, como co-pilotos, trabalha em um escopo limitado, mas eu queria algo que pudesse lidar com o contexto completo de um projeto.

Ao integrar a base de código completa à geração de recuperação de recuperação (RAG), esse POC visa melhorar a qualidade e a relevância das sugestões de código. O objetivo é ver como ter o código completo disponível para consulta em tempo real pode aumentar a produtividade.

Coderag

O CoderAg é uma ferramenta de recuperação de código e recuperação de IA que aproveita os modelos do OpenAI (como gpt-4 ou gpt-3.5-turbo ) para consulta, indexação e melhoria da base de código em tempo real. Este projeto integra um sistema de geração de recuperação de recuperação (RAG) para ajudar os desenvolvedores a pesquisar perfeitamente através do código, a receber sugestões e implementar melhorias.

Características

• Indexação de base de código em tempo real : indexa automaticamente os arquivos de código após alterações, com atualizações em tempo real.
• Pesquisa de banco de dados vetorial : utiliza o FAISS ou um banco de dados vetorial semelhante para pesquisa de código rápida e eficiente usando o incorporação.
• Assistência de codificação de conversação : integra os modelos GPT da OpenAI para fornecer sugestões contextuais de código, melhorias e correções.
• Configurações configuráveis : as configurações específicas do ambiente são gerenciadas usando um arquivo .env para chaves da API, seleção de modelos e diretórios.

Pilha de tecnologia

• API OpenAI : aproveita o GPT-4O (ou qualquer outro modelo OpenAI) para melhorias de conversação e codificação.
• Python : funcionalidade central e interações da API.
• FAISS (Pesquisa de similaridade da AI do Facebook) : para pesquisa baseada em vetores.
• Python-dotenv : para gerenciar variáveis ​​de ambiente.
• Geração de recuperação de recuperação (RAG) : combina modelos de pesquisa e generativos.

Instruções de configuração

Pré -requisitos

• Python 3.8+
• Chave da API OpenAI (você pode obter uma aqui)
• FAISS

Etapa 1: clonar o repositório

git clone https://github.com/yourusername/CodeRAG.git
cd CodeRAG

Etapa 2: Instale dependências

Crie um ambiente virtual (recomendado):

python3 -m venv venv
source venv/bin/activate  # On Windows use `venvScriptsactivate`

Instale os pacotes necessários:

pip install -r requirements.txt

Etapa 3: Configurar variáveis ​​de ambiente

Crie um arquivo .env na raiz do projeto e adicione as seguintes variáveis:

OPENAI_API_KEY=your_openai_api_key
OPENAI_EMBEDDING_MODEL=text-embedding-ada-002
OPENAI_CHAT_MODEL=gpt-4o
WATCHED_DIR=path_to_your_code_directory
FAISS_INDEX_FILE=path_to_faiss_index
EMBEDDING_DIM=1536  # Modify if you're using a different embedding model 

Etapa 4: execute o aplicativo

1. Comece o back -end :

   Para iniciar o back -end (indexação, incorporação e monitoramento):

   python main.py

2. Comece o front -end :

   Para iniciar a interface do usuário do streamlit:

   streamlit run app.py

Uso

1. Faça uma pergunta : digite sua pergunta ou solicitação de código na interface. O modelo pesquisará a base de código indexada e fornecerá sugestões ou melhorias.
2. Sugestões de revisão : você receberá uma versão mesclada ou fixa do código com base na análise do modelo.
3. Histórico de conversação : o sistema acompanha suas consultas e as respostas da IA ​​para melhor contexto em interações futuras.

Estrutura do projeto

• main.py : o script principal para executar o aplicativo.
• prompt_flow.py : lida com a consulta da API do OpenAI e gerencia a pesquisa e o histórico de conversação.
• coderag/config.py : armazena variáveis ​​de configuração e ambiente.
• coderag/search.py : gerencia o banco de dados vetorial (FAISS) Procura trechos de código relevantes.
• .env : mantém configurações específicas do ambiente (teclas de API OpenAI, configuração do modelo, etc.).
• requirements.txt : lista as dependências do Python necessárias para executar o projeto.

Contribuindo

Sinta -se à vontade para gastar este repositório, abrir problemas e enviar solicitações de puxar.

1. Fork o repositório.
2. Crie sua filial de recursos ( git checkout -b feature/your-feature ).
3. Comprometa suas alterações ( git commit -am 'Add new feature' ).
4. Empurre para o ramo ( git push origin feature/your-feature ).
5. Abra um pedido de tração.

Licença

Este projeto está licenciado sob a licença Apache. Consulte o arquivo de licença para obter detalhes.