https://github.com/pmalarme/ask-the-code

Ask The Code is demo project to use Azure OpenAI to talk with your source code.
https://github.com/pmalarme/ask-the-code

azure-openai openai openai-example

Last synced: about 1 month ago
JSON representation

Ask The Code is demo project to use Azure OpenAI to talk with your source code.

• Host: GitHub
• URL: https://github.com/pmalarme/ask-the-code
• Owner: pmalarme
• License: mit
• Created: 2023-05-31T06:39:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T12:40:05.000Z (about 1 year ago)
• Last Synced: 2025-04-04T18:22:36.075Z (3 months ago)
• Topics: azure-openai, openai, openai-example
• Language: Jupyter Notebook
• Homepage:
• Size: 364 KB
• Stars: 12
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ask The Code

Ask the code is a demo project to use Azure OpenAI to talk with your source code.

This project is inspired by [Azure OpenAI Embeddings QnA](https://github.com/ruoccofabrizio/azure-open-ai-embeddings-qna). It creates embeddings vectors from the source code files. Then it uses the Azure OpenAI GPT model to answer questions about the source code.

It is designed to work with Java projects. It uses the GPT model to add context to java code and to document it. The system commands can be updated to support other languages. Then the enriched code is transformed in embeddings vectors and store in a vector store.

The overall flow of the demo is represented on the figure below.

![Ask The Code - Flow](./media/overview.png)

> **NOTE: This project is a demo only. It is not production ready.**

# Run the demo

First the code needs to be enriched and indexed. To do so, you can follow the instructions in the [processing](processing/README.md) folder.

Then you can start the [backend](backend/README.md) and the [frontend](frontend/README.md).