Skip to content

FacerAin/khugpt-agent

Repository files navigation

Contributors Forks Stargazers Issues Pull Request MIT License


Logo

KHUGPT Agent Engine

API Engine for KHUGPT agent using LLM.
Explore the API docs Β»



Report Issues Β· Pull Requests

πŸ—ƒοΈ Built With

πŸ’‘ Language

Python

πŸ’‘ Frameworks

Fastapi

(back to top)

πŸš€ Getting Started

⚑ Prerequisites

πŸš€ Guideline

I recommend building your environment on top of a virtual environment (e.g., venv, anaconda, etc.)

  • Setup

    make setup
  • Run application

    make run
    
    or
    
    uvicorn app.main:app
  • Linting & Testing

    # Linting
    make style
    
    # Testing
    make test
  • Dockerizing

    docker build -t nickname/imagename .

(back to top)

🌐 Features

  • Providing API Endpoint through FastAPI
  • Generating answers using the Agent system
  • Document search and RAG using Pinecone Retriever
  • For more information, please refer to the API documentation.

(back to top)

πŸ”₯ Contributing

Please refer to CONTRIBUTING.md for Contribution.

For issues, new functions and requests to modify please follow the following procedure. πŸ₯°

  1. Fork the Project
  2. Create a Issue when you have new feature or bug, just not Typo fix
  3. Create your Feature Branch from dev Branch (git checkout -b feat/Newfeature)
  4. Commit your Changes (git commit -m 'feat: add new feature')
  5. Push to the Branch (git push origin feat/Newfeature)
  6. Open a Pull Request to dev branch with Issues

(back to top)

πŸ” License

Please refer to LICENSE for LICENSE.

(back to top)

πŸ’¬ Contact


Yongwoo Song

(back to top)

About

Agent system for KHUGPT service.

Resources

License

Stars

Watchers

Forks

Packages

No packages published