Self‑Correcting Agent Demo

Overview

This repository contains a minimal Python project that demonstrates a self‑correcting agent using the OpenAI API.
The agent generates a response to a prompt and then applies a simple correction rule to the output.

Technology Stack

Component	Version	Notes
Python	3.11+	The code is written for Python 3.11.
OpenAI SDK	`openai>=1.0.0`	Required dependency for interacting with the OpenAI API.

Mandatory Dependency
The assignment explicitly requires the openai package. It is listed in requirements.txt and will be installed with pip install -r requirements.txt.

Setup

Clone the repository

git clone https://git.brojs.ru/kuzakhmetovartur/ekzamen-samokorrektiruyuschiysya-agent.git
cd ekzamen-samokorrektiruyuschiysya-agent

Create a virtual environment (recommended)

python -m venv .venv
source .venv/bin/activate   # On Windows: .venv\\Scripts\\activate

Install dependencies
```
pip install -r requirements.txt
```
Set your OpenAI API key
```
export OPENAI_API_KEY="sk-..."
```

Running the Demo

python src/index.py

You should see two outputs: the raw response from the model and the corrected version.

Extending the Agent

The current correction logic is intentionally simple. To build a more sophisticated self‑correcting agent:

Replace the correct_text function with a rule‑based or ML‑based correction.
Add unit tests in a tests/ directory.
Integrate with a larger application or chatbot framework.

License

This project is provided as-is for educational purposes. Feel free to adapt and extend it.

Author: Artur Kuzakhmetov
Date: 28.05.2026
Version: 5

Note: The repository URL and commit history are maintained on the internal Git platform.

1.9 KiB Raw Blame History Unescape Escape