Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/client/raas #1018

Open
wants to merge 23 commits into
base: Feature/#959
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
7390a29
Refactor start_evaluate api endpoint
vkehfdl1 Nov 29, 2024
f7f1c37
if there is no .env, make one
vkehfdl1 Nov 29, 2024
d138a54
Merge branch 'Feature/#959' into Feature/#984
vkehfdl1 Nov 30, 2024
c78b827
make to one api endpoint that retrieve file content
vkehfdl1 Nov 30, 2024
0b3b698
add /artifacts/content delete operation to delete the file
vkehfdl1 Nov 30, 2024
5280e8c
upload korean filenames
vkehfdl1 Nov 30, 2024
3408e7b
✨ feat: Add initial version of AutoRAG client example
Nov 30, 2024
f6cf57a
✨ feat: Add AutoRAG client and models for project management
Nov 30, 2024
7f3ed59
✨ feat: Add AutoRAG client module with methods for project management…
Nov 30, 2024
dad46e0
✨ feat: Add AutoRAG client exceptions
Nov 30, 2024
26eedd4
✨ feat: Add initial AutoRAG client example implementation
Nov 30, 2024
c4d62b2
💄 style: update logging format in ex1.py to use consistent and descri…
Nov 30, 2024
655dc1b
Merge branch 'Feature/#959' into Feature/client/raas
vkehfdl1 Dec 2, 2024
48fddb0
Delete duplicate start_evaluate
vkehfdl1 Dec 2, 2024
2ae894a
rollback unnecessary whitespace changes while merging
vkehfdl1 Dec 2, 2024
62e6492
Make AutoRAG Client to the independent project for AutoRAG studio clo…
vkehfdl1 Dec 2, 2024
c857c0e
Make pyproject.toml for autorag-client and make a test code
vkehfdl1 Dec 2, 2024
acea3c5
test code done
vkehfdl1 Dec 2, 2024
f7bb536
✨ feat: Add tutorials, environment variables, and installation instru…
vkehfdl1 Dec 2, 2024
2c17866
delete auth at api server and fix ex1.py
vkehfdl1 Dec 2, 2024
78ff954
🔧 chore: Add AWS CloudWatch logging configuration to docker-compose.yml
Dec 3, 2024
7f63db1
update frontend version to the latest
vkehfdl1 Dec 4, 2024
e697484
Merge branch 'Feature/#959' into Feature/client/raas
vkehfdl1 Dec 4, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions api/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
from quart_uploads import UploadSet, configure_uploads

from database.project_db import SQLiteProjectDB # 올바른 임포트로 변경
from src.auth import require_auth
from src.evaluate_history import get_new_trial_dir
from src.schema import (
ChunkRequest,
Expand Down Expand Up @@ -133,7 +132,6 @@ async def options_handler(path=""):

# Project creation endpoint
@app.route("/projects", methods=["POST"])
@require_auth()
async def create_project():
data = await request.get_json()

Expand Down
163 changes: 163 additions & 0 deletions autorag_client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/
.vscode/
pytest.ini
.DS_Store
27 changes: 27 additions & 0 deletions autorag_client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# AutoRAG Client

This is the client for AutoRAG Studio Cloud.

To register this, please contact to Jeffrey Kim. ([email protected])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to change the e-mail address to [email protected]

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok


## Tutorials

- [Tutorial 1](tutorials/ex1.py)

## Environment Variables

- `AUTORAG_API_KEY`: API key for AutoRAG Studio Cloud
- `AUTORAG_BASE_URL`: Base URL for AutoRAG Studio Cloud API

## Installation

```bash
pip install autorag-client
```
## Run Tutorial

```bash
cd tutorials
# edit .env file with your API key and base URL
python ex1.py
```
1 change: 1 addition & 0 deletions autorag_client/autorag_client/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.0.1
21 changes: 21 additions & 0 deletions autorag_client/autorag_client/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import logging
import os

from .client import AutoRAGClient
from .models import Project, RAGPipeline, RetrievalResults, Retrieval
from .exceptions import APIError, AuthenticationError

__all__ = [
"AutoRAGClient",
"Project",
"RAGPipeline",
"RetrievalResults",
"Retrieval",
"APIError",
"AuthenticationError",
]

# Set log level based on environment variable
log_level = logging.DEBUG if os.getenv("AUTORAG_ENV") == "dev" else logging.WARNING
logger = logging.getLogger("AutoRAG-Client")
logger.setLevel(log_level)
Loading
Loading