Skip to content

Commit

Permalink
update images of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RexWzh committed May 14, 2024
1 parent c23b443 commit e6b39d4
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 19 deletions.
32 changes: 24 additions & 8 deletions README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,15 @@ AskChat is a command-line tool for ChatGPT interaction, allowing you to call Cha

Run in the terminal:

![hello](docs/assets/svgs/hello.svg)
<div align="center">
<img src="docs/assets/svgs/hello.svg" alt="hello" width="480">
</div>

Run in Jupyter Notebook:

![jupyter](docs/assets/jupyter.gif)
<div align="center">
<img src="docs/assets/jupyter.gif" alt="jupyter" width="480">
</div>

## Installation and Configuration

Expand Down Expand Up @@ -66,19 +70,27 @@ In addition, you can use `askchat` for more flexible dialogue and `askenv` to ma

1. API debugging, testing default parameters and return results.

![debug](docs/assets/svgs/debug.svg)
<div align="center">
<img src="docs/assets/svgs/debug.svg" alt="debug" width="480">
</div>

2. Get a list of available models.

![validmodels](docs/assets/svgs/validmodels.svg)
<div align="center">
<img src="docs/assets/svgs/validmodels.svg" alt="validmodels" width="480">
</div>

3. Multi-turn dialogue, saving dialogues, loading dialogues, etc.

![chatlog](docs/assets/svgs/chatlog.svg)
<div align="center">
<img src="docs/assets/svgs/chatlog.svg" alt="chatlog" width="480">
</div>

4. Specify parameters, using different models and APIs.

![para-models](docs/assets/svgs/para-models.svg)
<div align="center">
<img src="docs/assets/svgs/para-models.svg" alt="para-models" width="480">
</div>

### Dialogue Management

Expand Down Expand Up @@ -136,11 +148,15 @@ Note: `--all-valid-models` will print all available models, including Embedding,

1. Create, view, activate, and delete channels.

![askenv](docs/assets/svgs/askenv.svg)
<div align="center">
<img src="docs/assets/svgs/askenv.svg" alt="askenv" width="480">
</div>

2. Edit channel.

![askenv-config](docs/assets/svgs/editenv.svg)
<div align="center">
<img src="docs/assets/svgs/editenv.svg" alt="editenv" width="480">
</div>


### Basic Usage
Expand Down
38 changes: 27 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,19 @@
[English](README-en.md) | [简体中文](README.md)
</div>

AskChat 是一个通过命令行运行的,无界面的 ChatGPT 交互工具,随时随地调用 ChatGPT。
AskChat 是一个命令行运行的无界面 API 工具,随时随地调用 ChatGPT。

在终端调用
终端调用

![hello](docs/assets/svgs/hello.svg)
<div align="center">
<img src="docs/assets/svgs/hello.svg" alt="hello" width="480">
</div>

Jupyter Notebook 中调用
Jupyter Notebook 调用

![jupyter](docs/assets/jupyter.gif)
<div align="center">
<img src="docs/assets/jupyter.gif" alt="jupyter" width="480">
</div>

## 安装及配置

Expand Down Expand Up @@ -66,19 +70,27 @@ ask hello world

1. API 调试,测试默认参数和返回结果。

![debug](docs/assets/svgs/debug.svg)
<div align="center">
<img src="docs/assets/svgs/debug.svg" alt="debug" width="480">
</div>

2. 获取可用模型列表。

![validmodels](docs/assets/svgs/validmodels.svg)
<div align="center">
<img src="docs/assets/svgs/validmodels.svg" alt="validmodels" width="480">
</div>

3. 多轮对话,保存对话,加载对话等。

![chatlog](docs/assets/svgs/chatlog.svg)
<div align="center">
<img src="docs/assets/svgs/chatlog.svg" alt="chatlog" width="480">
</div>

4. 指定参数,使用不同的模型和 API。

![para-models](docs/assets/svgs/para-models.svg)
<div align="center">
<img src="docs/assets/svgs/para-models.svg" alt="para-models" width="480">
</div>

### 对话管理

Expand Down Expand Up @@ -134,11 +146,15 @@ ask hello world

1. 创建,查看,激活和删除渠道

![askenv](docs/assets/svgs/askenv.svg)
<div align="center">
<img src="docs/assets/svgs/askenv.svg" alt="askenv" width="480">
</div>

2. 编辑渠道

![askenv-config](docs/assets/svgs/editenv.svg)
<div align="center">
<img src="docs/assets/svgs/editenv.svg" alt="editenv" width="480">
</div>


### 基本用法
Expand Down

0 comments on commit e6b39d4

Please sign in to comment.