-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add h2oGPT Client #133
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
Merged
Merged
Add h2oGPT Client #133
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
5c9c922
Ignore JetBrains IDE files
this b686036
Add initial implementation of the h2oGPT Client
this e9c1e85
Add async operation support for text completion
this 972534c
Merge branch main into sajith/main/add-client
this cf1fa4b
Rename test functions
this 90a2e03
Add new langchain_mode param
this 8e179fa
Merge branch 'main' of github.com:h2oai/h2ogpt into sajith/main/add-c…
this bb71f56
Add missing PromptType enum values
this 5e73e77
Rename class
this 11e9c36
Remove duplicate entry
this 90195d7
Improve API docs
this 5d2a4e5
Export LangChainMode
this 49c0b37
Add langchain parameters
this 8c46c3c
Merge branch 'main' of github.com:h2oai/h2ogpt into sajith/main/add-c…
this 90935f5
Fix code formatting
this c481bd4
Add chat completion API
this ac44e5d
Upgrade gradio-client to v0.2.6
this 17ff8c9
Merge branch 'main' of github.com:h2oai/h2ogpt into sajith/main/add-c…
this e39e520
Use enums from h2oGPT
this 68460ef
Configure poetry to create the virtual environment inside the project
this 0bada30
Add details about the client in the README.md
this f593870
Improve README.md
this df6a960
Merge branch 'main' of github.com:h2oai/h2ogpt into sajith/main/add-c…
this File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| ### Generated files ### | ||
| enums.py | ||
|
|
||
| ### Python template | ||
| # 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/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| PACKAGE_NAME := $(firstword $(shell poetry version)) | ||
| PACKAGE_DIR := $(subst -,_,$(PACKAGE_NAME)) | ||
| PACKAGE_VERSION := $(shell poetry version --short) | ||
|
|
||
| generate_sources: | ||
| cp -f ./../enums.py "$(PACKAGE_DIR)/enums.py" | ||
|
|
||
| .PHONY: setup | ||
| setup: | ||
| poetry install | ||
|
|
||
| .PHONY: lint | ||
| lint: generate_sources | ||
| poetry run black . | ||
| poetry run isort . | ||
| poetry run flake8 "$(PACKAGE_DIR)" "tests" || true | ||
| poetry run mypy --show-error-codes --pretty . | ||
|
|
||
| .PHONY: test | ||
| test: generate_sources | ||
| poetry run pytest | ||
|
|
||
| .PHONY: build | ||
| build: generate_sources | ||
| poetry build |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # h2oGPT Client | ||
| A Python thin-client for h2oGPT. | ||
|
|
||
| ## Usage | ||
| ```python | ||
| from h2ogpt_client import Client | ||
|
|
||
| client = Client("http://0.0.0.0:7860") | ||
|
|
||
| # text completion | ||
| response = client.text_completion.create("Hello world") | ||
| response = await client.text_completion.create_async("Hello world") | ||
|
|
||
| # chat completion | ||
| chat_context = client.chat_completion.create() | ||
| chat = chat_context.chat("Hey!") | ||
| print(chat["user"]) # prints user prompt, i.e. "Hey!" | ||
| print(chat["gpt"]) # prints reply of the h2oGPT | ||
| chat_history = chat_context.chat_history() | ||
| ``` | ||
| :warning: **Note**: Client APIs are still evolving. Hence, APIs can be changed without prior warnings. | ||
|
|
||
| ## Development | ||
| ### Prerequisites | ||
| - Python 3.8 | ||
| - [Poetry](https://python-poetry.org/docs/#installation) - A dependency management and packaging tool for Python | ||
|
|
||
| ### Setup environment | ||
| ```shell | ||
| make setup | ||
| ``` | ||
|
|
||
| ### Run lint | ||
| ```shell | ||
| make lint | ||
| ``` | ||
|
|
||
| ### Build | ||
| ```shell | ||
| make build | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| from h2ogpt_client.core import Client | ||
| from h2ogpt_client.enums import LangChainMode, PromptType | ||
|
|
||
| __all__ = ["Client", "PromptType", "LangChainMode"] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.