Skip to content

Commit

Permalink
📝 [Doc] Update commands and expected results, and add thanks
Browse files Browse the repository at this point in the history
  • Loading branch information
Hansimov committed Jan 21, 2024
1 parent 4107531 commit 4484779
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Chat with Bing like what you do with OpenAI API.
- [EdgeGPT](https://github.com/acheong08/EdgeGPT) by [@acheong08](https://github.com/acheong08)
- [bingo](https://github.com/weaigc/bingo) by [@weaigc](https://github.com/weaigc)
- [@ninomae](https://github.com/NINOMAE1995)
- [@Harry-zklcdc][https://github.com/Harry-zklcdc]

## Features

Expand All @@ -36,16 +37,18 @@ Chat with Bing like what you do with OpenAI API.

🔨 In progress:
- [ ] Enhance performance and reduce session create requests
- [ ] Use auto proxies to enable create in restricted servers
- This is moved to another repo, and would release it when it is ready.
- [ ] Authentication with API key


## Running Example
## Run API service

![](docs/bing-chat-api-server.png)
### Expected results

## Run API service
After running the API service, you should be able to see the following UI and server logs.

![](docs/bing-chat-api-ui.png)

![](docs/bing-chat-api-server.png)

### Run in Command Line

Expand All @@ -59,7 +62,12 @@ pip install -r requirements.txt
**Run API:**

```bash
# on product mode
python -m apis.chat_api

# on develop mode
python -m apis.chat_api -d

```

## Run via Docker
Expand Down
Binary file removed docs/bing-chat-api-cli.png
Binary file not shown.
Binary file modified docs/bing-chat-api-server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/bing-chat-api-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4484779

Please sign in to comment.