Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ogios/huggingchat-api
huggingface.co/chat api. Fixed stream response & web search.
https://github.com/ogios/huggingchat-api
api huggingchat huggingface python
Last synced: 27 days ago
JSON representation
huggingface.co/chat api. Fixed stream response & web search.
- Host: GitHub
- URL: https://github.com/ogios/huggingchat-api
- Owner: ogios
- License: gpl-3.0
- Archived: true
- Created: 2023-06-21T11:35:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-01T03:59:58.000Z (about 1 year ago)
- Last Synced: 2024-09-18T04:59:59.440Z (about 2 months ago)
- Topics: api, huggingchat, huggingface, python
- Language: Python
- Homepage:
- Size: 95.7 KB
- Stars: 13
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Huggingchat api
**You Star You Win A BILLION$$$(maybe,it's not impossible that it would happen)**
> This is my first pypi project. Experienced some annoying moments, but i managed to do it anyway
[](https://pypi.python.org/pypi/hugchat-api/)
[](https://pypi.python.org/pypi/hugchat-api/)
[](https://pepy.tech/project/hugchat-api)
```shell
pip install hugchat-api
```
> [!NOTE]
> **VERSIONS BEFORE `v0.0.1.6` ARE DEPRECATED! PLEASE UPDATE TO THE LASTEST.**
> For documentation, please see [Wiki](https://github.com/ogios/huggingchat-api/wiki)
## Lastest Change
> Last update: 2023-09-30
- Fix: `summarize` api removed causing endless loop
- **Feat! :** ( Testing, not sure if it's working 🤨 ) System prompt injection
- rm: `Open-Assistant` is removed from `ListBots`
- Fix: `Chatflow` error not shown in `Message` hence hard to debug from log
- Update: Change multiple type hints to `Union` to adapt lower python version [#87](https://github.com/Soulter/hugging-chat-api/issues/87)
## Screenshots
### Normal Chat
### With Search Web
## Terminal Usage
### Start up
```shell
python -m hugchat_api.terminal_cli -u your_email
```
| Params | Descriptions |
|--------|-----------------------------------|
| -u | Login Email |
| -p | Use password or not (optional) |
| -f | Ignore the saved cookie and login |
| --debug| Open cli in with debug log type, log file can be found with the name: `terminal_cli.log` |
### Commands
Use `/` + `command` to execute:
| Commands | Descriptions |
|------------|----------------------------------------|
| q/exit | Exit the program |
| ls | List all conversations |
| cd | cd into the chosen conversation |
| new | Create a new conversation |
| rm | delete the chosen conversation |
| old | Print out the conversation's histories |
| web | Switch 'Search Web' enable option |
| pro | Provide prompt for `System` |
Anything not start with `/` will be seen as chat message.
Example:
```text
(None) > /ls
#* Conversations established:
#
# 0. [649471fa525d2d2474973871] - Hello there! How can I help you? Let me know if you need something specific done.
# 1. [64946fb2525d2d247497382c] - Hi there! How can I assist you?
(None) > /cd 0
(647e09ccabd9de3d82d6fba0) > hi
#(user): hi
#(HFBot): ...
(647e09ccabd9de3d82d6fba0) > /web
#WEB_SEARCH is set to `True`
(647e09ccabd9de3d82d6fba0) > hi
# ...(steps about web search)
#(HFBot): ...
```