Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacoblincool/chatgpt-agent
Deprecated! Library, CLI, and Discord bot for the unofficial ChatGPT API with progressive responses and more.
https://github.com/jacoblincool/chatgpt-agent
bot chatgpt discord
Last synced: about 1 month ago
JSON representation
Deprecated! Library, CLI, and Discord bot for the unofficial ChatGPT API with progressive responses and more.
- Host: GitHub
- URL: https://github.com/jacoblincool/chatgpt-agent
- Owner: JacobLinCool
- License: mit
- Created: 2022-12-04T21:00:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:39:17.000Z (11 months ago)
- Last Synced: 2024-04-23T14:05:27.334Z (7 months ago)
- Topics: bot, chatgpt, discord
- Language: TypeScript
- Homepage: https://discord.com/oauth2/authorize?client_id=1049030945832972389&permissions=274877975552&scope=bot
- Size: 173 KB
- Stars: 11
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChatGPT Agent
This is a library, a CLI, and a Discord bot for the unofficial [ChatGPT](https://chat.openai.com/chat) API with progressive responses and more.
You can find READMEs for the library, CLI, and Discord bot in their respective folders in `packages/`.
The library documentation is available at [https://jacoblincool.github.io/ChatGPT-Agent/](https://jacoblincool.github.io/ChatGPT-Agent/).
The CLI is available on [npm](https://www.npmjs.com/package/chatgpt-cli).
And you can invite the Discord bot to your server with [this link](https://discord.com/oauth2/authorize?client_id=1049030945832972389&permissions=274877975552&scope=bot). (Or host it by yourself: clone the repo, setup `.env`, and run `docker compose up`.)
## The Library
[Features](#features) | [Usage](#usage) | [Configuration](#configuration)
### Features
- Progressive responses
- Multiple sessions
- Conversation history
- Automatic token refresh
- Request timeout
- Request retry
### Usage
```ts
// refresh_token is optional
const agent = new Agent(token, refresh_token);
// multiple sessions can be created
const session = agent.session();
const first_conv = session.talk("Hello");
first_conv.on("partial", partial);
console.log("completed", await first_conv.response);
first_conv.off("partial", partial);
const second_conv = session.talk("Tell me a joke");
second_conv.on("partial", partial);
console.log("completed", await second_conv.response);
second_conv.off("partial", partial);
console.log("history", session.history);
```
`Agent` is the main class for the library. It represents a single user, and handles the token (and refresh token), and can create multiple sessions.
`Session` is a class that represents a single context just like the new ChatGPT tab you opened in the browser. It can be created with `Agent.session()`. It has a `history` property that is an array of messages, and a `talk` method that takes a message and returns a `Conversation` object.
`Conversation` is a class that represents a single conversation. It has a `response` property that is a promise that resolves to the full response, and an `on` method that takes an event name and a callback. You can listen to `partial` events, which are fired when the response is updated, and `complete` events, which are fired when the response is complete. Also, `error` events are fired when an error occurs.
### Configuration
You can configure the backend URL and the request timeout for the agent.
```ts
const agent = new Agent(token, refresh_token, {
backend: "https://chat.openai.com/backend-api",
timeout: 60_000,
});
```
The default backend URL is `https://chat.openai.com/backend-api`, and the default timeout is 60 seconds.
You can also configure them using environment variables.
```sh
CHATGPT_BACKEND="https://chat.openai.com/backend-api"
CHATGPT_TIMEOUT=60000
CHATGPT_RETRY=1
```