Skip to content

Commit

Permalink
docs(README): add 'Export Multiple Conversations' section
Browse files Browse the repository at this point in the history
Adds a section about the "Export Conversations" dialog to `README.md`. Briefly describes the various controls, particularly the "Archive" button, added in #198.

No translations added to `README_ID.md`, `README_KR.md`, or `README_TR.md`.
  • Loading branch information
peterkaminski authored and pionxzh committed Mar 22, 2024
1 parent b697fb3 commit 2c9ce54
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ English   |   [Indonesia](./README_ID.md)   |&nbsp

#

[📚 Supported Formats](#-supported-formats)   |   [💡 Example](#-example)   |   [🤝 Contribution](#-contribution)   |   [⭐ Star History](#-star-history)
[📚 Supported Formats](#-supported-formats)   |   [💡 Example](#-example)   |   [📤 Export Multiple Conversations](#-export-multiple-conversations)   |   [🤝 Contribution](#-contribution)   |   [⭐ Star History](#-star-history)

</div>

Expand Down Expand Up @@ -109,7 +109,6 @@ It sounds like you're planning on creating a tool that uses the ChatGPT model to
### Screenshot

<div align="center">

<img width="480" src="https://user-images.githubusercontent.com/9910706/205663680-6ac97fac-39b0-495c-bee4-8ef37713a9ae.png" />

</div>
Expand Down Expand Up @@ -220,6 +219,31 @@ the raw content from API `https://chat.openai.com/backend-api/conversation/[id]`
```
</details>

## 📤 Export Multiple Conversations

When you click the "Export All" button, the **Export Conversations** dialog pops up. Here are the functions you can access.

**Export from official export file (conversations.json)**

Click the upload icon button to upload a JSON file of conversations, such as one downloaded from OpenAI.

**Export from API**

In the list of all your conversations, select which conversations you want to export. Check the "Select All" checkbox to export all your conversations.

Choose the format you want to export to using the format pull-down selector under the list of your conversations at the left. You can choose from the following formats.

- **Markdown**
- **HTML**
- **JSON**
- **JSON (ZIP)**

Click the button to perform the action you want.

- **Archive** - Archived chat sessions will disappear from the sidebar and can be managed in ChatGPT settings. See [#199](https://github.com/pionxzh/chatgpt-exporter/issues/199) for more details.
- **Delete** - Deletes the selected conversations.
- **Export** - Exports the selected conversations in the format chosen using the format selector.

## 🤝 Contribution

See [CONTRIBUTING.md](./CONTRIBUTING.md)
Expand Down

0 comments on commit 2c9ce54

Please sign in to comment.